/* sis5595.c - Part of lm_sensors, Linux kernel modules for hardware monitoring Copyright (c) 1998, 1999 Frodo Looijaard and Philip Edelbrock This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ /* Note: we assume there can only be one SIS5595 with one SMBus interface */ /* TO DO: * Add Block Transfers (ugly, but supported by the adapter) * Add adapter resets */ #include #include #include #include #include #include #include #include #include #include "version.h" #include /* SIS5595 SMBus registers */ #define SMB_STS_LO 0x00 #define SMB_STS_HI 0x01 #define SMB_CTL_LO 0x02 #define SMB_CTL_HI 0x03 #define SMB_ADDR 0x04 #define SMB_CMD 0x05 #define SMB_PCNT 0x06 #define SMB_CNT 0x07 #define SMB_BYTE 0x08 #define SMB_DEV 0x10 #define SMB_DB0 0x11 #define SMB_DB1 0x12 #define SMB_HAA 0x13 /* PCI Address Constants */ #define SMB_INDEX 0x38 #define SMB_DAT 0x39 #define ACPI_BASE 0x90 /* Other settings */ #define MAX_TIMEOUT 500 /* SIS5595 constants */ #define SIS5595_QUICK 0x00 #define SIS5595_BYTE 0x02 #define SIS5595_BYTE_DATA 0x04 #define SIS5595_WORD_DATA 0x06 #define SIS5595_PROC_CALL 0x08 #define SIS5595_BLOCK_DATA 0x0A /* insmod parameters */ #ifdef MODULE static #else extern #endif int __init i2c_sis5595_init(void); static int __init sis5595_cleanup(void); static int sis5595_setup(void); static s32 sis5595_access(struct i2c_adapter *adap, u16 addr, unsigned short flags, char read_write, u8 command, int size, union i2c_smbus_data *data); static void sis5595_do_pause(unsigned int amount); static int sis5595_transaction(void); static void sis5595_inc(struct i2c_adapter *adapter); static void sis5595_dec(struct i2c_adapter *adapter); static u32 sis5595_func(struct i2c_adapter *adapter); #ifdef MODULE extern int init_module(void); extern int cleanup_module(void); #endif /* MODULE */ static struct i2c_algorithm smbus_algorithm = { /* name */ "Non-I2C SMBus adapter", /* id */ I2C_ALGO_SMBUS, /* master_xfer */ NULL, /* smbus_access */ sis5595_access, /* slave_send */ NULL, /* slave_rcv */ NULL, /* algo_control */ NULL, /* functionality */ sis5595_func, }; static struct i2c_adapter sis5595_adapter = { "unset", I2C_ALGO_SMBUS | I2C_HW_SMBUS_SIS5595, &smbus_algorithm, NULL, sis5595_inc, sis5595_dec, NULL, NULL, }; static int __initdata sis5595_initialized; static unsigned short sis5595_base = 0; static u8 sis5595_read(u8 reg) { outb(reg, sis5595_base + SMB_INDEX); return inb(sis5595_base + SMB_DAT); } static void sis5595_write(u8 reg, u8 data) { outb(reg, sis5595_base + SMB_INDEX); outb(data, sis5595_base + SMB_DAT); } /* Detect whether a SIS5595 can be found, and initialize it, where necessary. Note the differences between kernels with the old PCI BIOS interface and newer kernels with the real PCI interface. In compat.h some things are defined to make the transition easier. */ int sis5595_setup(void) { int error_return = 0; struct pci_dev *SIS5595_dev; /* First check whether we can access PCI at all */ if (pci_present() == 0) { printk("i2c-sis5595.o: Error: No PCI-bus found!\n"); error_return = -ENODEV; goto END; } /* Look for the SIS5595 */ SIS5595_dev = NULL; if (!(SIS5595_dev = pci_find_device(PCI_VENDOR_ID_SI, PCI_DEVICE_ID_SI_503, SIS5595_dev))) { printk("i2c-sis5595.o: Error: Can't detect SIS5595!\n"); error_return = -ENODEV; goto END; } /* Determine the address of the SMBus areas */ pci_read_config_word(SIS5595_dev, ACPI_BASE, &sis5595_base); if(sis5595_base == 0) { printk("i2c-sis5595.o: ACPI base address uninitialized - upgrade BIOS?\n"); error_return = -ENODEV; goto END; } #ifdef DEBUG printk("ACPI Base address: %04x\n", sis5595_base); #endif /* NB: We grab just the two SMBus registers here, but this may still * interfere with ACPI :-( */ if (check_region(sis5595_base + SMB_INDEX, 2)) { printk ("i2c-sis5595.o: SMBus registers 0x%04x-0x%04x already in use!\n", sis5595_base + SMB_INDEX, sis5595_base + SMB_INDEX + 1); error_return = -ENODEV; goto END; } /* Everything is happy, let's grab the memory and set things up. */ request_region(sis5595_base + SMB_INDEX, 2, "sis5595-smbus"); END: return error_return; } /* Internally used pause function */ void sis5595_do_pause(unsigned int amount) { current->state = TASK_INTERRUPTIBLE; schedule_timeout(amount); } /* Another internally used function */ int sis5595_transaction(void) { int temp; int result = 0; int timeout = 0; /* Make sure the SMBus host is ready to start transmitting */ if ( (temp = sis5595_read(SMB_STS_LO) + (sis5595_read(SMB_STS_HI) << 8)) != 0x00) { #ifdef DEBUG printk("i2c-sis5595.o: SMBus busy (%04x). Resetting... \n", temp); #endif sis5595_write(SMB_STS_LO, temp & 0xff); sis5595_write(SMB_STS_HI, temp >> 8); if ( (temp = sis5595_read(SMB_STS_LO) + (sis5595_read(SMB_STS_HI) << 8)) != 0x00) { #ifdef DEBUG printk("i2c-sis5595.o: Failed! (%02x)\n", temp); #endif return -1; } else { #ifdef DEBUG printk("i2c-sis5595.o: Successfull!\n"); #endif } } /* start the transaction by setting bit 4 */ sis5595_write(SMB_CTL_LO, sis5595_read(SMB_CTL_LO) | 0x10); /* We will always wait for a fraction of a second! */ do { sis5595_do_pause(1); temp = sis5595_read(SMB_STS_LO); } while (!(temp & 0x40) && (timeout++ < MAX_TIMEOUT)); /* If the SMBus is still busy, we give up */ if (timeout >= MAX_TIMEOUT) { #ifdef DEBUG printk("i2c-sis5595.o: SMBus Timeout!\n"); #endif result = -1; } if (temp & 0x10) { result = -1; #ifdef DEBUG printk("i2c-sis5595.o: Error: Failed bus transaction\n"); #endif } if (temp & 0x20) { result = -1; printk ("i2c-sis5595.o: Bus collision! SMBus may be locked until next hard\n" "reset (or not...)\n"); /* Clock stops and slave is stuck in mid-transmission */ } if ( (temp = sis5595_read(SMB_STS_LO) + (sis5595_read(SMB_STS_HI) << 8)) != 0x00) { sis5595_write(SMB_STS_LO, temp & 0xff); sis5595_write(SMB_STS_HI, temp >> 8); } if ( (temp = sis5595_read(SMB_STS_LO) + (sis5595_read(SMB_STS_HI) << 8)) != 0x00) { #ifdef DEBUG printk ("i2c-sis5595.o: Failed reset at end of transaction (%02x)\n", temp); #endif } return result; } /* Return -1 on error. See smbus.h for more information */ s32 sis5595_access(struct i2c_adapter * adap, u16 addr, unsigned short flags, char read_write, u8 command, int size, union i2c_smbus_data * data) { switch (size) { case I2C_SMBUS_QUICK: sis5595_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01)); size = SIS5595_QUICK; break; case I2C_SMBUS_BYTE: sis5595_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01)); if (read_write == I2C_SMBUS_WRITE) sis5595_write(SMB_CMD, command); size = SIS5595_BYTE; break; case I2C_SMBUS_BYTE_DATA: sis5595_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01)); sis5595_write(SMB_CMD, command); if (read_write == I2C_SMBUS_WRITE) sis5595_write(SMB_BYTE, data->byte); size = SIS5595_BYTE_DATA; break; case I2C_SMBUS_PROC_CALL: case I2C_SMBUS_WORD_DATA: sis5595_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01)); sis5595_write(SMB_CMD, command); if (read_write == I2C_SMBUS_WRITE) { sis5595_write(SMB_BYTE, data->word & 0xff); sis5595_write(SMB_BYTE + 1, (data->word & 0xff00) >> 8); } size = (size == I2C_SMBUS_PROC_CALL) ? SIS5595_PROC_CALL : SIS5595_WORD_DATA; break; case I2C_SMBUS_BLOCK_DATA: printk("sis5595.o: Block data not yet implemented!\n"); return -1; break; } sis5595_write(SMB_CTL_LO, ((size & 0x0E))); if (sis5595_transaction()) /* Error in transaction */ return -1; if ((size != SIS5595_PROC_CALL) && ((read_write == I2C_SMBUS_WRITE) || (size == SIS5595_QUICK))) return 0; switch (size) { case SIS5595_BYTE: /* Where is the result put? I assume here it is in SMB_DATA but it might just as well be in the SMB_CMD. No clue in the docs */ case SIS5595_BYTE_DATA: data->byte = sis5595_read(SMB_BYTE); break; case SIS5595_WORD_DATA: case SIS5595_PROC_CALL: data->word = sis5595_read(SMB_BYTE) + (sis5595_read(SMB_BYTE + 1) << 8); break; } return 0; } void sis5595_inc(struct i2c_adapter *adapter) { MOD_INC_USE_COUNT; } void sis5595_dec(struct i2c_adapter *adapter) { MOD_DEC_USE_COUNT; } u32 sis5595_func(struct i2c_adapter *adapter) { return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE | I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA | I2C_FUNC_SMBUS_PROC_CALL; } int __init i2c_sis5595_init(void) { int res; printk("i2c-sis5595.o version %s (%s)\n", LM_VERSION, LM_DATE); #ifdef DEBUG /* PE- It might be good to make this a permanent part of the code! */ if (sis5595_initialized) { printk ("i2c-sis5595.o: Oops, sis5595_init called a second time!\n"); return -EBUSY; } #endif sis5595_initialized = 0; if ((res = sis5595_setup())) { printk ("i2c-sis5595.o: SIS5595 not detected, module not inserted.\n"); sis5595_cleanup(); return res; } sis5595_initialized++; sprintf(sis5595_adapter.name, "SMBus SIS5595 adapter at %04x", sis5595_base + SMB_INDEX); if ((res = i2c_add_adapter(&sis5595_adapter))) { printk ("i2c-sis5595.o: Adapter registration failed, module not inserted.\n"); sis5595_cleanup(); return res; } sis5595_initialized++; printk("i2c-sis5595.o: SIS5595 bus detected and initialized\n"); return 0; } int __init sis5595_cleanup(void) { int res; if (sis5595_initialized >= 2) { if ((res = i2c_del_adapter(&sis5595_adapter))) { printk ("i2c-sis5595.o: i2c_del_adapter failed, module not removed\n"); return res; } else sis5595_initialized--; } if (sis5595_initialized >= 1) { release_region(sis5595_base + SMB_INDEX, 2); sis5595_initialized--; } return 0; } EXPORT_NO_SYMBOLS; #ifdef MODULE MODULE_AUTHOR("Frodo Looijaard "); MODULE_DESCRIPTION("SIS5595 SMBus driver"); int init_module(void) { return i2c_sis5595_init(); } int cleanup_module(void) { return sis5595_cleanup(); } #endif /* MODULE */