drivers/i2c/busses/i2c-piix4.c

   1 /*
   2     piix4.c - Part of lm_sensors, Linux kernel modules for hardware
   3               monitoring
   4     Copyright (c) 1998 - 2002 Frodo Looijaard <frodol@dds.nl> and
   5     Philip Edelbrock <phil@netroedge.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    Supports:
  24         Intel PIIX4, 440MX
  25         Serverworks OSB4, CSB5
  26         SMSC Victory66
  27
  28    Note: we assume there can only be one device, with one SMBus interface.
  29 */
  30
  31 /* #define DEBUG 1 */
  32
  33 #include <linux/module.h>
  34 #include <linux/config.h>
  35 #include <linux/pci.h>
  36 #include <linux/kernel.h>
  37 #include <linux/stddef.h>
  38 #include <linux/sched.h>
  39 #include <linux/ioport.h>
  40 #include <linux/i2c.h>
  41 #include <linux/init.h>
  42 #include <linux/apm_bios.h>
  43 #include <asm/io.h>
  44
  45
  46 struct sd {
  47         const unsigned short mfr;
  48         const unsigned short dev;
  49         const unsigned char fn;
  50         const char *name;
  51 };
  52
  53 /* PIIX4 SMBus address offsets */
  54 #define SMBHSTSTS       (0 + piix4_smba)
  55 #define SMBHSLVSTS      (1 + piix4_smba)
  56 #define SMBHSTCNT       (2 + piix4_smba)
  57 #define SMBHSTCMD       (3 + piix4_smba)
  58 #define SMBHSTADD       (4 + piix4_smba)
  59 #define SMBHSTDAT0      (5 + piix4_smba)
  60 #define SMBHSTDAT1      (6 + piix4_smba)
  61 #define SMBBLKDAT       (7 + piix4_smba)
  62 #define SMBSLVCNT       (8 + piix4_smba)
  63 #define SMBSHDWCMD      (9 + piix4_smba)
  64 #define SMBSLVEVT       (0xA + piix4_smba)
  65 #define SMBSLVDAT       (0xC + piix4_smba)
  66
  67 /* PCI Address Constants */
  68 #define SMBBA           0x090
  69 #define SMBHSTCFG       0x0D2
  70 #define SMBSLVC         0x0D3
  71 #define SMBSHDW1        0x0D4
  72 #define SMBSHDW2        0x0D5
  73 #define SMBREV          0x0D6
  74
  75 /* Other settings */
  76 #define MAX_TIMEOUT     500
  77 #define  ENABLE_INT9    0
  78
  79 /* PIIX4 constants */
  80 #define PIIX4_QUICK             0x00
  81 #define PIIX4_BYTE              0x04
  82 #define PIIX4_BYTE_DATA         0x08
  83 #define PIIX4_WORD_DATA         0x0C
  84 #define PIIX4_BLOCK_DATA        0x14
  85
  86 /* insmod parameters */
  87
  88 /* If force is set to anything different from 0, we forcibly enable the
  89    PIIX4. DANGEROUS! */
  90 static int force = 0;
  91 MODULE_PARM(force, "i");
  92 MODULE_PARM_DESC(force, "Forcibly enable the PIIX4. DANGEROUS!");
  93
  94 /* If force_addr is set to anything different from 0, we forcibly enable
  95    the PIIX4 at the given address. VERY DANGEROUS! */
  96 static int force_addr = 0;
  97 MODULE_PARM(force_addr, "i");
  98 MODULE_PARM_DESC(force_addr,
  99                  "Forcibly enable the PIIX4 at the given address. "
 100                  "EXTREMELY DANGEROUS!");
 101
 102 static int piix4_transaction(void);
 103
 104
 105 static unsigned short piix4_smba = 0;
 106 static struct i2c_adapter piix4_adapter;
 107
 108 /*
 109  * Get DMI information.
 110  */
 111 static int ibm_dmi_probe(void)
 112 {
 113 #ifdef CONFIG_X86
 114         extern int is_unsafe_smbus;
 115         return is_unsafe_smbus;
 116 #else
 117         return 0;
 118 #endif
 119 }
 120
 121 static int piix4_setup(struct pci_dev *PIIX4_dev, const struct pci_device_id *id)
 122 {
 123         int error_return = 0;
 124         unsigned char temp;
 125
 126         /* match up the function */
 127         if (PCI_FUNC(PIIX4_dev->devfn) != id->driver_data)
 128                 return -ENODEV;
 129
 130         dev_info(&PIIX4_dev->dev, "Found %s device\n", pci_name(PIIX4_dev));
 131
 132         if(ibm_dmi_probe()) {
 133                 dev_err(&PIIX4_dev->dev, "IBM Laptop detected; this module "
 134                         "may corrupt your serial eeprom! Refusing to load "
 135                         "module!\n");
 136                 error_return = -EPERM;
 137                 goto END;
 138         }
 139
 140         /* Determine the address of the SMBus areas */
 141         if (force_addr) {
 142                 piix4_smba = force_addr & 0xfff0;
 143                 force = 0;
 144         } else {
 145                 pci_read_config_word(PIIX4_dev, SMBBA, &piix4_smba);
 146                 piix4_smba &= 0xfff0;
 147                 if(piix4_smba == 0) {
 148                         dev_err(&PIIX4_dev->dev, "SMB base address "
 149                                 "uninitialized - upgrade BIOS or use "
 150                                 "force_addr=0xaddr\n");
 151                         return -ENODEV;
 152                 }
 153         }
 154
 155         if (!request_region(piix4_smba, 8, "piix4-smbus")) {
 156                 dev_err(&PIIX4_dev->dev, "SMB region 0x%x already in use!\n",
 157                         piix4_smba);
 158                 error_return = -ENODEV;
 159                 goto END;
 160         }
 161
 162         pci_read_config_byte(PIIX4_dev, SMBHSTCFG, &temp);
 163         /* If force_addr is set, we program the new address here. Just to make
 164            sure, we disable the PIIX4 first. */
 165         if (force_addr) {
 166                 pci_write_config_byte(PIIX4_dev, SMBHSTCFG, temp & 0xfe);
 167                 pci_write_config_word(PIIX4_dev, SMBBA, piix4_smba);
 168                 pci_write_config_byte(PIIX4_dev, SMBHSTCFG, temp | 0x01);
 169                 dev_info(&PIIX4_dev->dev, "WARNING: SMBus interface set to "
 170                         "new address %04x!\n", piix4_smba);
 171         } else if ((temp & 1) == 0) {
 172                 if (force) {
 173                         /* This should never need to be done, but has been
 174                          * noted that many Dell machines have the SMBus
 175                          * interface on the PIIX4 disabled!? NOTE: This assumes
 176                          * I/O space and other allocations WERE done by the
 177                          * Bios!  Don't complain if your hardware does weird
 178                          * things after enabling this. :') Check for Bios
 179                          * updates before resorting to this.
 180                          */
 181                         pci_write_config_byte(PIIX4_dev, SMBHSTCFG,
 182                                               temp | 1);
 183                         dev_printk(KERN_NOTICE, &PIIX4_dev->dev,
 184                                 "WARNING: SMBus interface has been "
 185                                 "FORCEFULLY ENABLED!\n");
 186                 } else {
 187                         dev_err(&PIIX4_dev->dev,
 188                                 "Host SMBus controller not enabled!\n");
 189                         error_return = -ENODEV;
 190                         goto END;
 191                 }
 192         }
 193
 194         if ((temp & 0x0E) == 8)
 195                 dev_dbg(&PIIX4_dev->dev, "Using Interrupt 9 for SMBus.\n");
 196         else if ((temp & 0x0E) == 0)
 197                 dev_dbg(&PIIX4_dev->dev, "Using Interrupt SMI# for SMBus.\n");
 198         else
 199                 dev_err(&PIIX4_dev->dev, "Illegal Interrupt configuration "
 200                         "(or code out of date)!\n");
 201
 202         pci_read_config_byte(PIIX4_dev, SMBREV, &temp);
 203         dev_dbg(&PIIX4_dev->dev, "SMBREV = 0x%X\n", temp);
 204         dev_dbg(&PIIX4_dev->dev, "SMBA = 0x%X\n", piix4_smba);
 205
 206 END:
 207         return error_return;
 208 }
 209
 210 /* Another internally used function */
 211 static int piix4_transaction(void)
 212 {
 213         int temp;
 214         int result = 0;
 215         int timeout = 0;
 216
 217         dev_dbg(&piix4_adapter.dev, "Transaction (pre): CNT=%02x, CMD=%02x, "
 218                 "ADD=%02x, DAT0=%02x, DAT1=%02x\n", inb_p(SMBHSTCNT),
 219                 inb_p(SMBHSTCMD), inb_p(SMBHSTADD), inb_p(SMBHSTDAT0),
 220                 inb_p(SMBHSTDAT1));
 221
 222         /* Make sure the SMBus host is ready to start transmitting */
 223         if ((temp = inb_p(SMBHSTSTS)) != 0x00) {
 224                 dev_dbg(&piix4_adapter.dev, "SMBus busy (%02x). "
 225                         "Resetting... \n", temp);
 226                 outb_p(temp, SMBHSTSTS);
 227                 if ((temp = inb_p(SMBHSTSTS)) != 0x00) {
 228                         dev_err(&piix4_adapter.dev, "Failed! (%02x)\n", temp);
 229                         return -1;
 230                 } else {
 231                         dev_dbg(&piix4_adapter.dev, "Successfull!\n");
 232                 }
 233         }
 234
 235         /* start the transaction by setting bit 6 */
 236         outb_p(inb(SMBHSTCNT) | 0x040, SMBHSTCNT);
 237
 238         /* We will always wait for a fraction of a second! (See PIIX4 docs errata) */
 239         do {
 240                 i2c_delay(1);
 241                 temp = inb_p(SMBHSTSTS);
 242         } while ((temp & 0x01) && (timeout++ < MAX_TIMEOUT));
 243
 244         /* If the SMBus is still busy, we give up */
 245         if (timeout >= MAX_TIMEOUT) {
 246                 dev_err(&piix4_adapter.dev, "SMBus Timeout!\n");
 247                 result = -1;
 248         }
 249
 250         if (temp & 0x10) {
 251                 result = -1;
 252                 dev_err(&piix4_adapter.dev, "Error: Failed bus transaction\n");
 253         }
 254
 255         if (temp & 0x08) {
 256                 result = -1;
 257                 dev_dbg(&piix4_adapter.dev, "Bus collision! SMBus may be "
 258                         "locked until next hard reset. (sorry!)\n");
 259                 /* Clock stops and slave is stuck in mid-transmission */
 260         }
 261
 262         if (temp & 0x04) {
 263                 result = -1;
 264                 dev_dbg(&piix4_adapter.dev, "Error: no response!\n");
 265         }
 266
 267         if (inb_p(SMBHSTSTS) != 0x00)
 268                 outb_p(inb(SMBHSTSTS), SMBHSTSTS);
 269
 270         if ((temp = inb_p(SMBHSTSTS)) != 0x00) {
 271                 dev_err(&piix4_adapter.dev, "Failed reset at end of "
 272                         "transaction (%02x)\n", temp);
 273         }
 274         dev_dbg(&piix4_adapter.dev, "Transaction (post): CNT=%02x, CMD=%02x, "
 275                 "ADD=%02x, DAT0=%02x, DAT1=%02x\n", inb_p(SMBHSTCNT),
 276                 inb_p(SMBHSTCMD), inb_p(SMBHSTADD), inb_p(SMBHSTDAT0),
 277                 inb_p(SMBHSTDAT1));
 278         return result;
 279 }
 280
 281 /* Return -1 on error. */
 282 static s32 piix4_access(struct i2c_adapter * adap, u16 addr,
 283                  unsigned short flags, char read_write,
 284                  u8 command, int size, union i2c_smbus_data * data)
 285 {
 286         int i, len;
 287
 288         switch (size) {
 289         case I2C_SMBUS_PROC_CALL:
 290                 dev_err(&adap->dev, "I2C_SMBUS_PROC_CALL not supported!\n");
 291                 return -1;
 292         case I2C_SMBUS_QUICK:
 293                 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
 294                        SMBHSTADD);
 295                 size = PIIX4_QUICK;
 296                 break;
 297         case I2C_SMBUS_BYTE:
 298                 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
 299                        SMBHSTADD);
 300                 if (read_write == I2C_SMBUS_WRITE)
 301                         outb_p(command, SMBHSTCMD);
 302                 size = PIIX4_BYTE;
 303                 break;
 304         case I2C_SMBUS_BYTE_DATA:
 305                 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
 306                        SMBHSTADD);
 307                 outb_p(command, SMBHSTCMD);
 308                 if (read_write == I2C_SMBUS_WRITE)
 309                         outb_p(data->byte, SMBHSTDAT0);
 310                 size = PIIX4_BYTE_DATA;
 311                 break;
 312         case I2C_SMBUS_WORD_DATA:
 313                 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
 314                        SMBHSTADD);
 315                 outb_p(command, SMBHSTCMD);
 316                 if (read_write == I2C_SMBUS_WRITE) {
 317                         outb_p(data->word & 0xff, SMBHSTDAT0);
 318                         outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1);
 319                 }
 320                 size = PIIX4_WORD_DATA;
 321                 break;
 322         case I2C_SMBUS_BLOCK_DATA:
 323                 outb_p(((addr & 0x7f) << 1) | (read_write & 0x01),
 324                        SMBHSTADD);
 325                 outb_p(command, SMBHSTCMD);
 326                 if (read_write == I2C_SMBUS_WRITE) {
 327                         len = data->block[0];
 328                         if (len < 0)
 329                                 len = 0;
 330                         if (len > 32)
 331                                 len = 32;
 332                         outb_p(len, SMBHSTDAT0);
 333                         i = inb_p(SMBHSTCNT);   /* Reset SMBBLKDAT */
 334                         for (i = 1; i <= len; i++)
 335                                 outb_p(data->block[i], SMBBLKDAT);
 336                 }
 337                 size = PIIX4_BLOCK_DATA;
 338                 break;
 339         }
 340
 341         outb_p((size & 0x1C) + (ENABLE_INT9 & 1), SMBHSTCNT);
 342
 343         if (piix4_transaction())        /* Error in transaction */
 344                 return -1;
 345
 346         if ((read_write == I2C_SMBUS_WRITE) || (size == PIIX4_QUICK))
 347                 return 0;
 348
 349
 350         switch (size) {
 351         case PIIX4_BYTE:        /* Where is the result put? I assume here it is in
 352                                    SMBHSTDAT0 but it might just as well be in the
 353                                    SMBHSTCMD. No clue in the docs */
 354
 355                 data->byte = inb_p(SMBHSTDAT0);
 356                 break;
 357         case PIIX4_BYTE_DATA:
 358                 data->byte = inb_p(SMBHSTDAT0);
 359                 break;
 360         case PIIX4_WORD_DATA:
 361                 data->word = inb_p(SMBHSTDAT0) + (inb_p(SMBHSTDAT1) << 8);
 362                 break;
 363         case PIIX4_BLOCK_DATA:
 364                 data->block[0] = inb_p(SMBHSTDAT0);
 365                 i = inb_p(SMBHSTCNT);   /* Reset SMBBLKDAT */
 366                 for (i = 1; i <= data->block[0]; i++)
 367                         data->block[i] = inb_p(SMBBLKDAT);
 368                 break;
 369         }
 370         return 0;
 371 }
 372
 373 static u32 piix4_func(struct i2c_adapter *adapter)
 374 {
 375         return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
 376             I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
 377             I2C_FUNC_SMBUS_BLOCK_DATA;
 378 }
 379
 380 static struct i2c_algorithm smbus_algorithm = {
 381         .name           = "Non-I2C SMBus adapter",
 382         .id             = I2C_ALGO_SMBUS,
 383         .smbus_xfer     = piix4_access,
 384         .functionality  = piix4_func,
 385 };
 386
 387 static struct i2c_adapter piix4_adapter = {
 388         .owner          = THIS_MODULE,
 389         .id             = I2C_ALGO_SMBUS | I2C_HW_SMBUS_PIIX4,
 390         .class          = I2C_ADAP_CLASS_SMBUS,
 391         .algo           = &smbus_algorithm,
 392         .name           = "unset",
 393 };
 394
 395 static struct pci_device_id piix4_ids[] = {
 396         {
 397                 .vendor =       PCI_VENDOR_ID_INTEL,
 398                 .device =       PCI_DEVICE_ID_INTEL_82371AB_3,
 399                 .subvendor =    PCI_ANY_ID,
 400                 .subdevice =    PCI_ANY_ID,
 401                 .driver_data =  3
 402         },
 403         {
 404                 .vendor =       PCI_VENDOR_ID_SERVERWORKS,
 405                 .device =       PCI_DEVICE_ID_SERVERWORKS_OSB4,
 406                 .subvendor =    PCI_ANY_ID,
 407                 .subdevice =    PCI_ANY_ID,
 408                 .driver_data =  0,
 409         },
 410         {
 411                 .vendor =       PCI_VENDOR_ID_SERVERWORKS,
 412                 .device =       PCI_DEVICE_ID_SERVERWORKS_CSB5,
 413                 .subvendor =    PCI_ANY_ID,
 414                 .subdevice =    PCI_ANY_ID,
 415                 .driver_data =  0,
 416         },
 417         {
 418                 .vendor =       PCI_VENDOR_ID_INTEL,
 419                 .device =       PCI_DEVICE_ID_INTEL_82443MX_3,
 420                 .subvendor =    PCI_ANY_ID,
 421                 .subdevice =    PCI_ANY_ID,
 422                 .driver_data =  3,
 423         },
 424         {
 425                 .vendor =       PCI_VENDOR_ID_EFAR,
 426                 .device =       PCI_DEVICE_ID_EFAR_SLC90E66_3,
 427                 .subvendor =    PCI_ANY_ID,
 428                 .subdevice =    PCI_ANY_ID,
 429                 .driver_data =  0,
 430         },
 431         { 0, }
 432 };
 433
 434 static int __devinit piix4_probe(struct pci_dev *dev, const struct pci_device_id *id)
 435 {
 436         int retval;
 437
 438         retval = piix4_setup(dev, id);
 439         if (retval)
 440                 return retval;
 441
 442         /* set up the driverfs linkage to our parent device */
 443         piix4_adapter.dev.parent = &dev->dev;
 444
 445         snprintf(piix4_adapter.name, DEVICE_NAME_SIZE,
 446                 "SMBus PIIX4 adapter at %04x", piix4_smba);
 447
 448         retval = i2c_add_adapter(&piix4_adapter);
 449
 450         return retval;
 451 }
 452
 453 static void __devexit piix4_remove(struct pci_dev *dev)
 454 {
 455         i2c_del_adapter(&piix4_adapter);
 456 }
 457
 458
 459 static struct pci_driver piix4_driver = {
 460         .name           = "piix4-smbus",
 461         .id_table       = piix4_ids,
 462         .probe          = piix4_probe,
 463         .remove         = __devexit_p(piix4_remove),
 464 };
 465
 466 static int __init i2c_piix4_init(void)
 467 {
 468         printk(KERN_INFO "i2c-piix4 version %s (%s)\n", I2C_VERSION, I2C_DATE);
 469         return pci_module_init(&piix4_driver);
 470 }
 471
 472
 473 static void __exit i2c_piix4_exit(void)
 474 {
 475         pci_unregister_driver(&piix4_driver);
 476         release_region(piix4_smba, 8);
 477 }
 478
 479 MODULE_AUTHOR
 480     ("Frodo Looijaard <frodol@dds.nl> and Philip Edelbrock <phil@netroedge.com>");
 481 MODULE_DESCRIPTION("PIIX4 SMBus driver");
 482 MODULE_LICENSE("GPL");
 483
 484 module_init(i2c_piix4_init);
 485 module_exit(i2c_piix4_exit);