2
0
mirror of https://github.com/lm-sensors/lm-sensors synced 2025-08-30 22:05:11 +00:00

new SiS645 SMBus driver

git-svn-id: http://lm-sensors.org/svn/lm-sensors/trunk@1516 7894878c-1315-0410-8ee3-d5d059ff63e0
This commit is contained in:
Mark M. Hoffman
2002-09-01 20:18:49 +00:00
parent c6dc4fdbb7
commit 9b60b4787b

545
kernel/busses/i2c-sis645.c Normal file
View File

@@ -0,0 +1,545 @@
/*
sis645.c - Part of lm_sensors, Linux kernel modules for hardware
monitoring
Copyright (c) 2002 Mark M. Hoffman <mhoffman@lightlink.com>
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.
*/
/*
This module must be considered BETA unless and until
the chipset manufacturer releases a datasheet.
The register definitions are based on the SiS630.
The method for *finding* the registers is based on trial and error.
*/
/*
Note: we assume there can only be one SiS645 with one SMBus interface
*/
#include <linux/version.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <asm/io.h>
#include <linux/kernel.h>
#include <linux/stddef.h>
#include <linux/sched.h>
#include <linux/ioport.h>
#include <linux/i2c.h>
#include "version.h"
#include <linux/init.h>
#ifdef MODULE_LICENSE
MODULE_LICENSE("GPL");
#endif
/* I2C identifier */
#ifndef I2C_HW_SMBUS_SIS645
#define I2C_HW_SMBUS_SIS645 0x09
#endif
/* PCI identifiers */
#ifndef PCI_DEVICE_ID_SI_645
#define PCI_DEVICE_ID_SI_645 0x0645
#endif
#define PCI_DEVICE_ID_SI_SMBUS 0x16
/* base address register in PCI config space */
#define BASE_IO_REG 0x04
/* SiS645 SMBus registers */
#define SMB_STS 0x00
#define SMB_EN 0x01
#define SMB_CNT 0x02
#define SMB_HOST_CNT 0x03
#define SMB_ADDR 0x04
#define SMB_CMD 0x05
#define SMB_PCOUNT 0x06
#define SMB_COUNT 0x07
#define SMB_BYTE 0x08
#define SMB_DEV_ADDR 0x10
#define SMB_DB0 0x11
#define SMB_DB1 0x12
#define SMB_SAA 0x13
/* register count for request_region */
#define SIS645_SMB_IOREGION 0x20
/* Other settings */
#define MAX_TIMEOUT 500
/* SiS645 SMBus constants */
#define SIS645_QUICK 0x00
#define SIS645_BYTE 0x01
#define SIS645_BYTE_DATA 0x02
#define SIS645_WORD_DATA 0x03
#define SIS645_PROC_CALL 0x04
#define SIS645_BLOCK_DATA 0x05
static int __init sis645_init(void);
static void sis645_cleanup(void);
static int sis645_enable_smbus(struct pci_dev *dev);
static int sis645_build_dev(struct pci_dev **smbus_dev,
struct pci_dev *bridge_dev);
static int sis645_setup(void);
static s32 sis645_access(struct i2c_adapter *adap, u16 addr,
unsigned short flags, char read_write,
u8 command, int size,
union i2c_smbus_data *data);
static void sis645_do_pause(unsigned int amount);
static int sis645_transaction(int size);
static void sis645_inc(struct i2c_adapter *adapter);
static void sis645_dec(struct i2c_adapter *adapter);
static u32 sis645_func(struct i2c_adapter *adapter);
static struct i2c_algorithm smbus_algorithm = {
/* name */ "Non-I2C SMBus adapter",
/* id */ I2C_ALGO_SMBUS,
/* master_xfer */ NULL,
/* smbus_access */ sis645_access,
/* slave_send */ NULL,
/* slave_rcv */ NULL,
/* algo_control */ NULL,
/* functionality */ sis645_func,
};
static struct i2c_adapter sis645_adapter = {
"unset",
I2C_ALGO_SMBUS | I2C_HW_SMBUS_SIS645,
&smbus_algorithm,
NULL,
sis645_inc,
sis645_dec,
NULL,
NULL,
};
static int sis645_initialized;
static unsigned short sis645_smbus_base = 0;
static u8 sis645_read(u8 reg)
{
return inb(sis645_smbus_base + reg) ;
}
static void sis645_write(u8 reg, u8 data)
{
outb(data, sis645_smbus_base + reg) ;
}
#ifdef CONFIG_HOTPLUG
/* Turns on SMBus device if it is not; return 0 iff successful
*/
static int sis645_enable_smbus(struct pci_dev *dev)
{
u8 val = 0;
pci_read_config_byte(dev, 0x77, &val);
#ifdef DEBUG
printk("i2c-sis645.o: Config byte was 0x%02x.\n", val);
#endif
pci_write_config_byte(dev, 0x77, val & ~0x10);
pci_read_config_byte(dev, 0x77, &val);
if (val & 0x10) {
#ifdef DEBUG
printk("i2c-sis645.o: Error: Config byte stuck!\n");
#endif
return -1;
}
return 0;
}
/* Builds the basic pci_dev for SiS645 SMBus
*/
static int sis645_build_dev(struct pci_dev **smbus_dev,
struct pci_dev *bridge_dev)
{
struct pci_dev temp_dev;
u16 vid = 0, did = 0;
int ret;
/* fill in the device structure for search */
memset(&temp_dev, 0, sizeof(temp_dev));
temp_dev.bus = bridge_dev->bus;
temp_dev.sysdata = bridge_dev->bus->sysdata;
temp_dev.hdr_type = PCI_HEADER_TYPE_NORMAL;
/* the SMBus device is function 1 on the same unit as the ISA bridge */
temp_dev.devfn = bridge_dev->devfn + 1;
/* query to make sure */
ret = pci_read_config_word(&temp_dev, PCI_VENDOR_ID, &vid);
if (ret || PCI_VENDOR_ID_SI != vid) {
printk("i2c-sis645.o: Couldn't find SMBus device!\n");
return ret;
}
temp_dev.vendor = vid;
ret = pci_read_config_word(&temp_dev, PCI_DEVICE_ID, &did);
if (ret || PCI_DEVICE_ID_SI_SMBUS != did) {
printk("i2c-sis645.o: Couldn't find SMBus device!\n");
return ret;
}
temp_dev.device = did;
/* ok, we've got it... request some memory and finish it off */
*smbus_dev = kmalloc(sizeof(**smbus_dev), GFP_ATOMIC);
if (NULL == *smbus_dev) {
printk("i2c-sis645.o: Error: Out of memory!\n");
return -ENOMEM;
}
**smbus_dev = temp_dev;
ret = pci_setup_device(*smbus_dev);
if (ret) {
printk("i2c-sis645.o: pci_setup_device failed (0x%08x)\n",ret);
}
return ret;
}
#endif /* CONFIG_HOTPLUG */
/* Detect whether a SiS645 can be found, and initialize it, where necessary.
*/
static int sis645_setup(void)
{
struct pci_dev *SIS645_ISA_dev;
struct pci_dev *SIS645_SMBUS_dev;
int ret;
u16 ww = 0;
if (pci_present() == 0) {
printk("i2c-sis645.o: Error: No PCI-bus found!\n");
return -ENODEV;
}
if (NULL == pci_find_device(PCI_VENDOR_ID_SI,
PCI_DEVICE_ID_SI_645, NULL)) {
printk("i2c-sis645.o: Error: Can't find SiS645 host bridge!\n");
return -ENODEV;
}
if (!(SIS645_ISA_dev = pci_find_device(PCI_VENDOR_ID_SI,
PCI_DEVICE_ID_SI_503, NULL))) {
printk("i2c-sis645.o: Error: Can't find SiS645 ISA bridge!\n");
return -ENODEV;
}
if (!(SIS645_SMBUS_dev = pci_find_device(PCI_VENDOR_ID_SI,
PCI_DEVICE_ID_SI_SMBUS, NULL))) {
printk("i2c-sis645.o: "
"Attempting to enable SiS645 SMBus device\n");
#ifndef CONFIG_HOTPLUG
printk("i2c-sis645.o: "
"Requires kernel >= 2.4 with CONFIG_HOTPLUG, sorry!\n");
#else /* CONFIG_HOTPLUG */
if (ret = sis645_enable_smbus(SIS645_ISA_dev)) {
return ret;
}
if (ret = sis645_build_dev(&SIS645_SMBUS_dev, SIS645_ISA_dev)) {
return ret;
}
if (ret = pci_enable_device(SIS645_SMBUS_dev)) {
printk("i2c-sis645.o: Can't pci_enable SMBus device!"
" (0x%08x)\n", ret);
return ret;
}
pci_insert_device(SIS645_SMBUS_dev, SIS645_SMBUS_dev->bus);
#endif /* CONFIG_HOTPLUG */
}
pci_read_config_word(SIS645_SMBUS_dev, PCI_CLASS_DEVICE, &ww);
if (PCI_CLASS_SERIAL_SMBUS != ww) {
printk("i2c-sis645.o: Error: Unsupported device class 0x%04x!\n", ww);
return -ENODEV;
}
/* get the IO base address */
sis645_smbus_base = SIS645_SMBUS_dev->resource[BASE_IO_REG].start;
if (!sis645_smbus_base) {
printk("i2c-sis645.o: SiS645 SMBus base address not initialized!\n");
return -EINVAL;
}
printk("i2c-sis645.o: SiS645 SMBus base address: 0x%04x\n", sis645_smbus_base);
/* Everything is happy, let's grab the memory and set things up. */
if (!request_region(sis645_smbus_base, SIS645_SMB_IOREGION, "sis645-smbus")) {
printk
("i2c-sis645.o: SMBus registers 0x%04x-0x%04x already in use!\n",
sis645_smbus_base, sis645_smbus_base + SIS645_SMB_IOREGION - 1);
return -EINVAL;
}
return(0);
}
/* Internally used pause function */
static void sis645_do_pause(unsigned int amount)
{
current->state = TASK_INTERRUPTIBLE;
schedule_timeout(amount);
}
/* Execute a SMBus transaction.
int size is from SIS645_QUICK to SIS645_BLOCK_DATA
*/
static int sis645_transaction(int size)
{
int temp;
int result = 0;
int timeout = 0;
/* Make sure the SMBus host is ready to start transmitting */
if (((temp = sis645_read(SMB_CNT)) & 0x03) != 0x00) {
#ifdef DEBUG
printk("i2c-sis645.o: SMBus busy (0x%02x). Resetting...\n",
temp);
#endif
/* kill the transaction */
sis645_write(SMB_HOST_CNT, 0x02);
/* check it again */
if (((temp = sis645_read(SMB_CNT)) & 0x03) != 0x00) {
#ifdef DEBUG
printk("i2c-sis645.o: Failed! (0x%02x)\n", temp);
#endif
return -1;
} else {
#ifdef DEBUG
printk("i2c-sis645.o: Successful!\n");
#endif
}
}
/* Turn off timeout interrupts, set fast host clock */
sis645_write(SMB_CNT, 0x20);
/* clear all (sticky) status flags */
temp = sis645_read(SMB_STS);
sis645_write(SMB_STS, temp & 0x1e);
/* start the transaction by setting bit 4 and size bits */
sis645_write(SMB_HOST_CNT, 0x10 | (size & 0x07));
/* We will always wait for a fraction of a second! */
do {
sis645_do_pause(1);
temp = sis645_read(SMB_STS);
} while (!(temp & 0x0e) && (timeout++ < MAX_TIMEOUT));
/* If the SMBus is still busy, we give up */
if (timeout >= MAX_TIMEOUT) {
printk("i2c-sis645.o: SMBus Timeout! (0x%02x)\n",temp);
result = -1;
}
/* device error - probably missing ACK */
if (temp & 0x02) {
#ifdef DEBUG
printk("i2c-sis645.o: Error: Failed bus transaction!\n");
#endif
result = -1;
}
/* bus collision */
if (temp & 0x04) {
#ifdef DEBUG
printk("i2c-sis645.o: Error: Bus collision!\n");
#endif
result = -1;
}
/* Finish up by resetting the bus */
sis645_write(SMB_STS, temp);
if (temp = sis645_read(SMB_STS)) {
#ifdef DEBUG
printk("i2c-sis645.o: Failed reset at end of transaction!"
" (0x%02x)\n", temp);
#endif
}
return result;
}
/* Return -1 on error. */
s32 sis645_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:
sis645_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
size = SIS645_QUICK;
break;
case I2C_SMBUS_BYTE:
sis645_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
if (read_write == I2C_SMBUS_WRITE)
sis645_write(SMB_CMD, command);
size = SIS645_BYTE;
break;
case I2C_SMBUS_BYTE_DATA:
sis645_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
sis645_write(SMB_CMD, command);
if (read_write == I2C_SMBUS_WRITE)
sis645_write(SMB_BYTE, data->byte);
size = SIS645_BYTE_DATA;
break;
case I2C_SMBUS_PROC_CALL:
case I2C_SMBUS_WORD_DATA:
sis645_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
sis645_write(SMB_CMD, command);
if (read_write == I2C_SMBUS_WRITE) {
sis645_write(SMB_BYTE, data->word & 0xff);
sis645_write(SMB_BYTE + 1, (data->word & 0xff00) >> 8);
}
size = (size == I2C_SMBUS_PROC_CALL ? SIS645_PROC_CALL : SIS645_WORD_DATA);
break;
case I2C_SMBUS_BLOCK_DATA:
/* TO DO: */
printk("sis645.o: SMBus block not implemented!\n");
return -1;
break;
default:
printk("sis645.o: unsupported I2C size\n");
return -1;
break;
}
if (sis645_transaction(size))
return -1;
if ((size != SIS645_PROC_CALL) &&
((read_write == I2C_SMBUS_WRITE) || (size == SIS645_QUICK)))
return 0;
switch (size) {
case SIS645_BYTE:
case SIS645_BYTE_DATA:
data->byte = sis645_read(SMB_BYTE);
break;
case SIS645_WORD_DATA:
case SIS645_PROC_CALL:
data->word = sis645_read(SMB_BYTE) +
(sis645_read(SMB_BYTE + 1) << 8);
break;
}
return 0;
}
static void sis645_inc(struct i2c_adapter *adapter)
{
MOD_INC_USE_COUNT;
}
static void sis645_dec(struct i2c_adapter *adapter)
{
MOD_DEC_USE_COUNT;
}
static u32 sis645_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;
}
static int __init sis645_init(void)
{
int res;
printk("i2c-sis645.o: version %s (%s)\n", LM_VERSION, LM_DATE);
if (sis645_initialized) {
printk("i2c-sis645.o: Oops, sis645_init called a second time!\n");
return -EBUSY;
}
sis645_initialized = 0;
if ((res = sis645_setup())) {
printk ("i2c-sis645.o: SiS645 not detected, module not inserted.\n");
sis645_cleanup();
return res;
}
sis645_initialized++;
sprintf(sis645_adapter.name, "SMBus SiS645 adapter at 0x%04x", sis645_smbus_base);
if ((res = i2c_add_adapter(&sis645_adapter))) {
printk ("i2c-sis645.o: Adapter registration failed, module not inserted.\n");
sis645_cleanup();
return res;
}
sis645_initialized++;
printk("i2c-sis645.o: SiS645 bus detected and initialized.\n");
return 0;
}
static void sis645_cleanup(void)
{
int res;
if (sis645_initialized >= 2) {
if ((res = i2c_del_adapter(&sis645_adapter))) {
printk("i2c-sis645.o: i2c_del_adapter failed, module not removed\n");
return;
} else
sis645_initialized--;
}
if (sis645_initialized >= 1) {
release_region(sis645_smbus_base, SIS645_SMB_IOREGION);
sis645_initialized--;
}
return;
}
EXPORT_NO_SYMBOLS;
/* Register initialization functions using helper macros */
module_init(sis645_init);
module_exit(sis645_cleanup);
#ifdef MODULE
MODULE_AUTHOR("Mark M. Hoffman <mhoffman@lightlink.com>");
MODULE_DESCRIPTION("SiS645 SMBus driver");
#endif