2 Copyright (c) 1998 - 2002 Frodo Looijaard <frodol@dds.nl>,
3 Philip Edelbrock <phil@netroedge.com>, and Mark D. Studebaker
5 Copyright (C) 2007 - 2014 Jean Delvare <jdelvare@suse.de>
6 Copyright (C) 2010 Intel Corporation,
7 David Woodhouse <dwmw2@infradead.org>
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
21 * Supports the following Intel I/O Controller Hubs (ICH):
24 * region SMBus Block proc. block
25 * Chip name PCI ID size PEC buffer call read
26 * ---------------------------------------------------------------------------
27 * 82801AA (ICH) 0x2413 16 no no no no
28 * 82801AB (ICH0) 0x2423 16 no no no no
29 * 82801BA (ICH2) 0x2443 16 no no no no
30 * 82801CA (ICH3) 0x2483 32 soft no no no
31 * 82801DB (ICH4) 0x24c3 32 hard yes no no
32 * 82801E (ICH5) 0x24d3 32 hard yes yes yes
33 * 6300ESB 0x25a4 32 hard yes yes yes
34 * 82801F (ICH6) 0x266a 32 hard yes yes yes
35 * 6310ESB/6320ESB 0x269b 32 hard yes yes yes
36 * 82801G (ICH7) 0x27da 32 hard yes yes yes
37 * 82801H (ICH8) 0x283e 32 hard yes yes yes
38 * 82801I (ICH9) 0x2930 32 hard yes yes yes
39 * EP80579 (Tolapai) 0x5032 32 hard yes yes yes
40 * ICH10 0x3a30 32 hard yes yes yes
41 * ICH10 0x3a60 32 hard yes yes yes
42 * 5/3400 Series (PCH) 0x3b30 32 hard yes yes yes
43 * 6 Series (PCH) 0x1c22 32 hard yes yes yes
44 * Patsburg (PCH) 0x1d22 32 hard yes yes yes
45 * Patsburg (PCH) IDF 0x1d70 32 hard yes yes yes
46 * Patsburg (PCH) IDF 0x1d71 32 hard yes yes yes
47 * Patsburg (PCH) IDF 0x1d72 32 hard yes yes yes
48 * DH89xxCC (PCH) 0x2330 32 hard yes yes yes
49 * Panther Point (PCH) 0x1e22 32 hard yes yes yes
50 * Lynx Point (PCH) 0x8c22 32 hard yes yes yes
51 * Lynx Point-LP (PCH) 0x9c22 32 hard yes yes yes
52 * Avoton (SOC) 0x1f3c 32 hard yes yes yes
53 * Wellsburg (PCH) 0x8d22 32 hard yes yes yes
54 * Wellsburg (PCH) MS 0x8d7d 32 hard yes yes yes
55 * Wellsburg (PCH) MS 0x8d7e 32 hard yes yes yes
56 * Wellsburg (PCH) MS 0x8d7f 32 hard yes yes yes
57 * Coleto Creek (PCH) 0x23b0 32 hard yes yes yes
58 * Wildcat Point (PCH) 0x8ca2 32 hard yes yes yes
59 * Wildcat Point-LP (PCH) 0x9ca2 32 hard yes yes yes
60 * BayTrail (SOC) 0x0f12 32 hard yes yes yes
61 * Braswell (SOC) 0x2292 32 hard yes yes yes
62 * Sunrise Point-H (PCH) 0xa123 32 hard yes yes yes
63 * Sunrise Point-LP (PCH) 0x9d23 32 hard yes yes yes
64 * DNV (SOC) 0x19df 32 hard yes yes yes
65 * Broxton (SOC) 0x5ad4 32 hard yes yes yes
66 * Lewisburg (PCH) 0xa1a3 32 hard yes yes yes
67 * Lewisburg Supersku (PCH) 0xa223 32 hard yes yes yes
68 * Kaby Lake PCH-H (PCH) 0xa2a3 32 hard yes yes yes
69 * Gemini Lake (SOC) 0x31d4 32 hard yes yes yes
70 * Cannon Lake-H (PCH) 0xa323 32 hard yes yes yes
71 * Cannon Lake-LP (PCH) 0x9da3 32 hard yes yes yes
72 * Cedar Fork (PCH) 0x18df 32 hard yes yes yes
73 * Ice Lake-LP (PCH) 0x34a3 32 hard yes yes yes
75 * Features supported by this driver:
79 * Block process call transaction no
80 * I2C block read transaction yes (doesn't use the block buffer)
82 * SMBus Host Notify yes
83 * Interrupt processing yes
85 * See the file Documentation/i2c/busses/i2c-i801 for details.
88 #include <linux/interrupt.h>
89 #include <linux/module.h>
90 #include <linux/pci.h>
91 #include <linux/kernel.h>
92 #include <linux/stddef.h>
93 #include <linux/delay.h>
94 #include <linux/ioport.h>
95 #include <linux/init.h>
96 #include <linux/i2c.h>
97 #include <linux/i2c-smbus.h>
98 #include <linux/acpi.h>
100 #include <linux/dmi.h>
101 #include <linux/slab.h>
102 #include <linux/wait.h>
103 #include <linux/err.h>
104 #include <linux/platform_device.h>
105 #include <linux/platform_data/itco_wdt.h>
106 #include <linux/pm_runtime.h>
108 #if IS_ENABLED(CONFIG_I2C_MUX_GPIO) && defined CONFIG_DMI
109 #include <linux/gpio.h>
110 #include <linux/platform_data/i2c-mux-gpio.h>
113 /* I801 SMBus address offsets */
114 #define SMBHSTSTS(p) (0 + (p)->smba)
115 #define SMBHSTCNT(p) (2 + (p)->smba)
116 #define SMBHSTCMD(p) (3 + (p)->smba)
117 #define SMBHSTADD(p) (4 + (p)->smba)
118 #define SMBHSTDAT0(p) (5 + (p)->smba)
119 #define SMBHSTDAT1(p) (6 + (p)->smba)
120 #define SMBBLKDAT(p) (7 + (p)->smba)
121 #define SMBPEC(p) (8 + (p)->smba) /* ICH3 and later */
122 #define SMBAUXSTS(p) (12 + (p)->smba) /* ICH4 and later */
123 #define SMBAUXCTL(p) (13 + (p)->smba) /* ICH4 and later */
124 #define SMBSLVSTS(p) (16 + (p)->smba) /* ICH3 and later */
125 #define SMBSLVCMD(p) (17 + (p)->smba) /* ICH3 and later */
126 #define SMBNTFDADD(p) (20 + (p)->smba) /* ICH3 and later */
128 /* PCI Address Constants */
130 #define SMBPCICTL 0x004
131 #define SMBPCISTS 0x006
132 #define SMBHSTCFG 0x040
133 #define TCOBASE 0x050
136 #define ACPIBASE 0x040
137 #define ACPIBASE_SMI_OFF 0x030
138 #define ACPICTRL 0x044
139 #define ACPICTRL_EN 0x080
141 #define SBREG_BAR 0x10
142 #define SBREG_SMBCTRL 0xc6000c
144 /* Host status bits for SMBPCISTS */
145 #define SMBPCISTS_INTS BIT(3)
147 /* Control bits for SMBPCICTL */
148 #define SMBPCICTL_INTDIS BIT(10)
150 /* Host configuration bits for SMBHSTCFG */
151 #define SMBHSTCFG_HST_EN BIT(0)
152 #define SMBHSTCFG_SMB_SMI_EN BIT(1)
153 #define SMBHSTCFG_I2C_EN BIT(2)
154 #define SMBHSTCFG_SPD_WD BIT(4)
156 /* TCO configuration bits for TCOCTL */
157 #define TCOCTL_EN BIT(8)
159 /* Auxiliary status register bits, ICH4+ only */
160 #define SMBAUXSTS_CRCE BIT(0)
161 #define SMBAUXSTS_STCO BIT(1)
163 /* Auxiliary control register bits, ICH4+ only */
164 #define SMBAUXCTL_CRC BIT(0)
165 #define SMBAUXCTL_E32B BIT(1)
168 #define MAX_RETRIES 400
170 /* I801 command constants */
171 #define I801_QUICK 0x00
172 #define I801_BYTE 0x04
173 #define I801_BYTE_DATA 0x08
174 #define I801_WORD_DATA 0x0C
175 #define I801_PROC_CALL 0x10 /* unimplemented */
176 #define I801_BLOCK_DATA 0x14
177 #define I801_I2C_BLOCK_DATA 0x18 /* ICH5 and later */
179 /* I801 Host Control register bits */
180 #define SMBHSTCNT_INTREN BIT(0)
181 #define SMBHSTCNT_KILL BIT(1)
182 #define SMBHSTCNT_LAST_BYTE BIT(5)
183 #define SMBHSTCNT_START BIT(6)
184 #define SMBHSTCNT_PEC_EN BIT(7) /* ICH3 and later */
186 /* I801 Hosts Status register bits */
187 #define SMBHSTSTS_BYTE_DONE BIT(7)
188 #define SMBHSTSTS_INUSE_STS BIT(6)
189 #define SMBHSTSTS_SMBALERT_STS BIT(5)
190 #define SMBHSTSTS_FAILED BIT(4)
191 #define SMBHSTSTS_BUS_ERR BIT(3)
192 #define SMBHSTSTS_DEV_ERR BIT(2)
193 #define SMBHSTSTS_INTR BIT(1)
194 #define SMBHSTSTS_HOST_BUSY BIT(0)
196 /* Host Notify Status register bits */
197 #define SMBSLVSTS_HST_NTFY_STS BIT(0)
199 /* Host Notify Command register bits */
200 #define SMBSLVCMD_HST_NTFY_INTREN BIT(0)
202 #define STATUS_ERROR_FLAGS (SMBHSTSTS_FAILED | SMBHSTSTS_BUS_ERR | \
205 #define STATUS_FLAGS (SMBHSTSTS_BYTE_DONE | SMBHSTSTS_INTR | \
208 /* Older devices have their ID defined in <linux/pci_ids.h> */
209 #define PCI_DEVICE_ID_INTEL_BAYTRAIL_SMBUS 0x0f12
210 #define PCI_DEVICE_ID_INTEL_CDF_SMBUS 0x18df
211 #define PCI_DEVICE_ID_INTEL_DNV_SMBUS 0x19df
212 #define PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS 0x1c22
213 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS 0x1d22
214 /* Patsburg also has three 'Integrated Device Function' SMBus controllers */
215 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0 0x1d70
216 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1 0x1d71
217 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2 0x1d72
218 #define PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS 0x1e22
219 #define PCI_DEVICE_ID_INTEL_AVOTON_SMBUS 0x1f3c
220 #define PCI_DEVICE_ID_INTEL_BRASWELL_SMBUS 0x2292
221 #define PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS 0x2330
222 #define PCI_DEVICE_ID_INTEL_COLETOCREEK_SMBUS 0x23b0
223 #define PCI_DEVICE_ID_INTEL_GEMINILAKE_SMBUS 0x31d4
224 #define PCI_DEVICE_ID_INTEL_ICELAKE_LP_SMBUS 0x34a3
225 #define PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS 0x3b30
226 #define PCI_DEVICE_ID_INTEL_BROXTON_SMBUS 0x5ad4
227 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS 0x8c22
228 #define PCI_DEVICE_ID_INTEL_WILDCATPOINT_SMBUS 0x8ca2
229 #define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS 0x8d22
230 #define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0 0x8d7d
231 #define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1 0x8d7e
232 #define PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2 0x8d7f
233 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS 0x9c22
234 #define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_SMBUS 0x9ca2
235 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS 0x9d23
236 #define PCI_DEVICE_ID_INTEL_CANNONLAKE_LP_SMBUS 0x9da3
237 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS 0xa123
238 #define PCI_DEVICE_ID_INTEL_LEWISBURG_SMBUS 0xa1a3
239 #define PCI_DEVICE_ID_INTEL_LEWISBURG_SSKU_SMBUS 0xa223
240 #define PCI_DEVICE_ID_INTEL_KABYLAKE_PCH_H_SMBUS 0xa2a3
241 #define PCI_DEVICE_ID_INTEL_CANNONLAKE_H_SMBUS 0xa323
243 struct i801_mux_config {
248 unsigned gpios[2]; /* Relative to gpio_chip->base */
253 struct i2c_adapter adapter;
255 unsigned char original_hstcfg;
256 unsigned char original_slvcmd;
257 struct pci_dev *pci_dev;
258 unsigned int features;
261 wait_queue_head_t waitq;
264 /* Command state used by isr for byte-by-byte block transactions */
271 #if IS_ENABLED(CONFIG_I2C_MUX_GPIO) && defined CONFIG_DMI
272 const struct i801_mux_config *mux_drvdata;
273 struct platform_device *mux_pdev;
275 struct platform_device *tco_pdev;
278 * If set to true the host controller registers are reserved for
279 * ACPI AML use. Protected by acpi_lock.
282 struct mutex acpi_lock;
285 #define FEATURE_SMBUS_PEC BIT(0)
286 #define FEATURE_BLOCK_BUFFER BIT(1)
287 #define FEATURE_BLOCK_PROC BIT(2)
288 #define FEATURE_I2C_BLOCK_READ BIT(3)
289 #define FEATURE_IRQ BIT(4)
290 #define FEATURE_HOST_NOTIFY BIT(5)
291 /* Not really a feature, but it's convenient to handle it as such */
292 #define FEATURE_IDF BIT(15)
293 #define FEATURE_TCO BIT(16)
295 static const char *i801_feature_names[] = {
298 "Block process call",
304 static unsigned int disable_features;
305 module_param(disable_features, uint, S_IRUGO | S_IWUSR);
306 MODULE_PARM_DESC(disable_features, "Disable selected driver features:\n"
307 "\t\t 0x01 disable SMBus PEC\n"
308 "\t\t 0x02 disable the block buffer\n"
309 "\t\t 0x08 disable the I2C block read functionality\n"
310 "\t\t 0x10 don't use interrupts\n"
311 "\t\t 0x20 disable SMBus Host Notify ");
313 /* Make sure the SMBus host is ready to start transmitting.
314 Return 0 if it is, -EBUSY if it is not. */
315 static int i801_check_pre(struct i801_priv *priv)
319 status = inb_p(SMBHSTSTS(priv));
320 if (status & SMBHSTSTS_HOST_BUSY) {
321 dev_err(&priv->pci_dev->dev, "SMBus is busy, can't use it!\n");
325 status &= STATUS_FLAGS;
327 dev_dbg(&priv->pci_dev->dev, "Clearing status flags (%02x)\n",
329 outb_p(status, SMBHSTSTS(priv));
330 status = inb_p(SMBHSTSTS(priv)) & STATUS_FLAGS;
332 dev_err(&priv->pci_dev->dev,
333 "Failed clearing status flags (%02x)\n",
340 * Clear CRC status if needed.
341 * During normal operation, i801_check_post() takes care
342 * of it after every operation. We do it here only in case
343 * the hardware was already in this state when the driver
346 if (priv->features & FEATURE_SMBUS_PEC) {
347 status = inb_p(SMBAUXSTS(priv)) & SMBAUXSTS_CRCE;
349 dev_dbg(&priv->pci_dev->dev,
350 "Clearing aux status flags (%02x)\n", status);
351 outb_p(status, SMBAUXSTS(priv));
352 status = inb_p(SMBAUXSTS(priv)) & SMBAUXSTS_CRCE;
354 dev_err(&priv->pci_dev->dev,
355 "Failed clearing aux status flags (%02x)\n",
366 * Convert the status register to an error code, and clear it.
367 * Note that status only contains the bits we want to clear, not the
368 * actual register value.
370 static int i801_check_post(struct i801_priv *priv, int status)
375 * If the SMBus is still busy, we give up
376 * Note: This timeout condition only happens when using polling
377 * transactions. For interrupt operation, NAK/timeout is indicated by
380 if (unlikely(status < 0)) {
381 dev_err(&priv->pci_dev->dev, "Transaction timeout\n");
382 /* try to stop the current command */
383 dev_dbg(&priv->pci_dev->dev, "Terminating the current operation\n");
384 outb_p(inb_p(SMBHSTCNT(priv)) | SMBHSTCNT_KILL,
386 usleep_range(1000, 2000);
387 outb_p(inb_p(SMBHSTCNT(priv)) & (~SMBHSTCNT_KILL),
390 /* Check if it worked */
391 status = inb_p(SMBHSTSTS(priv));
392 if ((status & SMBHSTSTS_HOST_BUSY) ||
393 !(status & SMBHSTSTS_FAILED))
394 dev_err(&priv->pci_dev->dev,
395 "Failed terminating the transaction\n");
396 outb_p(STATUS_FLAGS, SMBHSTSTS(priv));
400 if (status & SMBHSTSTS_FAILED) {
402 dev_err(&priv->pci_dev->dev, "Transaction failed\n");
404 if (status & SMBHSTSTS_DEV_ERR) {
406 * This may be a PEC error, check and clear it.
408 * AUXSTS is handled differently from HSTSTS.
409 * For HSTSTS, i801_isr() or i801_wait_intr()
410 * has already cleared the error bits in hardware,
411 * and we are passed a copy of the original value
413 * For AUXSTS, the hardware register is left
414 * for us to handle here.
415 * This is asymmetric, slightly iffy, but safe,
416 * since all this code is serialized and the CRCE
417 * bit is harmless as long as it's cleared before
418 * the next operation.
420 if ((priv->features & FEATURE_SMBUS_PEC) &&
421 (inb_p(SMBAUXSTS(priv)) & SMBAUXSTS_CRCE)) {
422 outb_p(SMBAUXSTS_CRCE, SMBAUXSTS(priv));
424 dev_dbg(&priv->pci_dev->dev, "PEC error\n");
427 dev_dbg(&priv->pci_dev->dev, "No response\n");
430 if (status & SMBHSTSTS_BUS_ERR) {
432 dev_dbg(&priv->pci_dev->dev, "Lost arbitration\n");
435 /* Clear status flags except BYTE_DONE, to be cleared by caller */
436 outb_p(status, SMBHSTSTS(priv));
441 /* Wait for BUSY being cleared and either INTR or an error flag being set */
442 static int i801_wait_intr(struct i801_priv *priv)
447 /* We will always wait for a fraction of a second! */
449 usleep_range(250, 500);
450 status = inb_p(SMBHSTSTS(priv));
451 } while (((status & SMBHSTSTS_HOST_BUSY) ||
452 !(status & (STATUS_ERROR_FLAGS | SMBHSTSTS_INTR))) &&
453 (timeout++ < MAX_RETRIES));
455 if (timeout > MAX_RETRIES) {
456 dev_dbg(&priv->pci_dev->dev, "INTR Timeout!\n");
459 return status & (STATUS_ERROR_FLAGS | SMBHSTSTS_INTR);
462 /* Wait for either BYTE_DONE or an error flag being set */
463 static int i801_wait_byte_done(struct i801_priv *priv)
468 /* We will always wait for a fraction of a second! */
470 usleep_range(250, 500);
471 status = inb_p(SMBHSTSTS(priv));
472 } while (!(status & (STATUS_ERROR_FLAGS | SMBHSTSTS_BYTE_DONE)) &&
473 (timeout++ < MAX_RETRIES));
475 if (timeout > MAX_RETRIES) {
476 dev_dbg(&priv->pci_dev->dev, "BYTE_DONE Timeout!\n");
479 return status & STATUS_ERROR_FLAGS;
482 static int i801_transaction(struct i801_priv *priv, int xact)
486 const struct i2c_adapter *adap = &priv->adapter;
488 result = i801_check_pre(priv);
492 if (priv->features & FEATURE_IRQ) {
493 outb_p(xact | SMBHSTCNT_INTREN | SMBHSTCNT_START,
495 result = wait_event_timeout(priv->waitq,
496 (status = priv->status),
500 dev_warn(&priv->pci_dev->dev,
501 "Timeout waiting for interrupt!\n");
504 return i801_check_post(priv, status);
507 /* the current contents of SMBHSTCNT can be overwritten, since PEC,
508 * SMBSCMD are passed in xact */
509 outb_p(xact | SMBHSTCNT_START, SMBHSTCNT(priv));
511 status = i801_wait_intr(priv);
512 return i801_check_post(priv, status);
515 static int i801_block_transaction_by_block(struct i801_priv *priv,
516 union i2c_smbus_data *data,
517 char read_write, int hwpec)
522 inb_p(SMBHSTCNT(priv)); /* reset the data buffer index */
524 /* Use 32-byte buffer to process this transaction */
525 if (read_write == I2C_SMBUS_WRITE) {
526 len = data->block[0];
527 outb_p(len, SMBHSTDAT0(priv));
528 for (i = 0; i < len; i++)
529 outb_p(data->block[i+1], SMBBLKDAT(priv));
532 status = i801_transaction(priv, I801_BLOCK_DATA |
533 (hwpec ? SMBHSTCNT_PEC_EN : 0));
537 if (read_write == I2C_SMBUS_READ) {
538 len = inb_p(SMBHSTDAT0(priv));
539 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX)
542 data->block[0] = len;
543 for (i = 0; i < len; i++)
544 data->block[i + 1] = inb_p(SMBBLKDAT(priv));
549 static void i801_isr_byte_done(struct i801_priv *priv)
552 /* For SMBus block reads, length is received with first byte */
553 if (((priv->cmd & 0x1c) == I801_BLOCK_DATA) &&
554 (priv->count == 0)) {
555 priv->len = inb_p(SMBHSTDAT0(priv));
556 if (priv->len < 1 || priv->len > I2C_SMBUS_BLOCK_MAX) {
557 dev_err(&priv->pci_dev->dev,
558 "Illegal SMBus block read size %d\n",
561 priv->len = I2C_SMBUS_BLOCK_MAX;
563 dev_dbg(&priv->pci_dev->dev,
564 "SMBus block read size is %d\n",
567 priv->data[-1] = priv->len;
571 if (priv->count < priv->len)
572 priv->data[priv->count++] = inb(SMBBLKDAT(priv));
574 dev_dbg(&priv->pci_dev->dev,
575 "Discarding extra byte on block read\n");
577 /* Set LAST_BYTE for last byte of read transaction */
578 if (priv->count == priv->len - 1)
579 outb_p(priv->cmd | SMBHSTCNT_LAST_BYTE,
581 } else if (priv->count < priv->len - 1) {
582 /* Write next byte, except for IRQ after last byte */
583 outb_p(priv->data[++priv->count], SMBBLKDAT(priv));
586 /* Clear BYTE_DONE to continue with next byte */
587 outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
590 static irqreturn_t i801_host_notify_isr(struct i801_priv *priv)
594 addr = inb_p(SMBNTFDADD(priv)) >> 1;
597 * With the tested platforms, reading SMBNTFDDAT (22 + (p)->smba)
598 * always returns 0. Our current implementation doesn't provide
599 * data, so we just ignore it.
601 i2c_handle_smbus_host_notify(&priv->adapter, addr);
603 /* clear Host Notify bit and return */
604 outb_p(SMBSLVSTS_HST_NTFY_STS, SMBSLVSTS(priv));
609 * There are three kinds of interrupts:
611 * 1) i801 signals transaction completion with one of these interrupts:
613 * DEV_ERR - Invalid command, NAK or communication timeout
614 * BUS_ERR - SMI# transaction collision
615 * FAILED - transaction was canceled due to a KILL request
616 * When any of these occur, update ->status and wake up the waitq.
617 * ->status must be cleared before kicking off the next transaction.
619 * 2) For byte-by-byte (I2C read/write) transactions, one BYTE_DONE interrupt
620 * occurs for each byte of a byte-by-byte to prepare the next byte.
622 * 3) Host Notify interrupts
624 static irqreturn_t i801_isr(int irq, void *dev_id)
626 struct i801_priv *priv = dev_id;
630 /* Confirm this is our interrupt */
631 pci_read_config_word(priv->pci_dev, SMBPCISTS, &pcists);
632 if (!(pcists & SMBPCISTS_INTS))
635 if (priv->features & FEATURE_HOST_NOTIFY) {
636 status = inb_p(SMBSLVSTS(priv));
637 if (status & SMBSLVSTS_HST_NTFY_STS)
638 return i801_host_notify_isr(priv);
641 status = inb_p(SMBHSTSTS(priv));
642 if (status & SMBHSTSTS_BYTE_DONE)
643 i801_isr_byte_done(priv);
646 * Clear irq sources and report transaction result.
647 * ->status must be cleared before the next transaction is started.
649 status &= SMBHSTSTS_INTR | STATUS_ERROR_FLAGS;
651 outb_p(status, SMBHSTSTS(priv));
652 priv->status = status;
653 wake_up(&priv->waitq);
660 * For "byte-by-byte" block transactions:
661 * I2C write uses cmd=I801_BLOCK_DATA, I2C_EN=1
662 * I2C read uses cmd=I801_I2C_BLOCK_DATA
664 static int i801_block_transaction_byte_by_byte(struct i801_priv *priv,
665 union i2c_smbus_data *data,
666 char read_write, int command,
673 const struct i2c_adapter *adap = &priv->adapter;
675 result = i801_check_pre(priv);
679 len = data->block[0];
681 if (read_write == I2C_SMBUS_WRITE) {
682 outb_p(len, SMBHSTDAT0(priv));
683 outb_p(data->block[1], SMBBLKDAT(priv));
686 if (command == I2C_SMBUS_I2C_BLOCK_DATA &&
687 read_write == I2C_SMBUS_READ)
688 smbcmd = I801_I2C_BLOCK_DATA;
690 smbcmd = I801_BLOCK_DATA;
692 if (priv->features & FEATURE_IRQ) {
693 priv->is_read = (read_write == I2C_SMBUS_READ);
694 if (len == 1 && priv->is_read)
695 smbcmd |= SMBHSTCNT_LAST_BYTE;
696 priv->cmd = smbcmd | SMBHSTCNT_INTREN;
699 priv->data = &data->block[1];
701 outb_p(priv->cmd | SMBHSTCNT_START, SMBHSTCNT(priv));
702 result = wait_event_timeout(priv->waitq,
703 (status = priv->status),
707 dev_warn(&priv->pci_dev->dev,
708 "Timeout waiting for interrupt!\n");
711 return i801_check_post(priv, status);
714 for (i = 1; i <= len; i++) {
715 if (i == len && read_write == I2C_SMBUS_READ)
716 smbcmd |= SMBHSTCNT_LAST_BYTE;
717 outb_p(smbcmd, SMBHSTCNT(priv));
720 outb_p(inb(SMBHSTCNT(priv)) | SMBHSTCNT_START,
723 status = i801_wait_byte_done(priv);
727 if (i == 1 && read_write == I2C_SMBUS_READ
728 && command != I2C_SMBUS_I2C_BLOCK_DATA) {
729 len = inb_p(SMBHSTDAT0(priv));
730 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX) {
731 dev_err(&priv->pci_dev->dev,
732 "Illegal SMBus block read size %d\n",
735 while (inb_p(SMBHSTSTS(priv)) &
737 outb_p(SMBHSTSTS_BYTE_DONE,
739 outb_p(SMBHSTSTS_INTR, SMBHSTSTS(priv));
742 data->block[0] = len;
745 /* Retrieve/store value in SMBBLKDAT */
746 if (read_write == I2C_SMBUS_READ)
747 data->block[i] = inb_p(SMBBLKDAT(priv));
748 if (read_write == I2C_SMBUS_WRITE && i+1 <= len)
749 outb_p(data->block[i+1], SMBBLKDAT(priv));
751 /* signals SMBBLKDAT ready */
752 outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
755 status = i801_wait_intr(priv);
757 return i801_check_post(priv, status);
760 static int i801_set_block_buffer_mode(struct i801_priv *priv)
762 outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_E32B, SMBAUXCTL(priv));
763 if ((inb_p(SMBAUXCTL(priv)) & SMBAUXCTL_E32B) == 0)
768 /* Block transaction function */
769 static int i801_block_transaction(struct i801_priv *priv,
770 union i2c_smbus_data *data, char read_write,
771 int command, int hwpec)
776 if (command == I2C_SMBUS_I2C_BLOCK_DATA) {
777 if (read_write == I2C_SMBUS_WRITE) {
778 /* set I2C_EN bit in configuration register */
779 pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &hostc);
780 pci_write_config_byte(priv->pci_dev, SMBHSTCFG,
781 hostc | SMBHSTCFG_I2C_EN);
782 } else if (!(priv->features & FEATURE_I2C_BLOCK_READ)) {
783 dev_err(&priv->pci_dev->dev,
784 "I2C block read is unsupported!\n");
789 if (read_write == I2C_SMBUS_WRITE
790 || command == I2C_SMBUS_I2C_BLOCK_DATA) {
791 if (data->block[0] < 1)
793 if (data->block[0] > I2C_SMBUS_BLOCK_MAX)
794 data->block[0] = I2C_SMBUS_BLOCK_MAX;
796 data->block[0] = 32; /* max for SMBus block reads */
799 /* Experience has shown that the block buffer can only be used for
800 SMBus (not I2C) block transactions, even though the datasheet
801 doesn't mention this limitation. */
802 if ((priv->features & FEATURE_BLOCK_BUFFER)
803 && command != I2C_SMBUS_I2C_BLOCK_DATA
804 && i801_set_block_buffer_mode(priv) == 0)
805 result = i801_block_transaction_by_block(priv, data,
808 result = i801_block_transaction_byte_by_byte(priv, data,
812 if (command == I2C_SMBUS_I2C_BLOCK_DATA
813 && read_write == I2C_SMBUS_WRITE) {
814 /* restore saved configuration register value */
815 pci_write_config_byte(priv->pci_dev, SMBHSTCFG, hostc);
820 /* Return negative errno on error. */
821 static s32 i801_access(struct i2c_adapter *adap, u16 addr,
822 unsigned short flags, char read_write, u8 command,
823 int size, union i2c_smbus_data *data)
827 int ret = 0, xact = 0;
828 struct i801_priv *priv = i2c_get_adapdata(adap);
830 mutex_lock(&priv->acpi_lock);
831 if (priv->acpi_reserved) {
832 mutex_unlock(&priv->acpi_lock);
836 pm_runtime_get_sync(&priv->pci_dev->dev);
838 hwpec = (priv->features & FEATURE_SMBUS_PEC) && (flags & I2C_CLIENT_PEC)
839 && size != I2C_SMBUS_QUICK
840 && size != I2C_SMBUS_I2C_BLOCK_DATA;
843 case I2C_SMBUS_QUICK:
844 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
849 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
851 if (read_write == I2C_SMBUS_WRITE)
852 outb_p(command, SMBHSTCMD(priv));
855 case I2C_SMBUS_BYTE_DATA:
856 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
858 outb_p(command, SMBHSTCMD(priv));
859 if (read_write == I2C_SMBUS_WRITE)
860 outb_p(data->byte, SMBHSTDAT0(priv));
861 xact = I801_BYTE_DATA;
863 case I2C_SMBUS_WORD_DATA:
864 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
866 outb_p(command, SMBHSTCMD(priv));
867 if (read_write == I2C_SMBUS_WRITE) {
868 outb_p(data->word & 0xff, SMBHSTDAT0(priv));
869 outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1(priv));
871 xact = I801_WORD_DATA;
873 case I2C_SMBUS_BLOCK_DATA:
874 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
876 outb_p(command, SMBHSTCMD(priv));
879 case I2C_SMBUS_I2C_BLOCK_DATA:
881 * NB: page 240 of ICH5 datasheet shows that the R/#W
882 * bit should be cleared here, even when reading.
883 * However if SPD Write Disable is set (Lynx Point and later),
884 * the read will fail if we don't set the R/#W bit.
886 outb_p(((addr & 0x7f) << 1) |
887 ((priv->original_hstcfg & SMBHSTCFG_SPD_WD) ?
888 (read_write & 0x01) : 0),
890 if (read_write == I2C_SMBUS_READ) {
891 /* NB: page 240 of ICH5 datasheet also shows
892 * that DATA1 is the cmd field when reading */
893 outb_p(command, SMBHSTDAT1(priv));
895 outb_p(command, SMBHSTCMD(priv));
899 dev_err(&priv->pci_dev->dev, "Unsupported transaction %d\n",
905 if (hwpec) /* enable/disable hardware PEC */
906 outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_CRC, SMBAUXCTL(priv));
908 outb_p(inb_p(SMBAUXCTL(priv)) & (~SMBAUXCTL_CRC),
912 ret = i801_block_transaction(priv, data, read_write, size,
915 ret = i801_transaction(priv, xact);
917 /* Some BIOSes don't like it when PEC is enabled at reboot or resume
918 time, so we forcibly disable it after every transaction. Turn off
919 E32B for the same reason. */
921 outb_p(inb_p(SMBAUXCTL(priv)) &
922 ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
928 if ((read_write == I2C_SMBUS_WRITE) || (xact == I801_QUICK))
931 switch (xact & 0x7f) {
932 case I801_BYTE: /* Result put in SMBHSTDAT0 */
934 data->byte = inb_p(SMBHSTDAT0(priv));
937 data->word = inb_p(SMBHSTDAT0(priv)) +
938 (inb_p(SMBHSTDAT1(priv)) << 8);
943 pm_runtime_mark_last_busy(&priv->pci_dev->dev);
944 pm_runtime_put_autosuspend(&priv->pci_dev->dev);
945 mutex_unlock(&priv->acpi_lock);
950 static u32 i801_func(struct i2c_adapter *adapter)
952 struct i801_priv *priv = i2c_get_adapdata(adapter);
954 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
955 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
956 I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK |
957 ((priv->features & FEATURE_SMBUS_PEC) ? I2C_FUNC_SMBUS_PEC : 0) |
958 ((priv->features & FEATURE_I2C_BLOCK_READ) ?
959 I2C_FUNC_SMBUS_READ_I2C_BLOCK : 0) |
960 ((priv->features & FEATURE_HOST_NOTIFY) ?
961 I2C_FUNC_SMBUS_HOST_NOTIFY : 0);
964 static void i801_enable_host_notify(struct i2c_adapter *adapter)
966 struct i801_priv *priv = i2c_get_adapdata(adapter);
968 if (!(priv->features & FEATURE_HOST_NOTIFY))
971 if (!(SMBSLVCMD_HST_NTFY_INTREN & priv->original_slvcmd))
972 outb_p(SMBSLVCMD_HST_NTFY_INTREN | priv->original_slvcmd,
975 /* clear Host Notify bit to allow a new notification */
976 outb_p(SMBSLVSTS_HST_NTFY_STS, SMBSLVSTS(priv));
979 static void i801_disable_host_notify(struct i801_priv *priv)
981 if (!(priv->features & FEATURE_HOST_NOTIFY))
984 outb_p(priv->original_slvcmd, SMBSLVCMD(priv));
987 static const struct i2c_algorithm smbus_algorithm = {
988 .smbus_xfer = i801_access,
989 .functionality = i801_func,
992 static const struct pci_device_id i801_ids[] = {
993 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AA_3) },
994 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AB_3) },
995 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801BA_2) },
996 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801CA_3) },
997 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_3) },
998 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801EB_3) },
999 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB_4) },
1000 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_16) },
1001 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH7_17) },
1002 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB2_17) },
1003 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH8_5) },
1004 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH9_6) },
1005 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_EP80579_1) },
1006 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_4) },
1007 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_5) },
1008 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS) },
1009 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS) },
1010 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS) },
1011 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0) },
1012 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1) },
1013 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2) },
1014 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS) },
1015 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS) },
1016 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS) },
1017 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS) },
1018 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_AVOTON_SMBUS) },
1019 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS) },
1020 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0) },
1021 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1) },
1022 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2) },
1023 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_COLETOCREEK_SMBUS) },
1024 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_GEMINILAKE_SMBUS) },
1025 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WILDCATPOINT_SMBUS) },
1026 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_SMBUS) },
1027 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BAYTRAIL_SMBUS) },
1028 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BRASWELL_SMBUS) },
1029 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS) },
1030 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS) },
1031 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_CDF_SMBUS) },
1032 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_DNV_SMBUS) },
1033 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_BROXTON_SMBUS) },
1034 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LEWISBURG_SMBUS) },
1035 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LEWISBURG_SSKU_SMBUS) },
1036 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_KABYLAKE_PCH_H_SMBUS) },
1037 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_CANNONLAKE_H_SMBUS) },
1038 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_CANNONLAKE_LP_SMBUS) },
1039 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICELAKE_LP_SMBUS) },
1043 MODULE_DEVICE_TABLE(pci, i801_ids);
1045 #if defined CONFIG_X86 && defined CONFIG_DMI
1046 static unsigned char apanel_addr;
1048 /* Scan the system ROM for the signature "FJKEYINF" */
1049 static __init const void __iomem *bios_signature(const void __iomem *bios)
1052 const unsigned char signature[] = "FJKEYINF";
1054 for (offset = 0; offset < 0x10000; offset += 0x10) {
1055 if (check_signature(bios + offset, signature,
1056 sizeof(signature)-1))
1057 return bios + offset;
1062 static void __init input_apanel_init(void)
1065 const void __iomem *p;
1067 bios = ioremap(0xF0000, 0x10000); /* Can't fail */
1068 p = bios_signature(bios);
1070 /* just use the first address */
1071 apanel_addr = readb(p + 8 + 3) >> 1;
1076 struct dmi_onboard_device_info {
1079 unsigned short i2c_addr;
1080 const char *i2c_type;
1083 static const struct dmi_onboard_device_info dmi_devices[] = {
1084 { "Syleus", DMI_DEV_TYPE_OTHER, 0x73, "fscsyl" },
1085 { "Hermes", DMI_DEV_TYPE_OTHER, 0x73, "fscher" },
1086 { "Hades", DMI_DEV_TYPE_OTHER, 0x73, "fschds" },
1089 static void dmi_check_onboard_device(u8 type, const char *name,
1090 struct i2c_adapter *adap)
1093 struct i2c_board_info info;
1095 for (i = 0; i < ARRAY_SIZE(dmi_devices); i++) {
1096 /* & ~0x80, ignore enabled/disabled bit */
1097 if ((type & ~0x80) != dmi_devices[i].type)
1099 if (strcasecmp(name, dmi_devices[i].name))
1102 memset(&info, 0, sizeof(struct i2c_board_info));
1103 info.addr = dmi_devices[i].i2c_addr;
1104 strlcpy(info.type, dmi_devices[i].i2c_type, I2C_NAME_SIZE);
1105 i2c_new_device(adap, &info);
1110 /* We use our own function to check for onboard devices instead of
1111 dmi_find_device() as some buggy BIOS's have the devices we are interested
1112 in marked as disabled */
1113 static void dmi_check_onboard_devices(const struct dmi_header *dm, void *adap)
1120 count = (dm->length - sizeof(struct dmi_header)) / 2;
1121 for (i = 0; i < count; i++) {
1122 const u8 *d = (char *)(dm + 1) + (i * 2);
1123 const char *name = ((char *) dm) + dm->length;
1130 while (s > 0 && name[0]) {
1131 name += strlen(name) + 1;
1134 if (name[0] == 0) /* Bogus string reference */
1137 dmi_check_onboard_device(type, name, adap);
1141 /* Register optional slaves */
1142 static void i801_probe_optional_slaves(struct i801_priv *priv)
1144 /* Only register slaves on main SMBus channel */
1145 if (priv->features & FEATURE_IDF)
1149 struct i2c_board_info info;
1151 memset(&info, 0, sizeof(struct i2c_board_info));
1152 info.addr = apanel_addr;
1153 strlcpy(info.type, "fujitsu_apanel", I2C_NAME_SIZE);
1154 i2c_new_device(&priv->adapter, &info);
1157 if (dmi_name_in_vendors("FUJITSU"))
1158 dmi_walk(dmi_check_onboard_devices, &priv->adapter);
1161 static void __init input_apanel_init(void) {}
1162 static void i801_probe_optional_slaves(struct i801_priv *priv) {}
1163 #endif /* CONFIG_X86 && CONFIG_DMI */
1165 #if IS_ENABLED(CONFIG_I2C_MUX_GPIO) && defined CONFIG_DMI
1166 static struct i801_mux_config i801_mux_config_asus_z8_d12 = {
1167 .gpio_chip = "gpio_ich",
1168 .values = { 0x02, 0x03 },
1170 .classes = { I2C_CLASS_SPD, I2C_CLASS_SPD },
1171 .gpios = { 52, 53 },
1175 static struct i801_mux_config i801_mux_config_asus_z8_d18 = {
1176 .gpio_chip = "gpio_ich",
1177 .values = { 0x02, 0x03, 0x01 },
1179 .classes = { I2C_CLASS_SPD, I2C_CLASS_SPD, I2C_CLASS_SPD },
1180 .gpios = { 52, 53 },
1184 static const struct dmi_system_id mux_dmi_table[] = {
1187 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1188 DMI_MATCH(DMI_BOARD_NAME, "Z8NA-D6(C)"),
1190 .driver_data = &i801_mux_config_asus_z8_d12,
1194 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1195 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)E-D12(X)"),
1197 .driver_data = &i801_mux_config_asus_z8_d12,
1201 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1202 DMI_MATCH(DMI_BOARD_NAME, "Z8NH-D12"),
1204 .driver_data = &i801_mux_config_asus_z8_d12,
1208 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1209 DMI_MATCH(DMI_BOARD_NAME, "Z8PH-D12/IFB"),
1211 .driver_data = &i801_mux_config_asus_z8_d12,
1215 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1216 DMI_MATCH(DMI_BOARD_NAME, "Z8NR-D12"),
1218 .driver_data = &i801_mux_config_asus_z8_d12,
1222 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1223 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)H-D12"),
1225 .driver_data = &i801_mux_config_asus_z8_d12,
1229 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1230 DMI_MATCH(DMI_BOARD_NAME, "Z8PG-D18"),
1232 .driver_data = &i801_mux_config_asus_z8_d18,
1236 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1237 DMI_MATCH(DMI_BOARD_NAME, "Z8PE-D18"),
1239 .driver_data = &i801_mux_config_asus_z8_d18,
1243 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1244 DMI_MATCH(DMI_BOARD_NAME, "Z8PS-D12"),
1246 .driver_data = &i801_mux_config_asus_z8_d12,
1251 /* Setup multiplexing if needed */
1252 static int i801_add_mux(struct i801_priv *priv)
1254 struct device *dev = &priv->adapter.dev;
1255 const struct i801_mux_config *mux_config;
1256 struct i2c_mux_gpio_platform_data gpio_data;
1259 if (!priv->mux_drvdata)
1261 mux_config = priv->mux_drvdata;
1263 /* Prepare the platform data */
1264 memset(&gpio_data, 0, sizeof(struct i2c_mux_gpio_platform_data));
1265 gpio_data.parent = priv->adapter.nr;
1266 gpio_data.values = mux_config->values;
1267 gpio_data.n_values = mux_config->n_values;
1268 gpio_data.classes = mux_config->classes;
1269 gpio_data.gpio_chip = mux_config->gpio_chip;
1270 gpio_data.gpios = mux_config->gpios;
1271 gpio_data.n_gpios = mux_config->n_gpios;
1272 gpio_data.idle = I2C_MUX_GPIO_NO_IDLE;
1274 /* Register the mux device */
1275 priv->mux_pdev = platform_device_register_data(dev, "i2c-mux-gpio",
1276 PLATFORM_DEVID_AUTO, &gpio_data,
1277 sizeof(struct i2c_mux_gpio_platform_data));
1278 if (IS_ERR(priv->mux_pdev)) {
1279 err = PTR_ERR(priv->mux_pdev);
1280 priv->mux_pdev = NULL;
1281 dev_err(dev, "Failed to register i2c-mux-gpio device\n");
1288 static void i801_del_mux(struct i801_priv *priv)
1291 platform_device_unregister(priv->mux_pdev);
1294 static unsigned int i801_get_adapter_class(struct i801_priv *priv)
1296 const struct dmi_system_id *id;
1297 const struct i801_mux_config *mux_config;
1298 unsigned int class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
1301 id = dmi_first_match(mux_dmi_table);
1303 /* Remove branch classes from trunk */
1304 mux_config = id->driver_data;
1305 for (i = 0; i < mux_config->n_values; i++)
1306 class &= ~mux_config->classes[i];
1308 /* Remember for later */
1309 priv->mux_drvdata = mux_config;
1315 static inline int i801_add_mux(struct i801_priv *priv) { return 0; }
1316 static inline void i801_del_mux(struct i801_priv *priv) { }
1318 static inline unsigned int i801_get_adapter_class(struct i801_priv *priv)
1320 return I2C_CLASS_HWMON | I2C_CLASS_SPD;
1324 static const struct itco_wdt_platform_data tco_platform_data = {
1325 .name = "Intel PCH",
1329 static DEFINE_SPINLOCK(p2sb_spinlock);
1331 static void i801_add_tco(struct i801_priv *priv)
1333 struct pci_dev *pci_dev = priv->pci_dev;
1334 struct resource tco_res[3], *res;
1335 struct platform_device *pdev;
1337 u32 tco_base, tco_ctl;
1338 u32 base_addr, ctrl_val;
1342 if (!(priv->features & FEATURE_TCO))
1345 pci_read_config_dword(pci_dev, TCOBASE, &tco_base);
1346 pci_read_config_dword(pci_dev, TCOCTL, &tco_ctl);
1347 if (!(tco_ctl & TCOCTL_EN))
1350 memset(tco_res, 0, sizeof(tco_res));
1352 res = &tco_res[ICH_RES_IO_TCO];
1353 res->start = tco_base & ~1;
1354 res->end = res->start + 32 - 1;
1355 res->flags = IORESOURCE_IO;
1358 * Power Management registers.
1360 devfn = PCI_DEVFN(PCI_SLOT(pci_dev->devfn), 2);
1361 pci_bus_read_config_dword(pci_dev->bus, devfn, ACPIBASE, &base_addr);
1363 res = &tco_res[ICH_RES_IO_SMI];
1364 res->start = (base_addr & ~1) + ACPIBASE_SMI_OFF;
1365 res->end = res->start + 3;
1366 res->flags = IORESOURCE_IO;
1369 * Enable the ACPI I/O space.
1371 pci_bus_read_config_dword(pci_dev->bus, devfn, ACPICTRL, &ctrl_val);
1372 ctrl_val |= ACPICTRL_EN;
1373 pci_bus_write_config_dword(pci_dev->bus, devfn, ACPICTRL, ctrl_val);
1376 * We must access the NO_REBOOT bit over the Primary to Sideband
1377 * bridge (P2SB). The BIOS prevents the P2SB device from being
1378 * enumerated by the PCI subsystem, so we need to unhide/hide it
1379 * to lookup the P2SB BAR.
1381 spin_lock(&p2sb_spinlock);
1383 devfn = PCI_DEVFN(PCI_SLOT(pci_dev->devfn), 1);
1385 /* Unhide the P2SB device, if it is hidden */
1386 pci_bus_read_config_byte(pci_dev->bus, devfn, 0xe1, &hidden);
1388 pci_bus_write_config_byte(pci_dev->bus, devfn, 0xe1, 0x0);
1390 pci_bus_read_config_dword(pci_dev->bus, devfn, SBREG_BAR, &base_addr);
1391 base64_addr = base_addr & 0xfffffff0;
1393 pci_bus_read_config_dword(pci_dev->bus, devfn, SBREG_BAR + 0x4, &base_addr);
1394 base64_addr |= (u64)base_addr << 32;
1396 /* Hide the P2SB device, if it was hidden before */
1398 pci_bus_write_config_byte(pci_dev->bus, devfn, 0xe1, hidden);
1399 spin_unlock(&p2sb_spinlock);
1401 res = &tco_res[ICH_RES_MEM_OFF];
1402 res->start = (resource_size_t)base64_addr + SBREG_SMBCTRL;
1403 res->end = res->start + 3;
1404 res->flags = IORESOURCE_MEM;
1406 pdev = platform_device_register_resndata(&pci_dev->dev, "iTCO_wdt", -1,
1407 tco_res, 3, &tco_platform_data,
1408 sizeof(tco_platform_data));
1410 dev_warn(&pci_dev->dev, "failed to create iTCO device\n");
1414 priv->tco_pdev = pdev;
1418 static bool i801_acpi_is_smbus_ioport(const struct i801_priv *priv,
1419 acpi_physical_address address)
1421 return address >= priv->smba &&
1422 address <= pci_resource_end(priv->pci_dev, SMBBAR);
1426 i801_acpi_io_handler(u32 function, acpi_physical_address address, u32 bits,
1427 u64 *value, void *handler_context, void *region_context)
1429 struct i801_priv *priv = handler_context;
1430 struct pci_dev *pdev = priv->pci_dev;
1434 * Once BIOS AML code touches the OpRegion we warn and inhibit any
1435 * further access from the driver itself. This device is now owned
1436 * by the system firmware.
1438 mutex_lock(&priv->acpi_lock);
1440 if (!priv->acpi_reserved && i801_acpi_is_smbus_ioport(priv, address)) {
1441 priv->acpi_reserved = true;
1443 dev_warn(&pdev->dev, "BIOS is accessing SMBus registers\n");
1444 dev_warn(&pdev->dev, "Driver SMBus register access inhibited\n");
1447 * BIOS is accessing the host controller so prevent it from
1448 * suspending automatically from now on.
1450 pm_runtime_get_sync(&pdev->dev);
1453 if ((function & ACPI_IO_MASK) == ACPI_READ)
1454 status = acpi_os_read_port(address, (u32 *)value, bits);
1456 status = acpi_os_write_port(address, (u32)*value, bits);
1458 mutex_unlock(&priv->acpi_lock);
1463 static int i801_acpi_probe(struct i801_priv *priv)
1465 struct acpi_device *adev;
1468 adev = ACPI_COMPANION(&priv->pci_dev->dev);
1470 status = acpi_install_address_space_handler(adev->handle,
1471 ACPI_ADR_SPACE_SYSTEM_IO, i801_acpi_io_handler,
1473 if (ACPI_SUCCESS(status))
1477 return acpi_check_resource_conflict(&priv->pci_dev->resource[SMBBAR]);
1480 static void i801_acpi_remove(struct i801_priv *priv)
1482 struct acpi_device *adev;
1484 adev = ACPI_COMPANION(&priv->pci_dev->dev);
1488 acpi_remove_address_space_handler(adev->handle,
1489 ACPI_ADR_SPACE_SYSTEM_IO, i801_acpi_io_handler);
1491 mutex_lock(&priv->acpi_lock);
1492 if (priv->acpi_reserved)
1493 pm_runtime_put(&priv->pci_dev->dev);
1494 mutex_unlock(&priv->acpi_lock);
1497 static inline int i801_acpi_probe(struct i801_priv *priv) { return 0; }
1498 static inline void i801_acpi_remove(struct i801_priv *priv) { }
1501 static int i801_probe(struct pci_dev *dev, const struct pci_device_id *id)
1505 struct i801_priv *priv;
1507 priv = devm_kzalloc(&dev->dev, sizeof(*priv), GFP_KERNEL);
1511 i2c_set_adapdata(&priv->adapter, priv);
1512 priv->adapter.owner = THIS_MODULE;
1513 priv->adapter.class = i801_get_adapter_class(priv);
1514 priv->adapter.algo = &smbus_algorithm;
1515 priv->adapter.dev.parent = &dev->dev;
1516 ACPI_COMPANION_SET(&priv->adapter.dev, ACPI_COMPANION(&dev->dev));
1517 priv->adapter.retries = 3;
1518 mutex_init(&priv->acpi_lock);
1520 priv->pci_dev = dev;
1521 switch (dev->device) {
1522 case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_SMBUS:
1523 case PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_SMBUS:
1524 case PCI_DEVICE_ID_INTEL_CANNONLAKE_H_SMBUS:
1525 case PCI_DEVICE_ID_INTEL_CANNONLAKE_LP_SMBUS:
1526 case PCI_DEVICE_ID_INTEL_LEWISBURG_SMBUS:
1527 case PCI_DEVICE_ID_INTEL_LEWISBURG_SSKU_SMBUS:
1528 case PCI_DEVICE_ID_INTEL_CDF_SMBUS:
1529 case PCI_DEVICE_ID_INTEL_DNV_SMBUS:
1530 case PCI_DEVICE_ID_INTEL_KABYLAKE_PCH_H_SMBUS:
1531 case PCI_DEVICE_ID_INTEL_ICELAKE_LP_SMBUS:
1532 priv->features |= FEATURE_I2C_BLOCK_READ;
1533 priv->features |= FEATURE_IRQ;
1534 priv->features |= FEATURE_SMBUS_PEC;
1535 priv->features |= FEATURE_BLOCK_BUFFER;
1536 /* If we have ACPI based watchdog use that instead */
1537 if (!acpi_has_watchdog())
1538 priv->features |= FEATURE_TCO;
1539 priv->features |= FEATURE_HOST_NOTIFY;
1542 case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0:
1543 case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1:
1544 case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2:
1545 case PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS0:
1546 case PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS1:
1547 case PCI_DEVICE_ID_INTEL_WELLSBURG_SMBUS_MS2:
1548 priv->features |= FEATURE_IDF;
1551 priv->features |= FEATURE_I2C_BLOCK_READ;
1552 priv->features |= FEATURE_IRQ;
1554 case PCI_DEVICE_ID_INTEL_82801DB_3:
1555 priv->features |= FEATURE_SMBUS_PEC;
1556 priv->features |= FEATURE_BLOCK_BUFFER;
1558 case PCI_DEVICE_ID_INTEL_82801CA_3:
1559 priv->features |= FEATURE_HOST_NOTIFY;
1561 case PCI_DEVICE_ID_INTEL_82801BA_2:
1562 case PCI_DEVICE_ID_INTEL_82801AB_3:
1563 case PCI_DEVICE_ID_INTEL_82801AA_3:
1567 /* Disable features on user request */
1568 for (i = 0; i < ARRAY_SIZE(i801_feature_names); i++) {
1569 if (priv->features & disable_features & (1 << i))
1570 dev_notice(&dev->dev, "%s disabled by user\n",
1571 i801_feature_names[i]);
1573 priv->features &= ~disable_features;
1575 err = pcim_enable_device(dev);
1577 dev_err(&dev->dev, "Failed to enable SMBus PCI device (%d)\n",
1581 pcim_pin_device(dev);
1583 /* Determine the address of the SMBus area */
1584 priv->smba = pci_resource_start(dev, SMBBAR);
1587 "SMBus base address uninitialized, upgrade BIOS\n");
1591 if (i801_acpi_probe(priv))
1594 err = pcim_iomap_regions(dev, 1 << SMBBAR,
1595 dev_driver_string(&dev->dev));
1598 "Failed to request SMBus region 0x%lx-0x%Lx\n",
1600 (unsigned long long)pci_resource_end(dev, SMBBAR));
1601 i801_acpi_remove(priv);
1605 pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &temp);
1606 priv->original_hstcfg = temp;
1607 temp &= ~SMBHSTCFG_I2C_EN; /* SMBus timing */
1608 if (!(temp & SMBHSTCFG_HST_EN)) {
1609 dev_info(&dev->dev, "Enabling SMBus device\n");
1610 temp |= SMBHSTCFG_HST_EN;
1612 pci_write_config_byte(priv->pci_dev, SMBHSTCFG, temp);
1614 if (temp & SMBHSTCFG_SMB_SMI_EN) {
1615 dev_dbg(&dev->dev, "SMBus using interrupt SMI#\n");
1616 /* Disable SMBus interrupt feature if SMBus using SMI# */
1617 priv->features &= ~FEATURE_IRQ;
1619 if (temp & SMBHSTCFG_SPD_WD)
1620 dev_info(&dev->dev, "SPD Write Disable is set\n");
1622 /* Clear special mode bits */
1623 if (priv->features & (FEATURE_SMBUS_PEC | FEATURE_BLOCK_BUFFER))
1624 outb_p(inb_p(SMBAUXCTL(priv)) &
1625 ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
1627 /* Remember original Host Notify setting */
1628 if (priv->features & FEATURE_HOST_NOTIFY)
1629 priv->original_slvcmd = inb_p(SMBSLVCMD(priv));
1631 /* Default timeout in interrupt mode: 200 ms */
1632 priv->adapter.timeout = HZ / 5;
1634 if (dev->irq == IRQ_NOTCONNECTED)
1635 priv->features &= ~FEATURE_IRQ;
1637 if (priv->features & FEATURE_IRQ) {
1640 /* Complain if an interrupt is already pending */
1641 pci_read_config_word(priv->pci_dev, SMBPCISTS, &pcists);
1642 if (pcists & SMBPCISTS_INTS)
1643 dev_warn(&dev->dev, "An interrupt is pending!\n");
1645 /* Check if interrupts have been disabled */
1646 pci_read_config_word(priv->pci_dev, SMBPCICTL, &pcictl);
1647 if (pcictl & SMBPCICTL_INTDIS) {
1648 dev_info(&dev->dev, "Interrupts are disabled\n");
1649 priv->features &= ~FEATURE_IRQ;
1653 if (priv->features & FEATURE_IRQ) {
1654 init_waitqueue_head(&priv->waitq);
1656 err = devm_request_irq(&dev->dev, dev->irq, i801_isr,
1658 dev_driver_string(&dev->dev), priv);
1660 dev_err(&dev->dev, "Failed to allocate irq %d: %d\n",
1662 priv->features &= ~FEATURE_IRQ;
1665 dev_info(&dev->dev, "SMBus using %s\n",
1666 priv->features & FEATURE_IRQ ? "PCI interrupt" : "polling");
1670 snprintf(priv->adapter.name, sizeof(priv->adapter.name),
1671 "SMBus I801 adapter at %04lx", priv->smba);
1672 err = i2c_add_adapter(&priv->adapter);
1674 i801_acpi_remove(priv);
1678 i801_enable_host_notify(&priv->adapter);
1680 i801_probe_optional_slaves(priv);
1681 /* We ignore errors - multiplexing is optional */
1684 pci_set_drvdata(dev, priv);
1686 pm_runtime_set_autosuspend_delay(&dev->dev, 1000);
1687 pm_runtime_use_autosuspend(&dev->dev);
1688 pm_runtime_put_autosuspend(&dev->dev);
1689 pm_runtime_allow(&dev->dev);
1694 static void i801_remove(struct pci_dev *dev)
1696 struct i801_priv *priv = pci_get_drvdata(dev);
1698 pm_runtime_forbid(&dev->dev);
1699 pm_runtime_get_noresume(&dev->dev);
1701 i801_disable_host_notify(priv);
1703 i2c_del_adapter(&priv->adapter);
1704 i801_acpi_remove(priv);
1705 pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
1707 platform_device_unregister(priv->tco_pdev);
1710 * do not call pci_disable_device(dev) since it can cause hard hangs on
1711 * some systems during power-off (eg. Fujitsu-Siemens Lifebook E8010)
1715 static void i801_shutdown(struct pci_dev *dev)
1717 struct i801_priv *priv = pci_get_drvdata(dev);
1719 /* Restore config registers to avoid hard hang on some systems */
1720 i801_disable_host_notify(priv);
1721 pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
1724 #ifdef CONFIG_PM_SLEEP
1725 static int i801_suspend(struct device *dev)
1727 struct pci_dev *pci_dev = to_pci_dev(dev);
1728 struct i801_priv *priv = pci_get_drvdata(pci_dev);
1730 pci_write_config_byte(pci_dev, SMBHSTCFG, priv->original_hstcfg);
1734 static int i801_resume(struct device *dev)
1736 struct pci_dev *pci_dev = to_pci_dev(dev);
1737 struct i801_priv *priv = pci_get_drvdata(pci_dev);
1739 i801_enable_host_notify(&priv->adapter);
1745 static SIMPLE_DEV_PM_OPS(i801_pm_ops, i801_suspend, i801_resume);
1747 static struct pci_driver i801_driver = {
1748 .name = "i801_smbus",
1749 .id_table = i801_ids,
1750 .probe = i801_probe,
1751 .remove = i801_remove,
1752 .shutdown = i801_shutdown,
1758 static int __init i2c_i801_init(void)
1760 if (dmi_name_in_vendors("FUJITSU"))
1761 input_apanel_init();
1762 return pci_register_driver(&i801_driver);
1765 static void __exit i2c_i801_exit(void)
1767 pci_unregister_driver(&i801_driver);
1770 MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>, Jean Delvare <jdelvare@suse.de>");
1771 MODULE_DESCRIPTION("I801 SMBus driver");
1772 MODULE_LICENSE("GPL");
1774 module_init(i2c_i801_init);
1775 module_exit(i2c_i801_exit);