2 Copyright (c) 1998 - 2002 Frodo Looijaard <frodol@dds.nl>,
3 Philip Edelbrock <phil@netroedge.com>, and Mark D. Studebaker
5 Copyright (C) 2007 - 2012 Jean Delvare <khali@linux-fr.org>
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.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 Supports the following Intel I/O Controller Hubs (ICH):
28 region SMBus Block proc. block
29 Chip name PCI ID size PEC buffer call read
30 ----------------------------------------------------------------------
31 82801AA (ICH) 0x2413 16 no no no no
32 82801AB (ICH0) 0x2423 16 no no no no
33 82801BA (ICH2) 0x2443 16 no no no no
34 82801CA (ICH3) 0x2483 32 soft no no no
35 82801DB (ICH4) 0x24c3 32 hard yes no no
36 82801E (ICH5) 0x24d3 32 hard yes yes yes
37 6300ESB 0x25a4 32 hard yes yes yes
38 82801F (ICH6) 0x266a 32 hard yes yes yes
39 6310ESB/6320ESB 0x269b 32 hard yes yes yes
40 82801G (ICH7) 0x27da 32 hard yes yes yes
41 82801H (ICH8) 0x283e 32 hard yes yes yes
42 82801I (ICH9) 0x2930 32 hard yes yes yes
43 EP80579 (Tolapai) 0x5032 32 hard yes yes yes
44 ICH10 0x3a30 32 hard yes yes yes
45 ICH10 0x3a60 32 hard yes yes yes
46 5/3400 Series (PCH) 0x3b30 32 hard yes yes yes
47 6 Series (PCH) 0x1c22 32 hard yes yes yes
48 Patsburg (PCH) 0x1d22 32 hard yes yes yes
49 Patsburg (PCH) IDF 0x1d70 32 hard yes yes yes
50 Patsburg (PCH) IDF 0x1d71 32 hard yes yes yes
51 Patsburg (PCH) IDF 0x1d72 32 hard yes yes yes
52 DH89xxCC (PCH) 0x2330 32 hard yes yes yes
53 Panther Point (PCH) 0x1e22 32 hard yes yes yes
54 Lynx Point (PCH) 0x8c22 32 hard yes yes yes
55 Lynx Point-LP (PCH) 0x9c22 32 hard yes yes yes
57 Features supported by this driver:
61 Block process call transaction no
62 I2C block read transaction yes (doesn't use the block buffer)
64 Interrupt processing yes
66 See the file Documentation/i2c/busses/i2c-i801 for details.
69 #include <linux/interrupt.h>
70 #include <linux/module.h>
71 #include <linux/pci.h>
72 #include <linux/kernel.h>
73 #include <linux/stddef.h>
74 #include <linux/delay.h>
75 #include <linux/ioport.h>
76 #include <linux/init.h>
77 #include <linux/i2c.h>
78 #include <linux/acpi.h>
80 #include <linux/dmi.h>
81 #include <linux/slab.h>
82 #include <linux/wait.h>
83 #include <linux/err.h>
84 #include <linux/of_i2c.h>
86 #if (defined CONFIG_I2C_MUX_GPIO || defined CONFIG_I2C_MUX_GPIO_MODULE) && \
88 #include <linux/gpio.h>
89 #include <linux/i2c-mux-gpio.h>
90 #include <linux/platform_device.h>
93 /* I801 SMBus address offsets */
94 #define SMBHSTSTS(p) (0 + (p)->smba)
95 #define SMBHSTCNT(p) (2 + (p)->smba)
96 #define SMBHSTCMD(p) (3 + (p)->smba)
97 #define SMBHSTADD(p) (4 + (p)->smba)
98 #define SMBHSTDAT0(p) (5 + (p)->smba)
99 #define SMBHSTDAT1(p) (6 + (p)->smba)
100 #define SMBBLKDAT(p) (7 + (p)->smba)
101 #define SMBPEC(p) (8 + (p)->smba) /* ICH3 and later */
102 #define SMBAUXSTS(p) (12 + (p)->smba) /* ICH4 and later */
103 #define SMBAUXCTL(p) (13 + (p)->smba) /* ICH4 and later */
105 /* PCI Address Constants */
107 #define SMBPCISTS 0x006
108 #define SMBHSTCFG 0x040
110 /* Host status bits for SMBPCISTS */
111 #define SMBPCISTS_INTS 0x08
113 /* Host configuration bits for SMBHSTCFG */
114 #define SMBHSTCFG_HST_EN 1
115 #define SMBHSTCFG_SMB_SMI_EN 2
116 #define SMBHSTCFG_I2C_EN 4
118 /* Auxiliary control register bits, ICH4+ only */
119 #define SMBAUXCTL_CRC 1
120 #define SMBAUXCTL_E32B 2
123 #define MAX_RETRIES 400
125 /* I801 command constants */
126 #define I801_QUICK 0x00
127 #define I801_BYTE 0x04
128 #define I801_BYTE_DATA 0x08
129 #define I801_WORD_DATA 0x0C
130 #define I801_PROC_CALL 0x10 /* unimplemented */
131 #define I801_BLOCK_DATA 0x14
132 #define I801_I2C_BLOCK_DATA 0x18 /* ICH5 and later */
134 /* I801 Host Control register bits */
135 #define SMBHSTCNT_INTREN 0x01
136 #define SMBHSTCNT_KILL 0x02
137 #define SMBHSTCNT_LAST_BYTE 0x20
138 #define SMBHSTCNT_START 0x40
139 #define SMBHSTCNT_PEC_EN 0x80 /* ICH3 and later */
141 /* I801 Hosts Status register bits */
142 #define SMBHSTSTS_BYTE_DONE 0x80
143 #define SMBHSTSTS_INUSE_STS 0x40
144 #define SMBHSTSTS_SMBALERT_STS 0x20
145 #define SMBHSTSTS_FAILED 0x10
146 #define SMBHSTSTS_BUS_ERR 0x08
147 #define SMBHSTSTS_DEV_ERR 0x04
148 #define SMBHSTSTS_INTR 0x02
149 #define SMBHSTSTS_HOST_BUSY 0x01
151 #define STATUS_ERROR_FLAGS (SMBHSTSTS_FAILED | SMBHSTSTS_BUS_ERR | \
154 #define STATUS_FLAGS (SMBHSTSTS_BYTE_DONE | SMBHSTSTS_INTR | \
157 /* Older devices have their ID defined in <linux/pci_ids.h> */
158 #define PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS 0x1c22
159 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS 0x1d22
160 /* Patsburg also has three 'Integrated Device Function' SMBus controllers */
161 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0 0x1d70
162 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1 0x1d71
163 #define PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2 0x1d72
164 #define PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS 0x1e22
165 #define PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS 0x2330
166 #define PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS 0x3b30
167 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS 0x8c22
168 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS 0x9c22
170 struct i801_mux_config {
175 unsigned gpios[2]; /* Relative to gpio_chip->base */
180 struct i2c_adapter adapter;
182 unsigned char original_hstcfg;
183 struct pci_dev *pci_dev;
184 unsigned int features;
187 wait_queue_head_t waitq;
190 /* Command state used by isr for byte-by-byte block transactions */
197 #if (defined CONFIG_I2C_MUX_GPIO || defined CONFIG_I2C_MUX_GPIO_MODULE) && \
199 const struct i801_mux_config *mux_drvdata;
200 struct platform_device *mux_pdev;
204 static struct pci_driver i801_driver;
206 #define FEATURE_SMBUS_PEC (1 << 0)
207 #define FEATURE_BLOCK_BUFFER (1 << 1)
208 #define FEATURE_BLOCK_PROC (1 << 2)
209 #define FEATURE_I2C_BLOCK_READ (1 << 3)
210 #define FEATURE_IRQ (1 << 4)
211 /* Not really a feature, but it's convenient to handle it as such */
212 #define FEATURE_IDF (1 << 15)
214 static const char *i801_feature_names[] = {
217 "Block process call",
222 static unsigned int disable_features;
223 module_param(disable_features, uint, S_IRUGO | S_IWUSR);
224 MODULE_PARM_DESC(disable_features, "Disable selected driver features");
226 /* Make sure the SMBus host is ready to start transmitting.
227 Return 0 if it is, -EBUSY if it is not. */
228 static int i801_check_pre(struct i801_priv *priv)
232 status = inb_p(SMBHSTSTS(priv));
233 if (status & SMBHSTSTS_HOST_BUSY) {
234 dev_err(&priv->pci_dev->dev, "SMBus is busy, can't use it!\n");
238 status &= STATUS_FLAGS;
240 dev_dbg(&priv->pci_dev->dev, "Clearing status flags (%02x)\n",
242 outb_p(status, SMBHSTSTS(priv));
243 status = inb_p(SMBHSTSTS(priv)) & STATUS_FLAGS;
245 dev_err(&priv->pci_dev->dev,
246 "Failed clearing status flags (%02x)\n",
256 * Convert the status register to an error code, and clear it.
257 * Note that status only contains the bits we want to clear, not the
258 * actual register value.
260 static int i801_check_post(struct i801_priv *priv, int status)
265 * If the SMBus is still busy, we give up
266 * Note: This timeout condition only happens when using polling
267 * transactions. For interrupt operation, NAK/timeout is indicated by
270 if (unlikely(status < 0)) {
271 dev_err(&priv->pci_dev->dev, "Transaction timeout\n");
272 /* try to stop the current command */
273 dev_dbg(&priv->pci_dev->dev, "Terminating the current operation\n");
274 outb_p(inb_p(SMBHSTCNT(priv)) | SMBHSTCNT_KILL,
276 usleep_range(1000, 2000);
277 outb_p(inb_p(SMBHSTCNT(priv)) & (~SMBHSTCNT_KILL),
280 /* Check if it worked */
281 status = inb_p(SMBHSTSTS(priv));
282 if ((status & SMBHSTSTS_HOST_BUSY) ||
283 !(status & SMBHSTSTS_FAILED))
284 dev_err(&priv->pci_dev->dev,
285 "Failed terminating the transaction\n");
286 outb_p(STATUS_FLAGS, SMBHSTSTS(priv));
290 if (status & SMBHSTSTS_FAILED) {
292 dev_err(&priv->pci_dev->dev, "Transaction failed\n");
294 if (status & SMBHSTSTS_DEV_ERR) {
296 dev_dbg(&priv->pci_dev->dev, "No response\n");
298 if (status & SMBHSTSTS_BUS_ERR) {
300 dev_dbg(&priv->pci_dev->dev, "Lost arbitration\n");
303 /* Clear status flags except BYTE_DONE, to be cleared by caller */
304 outb_p(status, SMBHSTSTS(priv));
309 /* Wait for BUSY being cleared and either INTR or an error flag being set */
310 static int i801_wait_intr(struct i801_priv *priv)
315 /* We will always wait for a fraction of a second! */
317 usleep_range(250, 500);
318 status = inb_p(SMBHSTSTS(priv));
319 } while (((status & SMBHSTSTS_HOST_BUSY) ||
320 !(status & (STATUS_ERROR_FLAGS | SMBHSTSTS_INTR))) &&
321 (timeout++ < MAX_RETRIES));
323 if (timeout > MAX_RETRIES) {
324 dev_dbg(&priv->pci_dev->dev, "INTR Timeout!\n");
327 return status & (STATUS_ERROR_FLAGS | SMBHSTSTS_INTR);
330 /* Wait for either BYTE_DONE or an error flag being set */
331 static int i801_wait_byte_done(struct i801_priv *priv)
336 /* We will always wait for a fraction of a second! */
338 usleep_range(250, 500);
339 status = inb_p(SMBHSTSTS(priv));
340 } while (!(status & (STATUS_ERROR_FLAGS | SMBHSTSTS_BYTE_DONE)) &&
341 (timeout++ < MAX_RETRIES));
343 if (timeout > MAX_RETRIES) {
344 dev_dbg(&priv->pci_dev->dev, "BYTE_DONE Timeout!\n");
347 return status & STATUS_ERROR_FLAGS;
350 static int i801_transaction(struct i801_priv *priv, int xact)
355 result = i801_check_pre(priv);
359 if (priv->features & FEATURE_IRQ) {
360 outb_p(xact | SMBHSTCNT_INTREN | SMBHSTCNT_START,
362 wait_event(priv->waitq, (status = priv->status));
364 return i801_check_post(priv, status);
367 /* the current contents of SMBHSTCNT can be overwritten, since PEC,
368 * SMBSCMD are passed in xact */
369 outb_p(xact | SMBHSTCNT_START, SMBHSTCNT(priv));
371 status = i801_wait_intr(priv);
372 return i801_check_post(priv, status);
375 static int i801_block_transaction_by_block(struct i801_priv *priv,
376 union i2c_smbus_data *data,
377 char read_write, int hwpec)
382 inb_p(SMBHSTCNT(priv)); /* reset the data buffer index */
384 /* Use 32-byte buffer to process this transaction */
385 if (read_write == I2C_SMBUS_WRITE) {
386 len = data->block[0];
387 outb_p(len, SMBHSTDAT0(priv));
388 for (i = 0; i < len; i++)
389 outb_p(data->block[i+1], SMBBLKDAT(priv));
392 status = i801_transaction(priv, I801_BLOCK_DATA |
393 (hwpec ? SMBHSTCNT_PEC_EN : 0));
397 if (read_write == I2C_SMBUS_READ) {
398 len = inb_p(SMBHSTDAT0(priv));
399 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX)
402 data->block[0] = len;
403 for (i = 0; i < len; i++)
404 data->block[i + 1] = inb_p(SMBBLKDAT(priv));
409 static void i801_isr_byte_done(struct i801_priv *priv)
412 /* For SMBus block reads, length is received with first byte */
413 if (((priv->cmd & 0x1c) == I801_BLOCK_DATA) &&
414 (priv->count == 0)) {
415 priv->len = inb_p(SMBHSTDAT0(priv));
416 if (priv->len < 1 || priv->len > I2C_SMBUS_BLOCK_MAX) {
417 dev_err(&priv->pci_dev->dev,
418 "Illegal SMBus block read size %d\n",
421 priv->len = I2C_SMBUS_BLOCK_MAX;
423 dev_dbg(&priv->pci_dev->dev,
424 "SMBus block read size is %d\n",
427 priv->data[-1] = priv->len;
431 if (priv->count < priv->len)
432 priv->data[priv->count++] = inb(SMBBLKDAT(priv));
434 dev_dbg(&priv->pci_dev->dev,
435 "Discarding extra byte on block read\n");
437 /* Set LAST_BYTE for last byte of read transaction */
438 if (priv->count == priv->len - 1)
439 outb_p(priv->cmd | SMBHSTCNT_LAST_BYTE,
441 } else if (priv->count < priv->len - 1) {
442 /* Write next byte, except for IRQ after last byte */
443 outb_p(priv->data[++priv->count], SMBBLKDAT(priv));
446 /* Clear BYTE_DONE to continue with next byte */
447 outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
451 * There are two kinds of interrupts:
453 * 1) i801 signals transaction completion with one of these interrupts:
455 * DEV_ERR - Invalid command, NAK or communication timeout
456 * BUS_ERR - SMI# transaction collision
457 * FAILED - transaction was canceled due to a KILL request
458 * When any of these occur, update ->status and wake up the waitq.
459 * ->status must be cleared before kicking off the next transaction.
461 * 2) For byte-by-byte (I2C read/write) transactions, one BYTE_DONE interrupt
462 * occurs for each byte of a byte-by-byte to prepare the next byte.
464 static irqreturn_t i801_isr(int irq, void *dev_id)
466 struct i801_priv *priv = dev_id;
470 /* Confirm this is our interrupt */
471 pci_read_config_word(priv->pci_dev, SMBPCISTS, &pcists);
472 if (!(pcists & SMBPCISTS_INTS))
475 status = inb_p(SMBHSTSTS(priv));
477 dev_dbg(&priv->pci_dev->dev, "irq: status = %02x\n", status);
479 if (status & SMBHSTSTS_BYTE_DONE)
480 i801_isr_byte_done(priv);
483 * Clear irq sources and report transaction result.
484 * ->status must be cleared before the next transaction is started.
486 status &= SMBHSTSTS_INTR | STATUS_ERROR_FLAGS;
488 outb_p(status, SMBHSTSTS(priv));
489 priv->status |= status;
490 wake_up(&priv->waitq);
497 * For "byte-by-byte" block transactions:
498 * I2C write uses cmd=I801_BLOCK_DATA, I2C_EN=1
499 * I2C read uses cmd=I801_I2C_BLOCK_DATA
501 static int i801_block_transaction_byte_by_byte(struct i801_priv *priv,
502 union i2c_smbus_data *data,
503 char read_write, int command,
511 result = i801_check_pre(priv);
515 len = data->block[0];
517 if (read_write == I2C_SMBUS_WRITE) {
518 outb_p(len, SMBHSTDAT0(priv));
519 outb_p(data->block[1], SMBBLKDAT(priv));
522 if (command == I2C_SMBUS_I2C_BLOCK_DATA &&
523 read_write == I2C_SMBUS_READ)
524 smbcmd = I801_I2C_BLOCK_DATA;
526 smbcmd = I801_BLOCK_DATA;
528 if (priv->features & FEATURE_IRQ) {
529 priv->is_read = (read_write == I2C_SMBUS_READ);
530 if (len == 1 && priv->is_read)
531 smbcmd |= SMBHSTCNT_LAST_BYTE;
532 priv->cmd = smbcmd | SMBHSTCNT_INTREN;
535 priv->data = &data->block[1];
537 outb_p(priv->cmd | SMBHSTCNT_START, SMBHSTCNT(priv));
538 wait_event(priv->waitq, (status = priv->status));
540 return i801_check_post(priv, status);
543 for (i = 1; i <= len; i++) {
544 if (i == len && read_write == I2C_SMBUS_READ)
545 smbcmd |= SMBHSTCNT_LAST_BYTE;
546 outb_p(smbcmd, SMBHSTCNT(priv));
549 outb_p(inb(SMBHSTCNT(priv)) | SMBHSTCNT_START,
552 status = i801_wait_byte_done(priv);
556 if (i == 1 && read_write == I2C_SMBUS_READ
557 && command != I2C_SMBUS_I2C_BLOCK_DATA) {
558 len = inb_p(SMBHSTDAT0(priv));
559 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX) {
560 dev_err(&priv->pci_dev->dev,
561 "Illegal SMBus block read size %d\n",
564 while (inb_p(SMBHSTSTS(priv)) &
566 outb_p(SMBHSTSTS_BYTE_DONE,
568 outb_p(SMBHSTSTS_INTR, SMBHSTSTS(priv));
571 data->block[0] = len;
574 /* Retrieve/store value in SMBBLKDAT */
575 if (read_write == I2C_SMBUS_READ)
576 data->block[i] = inb_p(SMBBLKDAT(priv));
577 if (read_write == I2C_SMBUS_WRITE && i+1 <= len)
578 outb_p(data->block[i+1], SMBBLKDAT(priv));
580 /* signals SMBBLKDAT ready */
581 outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS(priv));
584 status = i801_wait_intr(priv);
586 return i801_check_post(priv, status);
589 static int i801_set_block_buffer_mode(struct i801_priv *priv)
591 outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_E32B, SMBAUXCTL(priv));
592 if ((inb_p(SMBAUXCTL(priv)) & SMBAUXCTL_E32B) == 0)
597 /* Block transaction function */
598 static int i801_block_transaction(struct i801_priv *priv,
599 union i2c_smbus_data *data, char read_write,
600 int command, int hwpec)
605 if (command == I2C_SMBUS_I2C_BLOCK_DATA) {
606 if (read_write == I2C_SMBUS_WRITE) {
607 /* set I2C_EN bit in configuration register */
608 pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &hostc);
609 pci_write_config_byte(priv->pci_dev, SMBHSTCFG,
610 hostc | SMBHSTCFG_I2C_EN);
611 } else if (!(priv->features & FEATURE_I2C_BLOCK_READ)) {
612 dev_err(&priv->pci_dev->dev,
613 "I2C block read is unsupported!\n");
618 if (read_write == I2C_SMBUS_WRITE
619 || command == I2C_SMBUS_I2C_BLOCK_DATA) {
620 if (data->block[0] < 1)
622 if (data->block[0] > I2C_SMBUS_BLOCK_MAX)
623 data->block[0] = I2C_SMBUS_BLOCK_MAX;
625 data->block[0] = 32; /* max for SMBus block reads */
628 /* Experience has shown that the block buffer can only be used for
629 SMBus (not I2C) block transactions, even though the datasheet
630 doesn't mention this limitation. */
631 if ((priv->features & FEATURE_BLOCK_BUFFER)
632 && command != I2C_SMBUS_I2C_BLOCK_DATA
633 && i801_set_block_buffer_mode(priv) == 0)
634 result = i801_block_transaction_by_block(priv, data,
637 result = i801_block_transaction_byte_by_byte(priv, data,
641 if (command == I2C_SMBUS_I2C_BLOCK_DATA
642 && read_write == I2C_SMBUS_WRITE) {
643 /* restore saved configuration register value */
644 pci_write_config_byte(priv->pci_dev, SMBHSTCFG, hostc);
649 /* Return negative errno on error. */
650 static s32 i801_access(struct i2c_adapter *adap, u16 addr,
651 unsigned short flags, char read_write, u8 command,
652 int size, union i2c_smbus_data *data)
657 struct i801_priv *priv = i2c_get_adapdata(adap);
659 hwpec = (priv->features & FEATURE_SMBUS_PEC) && (flags & I2C_CLIENT_PEC)
660 && size != I2C_SMBUS_QUICK
661 && size != I2C_SMBUS_I2C_BLOCK_DATA;
664 case I2C_SMBUS_QUICK:
665 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
670 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
672 if (read_write == I2C_SMBUS_WRITE)
673 outb_p(command, SMBHSTCMD(priv));
676 case I2C_SMBUS_BYTE_DATA:
677 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
679 outb_p(command, SMBHSTCMD(priv));
680 if (read_write == I2C_SMBUS_WRITE)
681 outb_p(data->byte, SMBHSTDAT0(priv));
682 xact = I801_BYTE_DATA;
684 case I2C_SMBUS_WORD_DATA:
685 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
687 outb_p(command, SMBHSTCMD(priv));
688 if (read_write == I2C_SMBUS_WRITE) {
689 outb_p(data->word & 0xff, SMBHSTDAT0(priv));
690 outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1(priv));
692 xact = I801_WORD_DATA;
694 case I2C_SMBUS_BLOCK_DATA:
695 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
697 outb_p(command, SMBHSTCMD(priv));
700 case I2C_SMBUS_I2C_BLOCK_DATA:
701 /* NB: page 240 of ICH5 datasheet shows that the R/#W
702 * bit should be cleared here, even when reading */
703 outb_p((addr & 0x7f) << 1, SMBHSTADD(priv));
704 if (read_write == I2C_SMBUS_READ) {
705 /* NB: page 240 of ICH5 datasheet also shows
706 * that DATA1 is the cmd field when reading */
707 outb_p(command, SMBHSTDAT1(priv));
709 outb_p(command, SMBHSTCMD(priv));
713 dev_err(&priv->pci_dev->dev, "Unsupported transaction %d\n",
718 if (hwpec) /* enable/disable hardware PEC */
719 outb_p(inb_p(SMBAUXCTL(priv)) | SMBAUXCTL_CRC, SMBAUXCTL(priv));
721 outb_p(inb_p(SMBAUXCTL(priv)) & (~SMBAUXCTL_CRC),
725 ret = i801_block_transaction(priv, data, read_write, size,
728 ret = i801_transaction(priv, xact);
730 /* Some BIOSes don't like it when PEC is enabled at reboot or resume
731 time, so we forcibly disable it after every transaction. Turn off
732 E32B for the same reason. */
734 outb_p(inb_p(SMBAUXCTL(priv)) &
735 ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
741 if ((read_write == I2C_SMBUS_WRITE) || (xact == I801_QUICK))
744 switch (xact & 0x7f) {
745 case I801_BYTE: /* Result put in SMBHSTDAT0 */
747 data->byte = inb_p(SMBHSTDAT0(priv));
750 data->word = inb_p(SMBHSTDAT0(priv)) +
751 (inb_p(SMBHSTDAT1(priv)) << 8);
758 static u32 i801_func(struct i2c_adapter *adapter)
760 struct i801_priv *priv = i2c_get_adapdata(adapter);
762 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
763 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
764 I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK |
765 ((priv->features & FEATURE_SMBUS_PEC) ? I2C_FUNC_SMBUS_PEC : 0) |
766 ((priv->features & FEATURE_I2C_BLOCK_READ) ?
767 I2C_FUNC_SMBUS_READ_I2C_BLOCK : 0);
770 static const struct i2c_algorithm smbus_algorithm = {
771 .smbus_xfer = i801_access,
772 .functionality = i801_func,
775 static DEFINE_PCI_DEVICE_TABLE(i801_ids) = {
776 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AA_3) },
777 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AB_3) },
778 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801BA_2) },
779 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801CA_3) },
780 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_3) },
781 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801EB_3) },
782 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB_4) },
783 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_16) },
784 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH7_17) },
785 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB2_17) },
786 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH8_5) },
787 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH9_6) },
788 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_EP80579_1) },
789 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_4) },
790 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_5) },
791 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_5_3400_SERIES_SMBUS) },
792 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_COUGARPOINT_SMBUS) },
793 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS) },
794 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0) },
795 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1) },
796 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2) },
797 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_DH89XXCC_SMBUS) },
798 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_PANTHERPOINT_SMBUS) },
799 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LYNXPOINT_SMBUS) },
800 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_SMBUS) },
804 MODULE_DEVICE_TABLE(pci, i801_ids);
806 #if defined CONFIG_X86 && defined CONFIG_DMI
807 static unsigned char apanel_addr;
809 /* Scan the system ROM for the signature "FJKEYINF" */
810 static __init const void __iomem *bios_signature(const void __iomem *bios)
813 const unsigned char signature[] = "FJKEYINF";
815 for (offset = 0; offset < 0x10000; offset += 0x10) {
816 if (check_signature(bios + offset, signature,
817 sizeof(signature)-1))
818 return bios + offset;
823 static void __init input_apanel_init(void)
826 const void __iomem *p;
828 bios = ioremap(0xF0000, 0x10000); /* Can't fail */
829 p = bios_signature(bios);
831 /* just use the first address */
832 apanel_addr = readb(p + 8 + 3) >> 1;
837 struct dmi_onboard_device_info {
840 unsigned short i2c_addr;
841 const char *i2c_type;
844 static const struct dmi_onboard_device_info dmi_devices[] = {
845 { "Syleus", DMI_DEV_TYPE_OTHER, 0x73, "fscsyl" },
846 { "Hermes", DMI_DEV_TYPE_OTHER, 0x73, "fscher" },
847 { "Hades", DMI_DEV_TYPE_OTHER, 0x73, "fschds" },
850 static void dmi_check_onboard_device(u8 type, const char *name,
851 struct i2c_adapter *adap)
854 struct i2c_board_info info;
856 for (i = 0; i < ARRAY_SIZE(dmi_devices); i++) {
857 /* & ~0x80, ignore enabled/disabled bit */
858 if ((type & ~0x80) != dmi_devices[i].type)
860 if (strcasecmp(name, dmi_devices[i].name))
863 memset(&info, 0, sizeof(struct i2c_board_info));
864 info.addr = dmi_devices[i].i2c_addr;
865 strlcpy(info.type, dmi_devices[i].i2c_type, I2C_NAME_SIZE);
866 i2c_new_device(adap, &info);
871 /* We use our own function to check for onboard devices instead of
872 dmi_find_device() as some buggy BIOS's have the devices we are interested
873 in marked as disabled */
874 static void dmi_check_onboard_devices(const struct dmi_header *dm, void *adap)
881 count = (dm->length - sizeof(struct dmi_header)) / 2;
882 for (i = 0; i < count; i++) {
883 const u8 *d = (char *)(dm + 1) + (i * 2);
884 const char *name = ((char *) dm) + dm->length;
891 while (s > 0 && name[0]) {
892 name += strlen(name) + 1;
895 if (name[0] == 0) /* Bogus string reference */
898 dmi_check_onboard_device(type, name, adap);
902 /* Register optional slaves */
903 static void i801_probe_optional_slaves(struct i801_priv *priv)
905 /* Only register slaves on main SMBus channel */
906 if (priv->features & FEATURE_IDF)
910 struct i2c_board_info info;
912 memset(&info, 0, sizeof(struct i2c_board_info));
913 info.addr = apanel_addr;
914 strlcpy(info.type, "fujitsu_apanel", I2C_NAME_SIZE);
915 i2c_new_device(&priv->adapter, &info);
918 if (dmi_name_in_vendors("FUJITSU"))
919 dmi_walk(dmi_check_onboard_devices, &priv->adapter);
922 static void __init input_apanel_init(void) {}
923 static void i801_probe_optional_slaves(struct i801_priv *priv) {}
924 #endif /* CONFIG_X86 && CONFIG_DMI */
926 #if (defined CONFIG_I2C_MUX_GPIO || defined CONFIG_I2C_MUX_GPIO_MODULE) && \
928 static struct i801_mux_config i801_mux_config_asus_z8_d12 = {
929 .gpio_chip = "gpio_ich",
930 .values = { 0x02, 0x03 },
932 .classes = { I2C_CLASS_SPD, I2C_CLASS_SPD },
937 static struct i801_mux_config i801_mux_config_asus_z8_d18 = {
938 .gpio_chip = "gpio_ich",
939 .values = { 0x02, 0x03, 0x01 },
941 .classes = { I2C_CLASS_SPD, I2C_CLASS_SPD, I2C_CLASS_SPD },
946 static const struct dmi_system_id mux_dmi_table[] = {
949 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
950 DMI_MATCH(DMI_BOARD_NAME, "Z8NA-D6(C)"),
952 .driver_data = &i801_mux_config_asus_z8_d12,
956 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
957 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)E-D12(X)"),
959 .driver_data = &i801_mux_config_asus_z8_d12,
963 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
964 DMI_MATCH(DMI_BOARD_NAME, "Z8NH-D12"),
966 .driver_data = &i801_mux_config_asus_z8_d12,
970 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
971 DMI_MATCH(DMI_BOARD_NAME, "Z8PH-D12/IFB"),
973 .driver_data = &i801_mux_config_asus_z8_d12,
977 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
978 DMI_MATCH(DMI_BOARD_NAME, "Z8NR-D12"),
980 .driver_data = &i801_mux_config_asus_z8_d12,
984 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
985 DMI_MATCH(DMI_BOARD_NAME, "Z8P(N)H-D12"),
987 .driver_data = &i801_mux_config_asus_z8_d12,
991 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
992 DMI_MATCH(DMI_BOARD_NAME, "Z8PG-D18"),
994 .driver_data = &i801_mux_config_asus_z8_d18,
998 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
999 DMI_MATCH(DMI_BOARD_NAME, "Z8PE-D18"),
1001 .driver_data = &i801_mux_config_asus_z8_d18,
1005 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
1006 DMI_MATCH(DMI_BOARD_NAME, "Z8PS-D12"),
1008 .driver_data = &i801_mux_config_asus_z8_d12,
1013 /* Setup multiplexing if needed */
1014 static int i801_add_mux(struct i801_priv *priv)
1016 struct device *dev = &priv->adapter.dev;
1017 const struct i801_mux_config *mux_config;
1018 struct i2c_mux_gpio_platform_data gpio_data;
1021 if (!priv->mux_drvdata)
1023 mux_config = priv->mux_drvdata;
1025 /* Prepare the platform data */
1026 memset(&gpio_data, 0, sizeof(struct i2c_mux_gpio_platform_data));
1027 gpio_data.parent = priv->adapter.nr;
1028 gpio_data.values = mux_config->values;
1029 gpio_data.n_values = mux_config->n_values;
1030 gpio_data.classes = mux_config->classes;
1031 gpio_data.gpio_chip = mux_config->gpio_chip;
1032 gpio_data.gpios = mux_config->gpios;
1033 gpio_data.n_gpios = mux_config->n_gpios;
1034 gpio_data.idle = I2C_MUX_GPIO_NO_IDLE;
1036 /* Register the mux device */
1037 priv->mux_pdev = platform_device_register_data(dev, "i2c-mux-gpio",
1038 PLATFORM_DEVID_AUTO, &gpio_data,
1039 sizeof(struct i2c_mux_gpio_platform_data));
1040 if (IS_ERR(priv->mux_pdev)) {
1041 err = PTR_ERR(priv->mux_pdev);
1042 priv->mux_pdev = NULL;
1043 dev_err(dev, "Failed to register i2c-mux-gpio device\n");
1050 static void i801_del_mux(struct i801_priv *priv)
1053 platform_device_unregister(priv->mux_pdev);
1056 static unsigned int i801_get_adapter_class(struct i801_priv *priv)
1058 const struct dmi_system_id *id;
1059 const struct i801_mux_config *mux_config;
1060 unsigned int class = I2C_CLASS_HWMON | I2C_CLASS_SPD;
1063 id = dmi_first_match(mux_dmi_table);
1065 /* Remove branch classes from trunk */
1066 mux_config = id->driver_data;
1067 for (i = 0; i < mux_config->n_values; i++)
1068 class &= ~mux_config->classes[i];
1070 /* Remember for later */
1071 priv->mux_drvdata = mux_config;
1077 static inline int i801_add_mux(struct i801_priv *priv) { return 0; }
1078 static inline void i801_del_mux(struct i801_priv *priv) { }
1080 static inline unsigned int i801_get_adapter_class(struct i801_priv *priv)
1082 return I2C_CLASS_HWMON | I2C_CLASS_SPD;
1086 static int i801_probe(struct pci_dev *dev, const struct pci_device_id *id)
1090 struct i801_priv *priv;
1092 priv = kzalloc(sizeof(*priv), GFP_KERNEL);
1096 i2c_set_adapdata(&priv->adapter, priv);
1097 priv->adapter.owner = THIS_MODULE;
1098 priv->adapter.class = i801_get_adapter_class(priv);
1099 priv->adapter.algo = &smbus_algorithm;
1101 priv->pci_dev = dev;
1102 switch (dev->device) {
1103 case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF0:
1104 case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF1:
1105 case PCI_DEVICE_ID_INTEL_PATSBURG_SMBUS_IDF2:
1106 priv->features |= FEATURE_IDF;
1109 priv->features |= FEATURE_I2C_BLOCK_READ;
1110 priv->features |= FEATURE_IRQ;
1112 case PCI_DEVICE_ID_INTEL_82801DB_3:
1113 priv->features |= FEATURE_SMBUS_PEC;
1114 priv->features |= FEATURE_BLOCK_BUFFER;
1116 case PCI_DEVICE_ID_INTEL_82801CA_3:
1117 case PCI_DEVICE_ID_INTEL_82801BA_2:
1118 case PCI_DEVICE_ID_INTEL_82801AB_3:
1119 case PCI_DEVICE_ID_INTEL_82801AA_3:
1123 /* Disable features on user request */
1124 for (i = 0; i < ARRAY_SIZE(i801_feature_names); i++) {
1125 if (priv->features & disable_features & (1 << i))
1126 dev_notice(&dev->dev, "%s disabled by user\n",
1127 i801_feature_names[i]);
1129 priv->features &= ~disable_features;
1131 err = pci_enable_device(dev);
1133 dev_err(&dev->dev, "Failed to enable SMBus PCI device (%d)\n",
1138 /* Determine the address of the SMBus area */
1139 priv->smba = pci_resource_start(dev, SMBBAR);
1141 dev_err(&dev->dev, "SMBus base address uninitialized, "
1147 err = acpi_check_resource_conflict(&dev->resource[SMBBAR]);
1153 err = pci_request_region(dev, SMBBAR, i801_driver.name);
1155 dev_err(&dev->dev, "Failed to request SMBus region "
1156 "0x%lx-0x%Lx\n", priv->smba,
1157 (unsigned long long)pci_resource_end(dev, SMBBAR));
1161 pci_read_config_byte(priv->pci_dev, SMBHSTCFG, &temp);
1162 priv->original_hstcfg = temp;
1163 temp &= ~SMBHSTCFG_I2C_EN; /* SMBus timing */
1164 if (!(temp & SMBHSTCFG_HST_EN)) {
1165 dev_info(&dev->dev, "Enabling SMBus device\n");
1166 temp |= SMBHSTCFG_HST_EN;
1168 pci_write_config_byte(priv->pci_dev, SMBHSTCFG, temp);
1170 if (temp & SMBHSTCFG_SMB_SMI_EN) {
1171 dev_dbg(&dev->dev, "SMBus using interrupt SMI#\n");
1172 /* Disable SMBus interrupt feature if SMBus using SMI# */
1173 priv->features &= ~FEATURE_IRQ;
1176 /* Clear special mode bits */
1177 if (priv->features & (FEATURE_SMBUS_PEC | FEATURE_BLOCK_BUFFER))
1178 outb_p(inb_p(SMBAUXCTL(priv)) &
1179 ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B), SMBAUXCTL(priv));
1181 if (priv->features & FEATURE_IRQ) {
1182 init_waitqueue_head(&priv->waitq);
1184 err = request_irq(dev->irq, i801_isr, IRQF_SHARED,
1185 i801_driver.name, priv);
1187 dev_err(&dev->dev, "Failed to allocate irq %d: %d\n",
1191 dev_info(&dev->dev, "SMBus using PCI Interrupt\n");
1194 /* set up the sysfs linkage to our parent device */
1195 priv->adapter.dev.parent = &dev->dev;
1197 /* Retry up to 3 times on lost arbitration */
1198 priv->adapter.retries = 3;
1200 snprintf(priv->adapter.name, sizeof(priv->adapter.name),
1201 "SMBus I801 adapter at %04lx", priv->smba);
1202 err = i2c_add_adapter(&priv->adapter);
1204 dev_err(&dev->dev, "Failed to add SMBus adapter\n");
1208 of_i2c_register_devices(&priv->adapter);
1209 i801_probe_optional_slaves(priv);
1210 /* We ignore errors - multiplexing is optional */
1213 pci_set_drvdata(dev, priv);
1218 if (priv->features & FEATURE_IRQ)
1219 free_irq(dev->irq, priv);
1221 pci_release_region(dev, SMBBAR);
1227 static void i801_remove(struct pci_dev *dev)
1229 struct i801_priv *priv = pci_get_drvdata(dev);
1232 i2c_del_adapter(&priv->adapter);
1233 pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
1235 if (priv->features & FEATURE_IRQ)
1236 free_irq(dev->irq, priv);
1237 pci_release_region(dev, SMBBAR);
1239 pci_set_drvdata(dev, NULL);
1242 * do not call pci_disable_device(dev) since it can cause hard hangs on
1243 * some systems during power-off (eg. Fujitsu-Siemens Lifebook E8010)
1248 static int i801_suspend(struct pci_dev *dev, pm_message_t mesg)
1250 struct i801_priv *priv = pci_get_drvdata(dev);
1252 pci_save_state(dev);
1253 pci_write_config_byte(dev, SMBHSTCFG, priv->original_hstcfg);
1254 pci_set_power_state(dev, pci_choose_state(dev, mesg));
1258 static int i801_resume(struct pci_dev *dev)
1260 pci_set_power_state(dev, PCI_D0);
1261 pci_restore_state(dev);
1262 return pci_enable_device(dev);
1265 #define i801_suspend NULL
1266 #define i801_resume NULL
1269 static struct pci_driver i801_driver = {
1270 .name = "i801_smbus",
1271 .id_table = i801_ids,
1272 .probe = i801_probe,
1273 .remove = i801_remove,
1274 .suspend = i801_suspend,
1275 .resume = i801_resume,
1278 static int __init i2c_i801_init(void)
1280 if (dmi_name_in_vendors("FUJITSU"))
1281 input_apanel_init();
1282 return pci_register_driver(&i801_driver);
1285 static void __exit i2c_i801_exit(void)
1287 pci_unregister_driver(&i801_driver);
1290 MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>, "
1291 "Jean Delvare <khali@linux-fr.org>");
1292 MODULE_DESCRIPTION("I801 SMBus driver");
1293 MODULE_LICENSE("GPL");
1295 module_init(i2c_i801_init);
1296 module_exit(i2c_i801_exit);