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     nForce4 MCP-04              0034
  34     nForce4 MCP51               0264
  35     nForce4 MCP55               0368
  36
  37     This driver supports the 2 SMBuses that are included in the MCP of the
  38     nForce2/3/4/5xx chipsets.
  39 */
  40
  41 /* Note: we assume there can only be one nForce2, with two SMBus interfaces */
  42
  43 #include <linux/module.h>
  44 #include <linux/pci.h>
  45 #include <linux/kernel.h>
  46 #include <linux/stddef.h>
  47 #include <linux/sched.h>
  48 #include <linux/ioport.h>
  49 #include <linux/init.h>
  50 #include <linux/i2c.h>
  51 #include <linux/delay.h>
  52 #include <asm/io.h>
  53
  54 MODULE_LICENSE("GPL");
  55 MODULE_AUTHOR ("Hans-Frieder Vogt <hfvogt@gmx.net>");
  56 MODULE_DESCRIPTION("nForce2/3/4/5xx SMBus driver");
  57
  58
  59 struct nforce2_smbus {
  60         struct pci_dev *dev;
  61         struct i2c_adapter adapter;
  62         int base;
  63         int size;
  64 };
  65
  66
  67 /*
  68  * nVidia nForce2 SMBus control register definitions
  69  * (Newer incarnations use standard BARs 4 and 5 instead)
  70  */
  71 #define NFORCE_PCI_SMB1 0x50
  72 #define NFORCE_PCI_SMB2 0x54
  73
  74
  75 /*
  76  * ACPI 2.0 chapter 13 SMBus 2.0 EC register model
  77  */
  78 #define NVIDIA_SMB_PRTCL        (smbus->base + 0x00)    /* protocol, PEC */
  79 #define NVIDIA_SMB_STS          (smbus->base + 0x01)    /* status */
  80 #define NVIDIA_SMB_ADDR         (smbus->base + 0x02)    /* address */
  81 #define NVIDIA_SMB_CMD          (smbus->base + 0x03)    /* command */
  82 #define NVIDIA_SMB_DATA         (smbus->base + 0x04)    /* 32 data registers */
  83
  84 #define NVIDIA_SMB_STS_DONE     0x80
  85 #define NVIDIA_SMB_STS_ALRM     0x40
  86 #define NVIDIA_SMB_STS_RES      0x20
  87 #define NVIDIA_SMB_STS_STATUS   0x1f
  88
  89 #define NVIDIA_SMB_PRTCL_WRITE                  0x00
  90 #define NVIDIA_SMB_PRTCL_READ                   0x01
  91 #define NVIDIA_SMB_PRTCL_QUICK                  0x02
  92 #define NVIDIA_SMB_PRTCL_BYTE                   0x04
  93 #define NVIDIA_SMB_PRTCL_BYTE_DATA              0x06
  94 #define NVIDIA_SMB_PRTCL_WORD_DATA              0x08
  95 #define NVIDIA_SMB_PRTCL_PEC                    0x80
  96
  97 static struct pci_driver nforce2_driver;
  98
  99 /* Return -1 on error */
 100 static s32 nforce2_access(struct i2c_adapter * adap, u16 addr,
 101                 unsigned short flags, char read_write,
 102                 u8 command, int size, union i2c_smbus_data * data)
 103 {
 104         struct nforce2_smbus *smbus = adap->algo_data;
 105         unsigned char protocol, pec, temp;
 106
 107         protocol = (read_write == I2C_SMBUS_READ) ? NVIDIA_SMB_PRTCL_READ :
 108                 NVIDIA_SMB_PRTCL_WRITE;
 109         pec = (flags & I2C_CLIENT_PEC) ? NVIDIA_SMB_PRTCL_PEC : 0;
 110
 111         switch (size) {
 112
 113                 case I2C_SMBUS_QUICK:
 114                         protocol |= NVIDIA_SMB_PRTCL_QUICK;
 115                         read_write = I2C_SMBUS_WRITE;
 116                         break;
 117
 118                 case I2C_SMBUS_BYTE:
 119                         if (read_write == I2C_SMBUS_WRITE)
 120                                 outb_p(command, NVIDIA_SMB_CMD);
 121                         protocol |= NVIDIA_SMB_PRTCL_BYTE;
 122                         break;
 123
 124                 case I2C_SMBUS_BYTE_DATA:
 125                         outb_p(command, NVIDIA_SMB_CMD);
 126                         if (read_write == I2C_SMBUS_WRITE)
 127                                 outb_p(data->byte, NVIDIA_SMB_DATA);
 128                         protocol |= NVIDIA_SMB_PRTCL_BYTE_DATA;
 129                         break;
 130
 131                 case I2C_SMBUS_WORD_DATA:
 132                         outb_p(command, NVIDIA_SMB_CMD);
 133                         if (read_write == I2C_SMBUS_WRITE) {
 134                                  outb_p(data->word, NVIDIA_SMB_DATA);
 135                                  outb_p(data->word >> 8, NVIDIA_SMB_DATA+1);
 136                         }
 137                         protocol |= NVIDIA_SMB_PRTCL_WORD_DATA | pec;
 138                         break;
 139
 140                 default:
 141                         dev_err(&adap->dev, "Unsupported transaction %d\n", size);
 142                         return -1;
 143         }
 144
 145         outb_p((addr & 0x7f) << 1, NVIDIA_SMB_ADDR);
 146         outb_p(protocol, NVIDIA_SMB_PRTCL);
 147
 148         temp = inb_p(NVIDIA_SMB_STS);
 149
 150         if (~temp & NVIDIA_SMB_STS_DONE) {
 151                 udelay(500);
 152                 temp = inb_p(NVIDIA_SMB_STS);
 153         }
 154         if (~temp & NVIDIA_SMB_STS_DONE) {
 155                 msleep(10);
 156                 temp = inb_p(NVIDIA_SMB_STS);
 157         }
 158
 159         if ((~temp & NVIDIA_SMB_STS_DONE) || (temp & NVIDIA_SMB_STS_STATUS)) {
 160                 dev_dbg(&adap->dev, "SMBus Timeout! (0x%02x)\n", temp);
 161                 return -1;
 162         }
 163
 164         if (read_write == I2C_SMBUS_WRITE)
 165                 return 0;
 166
 167         switch (size) {
 168
 169                 case I2C_SMBUS_BYTE:
 170                 case I2C_SMBUS_BYTE_DATA:
 171                         data->byte = inb_p(NVIDIA_SMB_DATA);
 172                         break;
 173
 174                 case I2C_SMBUS_WORD_DATA:
 175                         data->word = inb_p(NVIDIA_SMB_DATA) | (inb_p(NVIDIA_SMB_DATA+1) << 8);
 176                         break;
 177         }
 178
 179         return 0;
 180 }
 181
 182
 183 static u32 nforce2_func(struct i2c_adapter *adapter)
 184 {
 185         /* other functionality might be possible, but is not tested */
 186         return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
 187             I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA;
 188 }
 189
 190 static struct i2c_algorithm smbus_algorithm = {
 191         .smbus_xfer     = nforce2_access,
 192         .functionality  = nforce2_func,
 193 };
 194
 195
 196 static struct pci_device_id nforce2_ids[] = {
 197         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE2_SMBUS) },
 198         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE2S_SMBUS) },
 199         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE3_SMBUS) },
 200         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE3S_SMBUS) },
 201         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE4_SMBUS) },
 202         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP04_SMBUS) },
 203         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP51_SMBUS) },
 204         { PCI_DEVICE(PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP55_SMBUS) },
 205         { 0 }
 206 };
 207
 208 MODULE_DEVICE_TABLE (pci, nforce2_ids);
 209
 210
 211 static int __devinit nforce2_probe_smb (struct pci_dev *dev, int bar,
 212         int alt_reg, struct nforce2_smbus *smbus, const char *name)
 213 {
 214         int error;
 215
 216         smbus->base = pci_resource_start(dev, bar);
 217         if (smbus->base) {
 218                 smbus->size = pci_resource_len(dev, bar);
 219         } else {
 220                 /* Older incarnations of the device used non-standard BARs */
 221                 u16 iobase;
 222
 223                 if (pci_read_config_word(dev, alt_reg, &iobase)
 224                     != PCIBIOS_SUCCESSFUL) {
 225                         dev_err(&dev->dev, "Error reading PCI config for %s\n",
 226                                 name);
 227                         return -1;
 228                 }
 229
 230                 smbus->base = iobase & PCI_BASE_ADDRESS_IO_MASK;
 231                 smbus->size = 64;
 232         }
 233         smbus->dev = dev;
 234
 235         if (!request_region(smbus->base, smbus->size, nforce2_driver.name)) {
 236                 dev_err(&smbus->adapter.dev, "Error requesting region %02x .. %02X for %s\n",
 237                         smbus->base, smbus->base+smbus->size-1, name);
 238                 return -1;
 239         }
 240         smbus->adapter.owner = THIS_MODULE;
 241         smbus->adapter.class = I2C_CLASS_HWMON;
 242         smbus->adapter.algo = &smbus_algorithm;
 243         smbus->adapter.algo_data = smbus;
 244         smbus->adapter.dev.parent = &dev->dev;
 245         snprintf(smbus->adapter.name, I2C_NAME_SIZE,
 246                 "SMBus nForce2 adapter at %04x", smbus->base);
 247
 248         error = i2c_add_adapter(&smbus->adapter);
 249         if (error) {
 250                 dev_err(&smbus->adapter.dev, "Failed to register adapter.\n");
 251                 release_region(smbus->base, smbus->size);
 252                 return -1;
 253         }
 254         dev_info(&smbus->adapter.dev, "nForce2 SMBus adapter at %#x\n", smbus->base);
 255         return 0;
 256 }
 257
 258
 259 static int __devinit nforce2_probe(struct pci_dev *dev, const struct pci_device_id *id)
 260 {
 261         struct nforce2_smbus *smbuses;
 262         int res1, res2;
 263
 264         /* we support 2 SMBus adapters */
 265         if (!(smbuses = kzalloc(2*sizeof(struct nforce2_smbus), GFP_KERNEL)))
 266                 return -ENOMEM;
 267         pci_set_drvdata(dev, smbuses);
 268
 269         /* SMBus adapter 1 */
 270         res1 = nforce2_probe_smb(dev, 4, NFORCE_PCI_SMB1, &smbuses[0], "SMB1");
 271         if (res1 < 0) {
 272                 dev_err(&dev->dev, "Error probing SMB1.\n");
 273                 smbuses[0].base = 0;    /* to have a check value */
 274         }
 275         /* SMBus adapter 2 */
 276         res2 = nforce2_probe_smb(dev, 5, NFORCE_PCI_SMB2, &smbuses[1], "SMB2");
 277         if (res2 < 0) {
 278                 dev_err(&dev->dev, "Error probing SMB2.\n");
 279                 smbuses[1].base = 0;    /* to have a check value */
 280         }
 281         if ((res1 < 0) && (res2 < 0)) {
 282                 /* we did not find even one of the SMBuses, so we give up */
 283                 kfree(smbuses);
 284                 return -ENODEV;
 285         }
 286
 287         return 0;
 288 }
 289
 290
 291 static void __devexit nforce2_remove(struct pci_dev *dev)
 292 {
 293         struct nforce2_smbus *smbuses = (void*) pci_get_drvdata(dev);
 294
 295         if (smbuses[0].base) {
 296                 i2c_del_adapter(&smbuses[0].adapter);
 297                 release_region(smbuses[0].base, smbuses[0].size);
 298         }
 299         if (smbuses[1].base) {
 300                 i2c_del_adapter(&smbuses[1].adapter);
 301                 release_region(smbuses[1].base, smbuses[1].size);
 302         }
 303         kfree(smbuses);
 304 }
 305
 306 static struct pci_driver nforce2_driver = {
 307         .name           = "nForce2_smbus",
 308         .id_table       = nforce2_ids,
 309         .probe          = nforce2_probe,
 310         .remove         = __devexit_p(nforce2_remove),
 311 };
 312
 313 static int __init nforce2_init(void)
 314 {
 315         return pci_register_driver(&nforce2_driver);
 316 }
 317
 318 static void __exit nforce2_exit(void)
 319 {
 320         pci_unregister_driver(&nforce2_driver);
 321 }
 322
 323 module_init(nforce2_init);
 324 module_exit(nforce2_exit);
 325