ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / i2c / busses / i2c-sis96x.c
1 /*
2     sis96x.c - Part of lm_sensors, Linux kernel modules for hardware
3               monitoring
4
5     Copyright (c) 2003 Mark M. Hoffman <mhoffman@lightlink.com>
6
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.
11
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.
16
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.
20 */
21
22 /*
23     This module must be considered BETA unless and until
24     the chipset manufacturer releases a datasheet.
25     The register definitions are based on the SiS630.
26
27     This module relies on quirk_sis_96x_smbus (drivers/pci/quirks.c)
28     for just about every machine for which users have reported.
29     If this module isn't detecting your 96x south bridge, have a 
30     look there.
31
32     We assume there can only be one SiS96x with one SMBus interface.
33 */
34
35 #include <linux/config.h>
36 #include <linux/module.h>
37 #include <linux/pci.h>
38 #include <linux/kernel.h>
39 #include <linux/stddef.h>
40 #include <linux/sched.h>
41 #include <linux/ioport.h>
42 #include <linux/i2c.h>
43 #include <linux/init.h>
44 #include <asm/io.h>
45
46 /*
47         HISTORY:
48         2003-05-11      1.0.0   Updated from lm_sensors project for kernel 2.5
49                                 (was i2c-sis645.c from lm_sensors 2.7.0)
50 */
51 #define SIS96x_VERSION "1.0.0"
52
53 /* SiS96x SMBus PCI device ID */
54 #define PCI_DEVICE_ID_SI_SMBUS 0x16
55
56 /* base address register in PCI config space */
57 #define SIS96x_BAR 0x04
58
59 /* SiS96x SMBus registers */
60 #define SMB_STS      0x00
61 #define SMB_EN       0x01
62 #define SMB_CNT      0x02
63 #define SMB_HOST_CNT 0x03
64 #define SMB_ADDR     0x04
65 #define SMB_CMD      0x05
66 #define SMB_PCOUNT   0x06
67 #define SMB_COUNT    0x07
68 #define SMB_BYTE     0x08
69 #define SMB_DEV_ADDR 0x10
70 #define SMB_DB0      0x11
71 #define SMB_DB1      0x12
72 #define SMB_SAA      0x13
73
74 /* register count for request_region */
75 #define SMB_IOSIZE 0x20
76
77 /* Other settings */
78 #define MAX_TIMEOUT 500
79
80 /* SiS96x SMBus constants */
81 #define SIS96x_QUICK      0x00
82 #define SIS96x_BYTE       0x01
83 #define SIS96x_BYTE_DATA  0x02
84 #define SIS96x_WORD_DATA  0x03
85 #define SIS96x_PROC_CALL  0x04
86 #define SIS96x_BLOCK_DATA 0x05
87
88 static struct i2c_adapter sis96x_adapter;
89 static u16 sis96x_smbus_base = 0;
90
91 static inline u8 sis96x_read(u8 reg)
92 {
93         return inb(sis96x_smbus_base + reg) ;
94 }
95
96 static inline void sis96x_write(u8 reg, u8 data)
97 {
98         outb(data, sis96x_smbus_base + reg) ;
99 }
100
101 /* Execute a SMBus transaction.
102    int size is from SIS96x_QUICK to SIS96x_BLOCK_DATA
103  */
104 static int sis96x_transaction(int size)
105 {
106         int temp;
107         int result = 0;
108         int timeout = 0;
109
110         dev_dbg(&sis96x_adapter.dev, "SMBus transaction %d\n", size);
111
112         /* Make sure the SMBus host is ready to start transmitting */
113         if (((temp = sis96x_read(SMB_CNT)) & 0x03) != 0x00) {
114
115                 dev_dbg(&sis96x_adapter.dev, "SMBus busy (0x%02x). "
116                         "Resetting...\n", temp);
117
118                 /* kill the transaction */
119                 sis96x_write(SMB_HOST_CNT, 0x20);
120
121                 /* check it again */
122                 if (((temp = sis96x_read(SMB_CNT)) & 0x03) != 0x00) {
123                         dev_dbg(&sis96x_adapter.dev, "Failed (0x%02x)\n", temp);
124                         return -1;
125                 } else {
126                         dev_dbg(&sis96x_adapter.dev, "Successful\n");
127                 }
128         }
129
130         /* Turn off timeout interrupts, set fast host clock */
131         sis96x_write(SMB_CNT, 0x20);
132
133         /* clear all (sticky) status flags */
134         temp = sis96x_read(SMB_STS);
135         sis96x_write(SMB_STS, temp & 0x1e);
136
137         /* start the transaction by setting bit 4 and size bits */
138         sis96x_write(SMB_HOST_CNT, 0x10 | (size & 0x07));
139
140         /* We will always wait for a fraction of a second! */
141         do {
142                 i2c_delay(1);
143                 temp = sis96x_read(SMB_STS);
144         } while (!(temp & 0x0e) && (timeout++ < MAX_TIMEOUT));
145
146         /* If the SMBus is still busy, we give up */
147         if (timeout >= MAX_TIMEOUT) {
148                 dev_dbg(&sis96x_adapter.dev, "SMBus Timeout! (0x%02x)\n", temp);
149                 result = -1;
150         }
151
152         /* device error - probably missing ACK */
153         if (temp & 0x02) {
154                 dev_dbg(&sis96x_adapter.dev, "Failed bus transaction!\n");
155                 result = -1;
156         }
157
158         /* bus collision */
159         if (temp & 0x04) {
160                 dev_dbg(&sis96x_adapter.dev, "Bus collision!\n");
161                 result = -1;
162         }
163
164         /* Finish up by resetting the bus */
165         sis96x_write(SMB_STS, temp);
166         if ((temp = sis96x_read(SMB_STS))) {
167                 dev_dbg(&sis96x_adapter.dev, "Failed reset at "
168                         "end of transaction! (0x%02x)\n", temp);
169         }
170
171         return result;
172 }
173
174 /* Return -1 on error. */
175 static s32 sis96x_access(struct i2c_adapter * adap, u16 addr,
176                          unsigned short flags, char read_write,
177                          u8 command, int size, union i2c_smbus_data * data)
178 {
179
180         switch (size) {
181         case I2C_SMBUS_QUICK:
182                 sis96x_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
183                 size = SIS96x_QUICK;
184                 break;
185
186         case I2C_SMBUS_BYTE:
187                 sis96x_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
188                 if (read_write == I2C_SMBUS_WRITE)
189                         sis96x_write(SMB_CMD, command);
190                 size = SIS96x_BYTE;
191                 break;
192
193         case I2C_SMBUS_BYTE_DATA:
194                 sis96x_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
195                 sis96x_write(SMB_CMD, command);
196                 if (read_write == I2C_SMBUS_WRITE)
197                         sis96x_write(SMB_BYTE, data->byte);
198                 size = SIS96x_BYTE_DATA;
199                 break;
200
201         case I2C_SMBUS_PROC_CALL:
202         case I2C_SMBUS_WORD_DATA:
203                 sis96x_write(SMB_ADDR, ((addr & 0x7f) << 1) | (read_write & 0x01));
204                 sis96x_write(SMB_CMD, command);
205                 if (read_write == I2C_SMBUS_WRITE) {
206                         sis96x_write(SMB_BYTE, data->word & 0xff);
207                         sis96x_write(SMB_BYTE + 1, (data->word & 0xff00) >> 8);
208                 }
209                 size = (size == I2C_SMBUS_PROC_CALL ? 
210                         SIS96x_PROC_CALL : SIS96x_WORD_DATA);
211                 break;
212
213         case I2C_SMBUS_BLOCK_DATA:
214                 /* TO DO: */
215                 dev_info(&adap->dev, "SMBus block not implemented!\n");
216                 return -1;
217                 break;
218
219         default:
220                 dev_info(&adap->dev, "Unsupported I2C size\n");
221                 return -1;
222                 break;
223         }
224
225         if (sis96x_transaction(size))
226                 return -1;
227
228         if ((size != SIS96x_PROC_CALL) &&
229                 ((read_write == I2C_SMBUS_WRITE) || (size == SIS96x_QUICK)))
230                 return 0;
231
232         switch (size) {
233         case SIS96x_BYTE:
234         case SIS96x_BYTE_DATA:
235                 data->byte = sis96x_read(SMB_BYTE);
236                 break;
237
238         case SIS96x_WORD_DATA:
239         case SIS96x_PROC_CALL:
240                 data->word = sis96x_read(SMB_BYTE) +
241                                 (sis96x_read(SMB_BYTE + 1) << 8);
242                 break;
243         }
244         return 0;
245 }
246
247 static u32 sis96x_func(struct i2c_adapter *adapter)
248 {
249         return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
250             I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
251             I2C_FUNC_SMBUS_PROC_CALL;
252 }
253
254 static struct i2c_algorithm smbus_algorithm = {
255         .name           = "Non-I2C SMBus adapter",
256         .id             = I2C_ALGO_SMBUS,
257         .smbus_xfer     = sis96x_access,
258         .functionality  = sis96x_func,
259 };
260
261 static struct i2c_adapter sis96x_adapter = {
262         .owner          = THIS_MODULE,
263         .class          = I2C_ADAP_CLASS_SMBUS,
264         .algo           = &smbus_algorithm,
265         .name           = "unset",
266 };
267
268 static struct pci_device_id sis96x_ids[] = {
269
270         {
271                 .vendor =       PCI_VENDOR_ID_SI,
272                 .device =       PCI_DEVICE_ID_SI_SMBUS,
273                 .subvendor =    PCI_ANY_ID,
274                 .subdevice =    PCI_ANY_ID,
275         },
276
277         { 0, }
278 };
279
280 static int __devinit sis96x_probe(struct pci_dev *dev,
281                                 const struct pci_device_id *id)
282 {
283         u16 ww = 0;
284         int retval;
285
286         if (sis96x_smbus_base) {
287                 dev_err(&dev->dev, "Only one device supported.\n");
288                 return -EBUSY;
289         }
290
291         pci_read_config_word(dev, PCI_CLASS_DEVICE, &ww);
292         if (PCI_CLASS_SERIAL_SMBUS != ww) {
293                 dev_err(&dev->dev, "Unsupported device class 0x%04x!\n", ww);
294                 return -ENODEV;
295         }
296
297         sis96x_smbus_base = pci_resource_start(dev, SIS96x_BAR);
298         if (!sis96x_smbus_base) {
299                 dev_err(&dev->dev, "SiS96x SMBus base address "
300                         "not initialized!\n");
301                 return -EINVAL;
302         }
303         dev_info(&dev->dev, "SiS96x SMBus base address: 0x%04x\n",
304                         sis96x_smbus_base);
305
306         /* Everything is happy, let's grab the memory and set things up. */
307         if (!request_region(sis96x_smbus_base, SMB_IOSIZE, "sis96x-smbus")) {
308                 dev_err(&dev->dev, "SMBus registers 0x%04x-0x%04x "
309                         "already in use!\n", sis96x_smbus_base,
310                         sis96x_smbus_base + SMB_IOSIZE - 1);
311
312                 sis96x_smbus_base = 0;
313                 return -EINVAL;
314         }
315
316         /* set up the driverfs linkage to our parent device */
317         sis96x_adapter.dev.parent = &dev->dev;
318
319         snprintf(sis96x_adapter.name, I2C_NAME_SIZE,
320                 "SiS96x SMBus adapter at 0x%04x", sis96x_smbus_base);
321
322         if ((retval = i2c_add_adapter(&sis96x_adapter))) {
323                 dev_err(&dev->dev, "Couldn't register adapter!\n");
324                 release_region(sis96x_smbus_base, SMB_IOSIZE);
325                 sis96x_smbus_base = 0;
326         }
327
328         return retval;
329 }
330
331 static void __devexit sis96x_remove(struct pci_dev *dev)
332 {
333         if (sis96x_smbus_base) {
334                 i2c_del_adapter(&sis96x_adapter);
335                 release_region(sis96x_smbus_base, SMB_IOSIZE);
336                 sis96x_smbus_base = 0;
337         }
338 }
339
340 static struct pci_driver sis96x_driver = {
341         .name           = "sis96x smbus",
342         .id_table       = sis96x_ids,
343         .probe          = sis96x_probe,
344         .remove         = __devexit_p(sis96x_remove),
345 };
346
347 static int __init i2c_sis96x_init(void)
348 {
349         printk(KERN_INFO "i2c-sis96x version %s\n", SIS96x_VERSION);
350         return pci_module_init(&sis96x_driver);
351 }
352
353 static void __exit i2c_sis96x_exit(void)
354 {
355         pci_unregister_driver(&sis96x_driver);
356 }
357
358 MODULE_AUTHOR("Mark M. Hoffman <mhoffman@lightlink.com>");
359 MODULE_DESCRIPTION("SiS96x SMBus driver");
360 MODULE_LICENSE("GPL");
361
362 /* Register initialization functions using helper macros */
363 module_init(i2c_sis96x_init);
364 module_exit(i2c_sis96x_exit);
365