1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 Copyright (c) 1999 Frodo Looijaard <frodol@dds.nl> and 4 Philip Edelbrock <phil@netroedge.com> and 5 Mark D. Studebaker <mdsxyz123@yahoo.com> 6 7 */ 8 9 /* 10 This is the driver for the SMB Host controller on 11 Acer Labs Inc. (ALI) M1541 and M1543C South Bridges. 12 13 The M1543C is a South bridge for desktop systems. 14 The M1533 is a South bridge for portable systems. 15 They are part of the following ALI chipsets: 16 "Aladdin Pro 2": Includes the M1621 Slot 1 North bridge 17 with AGP and 100MHz CPU Front Side bus 18 "Aladdin V": Includes the M1541 Socket 7 North bridge 19 with AGP and 100MHz CPU Front Side bus 20 "Aladdin IV": Includes the M1541 Socket 7 North bridge 21 with host bus up to 83.3 MHz. 22 For an overview of these chips see http://www.acerlabs.com 23 24 The M1533/M1543C devices appear as FOUR separate devices 25 on the PCI bus. An output of lspci will show something similar 26 to the following: 27 28 00:02.0 USB Controller: Acer Laboratories Inc. M5237 29 00:03.0 Bridge: Acer Laboratories Inc. M7101 30 00:07.0 ISA bridge: Acer Laboratories Inc. M1533 31 00:0f.0 IDE interface: Acer Laboratories Inc. M5229 32 33 The SMB controller is part of the 7101 device, which is an 34 ACPI-compliant Power Management Unit (PMU). 35 36 The whole 7101 device has to be enabled for the SMB to work. 37 You can't just enable the SMB alone. 38 The SMB and the ACPI have separate I/O spaces. 39 We make sure that the SMB is enabled. We leave the ACPI alone. 40 41 This driver controls the SMB Host only. 42 The SMB Slave controller on the M15X3 is not enabled. 43 44 This driver does not use interrupts. 45 */ 46 47 /* Note: we assume there can only be one ALI15X3, with one SMBus interface */ 48 49 #include <linux/module.h> 50 #include <linux/pci.h> 51 #include <linux/kernel.h> 52 #include <linux/stddef.h> 53 #include <linux/ioport.h> 54 #include <linux/delay.h> 55 #include <linux/i2c.h> 56 #include <linux/acpi.h> 57 #include <linux/io.h> 58 59 /* ALI15X3 SMBus address offsets */ 60 #define SMBHSTSTS (0 + ali15x3_smba) 61 #define SMBHSTCNT (1 + ali15x3_smba) 62 #define SMBHSTSTART (2 + ali15x3_smba) 63 #define SMBHSTCMD (7 + ali15x3_smba) 64 #define SMBHSTADD (3 + ali15x3_smba) 65 #define SMBHSTDAT0 (4 + ali15x3_smba) 66 #define SMBHSTDAT1 (5 + ali15x3_smba) 67 #define SMBBLKDAT (6 + ali15x3_smba) 68 69 /* PCI Address Constants */ 70 #define SMBCOM 0x004 71 #define SMBBA 0x014 72 #define SMBATPC 0x05B /* used to unlock xxxBA registers */ 73 #define SMBHSTCFG 0x0E0 74 #define SMBSLVC 0x0E1 75 #define SMBCLK 0x0E2 76 #define SMBREV 0x008 77 78 /* Other settings */ 79 #define MAX_TIMEOUT 200 /* times 1/100 sec */ 80 #define ALI15X3_SMB_IOSIZE 32 81 82 /* this is what the Award 1004 BIOS sets them to on a ASUS P5A MB. 83 We don't use these here. If the bases aren't set to some value we 84 tell user to upgrade BIOS and we fail. 85 */ 86 #define ALI15X3_SMB_DEFAULTBASE 0xE800 87 88 /* ALI15X3 address lock bits */ 89 #define ALI15X3_LOCK 0x06 90 91 /* ALI15X3 command constants */ 92 #define ALI15X3_ABORT 0x02 93 #define ALI15X3_T_OUT 0x04 94 #define ALI15X3_QUICK 0x00 95 #define ALI15X3_BYTE 0x10 96 #define ALI15X3_BYTE_DATA 0x20 97 #define ALI15X3_WORD_DATA 0x30 98 #define ALI15X3_BLOCK_DATA 0x40 99 #define ALI15X3_BLOCK_CLR 0x80 100 101 /* ALI15X3 status register bits */ 102 #define ALI15X3_STS_IDLE 0x04 103 #define ALI15X3_STS_BUSY 0x08 104 #define ALI15X3_STS_DONE 0x10 105 #define ALI15X3_STS_DEV 0x20 /* device error */ 106 #define ALI15X3_STS_COLL 0x40 /* collision or no response */ 107 #define ALI15X3_STS_TERM 0x80 /* terminated by abort */ 108 #define ALI15X3_STS_ERR 0xE0 /* all the bad error bits */ 109 110 111 /* If force_addr is set to anything different from 0, we forcibly enable 112 the device at the given address. */ 113 static u16 force_addr; 114 module_param_hw(force_addr, ushort, ioport, 0); 115 MODULE_PARM_DESC(force_addr, 116 "Initialize the base address of the i2c controller"); 117 118 static struct pci_driver ali15x3_driver; 119 static unsigned short ali15x3_smba; 120 121 static int ali15x3_setup(struct pci_dev *ALI15X3_dev) 122 { 123 u16 a; 124 unsigned char temp; 125 126 /* Check the following things: 127 - SMB I/O address is initialized 128 - Device is enabled 129 - We can use the addresses 130 */ 131 132 /* Unlock the register. 133 The data sheet says that the address registers are read-only 134 if the lock bits are 1, but in fact the address registers 135 are zero unless you clear the lock bits. 136 */ 137 pci_read_config_byte(ALI15X3_dev, SMBATPC, &temp); 138 if (temp & ALI15X3_LOCK) { 139 temp &= ~ALI15X3_LOCK; 140 pci_write_config_byte(ALI15X3_dev, SMBATPC, temp); 141 } 142 143 /* Determine the address of the SMBus area */ 144 pci_read_config_word(ALI15X3_dev, SMBBA, &ali15x3_smba); 145 ali15x3_smba &= (0xffff & ~(ALI15X3_SMB_IOSIZE - 1)); 146 if (ali15x3_smba == 0 && force_addr == 0) { 147 dev_err(&ALI15X3_dev->dev, "ALI15X3_smb region uninitialized " 148 "- upgrade BIOS or use force_addr=0xaddr\n"); 149 return -ENODEV; 150 } 151 152 if(force_addr) 153 ali15x3_smba = force_addr & ~(ALI15X3_SMB_IOSIZE - 1); 154 155 if (acpi_check_region(ali15x3_smba, ALI15X3_SMB_IOSIZE, 156 ali15x3_driver.name)) 157 return -EBUSY; 158 159 if (!request_region(ali15x3_smba, ALI15X3_SMB_IOSIZE, 160 ali15x3_driver.name)) { 161 dev_err(&ALI15X3_dev->dev, 162 "ALI15X3_smb region 0x%x already in use!\n", 163 ali15x3_smba); 164 return -ENODEV; 165 } 166 167 if(force_addr) { 168 int ret; 169 170 dev_info(&ALI15X3_dev->dev, "forcing ISA address 0x%04X\n", 171 ali15x3_smba); 172 ret = pci_write_config_word(ALI15X3_dev, SMBBA, ali15x3_smba); 173 if (ret != PCIBIOS_SUCCESSFUL) 174 goto error; 175 ret = pci_read_config_word(ALI15X3_dev, SMBBA, &a); 176 if (ret != PCIBIOS_SUCCESSFUL) 177 goto error; 178 if ((a & ~(ALI15X3_SMB_IOSIZE - 1)) != ali15x3_smba) { 179 /* make sure it works */ 180 dev_err(&ALI15X3_dev->dev, 181 "force address failed - not supported?\n"); 182 goto error; 183 } 184 } 185 /* check if whole device is enabled */ 186 pci_read_config_byte(ALI15X3_dev, SMBCOM, &temp); 187 if ((temp & 1) == 0) { 188 dev_info(&ALI15X3_dev->dev, "enabling SMBus device\n"); 189 pci_write_config_byte(ALI15X3_dev, SMBCOM, temp | 0x01); 190 } 191 192 /* Is SMB Host controller enabled? */ 193 pci_read_config_byte(ALI15X3_dev, SMBHSTCFG, &temp); 194 if ((temp & 1) == 0) { 195 dev_info(&ALI15X3_dev->dev, "enabling SMBus controller\n"); 196 pci_write_config_byte(ALI15X3_dev, SMBHSTCFG, temp | 0x01); 197 } 198 199 /* set SMB clock to 74KHz as recommended in data sheet */ 200 pci_write_config_byte(ALI15X3_dev, SMBCLK, 0x20); 201 202 /* 203 The interrupt routing for SMB is set up in register 0x77 in the 204 1533 ISA Bridge device, NOT in the 7101 device. 205 Don't bother with finding the 1533 device and reading the register. 206 if ((....... & 0x0F) == 1) 207 dev_dbg(&ALI15X3_dev->dev, "ALI15X3 using Interrupt 9 for SMBus.\n"); 208 */ 209 pci_read_config_byte(ALI15X3_dev, SMBREV, &temp); 210 dev_dbg(&ALI15X3_dev->dev, "SMBREV = 0x%X\n", temp); 211 dev_dbg(&ALI15X3_dev->dev, "iALI15X3_smba = 0x%X\n", ali15x3_smba); 212 213 return 0; 214 error: 215 release_region(ali15x3_smba, ALI15X3_SMB_IOSIZE); 216 return -ENODEV; 217 } 218 219 /* Another internally used function */ 220 static int ali15x3_transaction(struct i2c_adapter *adap) 221 { 222 int temp; 223 int result = 0; 224 int timeout = 0; 225 226 dev_dbg(&adap->dev, "Transaction (pre): STS=%02x, CNT=%02x, CMD=%02x, " 227 "ADD=%02x, DAT0=%02x, DAT1=%02x\n", inb_p(SMBHSTSTS), 228 inb_p(SMBHSTCNT), inb_p(SMBHSTCMD), inb_p(SMBHSTADD), 229 inb_p(SMBHSTDAT0), inb_p(SMBHSTDAT1)); 230 231 /* get status */ 232 temp = inb_p(SMBHSTSTS); 233 234 /* Make sure the SMBus host is ready to start transmitting */ 235 /* Check the busy bit first */ 236 if (temp & ALI15X3_STS_BUSY) { 237 /* 238 If the host controller is still busy, it may have timed out in the 239 previous transaction, resulting in a "SMBus Timeout" Dev. 240 I've tried the following to reset a stuck busy bit. 241 1. Reset the controller with an ABORT command. 242 (this doesn't seem to clear the controller if an external 243 device is hung) 244 2. Reset the controller and the other SMBus devices with a 245 T_OUT command. (this clears the host busy bit if an 246 external device is hung, but it comes back upon a new access 247 to a device) 248 3. Disable and reenable the controller in SMBHSTCFG 249 Worst case, nothing seems to work except power reset. 250 */ 251 /* Abort - reset the host controller */ 252 /* 253 Try resetting entire SMB bus, including other devices - 254 This may not work either - it clears the BUSY bit but 255 then the BUSY bit may come back on when you try and use the chip again. 256 If that's the case you are stuck. 257 */ 258 dev_info(&adap->dev, "Resetting entire SMB Bus to " 259 "clear busy condition (%02x)\n", temp); 260 outb_p(ALI15X3_T_OUT, SMBHSTCNT); 261 temp = inb_p(SMBHSTSTS); 262 } 263 264 /* now check the error bits and the busy bit */ 265 if (temp & (ALI15X3_STS_ERR | ALI15X3_STS_BUSY)) { 266 /* do a clear-on-write */ 267 outb_p(0xFF, SMBHSTSTS); 268 if ((temp = inb_p(SMBHSTSTS)) & 269 (ALI15X3_STS_ERR | ALI15X3_STS_BUSY)) { 270 /* this is probably going to be correctable only by a power reset 271 as one of the bits now appears to be stuck */ 272 /* This may be a bus or device with electrical problems. */ 273 dev_err(&adap->dev, "SMBus reset failed! (0x%02x) - " 274 "controller or device on bus is probably hung\n", 275 temp); 276 return -EBUSY; 277 } 278 } else { 279 /* check and clear done bit */ 280 if (temp & ALI15X3_STS_DONE) { 281 outb_p(temp, SMBHSTSTS); 282 } 283 } 284 285 /* start the transaction by writing anything to the start register */ 286 outb_p(0xFF, SMBHSTSTART); 287 288 /* We will always wait for a fraction of a second! */ 289 timeout = 0; 290 do { 291 msleep(1); 292 temp = inb_p(SMBHSTSTS); 293 } while ((!(temp & (ALI15X3_STS_ERR | ALI15X3_STS_DONE))) 294 && (timeout++ < MAX_TIMEOUT)); 295 296 /* If the SMBus is still busy, we give up */ 297 if (timeout > MAX_TIMEOUT) 298 result = -ETIMEDOUT; 299 300 if (temp & ALI15X3_STS_TERM) { 301 result = -EIO; 302 dev_dbg(&adap->dev, "Error: Failed bus transaction\n"); 303 } 304 305 /* 306 Unfortunately the ALI SMB controller maps "no response" and "bus 307 collision" into a single bit. No response is the usual case so don't 308 do a printk. 309 This means that bus collisions go unreported. 310 */ 311 if (temp & ALI15X3_STS_COLL) { 312 result = -ENXIO; 313 dev_dbg(&adap->dev, 314 "Error: no response or bus collision ADD=%02x\n", 315 inb_p(SMBHSTADD)); 316 } 317 318 /* haven't ever seen this */ 319 if (temp & ALI15X3_STS_DEV) { 320 result = -EIO; 321 dev_err(&adap->dev, "Error: device error\n"); 322 } 323 dev_dbg(&adap->dev, "Transaction (post): STS=%02x, CNT=%02x, CMD=%02x, " 324 "ADD=%02x, DAT0=%02x, DAT1=%02x\n", inb_p(SMBHSTSTS), 325 inb_p(SMBHSTCNT), inb_p(SMBHSTCMD), inb_p(SMBHSTADD), 326 inb_p(SMBHSTDAT0), inb_p(SMBHSTDAT1)); 327 return result; 328 } 329 330 /* Return negative errno on error. */ 331 static s32 ali15x3_access(struct i2c_adapter * adap, u16 addr, 332 unsigned short flags, char read_write, u8 command, 333 int size, union i2c_smbus_data * data) 334 { 335 int i, len; 336 int temp; 337 int timeout; 338 339 /* clear all the bits (clear-on-write) */ 340 outb_p(0xFF, SMBHSTSTS); 341 /* make sure SMBus is idle */ 342 temp = inb_p(SMBHSTSTS); 343 for (timeout = 0; 344 (timeout < MAX_TIMEOUT) && !(temp & ALI15X3_STS_IDLE); 345 timeout++) { 346 msleep(1); 347 temp = inb_p(SMBHSTSTS); 348 } 349 if (timeout >= MAX_TIMEOUT) { 350 dev_err(&adap->dev, "Idle wait Timeout! STS=0x%02x\n", temp); 351 } 352 353 switch (size) { 354 case I2C_SMBUS_QUICK: 355 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01), 356 SMBHSTADD); 357 size = ALI15X3_QUICK; 358 break; 359 case I2C_SMBUS_BYTE: 360 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01), 361 SMBHSTADD); 362 if (read_write == I2C_SMBUS_WRITE) 363 outb_p(command, SMBHSTCMD); 364 size = ALI15X3_BYTE; 365 break; 366 case I2C_SMBUS_BYTE_DATA: 367 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01), 368 SMBHSTADD); 369 outb_p(command, SMBHSTCMD); 370 if (read_write == I2C_SMBUS_WRITE) 371 outb_p(data->byte, SMBHSTDAT0); 372 size = ALI15X3_BYTE_DATA; 373 break; 374 case I2C_SMBUS_WORD_DATA: 375 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01), 376 SMBHSTADD); 377 outb_p(command, SMBHSTCMD); 378 if (read_write == I2C_SMBUS_WRITE) { 379 outb_p(data->word & 0xff, SMBHSTDAT0); 380 outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1); 381 } 382 size = ALI15X3_WORD_DATA; 383 break; 384 case I2C_SMBUS_BLOCK_DATA: 385 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01), 386 SMBHSTADD); 387 outb_p(command, SMBHSTCMD); 388 if (read_write == I2C_SMBUS_WRITE) { 389 len = data->block[0]; 390 if (len < 0) { 391 len = 0; 392 data->block[0] = len; 393 } 394 if (len > 32) { 395 len = 32; 396 data->block[0] = len; 397 } 398 outb_p(len, SMBHSTDAT0); 399 /* Reset SMBBLKDAT */ 400 outb_p(inb_p(SMBHSTCNT) | ALI15X3_BLOCK_CLR, SMBHSTCNT); 401 for (i = 1; i <= len; i++) 402 outb_p(data->block[i], SMBBLKDAT); 403 } 404 size = ALI15X3_BLOCK_DATA; 405 break; 406 default: 407 dev_warn(&adap->dev, "Unsupported transaction %d\n", size); 408 return -EOPNOTSUPP; 409 } 410 411 outb_p(size, SMBHSTCNT); /* output command */ 412 413 temp = ali15x3_transaction(adap); 414 if (temp) 415 return temp; 416 417 if ((read_write == I2C_SMBUS_WRITE) || (size == ALI15X3_QUICK)) 418 return 0; 419 420 421 switch (size) { 422 case ALI15X3_BYTE: /* Result put in SMBHSTDAT0 */ 423 data->byte = inb_p(SMBHSTDAT0); 424 break; 425 case ALI15X3_BYTE_DATA: 426 data->byte = inb_p(SMBHSTDAT0); 427 break; 428 case ALI15X3_WORD_DATA: 429 data->word = inb_p(SMBHSTDAT0) + (inb_p(SMBHSTDAT1) << 8); 430 break; 431 case ALI15X3_BLOCK_DATA: 432 len = inb_p(SMBHSTDAT0); 433 if (len > 32) 434 len = 32; 435 data->block[0] = len; 436 /* Reset SMBBLKDAT */ 437 outb_p(inb_p(SMBHSTCNT) | ALI15X3_BLOCK_CLR, SMBHSTCNT); 438 for (i = 1; i <= data->block[0]; i++) { 439 data->block[i] = inb_p(SMBBLKDAT); 440 dev_dbg(&adap->dev, "Blk: len=%d, i=%d, data=%02x\n", 441 len, i, data->block[i]); 442 } 443 break; 444 } 445 return 0; 446 } 447 448 static u32 ali15x3_func(struct i2c_adapter *adapter) 449 { 450 return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE | 451 I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA | 452 I2C_FUNC_SMBUS_BLOCK_DATA; 453 } 454 455 static const struct i2c_algorithm smbus_algorithm = { 456 .smbus_xfer = ali15x3_access, 457 .functionality = ali15x3_func, 458 }; 459 460 static struct i2c_adapter ali15x3_adapter = { 461 .owner = THIS_MODULE, 462 .class = I2C_CLASS_HWMON, 463 .algo = &smbus_algorithm, 464 }; 465 466 static const struct pci_device_id ali15x3_ids[] = { 467 { PCI_DEVICE(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M7101) }, 468 { 0, } 469 }; 470 471 MODULE_DEVICE_TABLE (pci, ali15x3_ids); 472 473 static int ali15x3_probe(struct pci_dev *dev, const struct pci_device_id *id) 474 { 475 if (ali15x3_setup(dev)) { 476 dev_err(&dev->dev, 477 "ALI15X3 not detected, module not inserted.\n"); 478 return -ENODEV; 479 } 480 481 /* set up the sysfs linkage to our parent device */ 482 ali15x3_adapter.dev.parent = &dev->dev; 483 484 snprintf(ali15x3_adapter.name, sizeof(ali15x3_adapter.name), 485 "SMBus ALI15X3 adapter at %04x", ali15x3_smba); 486 return i2c_add_adapter(&ali15x3_adapter); 487 } 488 489 static void ali15x3_remove(struct pci_dev *dev) 490 { 491 i2c_del_adapter(&ali15x3_adapter); 492 release_region(ali15x3_smba, ALI15X3_SMB_IOSIZE); 493 } 494 495 static struct pci_driver ali15x3_driver = { 496 .name = "ali15x3_smbus", 497 .id_table = ali15x3_ids, 498 .probe = ali15x3_probe, 499 .remove = ali15x3_remove, 500 }; 501 502 module_pci_driver(ali15x3_driver); 503 504 MODULE_AUTHOR("Frodo Looijaard <frodol@dds.nl>"); 505 MODULE_AUTHOR("Philip Edelbrock <phil@netroedge.com>"); 506 MODULE_AUTHOR("Mark D. Studebaker <mdsxyz123@yahoo.com>"); 507 MODULE_DESCRIPTION("ALI15X3 SMBus driver"); 508 MODULE_LICENSE("GPL"); 509