2 i2c-ali1535.c - Part of lm_sensors, Linux kernel modules for hardware
4 Copyright (c) 2000 Frodo Looijaard <frodol@dds.nl>,
5 Philip Edelbrock <phil@netroedge.com>,
6 Mark D. Studebaker <mdsxyz123@yahoo.com>,
7 Dan Eaton <dan.eaton@rocketlogix.com> and
8 Stephen Rousset<stephen.rousset@rocketlogix.com>
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 This is the driver for the SMB Host controller on
27 Acer Labs Inc. (ALI) M1535 South Bridge.
29 The M1535 is a South bridge for portable systems.
30 It is very similar to the M15x3 South bridges also produced
31 by Acer Labs Inc. Some of the registers within the part
32 have moved and some have been redefined slightly. Additionally,
33 the sequencing of the SMBus transactions has been modified
34 to be more consistent with the sequencing recommended by
35 the manufacturer and observed through testing. These
36 changes are reflected in this driver and can be identified
37 by comparing this driver to the i2c-ali15x3 driver.
38 For an overview of these chips see http://www.acerlabs.com
40 The SMB controller is part of the 7101 device, which is an
41 ACPI-compliant Power Management Unit (PMU).
43 The whole 7101 device has to be enabled for the SMB to work.
44 You can't just enable the SMB alone.
45 The SMB and the ACPI have separate I/O spaces.
46 We make sure that the SMB is enabled. We leave the ACPI alone.
48 This driver controls the SMB Host only.
50 This driver does not use interrupts.
54 /* Note: we assume there can only be one ALI1535, with one SMBus interface */
56 #include <linux/module.h>
57 #include <linux/pci.h>
58 #include <linux/kernel.h>
59 #include <linux/stddef.h>
60 #include <linux/delay.h>
61 #include <linux/ioport.h>
62 #include <linux/i2c.h>
63 #include <linux/init.h>
67 /* ALI1535 SMBus address offsets */
68 #define SMBHSTSTS (0 + ali1535_smba)
69 #define SMBHSTTYP (1 + ali1535_smba)
70 #define SMBHSTPORT (2 + ali1535_smba)
71 #define SMBHSTCMD (7 + ali1535_smba)
72 #define SMBHSTADD (3 + ali1535_smba)
73 #define SMBHSTDAT0 (4 + ali1535_smba)
74 #define SMBHSTDAT1 (5 + ali1535_smba)
75 #define SMBBLKDAT (6 + ali1535_smba)
77 /* PCI Address Constants */
82 #define SMBHSTCFG 0x0F0
86 #define MAX_TIMEOUT 500 /* times 1/100 sec */
87 #define ALI1535_SMB_IOSIZE 32
89 #define ALI1535_SMB_DEFAULTBASE 0x8040
91 /* ALI1535 address lock bits */
92 #define ALI1535_LOCK 0x06 /* dwe */
94 /* ALI1535 command constants */
95 #define ALI1535_QUICK 0x00
96 #define ALI1535_BYTE 0x10
97 #define ALI1535_BYTE_DATA 0x20
98 #define ALI1535_WORD_DATA 0x30
99 #define ALI1535_BLOCK_DATA 0x40
100 #define ALI1535_I2C_READ 0x60
102 #define ALI1535_DEV10B_EN 0x80 /* Enable 10-bit addressing in */
104 #define ALI1535_T_OUT 0x08 /* Time-out Command (write) */
105 #define ALI1535_A_HIGH_BIT9 0x08 /* Bit 9 of 10-bit address in */
106 /* Alert-Response-Address */
108 #define ALI1535_KILL 0x04 /* Kill Command (write) */
109 #define ALI1535_A_HIGH_BIT8 0x04 /* Bit 8 of 10-bit address in */
110 /* Alert-Response-Address */
113 #define ALI1535_D_HI_MASK 0x03 /* Mask for isolating bits 9-8 */
114 /* of 10-bit address in I2C */
117 /* ALI1535 status register bits */
118 #define ALI1535_STS_IDLE 0x04
119 #define ALI1535_STS_BUSY 0x08 /* host busy */
120 #define ALI1535_STS_DONE 0x10 /* transaction complete */
121 #define ALI1535_STS_DEV 0x20 /* device error */
122 #define ALI1535_STS_BUSERR 0x40 /* bus error */
123 #define ALI1535_STS_FAIL 0x80 /* failed bus transaction */
124 #define ALI1535_STS_ERR 0xE0 /* all the bad error bits */
126 #define ALI1535_BLOCK_CLR 0x04 /* reset block data index */
128 /* ALI1535 device address register bits */
129 #define ALI1535_RD_ADDR 0x01 /* Read/Write Bit in Device */
133 #define ALI1535_SMBIO_EN 0x04 /* SMB I/O Space enable */
135 static struct pci_driver ali1535_driver;
136 static unsigned short ali1535_smba;
138 /* Detect whether a ALI1535 can be found, and initialize it, where necessary.
139 Note the differences between kernels with the old PCI BIOS interface and
140 newer kernels with the real PCI interface. In compat.h some things are
141 defined to make the transition easier. */
142 static int ali1535_setup(struct pci_dev *dev)
144 int retval = -ENODEV;
147 /* Check the following things:
148 - SMB I/O address is initialized
150 - We can use the addresses
153 /* Determine the address of the SMBus area */
154 pci_read_config_word(dev, SMBBA, &ali1535_smba);
155 ali1535_smba &= (0xffff & ~(ALI1535_SMB_IOSIZE - 1));
156 if (ali1535_smba == 0) {
158 "ALI1535_smb region uninitialized - upgrade BIOS?\n");
162 if (!request_region(ali1535_smba, ALI1535_SMB_IOSIZE,
163 ali1535_driver.name)) {
164 dev_err(&dev->dev, "ALI1535_smb region 0x%x already in use!\n",
169 /* check if whole device is enabled */
170 pci_read_config_byte(dev, SMBCFG, &temp);
171 if ((temp & ALI1535_SMBIO_EN) == 0) {
172 dev_err(&dev->dev, "SMB device not enabled - upgrade BIOS?\n");
176 /* Is SMB Host controller enabled? */
177 pci_read_config_byte(dev, SMBHSTCFG, &temp);
178 if ((temp & 1) == 0) {
179 dev_err(&dev->dev, "SMBus controller not enabled - upgrade BIOS?\n");
183 /* set SMB clock to 74KHz as recommended in data sheet */
184 pci_write_config_byte(dev, SMBCLK, 0x20);
187 The interrupt routing for SMB is set up in register 0x77 in the
188 1533 ISA Bridge device, NOT in the 7101 device.
189 Don't bother with finding the 1533 device and reading the register.
190 if ((....... & 0x0F) == 1)
191 dev_dbg(&dev->dev, "ALI1535 using Interrupt 9 for SMBus.\n");
193 pci_read_config_byte(dev, SMBREV, &temp);
194 dev_dbg(&dev->dev, "SMBREV = 0x%X\n", temp);
195 dev_dbg(&dev->dev, "ALI1535_smba = 0x%X\n", ali1535_smba);
202 release_region(ali1535_smba, ALI1535_SMB_IOSIZE);
206 static int ali1535_transaction(struct i2c_adapter *adap)
212 dev_dbg(&adap->dev, "Transaction (pre): STS=%02x, TYP=%02x, "
213 "CMD=%02x, ADD=%02x, DAT0=%02x, DAT1=%02x\n",
214 inb_p(SMBHSTSTS), inb_p(SMBHSTTYP), inb_p(SMBHSTCMD),
215 inb_p(SMBHSTADD), inb_p(SMBHSTDAT0), inb_p(SMBHSTDAT1));
218 temp = inb_p(SMBHSTSTS);
220 /* Make sure the SMBus host is ready to start transmitting */
221 /* Check the busy bit first */
222 if (temp & ALI1535_STS_BUSY) {
223 /* If the host controller is still busy, it may have timed out
224 * in the previous transaction, resulting in a "SMBus Timeout"
225 * printk. I've tried the following to reset a stuck busy bit.
226 * 1. Reset the controller with an KILL command. (this
227 * doesn't seem to clear the controller if an external
229 * 2. Reset the controller and the other SMBus devices with a
230 * T_OUT command. (this clears the host busy bit if an
231 * external device is hung, but it comes back upon a new
232 * access to a device)
233 * 3. Disable and reenable the controller in SMBHSTCFG. Worst
234 * case, nothing seems to work except power reset.
237 /* Try resetting entire SMB bus, including other devices - This
238 * may not work either - it clears the BUSY bit but then the
239 * BUSY bit may come back on when you try and use the chip
240 * again. If that's the case you are stuck.
243 "Resetting entire SMB Bus to clear busy condition (%02x)\n",
245 outb_p(ALI1535_T_OUT, SMBHSTTYP);
246 temp = inb_p(SMBHSTSTS);
249 /* now check the error bits and the busy bit */
250 if (temp & (ALI1535_STS_ERR | ALI1535_STS_BUSY)) {
251 /* do a clear-on-write */
252 outb_p(0xFF, SMBHSTSTS);
253 if ((temp = inb_p(SMBHSTSTS)) &
254 (ALI1535_STS_ERR | ALI1535_STS_BUSY)) {
255 /* This is probably going to be correctable only by a
256 * power reset as one of the bits now appears to be
258 /* This may be a bus or device with electrical problems. */
260 "SMBus reset failed! (0x%02x) - controller or "
261 "device on bus is probably hung\n", temp);
265 /* check and clear done bit */
266 if (temp & ALI1535_STS_DONE) {
267 outb_p(temp, SMBHSTSTS);
271 /* start the transaction by writing anything to the start register */
272 outb_p(0xFF, SMBHSTPORT);
274 /* We will always wait for a fraction of a second! */
278 temp = inb_p(SMBHSTSTS);
279 } while (((temp & ALI1535_STS_BUSY) && !(temp & ALI1535_STS_IDLE))
280 && (timeout++ < MAX_TIMEOUT));
282 /* If the SMBus is still busy, we give up */
283 if (timeout >= MAX_TIMEOUT) {
285 dev_err(&adap->dev, "SMBus Timeout!\n");
288 if (temp & ALI1535_STS_FAIL) {
290 dev_dbg(&adap->dev, "Error: Failed bus transaction\n");
293 /* Unfortunately the ALI SMB controller maps "no response" and "bus
294 * collision" into a single bit. No reponse is the usual case so don't
295 * do a printk. This means that bus collisions go unreported.
297 if (temp & ALI1535_STS_BUSERR) {
300 "Error: no response or bus collision ADD=%02x\n",
304 /* haven't ever seen this */
305 if (temp & ALI1535_STS_DEV) {
307 dev_err(&adap->dev, "Error: device error\n");
310 /* check to see if the "command complete" indication is set */
311 if (!(temp & ALI1535_STS_DONE)) {
313 dev_err(&adap->dev, "Error: command never completed\n");
316 dev_dbg(&adap->dev, "Transaction (post): STS=%02x, TYP=%02x, "
317 "CMD=%02x, ADD=%02x, DAT0=%02x, DAT1=%02x\n",
318 inb_p(SMBHSTSTS), inb_p(SMBHSTTYP), inb_p(SMBHSTCMD),
319 inb_p(SMBHSTADD), inb_p(SMBHSTDAT0), inb_p(SMBHSTDAT1));
321 /* take consequent actions for error conditions */
322 if (!(temp & ALI1535_STS_DONE)) {
323 /* issue "kill" to reset host controller */
324 outb_p(ALI1535_KILL,SMBHSTTYP);
325 outb_p(0xFF,SMBHSTSTS);
326 } else if (temp & ALI1535_STS_ERR) {
327 /* issue "timeout" to reset all devices on bus */
328 outb_p(ALI1535_T_OUT,SMBHSTTYP);
329 outb_p(0xFF,SMBHSTSTS);
335 /* Return negative errno on error. */
336 static s32 ali1535_access(struct i2c_adapter *adap, u16 addr,
337 unsigned short flags, char read_write, u8 command,
338 int size, union i2c_smbus_data *data)
345 /* make sure SMBus is idle */
346 temp = inb_p(SMBHSTSTS);
348 (timeout < MAX_TIMEOUT) && !(temp & ALI1535_STS_IDLE);
351 temp = inb_p(SMBHSTSTS);
353 if (timeout >= MAX_TIMEOUT)
354 dev_warn(&adap->dev, "Idle wait Timeout! STS=0x%02x\n", temp);
356 /* clear status register (clear-on-write) */
357 outb_p(0xFF, SMBHSTSTS);
360 case I2C_SMBUS_QUICK:
361 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
363 size = ALI1535_QUICK;
364 outb_p(size, SMBHSTTYP); /* output command */
367 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
370 outb_p(size, SMBHSTTYP); /* output command */
371 if (read_write == I2C_SMBUS_WRITE)
372 outb_p(command, SMBHSTCMD);
374 case I2C_SMBUS_BYTE_DATA:
375 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
377 size = ALI1535_BYTE_DATA;
378 outb_p(size, SMBHSTTYP); /* output command */
379 outb_p(command, SMBHSTCMD);
380 if (read_write == I2C_SMBUS_WRITE)
381 outb_p(data->byte, SMBHSTDAT0);
383 case I2C_SMBUS_WORD_DATA:
384 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
386 size = ALI1535_WORD_DATA;
387 outb_p(size, SMBHSTTYP); /* output command */
388 outb_p(command, SMBHSTCMD);
389 if (read_write == I2C_SMBUS_WRITE) {
390 outb_p(data->word & 0xff, SMBHSTDAT0);
391 outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1);
394 case I2C_SMBUS_BLOCK_DATA:
395 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
397 size = ALI1535_BLOCK_DATA;
398 outb_p(size, SMBHSTTYP); /* output command */
399 outb_p(command, SMBHSTCMD);
400 if (read_write == I2C_SMBUS_WRITE) {
401 len = data->block[0];
404 data->block[0] = len;
408 data->block[0] = len;
410 outb_p(len, SMBHSTDAT0);
411 /* Reset SMBBLKDAT */
412 outb_p(inb_p(SMBHSTTYP) | ALI1535_BLOCK_CLR, SMBHSTTYP);
413 for (i = 1; i <= len; i++)
414 outb_p(data->block[i], SMBBLKDAT);
418 dev_warn(&adap->dev, "Unsupported transaction %d\n", size);
419 result = -EOPNOTSUPP;
423 result = ali1535_transaction(adap);
427 if ((read_write == I2C_SMBUS_WRITE) || (size == ALI1535_QUICK)) {
433 case ALI1535_BYTE: /* Result put in SMBHSTDAT0 */
434 data->byte = inb_p(SMBHSTDAT0);
436 case ALI1535_BYTE_DATA:
437 data->byte = inb_p(SMBHSTDAT0);
439 case ALI1535_WORD_DATA:
440 data->word = inb_p(SMBHSTDAT0) + (inb_p(SMBHSTDAT1) << 8);
442 case ALI1535_BLOCK_DATA:
443 len = inb_p(SMBHSTDAT0);
446 data->block[0] = len;
447 /* Reset SMBBLKDAT */
448 outb_p(inb_p(SMBHSTTYP) | ALI1535_BLOCK_CLR, SMBHSTTYP);
449 for (i = 1; i <= data->block[0]; i++) {
450 data->block[i] = inb_p(SMBBLKDAT);
451 dev_dbg(&adap->dev, "Blk: len=%d, i=%d, data=%02x\n",
452 len, i, data->block[i]);
461 static u32 ali1535_func(struct i2c_adapter *adapter)
463 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
464 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
465 I2C_FUNC_SMBUS_BLOCK_DATA;
468 static const struct i2c_algorithm smbus_algorithm = {
469 .smbus_xfer = ali1535_access,
470 .functionality = ali1535_func,
473 static struct i2c_adapter ali1535_adapter = {
474 .owner = THIS_MODULE,
475 .id = I2C_HW_SMBUS_ALI1535,
476 .class = I2C_CLASS_HWMON,
477 .algo = &smbus_algorithm,
480 static struct pci_device_id ali1535_ids[] = {
481 { PCI_DEVICE(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M7101) },
485 MODULE_DEVICE_TABLE (pci, ali1535_ids);
487 static int __devinit ali1535_probe(struct pci_dev *dev, const struct pci_device_id *id)
489 if (ali1535_setup(dev)) {
491 "ALI1535 not detected, module not inserted.\n");
495 /* set up the sysfs linkage to our parent device */
496 ali1535_adapter.dev.parent = &dev->dev;
498 snprintf(ali1535_adapter.name, sizeof(ali1535_adapter.name),
499 "SMBus ALI1535 adapter at %04x", ali1535_smba);
500 return i2c_add_adapter(&ali1535_adapter);
503 static void __devexit ali1535_remove(struct pci_dev *dev)
505 i2c_del_adapter(&ali1535_adapter);
506 release_region(ali1535_smba, ALI1535_SMB_IOSIZE);
509 static struct pci_driver ali1535_driver = {
510 .name = "ali1535_smbus",
511 .id_table = ali1535_ids,
512 .probe = ali1535_probe,
513 .remove = __devexit_p(ali1535_remove),
516 static int __init i2c_ali1535_init(void)
518 return pci_register_driver(&ali1535_driver);
521 static void __exit i2c_ali1535_exit(void)
523 pci_unregister_driver(&ali1535_driver);
526 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>, "
527 "Philip Edelbrock <phil@netroedge.com>, "
528 "Mark D. Studebaker <mdsxyz123@yahoo.com> "
529 "and Dan Eaton <dan.eaton@rocketlogix.com>");
530 MODULE_DESCRIPTION("ALI1535 SMBus driver");
531 MODULE_LICENSE("GPL");
533 module_init(i2c_ali1535_init);
534 module_exit(i2c_ali1535_exit);