root/lm-sensors/trunk/kernel/busses/i2c-ali1563.c @ 4324

Revision 4324, 11.6 KB (checked in by khali, 8 years ago)

i2c-ali1563: Fix device initialization (backported from Linux 2.6)

The i2c-ali1563 initialization looks quite broken to me:
* If the I/O space isn't enabled, we forcibly set 3 bits in

the PCI configuration space instead of just the one enabling
the I/O space.

* After that we pretend to check if the write worked, but we

don't actually read the new value from the register.

* It's probably not a good idea to enable the I/O space if no

base address has been set.

So I propose the following changes to that part of the driver:
* Merge ali1563_enable() into ali1563_setup().
* Check the base address before the I/O space enabled bit.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1/**
2 *      i2c-ali1563.c - i2c driver for the ALi 1563 Southbridge
3 *
4 *      Copyright (C) 2004, 2005 Patrick Mochel, Chunhao Huang
5 *
6 *      The 1563 southbridge is deceptively similar to the 1533, with a
7 *      few notable exceptions. One of those happens to be the fact they
8 *      upgraded the i2c core to be 2.0 compliant, and happens to be almost
9 *      identical to the i2c controller found in the Intel 801 south
10 *      bridges.
11 *
12 *      This driver is based on a mix of the 15x3, 1535, and i801 drivers,
13 *      with a little help from the ALi 1563 spec.
14 *
15 *      Chunhao Huang / Winbond
16 *      Backport to linux-2.4 from linux-2.6 on Mar.2005
17 *
18 *      This file is released under the GPLv2
19 */
20
21#include <linux/module.h>
22#include <linux/delay.h>
23#include <linux/i2c.h>
24#include <linux/pci.h>
25#include <linux/init.h>
26#include "version.h"
27#include "sensors_compat.h"
28
29#ifndef PCI_DEVICE_ID_AL_M1563
30#define PCI_DEVICE_ID_AL_M1563      0x1563
31#endif
32
33#define ALI1563_MAX_TIMEOUT     500
34#define ALI1563_SMBBA           0x80
35#define ALI1563_SMB_IOEN        1
36#define ALI1563_SMB_HOSTEN      2
37#define ALI1563_SMB_IOSIZE      16
38
39#define SMB_HST_STS     (ali1563_smba + 0)
40#define SMB_HST_CNTL1   (ali1563_smba + 1)
41#define SMB_HST_CNTL2   (ali1563_smba + 2)
42#define SMB_HST_CMD     (ali1563_smba + 3)
43#define SMB_HST_ADD     (ali1563_smba + 4)
44#define SMB_HST_DAT0    (ali1563_smba + 5)
45#define SMB_HST_DAT1    (ali1563_smba + 6)
46#define SMB_BLK_DAT     (ali1563_smba + 7)
47
48#define HST_STS_BUSY    0x01
49#define HST_STS_INTR    0x02
50#define HST_STS_DEVERR  0x04
51#define HST_STS_BUSERR  0x08
52#define HST_STS_FAIL    0x10
53#define HST_STS_DONE    0x80
54#define HST_STS_BAD     0x1c
55
56
57#define HST_CNTL1_TIMEOUT       0x80
58#define HST_CNTL1_LAST          0x40
59
60#define HST_CNTL2_KILL          0x04
61#define HST_CNTL2_START         0x40
62#define HST_CNTL2_QUICK         0x00
63#define HST_CNTL2_BYTE          0x01
64#define HST_CNTL2_BYTE_DATA     0x02
65#define HST_CNTL2_WORD_DATA     0x03
66#define HST_CNTL2_BLOCK         0x05
67#define HST_CNTL2_SIZEMASK      0x38
68
69static struct pci_driver ali1563_pci_driver;
70static unsigned short ali1563_smba;
71
72static int ali1563_transaction(struct i2c_adapter * a)
73{
74        u32 data;
75        int timeout;
76
77        printk(KERN_DEBUG "ali1563: Transaction (pre): STS=%02x, CNTL1=%02x, "
78                "CNTL2=%02x, CMD=%02x, ADD=%02x, DAT0=%02x, DAT1=%02x\n",
79                inb_p(SMB_HST_STS), inb_p(SMB_HST_CNTL1), inb_p(SMB_HST_CNTL2),
80                inb_p(SMB_HST_CMD), inb_p(SMB_HST_ADD), inb_p(SMB_HST_DAT0),
81                inb_p(SMB_HST_DAT1));
82
83        data = inb_p(SMB_HST_STS);
84        if (data & HST_STS_BAD) {
85                printk(KERN_WARNING "ali1563: Trying to reset busy device\n");
86                outb_p(data | HST_STS_BAD,SMB_HST_STS);
87                data = inb_p(SMB_HST_STS);
88                if (data & HST_STS_BAD){
89                        return -EBUSY;
90                }
91        }
92        outb_p(inb_p(SMB_HST_CNTL2) | HST_CNTL2_START, SMB_HST_CNTL2);
93
94        timeout = ALI1563_MAX_TIMEOUT;
95        do
96                i2c_delay(1);
97        while (((data = inb_p(SMB_HST_STS)) & HST_STS_BUSY) && --timeout);
98
99        printk(KERN_DEBUG "ali1563: Transaction (post): STS=%02x, CNTL1=%02x, "
100                "CNTL2=%02x, CMD=%02x, ADD=%02x, DAT0=%02x, DAT1=%02x\n",
101                inb_p(SMB_HST_STS), inb_p(SMB_HST_CNTL1), inb_p(SMB_HST_CNTL2),
102                inb_p(SMB_HST_CMD), inb_p(SMB_HST_ADD), inb_p(SMB_HST_DAT0),
103                inb_p(SMB_HST_DAT1));
104
105        if (timeout && !(data & HST_STS_BAD)) {
106                return 0;
107        }
108
109        /* modified by Rudolf */
110        if (!timeout) {
111                printk(KERN_ERR "ali1563: Timeout - Trying to KILL transaction!\n");
112                /* Issue 'kill' to host controller */
113                outb_p(HST_CNTL2_KILL,SMB_HST_CNTL2);
114                data = inb_p(SMB_HST_STS);             
115        }
116       
117        /* device error - probably missing ACK */       
118        if (data & HST_STS_DEVERR) {
119                printk(KERN_DEBUG "ali1563: Device error!\n");
120        }
121
122        /* bus collision */
123        if (data & HST_STS_BUSERR) {
124                printk(KERN_ERR "ali1563: Bus collision!\n");
125                /* Issue timeout, hoping it helps */
126                outb_p(HST_CNTL1_TIMEOUT,SMB_HST_CNTL1);
127        }
128
129        if (data & HST_STS_FAIL) {
130                printk(KERN_ERR "ali1563: Cleaning fail after KILL!\n");
131                outb_p(0x0,SMB_HST_CNTL2);
132        }
133
134        return -1;
135}
136
137static int ali1563_block_start(struct i2c_adapter * a)
138{
139        u32 data;
140        int timeout;
141
142        printk(KERN_DEBUG "ali1563: Block (pre): STS=%02x, CNTL1=%02x, "
143                "CNTL2=%02x, CMD=%02x, ADD=%02x, DAT0=%02x, DAT1=%02x\n",
144                inb_p(SMB_HST_STS), inb_p(SMB_HST_CNTL1), inb_p(SMB_HST_CNTL2),
145                inb_p(SMB_HST_CMD), inb_p(SMB_HST_ADD), inb_p(SMB_HST_DAT0),
146                inb_p(SMB_HST_DAT1));
147
148        data = inb_p(SMB_HST_STS);
149        if (data & HST_STS_BAD) {
150                printk(KERN_WARNING "ali1563: Trying to reset busy device\n");
151                outb_p(data | HST_STS_BAD,SMB_HST_STS);
152                data = inb_p(SMB_HST_STS);
153                if (data & HST_STS_BAD){
154                        return -EBUSY;
155                }
156        }
157
158        /* Clear byte-ready bit */
159        outb_p(data | HST_STS_DONE, SMB_HST_STS);
160
161        /* Start transaction and wait for byte-ready bit to be set */
162        outb_p(inb_p(SMB_HST_CNTL2) | HST_CNTL2_START, SMB_HST_CNTL2);
163
164        timeout = ALI1563_MAX_TIMEOUT;
165        do
166                i2c_delay(1);
167        while (!((data = inb_p(SMB_HST_STS)) & HST_STS_DONE) && --timeout);
168
169        printk(KERN_DEBUG "ali1563: Block (post): STS=%02x, CNTL1=%02x, "
170                "CNTL2=%02x, CMD=%02x, ADD=%02x, DAT0=%02x, DAT1=%02x\n",
171                inb_p(SMB_HST_STS), inb_p(SMB_HST_CNTL1), inb_p(SMB_HST_CNTL2),
172                inb_p(SMB_HST_CMD), inb_p(SMB_HST_ADD), inb_p(SMB_HST_DAT0),
173                inb_p(SMB_HST_DAT1));
174
175        if (timeout && !(data & HST_STS_BAD)){
176                return 0;
177        }
178        printk(KERN_WARNING "ali1563: SMBus Error: %s%s%s%s%s\n",
179                timeout ? "Timeout " : "",
180                data & HST_STS_FAIL ? "Transaction Failed " : "",
181                data & HST_STS_BUSERR ? "No response or Bus Collision " : "",
182                data & HST_STS_DEVERR ? "Device Error " : "",
183                !(data & HST_STS_DONE) ? "Transaction Never Finished " : "");
184        return -1;
185}
186
187static int ali1563_block(struct i2c_adapter * a, union i2c_smbus_data * data, u8 rw)
188{
189        int i, len;
190        int error = 0;
191
192        /* Do we need this? */
193        outb_p(HST_CNTL1_LAST,SMB_HST_CNTL1);
194
195        if (rw == I2C_SMBUS_WRITE) {
196                len = data->block[0];
197                if (len < 1)
198                        len = 1;
199                else if (len > 32)
200                        len = 32;
201                outb_p(len,SMB_HST_DAT0);
202                outb_p(data->block[1],SMB_BLK_DAT);
203        } else
204                len = 32;
205
206        outb_p(inb_p(SMB_HST_CNTL2) | HST_CNTL2_BLOCK, SMB_HST_CNTL2);
207
208        for (i = 0; i < len; i++) {
209                if (rw == I2C_SMBUS_WRITE) {
210                        outb_p(data->block[i + 1], SMB_BLK_DAT);
211                        if ((error = ali1563_block_start(a)))
212                                break;
213                } else {
214                        if ((error = ali1563_block_start(a)))
215                                break;
216                        if (i == 0) {
217                                len = inb_p(SMB_HST_DAT0);
218                                if (len < 1)
219                                        len = 1;
220                                else if (len > 32)
221                                        len = 32;
222                        }
223                        data->block[i+1] = inb_p(SMB_BLK_DAT);
224                }
225        }
226        /* Do we need this? */
227        outb_p(HST_CNTL1_LAST,SMB_HST_CNTL1);
228        return error;
229}
230
231static s32 ali1563_access(struct i2c_adapter * a, u16 addr,
232                          unsigned short flags, char rw, u8 cmd,
233                          int size, union i2c_smbus_data * data)
234{
235        int error = 0;
236        int timeout;
237        u32 reg;
238
239        for (timeout = ALI1563_MAX_TIMEOUT; timeout; timeout--) {
240                if (!(reg = inb_p(SMB_HST_STS) & HST_STS_BUSY))
241                        break;
242        }
243        if (!timeout)
244                printk(KERN_WARNING "ali1563: SMBus not idle. HST_STS = %02x\n",reg);
245        outb_p(0xff,SMB_HST_STS);
246
247        /* Map the size to what the chip understands */
248        switch (size) {
249        case I2C_SMBUS_PROC_CALL:
250                printk(KERN_ERR "ali1563: I2C_SMBUS_PROC_CALL not supported!\n");
251                error = -EINVAL;
252                break;
253        case I2C_SMBUS_QUICK:
254                size = HST_CNTL2_QUICK;
255                break;
256        case I2C_SMBUS_BYTE:
257                size = HST_CNTL2_BYTE;
258                break;
259        case I2C_SMBUS_BYTE_DATA:
260                size = HST_CNTL2_BYTE_DATA;
261                break;
262        case I2C_SMBUS_WORD_DATA:
263                size = HST_CNTL2_WORD_DATA;
264                break;
265        case I2C_SMBUS_BLOCK_DATA:
266                size = HST_CNTL2_BLOCK;
267                break;
268        }
269
270        outb_p(((addr & 0x7f) << 1) | (rw & 0x01), SMB_HST_ADD);
271        outb_p( (inb_p(SMB_HST_CNTL2)&~HST_CNTL2_SIZEMASK) | (size << 3), SMB_HST_CNTL2);
272
273        /* Write the command register */
274        switch(size) {
275        case HST_CNTL2_BYTE:
276                if (rw== I2C_SMBUS_WRITE)
277                        /* outb_p(cmd, SMB_HST_CMD); */
278                        outb_p(cmd, SMB_HST_DAT0); /* modify by Rudolf */
279                break;
280        case HST_CNTL2_BYTE_DATA:
281                outb_p(cmd, SMB_HST_CMD);
282                if (rw == I2C_SMBUS_WRITE)
283                        outb_p(data->byte, SMB_HST_DAT0);
284                break;
285        case HST_CNTL2_WORD_DATA:
286                outb_p(cmd, SMB_HST_CMD);
287                if (rw == I2C_SMBUS_WRITE) {
288                        outb_p(data->word & 0xff, SMB_HST_DAT0);
289                        outb_p((data->word & 0xff00) >> 8, SMB_HST_DAT1);
290                }
291                break;
292        case HST_CNTL2_BLOCK:
293                outb_p(cmd, SMB_HST_CMD);
294                error = ali1563_block(a,data,rw);
295                goto Done;
296        }
297
298        if ((error = ali1563_transaction(a))){
299                goto Done;
300        }
301
302        if ((rw == I2C_SMBUS_WRITE) || (size == HST_CNTL2_QUICK)){
303                goto Done;
304        }
305
306        switch (size) {
307        case HST_CNTL2_BYTE:    /* Result put in SMBHSTDAT0 */
308                data->byte = inb_p(SMB_HST_DAT0);
309                break;
310        case HST_CNTL2_BYTE_DATA:
311                data->byte = inb_p(SMB_HST_DAT0);
312                break;
313        case HST_CNTL2_WORD_DATA:
314                data->word = inb_p(SMB_HST_DAT0) + (inb_p(SMB_HST_DAT1) << 8);
315                break;
316        }
317Done:
318        return error;
319}
320
321static u32 ali1563_func(struct i2c_adapter * a)
322{
323        return ( I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
324            I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
325            I2C_FUNC_SMBUS_BLOCK_DATA );
326}
327
328
329static int __devinit ali1563_setup(struct pci_dev * dev)
330{
331        u16 ctrl;
332
333        pci_read_config_word(dev,ALI1563_SMBBA,&ctrl);
334
335        /* SMB I/O Base in high 12 bits and must be aligned with the
336         * size of the I/O space. */
337        ali1563_smba = ctrl & ~(ALI1563_SMB_IOSIZE - 1);
338        if (!ali1563_smba) {
339                printk(KERN_WARNING "ali1563: ali1563_smba Uninitialized\n");
340                goto Err;
341        }
342
343        /* Check if device is enabled */
344        if (!(ctrl & ALI1563_SMB_HOSTEN)) {
345                printk(KERN_WARNING "ali1563: Host Controller not enabled\n");
346                goto Err;
347        }
348        if (!(ctrl & ALI1563_SMB_IOEN)) {
349                printk(KERN_WARNING "I/O space not enabled, trying manually\n");
350                pci_write_config_word(dev, ALI1563_SMBBA,
351                                      ctrl | ALI1563_SMB_IOEN);
352                pci_read_config_word(dev, ALI1563_SMBBA, &ctrl);
353                if (!(ctrl & ALI1563_SMB_IOEN)) {
354                        printk(KERN_WARNING "I/O space still not enabled, "
355                               "giving up\n");
356                        goto Err;
357                }
358        }
359
360        if (!request_region(ali1563_smba, ALI1563_SMB_IOSIZE,
361                            ali1563_pci_driver.name)) {
362                printk(KERN_WARNING "ali1563: Could not allocate I/O space "
363                       "at 0x%04x\n", ali1563_smba);
364                goto Err;
365        }
366        printk(KERN_INFO "ali1563: Found ALi1563 SMBus at 0x%04x\n",
367               ali1563_smba);
368
369        return 0;
370Err:
371        return -ENODEV;
372}
373
374static void ali1563_shutdown(struct pci_dev *dev)
375{
376        release_region(ali1563_smba,ALI1563_SMB_IOSIZE);
377}
378
379static void ali1563_inc(struct i2c_adapter *adapter)
380{
381#ifdef MODULE
382        MOD_INC_USE_COUNT;
383#endif
384}
385
386static void ali1563_dec(struct i2c_adapter *adapter)
387{
388#ifdef MODULE
389        MOD_DEC_USE_COUNT;
390#endif
391}
392
393static struct i2c_algorithm ali1563_algorithm = {
394        .name           = "Non-i2c SMBus adapter",
395        .id             = I2C_ALGO_SMBUS,
396        .smbus_xfer     = ali1563_access,
397        .functionality  = ali1563_func,
398};
399
400static struct i2c_adapter ali1563_adapter = {
401        .algo           = &ali1563_algorithm,
402        .inc_use        = ali1563_inc,
403        .dec_use        = ali1563_dec,
404};
405
406static int __devinit ali1563_probe(struct pci_dev * dev,
407                                const struct pci_device_id * id_table)
408{
409        int error;
410
411        if ((error = ali1563_setup(dev))) {
412                printk(KERN_WARNING "ali1563: ALi1563 SMBus probe failed "
413                       "(%d)\n", error);
414                return error;
415        }
416        sprintf(ali1563_adapter.name,"SMBus ALi 1563 Adapter @ %04x",
417                ali1563_smba);
418        if ((error = i2c_add_adapter(&ali1563_adapter)))
419                ali1563_shutdown(dev);
420        return error;
421}
422
423static void __devexit ali1563_remove(struct pci_dev * dev)
424{
425        i2c_del_adapter(&ali1563_adapter);
426        ali1563_shutdown(dev);
427}
428
429static struct pci_device_id ali1563_ids[] __devinitdata = {
430        {
431        .vendor =       PCI_VENDOR_ID_AL,
432        .device =       PCI_DEVICE_ID_AL_M1563,
433        .subvendor =    PCI_ANY_ID,
434        .subdevice =    PCI_ANY_ID,
435        },
436        { 0, }
437};
438
439static struct pci_driver ali1563_pci_driver = {
440        .name           = "ali1563 smbus",
441        .id_table       = ali1563_ids,
442        .probe          = ali1563_probe,
443        .remove         = __devexit_p(ali1563_remove),
444};
445
446static int __init ali1563_init(void)
447{
448        printk("i2c-ali1563.o version %s (%s)\n", LM_VERSION, LM_DATE);
449        return pci_module_init(&ali1563_pci_driver);
450}
451
452module_init(ali1563_init);
453
454static void __exit ali1563_exit(void)
455{
456        pci_unregister_driver(&ali1563_pci_driver);
457}
458
459module_exit(ali1563_exit);
460
461MODULE_AUTHOR("Patrick Mochel <mochel@digitalimplant.org>, Chunhao Huang");
462MODULE_DESCRIPTION("ALi M1563 southbridge driver for linux-2.4, backported by Chunhao Huang from linux-2.6");
463MODULE_LICENSE("GPL");
464
Note: See TracBrowser for help on using the browser.