SAFE public projects git trees. - safe/jmp/linux-2.6/blob - drivers/i2c/busses/i2c-viapro.c

   1 /*
   2     i2c-viapro.c - Part of lm_sensors, Linux kernel modules for hardware
   3               monitoring
   4     Copyright (c) 1998 - 2002  Frodo Looijaard <frodol@dds.nl>,
   5     Philip Edelbrock <phil@netroedge.com>, Kyösti Mälkki <kmalkki@cc.hut.fi>,
   6     Mark D. Studebaker <mdsxyz123@yahoo.com>
   7     Copyright (C) 2005  Jean Delvare <khali@linux-fr.org>
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17     GNU General Public License for more details.
  18
  19     You should have received a copy of the GNU General Public License
  20     along with this program; if not, write to the Free Software
  21     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 /*
  25    Supports the following VIA south bridges:
  26
  27    Chip name          PCI ID  REV     I2C block
  28    VT82C596A          0x3050             no
  29    VT82C596B          0x3051             no
  30    VT82C686A          0x3057  0x30       no
  31    VT82C686B          0x3057  0x40       yes
  32    VT8231             0x8235             no?
  33    VT8233             0x3074             yes
  34    VT8233A            0x3147             yes?
  35    VT8235             0x3177             yes
  36    VT8237R            0x3227             yes
  37
  38    Note: we assume there can only be one device, with one SMBus interface.
  39 */
  40
  41 #include <linux/module.h>
  42 #include <linux/delay.h>
  43 #include <linux/pci.h>
  44 #include <linux/kernel.h>
  45 #include <linux/stddef.h>
  46 #include <linux/ioport.h>
  47 #include <linux/i2c.h>
  48 #include <linux/init.h>
  49 #include <asm/io.h>
  50
  51 static struct pci_dev *vt596_pdev;
  52
  53 #define SMBBA1          0x90
  54 #define SMBBA2          0x80
  55 #define SMBBA3          0xD0
  56
  57 /* SMBus address offsets */
  58 static unsigned short vt596_smba;
  59 #define SMBHSTSTS       (vt596_smba + 0)
  60 #define SMBHSTCNT       (vt596_smba + 2)
  61 #define SMBHSTCMD       (vt596_smba + 3)
  62 #define SMBHSTADD       (vt596_smba + 4)
  63 #define SMBHSTDAT0      (vt596_smba + 5)
  64 #define SMBHSTDAT1      (vt596_smba + 6)
  65 #define SMBBLKDAT       (vt596_smba + 7)
  66
  67 /* PCI Address Constants */
  68
  69 /* SMBus data in configuration space can be found in two places,
  70    We try to select the better one */
  71
  72 static unsigned short SMBHSTCFG = 0xD2;
  73
  74 /* Other settings */
  75 #define MAX_TIMEOUT     500
  76
  77 /* VT82C596 constants */
  78 #define VT596_QUICK             0x00
  79 #define VT596_BYTE              0x04
  80 #define VT596_BYTE_DATA         0x08
  81 #define VT596_WORD_DATA         0x0C
  82 #define VT596_BLOCK_DATA        0x14
  83 #define VT596_I2C_BLOCK_DATA    0x34
  84
  85
  86 /* If force is set to anything different from 0, we forcibly enable the
  87    VT596. DANGEROUS! */
  88 static int force;
  89 module_param(force, bool, 0);
  90 MODULE_PARM_DESC(force, "Forcibly enable the SMBus. DANGEROUS!");
  91
  92 /* If force_addr is set to anything different from 0, we forcibly enable
  93    the VT596 at the given address. VERY DANGEROUS! */
  94 static u16 force_addr;
  95 module_param(force_addr, ushort, 0);
  96 MODULE_PARM_DESC(force_addr,
  97                  "Forcibly enable the SMBus at the given address. "
  98                  "EXTREMELY DANGEROUS!");
  99
 100
 101 static struct pci_driver vt596_driver;
 102 static struct i2c_adapter vt596_adapter;
 103
 104 #define FEATURE_I2CBLOCK        (1<<0)
 105 static unsigned int vt596_features;
 106
 107 #ifdef DEBUG
 108 static void vt596_dump_regs(const char *msg, u8 size)
 109 {
 110         dev_dbg(&vt596_adapter.dev, "%s: STS=%02x CNT=%02x CMD=%02x ADD=%02x "
 111                 "DAT=%02x,%02x\n", msg, inb_p(SMBHSTSTS), inb_p(SMBHSTCNT),
 112                 inb_p(SMBHSTCMD), inb_p(SMBHSTADD), inb_p(SMBHSTDAT0),
 113                 inb_p(SMBHSTDAT1));
 114
 115         if (size == VT596_BLOCK_DATA
 116          || size == VT596_I2C_BLOCK_DATA) {
 117                 int i;
 118
 119                 dev_dbg(&vt596_adapter.dev, "BLK=");
 120                 for (i = 0; i < I2C_SMBUS_BLOCK_MAX / 2; i++)
 121                         printk("%02x,", inb_p(SMBBLKDAT));
 122                 printk("\n");
 123                 dev_dbg(&vt596_adapter.dev, "    ");
 124                 for (; i < I2C_SMBUS_BLOCK_MAX - 1; i++)
 125                         printk("%02x,", inb_p(SMBBLKDAT));
 126                 printk("%02x\n", inb_p(SMBBLKDAT));
 127         }
 128 }
 129 #endif
 130
 131 /* Return -1 on error, 0 on success */
 132 static int vt596_transaction(u8 size)
 133 {
 134         int temp;
 135         int result = 0;
 136         int timeout = 0;
 137
 138 #ifdef DEBUG
 139         vt596_dump_regs("Transaction (pre)", size);
 140 #endif
 141
 142         /* Make sure the SMBus host is ready to start transmitting */
 143         if ((temp = inb_p(SMBHSTSTS)) & 0x1F) {
 144                 dev_dbg(&vt596_adapter.dev, "SMBus busy (0x%02x). "
 145                         "Resetting... ", temp);
 146
 147                 outb_p(temp, SMBHSTSTS);
 148                 if ((temp = inb_p(SMBHSTSTS)) & 0x1F) {
 149                         printk("Failed! (0x%02x)\n", temp);
 150                         return -1;
 151                 } else {
 152                         printk("Successful!\n");
 153                 }
 154         }
 155
 156         /* Start the transaction by setting bit 6 */
 157         outb_p(0x40 | (size & 0x3C), SMBHSTCNT);
 158
 159         /* We will always wait for a fraction of a second */
 160         do {
 161                 msleep(1);
 162                 temp = inb_p(SMBHSTSTS);
 163         } while ((temp & 0x01) && (timeout++ < MAX_TIMEOUT));
 164
 165         /* If the SMBus is still busy, we give up */
 166         if (timeout >= MAX_TIMEOUT) {
 167                 result = -1;
 168                 dev_err(&vt596_adapter.dev, "SMBus timeout!\n");
 169         }
 170
 171         if (temp & 0x10) {
 172                 result = -1;
 173                 dev_err(&vt596_adapter.dev, "Transaction failed (0x%02x)\n",
 174                         inb_p(SMBHSTCNT) & 0x3C);
 175         }
 176
 177         if (temp & 0x08) {
 178                 result = -1;
 179                 dev_err(&vt596_adapter.dev, "SMBus collision!\n");
 180         }
 181
 182         if (temp & 0x04) {
 183                 result = -1;
 184                 /* Quick commands are used to probe for chips, so
 185                    errors are expected, and we don't want to frighten the
 186                    user. */
 187                 if ((inb_p(SMBHSTCNT) & 0x3C) != VT596_QUICK)
 188                         dev_err(&vt596_adapter.dev, "Transaction error!\n");
 189         }
 190
 191         /* Resetting status register */
 192         if (temp & 0x1F)
 193                 outb_p(temp, SMBHSTSTS);
 194
 195 #ifdef DEBUG
 196         vt596_dump_regs("Transaction (post)", size);
 197 #endif
 198
 199         return result;
 200 }
 201
 202 /* Return -1 on error, 0 on success */
 203 static s32 vt596_access(struct i2c_adapter *adap, u16 addr,
 204                 unsigned short flags, char read_write, u8 command,
 205                 int size, union i2c_smbus_data *data)
 206 {
 207         int i;
 208
 209         switch (size) {
 210         case I2C_SMBUS_QUICK:
 211                 size = VT596_QUICK;
 212                 break;
 213         case I2C_SMBUS_BYTE:
 214                 if (read_write == I2C_SMBUS_WRITE)
 215                         outb_p(command, SMBHSTCMD);
 216                 size = VT596_BYTE;
 217                 break;
 218         case I2C_SMBUS_BYTE_DATA:
 219                 outb_p(command, SMBHSTCMD);
 220                 if (read_write == I2C_SMBUS_WRITE)
 221                         outb_p(data->byte, SMBHSTDAT0);
 222                 size = VT596_BYTE_DATA;
 223                 break;
 224         case I2C_SMBUS_WORD_DATA:
 225                 outb_p(command, SMBHSTCMD);
 226                 if (read_write == I2C_SMBUS_WRITE) {
 227                         outb_p(data->word & 0xff, SMBHSTDAT0);
 228                         outb_p((data->word & 0xff00) >> 8, SMBHSTDAT1);
 229                 }
 230                 size = VT596_WORD_DATA;
 231                 break;
 232         case I2C_SMBUS_I2C_BLOCK_DATA:
 233                 if (!(vt596_features & FEATURE_I2CBLOCK))
 234                         goto exit_unsupported;
 235                 if (read_write == I2C_SMBUS_READ)
 236                         outb_p(I2C_SMBUS_BLOCK_MAX, SMBHSTDAT0);
 237                 /* Fall through */
 238         case I2C_SMBUS_BLOCK_DATA:
 239                 outb_p(command, SMBHSTCMD);
 240                 if (read_write == I2C_SMBUS_WRITE) {
 241                         u8 len = data->block[0];
 242                         if (len > I2C_SMBUS_BLOCK_MAX)
 243                                 len = I2C_SMBUS_BLOCK_MAX;
 244                         outb_p(len, SMBHSTDAT0);
 245                         inb_p(SMBHSTCNT);       /* Reset SMBBLKDAT */
 246                         for (i = 1; i <= len; i++)
 247                                 outb_p(data->block[i], SMBBLKDAT);
 248                 }
 249                 size = (size == I2C_SMBUS_I2C_BLOCK_DATA) ?
 250                        VT596_I2C_BLOCK_DATA : VT596_BLOCK_DATA;
 251                 break;
 252         default:
 253                 goto exit_unsupported;
 254         }
 255
 256         outb_p(((addr & 0x7f) << 1) | read_write, SMBHSTADD);
 257
 258         if (vt596_transaction(size)) /* Error in transaction */
 259                 return -1;
 260
 261         if ((read_write == I2C_SMBUS_WRITE) || (size == VT596_QUICK))
 262                 return 0;
 263
 264         switch (size) {
 265         case VT596_BYTE:
 266         case VT596_BYTE_DATA:
 267                 data->byte = inb_p(SMBHSTDAT0);
 268                 break;
 269         case VT596_WORD_DATA:
 270                 data->word = inb_p(SMBHSTDAT0) + (inb_p(SMBHSTDAT1) << 8);
 271                 break;
 272         case VT596_I2C_BLOCK_DATA:
 273         case VT596_BLOCK_DATA:
 274                 data->block[0] = inb_p(SMBHSTDAT0);
 275                 if (data->block[0] > I2C_SMBUS_BLOCK_MAX)
 276                         data->block[0] = I2C_SMBUS_BLOCK_MAX;
 277                 inb_p(SMBHSTCNT);       /* Reset SMBBLKDAT */
 278                 for (i = 1; i <= data->block[0]; i++)
 279                         data->block[i] = inb_p(SMBBLKDAT);
 280                 break;
 281         }
 282         return 0;
 283
 284 exit_unsupported:
 285         dev_warn(&vt596_adapter.dev, "Unsupported command invoked! (0x%02x)\n",
 286                  size);
 287         return -1;
 288 }
 289
 290 static u32 vt596_func(struct i2c_adapter *adapter)
 291 {
 292         u32 func = I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
 293             I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
 294             I2C_FUNC_SMBUS_BLOCK_DATA;
 295
 296         if (vt596_features & FEATURE_I2CBLOCK)
 297                 func |= I2C_FUNC_SMBUS_I2C_BLOCK;
 298         return func;
 299 }
 300
 301 static struct i2c_algorithm smbus_algorithm = {
 302         .smbus_xfer     = vt596_access,
 303         .functionality  = vt596_func,
 304 };
 305
 306 static struct i2c_adapter vt596_adapter = {
 307         .owner          = THIS_MODULE,
 308         .class          = I2C_CLASS_HWMON,
 309         .algo           = &smbus_algorithm,
 310 };
 311
 312 static int __devinit vt596_probe(struct pci_dev *pdev,
 313                                  const struct pci_device_id *id)
 314 {
 315         unsigned char temp;
 316         int error = -ENODEV;
 317
 318         /* Determine the address of the SMBus areas */
 319         if (force_addr) {
 320                 vt596_smba = force_addr & 0xfff0;
 321                 force = 0;
 322                 goto found;
 323         }
 324
 325         if ((pci_read_config_word(pdev, id->driver_data, &vt596_smba)) ||
 326             !(vt596_smba & 0x0001)) {
 327                 /* try 2nd address and config reg. for 596 */
 328                 if (id->device == PCI_DEVICE_ID_VIA_82C596_3 &&
 329                     !pci_read_config_word(pdev, SMBBA2, &vt596_smba) &&
 330                     (vt596_smba & 0x0001)) {
 331                         SMBHSTCFG = 0x84;
 332                 } else {
 333                         /* no matches at all */
 334                         dev_err(&pdev->dev, "Cannot configure "
 335                                 "SMBus I/O Base address\n");
 336                         return -ENODEV;
 337                 }
 338         }
 339
 340         vt596_smba &= 0xfff0;
 341         if (vt596_smba == 0) {
 342                 dev_err(&pdev->dev, "SMBus base address "
 343                         "uninitialized - upgrade BIOS or use "
 344                         "force_addr=0xaddr\n");
 345                 return -ENODEV;
 346         }
 347
 348 found:
 349         if (!request_region(vt596_smba, 8, vt596_driver.name)) {
 350                 dev_err(&pdev->dev, "SMBus region 0x%x already in use!\n",
 351                         vt596_smba);
 352                 return -ENODEV;
 353         }
 354
 355         pci_read_config_byte(pdev, SMBHSTCFG, &temp);
 356         /* If force_addr is set, we program the new address here. Just to make
 357            sure, we disable the VT596 first. */
 358         if (force_addr) {
 359                 pci_write_config_byte(pdev, SMBHSTCFG, temp & 0xfe);
 360                 pci_write_config_word(pdev, id->driver_data, vt596_smba);
 361                 pci_write_config_byte(pdev, SMBHSTCFG, temp | 0x01);
 362                 dev_warn(&pdev->dev, "WARNING: SMBus interface set to new "
 363                          "address 0x%04x!\n", vt596_smba);
 364         } else if (!(temp & 0x01)) {
 365                 if (force) {
 366                         /* NOTE: This assumes I/O space and other allocations
 367                          * WERE done by the Bios!  Don't complain if your
 368                          * hardware does weird things after enabling this.
 369                          * :') Check for Bios updates before resorting to
 370                          * this.
 371                          */
 372                         pci_write_config_byte(pdev, SMBHSTCFG, temp | 0x01);
 373                         dev_info(&pdev->dev, "Enabling SMBus device\n");
 374                 } else {
 375                         dev_err(&pdev->dev, "SMBUS: Error: Host SMBus "
 376                                 "controller not enabled! - upgrade BIOS or "
 377                                 "use force=1\n");
 378                         goto release_region;
 379                 }
 380         }
 381
 382         dev_dbg(&pdev->dev, "VT596_smba = 0x%X\n", vt596_smba);
 383
 384         switch (pdev->device) {
 385         case PCI_DEVICE_ID_VIA_8237:
 386         case PCI_DEVICE_ID_VIA_8235:
 387         case PCI_DEVICE_ID_VIA_8233A:
 388         case PCI_DEVICE_ID_VIA_8233_0:
 389                 vt596_features |= FEATURE_I2CBLOCK;
 390                 break;
 391         case PCI_DEVICE_ID_VIA_82C686_4:
 392                 /* The VT82C686B (rev 0x40) does support I2C block
 393                    transactions, but the VT82C686A (rev 0x30) doesn't */
 394                 if (!pci_read_config_byte(pdev, PCI_REVISION_ID, &temp)
 395                  && temp >= 0x40)
 396                         vt596_features |= FEATURE_I2CBLOCK;
 397                 break;
 398         }
 399
 400         vt596_adapter.dev.parent = &pdev->dev;
 401         snprintf(vt596_adapter.name, I2C_NAME_SIZE,
 402                  "SMBus Via Pro adapter at %04x", vt596_smba);
 403
 404         vt596_pdev = pci_dev_get(pdev);
 405         if (i2c_add_adapter(&vt596_adapter)) {
 406                 pci_dev_put(vt596_pdev);
 407                 vt596_pdev = NULL;
 408         }
 409
 410         /* Always return failure here.  This is to allow other drivers to bind
 411          * to this pci device.  We don't really want to have control over the
 412          * pci device, we only wanted to read as few register values from it.
 413          */
 414         return -ENODEV;
 415
 416 release_region:
 417         release_region(vt596_smba, 8);
 418         return error;
 419 }
 420
 421 static struct pci_device_id vt596_ids[] = {
 422         { PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C596_3),
 423           .driver_data = SMBBA1 },
 424         { PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C596B_3),
 425           .driver_data = SMBBA1 },
 426         { PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C686_4),
 427           .driver_data = SMBBA1 },
 428         { PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8233_0),
 429           .driver_data = SMBBA3 },
 430         { PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8233A),
 431           .driver_data = SMBBA3 },
 432         { PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8235),
 433           .driver_data = SMBBA3 },
 434         { PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8237),
 435           .driver_data = SMBBA3 },
 436         { PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_8231_4),
 437           .driver_data = SMBBA1 },
 438         { 0, }
 439 };
 440
 441 MODULE_DEVICE_TABLE(pci, vt596_ids);
 442
 443 static struct pci_driver vt596_driver = {
 444         .name           = "vt596_smbus",
 445         .id_table       = vt596_ids,
 446         .probe          = vt596_probe,
 447 };
 448
 449 static int __init i2c_vt596_init(void)
 450 {
 451         return pci_register_driver(&vt596_driver);
 452 }
 453
 454
 455 static void __exit i2c_vt596_exit(void)
 456 {
 457         pci_unregister_driver(&vt596_driver);
 458         if (vt596_pdev != NULL) {
 459                 i2c_del_adapter(&vt596_adapter);
 460                 release_region(vt596_smba, 8);
 461                 pci_dev_put(vt596_pdev);
 462                 vt596_pdev = NULL;
 463         }
 464 }
 465
 466 MODULE_AUTHOR(
 467     "Frodo Looijaard <frodol@dds.nl> and "
 468     "Philip Edelbrock <phil@netroedge.com>");
 469 MODULE_DESCRIPTION("vt82c596 SMBus driver");
 470 MODULE_LICENSE("GPL");
 471
 472 module_init(i2c_vt596_init);
 473 module_exit(i2c_vt596_exit);