[linux-2.6-block.git] / drivers / i2c / busses / i2c-viapro.c

/*
    i2c-viapro.c - Part of lm_sensors, Linux kernel modules for hardware
              monitoring
    Copyright (c) 1998 - 2002  Frodo Looijaard <frodol@dds.nl>,
    Philip Edelbrock <phil@netroedge.com>, Kyösti Mälkki <kmalkki@cc.hut.fi>,
    Mark D. Studebaker <mdsxyz123@yahoo.com>
    Copyright (C) 2005 - 2008  Jean Delvare <khali@linux-fr.org>

    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.
*/

/*
   Supports the following VIA south bridges:

   Chip name          PCI ID  REV     I2C block
   VT82C596A          0x3050             no
   VT82C596B          0x3051             no
   VT82C686A          0x3057  0x30       no
   VT82C686B          0x3057  0x40       yes
   VT8231             0x8235             no?
   VT8233             0x3074             yes
   VT8233A            0x3147             yes?
   VT8235             0x3177             yes
   VT8237R            0x3227             yes
   VT8237A            0x3337             yes
   VT8237S            0x3372             yes
   VT8251             0x3287             yes
   CX700              0x8324             yes

   Note: we assume there can only be one device, with one SMBus interface.
*/

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/pci.h>
#include <linux/kernel.h>
#include <linux/stddef.h>
#include <linux/ioport.h>
#include <linux/i2c.h>
#include <linux/init.h>
#include <asm/io.h>

static struct pci_dev *vt596_pdev;

#define SMBBA1		0x90
#define SMBBA2		0x80
#define SMBBA3		0xD0

/* SMBus address offsets */
static unsigned short vt596_smba;
#define SMBHSTSTS	(vt596_smba + 0)
#define SMBHSTCNT	(vt596_smba + 2)
#define SMBHSTCMD	(vt596_smba + 3)
#define SMBHSTADD	(vt596_smba + 4)
#define SMBHSTDAT0	(vt596_smba + 5)
#define SMBHSTDAT1	(vt596_smba + 6)
#define SMBBLKDAT	(vt596_smba + 7)

/* PCI Address Constants */

/* SMBus data in configuration space can be found in two places,
   We try to select the better one */

static unsigned short SMBHSTCFG = 0xD2;

/* Other settings */
#define MAX_TIMEOUT	500

/* VT82C596 constants */
#define VT596_QUICK		0x00
#define VT596_BYTE		0x04
#define VT596_BYTE_DATA		0x08
#define VT596_WORD_DATA		0x0C
#define VT596_BLOCK_DATA	0x14
#define VT596_I2C_BLOCK_DATA	0x34


/* If force is set to anything different from 0, we forcibly enable the
   VT596. DANGEROUS! */
static int force;
module_param(force, bool, 0);
MODULE_PARM_DESC(force, "Forcibly enable the SMBus. DANGEROUS!");

/* If force_addr is set to anything different from 0, we forcibly enable
   the VT596 at the given address. VERY DANGEROUS! */
static u16 force_addr;
module_param(force_addr, ushort, 0);
MODULE_PARM_DESC(force_addr,
		 "Forcibly enable the SMBus at the given address. "
		 "EXTREMELY DANGEROUS!");


static struct pci_driver vt596_driver;
static struct i2c_adapter vt596_adapter;

#define FEATURE_I2CBLOCK	(1<<0)
static unsigned int vt596_features;

#ifdef DEBUG
static void vt596_dump_regs(const char *msg, u8 size)
{
	dev_dbg(&vt596_adapter.dev, "%s: STS=%02x CNT=%02x CMD=%02x ADD=%02x "
		"DAT=%02x,%02x\n", msg, inb_p(SMBHSTSTS), inb_p(SMBHSTCNT),
		inb_p(SMBHSTCMD), inb_p(SMBHSTADD), inb_p(SMBHSTDAT0),
		inb_p(SMBHSTDAT1));

	if (size == VT596_BLOCK_DATA
	 || size == VT596_I2C_BLOCK_DATA) {
		int i;

		dev_dbg(&vt596_adapter.dev, "BLK=");
		for (i = 0; i < I2C_SMBUS_BLOCK_MAX / 2; i++)
			printk("%02x,", inb_p(SMBBLKDAT));
		printk("\n");
		dev_dbg(&vt596_adapter.dev, "    ");
		for (; i < I2C_SMBUS_BLOCK_MAX - 1; i++)
			printk("%02x,", inb_p(SMBBLKDAT));
		printk("%02x\n", inb_p(SMBBLKDAT));
	}
}
#else
static inline void vt596_dump_regs(const char *msg, u8 size) { }
#endif

/* Return -1 on error, 0 on success */
static int vt596_transaction(u8 size)
{
	int temp;
	int result = 0;
	int timeout = 0;

	vt596_dump_regs("Transaction (pre)", size);

	/* Make sure the SMBus host is ready to start transmitting */
	if ((temp = inb_p(SMBHSTSTS)) & 0x1F) {
		dev_dbg(&vt596_adapter.dev, "SMBus busy (0x%02x). "
			"Resetting...\n", temp);

		outb_p(temp, SMBHSTSTS);
		if ((temp = inb_p(SMBHSTSTS)) & 0x1F) {
			dev_err(&vt596_adapter.dev, "SMBus reset failed! "
				"(0x%02x)\n", temp);
			return -1;
		}
	}

	/* Start the transaction by setting bit 6 */
	outb_p(0x40 | size, SMBHSTCNT);

	/* We will always wait for a fraction of a second */
	do {
		msleep(1);
		temp = inb_p(SMBHSTSTS);
	} while ((temp & 0x01) && (timeout++ < MAX_TIMEOUT));

	/* If the SMBus is still busy, we give up */
	if (timeout >= MAX_TIMEOUT) {
		result = -1;
		dev_err(&vt596_adapter.dev, "SMBus timeout!\n");
	}

	if (temp & 0x10) {
		result = -1;
		dev_err(&vt596_adapter.dev, "Transaction failed (0x%02x)\n",
			size);
	}

	if (temp & 0x08) {
		result = -1;
		dev_err(&vt596_adapter.dev, "SMBus collision!\n");
	}

	if (temp & 0x04) {
		int read = inb_p(SMBHSTADD) & 0x01;
		result = -1;
		/* The quick and receive byte commands are used to probe
		   for chips, so errors are expected, and we don't want
		   to frighten the user. */
		if (!((size == VT596_QUICK && !read) ||
		      (size == VT596_BYTE && read)))
			dev_err(&vt596_adapter.dev, "Transaction error!\n");
	}

	/* Resetting status register */
	if (temp & 0x1F)
		outb_p(temp, SMBHSTSTS);

	vt596_dump_regs("Transaction (post)", size);

	return result;
}

/* Return -1 on error, 0 on success */
static s32 vt596_access(struct i2c_adapter *adap, u16 addr,
		unsigned short flags, char read_write, u8 command,
		int size, union i2c_smbus_data *data)
{
	int i;

	switch (size) {
	case I2C_SMBUS_QUICK:
		size = VT596_QUICK;
		break;
	case I2C_SMBUS_BYTE:
		if (read_write == I2C_SMBUS_WRITE)
			outb_p(command, SMBHSTCMD);
		size = VT596_BYTE;
		break;
	case I2C_SMBUS_BYTE_DATA:
		outb_p(command, SMBHSTCMD);
		if (read_write == I2C_SMBUS_WRITE)
			outb_p(data->byte, SMBHSTDAT0);
		size = VT596_BYTE_DATA;
		break;
	case I2C_SMBUS_WORD_DATA:
		outb_p(command, SMBHSTCMD);
		if (read_write == I2C_SMBUS_WRITE) {
			outb_p(data->word & 0xff, SMBHSTDAT0);
			outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1);
		}
		size = VT596_WORD_DATA;
		break;
	case I2C_SMBUS_I2C_BLOCK_DATA:
		if (!(vt596_features & FEATURE_I2CBLOCK))
			goto exit_unsupported;
		if (read_write == I2C_SMBUS_READ)
			outb_p(data->block[0], SMBHSTDAT0);
		/* Fall through */
	case I2C_SMBUS_BLOCK_DATA:
		outb_p(command, SMBHSTCMD);
		if (read_write == I2C_SMBUS_WRITE) {
			u8 len = data->block[0];
			if (len > I2C_SMBUS_BLOCK_MAX)
				len = I2C_SMBUS_BLOCK_MAX;
			outb_p(len, SMBHSTDAT0);
			inb_p(SMBHSTCNT);	/* Reset SMBBLKDAT */
			for (i = 1; i <= len; i++)
				outb_p(data->block[i], SMBBLKDAT);
		}
		size = (size == I2C_SMBUS_I2C_BLOCK_DATA) ?
		       VT596_I2C_BLOCK_DATA : VT596_BLOCK_DATA;
		break;
	default:
		goto exit_unsupported;
	}

	outb_p(((addr & 0x7f) << 1) | read_write, SMBHSTADD);

	if (vt596_transaction(size)) /* Error in transaction */
		return -1;

	if ((read_write == I2C_SMBUS_WRITE) || (size == VT596_QUICK))
		return 0;

	switch (size) {
	case VT596_BYTE:
	case VT596_BYTE_DATA:
		data->byte = inb_p(SMBHSTDAT0);
		break;
	case VT596_WORD_DATA:
		data->word = inb_p(SMBHSTDAT0) + (inb_p(SMBHSTDAT1) << 8);
		break;
	case VT596_I2C_BLOCK_DATA:
	case VT596_BLOCK_DATA:
		data->block[0] = inb_p(SMBHSTDAT0);
		if (data->block[0] > I2C_SMBUS_BLOCK_MAX)
			data->block[0] = I2C_SMBUS_BLOCK_MAX;
		inb_p(SMBHSTCNT);	/* Reset SMBBLKDAT */
		for (i = 1; i <= data->block[0]; i++)
			data->block[i] = inb_p(SMBBLKDAT);
		break;
	}
	return 0;

exit_unsupported:
	dev_warn(&vt596_adapter.dev, "Unsupported command invoked! (0x%02x)\n",
		 size);
	return -1;
}

static u32 vt596_func(struct i2c_adapter *adapter)
{
	u32 func = I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
	    I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
	    I2C_FUNC_SMBUS_BLOCK_DATA;

	if (vt596_features & FEATURE_I2CBLOCK)
		func |= I2C_FUNC_SMBUS_I2C_BLOCK;
	return func;
}

static const struct i2c_algorithm smbus_algorithm = {
	.smbus_xfer	= vt596_access,
	.functionality	= vt596_func,
};

static struct i2c_adapter vt596_adapter = {
	.owner		= THIS_MODULE,
	.id		= I2C_HW_SMBUS_VIA2,
	.class		= I2C_CLASS_HWMON,
	.algo		= &smbus_algorithm,
};

static int __devinit vt596_probe(struct pci_dev *pdev,
				 const struct pci_device_id *id)
{
	unsigned char temp;
	int error = -ENODEV;

	/* driver_data might come from user-space, so check it */
	if (id->driver_data & 1 || id->driver_data > 0xff)
		return -EINVAL;

	/* Determine the address of the SMBus areas */
	if (force_addr) {
		vt596_smba = force_addr & 0xfff0;
		force = 0;
		goto found;
	}

	if ((pci_read_config_word(pdev, id->driver_data, &vt596_smba)) ||
	    !(vt596_smba & 0x0001)) {
		/* try 2nd address and config reg. for 596 */
		if (id->device == PCI_DEVICE_ID_VIA_82C596_3 &&
		    !pci_read_config_word(pdev, SMBBA2, &vt596_smba) &&
		    (vt596_smba & 0x0001)) {
			SMBHSTCFG = 0x84;
		} else {
			/* no matches at all */
			dev_err(&pdev->dev, "Cannot configure "
				"SMBus I/O Base address\n");
			return -ENODEV;
		}
	}

	vt596_smba &= 0xfff0;
	if (vt596_smba == 0) {
		dev_err(&pdev->dev, "SMBus base address "
			"uninitialized - upgrade BIOS or use "
			"force_addr=0xaddr\n");
		return -ENODEV;
	}

found:
	if (!request_region(vt596_smba, 8, vt596_driver.name)) {
		dev_err(&pdev->dev, "SMBus region 0x%x already in use!\n",
			vt596_smba);
		return -ENODEV;
	}

	pci_read_config_byte(pdev, SMBHSTCFG, &temp);
	/* If force_addr is set, we program the new address here. Just to make
	   sure, we disable the VT596 first. */
	if (force_addr) {
		pci_write_config_byte(pdev, SMBHSTCFG, temp & 0xfe);
		pci_write_config_word(pdev, id->driver_data, vt596_smba);
		pci_write_config_byte(pdev, SMBHSTCFG, temp | 0x01);
		dev_warn(&pdev->dev, "WARNING: SMBus interface set to new "
			 "address 0x%04x!\n", vt596_smba);
	} else if (!(temp & 0x01)) {
		if (force) {
			/* NOTE: This assumes I/O space and other allocations
			 * WERE done by the Bios!  Don't complain if your
			 * hardware does weird things after enabling this.
			 * :') Check for Bios updates before resorting to
			 * this.
			 */
			pci_write_config_byte(pdev, SMBHSTCFG, temp | 0x01);
			dev_info(&pdev->dev, "Enabling SMBus device\n");
		} else {
			dev_err(&pdev->dev, "SMBUS: Error: Host SMBus "
				"controller not enabled! - upgrade BIOS or "
				"use force=1\n");
			goto release_region;
		}
	}

	dev_dbg(&pdev->dev, "VT596_smba = 0x%X\n", vt596_smba);

	switch (pdev->device) {
	case PCI_DEVICE_ID_VIA_CX700:
	case PCI_DEVICE_ID_VIA_8251:
	case PCI_DEVICE_ID_VIA_8237:
	case PCI_DEVICE_ID_VIA_8237A:
	case PCI_DEVICE_ID_VIA_8237S:
	case PCI_DEVICE_ID_VIA_8235:
	case PCI_DEVICE_ID_VIA_8233A:
	case PCI_DEVICE_ID_VIA_8233_0:
		vt596_features |= FEATURE_I2CBLOCK;
		break;
	case PCI_DEVICE_ID_VIA_82C686_4:
		/* The VT82C686B (rev 0x40) does support I2C block
		   transactions, but the VT82C686A (rev 0x30) doesn't */
		if (pdev->revision >= 0x40)
			vt596_features |= FEATURE_I2CBLOCK;
		break;
	}

	vt596_adapter.dev.parent = &pdev->dev;
	snprintf(vt596_adapter.name, sizeof(vt596_adapter.name),
		 "SMBus Via Pro adapter at %04x", vt596_smba);

	vt596_pdev = pci_dev_get(pdev);
	if (i2c_add_adapter(&vt596_adapter)) {
		pci_dev_put(vt596_pdev);
		vt596_pdev = NULL;
	}

	/* Always return failure here.  This is to allow other drivers to bind
	 * to this pci device.  We don't really want to have control over the
	 * pci device, we only wanted to read as few register values from it.
	 */
	return -ENODEV;

release_region:
	release_region(vt596_smba, 8);
	return error;
}

static struct pci_device_id vt596_ids[] = {
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C596_3),
	  .driver_data = SMBBA1 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C596B_3),
	  .driver_data = SMBBA1 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C686_4),
	  .driver_data = SMBBA1 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8233_0),
	  .driver_data = SMBBA3 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8233A),
	  .driver_data = SMBBA3 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8235),
	  .driver_data = SMBBA3 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8237),
	  .driver_data = SMBBA3 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8237A),
	  .driver_data = SMBBA3 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8237S),
	  .driver_data = SMBBA3 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8231_4),
	  .driver_data = SMBBA1 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8251),
	  .driver_data = SMBBA3 },
	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_CX700),
	  .driver_data = SMBBA3 },
	{ 0, }
};

MODULE_DEVICE_TABLE(pci, vt596_ids);

static struct pci_driver vt596_driver = {
	.name		= "vt596_smbus",
	.id_table	= vt596_ids,
	.probe		= vt596_probe,
	.dynids.use_driver_data = 1,
};

static int __init i2c_vt596_init(void)
{
	return pci_register_driver(&vt596_driver);
}


static void __exit i2c_vt596_exit(void)
{
	pci_unregister_driver(&vt596_driver);
	if (vt596_pdev != NULL) {
		i2c_del_adapter(&vt596_adapter);
		release_region(vt596_smba, 8);
		pci_dev_put(vt596_pdev);
		vt596_pdev = NULL;
	}
}

MODULE_AUTHOR("Kyosti Malkki <kmalkki@cc.hut.fi>, "
	      "Mark D. Studebaker <mdsxyz123@yahoo.com> and "
	      "Jean Delvare <khali@linux-fr.org>");
MODULE_DESCRIPTION("vt82c596 SMBus driver");
MODULE_LICENSE("GPL");

module_init(i2c_vt596_init);
module_exit(i2c_vt596_exit);
Commit	Line	Data
1da177e4 LT	1	/*
	2	i2c-viapro.c - Part of lm_sensors, Linux kernel modules for hardware
	3	monitoring
5f49ef8e	4	Copyright (c) 1998 - 2002 Frodo Looijaard <frodol@dds.nl>,
96de0e25	5	Philip Edelbrock <phil@netroedge.com>, Kyösti Mälkki <kmalkki@cc.hut.fi>,
1da177e4	6	Mark D. Studebaker <mdsxyz123@yahoo.com>
0d227a7e	7	Copyright (C) 2005 - 2008 Jean Delvare <khali@linux-fr.org>
1da177e4 LT	8
	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	/*
aaf7f147 JD	25	Supports the following VIA south bridges:
	26
	27	Chip name PCI ID REV I2C block
	28	VT82C596A 0x3050 no
	29	VT82C596B 0x3051 no
	30	VT82C686A 0x3057 0x30 no
	31	VT82C686B 0x3057 0x40 yes
	32	VT8231 0x8235 no?
	33	VT8233 0x3074 yes
	34	VT8233A 0x3147 yes?
	35	VT8235 0x3177 yes
	36	VT8237R 0x3227 yes
c243353a	37	VT8237A 0x3337 yes
0d227a7e	38	VT8237S 0x3372 yes
c243353a	39	VT8251 0x3287 yes
ab6a6ed2	40	CX700 0x8324 yes
aaf7f147	41
1da177e4 LT	42	Note: we assume there can only be one device, with one SMBus interface.
	43	*/
	44
1da177e4 LT	45	#include <linux/module.h>
	46	#include <linux/delay.h>
	47	#include <linux/pci.h>
	48	#include <linux/kernel.h>
	49	#include <linux/stddef.h>
1da177e4 LT	50	#include <linux/ioport.h>
	51	#include <linux/i2c.h>
	52	#include <linux/init.h>
	53	#include <asm/io.h>
	54
	55	static struct pci_dev *vt596_pdev;
	56
5f49ef8e JD	57	#define SMBBA1 0x90
	58	#define SMBBA2 0x80
	59	#define SMBBA3 0xD0
1da177e4 LT	60
	61	/* SMBus address offsets */
	62	static unsigned short vt596_smba;
	63	#define SMBHSTSTS (vt596_smba + 0)
1da177e4 LT	64	#define SMBHSTCNT (vt596_smba + 2)
	65	#define SMBHSTCMD (vt596_smba + 3)
	66	#define SMBHSTADD (vt596_smba + 4)
	67	#define SMBHSTDAT0 (vt596_smba + 5)
	68	#define SMBHSTDAT1 (vt596_smba + 6)
	69	#define SMBBLKDAT (vt596_smba + 7)
1da177e4 LT	70
	71	/* PCI Address Constants */
	72
	73	/* SMBus data in configuration space can be found in two places,
5f49ef8e	74	We try to select the better one */
1da177e4	75
c2f559d5	76	static unsigned short SMBHSTCFG = 0xD2;
1da177e4 LT	77
	78	/* Other settings */
	79	#define MAX_TIMEOUT 500
1da177e4 LT	80
1da177e4 LT	81	/* VT82C596 constants */
5f49ef8e JD	82	#define VT596_QUICK 0x00
	83	#define VT596_BYTE 0x04
	84	#define VT596_BYTE_DATA 0x08
	85	#define VT596_WORD_DATA 0x0C
	86	#define VT596_BLOCK_DATA 0x14
f1183014	87	#define VT596_I2C_BLOCK_DATA 0x34
1da177e4 LT	88
	89
	90	/* If force is set to anything different from 0, we forcibly enable the
	91	VT596. DANGEROUS! */
	92	static int force;
	93	module_param(force, bool, 0);
	94	MODULE_PARM_DESC(force, "Forcibly enable the SMBus. DANGEROUS!");
	95
	96	/* If force_addr is set to anything different from 0, we forcibly enable
	97	the VT596 at the given address. VERY DANGEROUS! */
	98	static u16 force_addr;
	99	module_param(force_addr, ushort, 0);
	100	MODULE_PARM_DESC(force_addr,
	101	"Forcibly enable the SMBus at the given address. "
	102	"EXTREMELY DANGEROUS!");
	103
	104
c2f559d5	105	static struct pci_driver vt596_driver;
1da177e4 LT	106	static struct i2c_adapter vt596_adapter;
1da177e4 LT	107
f1183014 JD	108	#define FEATURE_I2CBLOCK (1<<0)
	109	static unsigned int vt596_features;
	110
ed5453e5 JD	111	#ifdef DEBUG
	112	static void vt596_dump_regs(const char *msg, u8 size)
	113	{
	114	dev_dbg(&vt596_adapter.dev, "%s: STS=%02x CNT=%02x CMD=%02x ADD=%02x "
	115	"DAT=%02x,%02x\n", msg, inb_p(SMBHSTSTS), inb_p(SMBHSTCNT),
	116	inb_p(SMBHSTCMD), inb_p(SMBHSTADD), inb_p(SMBHSTDAT0),
	117	inb_p(SMBHSTDAT1));
	118
	119	if (size == VT596_BLOCK_DATA
	120	\|\| size == VT596_I2C_BLOCK_DATA) {
	121	int i;
	122
	123	dev_dbg(&vt596_adapter.dev, "BLK=");
	124	for (i = 0; i < I2C_SMBUS_BLOCK_MAX / 2; i++)
	125	printk("%02x,", inb_p(SMBBLKDAT));
	126	printk("\n");
	127	dev_dbg(&vt596_adapter.dev, " ");
	128	for (; i < I2C_SMBUS_BLOCK_MAX - 1; i++)
	129	printk("%02x,", inb_p(SMBBLKDAT));
	130	printk("%02x\n", inb_p(SMBBLKDAT));
	131	}
	132	}
ca68f119 GK	133	#else
ca68f119 GK	134	static inline void vt596_dump_regs(const char *msg, u8 size) { }
ed5453e5 JD	135	#endif
ed5453e5 JD	136
c2f559d5	137	/* Return -1 on error, 0 on success */
50c1cc33	138	static int vt596_transaction(u8 size)
1da177e4 LT	139	{
	140	int temp;
	141	int result = 0;
	142	int timeout = 0;
	143
ed5453e5	144	vt596_dump_regs("Transaction (pre)", size);
1da177e4 LT	145
	146	/* Make sure the SMBus host is ready to start transmitting */
	147	if ((temp = inb_p(SMBHSTSTS)) & 0x1F) {
	148	dev_dbg(&vt596_adapter.dev, "SMBus busy (0x%02x). "
8750197f	149	"Resetting...\n", temp);
5f49ef8e	150
1da177e4 LT	151	outb_p(temp, SMBHSTSTS);
1da177e4 LT	152	if ((temp = inb_p(SMBHSTSTS)) & 0x1F) {
8750197f JD	153	dev_err(&vt596_adapter.dev, "SMBus reset failed! "
8750197f JD	154	"(0x%02x)\n", temp);
1da177e4	155	return -1;
1da177e4 LT	156	}
	157	}
	158
c2f559d5	159	/* Start the transaction by setting bit 6 */
8750197f	160	outb_p(0x40 \| size, SMBHSTCNT);
1da177e4	161
c2f559d5	162	/* We will always wait for a fraction of a second */
1da177e4 LT	163	do {
	164	msleep(1);
	165	temp = inb_p(SMBHSTSTS);
	166	} while ((temp & 0x01) && (timeout++ < MAX_TIMEOUT));
	167
	168	/* If the SMBus is still busy, we give up */
	169	if (timeout >= MAX_TIMEOUT) {
	170	result = -1;
c2f559d5	171	dev_err(&vt596_adapter.dev, "SMBus timeout!\n");
1da177e4 LT	172	}
	173
	174	if (temp & 0x10) {
	175	result = -1;
c2f559d5	176	dev_err(&vt596_adapter.dev, "Transaction failed (0x%02x)\n",
8750197f	177	size);
1da177e4 LT	178	}
	179
	180	if (temp & 0x08) {
	181	result = -1;
c2f559d5	182	dev_err(&vt596_adapter.dev, "SMBus collision!\n");
1da177e4 LT	183	}
	184
	185	if (temp & 0x04) {
8750197f	186	int read = inb_p(SMBHSTADD) & 0x01;
1da177e4	187	result = -1;
8750197f JD	188	/* The quick and receive byte commands are used to probe
	189	for chips, so errors are expected, and we don't want
	190	to frighten the user. */
	191	if (!((size == VT596_QUICK && !read) \|\|
	192	(size == VT596_BYTE && read)))
c2f559d5	193	dev_err(&vt596_adapter.dev, "Transaction error!\n");
1da177e4 LT	194	}
1da177e4 LT	195
c2f559d5 JD	196	/* Resetting status register */
c2f559d5 JD	197	if (temp & 0x1F)
1da177e4	198	outb_p(temp, SMBHSTSTS);
1da177e4	199
ed5453e5	200	vt596_dump_regs("Transaction (post)", size);
5f49ef8e	201
1da177e4 LT	202	return result;
	203	}
	204
c2f559d5	205	/* Return -1 on error, 0 on success */
1da177e4	206	static s32 vt596_access(struct i2c_adapter *adap, u16 addr,
5f49ef8e JD	207	unsigned short flags, char read_write, u8 command,
5f49ef8e JD	208	int size, union i2c_smbus_data *data)
1da177e4	209	{
c2f559d5	210	int i;
1da177e4 LT	211
1da177e4 LT	212	switch (size) {
1da177e4	213	case I2C_SMBUS_QUICK:
1da177e4 LT	214	size = VT596_QUICK;
	215	break;
	216	case I2C_SMBUS_BYTE:
1da177e4 LT	217	if (read_write == I2C_SMBUS_WRITE)
	218	outb_p(command, SMBHSTCMD);
	219	size = VT596_BYTE;
	220	break;
	221	case I2C_SMBUS_BYTE_DATA:
1da177e4 LT	222	outb_p(command, SMBHSTCMD);
	223	if (read_write == I2C_SMBUS_WRITE)
	224	outb_p(data->byte, SMBHSTDAT0);
	225	size = VT596_BYTE_DATA;
	226	break;
	227	case I2C_SMBUS_WORD_DATA:
1da177e4 LT	228	outb_p(command, SMBHSTCMD);
	229	if (read_write == I2C_SMBUS_WRITE) {
	230	outb_p(data->word & 0xff, SMBHSTDAT0);
	231	outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1);
	232	}
	233	size = VT596_WORD_DATA;
	234	break;
f1183014 JD	235	case I2C_SMBUS_I2C_BLOCK_DATA:
f1183014 JD	236	if (!(vt596_features & FEATURE_I2CBLOCK))
c2f559d5	237	goto exit_unsupported;
f1183014	238	if (read_write == I2C_SMBUS_READ)
4b2643d7	239	outb_p(data->block[0], SMBHSTDAT0);
f1183014	240	/* Fall through */
1da177e4	241	case I2C_SMBUS_BLOCK_DATA:
1da177e4 LT	242	outb_p(command, SMBHSTCMD);
1da177e4 LT	243	if (read_write == I2C_SMBUS_WRITE) {
c2f559d5	244	u8 len = data->block[0];
1da177e4 LT	245	if (len > I2C_SMBUS_BLOCK_MAX)
	246	len = I2C_SMBUS_BLOCK_MAX;
	247	outb_p(len, SMBHSTDAT0);
c2f559d5	248	inb_p(SMBHSTCNT); /* Reset SMBBLKDAT */
1da177e4 LT	249	for (i = 1; i <= len; i++)
	250	outb_p(data->block[i], SMBBLKDAT);
	251	}
f1183014 JD	252	size = (size == I2C_SMBUS_I2C_BLOCK_DATA) ?
f1183014 JD	253	VT596_I2C_BLOCK_DATA : VT596_BLOCK_DATA;
1da177e4	254	break;
c2f559d5 JD	255	default:
c2f559d5 JD	256	goto exit_unsupported;
1da177e4 LT	257	}
1da177e4 LT	258
c2f559d5	259	outb_p(((addr & 0x7f) << 1) \| read_write, SMBHSTADD);
1da177e4	260
50c1cc33	261	if (vt596_transaction(size)) /* Error in transaction */
1da177e4 LT	262	return -1;
	263
	264	if ((read_write == I2C_SMBUS_WRITE) \|\| (size == VT596_QUICK))
	265	return 0;
	266
	267	switch (size) {
	268	case VT596_BYTE:
1da177e4 LT	269	case VT596_BYTE_DATA:
	270	data->byte = inb_p(SMBHSTDAT0);
	271	break;
	272	case VT596_WORD_DATA:
	273	data->word = inb_p(SMBHSTDAT0) + (inb_p(SMBHSTDAT1) << 8);
	274	break;
f1183014	275	case VT596_I2C_BLOCK_DATA:
1da177e4 LT	276	case VT596_BLOCK_DATA:
	277	data->block[0] = inb_p(SMBHSTDAT0);
	278	if (data->block[0] > I2C_SMBUS_BLOCK_MAX)
	279	data->block[0] = I2C_SMBUS_BLOCK_MAX;
c2f559d5	280	inb_p(SMBHSTCNT); /* Reset SMBBLKDAT */
1da177e4 LT	281	for (i = 1; i <= data->block[0]; i++)
	282	data->block[i] = inb_p(SMBBLKDAT);
	283	break;
	284	}
	285	return 0;
c2f559d5 JD	286
	287	exit_unsupported:
	288	dev_warn(&vt596_adapter.dev, "Unsupported command invoked! (0x%02x)\n",
	289	size);
	290	return -1;
1da177e4 LT	291	}
	292
	293	static u32 vt596_func(struct i2c_adapter *adapter)
	294	{
f1183014	295	u32 func = I2C_FUNC_SMBUS_QUICK \| I2C_FUNC_SMBUS_BYTE \|
1da177e4 LT	296	I2C_FUNC_SMBUS_BYTE_DATA \| I2C_FUNC_SMBUS_WORD_DATA \|
1da177e4 LT	297	I2C_FUNC_SMBUS_BLOCK_DATA;
f1183014 JD	298
	299	if (vt596_features & FEATURE_I2CBLOCK)
	300	func \|= I2C_FUNC_SMBUS_I2C_BLOCK;
	301	return func;
1da177e4 LT	302	}
1da177e4 LT	303
8f9082c5	304	static const struct i2c_algorithm smbus_algorithm = {
1da177e4 LT	305	.smbus_xfer = vt596_access,
	306	.functionality = vt596_func,
	307	};
	308
	309	static struct i2c_adapter vt596_adapter = {
	310	.owner = THIS_MODULE,
9ace555d	311	.id = I2C_HW_SMBUS_VIA2,
1da177e4 LT	312	.class = I2C_CLASS_HWMON,
1da177e4 LT	313	.algo = &smbus_algorithm,
1da177e4 LT	314	};
	315
	316	static int __devinit vt596_probe(struct pci_dev *pdev,
	317	const struct pci_device_id *id)
	318	{
	319	unsigned char temp;
	320	int error = -ENODEV;
5f49ef8e	321
0f07a24b JD	322	/* driver_data might come from user-space, so check it */
	323	if (id->driver_data & 1 \|\| id->driver_data > 0xff)
	324	return -EINVAL;
	325
1da177e4 LT	326	/* Determine the address of the SMBus areas */
	327	if (force_addr) {
	328	vt596_smba = force_addr & 0xfff0;
	329	force = 0;
	330	goto found;
	331	}
	332
	333	if ((pci_read_config_word(pdev, id->driver_data, &vt596_smba)) \|\|
c2f559d5	334	!(vt596_smba & 0x0001)) {
1da177e4 LT	335	/* try 2nd address and config reg. for 596 */
	336	if (id->device == PCI_DEVICE_ID_VIA_82C596_3 &&
	337	!pci_read_config_word(pdev, SMBBA2, &vt596_smba) &&
c2f559d5 JD	338	(vt596_smba & 0x0001)) {
c2f559d5 JD	339	SMBHSTCFG = 0x84;
1da177e4 LT	340	} else {
	341	/* no matches at all */
	342	dev_err(&pdev->dev, "Cannot configure "
	343	"SMBus I/O Base address\n");
	344	return -ENODEV;
	345	}
	346	}
	347
	348	vt596_smba &= 0xfff0;
	349	if (vt596_smba == 0) {
	350	dev_err(&pdev->dev, "SMBus base address "
	351	"uninitialized - upgrade BIOS or use "
	352	"force_addr=0xaddr\n");
	353	return -ENODEV;
	354	}
	355
5f49ef8e	356	found:
c2f559d5	357	if (!request_region(vt596_smba, 8, vt596_driver.name)) {
1da177e4	358	dev_err(&pdev->dev, "SMBus region 0x%x already in use!\n",
5f49ef8e	359	vt596_smba);
1da177e4 LT	360	return -ENODEV;
	361	}
	362
	363	pci_read_config_byte(pdev, SMBHSTCFG, &temp);
	364	/* If force_addr is set, we program the new address here. Just to make
	365	sure, we disable the VT596 first. */
	366	if (force_addr) {
	367	pci_write_config_byte(pdev, SMBHSTCFG, temp & 0xfe);
	368	pci_write_config_word(pdev, id->driver_data, vt596_smba);
	369	pci_write_config_byte(pdev, SMBHSTCFG, temp \| 0x01);
	370	dev_warn(&pdev->dev, "WARNING: SMBus interface set to new "
5f49ef8e	371	"address 0x%04x!\n", vt596_smba);
c2f559d5	372	} else if (!(temp & 0x01)) {
1da177e4	373	if (force) {
5f49ef8e JD	374	/* NOTE: This assumes I/O space and other allocations
	375	* WERE done by the Bios! Don't complain if your
	376	* hardware does weird things after enabling this.
	377	* :') Check for Bios updates before resorting to
1da177e4 LT	378	* this.
1da177e4 LT	379	*/
c2f559d5	380	pci_write_config_byte(pdev, SMBHSTCFG, temp \| 0x01);
1da177e4 LT	381	dev_info(&pdev->dev, "Enabling SMBus device\n");
	382	} else {
	383	dev_err(&pdev->dev, "SMBUS: Error: Host SMBus "
	384	"controller not enabled! - upgrade BIOS or "
	385	"use force=1\n");
	386	goto release_region;
	387	}
	388	}
	389
1da177e4 LT	390	dev_dbg(&pdev->dev, "VT596_smba = 0x%X\n", vt596_smba);
1da177e4 LT	391
f1183014	392	switch (pdev->device) {
ab6a6ed2	393	case PCI_DEVICE_ID_VIA_CX700:
c243353a	394	case PCI_DEVICE_ID_VIA_8251:
f1183014	395	case PCI_DEVICE_ID_VIA_8237:
c243353a	396	case PCI_DEVICE_ID_VIA_8237A:
0d227a7e	397	case PCI_DEVICE_ID_VIA_8237S:
f1183014 JD	398	case PCI_DEVICE_ID_VIA_8235:
	399	case PCI_DEVICE_ID_VIA_8233A:
	400	case PCI_DEVICE_ID_VIA_8233_0:
	401	vt596_features \|= FEATURE_I2CBLOCK;
	402	break;
	403	case PCI_DEVICE_ID_VIA_82C686_4:
	404	/* The VT82C686B (rev 0x40) does support I2C block
	405	transactions, but the VT82C686A (rev 0x30) doesn't */
44c10138	406	if (pdev->revision >= 0x40)
f1183014 JD	407	vt596_features \|= FEATURE_I2CBLOCK;
	408	break;
	409	}
	410
1da177e4	411	vt596_adapter.dev.parent = &pdev->dev;
2096b956	412	snprintf(vt596_adapter.name, sizeof(vt596_adapter.name),
5f49ef8e JD	413	"SMBus Via Pro adapter at %04x", vt596_smba);
5f49ef8e JD	414
1da177e4 LT	415	vt596_pdev = pci_dev_get(pdev);
	416	if (i2c_add_adapter(&vt596_adapter)) {
	417	pci_dev_put(vt596_pdev);
	418	vt596_pdev = NULL;
	419	}
	420
	421	/* Always return failure here. This is to allow other drivers to bind
	422	* to this pci device. We don't really want to have control over the
	423	* pci device, we only wanted to read as few register values from it.
	424	*/
	425	return -ENODEV;
	426
5f49ef8e	427	release_region:
1da177e4 LT	428	release_region(vt596_smba, 8);
	429	return error;
	430	}
	431
	432	static struct pci_device_id vt596_ids[] = {
	433	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C596_3),
	434	.driver_data = SMBBA1 },
	435	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C596B_3),
	436	.driver_data = SMBBA1 },
	437	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C686_4),
	438	.driver_data = SMBBA1 },
	439	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8233_0),
	440	.driver_data = SMBBA3 },
	441	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8233A),
	442	.driver_data = SMBBA3 },
	443	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8235),
	444	.driver_data = SMBBA3 },
	445	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8237),
	446	.driver_data = SMBBA3 },
c243353a RM	447	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8237A),
c243353a RM	448	.driver_data = SMBBA3 },
0d227a7e JD	449	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8237S),
0d227a7e JD	450	.driver_data = SMBBA3 },
1da177e4 LT	451	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8231_4),
1da177e4 LT	452	.driver_data = SMBBA1 },
c243353a RM	453	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8251),
c243353a RM	454	.driver_data = SMBBA3 },
ab6a6ed2 JD	455	{ PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_CX700),
ab6a6ed2 JD	456	.driver_data = SMBBA3 },
1da177e4 LT	457	{ 0, }
	458	};
	459
5f49ef8e	460	MODULE_DEVICE_TABLE(pci, vt596_ids);
1da177e4 LT	461
	462	static struct pci_driver vt596_driver = {
	463	.name = "vt596_smbus",
	464	.id_table = vt596_ids,
	465	.probe = vt596_probe,
0f07a24b	466	.dynids.use_driver_data = 1,
1da177e4 LT	467	};
	468
	469	static int __init i2c_vt596_init(void)
	470	{
	471	return pci_register_driver(&vt596_driver);
	472	}
	473
	474
	475	static void __exit i2c_vt596_exit(void)
	476	{
	477	pci_unregister_driver(&vt596_driver);
	478	if (vt596_pdev != NULL) {
	479	i2c_del_adapter(&vt596_adapter);
	480	release_region(vt596_smba, 8);
	481	pci_dev_put(vt596_pdev);
	482	vt596_pdev = NULL;
	483	}
	484	}
	485
8750197f JD	486	MODULE_AUTHOR("Kyosti Malkki <kmalkki@cc.hut.fi>, "
	487	"Mark D. Studebaker <mdsxyz123@yahoo.com> and "
	488	"Jean Delvare <khali@linux-fr.org>");
1da177e4 LT	489	MODULE_DESCRIPTION("vt82c596 SMBus driver");
	490	MODULE_LICENSE("GPL");
	491
	492	module_init(i2c_vt596_init);
	493	module_exit(i2c_vt596_exit);