blob: 46aa41f73fdd9e0bb39338be18b3378b8aaf15bd [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jean Delvare455f3322006-06-12 21:52:02 +02002 i2c-i801.c - Part of lm_sensors, Linux kernel modules for hardware
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 monitoring
4 Copyright (c) 1998 - 2002 Frodo Looijaard <frodol@dds.nl>,
5 Philip Edelbrock <phil@netroedge.com>, and Mark D. Studebaker
6 <mdsxyz123@yahoo.com>
Jean Delvarecf898dc2008-07-14 22:38:33 +02007 Copyright (C) 2007, 2008 Jean Delvare <khali@linux-fr.org>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
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.
13
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.
18
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.
22*/
23
24/*
Jean Delvareae7b0492008-01-27 18:14:49 +010025 Supports the following Intel I/O Controller Hubs (ICH):
26
27 I/O Block I2C
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
Gaston, Jason Dd28dc712008-02-24 20:03:42 +010043 Tolapai 0x5032 32 hard yes yes yes
44 ICH10 0x3a30 32 hard yes yes yes
45 ICH10 0x3a60 32 hard yes yes yes
Jean Delvareae7b0492008-01-27 18:14:49 +010046
47 Features supported by this driver:
48 Software PEC no
49 Hardware PEC yes
50 Block buffer yes
51 Block process call transaction no
Jean Delvare63420642008-01-27 18:14:50 +010052 I2C block read transaction yes (doesn't use the block buffer)
Jean Delvareae7b0492008-01-27 18:14:49 +010053
54 See the file Documentation/i2c/busses/i2c-i801 for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070055*/
56
57/* Note: we assume there can only be one I801, with one SMBus interface */
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059#include <linux/module.h>
60#include <linux/pci.h>
61#include <linux/kernel.h>
62#include <linux/stddef.h>
63#include <linux/delay.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#include <linux/ioport.h>
65#include <linux/init.h>
66#include <linux/i2c.h>
67#include <asm/io.h>
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069/* I801 SMBus address offsets */
70#define SMBHSTSTS (0 + i801_smba)
71#define SMBHSTCNT (2 + i801_smba)
72#define SMBHSTCMD (3 + i801_smba)
73#define SMBHSTADD (4 + i801_smba)
74#define SMBHSTDAT0 (5 + i801_smba)
75#define SMBHSTDAT1 (6 + i801_smba)
76#define SMBBLKDAT (7 + i801_smba)
Jean Delvareae7b0492008-01-27 18:14:49 +010077#define SMBPEC (8 + i801_smba) /* ICH3 and later */
78#define SMBAUXSTS (12 + i801_smba) /* ICH4 and later */
79#define SMBAUXCTL (13 + i801_smba) /* ICH4 and later */
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81/* PCI Address Constants */
Jean Delvare6dcc19d2006-06-12 21:53:02 +020082#define SMBBAR 4
Linus Torvalds1da177e2005-04-16 15:20:36 -070083#define SMBHSTCFG 0x040
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
85/* Host configuration bits for SMBHSTCFG */
86#define SMBHSTCFG_HST_EN 1
87#define SMBHSTCFG_SMB_SMI_EN 2
88#define SMBHSTCFG_I2C_EN 4
89
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +020090/* Auxillary control register bits, ICH4+ only */
91#define SMBAUXCTL_CRC 1
92#define SMBAUXCTL_E32B 2
93
94/* kill bit for SMBHSTCNT */
95#define SMBHSTCNT_KILL 2
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097/* Other settings */
98#define MAX_TIMEOUT 100
99#define ENABLE_INT9 0 /* set to 0x01 to enable - untested */
100
101/* I801 command constants */
102#define I801_QUICK 0x00
103#define I801_BYTE 0x04
104#define I801_BYTE_DATA 0x08
105#define I801_WORD_DATA 0x0C
Jean Delvareae7b0492008-01-27 18:14:49 +0100106#define I801_PROC_CALL 0x10 /* unimplemented */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107#define I801_BLOCK_DATA 0x14
Jean Delvare63420642008-01-27 18:14:50 +0100108#define I801_I2C_BLOCK_DATA 0x18 /* ICH5 and later */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109#define I801_BLOCK_LAST 0x34
Jean Delvare63420642008-01-27 18:14:50 +0100110#define I801_I2C_BLOCK_LAST 0x38 /* ICH5 and later */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111#define I801_START 0x40
Jean Delvareae7b0492008-01-27 18:14:49 +0100112#define I801_PEC_EN 0x80 /* ICH3 and later */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200114/* I801 Hosts Status register bits */
115#define SMBHSTSTS_BYTE_DONE 0x80
116#define SMBHSTSTS_INUSE_STS 0x40
117#define SMBHSTSTS_SMBALERT_STS 0x20
118#define SMBHSTSTS_FAILED 0x10
119#define SMBHSTSTS_BUS_ERR 0x08
120#define SMBHSTSTS_DEV_ERR 0x04
121#define SMBHSTSTS_INTR 0x02
122#define SMBHSTSTS_HOST_BUSY 0x01
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Jean Delvarecf898dc2008-07-14 22:38:33 +0200124#define STATUS_FLAGS (SMBHSTSTS_BYTE_DONE | SMBHSTSTS_FAILED | \
125 SMBHSTSTS_BUS_ERR | SMBHSTSTS_DEV_ERR | \
126 SMBHSTSTS_INTR)
127
Jean Delvare6dcc19d2006-06-12 21:53:02 +0200128static unsigned long i801_smba;
Jean Delvarea5aaea32007-03-22 19:49:01 +0100129static unsigned char i801_original_hstcfg;
Jean Delvared6072f82005-09-25 16:37:04 +0200130static struct pci_driver i801_driver;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131static struct pci_dev *I801_dev;
Jean Delvare369f6f42008-01-27 18:14:50 +0100132
133#define FEATURE_SMBUS_PEC (1 << 0)
134#define FEATURE_BLOCK_BUFFER (1 << 1)
135#define FEATURE_BLOCK_PROC (1 << 2)
136#define FEATURE_I2C_BLOCK_READ (1 << 3)
137static unsigned int i801_features;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
Jean Delvarecf898dc2008-07-14 22:38:33 +0200139/* Make sure the SMBus host is ready to start transmitting.
140 Return 0 if it is, -EBUSY if it is not. */
141static int i801_check_pre(void)
142{
143 int status;
144
145 status = inb_p(SMBHSTSTS);
146 if (status & SMBHSTSTS_HOST_BUSY) {
147 dev_err(&I801_dev->dev, "SMBus is busy, can't use it!\n");
148 return -EBUSY;
149 }
150
151 status &= STATUS_FLAGS;
152 if (status) {
153 dev_dbg(&I801_dev->dev, "Clearing status flags (%02x)\n",
154 status);
155 outb_p(status, SMBHSTSTS);
156 status = inb_p(SMBHSTSTS) & STATUS_FLAGS;
157 if (status) {
158 dev_err(&I801_dev->dev,
159 "Failed clearing status flags (%02x)\n",
160 status);
161 return -EBUSY;
162 }
163 }
164
165 return 0;
166}
167
168/* Convert the status register to an error code, and clear it. */
169static int i801_check_post(int status, int timeout)
170{
171 int result = 0;
172
173 /* If the SMBus is still busy, we give up */
174 if (timeout) {
175 dev_err(&I801_dev->dev, "Transaction timeout\n");
176 /* try to stop the current command */
177 dev_dbg(&I801_dev->dev, "Terminating the current operation\n");
178 outb_p(inb_p(SMBHSTCNT) | SMBHSTCNT_KILL, SMBHSTCNT);
179 msleep(1);
180 outb_p(inb_p(SMBHSTCNT) & (~SMBHSTCNT_KILL), SMBHSTCNT);
181
182 /* Check if it worked */
183 status = inb_p(SMBHSTSTS);
184 if ((status & SMBHSTSTS_HOST_BUSY) ||
185 !(status & SMBHSTSTS_FAILED))
186 dev_err(&I801_dev->dev,
187 "Failed terminating the transaction\n");
188 outb_p(STATUS_FLAGS, SMBHSTSTS);
189 return -ETIMEDOUT;
190 }
191
192 if (status & SMBHSTSTS_FAILED) {
193 result = -EIO;
194 dev_err(&I801_dev->dev, "Transaction failed\n");
195 }
196 if (status & SMBHSTSTS_DEV_ERR) {
197 result = -ENXIO;
198 dev_dbg(&I801_dev->dev, "No response\n");
199 }
200 if (status & SMBHSTSTS_BUS_ERR) {
201 result = -EAGAIN;
202 dev_dbg(&I801_dev->dev, "Lost arbitration\n");
203 }
204
205 if (result) {
206 /* Clear error flags */
207 outb_p(status & STATUS_FLAGS, SMBHSTSTS);
208 status = inb_p(SMBHSTSTS) & STATUS_FLAGS;
209 if (status) {
210 dev_warn(&I801_dev->dev, "Failed clearing status "
211 "flags at end of transaction (%02x)\n",
212 status);
213 }
214 }
215
216 return result;
217}
218
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200219static int i801_transaction(int xact)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
Jean Delvare2b738092008-07-14 22:38:32 +0200221 int status;
Jean Delvarecf898dc2008-07-14 22:38:33 +0200222 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 int timeout = 0;
224
Jean Delvarecf898dc2008-07-14 22:38:33 +0200225 result = i801_check_pre();
226 if (result < 0)
227 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200229 /* the current contents of SMBHSTCNT can be overwritten, since PEC,
230 * INTREN, SMBSCMD are passed in xact */
231 outb_p(xact | I801_START, SMBHSTCNT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232
233 /* We will always wait for a fraction of a second! */
234 do {
235 msleep(1);
Jean Delvare2b738092008-07-14 22:38:32 +0200236 status = inb_p(SMBHSTSTS);
237 } while ((status & SMBHSTSTS_HOST_BUSY) && (timeout++ < MAX_TIMEOUT));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Jean Delvarecf898dc2008-07-14 22:38:33 +0200239 result = i801_check_post(status, timeout >= MAX_TIMEOUT);
240 if (result < 0)
241 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Jean Delvarecf898dc2008-07-14 22:38:33 +0200243 outb_p(SMBHSTSTS_INTR, SMBHSTSTS);
244 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245}
246
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200247/* wait for INTR bit as advised by Intel */
248static void i801_wait_hwpec(void)
249{
250 int timeout = 0;
Jean Delvare2b738092008-07-14 22:38:32 +0200251 int status;
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200252
253 do {
254 msleep(1);
Jean Delvare2b738092008-07-14 22:38:32 +0200255 status = inb_p(SMBHSTSTS);
256 } while ((!(status & SMBHSTSTS_INTR))
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200257 && (timeout++ < MAX_TIMEOUT));
258
259 if (timeout >= MAX_TIMEOUT) {
260 dev_dbg(&I801_dev->dev, "PEC Timeout!\n");
261 }
Jean Delvare2b738092008-07-14 22:38:32 +0200262 outb_p(status, SMBHSTSTS);
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200263}
264
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200265static int i801_block_transaction_by_block(union i2c_smbus_data *data,
266 char read_write, int hwpec)
267{
268 int i, len;
David Brownell97140342008-07-14 22:38:25 +0200269 int status;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200270
271 inb_p(SMBHSTCNT); /* reset the data buffer index */
272
273 /* Use 32-byte buffer to process this transaction */
274 if (read_write == I2C_SMBUS_WRITE) {
275 len = data->block[0];
276 outb_p(len, SMBHSTDAT0);
277 for (i = 0; i < len; i++)
278 outb_p(data->block[i+1], SMBBLKDAT);
279 }
280
David Brownell97140342008-07-14 22:38:25 +0200281 status = i801_transaction(I801_BLOCK_DATA | ENABLE_INT9 |
282 I801_PEC_EN * hwpec);
283 if (status)
284 return status;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200285
286 if (read_write == I2C_SMBUS_READ) {
287 len = inb_p(SMBHSTDAT0);
288 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX)
David Brownell97140342008-07-14 22:38:25 +0200289 return -EPROTO;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200290
291 data->block[0] = len;
292 for (i = 0; i < len; i++)
293 data->block[i + 1] = inb_p(SMBBLKDAT);
294 }
295 return 0;
296}
297
298static int i801_block_transaction_byte_by_byte(union i2c_smbus_data *data,
Jean Delvare63420642008-01-27 18:14:50 +0100299 char read_write, int command,
300 int hwpec)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301{
302 int i, len;
303 int smbcmd;
Jean Delvare2b738092008-07-14 22:38:32 +0200304 int status;
Jean Delvarecf898dc2008-07-14 22:38:33 +0200305 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 int timeout;
Jean Delvarecf898dc2008-07-14 22:38:33 +0200307
308 result = i801_check_pre();
309 if (result < 0)
310 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200312 len = data->block[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314 if (read_write == I2C_SMBUS_WRITE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 outb_p(len, SMBHSTDAT0);
316 outb_p(data->block[1], SMBBLKDAT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 }
318
319 for (i = 1; i <= len; i++) {
Jean Delvare63420642008-01-27 18:14:50 +0100320 if (i == len && read_write == I2C_SMBUS_READ) {
321 if (command == I2C_SMBUS_I2C_BLOCK_DATA)
322 smbcmd = I801_I2C_BLOCK_LAST;
323 else
324 smbcmd = I801_BLOCK_LAST;
325 } else {
326 if (command == I2C_SMBUS_I2C_BLOCK_DATA
327 && read_write == I2C_SMBUS_READ)
328 smbcmd = I801_I2C_BLOCK_DATA;
329 else
330 smbcmd = I801_BLOCK_DATA;
331 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 outb_p(smbcmd | ENABLE_INT9, SMBHSTCNT);
333
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 if (i == 1)
335 outb_p(inb(SMBHSTCNT) | I801_START, SMBHSTCNT);
336
337 /* We will always wait for a fraction of a second! */
338 timeout = 0;
339 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 msleep(1);
Jean Delvare2b738092008-07-14 22:38:32 +0200341 status = inb_p(SMBHSTSTS);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 }
Jean Delvare2b738092008-07-14 22:38:32 +0200343 while ((!(status & SMBHSTSTS_BYTE_DONE))
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200344 && (timeout++ < MAX_TIMEOUT));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
Jean Delvarecf898dc2008-07-14 22:38:33 +0200346 result = i801_check_post(status, timeout >= MAX_TIMEOUT);
347 if (result < 0)
348 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349
Jean Delvare63420642008-01-27 18:14:50 +0100350 if (i == 1 && read_write == I2C_SMBUS_READ
351 && command != I2C_SMBUS_I2C_BLOCK_DATA) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 len = inb_p(SMBHSTDAT0);
Jean Delvarecf898dc2008-07-14 22:38:33 +0200353 if (len < 1 || len > I2C_SMBUS_BLOCK_MAX) {
354 dev_err(&I801_dev->dev,
355 "Illegal SMBus block read size %d\n",
356 len);
357 /* Recover */
358 while (inb_p(SMBHSTSTS) & SMBHSTSTS_HOST_BUSY)
359 outb_p(SMBHSTSTS_BYTE_DONE, SMBHSTSTS);
360 outb_p(SMBHSTSTS_INTR, SMBHSTSTS);
David Brownell97140342008-07-14 22:38:25 +0200361 return -EPROTO;
Jean Delvarecf898dc2008-07-14 22:38:33 +0200362 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 data->block[0] = len;
364 }
365
366 /* Retrieve/store value in SMBBLKDAT */
367 if (read_write == I2C_SMBUS_READ)
368 data->block[i] = inb_p(SMBBLKDAT);
369 if (read_write == I2C_SMBUS_WRITE && i+1 <= len)
370 outb_p(data->block[i+1], SMBBLKDAT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Jean Delvarecf898dc2008-07-14 22:38:33 +0200372 /* signals SMBBLKDAT ready */
373 outb_p(SMBHSTSTS_BYTE_DONE | SMBHSTSTS_INTR, SMBHSTSTS);
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200374 }
Jean Delvarecf898dc2008-07-14 22:38:33 +0200375
376 return 0;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200377}
378
379static int i801_set_block_buffer_mode(void)
380{
381 outb_p(inb_p(SMBAUXCTL) | SMBAUXCTL_E32B, SMBAUXCTL);
382 if ((inb_p(SMBAUXCTL) & SMBAUXCTL_E32B) == 0)
David Brownell97140342008-07-14 22:38:25 +0200383 return -EIO;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200384 return 0;
385}
386
387/* Block transaction function */
388static int i801_block_transaction(union i2c_smbus_data *data, char read_write,
389 int command, int hwpec)
390{
391 int result = 0;
392 unsigned char hostc;
393
394 if (command == I2C_SMBUS_I2C_BLOCK_DATA) {
395 if (read_write == I2C_SMBUS_WRITE) {
396 /* set I2C_EN bit in configuration register */
397 pci_read_config_byte(I801_dev, SMBHSTCFG, &hostc);
398 pci_write_config_byte(I801_dev, SMBHSTCFG,
399 hostc | SMBHSTCFG_I2C_EN);
Jean Delvare63420642008-01-27 18:14:50 +0100400 } else if (!(i801_features & FEATURE_I2C_BLOCK_READ)) {
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200401 dev_err(&I801_dev->dev,
Jean Delvare63420642008-01-27 18:14:50 +0100402 "I2C block read is unsupported!\n");
David Brownell97140342008-07-14 22:38:25 +0200403 return -EOPNOTSUPP;
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200404 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 }
406
Jean Delvare63420642008-01-27 18:14:50 +0100407 if (read_write == I2C_SMBUS_WRITE
408 || command == I2C_SMBUS_I2C_BLOCK_DATA) {
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200409 if (data->block[0] < 1)
410 data->block[0] = 1;
411 if (data->block[0] > I2C_SMBUS_BLOCK_MAX)
412 data->block[0] = I2C_SMBUS_BLOCK_MAX;
413 } else {
Jean Delvare63420642008-01-27 18:14:50 +0100414 data->block[0] = 32; /* max for SMBus block reads */
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200415 }
416
Jean Delvare369f6f42008-01-27 18:14:50 +0100417 if ((i801_features & FEATURE_BLOCK_BUFFER)
Jean Delvare63420642008-01-27 18:14:50 +0100418 && !(command == I2C_SMBUS_I2C_BLOCK_DATA
419 && read_write == I2C_SMBUS_READ)
Jean Delvare369f6f42008-01-27 18:14:50 +0100420 && i801_set_block_buffer_mode() == 0)
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200421 result = i801_block_transaction_by_block(data, read_write,
422 hwpec);
423 else
424 result = i801_block_transaction_byte_by_byte(data, read_write,
Jean Delvare63420642008-01-27 18:14:50 +0100425 command, hwpec);
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200426
427 if (result == 0 && hwpec)
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200428 i801_wait_hwpec();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Jean Delvare63420642008-01-27 18:14:50 +0100430 if (command == I2C_SMBUS_I2C_BLOCK_DATA
431 && read_write == I2C_SMBUS_WRITE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 /* restore saved configuration register value */
433 pci_write_config_byte(I801_dev, SMBHSTCFG, hostc);
434 }
435 return result;
436}
437
David Brownell97140342008-07-14 22:38:25 +0200438/* Return negative errno on error. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439static s32 i801_access(struct i2c_adapter * adap, u16 addr,
440 unsigned short flags, char read_write, u8 command,
441 int size, union i2c_smbus_data * data)
442{
Jean Delvaree8aac4a2005-10-26 21:34:42 +0200443 int hwpec;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 int block = 0;
445 int ret, xact = 0;
446
Jean Delvare369f6f42008-01-27 18:14:50 +0100447 hwpec = (i801_features & FEATURE_SMBUS_PEC) && (flags & I2C_CLIENT_PEC)
Jean Delvaree8aac4a2005-10-26 21:34:42 +0200448 && size != I2C_SMBUS_QUICK
449 && size != I2C_SMBUS_I2C_BLOCK_DATA;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
451 switch (size) {
452 case I2C_SMBUS_QUICK:
453 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
454 SMBHSTADD);
455 xact = I801_QUICK;
456 break;
457 case I2C_SMBUS_BYTE:
458 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
459 SMBHSTADD);
460 if (read_write == I2C_SMBUS_WRITE)
461 outb_p(command, SMBHSTCMD);
462 xact = I801_BYTE;
463 break;
464 case I2C_SMBUS_BYTE_DATA:
465 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
466 SMBHSTADD);
467 outb_p(command, SMBHSTCMD);
468 if (read_write == I2C_SMBUS_WRITE)
469 outb_p(data->byte, SMBHSTDAT0);
470 xact = I801_BYTE_DATA;
471 break;
472 case I2C_SMBUS_WORD_DATA:
473 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
474 SMBHSTADD);
475 outb_p(command, SMBHSTCMD);
476 if (read_write == I2C_SMBUS_WRITE) {
477 outb_p(data->word & 0xff, SMBHSTDAT0);
478 outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1);
479 }
480 xact = I801_WORD_DATA;
481 break;
482 case I2C_SMBUS_BLOCK_DATA:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
484 SMBHSTADD);
485 outb_p(command, SMBHSTCMD);
486 block = 1;
487 break;
Jean Delvare63420642008-01-27 18:14:50 +0100488 case I2C_SMBUS_I2C_BLOCK_DATA:
489 /* NB: page 240 of ICH5 datasheet shows that the R/#W
490 * bit should be cleared here, even when reading */
491 outb_p((addr & 0x7f) << 1, SMBHSTADD);
492 if (read_write == I2C_SMBUS_READ) {
493 /* NB: page 240 of ICH5 datasheet also shows
494 * that DATA1 is the cmd field when reading */
495 outb_p(command, SMBHSTDAT1);
496 } else
497 outb_p(command, SMBHSTCMD);
498 block = 1;
499 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 default:
501 dev_err(&I801_dev->dev, "Unsupported transaction %d\n", size);
David Brownell97140342008-07-14 22:38:25 +0200502 return -EOPNOTSUPP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 }
504
Oleg Ryjkovca8b9e32007-07-12 14:12:31 +0200505 if (hwpec) /* enable/disable hardware PEC */
506 outb_p(inb_p(SMBAUXCTL) | SMBAUXCTL_CRC, SMBAUXCTL);
507 else
508 outb_p(inb_p(SMBAUXCTL) & (~SMBAUXCTL_CRC), SMBAUXCTL);
Jean Delvaree8aac4a2005-10-26 21:34:42 +0200509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 if(block)
Jean Delvare585b3162005-10-26 21:31:15 +0200511 ret = i801_block_transaction(data, read_write, size, hwpec);
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200512 else
513 ret = i801_transaction(xact | ENABLE_INT9);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Jean Delvarec79cfba2006-04-20 02:43:18 -0700515 /* Some BIOSes don't like it when PEC is enabled at reboot or resume
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200516 time, so we forcibly disable it after every transaction. Turn off
517 E32B for the same reason. */
Jean Delvarea0921b62008-01-27 18:14:50 +0100518 if (hwpec || block)
Oleg Ryjkov7edcb9a2007-07-12 14:12:31 +0200519 outb_p(inb_p(SMBAUXCTL) & ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B),
520 SMBAUXCTL);
Jean Delvarec79cfba2006-04-20 02:43:18 -0700521
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 if(block)
523 return ret;
524 if(ret)
David Brownell97140342008-07-14 22:38:25 +0200525 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 if ((read_write == I2C_SMBUS_WRITE) || (xact == I801_QUICK))
527 return 0;
528
529 switch (xact & 0x7f) {
530 case I801_BYTE: /* Result put in SMBHSTDAT0 */
531 case I801_BYTE_DATA:
532 data->byte = inb_p(SMBHSTDAT0);
533 break;
534 case I801_WORD_DATA:
535 data->word = inb_p(SMBHSTDAT0) + (inb_p(SMBHSTDAT1) << 8);
536 break;
537 }
538 return 0;
539}
540
541
542static u32 i801_func(struct i2c_adapter *adapter)
543{
544 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
Jean Delvare369f6f42008-01-27 18:14:50 +0100545 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
546 I2C_FUNC_SMBUS_BLOCK_DATA | I2C_FUNC_SMBUS_WRITE_I2C_BLOCK |
Jean Delvare63420642008-01-27 18:14:50 +0100547 ((i801_features & FEATURE_SMBUS_PEC) ? I2C_FUNC_SMBUS_PEC : 0) |
548 ((i801_features & FEATURE_I2C_BLOCK_READ) ?
549 I2C_FUNC_SMBUS_READ_I2C_BLOCK : 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550}
551
Jean Delvare8f9082c2006-09-03 22:39:46 +0200552static const struct i2c_algorithm smbus_algorithm = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 .smbus_xfer = i801_access,
554 .functionality = i801_func,
555};
556
557static struct i2c_adapter i801_adapter = {
558 .owner = THIS_MODULE,
Stephen Hemminger9ace5552007-02-13 22:09:01 +0100559 .id = I2C_HW_SMBUS_I801,
Jean Delvare3401b2f2008-07-14 22:38:29 +0200560 .class = I2C_CLASS_HWMON | I2C_CLASS_SPD,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 .algo = &smbus_algorithm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562};
563
564static struct pci_device_id i801_ids[] = {
565 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AA_3) },
566 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801AB_3) },
567 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801BA_2) },
568 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801CA_3) },
569 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801DB_3) },
570 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_82801EB_3) },
571 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB_4) },
572 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH6_16) },
573 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH7_17) },
Jason Gastonb0a70b52005-04-16 15:24:45 -0700574 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ESB2_17) },
Jason Gaston8254fc42006-01-09 10:58:08 -0800575 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH8_5) },
Jason Gastonadbc2a12006-11-22 15:19:12 -0800576 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH9_6) },
Jason Gastone07bc672007-10-13 23:56:31 +0200577 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_TOLAPAI_1) },
Gaston, Jason Dd28dc712008-02-24 20:03:42 +0100578 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_4) },
579 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_ICH10_5) },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 { 0, }
581};
582
583MODULE_DEVICE_TABLE (pci, i801_ids);
584
585static int __devinit i801_probe(struct pci_dev *dev, const struct pci_device_id *id)
586{
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200587 unsigned char temp;
Jean Delvare455f3322006-06-12 21:52:02 +0200588 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200590 I801_dev = dev;
Jean Delvare369f6f42008-01-27 18:14:50 +0100591 i801_features = 0;
Jean Delvare250d1bd2006-12-10 21:21:33 +0100592 switch (dev->device) {
Jean Delvare250d1bd2006-12-10 21:21:33 +0100593 case PCI_DEVICE_ID_INTEL_82801EB_3:
594 case PCI_DEVICE_ID_INTEL_ESB_4:
595 case PCI_DEVICE_ID_INTEL_ICH6_16:
596 case PCI_DEVICE_ID_INTEL_ICH7_17:
597 case PCI_DEVICE_ID_INTEL_ESB2_17:
598 case PCI_DEVICE_ID_INTEL_ICH8_5:
599 case PCI_DEVICE_ID_INTEL_ICH9_6:
Gaston, Jason Dd28dc712008-02-24 20:03:42 +0100600 case PCI_DEVICE_ID_INTEL_TOLAPAI_1:
601 case PCI_DEVICE_ID_INTEL_ICH10_4:
602 case PCI_DEVICE_ID_INTEL_ICH10_5:
Jean Delvare63420642008-01-27 18:14:50 +0100603 i801_features |= FEATURE_I2C_BLOCK_READ;
604 /* fall through */
605 case PCI_DEVICE_ID_INTEL_82801DB_3:
Jean Delvare369f6f42008-01-27 18:14:50 +0100606 i801_features |= FEATURE_SMBUS_PEC;
607 i801_features |= FEATURE_BLOCK_BUFFER;
Jean Delvare250d1bd2006-12-10 21:21:33 +0100608 break;
Jean Delvare250d1bd2006-12-10 21:21:33 +0100609 }
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200610
611 err = pci_enable_device(dev);
612 if (err) {
613 dev_err(&dev->dev, "Failed to enable SMBus PCI device (%d)\n",
614 err);
615 goto exit;
616 }
617
618 /* Determine the address of the SMBus area */
619 i801_smba = pci_resource_start(dev, SMBBAR);
620 if (!i801_smba) {
621 dev_err(&dev->dev, "SMBus base address uninitialized, "
622 "upgrade BIOS\n");
623 err = -ENODEV;
Daniel Ritzd6fcb3b2006-06-27 18:40:54 +0200624 goto exit;
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200625 }
626
627 err = pci_request_region(dev, SMBBAR, i801_driver.name);
628 if (err) {
629 dev_err(&dev->dev, "Failed to request SMBus region "
Andrew Morton598736c2006-06-30 01:56:20 -0700630 "0x%lx-0x%Lx\n", i801_smba,
631 (unsigned long long)pci_resource_end(dev, SMBBAR));
Daniel Ritzd6fcb3b2006-06-27 18:40:54 +0200632 goto exit;
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200633 }
634
635 pci_read_config_byte(I801_dev, SMBHSTCFG, &temp);
Jean Delvarea5aaea32007-03-22 19:49:01 +0100636 i801_original_hstcfg = temp;
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200637 temp &= ~SMBHSTCFG_I2C_EN; /* SMBus timing */
638 if (!(temp & SMBHSTCFG_HST_EN)) {
639 dev_info(&dev->dev, "Enabling SMBus device\n");
640 temp |= SMBHSTCFG_HST_EN;
641 }
642 pci_write_config_byte(I801_dev, SMBHSTCFG, temp);
643
644 if (temp & SMBHSTCFG_SMB_SMI_EN)
645 dev_dbg(&dev->dev, "SMBus using interrupt SMI#\n");
646 else
647 dev_dbg(&dev->dev, "SMBus using PCI Interrupt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Jean Delvarea0921b62008-01-27 18:14:50 +0100649 /* Clear special mode bits */
650 if (i801_features & (FEATURE_SMBUS_PEC | FEATURE_BLOCK_BUFFER))
651 outb_p(inb_p(SMBAUXCTL) & ~(SMBAUXCTL_CRC | SMBAUXCTL_E32B),
652 SMBAUXCTL);
653
Robert P. J. Day405ae7d2007-02-17 19:13:42 +0100654 /* set up the sysfs linkage to our parent device */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 i801_adapter.dev.parent = &dev->dev;
656
David Brownell2096b952007-05-01 23:26:28 +0200657 snprintf(i801_adapter.name, sizeof(i801_adapter.name),
Jean Delvare6dcc19d2006-06-12 21:53:02 +0200658 "SMBus I801 adapter at %04lx", i801_smba);
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200659 err = i2c_add_adapter(&i801_adapter);
660 if (err) {
661 dev_err(&dev->dev, "Failed to add SMBus adapter\n");
Daniel Ritzd6fcb3b2006-06-27 18:40:54 +0200662 goto exit_release;
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200663 }
Daniel Ritzd6fcb3b2006-06-27 18:40:54 +0200664 return 0;
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200665
Daniel Ritzd6fcb3b2006-06-27 18:40:54 +0200666exit_release:
667 pci_release_region(dev, SMBBAR);
Jean Delvare02dd7ae2006-06-12 21:53:41 +0200668exit:
669 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670}
671
672static void __devexit i801_remove(struct pci_dev *dev)
673{
674 i2c_del_adapter(&i801_adapter);
Jean Delvarea5aaea32007-03-22 19:49:01 +0100675 pci_write_config_byte(I801_dev, SMBHSTCFG, i801_original_hstcfg);
Jean Delvare6dcc19d2006-06-12 21:53:02 +0200676 pci_release_region(dev, SMBBAR);
Daniel Ritzd6fcb3b2006-06-27 18:40:54 +0200677 /*
678 * do not call pci_disable_device(dev) since it can cause hard hangs on
679 * some systems during power-off (eg. Fujitsu-Siemens Lifebook E8010)
680 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681}
682
Jean Delvarea5aaea32007-03-22 19:49:01 +0100683#ifdef CONFIG_PM
684static int i801_suspend(struct pci_dev *dev, pm_message_t mesg)
685{
686 pci_save_state(dev);
687 pci_write_config_byte(dev, SMBHSTCFG, i801_original_hstcfg);
688 pci_set_power_state(dev, pci_choose_state(dev, mesg));
689 return 0;
690}
691
692static int i801_resume(struct pci_dev *dev)
693{
694 pci_set_power_state(dev, PCI_D0);
695 pci_restore_state(dev);
696 return pci_enable_device(dev);
697}
698#else
699#define i801_suspend NULL
700#define i801_resume NULL
701#endif
702
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703static struct pci_driver i801_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 .name = "i801_smbus",
705 .id_table = i801_ids,
706 .probe = i801_probe,
707 .remove = __devexit_p(i801_remove),
Jean Delvarea5aaea32007-03-22 19:49:01 +0100708 .suspend = i801_suspend,
709 .resume = i801_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710};
711
712static int __init i2c_i801_init(void)
713{
714 return pci_register_driver(&i801_driver);
715}
716
717static void __exit i2c_i801_exit(void)
718{
719 pci_unregister_driver(&i801_driver);
720}
721
Jean Delvare63420642008-01-27 18:14:50 +0100722MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>, "
723 "Jean Delvare <khali@linux-fr.org>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724MODULE_DESCRIPTION("I801 SMBus driver");
725MODULE_LICENSE("GPL");
726
727module_init(i2c_i801_init);
728module_exit(i2c_i801_exit);