2 Copyright (c) 2002,2003 Alexander Malysh <amalysh@web.de>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
23 Notable differences between chips:
24 +------------------------+--------------------+-------------------+
25 | | SIS630/730 | SIS964 |
26 +------------------------+--------------------+-------------------+
27 | Clock | 14kHz/56kHz | 55.56kHz/27.78kHz |
28 | SMBus registers offset | 0x80 | 0xE0 |
29 | SMB_CNT | Bit 1 = Slave Busy | Bit 1 = Bus probe |
30 | (not used yet) | Bit 3 is reserved | Bit 3 = Last byte |
31 | SMB_PCOUNT | Offset + 0x06 | Offset + 0x14 |
32 | SMB_COUNT | 4:0 bits | 5:0 bits |
33 +------------------------+--------------------+-------------------+
34 (Other differences don't affect the functions provided by the driver)
36 Note: we assume there can only be one device, with one SMBus interface.
39 #include <linux/kernel.h>
40 #include <linux/module.h>
41 #include <linux/delay.h>
42 #include <linux/pci.h>
43 #include <linux/ioport.h>
44 #include <linux/i2c.h>
45 #include <linux/acpi.h>
48 /* SIS964 id is defined here as we are the only file using it */
49 #define PCI_DEVICE_ID_SI_964 0x0964
51 /* SIS630/730/964 SMBus registers */
52 #define SMB_STS 0x00 /* status */
53 #define SMB_CNT 0x02 /* control */
54 #define SMBHOST_CNT 0x03 /* host control */
55 #define SMB_ADDR 0x04 /* address */
56 #define SMB_CMD 0x05 /* command */
57 #define SMB_COUNT 0x07 /* byte count */
58 #define SMB_BYTE 0x08 /* ~0x8F data byte field */
60 /* SMB_STS register */
61 #define BYTE_DONE_STS 0x10 /* Byte Done Status / Block Array */
62 #define SMBCOL_STS 0x04 /* Collision */
63 #define SMBERR_STS 0x02 /* Device error */
65 /* SMB_CNT register */
66 #define MSTO_EN 0x40 /* Host Master Timeout Enable */
67 #define SMBCLK_SEL 0x20 /* Host master clock selection */
68 #define SMB_PROBE 0x02 /* Bus Probe/Slave busy */
69 #define SMB_HOSTBUSY 0x01 /* Host Busy */
71 /* SMBHOST_CNT register */
72 #define SMB_KILL 0x20 /* Kill */
73 #define SMB_START 0x10 /* Start */
75 /* register count for request_region
76 * As we don't use SMB_PCOUNT, 20 is ok for SiS630 and SiS964
78 #define SIS630_SMB_IOREGION 20
80 /* PCI address constants */
81 /* acpi base address register */
82 #define SIS630_ACPI_BASE_REG 0x74
83 /* bios control register */
84 #define SIS630_BIOS_CTL_REG 0x40
87 #define MAX_TIMEOUT 500
89 /* SIS630 constants */
90 #define SIS630_QUICK 0x00
91 #define SIS630_BYTE 0x01
92 #define SIS630_BYTE_DATA 0x02
93 #define SIS630_WORD_DATA 0x03
94 #define SIS630_PCALL 0x04
95 #define SIS630_BLOCK_DATA 0x05
97 static struct pci_driver sis630_driver
;
99 /* insmod parameters */
100 static bool high_clock
;
102 module_param(high_clock
, bool, 0);
103 MODULE_PARM_DESC(high_clock
,
104 "Set Host Master Clock to 56KHz (default 14KHz) (SIS630/730 only).");
105 module_param(force
, bool, 0);
106 MODULE_PARM_DESC(force
, "Forcibly enable the SIS630. DANGEROUS!");
108 /* SMBus base adress */
109 static unsigned short smbus_base
;
111 /* supported chips */
112 static int supported
[] = {
113 PCI_DEVICE_ID_SI_630
,
114 PCI_DEVICE_ID_SI_730
,
115 PCI_DEVICE_ID_SI_760
,
116 0 /* terminates the list */
119 static inline u8
sis630_read(u8 reg
)
121 return inb(smbus_base
+ reg
);
124 static inline void sis630_write(u8 reg
, u8 data
)
126 outb(data
, smbus_base
+ reg
);
129 static int sis630_transaction_start(struct i2c_adapter
*adap
, int size
,
134 /* Make sure the SMBus host is ready to start transmitting. */
135 temp
= sis630_read(SMB_CNT
);
136 if ((temp
& (SMB_PROBE
| SMB_HOSTBUSY
)) != 0x00) {
137 dev_dbg(&adap
->dev
, "SMBus busy (%02x). Resetting...\n", temp
);
138 /* kill smbus transaction */
139 sis630_write(SMBHOST_CNT
, SMB_KILL
);
141 temp
= sis630_read(SMB_CNT
);
142 if (temp
& (SMB_PROBE
| SMB_HOSTBUSY
)) {
143 dev_dbg(&adap
->dev
, "Failed! (%02x)\n", temp
);
146 dev_dbg(&adap
->dev
, "Successful!\n");
150 /* save old clock, so we can prevent machine for hung */
151 *oldclock
= sis630_read(SMB_CNT
);
153 dev_dbg(&adap
->dev
, "saved clock 0x%02x\n", *oldclock
);
155 /* disable timeout interrupt,
156 * set Host Master Clock to 56KHz if requested */
158 sis630_write(SMB_CNT
, SMBCLK_SEL
);
160 sis630_write(SMB_CNT
, (*oldclock
& ~MSTO_EN
));
162 /* clear all sticky bits */
163 temp
= sis630_read(SMB_STS
);
164 sis630_write(SMB_STS
, temp
& 0x1e);
166 /* start the transaction by setting bit 4 and size */
167 sis630_write(SMBHOST_CNT
, SMB_START
| (size
& 0x07));
172 static int sis630_transaction_wait(struct i2c_adapter
*adap
, int size
)
174 int temp
, result
= 0, timeout
= 0;
176 /* We will always wait for a fraction of a second! */
179 temp
= sis630_read(SMB_STS
);
180 /* check if block transmitted */
181 if (size
== SIS630_BLOCK_DATA
&& (temp
& BYTE_DONE_STS
))
183 } while (!(temp
& 0x0e) && (timeout
++ < MAX_TIMEOUT
));
185 /* If the SMBus is still busy, we give up */
186 if (timeout
> MAX_TIMEOUT
) {
187 dev_dbg(&adap
->dev
, "SMBus Timeout!\n");
191 if (temp
& SMBERR_STS
) {
192 dev_dbg(&adap
->dev
, "Error: Failed bus transaction\n");
196 if (temp
& SMBCOL_STS
) {
197 dev_err(&adap
->dev
, "Bus collision!\n");
204 static void sis630_transaction_end(struct i2c_adapter
*adap
, u8 oldclock
)
206 /* clear all status "sticky" bits */
207 sis630_write(SMB_STS
, 0xFF);
210 "SMB_CNT before clock restore 0x%02x\n", sis630_read(SMB_CNT
));
213 * restore old Host Master Clock if high_clock is set
214 * and oldclock was not 56KHz
216 if (high_clock
&& !(oldclock
& SMBCLK_SEL
))
217 sis630_write(SMB_CNT
, sis630_read(SMB_CNT
) & ~SMBCLK_SEL
);
220 "SMB_CNT after clock restore 0x%02x\n", sis630_read(SMB_CNT
));
223 static int sis630_transaction(struct i2c_adapter
*adap
, int size
)
228 result
= sis630_transaction_start(adap
, size
, &oldclock
);
230 result
= sis630_transaction_wait(adap
, size
);
231 sis630_transaction_end(adap
, oldclock
);
237 static int sis630_block_data(struct i2c_adapter
*adap
,
238 union i2c_smbus_data
*data
, int read_write
)
240 int i
, len
= 0, rc
= 0;
243 if (read_write
== I2C_SMBUS_WRITE
) {
244 len
= data
->block
[0];
249 sis630_write(SMB_COUNT
, len
);
250 for (i
= 1; i
<= len
; i
++) {
252 "set data 0x%02x\n", data
->block
[i
]);
254 sis630_write(SMB_BYTE
+ (i
- 1) % 8, data
->block
[i
]);
255 if (i
== 8 || (len
< 8 && i
== len
)) {
257 "start trans len=%d i=%d\n", len
, i
);
258 /* first transaction */
259 rc
= sis630_transaction_start(adap
,
260 SIS630_BLOCK_DATA
, &oldclock
);
263 } else if ((i
- 1) % 8 == 7 || i
== len
) {
265 "trans_wait len=%d i=%d\n", len
, i
);
269 " len=%d i=%d\n", len
, i
);
271 If this is not first transaction,
272 we must clear sticky bit.
275 sis630_write(SMB_STS
, BYTE_DONE_STS
);
277 rc
= sis630_transaction_wait(adap
,
281 "trans_wait failed\n");
288 data
->block
[0] = len
= 0;
289 rc
= sis630_transaction_start(adap
,
290 SIS630_BLOCK_DATA
, &oldclock
);
294 rc
= sis630_transaction_wait(adap
, SIS630_BLOCK_DATA
);
296 dev_dbg(&adap
->dev
, "trans_wait failed\n");
299 /* if this first transaction then read byte count */
301 data
->block
[0] = sis630_read(SMB_COUNT
);
303 /* just to be sure */
304 if (data
->block
[0] > 32)
308 "block data read len=0x%x\n", data
->block
[0]);
310 for (i
= 0; i
< 8 && len
< data
->block
[0]; i
++, len
++) {
312 "read i=%d len=%d\n", i
, len
);
313 data
->block
[len
+ 1] = sis630_read(SMB_BYTE
+
318 "clear smbary_sts len=%d i=%d\n", len
, i
);
320 /* clear SMBARY_STS */
321 sis630_write(SMB_STS
, BYTE_DONE_STS
);
322 } while (len
< data
->block
[0]);
325 sis630_transaction_end(adap
, oldclock
);
330 /* Return negative errno on error. */
331 static s32
sis630_access(struct i2c_adapter
*adap
, u16 addr
,
332 unsigned short flags
, char read_write
,
333 u8 command
, int size
, union i2c_smbus_data
*data
)
338 case I2C_SMBUS_QUICK
:
339 sis630_write(SMB_ADDR
,
340 ((addr
& 0x7f) << 1) | (read_write
& 0x01));
344 sis630_write(SMB_ADDR
,
345 ((addr
& 0x7f) << 1) | (read_write
& 0x01));
346 if (read_write
== I2C_SMBUS_WRITE
)
347 sis630_write(SMB_CMD
, command
);
350 case I2C_SMBUS_BYTE_DATA
:
351 sis630_write(SMB_ADDR
,
352 ((addr
& 0x7f) << 1) | (read_write
& 0x01));
353 sis630_write(SMB_CMD
, command
);
354 if (read_write
== I2C_SMBUS_WRITE
)
355 sis630_write(SMB_BYTE
, data
->byte
);
356 size
= SIS630_BYTE_DATA
;
358 case I2C_SMBUS_PROC_CALL
:
359 case I2C_SMBUS_WORD_DATA
:
360 sis630_write(SMB_ADDR
,
361 ((addr
& 0x7f) << 1) | (read_write
& 0x01));
362 sis630_write(SMB_CMD
, command
);
363 if (read_write
== I2C_SMBUS_WRITE
) {
364 sis630_write(SMB_BYTE
, data
->word
& 0xff);
365 sis630_write(SMB_BYTE
+ 1, (data
->word
& 0xff00) >> 8);
367 size
= (size
== I2C_SMBUS_PROC_CALL
?
368 SIS630_PCALL
: SIS630_WORD_DATA
);
370 case I2C_SMBUS_BLOCK_DATA
:
371 sis630_write(SMB_ADDR
,
372 ((addr
& 0x7f) << 1) | (read_write
& 0x01));
373 sis630_write(SMB_CMD
, command
);
374 size
= SIS630_BLOCK_DATA
;
375 return sis630_block_data(adap
, data
, read_write
);
377 dev_warn(&adap
->dev
, "Unsupported transaction %d\n", size
);
381 status
= sis630_transaction(adap
, size
);
385 if ((size
!= SIS630_PCALL
) &&
386 ((read_write
== I2C_SMBUS_WRITE
) || (size
== SIS630_QUICK
))) {
392 case SIS630_BYTE_DATA
:
393 data
->byte
= sis630_read(SMB_BYTE
);
396 case SIS630_WORD_DATA
:
397 data
->word
= sis630_read(SMB_BYTE
) +
398 (sis630_read(SMB_BYTE
+ 1) << 8);
405 static u32
sis630_func(struct i2c_adapter
*adapter
)
407 return I2C_FUNC_SMBUS_QUICK
| I2C_FUNC_SMBUS_BYTE
|
408 I2C_FUNC_SMBUS_BYTE_DATA
| I2C_FUNC_SMBUS_WORD_DATA
|
409 I2C_FUNC_SMBUS_PROC_CALL
| I2C_FUNC_SMBUS_BLOCK_DATA
;
412 static int sis630_setup(struct pci_dev
*sis630_dev
)
415 struct pci_dev
*dummy
= NULL
;
417 /* acpi base address */
418 unsigned short acpi_base
;
420 /* check for supported SiS devices */
421 for (i
= 0; supported
[i
] > 0; i
++) {
422 dummy
= pci_get_device(PCI_VENDOR_ID_SI
, supported
[i
], dummy
);
430 dev_err(&sis630_dev
->dev
,
431 "WARNING: Can't detect SIS630 compatible device, but "
432 "loading because of force option enabled\n");
438 Enable ACPI first , so we can accsess reg 74-75
439 in acpi io space and read acpi base addr
441 if (pci_read_config_byte(sis630_dev
, SIS630_BIOS_CTL_REG
, &b
)) {
442 dev_err(&sis630_dev
->dev
, "Error: Can't read bios ctl reg\n");
446 /* if ACPI already enabled , do nothing */
448 pci_write_config_byte(sis630_dev
, SIS630_BIOS_CTL_REG
, b
| 0x80)) {
449 dev_err(&sis630_dev
->dev
, "Error: Can't enable ACPI\n");
454 /* Determine the ACPI base address */
455 if (pci_read_config_word(sis630_dev
,
456 SIS630_ACPI_BASE_REG
, &acpi_base
)) {
457 dev_err(&sis630_dev
->dev
,
458 "Error: Can't determine ACPI base address\n");
463 dev_dbg(&sis630_dev
->dev
, "ACPI base at 0x%04hx\n", acpi_base
);
465 if (supported
[i
] == PCI_DEVICE_ID_SI_760
)
466 smbus_base
= acpi_base
+ 0xE0;
468 smbus_base
= acpi_base
+ 0x80;
470 dev_dbg(&sis630_dev
->dev
, "SMBus base at 0x%04hx\n", smbus_base
);
472 retval
= acpi_check_region(smbus_base
+ SMB_STS
, SIS630_SMB_IOREGION
,
477 /* Everything is happy, let's grab the memory and set things up. */
478 if (!request_region(smbus_base
+ SMB_STS
, SIS630_SMB_IOREGION
,
479 sis630_driver
.name
)) {
480 dev_err(&sis630_dev
->dev
,
481 "I/O Region 0x%04hx-0x%04hx for SMBus already in use.\n",
482 smbus_base
+ SMB_STS
,
483 smbus_base
+ SMB_STS
+ SIS630_SMB_IOREGION
- 1);
497 static const struct i2c_algorithm smbus_algorithm
= {
498 .smbus_xfer
= sis630_access
,
499 .functionality
= sis630_func
,
502 static struct i2c_adapter sis630_adapter
= {
503 .owner
= THIS_MODULE
,
504 .class = I2C_CLASS_HWMON
| I2C_CLASS_SPD
,
505 .algo
= &smbus_algorithm
,
509 static const struct pci_device_id sis630_ids
[] = {
510 { PCI_DEVICE(PCI_VENDOR_ID_SI
, PCI_DEVICE_ID_SI_503
) },
511 { PCI_DEVICE(PCI_VENDOR_ID_SI
, PCI_DEVICE_ID_SI_LPC
) },
512 { PCI_DEVICE(PCI_VENDOR_ID_SI
, PCI_DEVICE_ID_SI_964
) },
516 MODULE_DEVICE_TABLE(pci
, sis630_ids
);
518 static int sis630_probe(struct pci_dev
*dev
, const struct pci_device_id
*id
)
520 if (sis630_setup(dev
)) {
522 "SIS630 compatible bus not detected, "
523 "module not inserted.\n");
527 /* set up the sysfs linkage to our parent device */
528 sis630_adapter
.dev
.parent
= &dev
->dev
;
530 snprintf(sis630_adapter
.name
, sizeof(sis630_adapter
.name
),
531 "SMBus SIS630 adapter at %04hx", smbus_base
+ SMB_STS
);
533 return i2c_add_adapter(&sis630_adapter
);
536 static void sis630_remove(struct pci_dev
*dev
)
539 i2c_del_adapter(&sis630_adapter
);
540 release_region(smbus_base
+ SMB_STS
, SIS630_SMB_IOREGION
);
546 static struct pci_driver sis630_driver
= {
547 .name
= "sis630_smbus",
548 .id_table
= sis630_ids
,
549 .probe
= sis630_probe
,
550 .remove
= sis630_remove
,
553 module_pci_driver(sis630_driver
);
555 MODULE_LICENSE("GPL");
556 MODULE_AUTHOR("Alexander Malysh <amalysh@web.de>");
557 MODULE_DESCRIPTION("SIS630 SMBus driver");