2 sis5595.c - Part of lm_sensors, Linux kernel modules for hardware
4 Copyright (c) 1998, 1999 Frodo Looijaard <frodol@dds.nl> and
5 Philip Edelbrock <phil@netroedge.com>
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 /* Note: we assume there can only be one SIS5595 with one SMBus interface */
25 Note: all have mfr. ID 0x1039.
29 Note: these chips contain a 0008 device which is incompatible with the
30 5595. We recognize these by the presence of the listed
31 "blacklist" PCI ID and refuse to load.
33 NOT SUPPORTED PCI ID BLACKLIST PCI ID
54 * Add Block Transfers (ugly, but supported by the adapter)
58 #include <linux/config.h>
59 #include <linux/kernel.h>
60 #include <linux/module.h>
61 #include <linux/pci.h>
62 #include <linux/ioport.h>
63 #include <linux/init.h>
64 #include <linux/i2c.h>
67 static int blacklist[] = {
80 PCI_DEVICE_ID_SI_5511, /* 5513 chip has the 0008 device but that ID
81 shows up in other chips so we use the 5511
83 PCI_DEVICE_ID_SI_5597,
84 PCI_DEVICE_ID_SI_5598,
85 0, /* terminates the list */
88 /* Length of ISA address segment */
89 #define SIS5595_EXTENT 8
90 /* SIS5595 SMBus registers */
91 #define SMB_STS_LO 0x00
92 #define SMB_STS_HI 0x01
93 #define SMB_CTL_LO 0x02
94 #define SMB_CTL_HI 0x03
105 /* PCI Address Constants */
106 #define SMB_INDEX 0x38
108 #define SIS5595_ENABLE_REG 0x40
109 #define ACPI_BASE 0x90
112 #define MAX_TIMEOUT 500
114 /* SIS5595 constants */
115 #define SIS5595_QUICK 0x00
116 #define SIS5595_BYTE 0x02
117 #define SIS5595_BYTE_DATA 0x04
118 #define SIS5595_WORD_DATA 0x06
119 #define SIS5595_PROC_CALL 0x08
120 #define SIS5595_BLOCK_DATA 0x0A
122 /* insmod parameters */
124 /* If force_addr is set to anything different from 0, we forcibly enable
125 the device at the given address. */
126 static int force_addr = 0;
127 MODULE_PARM(force_addr, "i");
128 MODULE_PARM_DESC(force_addr, "Initialize the base address of the i2c controller");
130 static unsigned short sis5595_base = 0;
132 static u8 sis5595_read(u8 reg)
134 outb(reg, sis5595_base + SMB_INDEX);
135 return inb(sis5595_base + SMB_DAT);
138 static void sis5595_write(u8 reg, u8 data)
140 outb(reg, sis5595_base + SMB_INDEX);
141 outb(data, sis5595_base + SMB_DAT);
144 static int sis5595_setup(struct pci_dev *SIS5595_dev)
149 int retval = -ENODEV;
151 /* Look for imposters */
152 for (i = blacklist; *i != 0; i++) {
154 dev = pci_get_device(PCI_VENDOR_ID_SI, *i, NULL);
156 dev_err(&SIS5595_dev->dev, "Looked for SIS5595 but found unsupported device %.4x\n", *i);
162 /* Determine the address of the SMBus areas */
163 pci_read_config_word(SIS5595_dev, ACPI_BASE, &sis5595_base);
164 if (sis5595_base == 0 && force_addr == 0) {
165 dev_err(&SIS5595_dev->dev, "ACPI base address uninitialized - upgrade BIOS or use force_addr=0xaddr\n");
170 sis5595_base = force_addr & ~(SIS5595_EXTENT - 1);
171 dev_dbg(&SIS5595_dev->dev, "ACPI Base address: %04x\n", sis5595_base);
173 /* NB: We grab just the two SMBus registers here, but this may still
174 * interfere with ACPI :-( */
175 if (!request_region(sis5595_base + SMB_INDEX, 2, "sis5595-smbus")) {
176 dev_err(&SIS5595_dev->dev, "SMBus registers 0x%04x-0x%04x already in use!\n",
177 sis5595_base + SMB_INDEX, sis5595_base + SMB_INDEX + 1);
182 dev_info(&SIS5595_dev->dev, "forcing ISA address 0x%04X\n", sis5595_base);
183 if (!pci_write_config_word(SIS5595_dev, ACPI_BASE, sis5595_base))
185 if (!pci_read_config_word(SIS5595_dev, ACPI_BASE, &a))
187 if ((a & ~(SIS5595_EXTENT - 1)) != sis5595_base) {
188 /* doesn't work for some chips! */
189 dev_err(&SIS5595_dev->dev, "force address failed - not supported?\n");
194 if (!pci_read_config_byte(SIS5595_dev, SIS5595_ENABLE_REG, &val))
196 if ((val & 0x80) == 0) {
197 dev_info(&SIS5595_dev->dev, "enabling ACPI\n");
198 if (!pci_write_config_byte(SIS5595_dev, SIS5595_ENABLE_REG, val | 0x80))
200 if (!pci_read_config_byte(SIS5595_dev, SIS5595_ENABLE_REG, &val))
202 if ((val & 0x80) == 0) {
203 /* doesn't work for some chips? */
204 dev_err(&SIS5595_dev->dev, "ACPI enable failed - not supported?\n");
209 /* Everything is happy */
213 release_region(sis5595_base + SMB_INDEX, 2);
217 static int sis5595_transaction(struct i2c_adapter *adap)
223 /* Make sure the SMBus host is ready to start transmitting */
224 temp = sis5595_read(SMB_STS_LO) + (sis5595_read(SMB_STS_HI) << 8);
226 dev_dbg(&adap->dev, "SMBus busy (%04x). Resetting... \n", temp);
227 sis5595_write(SMB_STS_LO, temp & 0xff);
228 sis5595_write(SMB_STS_HI, temp >> 8);
229 if ((temp = sis5595_read(SMB_STS_LO) + (sis5595_read(SMB_STS_HI) << 8)) != 0x00) {
230 dev_dbg(&adap->dev, "Failed! (%02x)\n", temp);
233 dev_dbg(&adap->dev, "Successfull!\n");
237 /* start the transaction by setting bit 4 */
238 sis5595_write(SMB_CTL_LO, sis5595_read(SMB_CTL_LO) | 0x10);
240 /* We will always wait for a fraction of a second! */
243 temp = sis5595_read(SMB_STS_LO);
244 } while (!(temp & 0x40) && (timeout++ < MAX_TIMEOUT));
246 /* If the SMBus is still busy, we give up */
247 if (timeout >= MAX_TIMEOUT) {
248 dev_dbg(&adap->dev, "SMBus Timeout!\n");
253 dev_dbg(&adap->dev, "Error: Failed bus transaction\n");
258 dev_err(&adap->dev, "Bus collision! SMBus may be locked until "
259 "next hard reset (or not...)\n");
260 /* Clock stops and slave is stuck in mid-transmission */
264 temp = sis5595_read(SMB_STS_LO) + (sis5595_read(SMB_STS_HI) << 8);
266 sis5595_write(SMB_STS_LO, temp & 0xff);
267 sis5595_write(SMB_STS_HI, temp >> 8);
270 temp = sis5595_read(SMB_STS_LO) + (sis5595_read(SMB_STS_HI) << 8);
272 dev_dbg(&adap->dev, "Failed reset at end of transaction (%02x)\n", temp);
277 /* Return -1 on error. */
278 static s32 sis5595_access(struct i2c_adapter *adap, u16 addr,
279 unsigned short flags, char read_write,
280 u8 command, int size, union i2c_smbus_data *data)
283 case I2C_SMBUS_QUICK:
284 sis5595_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
285 size = SIS5595_QUICK;
288 sis5595_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
289 if (read_write == I2C_SMBUS_WRITE)
290 sis5595_write(SMB_CMD, command);
293 case I2C_SMBUS_BYTE_DATA:
294 sis5595_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
295 sis5595_write(SMB_CMD, command);
296 if (read_write == I2C_SMBUS_WRITE)
297 sis5595_write(SMB_BYTE, data->byte);
298 size = SIS5595_BYTE_DATA;
300 case I2C_SMBUS_PROC_CALL:
301 case I2C_SMBUS_WORD_DATA:
302 sis5595_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
303 sis5595_write(SMB_CMD, command);
304 if (read_write == I2C_SMBUS_WRITE) {
305 sis5595_write(SMB_BYTE, data->word & 0xff);
306 sis5595_write(SMB_BYTE + 1,
307 (data->word & 0xff00) >> 8);
309 size = (size == I2C_SMBUS_PROC_CALL) ? SIS5595_PROC_CALL : SIS5595_WORD_DATA;
312 case I2C_SMBUS_BLOCK_DATA:
313 printk(KERN_WARNING "sis5595.o: Block data not yet implemented!\n");
318 printk(KERN_WARNING "sis5595.o: Unsupported transaction %d\n", size);
322 sis5595_write(SMB_CTL_LO, ((size & 0x0E)));
324 if (sis5595_transaction(adap))
327 if ((size != SIS5595_PROC_CALL) &&
328 ((read_write == I2C_SMBUS_WRITE) || (size == SIS5595_QUICK)))
333 case SIS5595_BYTE: /* Where is the result put? I assume here it is in
334 SMB_DATA but it might just as well be in the
335 SMB_CMD. No clue in the docs */
336 case SIS5595_BYTE_DATA:
337 data->byte = sis5595_read(SMB_BYTE);
339 case SIS5595_WORD_DATA:
340 case SIS5595_PROC_CALL:
341 data->word = sis5595_read(SMB_BYTE) + (sis5595_read(SMB_BYTE + 1) << 8);
347 static u32 sis5595_func(struct i2c_adapter *adapter)
349 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
350 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
351 I2C_FUNC_SMBUS_PROC_CALL;
354 static struct i2c_algorithm smbus_algorithm = {
355 .name = "Non-I2C SMBus adapter",
356 .id = I2C_ALGO_SMBUS,
357 .smbus_xfer = sis5595_access,
358 .functionality = sis5595_func,
361 static struct i2c_adapter sis5595_adapter = {
362 .owner = THIS_MODULE,
363 .class = I2C_ADAP_CLASS_SMBUS,
365 .algo = &smbus_algorithm,
368 static struct pci_device_id sis5595_ids[] __devinitdata = {
369 { PCI_DEVICE(PCI_VENDOR_ID_SI, PCI_DEVICE_ID_SI_503) },
373 static int __devinit sis5595_probe(struct pci_dev *dev, const struct pci_device_id *id)
375 if (sis5595_setup(dev)) {
376 dev_err(&dev->dev, "SIS5595 not detected, module not inserted.\n");
380 /* set up the driverfs linkage to our parent device */
381 sis5595_adapter.dev.parent = &dev->dev;
383 sprintf(sis5595_adapter.name, "SMBus SIS5595 adapter at %04x",
384 sis5595_base + SMB_INDEX);
385 return i2c_add_adapter(&sis5595_adapter);
388 static void __devexit sis5595_remove(struct pci_dev *dev)
390 i2c_del_adapter(&sis5595_adapter);
391 release_region(sis5595_base + SMB_INDEX, 2);
394 static struct pci_driver sis5595_driver = {
395 .name = "sis5595 smbus",
396 .id_table = sis5595_ids,
397 .probe = sis5595_probe,
398 .remove = __devexit_p(sis5595_remove),
401 static int __init i2c_sis5595_init(void)
403 return pci_module_init(&sis5595_driver);
406 static void __exit i2c_sis5595_exit(void)
408 pci_unregister_driver(&sis5595_driver);
411 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>");
412 MODULE_DESCRIPTION("SIS5595 SMBus driver");
413 MODULE_LICENSE("GPL");
415 module_init(i2c_sis5595_init);
416 module_exit(i2c_sis5595_exit);