drivers/i2c/busses/i2c-nforce2.c

   1 /*
   2     SMBus driver for nVidia nForce2 MCP
   3
   4     Added nForce3 Pro 150  Thomas Leibold <thomas@plx.com>,
   5         Ported to 2.5 Patrick Dreker <patrick@dreker.de>,
   6     Copyright (c) 2003  Hans-Frieder Vogt <hfvogt@arcor.de>,
   7     Based on
   8     SMBus 2.0 driver for AMD-8111 IO-Hub
   9     Copyright (c) 2002 Vojtech Pavlik
  10
  11     This program is free software; you can redistribute it and/or modify
  12     it under the terms of the GNU General Public License as published by
  13     the Free Software Foundation; either version 2 of the License, or
  14     (at your option) any later version.
  15
  16     This program is distributed in the hope that it will be useful,
  17     but WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19     GNU General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with this program; if not, write to the Free Software
  23     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  24 */
  25
  26 /*
  27     SUPPORTED DEVICES           PCI ID
  28     nForce2 MCP                 0064
  29     nForce2 Ultra 400 MCP       0084
  30     nForce3 Pro150 MCP          00D4
  31     nForce3 250Gb MCP           00E4
  32     nForce4 MCP                 0052
  33
  34     This driver supports the 2 SMBuses that are included in the MCP of the
  35     nForce2/3/4 chipsets.
  36 */
  37
  38 /* Note: we assume there can only be one nForce2, with two SMBus interfaces */
  39
  40 #include <linux/module.h>
  41 #include <linux/pci.h>
  42 #include <linux/kernel.h>
  43 #include <linux/stddef.h>
  44 #include <linux/sched.h>
  45 #include <linux/ioport.h>
  46 #include <linux/init.h>
  47 #include <linux/i2c.h>
  48 #include <linux/delay.h>
  49 #include <asm/io.h>
  50
  51 MODULE_LICENSE("GPL");
  52 MODULE_AUTHOR ("Hans-Frieder Vogt <hfvogt@arcor.de>");
  53 MODULE_DESCRIPTION("nForce2 SMBus driver");
  54
  55
  56 struct nforce2_smbus {
  57         struct pci_dev *dev;
  58         struct i2c_adapter adapter;
  59         int base;
  60         int size;
  61 };
  62
  63
  64 /*
  65  * nVidia nForce2 SMBus control register definitions
  66  */
  67 #define NFORCE_PCI_SMB1 0x50
  68 #define NFORCE_PCI_SMB2 0x54
  69
  70
  71 /*
  72  * ACPI 2.0 chapter 13 SMBus 2.0 EC register model
  73  */
  74 #define NVIDIA_SMB_PRTCL        (smbus->base + 0x00)    /* protocol, PEC */
  75 #define NVIDIA_SMB_STS          (smbus->base + 0x01)    /* status */
  76 #define NVIDIA_SMB_ADDR         (smbus->base + 0x02)    /* address */
  77 #define NVIDIA_SMB_CMD          (smbus->base + 0x03)    /* command */
  78 #define NVIDIA_SMB_DATA         (smbus->base + 0x04)    /* 32 data registers */
  79 #define NVIDIA_SMB_BCNT         (smbus->base + 0x24)    /* number of data bytes */
  80 #define NVIDIA_SMB_ALRM_A       (smbus->base + 0x25)    /* alarm address */
  81 #define NVIDIA_SMB_ALRM_D       (smbus->base + 0x26)    /* 2 bytes alarm data */
  82
  83 #define NVIDIA_SMB_STS_DONE     0x80
  84 #define NVIDIA_SMB_STS_ALRM     0x40
  85 #define NVIDIA_SMB_STS_RES      0x20
  86 #define NVIDIA_SMB_STS_STATUS   0x1f
  87
  88 #define NVIDIA_SMB_PRTCL_WRITE                  0x00
  89 #define NVIDIA_SMB_PRTCL_READ                   0x01
  90 #define NVIDIA_SMB_PRTCL_QUICK                  0x02
  91 #define NVIDIA_SMB_PRTCL_BYTE                   0x04
  92 #define NVIDIA_SMB_PRTCL_BYTE_DATA              0x06
  93 #define NVIDIA_SMB_PRTCL_WORD_DATA              0x08
  94 #define NVIDIA_SMB_PRTCL_BLOCK_DATA             0x0a
  95 #define NVIDIA_SMB_PRTCL_PROC_CALL              0x0c
  96 #define NVIDIA_SMB_PRTCL_BLOCK_PROC_CALL        0x0d
  97 #define NVIDIA_SMB_PRTCL_I2C_BLOCK_DATA         0x4a
  98 #define NVIDIA_SMB_PRTCL_PEC                    0x80
  99
 100
 101 static s32 nforce2_access(struct i2c_adapter *adap, u16 addr,
 102                        unsigned short flags, char read_write,
 103                        u8 command, int size, union i2c_smbus_data *data);
 104 static u32 nforce2_func(struct i2c_adapter *adapter);
 105
 106
 107 static struct i2c_algorithm smbus_algorithm = {
 108         .smbus_xfer = nforce2_access,
 109         .functionality = nforce2_func,
 110 };
 111
 112 static struct i2c_adapter nforce2_adapter = {
 113         .owner          = THIS_MODULE,
 114         .class          = I2C_CLASS_HWMON,
 115         .algo           = &smbus_algorithm,
 116         .name           = "unset",
 117 };
 118
 119 /* Return -1 on error. See smbus.h for more information */
 120 static s32 nforce2_access(struct i2c_adapter * adap, u16 addr,
 121                 unsigned short flags, char read_write,
 122                 u8 command, int size, union i2c_smbus_data * data)
 123 {
 124         struct nforce2_smbus *smbus = adap->algo_data;
 125         unsigned char protocol, pec, temp;
 126         unsigned char len = 0; /* to keep the compiler quiet */
 127         int i;
 128
 129         protocol = (read_write == I2C_SMBUS_READ) ? NVIDIA_SMB_PRTCL_READ :
 130                 NVIDIA_SMB_PRTCL_WRITE;
 131         pec = (flags & I2C_CLIENT_PEC) ? NVIDIA_SMB_PRTCL_PEC : 0;
 132
 133         switch (size) {
 134
 135                 case I2C_SMBUS_QUICK:
 136                         protocol |= NVIDIA_SMB_PRTCL_QUICK;
 137                         read_write = I2C_SMBUS_WRITE;
 138                         break;
 139
 140                 case I2C_SMBUS_BYTE:
 141                         if (read_write == I2C_SMBUS_WRITE)
 142                                 outb_p(command, NVIDIA_SMB_CMD);
 143                         protocol |= NVIDIA_SMB_PRTCL_BYTE;
 144                         break;
 145
 146                 case I2C_SMBUS_BYTE_DATA:
 147                         outb_p(command, NVIDIA_SMB_CMD);
 148                         if (read_write == I2C_SMBUS_WRITE)
 149                                 outb_p(data->byte, NVIDIA_SMB_DATA);
 150                         protocol |= NVIDIA_SMB_PRTCL_BYTE_DATA;
 151                         break;
 152
 153                 case I2C_SMBUS_WORD_DATA:
 154                         outb_p(command, NVIDIA_SMB_CMD);
 155                         if (read_write == I2C_SMBUS_WRITE) {
 156                                  outb_p(data->word, NVIDIA_SMB_DATA);
 157                                  outb_p(data->word >> 8, NVIDIA_SMB_DATA+1);
 158                         }
 159                         protocol |= NVIDIA_SMB_PRTCL_WORD_DATA | pec;
 160                         break;
 161
 162                 case I2C_SMBUS_BLOCK_DATA:
 163                         outb_p(command, NVIDIA_SMB_CMD);
 164                         if (read_write == I2C_SMBUS_WRITE) {
 165                                 len = min_t(u8, data->block[0], 32);
 166                                 outb_p(len, NVIDIA_SMB_BCNT);
 167                                 for (i = 0; i < len; i++)
 168                                         outb_p(data->block[i + 1], NVIDIA_SMB_DATA+i);
 169                         }
 170                         protocol |= NVIDIA_SMB_PRTCL_BLOCK_DATA | pec;
 171                         break;
 172
 173                 case I2C_SMBUS_I2C_BLOCK_DATA:
 174                         len = min_t(u8, data->block[0], 32);
 175                         outb_p(command, NVIDIA_SMB_CMD);
 176                         outb_p(len, NVIDIA_SMB_BCNT);
 177                         if (read_write == I2C_SMBUS_WRITE)
 178                                 for (i = 0; i < len; i++)
 179                                         outb_p(data->block[i + 1], NVIDIA_SMB_DATA+i);
 180                         protocol |= NVIDIA_SMB_PRTCL_I2C_BLOCK_DATA;
 181                         break;
 182
 183                 case I2C_SMBUS_PROC_CALL:
 184                         dev_err(&adap->dev, "I2C_SMBUS_PROC_CALL not supported!\n");
 185                         return -1;
 186
 187                 case I2C_SMBUS_BLOCK_PROC_CALL:
 188                         dev_err(&adap->dev, "I2C_SMBUS_BLOCK_PROC_CALL not supported!\n");
 189                         return -1;
 190
 191                 case I2C_SMBUS_WORD_DATA_PEC:
 192                 case I2C_SMBUS_BLOCK_DATA_PEC:
 193                 case I2C_SMBUS_PROC_CALL_PEC:
 194                 case I2C_SMBUS_BLOCK_PROC_CALL_PEC:
 195                         dev_err(&adap->dev, "Unexpected software PEC transaction %d\n.", size);
 196                         return -1;
 197
 198                 default:
 199                         dev_err(&adap->dev, "Unsupported transaction %d\n", size);
 200                         return -1;
 201         }
 202
 203         outb_p((addr & 0x7f) << 1, NVIDIA_SMB_ADDR);
 204         outb_p(protocol, NVIDIA_SMB_PRTCL);
 205
 206         temp = inb_p(NVIDIA_SMB_STS);
 207
 208         if (~temp & NVIDIA_SMB_STS_DONE) {
 209                 udelay(500);
 210                 temp = inb_p(NVIDIA_SMB_STS);
 211         }
 212         if (~temp & NVIDIA_SMB_STS_DONE) {
 213                 msleep(10);
 214                 temp = inb_p(NVIDIA_SMB_STS);
 215         }
 216
 217         if ((~temp & NVIDIA_SMB_STS_DONE) || (temp & NVIDIA_SMB_STS_STATUS)) {
 218                 dev_dbg(&adap->dev, "SMBus Timeout! (0x%02x)\n", temp);
 219                 return -1;
 220         }
 221
 222         if (read_write == I2C_SMBUS_WRITE)
 223                 return 0;
 224
 225         switch (size) {
 226
 227                 case I2C_SMBUS_BYTE:
 228                 case I2C_SMBUS_BYTE_DATA:
 229                         data->byte = inb_p(NVIDIA_SMB_DATA);
 230                         break;
 231
 232                 case I2C_SMBUS_WORD_DATA:
 233                 /* case I2C_SMBUS_PROC_CALL: not supported */
 234                         data->word = inb_p(NVIDIA_SMB_DATA) | (inb_p(NVIDIA_SMB_DATA+1) << 8);
 235                         break;
 236
 237                 case I2C_SMBUS_BLOCK_DATA:
 238                 /* case I2C_SMBUS_BLOCK_PROC_CALL: not supported */
 239                         len = inb_p(NVIDIA_SMB_BCNT);
 240                         len = min_t(u8, len, 32);
 241                 case I2C_SMBUS_I2C_BLOCK_DATA:
 242                         for (i = 0; i < len; i++)
 243                                 data->block[i+1] = inb_p(NVIDIA_SMB_DATA + i);
 244                         data->block[0] = len;
 245                         break;
 246         }
 247
 248         return 0;
 249 }
 250
 251
 252 static u32 nforce2_func(struct i2c_adapter *adapter)
 253 {
 254         /* other functionality might be possible, but is not tested */
 255         return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
 256             I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA /* |
 257             I2C_FUNC_SMBUS_BLOCK_DATA */;
 258 }
 259
 260
 261 static struct pci_device_id nforce2_ids[] = {
 262         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE2_SMBUS) },
 263         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE2S_SMBUS) },
 264         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE3_SMBUS) },
 265         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE3S_SMBUS) },
 266         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE4_SMBUS) },
 267         { 0 }
 268 };
 269
 270
 271 MODULE_DEVICE_TABLE (pci, nforce2_ids);
 272
 273
 274 static int __devinit nforce2_probe_smb (struct pci_dev *dev, int reg,
 275         struct nforce2_smbus *smbus, char *name)
 276 {
 277         u16 iobase;
 278         int error;
 279
 280         if (pci_read_config_word(dev, reg, &iobase) != PCIBIOS_SUCCESSFUL) {
 281                 dev_err(&smbus->adapter.dev, "Error reading PCI config for %s\n", name);
 282                 return -1;
 283         }
 284         smbus->dev  = dev;
 285         smbus->base = iobase & 0xfffc;
 286         smbus->size = 8;
 287
 288         if (!request_region(smbus->base, smbus->size, "nForce2 SMBus")) {
 289                 dev_err(&smbus->adapter.dev, "Error requesting region %02x .. %02X for %s\n",
 290                         smbus->base, smbus->base+smbus->size-1, name);
 291                 return -1;
 292         }
 293         smbus->adapter = nforce2_adapter;
 294         smbus->adapter.algo_data = smbus;
 295         smbus->adapter.dev.parent = &dev->dev;
 296         snprintf(smbus->adapter.name, I2C_NAME_SIZE,
 297                 "SMBus nForce2 adapter at %04x", smbus->base);
 298
 299         error = i2c_add_adapter(&smbus->adapter);
 300         if (error) {
 301                 dev_err(&smbus->adapter.dev, "Failed to register adapter.\n");
 302                 release_region(smbus->base, smbus->size);
 303                 return -1;
 304         }
 305         dev_info(&smbus->adapter.dev, "nForce2 SMBus adapter at %#x\n", smbus->base);
 306         return 0;
 307 }
 308
 309
 310 static int __devinit nforce2_probe(struct pci_dev *dev, const struct pci_device_id *id)
 311 {
 312         struct nforce2_smbus *smbuses;
 313         int res1, res2;
 314
 315         /* we support 2 SMBus adapters */
 316         if (!(smbuses = (void *)kmalloc(2*sizeof(struct nforce2_smbus),
 317                                         GFP_KERNEL)))
 318                 return -ENOMEM;
 319         memset (smbuses, 0, 2*sizeof(struct nforce2_smbus));
 320         pci_set_drvdata(dev, smbuses);
 321
 322         /* SMBus adapter 1 */
 323         res1 = nforce2_probe_smb (dev, NFORCE_PCI_SMB1, &smbuses[0], "SMB1");
 324         if (res1 < 0) {
 325                 dev_err(&dev->dev, "Error probing SMB1.\n");
 326                 smbuses[0].base = 0;    /* to have a check value */
 327         }
 328         res2 = nforce2_probe_smb (dev, NFORCE_PCI_SMB2, &smbuses[1], "SMB2");
 329         if (res2 < 0) {
 330                 dev_err(&dev->dev, "Error probing SMB2.\n");
 331                 smbuses[1].base = 0;    /* to have a check value */
 332         }
 333         if ((res1 < 0) && (res2 < 0)) {
 334                 /* we did not find even one of the SMBuses, so we give up */
 335                 kfree(smbuses);
 336                 return -ENODEV;
 337         }
 338
 339         return 0;
 340 }
 341
 342
 343 static void __devexit nforce2_remove(struct pci_dev *dev)
 344 {
 345         struct nforce2_smbus *smbuses = (void*) pci_get_drvdata(dev);
 346
 347         if (smbuses[0].base) {
 348                 i2c_del_adapter(&smbuses[0].adapter);
 349                 release_region(smbuses[0].base, smbuses[0].size);
 350         }
 351         if (smbuses[1].base) {
 352                 i2c_del_adapter(&smbuses[1].adapter);
 353                 release_region(smbuses[1].base, smbuses[1].size);
 354         }
 355         kfree(smbuses);
 356 }
 357
 358 static struct pci_driver nforce2_driver = {
 359         .name           = "nForce2_smbus",
 360         .id_table       = nforce2_ids,
 361         .probe          = nforce2_probe,
 362         .remove         = __devexit_p(nforce2_remove),
 363 };
 364
 365 static int __init nforce2_init(void)
 366 {
 367         return pci_register_driver(&nforce2_driver);
 368 }
 369
 370 static void __exit nforce2_exit(void)
 371 {
 372         pci_unregister_driver(&nforce2_driver);
 373 }
 374
 375 module_init(nforce2_init);
 376 module_exit(nforce2_exit);
 377