1 /*
2 * Copyright (c) 2014 The DragonFly Project. All rights reserved.
3 *
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com> and was subsequently ported
6 * to FreeBSD by Michael Gmelin <freebsd@grem.de>
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * $FreeBSD: releng/11.2/sys/dev/ichiic/ig4_reg.h 331834 2018-03-31 00:30:47Z gonzo $
36 */
37 /*
38 * Intel fourth generation mobile cpus integrated I2C device.
39 *
40 * Datasheet reference: Section 22.
41 *
42 * http://www.intel.com/content/www/us/en/processors/core/4th-gen-core-family-mobile-i-o-datasheet.html?wapkw=datasheets+4th+generation
43 *
44 * This is a from-scratch driver under the BSD license using the Intel data
45 * sheet and the linux driver for reference. All code is freshly written
46 * without referencing the linux driver code. However, during testing
47 * I am also using the linux driver code as a reference to help resolve any
48 * issues that come. These will be specifically documented in the code.
49 *
50 * This controller is an I2C master only and cannot act as a slave. The IO
51 * voltage should be set by the BIOS. Standard (100Kb/s) and Fast (400Kb/s)
52 * and fast mode plus (1MB/s) is supported. High speed mode (3.4 MB/s) is NOT
53 * supported.
54 */
55
56 #ifndef _ICHIIC_IG4_REG_H_
57 #define _ICHIIC_IG4_REG_H_
58
59 /*
60 * 22.2 MMIO registers can be accessed through BAR0 in PCI mode or through
61 * BAR1 when in ACPI mode.
62 *
63 * Register width is 32-bits
64 *
65 * 22.2 Default Values on device reset are 0 except as specified here:
66 * TAR_ADD 0x00000055
67 * SS_SCL_HCNT 0x00000264
68 * SS_SCL_LCNT 0x000002C2
69 * FS_SCL_HCNT 0x0000006E
70 * FS_SCL_LCNT 0x000000CF
71 * INTR_MASK 0x000008FF
72 * I2C_STA 0x00000006
73 * SDA_HOLD 0x00000001
74 * SDA_SETUP 0x00000064
75 * COMP_PARAM1 0x00FFFF6E
76 * COMP_VER 0x3131352A
77 */
78
79 #define IG4_REG_CTL 0x0000 /* RW Control Register */
80 #define IG4_REG_TAR_ADD 0x0004 /* RW Target Address */
81 #define IG4_REG_DATA_CMD 0x0010 /* RW Data Buffer and Command */
82 #define IG4_REG_SS_SCL_HCNT 0x0014 /* RW Std Speed clock High Count */
83 #define IG4_REG_SS_SCL_LCNT 0x0018 /* RW Std Speed clock Low Count */
84 #define IG4_REG_FS_SCL_HCNT 0x001C /* RW Fast Speed clock High Count */
85 #define IG4_REG_FS_SCL_LCNT 0x0020 /* RW Fast Speed clock Low Count */
86 #define IG4_REG_INTR_STAT 0x002C /* RO Interrupt Status */
87 #define IG4_REG_INTR_MASK 0x0030 /* RW Interrupt Mask */
88 #define IG4_REG_RAW_INTR_STAT 0x0034 /* RO Raw Interrupt Status */
89 #define IG4_REG_RX_TL 0x0038 /* RW Receive FIFO Threshold */
90 #define IG4_REG_TX_TL 0x003C /* RW Transmit FIFO Threshold */
91 #define IG4_REG_CLR_INTR 0x0040 /* RO Clear Interrupt */
92 #define IG4_REG_CLR_RX_UNDER 0x0044 /* RO Clear RX_Under Interrupt */
93 #define IG4_REG_CLR_RX_OVER 0x0048 /* RO Clear RX_Over Interrupt */
94 #define IG4_REG_CLR_TX_OVER 0x004C /* RO Clear TX_Over Interrupt */
95 #define IG4_REG_CLR_TX_ABORT 0x0054 /* RO Clear TX_Abort Interrupt */
96 #define IG4_REG_CLR_ACTIVITY 0x005C /* RO Clear Activity Interrupt */
97 #define IG4_REG_CLR_STOP_DET 0x0060 /* RO Clear STOP Detection Int */
98 #define IG4_REG_CLR_START_DET 0x0064 /* RO Clear START Detection Int */
99 #define IG4_REG_CLR_GEN_CALL 0x0068 /* RO Clear General Call Interrupt */
100 #define IG4_REG_I2C_EN 0x006C /* RW I2C Enable */
101 #define IG4_REG_I2C_STA 0x0070 /* RO I2C Status */
102 #define IG4_REG_TXFLR 0x0074 /* RO Transmit FIFO Level */
103 #define IG4_REG_RXFLR 0x0078 /* RO Receive FIFO Level */
104 #define IG4_REG_SDA_HOLD 0x007C /* RW SDA Hold Time Length */
105 #define IG4_REG_TX_ABRT_SOURCE 0x0080 /* RO Transmit Abort Source */
106 #define IG4_REG_SLV_DATA_NACK 0x0084 /* RW General Slave Data NACK */
107 #define IG4_REG_DMA_CTRL 0x0088 /* RW DMA Control */
108 #define IG4_REG_DMA_TDLR 0x008C /* RW DMA Transmit Data Level */
109 #define IG4_REG_DMA_RDLR 0x0090 /* RW DMA Receive Data Level */
110 #define IG4_REG_SDA_SETUP 0x0094 /* RW SDA Setup */
111 #define IG4_REG_ENABLE_STATUS 0x009C /* RO Enable Status */
112 /* Available at least on Atom SoCs and Haswell mobile. */
113 #define IG4_REG_COMP_PARAM1 0x00F4 /* RO Component Parameter */
114 #define IG4_REG_COMP_VER 0x00F8 /* RO Component Version */
115 /* Available at least on Atom SoCs */
116 #define IG4_REG_COMP_TYPE 0x00FC /* RO Probe width/endian? (linux) */
117 /* Available on Skylake-U/Y and Kaby Lake-U/Y */
118 #define IG4_REG_RESETS_SKL 0x0204 /* RW Reset Register */
119 #define IG4_REG_ACTIVE_LTR_VALUE 0x0210 /* RW Active LTR Value */
120 #define IG4_REG_IDLE_LTR_VALUE 0x0214 /* RW Idle LTR Value */
121 /* Available at least on Atom SoCs */
122 #define IG4_REG_CLK_PARMS 0x0800 /* RW Clock Parameters */
123 /* Available at least on Atom SoCs and Haswell mobile */
124 #define IG4_REG_RESETS_HSW 0x0804 /* RW Reset Register */
125 #define IG4_REG_GENERAL 0x0808 /* RW General Register */
126 /* These LTR config registers are at least available on Haswell mobile. */
127 #define IG4_REG_SW_LTR_VALUE 0x0810 /* RW SW LTR Value */
128 #define IG4_REG_AUTO_LTR_VALUE 0x0814 /* RW Auto LTR Value */
129
130 /*
131 * CTL - Control Register 22.2.1
132 * Default Value: 0x0000007F.
133 *
134 * RESTARTEN - RW Restart Enable
135 * 10BIT - RW Controller operates in 10-bit mode, else 7-bit
136 *
137 * NOTE: When restart is disabled the controller is incapable of
138 * performing the following functions:
139 *
140 * Sending a START Byte
141 * Performing any high-speed mode op
142 * Performing direction changes in combined format mode
143 * Performing a read operation with a 10-bit address
144 *
145 * Attempting to perform the above operations will result in the
146 * TX_ABORT bit being set in RAW_INTR_STAT.
147 */
148 #define IG4_CTL_SLAVE_DISABLE 0x0040 /* snarfed from linux */
149 #define IG4_CTL_RESTARTEN 0x0020 /* Allow Restart when master */
150 #define IG4_CTL_10BIT 0x0010 /* ctlr accepts 10-bit addresses */
151 #define IG4_CTL_SPEED_FAST 0x0004 /* snarfed from linux */
152 #define IG4_CTL_SPEED_STD 0x0002 /* snarfed from linux */
153 #define IG4_CTL_MASTER 0x0001 /* snarfed from linux */
154
155 /*
156 * TAR_ADD - Target Address Register 22.2.2
157 * Default Value: 0x00000055F
158 *
159 * 10BIT - RW controller starts its transfers in 10-bit
160 * address mode, else 7-bit.
161 *
162 * SPECIAL - RW Indicates whether software performs a General Call
163 * or START BYTE command.
164 *
165 * 0 Ignore GC_OR_START and use TAR address.
166 *
167 * 1 Perform special I2C Command based on GC_OR_START.
168 *
169 * GC_OR_START - RW (only if SPECIAL is set)
170 *
171 * 0 General Call Address. After issuing a General Call,
172 * only writes may be performed. Attempting to issue
173 * a read command results in IX_ABRT in RAW_INTR_STAT.
174 * The controller remains in General Call mode until
175 * bit 11 (SPECIAL) is cleared.
176 *
177 * 1 START BYTE.
178 *
179 *
180 * IC_TAR - RW when transmitting a general call, these bits are
181 * ignored. To generate a START BYTE, the address
182 * needs to be written into these bits once.
183 *
184 * This register should only be updated when the IIC is disabled (I2C_ENABLE=0)
185 */
186 #define IG4_TAR_10BIT 0x1000 /* start xfer in 10-bit mode */
187 #define IG4_TAR_SPECIAL 0x0800 /* Perform special command */
188 #define IG4_TAR_GC_OR_START 0x0400 /* General Call or Start */
189 #define IG4_TAR_ADDR_MASK 0x03FF /* Target address */
190
191 /*
192 * TAR_DATA_CMD - Data Buffer and Command Register 22.2.3
193 *
194 * RESTART - RW This bit controls whether a forced RESTART is
195 * issued before the byte is sent or received.
196 *
197 * 0 If not set a RESTART is only issued if the transfer
198 * direction is changing from the previous command.
199 *
200 * 1 A RESTART is issued before the byte is sent or
201 * received, regardless of whether or not the transfer
202 * direction is changing from the previous command.
203 *
204 * STOP - RW This bit controls whether a STOP is issued after
205 * the byte is sent or received.
206 *
207 * 0 STOP is not issued after this byte, regardless
208 * of whether or not the Tx FIFO is empty.
209 *
210 * 1 STOP is issued after this byte, regardless of
211 * whether or not the Tx FIFO is empty. If the
212 * Tx FIFO is not empty the master immediately tries
213 * to start a new transfer by issuing a START and
214 * arbitrating for the bus.
215 *
216 * i.e. the STOP is issued along with this byte,
217 * within the write stream.
218 *
219 * COMMAND - RW Control whether a read or write is performed.
220 *
221 * 0 WRITE
222 *
223 * 1 READ
224 *
225 * DATA (7:0) - RW Contains the data to be transmitted or received
226 * on the I2C bus.
227 *
228 * NOTE: Writing to this register causes a START + slave + RW to be
229 * issued if the direction has changed or the last data byte was
230 * sent with a STOP.
231 *
232 * NOTE: We control termination? so this register must be written
233 * for each byte we wish to receive. We can then drain the
234 * receive FIFO.
235 */
236
237 #define IG4_DATA_RESTART 0x0400 /* Force RESTART */
238 #define IG4_DATA_STOP 0x0200 /* Force STOP[+START] */
239 #define IG4_DATA_COMMAND_RD 0x0100 /* bus direction 0=write 1=read */
240 #define IG4_DATA_MASK 0x00FF
241
242 /*
243 * SS_SCL_HCNT - Standard Speed Clock High Count Register 22.2.4
244 * SS_SCL_LCNT - Standard Speed Clock Low Count Register 22.2.5
245 * FS_SCL_HCNT - Fast Speed Clock High Count Register 22.2.6
246 * FS_SCL_LCNT - Fast Speed Clock Low Count Register 22.2.7
247 *
248 * COUNT (15:0) - Set the period count to a value between 6 and
249 * 65525.
250 */
251 #define IG4_SCL_CLOCK_MASK 0xFFFFU /* count bits in register */
252
253 /*
254 * INTR_STAT - (RO) Interrupt Status Register 22.2.8
255 * INTR_MASK - (RW) Interrupt Mask Register 22.2.9
256 * RAW_INTR_STAT- (RO) Raw Interrupt Status Register 22.2.10
257 *
258 * GEN_CALL Set only when a general call (broadcast) address
259 * is received and acknowleged, stays set until
260 * cleared by reading CLR_GEN_CALL.
261 *
262 * START_DET Set when a START or RESTART condition has occurred
263 * on the interface.
264 *
265 * STOP_DET Set when a STOP condition has occurred on the
266 * interface.
267 *
268 * ACTIVITY Set by any activity on the interface. Cleared
269 * by reading CLR_ACTIVITY or CLR_INTR.
270 *
271 * TX_ABRT Indicates the controller as a transmitter is
272 * unable to complete the intended action. When set,
273 * the controller will hold the TX FIFO in a reset
274 * state (flushed) until CLR_TX_ABORT is read to
275 * clear the condition. Once cleared, the TX FIFO
276 * will be available again.
277 *
278 * TX_EMPTY Indicates that the transmitter is at or below
279 * the specified TX_TL threshold. Automatically
280 * cleared by HW when the buffer level goes above
281 * the threshold.
282 *
283 * TX_OVER Indicates that the processor attempted to write
284 * to the TX FIFO while the TX FIFO was full. Cleared
285 * by reading CLR_TX_OVER.
286 *
287 * RX_FULL Indicates that the receive FIFO has reached or
288 * exceeded the specified RX_TL threshold. Cleared
289 * by HW when the cpu drains the FIFO to below the
290 * threshold.
291 *
292 * RX_OVER Indicates that the receive FIFO was unable to
293 * accept new data and data was lost. Cleared by
294 * reading CLR_RX_OVER.
295 *
296 * RX_UNDER Indicates that the cpu attempted to read data
297 * from the receive buffer while the RX FIFO was
298 * empty. Cleared by reading CLR_RX_UNDER.
299 *
300 * NOTES ON RAW_INTR_STAT:
301 *
302 * This register can be used to monitor the GEN_CALL, START_DET,
303 * STOP_DET, ACTIVITY, TX_ABRT, TX_EMPTY, TX_OVER, RX_FULL, RX_OVER,
304 * and RX_UNDER bits. The documentation is a bit unclear but presumably
305 * this is the unlatched version.
306 *
307 * Code should test FIFO conditions using the I2C_STA (status) register,
308 * not the interrupt status registers.
309 */
310
311 #define IG4_INTR_GEN_CALL 0x0800
312 #define IG4_INTR_START_DET 0x0400
313 #define IG4_INTR_STOP_DET 0x0200
314 #define IG4_INTR_ACTIVITY 0x0100
315 #define IG4_INTR_TX_ABRT 0x0040
316 #define IG4_INTR_TX_EMPTY 0x0010
317 #define IG4_INTR_TX_OVER 0x0008
318 #define IG4_INTR_RX_FULL 0x0004
319 #define IG4_INTR_RX_OVER 0x0002
320 #define IG4_INTR_RX_UNDER 0x0001
321
322 /*
323 * RX_TL - (RW) Receive FIFO Threshold Register 22.2.11
324 * TX_TL - (RW) Transmit FIFO Threshold Register 22.2.12
325 *
326 * Specify the receive and transmit FIFO threshold register. The
327 * FIFOs have 16 elements. The valid range is 0-15. Setting a
328 * value greater than 15 causes the actual value to be the maximum
329 * depth of the FIFO.
330 *
331 * Generally speaking since everything is messaged, we can use a
332 * mid-level setting for both parameters and (e.g.) fully drain the
333 * receive FIFO on the STOP_DET condition to handle loose ends.
334 */
335 #define IG4_FIFO_MASK 0x00FF
336 #define IG4_FIFO_LIMIT 16
337
338 /*
339 * CLR_INTR - (RO) Clear Interrupt Register 22.2.13
340 * CLR_RX_UNDER - (RO) Clear Interrupt Register (specific) 22.2.14
341 * CLR_RX_OVER - (RO) Clear Interrupt Register (specific) 22.2.15
342 * CLR_TX_OVER - (RO) Clear Interrupt Register (specific) 22.2.16
343 * CLR_TX_ABORT - (RO) Clear Interrupt Register (specific) 22.2.17
344 * CLR_ACTIVITY - (RO) Clear Interrupt Register (specific) 22.2.18
345 * CLR_STOP_DET - (RO) Clear Interrupt Register (specific) 22.2.19
346 * CLR_START_DET- (RO) Clear Interrupt Register (specific) 22.2.20
347 * CLR_GEN_CALL - (RO) Clear Interrupt Register (specific) 22.2.21
348 *
349 * CLR_* specific operations clear the appropriate bit in the
350 * RAW_INTR_STAT register. Intel does not really document whether
351 * these operations clear the normal interrupt status register.
352 *
353 * CLR_INTR clears bits in the normal interrupt status register and
354 * presumably also the raw(?) register? Intel is again unclear.
355 *
356 * NOTE: CLR_INTR only clears software-clearable interrupts. Hardware
357 * clearable interrupts are controlled entirely by the hardware.
358 * CLR_INTR also clears the TX_ABRT_SOURCE register.
359 *
360 * NOTE: CLR_TX_ABORT also clears the TX_ABRT_SOURCE register and releases
361 * the TX FIFO from its flushed/reset state, allowing more writes
362 * to the TX FIFO.
363 *
364 * NOTE: CLR_ACTIVITY has no effect if the I2C bus is still active.
365 * Intel documents that the bit is automatically cleared when
366 * there is no further activity on the bus.
367 */
368 #define IG4_CLR_BIT 0x0001 /* Reflects source */
369
370 /*
371 * I2C_EN - (RW) I2C Enable Register 22.2.22
372 *
373 * ABORT Software can abort an I2C transfer by setting this
374 * bit. Hardware will clear the bit once the STOP has
375 * been detected. This bit can only be set while the
376 * I2C interface is enabled.
377 *
378 * I2C_ENABLE Enable the controller, else disable it.
379 * (Use I2C_ENABLE_STATUS to poll enable status
380 * & wait for changes)
381 */
382 #define IG4_I2C_ABORT 0x0002
383 #define IG4_I2C_ENABLE 0x0001
384
385 /*
386 * I2C_STA - (RO) I2C Status Register 22.2.23
387 */
388 #define IG4_STATUS_ACTIVITY 0x0020 /* Controller is active */
389 #define IG4_STATUS_RX_FULL 0x0010 /* RX FIFO completely full */
390 #define IG4_STATUS_RX_NOTEMPTY 0x0008 /* RX FIFO not empty */
391 #define IG4_STATUS_TX_EMPTY 0x0004 /* TX FIFO completely empty */
392 #define IG4_STATUS_TX_NOTFULL 0x0002 /* TX FIFO not full */
393 #define IG4_STATUS_I2C_ACTIVE 0x0001 /* I2C bus is active */
394
395 /*
396 * TXFLR - (RO) Transmit FIFO Level Register 22.2.24
397 * RXFLR - (RO) Receive FIFO Level Register 22.2.25
398 *
399 * Read the number of entries currently in the Transmit or Receive
400 * FIFOs. Note that for some reason the mask is 9 bits instead of
401 * the 8 bits the fill level controls.
402 */
403 #define IG4_FIFOLVL_MASK 0x001F
404
405 /*
406 * SDA_HOLD - (RW) SDA Hold Time Length Register 22.2.26
407 *
408 * Set the SDA hold time length register in I2C clocks.
409 */
410 #define IG4_SDA_HOLD_MASK 0x00FF
411
412 /*
413 * TX_ABRT_SOURCE- (RO) Transmit Abort Source Register 22.2.27
414 *
415 * Indicates the cause of a transmit abort. This can indicate a
416 * software programming error or a device expected address width
417 * mismatch or other issues. The NORESTART conditions and GENCALL_NOACK
418 * can only occur if a programming error was made in the driver software.
419 *
420 * In particular, it should be possible to detect whether any devices
421 * are on the bus by observing the GENCALL_READ status, and it might
422 * be possible to detect ADDR7 vs ADDR10 mismatches.
423 */
424 #define IG4_ABRTSRC_TRANSFER 0x00010000 /* Abort initiated by user */
425 #define IG4_ABRTSRC_ARBLOST 0x00001000 /* Arbitration lost */
426 #define IG4_ABRTSRC_NORESTART_10 0x00000400 /* RESTART disabled */
427 #define IG4_ABRTSRC_NORESTART_START 0x00000200 /* RESTART disabled */
428 #define IG4_ABRTSRC_ACKED_START 0x00000080 /* Improper acked START */
429 #define IG4_ABRTSRC_GENCALL_NOACK 0x00000020 /* Improper GENCALL */
430 #define IG4_ABRTSRC_GENCALL_READ 0x00000010 /* Nobody acked GENCALL */
431 #define IG4_ABRTSRC_TXNOACK_DATA 0x00000008 /* data phase no ACK */
432 #define IG4_ABRTSRC_TXNOACK_ADDR10_2 0x00000004 /* addr10/1 phase no ACK */
433 #define IG4_ABRTSRC_TXNOACK_ADDR10_1 0x00000002 /* addr10/2 phase no ACK */
434 #define IG4_ABRTSRC_TXNOACK_ADDR7 0x00000001 /* addr7 phase no ACK */
435
436 /*
437 * SLV_DATA_NACK - (RW) Generate Slave DATA NACK Register 22.2.28
438 *
439 * When the controller is a receiver a NACK can be generated on
440 * receipt of data.
441 *
442 * NACK_GENERATE Set to 0 for normal NACK/ACK generation.
443 * Set to 1 to generate a NACK after next data
444 * byte received.
445 *
446 */
447 #define IG4_NACK_GENERATE 0x0001
448
449 /*
450 * DMA_CTRL - (RW) DMA Control Register 22.2.29
451 *
452 * Enables DMA on the transmit and/or receive DMA channel.
453 */
454 #define IG4_TX_DMA_ENABLE 0x0002
455 #define IG4_RX_DMA_ENABLE 0x0001
456
457 /*
458 * DMA_TDLR - (RW) DMA Transmit Data Level Register 22.2.30
459 * DMA_RDLR - (RW) DMA Receive Data Level Register 22.2.31
460 *
461 * Similar to RX_TL and TX_TL but controls when a DMA burst occurs
462 * to empty or fill the FIFOs. Use the same IG4_FIFO_MASK and
463 * IG4_FIFO_LIMIT defines for RX_RL and TX_TL.
464 */
465 /* empty */
466
467 /*
468 * SDA_SETUP - (RW) SDA Setup Time Length Register 22.2.32
469 *
470 * Set the SDA setup time length register in I2C clocks.
471 * The register must be programmed with a value >=2.
472 * (Defaults to 0x64).
473 */
474 #define IG4_SDA_SETUP_MASK 0x00FF
475
476 /*
477 * ACK_GEN_CALL - (RW) ACK General Call Register 22.2.33
478 *
479 * Control whether the controller responds with a ACK or NACK when
480 * it receives an I2C General Call address.
481 *
482 * If set to 0 a NACK is generated and a General Call interrupt is
483 * NOT generated. Otherwise an ACK + interrupt is generated.
484 */
485 #define IG4_ACKGC_ACK 0x0001
486
487 /*
488 * ENABLE_STATUS - (RO) Enable Status Registger 22.2.34
489 *
490 * DATA_LOST - Indicates that a slave receiver operation has
491 * been aborted with at least one data byte received
492 * from a transfer due to the I2C controller being
493 * disabled (IG4_I2C_ENABLE -> 0)
494 *
495 * ENABLED - Intel documentation is lacking but I assume this
496 * is a reflection of the IG4_I2C_ENABLE bit in the
497 * I2C_EN register.
498 *
499 */
500 #define IG4_ENASTAT_DATA_LOST 0x0004
501 #define IG4_ENASTAT_ENABLED 0x0001
502
503 /*
504 * COMP_PARAM1 - (RO) Component Parameter Register 22.2.35
505 * Default Value 0x00FFFF6E
506 *
507 * VALID - Intel documentation is unclear but I believe this
508 * must be read as a 1 to indicate that the rest of
509 * the bits in the register are valid.
510 *
511 * HASDMA - Indicates that the chip is DMA-capable. Presumably
512 * in certain virtualization cases the chip might be
513 * set to not be DMA-capable.
514 *
515 * INTR_IO - Indicates that all interrupts are combined to
516 * generate one interrupt. If not set, interrupts
517 * are individual (more virtualization stuff?)
518 *
519 * HCCNT_RO - Indicates that the clock timing registers are
520 * RW. If not set, the registers are RO.
521 * (more virtualization stuff).
522 *
523 * MAXSPEED - Indicates the maximum speed supported.
524 *
525 * DATAW - Indicates the internal bus width in bits.
526 */
527 #define IG4_PARAM1_TXFIFO_DEPTH(v) (((v) >> 16) & 0xFF)
528 #define IG4_PARAM1_RXFIFO_DEPTH(v) (((v) >> 8) & 0xFF)
529 #define IG4_PARAM1_CONFIG_VALID 0x00000080
530 #define IG4_PARAM1_CONFIG_HASDMA 0x00000040
531 #define IG4_PARAM1_CONFIG_INTR_IO 0x00000020
532 #define IG4_PARAM1_CONFIG_HCCNT_RO 0x00000010
533 #define IG4_PARAM1_CONFIG_MAXSPEED_MASK 0x0000000C
534 #define IG4_PARAM1_CONFIG_DATAW_MASK 0x00000003
535
536 #define IG4_CONFIG_MAXSPEED_RESERVED00 0x00000000
537 #define IG4_CONFIG_MAXSPEED_STANDARD 0x00000004
538 #define IG4_CONFIG_MAXSPEED_FAST 0x00000008
539 #define IG4_CONFIG_MAXSPEED_HIGH 0x0000000C
540
541 #define IG4_CONFIG_DATAW_8 0x00000000
542 #define IG4_CONFIG_DATAW_16 0x00000001
543 #define IG4_CONFIG_DATAW_32 0x00000002
544 #define IG4_CONFIG_DATAW_RESERVED11 0x00000003
545
546 /*
547 * COMP_VER - (RO) Component Version Register 22.2.36
548 * Default Value 0x3131352A
549 *
550 * Contains the chip version number. All 32 bits.
551 */
552 #define IG4_COMP_VER 0x3131352A
553
554 /*
555 * COMP_TYPE - (RO) (linux) Endian and bus width probe
556 *
557 * Read32 from this register and test against IG4_COMP_TYPE
558 * to determine the bus width. e.g. 01404457 = endian-reversed,
559 * and 00000140 or 00004457 means internal 16-bit bus (?).
560 *
561 * This register is not in the intel documentation, I pulled it
562 * from the linux driver i2c-designware-core.c.
563 */
564 #define IG4_COMP_TYPE 0x44570140
565
566 /*
567 * RESETS - (RW) Resets Register 22.2.37
568 *
569 * Used to reset the I2C host controller by SW. There is no timing
570 * requirement, software can assert and de-assert in back-to-back
571 * transactions.
572 *
573 * 00 I2C host controller is NOT in reset.
574 * 01 (reserved)
575 * 10 (reserved)
576 * 11 I2C host controller is in reset.
577 */
578 #define IG4_RESETS_ASSERT_HSW 0x0003
579 #define IG4_RESETS_DEASSERT_HSW 0x0000
580
581 /* Skylake-U/Y and Kaby Lake-U/Y have the reset bits inverted */
582 #define IG4_RESETS_DEASSERT_SKL 0x0003
583 #define IG4_RESETS_ASSERT_SKL 0x0000
584
585 /*
586 * GENERAL - (RW) General Reigster 22.2.38
587 *
588 * IOVOLT 0=1.8V 1=3.3V
589 *
590 * LTR 0=Auto 1=SW
591 *
592 * In Auto mode the BIOS will write to the host controller's
593 * AUTO LTR Value register (offset 0x0814) with the active
594 * state LTR value, and will write to the SW LTR Value register
595 * (offset 0x0810) with the idle state LTR value.
596 *
597 * In SW mode the SW will write to the host controller SW LTR
598 * value (offset 0x0810). It is the SW responsibility to update
599 * the LTR with the appropriate value.
600 */
601 #define IG4_GENERAL_IOVOLT3_3 0x0008
602 #define IG4_GENERAL_SWMODE 0x0004
603
604 /*
605 * SW_LTR_VALUE - (RW) SW LTR Value Register 22.2.39
606 * AUTO_LTR_VALUE - (RW) SW LTR Value Register 22.2.40
607 *
608 * Default value is 0x00000800 which means the best possible
609 * service/response time.
610 *
611 * It isn't quite clear how the snooping works. There are two scale
612 * bits for both sets but two of the four codes are reserved. The
613 * *SNOOP_VALUE() is specified as a 10-bit latency value. If 0, it
614 * indicates that the device cannot tolerate any delay and needs the
615 * best possible service/response time.
616 *
617 * I think this is for snooping (testing) the I2C bus. The lowest
618 * delay (0) probably runs the controller polling at a high, power hungry
619 * rate. But I dunno.
620 */
621 #define IG4_SWLTR_NSNOOP_REQ 0x80000000 /* (ro) */
622 #define IG4_SWLTR_NSNOOP_SCALE_MASK 0x1C000000 /* (ro) */
623 #define IG4_SWLTR_NSNOOP_SCALE_1US 0x08000000 /* (ro) */
624 #define IG4_SWLTR_NSNOOP_SCALE_32US 0x0C000000 /* (ro) */
625 #define IG4_SWLTR_NSNOOP_VALUE_DECODE(v) (((v) >> 16) & 0x3F)
626 #define IG4_SWLTR_NSNOOP_VALUE_ENCODE(v) (((v) & 0x3F) << 16)
627
628 #define IG4_SWLTR_SNOOP_REQ 0x00008000 /* (rw) */
629 #define IG4_SWLTR_SNOOP_SCALE_MASK 0x00001C00 /* (rw) */
630 #define IG4_SWLTR_SNOOP_SCALE_1US 0x00000800 /* (rw) */
631 #define IG4_SWLTR_SNOOP_SCALE_32US 0x00000C00 /* (rw) */
632 #define IG4_SWLTR_SNOOP_VALUE_DECODE(v) ((v) & 0x3F)
633 #define IG4_SWLTR_SNOOP_VALUE_ENCODE(v) ((v) & 0x3F)
634
635 #endif /* _ICHIIC_IG4_REG_H_ */
Cache object: ef5ab1774356b48337acc91ffd5c3d0c
|