drivers/i2c/busses/scx200_acb.c

   1 /*
   2     Copyright (c) 2001,2002 Christer Weinigel <wingel@nano-system.com>
   3
   4     National Semiconductor SCx200 ACCESS.bus support
   5     Also supports the AMD CS5535 and AMD CS5536
   6
   7     Based on i2c-keywest.c which is:
   8         Copyright (c) 2001 Benjamin Herrenschmidt <benh@kernel.crashing.org>
   9         Copyright (c) 2000 Philip Edelbrock <phil@stimpy.netroedge.com>
  10
  11     This program is free software; you can redistribute it and/or
  12     modify it under the terms of the GNU General Public License as
  13     published by the Free Software Foundation; either version 2 of the
  14     License, or (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 GNU
  19     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 #include <linux/module.h>
  27 #include <linux/errno.h>
  28 #include <linux/kernel.h>
  29 #include <linux/init.h>
  30 #include <linux/i2c.h>
  31 #include <linux/smp_lock.h>
  32 #include <linux/pci.h>
  33 #include <linux/delay.h>
  34 #include <linux/mutex.h>
  35 #include <asm/io.h>
  36 #include <asm/msr.h>
  37
  38 #include <linux/scx200.h>
  39
  40 #define NAME "scx200_acb"
  41
  42 MODULE_AUTHOR("Christer Weinigel <wingel@nano-system.com>");
  43 MODULE_DESCRIPTION("NatSemi SCx200 ACCESS.bus Driver");
  44 MODULE_LICENSE("GPL");
  45
  46 #define MAX_DEVICES 4
  47 static int base[MAX_DEVICES] = { 0x820, 0x840 };
  48 module_param_array(base, int, NULL, 0);
  49 MODULE_PARM_DESC(base, "Base addresses for the ACCESS.bus controllers");
  50
  51 #define POLL_TIMEOUT    (HZ/5)
  52
  53 enum scx200_acb_state {
  54         state_idle,
  55         state_address,
  56         state_command,
  57         state_repeat_start,
  58         state_quick,
  59         state_read,
  60         state_write,
  61 };
  62
  63 static const char *scx200_acb_state_name[] = {
  64         "idle",
  65         "address",
  66         "command",
  67         "repeat_start",
  68         "quick",
  69         "read",
  70         "write",
  71 };
  72
  73 /* Physical interface */
  74 struct scx200_acb_iface {
  75         struct scx200_acb_iface *next;
  76         struct i2c_adapter adapter;
  77         unsigned base;
  78         struct mutex mutex;
  79
  80         /* State machine data */
  81         enum scx200_acb_state state;
  82         int result;
  83         u8 address_byte;
  84         u8 command;
  85         u8 *ptr;
  86         char needs_reset;
  87         unsigned len;
  88 };
  89
  90 /* Register Definitions */
  91 #define ACBSDA          (iface->base + 0)
  92 #define ACBST           (iface->base + 1)
  93 #define    ACBST_SDAST          0x40 /* SDA Status */
  94 #define    ACBST_BER            0x20
  95 #define    ACBST_NEGACK         0x10 /* Negative Acknowledge */
  96 #define    ACBST_STASTR         0x08 /* Stall After Start */
  97 #define    ACBST_MASTER         0x02
  98 #define ACBCST          (iface->base + 2)
  99 #define    ACBCST_BB            0x02
 100 #define ACBCTL1         (iface->base + 3)
 101 #define    ACBCTL1_STASTRE      0x80
 102 #define    ACBCTL1_NMINTE       0x40
 103 #define    ACBCTL1_ACK          0x10
 104 #define    ACBCTL1_STOP         0x02
 105 #define    ACBCTL1_START        0x01
 106 #define ACBADDR         (iface->base + 4)
 107 #define ACBCTL2         (iface->base + 5)
 108 #define    ACBCTL2_ENABLE       0x01
 109
 110 /************************************************************************/
 111
 112 static void scx200_acb_machine(struct scx200_acb_iface *iface, u8 status)
 113 {
 114         const char *errmsg;
 115
 116         dev_dbg(&iface->adapter.dev, "state %s, status = 0x%02x\n",
 117                 scx200_acb_state_name[iface->state], status);
 118
 119         if (status & ACBST_BER) {
 120                 errmsg = "bus error";
 121                 goto error;
 122         }
 123         if (!(status & ACBST_MASTER)) {
 124                 errmsg = "not master";
 125                 goto error;
 126         }
 127         if (status & ACBST_NEGACK) {
 128                 dev_dbg(&iface->adapter.dev, "negative ack in state %s\n",
 129                         scx200_acb_state_name[iface->state]);
 130
 131                 iface->state = state_idle;
 132                 iface->result = -ENXIO;
 133
 134                 outb(inb(ACBCTL1) | ACBCTL1_STOP, ACBCTL1);
 135                 outb(ACBST_STASTR | ACBST_NEGACK, ACBST);
 136
 137                 /* Reset the status register */
 138                 outb(0, ACBST);
 139                 return;
 140         }
 141
 142         switch (iface->state) {
 143         case state_idle:
 144                 dev_warn(&iface->adapter.dev, "interrupt in idle state\n");
 145                 break;
 146
 147         case state_address:
 148                 /* Do a pointer write first */
 149                 outb(iface->address_byte & ~1, ACBSDA);
 150
 151                 iface->state = state_command;
 152                 break;
 153
 154         case state_command:
 155                 outb(iface->command, ACBSDA);
 156
 157                 if (iface->address_byte & 1)
 158                         iface->state = state_repeat_start;
 159                 else
 160                         iface->state = state_write;
 161                 break;
 162
 163         case state_repeat_start:
 164                 outb(inb(ACBCTL1) | ACBCTL1_START, ACBCTL1);
 165                 /* fallthrough */
 166
 167         case state_quick:
 168                 if (iface->address_byte & 1) {
 169                         if (iface->len == 1)
 170                                 outb(inb(ACBCTL1) | ACBCTL1_ACK, ACBCTL1);
 171                         else
 172                                 outb(inb(ACBCTL1) & ~ACBCTL1_ACK, ACBCTL1);
 173                         outb(iface->address_byte, ACBSDA);
 174
 175                         iface->state = state_read;
 176                 } else {
 177                         outb(iface->address_byte, ACBSDA);
 178
 179                         iface->state = state_write;
 180                 }
 181                 break;
 182
 183         case state_read:
 184                 /* Set ACK if _next_ byte will be the last one */
 185                 if (iface->len == 2)
 186                         outb(inb(ACBCTL1) | ACBCTL1_ACK, ACBCTL1);
 187                 else
 188                         outb(inb(ACBCTL1) & ~ACBCTL1_ACK, ACBCTL1);
 189
 190                 if (iface->len == 1) {
 191                         iface->result = 0;
 192                         iface->state = state_idle;
 193                         outb(inb(ACBCTL1) | ACBCTL1_STOP, ACBCTL1);
 194                 }
 195
 196                 *iface->ptr++ = inb(ACBSDA);
 197                 --iface->len;
 198
 199                 break;
 200
 201         case state_write:
 202                 if (iface->len == 0) {
 203                         iface->result = 0;
 204                         iface->state = state_idle;
 205                         outb(inb(ACBCTL1) | ACBCTL1_STOP, ACBCTL1);
 206                         break;
 207                 }
 208
 209                 outb(*iface->ptr++, ACBSDA);
 210                 --iface->len;
 211
 212                 break;
 213         }
 214
 215         return;
 216
 217  error:
 218         dev_err(&iface->adapter.dev, "%s in state %s\n", errmsg,
 219                 scx200_acb_state_name[iface->state]);
 220
 221         iface->state = state_idle;
 222         iface->result = -EIO;
 223         iface->needs_reset = 1;
 224 }
 225
 226 static void scx200_acb_poll(struct scx200_acb_iface *iface)
 227 {
 228         u8 status;
 229         unsigned long timeout;
 230
 231         timeout = jiffies + POLL_TIMEOUT;
 232         while (time_before(jiffies, timeout)) {
 233                 status = inb(ACBST);
 234
 235                 /* Reset the status register to avoid the hang */
 236                 outb(0, ACBST);
 237
 238                 if ((status & (ACBST_SDAST|ACBST_BER|ACBST_NEGACK)) != 0) {
 239                         scx200_acb_machine(iface, status);
 240                         return;
 241                 }
 242                 yield();
 243         }
 244
 245         dev_err(&iface->adapter.dev, "timeout in state %s\n",
 246                 scx200_acb_state_name[iface->state]);
 247
 248         iface->state = state_idle;
 249         iface->result = -EIO;
 250         iface->needs_reset = 1;
 251 }
 252
 253 static void scx200_acb_reset(struct scx200_acb_iface *iface)
 254 {
 255         /* Disable the ACCESS.bus device and Configure the SCL
 256            frequency: 16 clock cycles */
 257         outb(0x70, ACBCTL2);
 258         /* Polling mode */
 259         outb(0, ACBCTL1);
 260         /* Disable slave address */
 261         outb(0, ACBADDR);
 262         /* Enable the ACCESS.bus device */
 263         outb(inb(ACBCTL2) | ACBCTL2_ENABLE, ACBCTL2);
 264         /* Free STALL after START */
 265         outb(inb(ACBCTL1) & ~(ACBCTL1_STASTRE | ACBCTL1_NMINTE), ACBCTL1);
 266         /* Send a STOP */
 267         outb(inb(ACBCTL1) | ACBCTL1_STOP, ACBCTL1);
 268         /* Clear BER, NEGACK and STASTR bits */
 269         outb(ACBST_BER | ACBST_NEGACK | ACBST_STASTR, ACBST);
 270         /* Clear BB bit */
 271         outb(inb(ACBCST) | ACBCST_BB, ACBCST);
 272 }
 273
 274 static s32 scx200_acb_smbus_xfer(struct i2c_adapter *adapter,
 275                                  u16 address, unsigned short flags,
 276                                  char rw, u8 command, int size,
 277                                  union i2c_smbus_data *data)
 278 {
 279         struct scx200_acb_iface *iface = i2c_get_adapdata(adapter);
 280         int len;
 281         u8 *buffer;
 282         u16 cur_word;
 283         int rc;
 284
 285         switch (size) {
 286         case I2C_SMBUS_QUICK:
 287                 len = 0;
 288                 buffer = NULL;
 289                 break;
 290
 291         case I2C_SMBUS_BYTE:
 292                 len = 1;
 293                 buffer = rw ? &data->byte : &command;
 294                 break;
 295
 296         case I2C_SMBUS_BYTE_DATA:
 297                 len = 1;
 298                 buffer = &data->byte;
 299                 break;
 300
 301         case I2C_SMBUS_WORD_DATA:
 302                 len = 2;
 303                 cur_word = cpu_to_le16(data->word);
 304                 buffer = (u8 *)&cur_word;
 305                 break;
 306
 307         case I2C_SMBUS_I2C_BLOCK_DATA:
 308                 if (rw == I2C_SMBUS_READ)
 309                         data->block[0] = I2C_SMBUS_BLOCK_MAX; /* For now */
 310                 len = data->block[0];
 311                 if (len == 0 || len > I2C_SMBUS_BLOCK_MAX)
 312                         return -EINVAL;
 313                 buffer = &data->block[1];
 314                 break;
 315
 316         default:
 317                 return -EINVAL;
 318         }
 319
 320         dev_dbg(&adapter->dev,
 321                 "size=%d, address=0x%x, command=0x%x, len=%d, read=%d\n",
 322                 size, address, command, len, rw);
 323
 324         if (!len && rw == I2C_SMBUS_READ) {
 325                 dev_dbg(&adapter->dev, "zero length read\n");
 326                 return -EINVAL;
 327         }
 328
 329         mutex_lock(&iface->mutex);
 330
 331         iface->address_byte = (address << 1) | rw;
 332         iface->command = command;
 333         iface->ptr = buffer;
 334         iface->len = len;
 335         iface->result = -EINVAL;
 336         iface->needs_reset = 0;
 337
 338         outb(inb(ACBCTL1) | ACBCTL1_START, ACBCTL1);
 339
 340         if (size == I2C_SMBUS_QUICK || size == I2C_SMBUS_BYTE)
 341                 iface->state = state_quick;
 342         else
 343                 iface->state = state_address;
 344
 345         while (iface->state != state_idle)
 346                 scx200_acb_poll(iface);
 347
 348         if (iface->needs_reset)
 349                 scx200_acb_reset(iface);
 350
 351         rc = iface->result;
 352
 353         mutex_unlock(&iface->mutex);
 354
 355         if (rc == 0 && size == I2C_SMBUS_WORD_DATA && rw == I2C_SMBUS_READ)
 356                 data->word = le16_to_cpu(cur_word);
 357
 358 #ifdef DEBUG
 359         dev_dbg(&adapter->dev, "transfer done, result: %d", rc);
 360         if (buffer) {
 361                 int i;
 362                 printk(" data:");
 363                 for (i = 0; i < len; ++i)
 364                         printk(" %02x", buffer[i]);
 365         }
 366         printk("\n");
 367 #endif
 368
 369         return rc;
 370 }
 371
 372 static u32 scx200_acb_func(struct i2c_adapter *adapter)
 373 {
 374         return I2C_FUNC_SMBUS_QUICK | I2C_FUNC_SMBUS_BYTE |
 375                I2C_FUNC_SMBUS_BYTE_DATA | I2C_FUNC_SMBUS_WORD_DATA |
 376                I2C_FUNC_SMBUS_I2C_BLOCK;
 377 }
 378
 379 /* For now, we only handle combined mode (smbus) */
 380 static struct i2c_algorithm scx200_acb_algorithm = {
 381         .smbus_xfer     = scx200_acb_smbus_xfer,
 382         .functionality  = scx200_acb_func,
 383 };
 384
 385 static struct scx200_acb_iface *scx200_acb_list;
 386 static DECLARE_MUTEX(scx200_acb_list_mutex);
 387
 388 static int scx200_acb_probe(struct scx200_acb_iface *iface)
 389 {
 390         u8 val;
 391
 392         /* Disable the ACCESS.bus device and Configure the SCL
 393            frequency: 16 clock cycles */
 394         outb(0x70, ACBCTL2);
 395
 396         if (inb(ACBCTL2) != 0x70) {
 397                 pr_debug(NAME ": ACBCTL2 readback failed\n");
 398                 return -ENXIO;
 399         }
 400
 401         outb(inb(ACBCTL1) | ACBCTL1_NMINTE, ACBCTL1);
 402
 403         val = inb(ACBCTL1);
 404         if (val) {
 405                 pr_debug(NAME ": disabled, but ACBCTL1=0x%02x\n",
 406                         val);
 407                 return -ENXIO;
 408         }
 409
 410         outb(inb(ACBCTL2) | ACBCTL2_ENABLE, ACBCTL2);
 411
 412         outb(inb(ACBCTL1) | ACBCTL1_NMINTE, ACBCTL1);
 413
 414         val = inb(ACBCTL1);
 415         if ((val & ACBCTL1_NMINTE) != ACBCTL1_NMINTE) {
 416                 pr_debug(NAME ": enabled, but NMINTE won't be set, "
 417                          "ACBCTL1=0x%02x\n", val);
 418                 return -ENXIO;
 419         }
 420
 421         return 0;
 422 }
 423
 424 static int  __init scx200_acb_create(const char *text, int base, int index)
 425 {
 426         struct scx200_acb_iface *iface;
 427         struct i2c_adapter *adapter;
 428         int rc;
 429
 430         iface = kzalloc(sizeof(*iface), GFP_KERNEL);
 431         if (!iface) {
 432                 printk(KERN_ERR NAME ": can't allocate memory\n");
 433                 rc = -ENOMEM;
 434                 goto errout;
 435         }
 436
 437         adapter = &iface->adapter;
 438         i2c_set_adapdata(adapter, iface);
 439         snprintf(adapter->name, I2C_NAME_SIZE, "%s ACB%d", text, index);
 440         adapter->owner = THIS_MODULE;
 441         adapter->id = I2C_HW_SMBUS_SCX200;
 442         adapter->algo = &scx200_acb_algorithm;
 443         adapter->class = I2C_CLASS_HWMON;
 444
 445         mutex_init(&iface->mutex);
 446
 447         if (!request_region(base, 8, adapter->name)) {
 448                 printk(KERN_ERR NAME ": can't allocate io 0x%x-0x%x\n",
 449                         base, base + 8-1);
 450                 rc = -EBUSY;
 451                 goto errout_free;
 452         }
 453         iface->base = base;
 454
 455         rc = scx200_acb_probe(iface);
 456         if (rc) {
 457                 printk(KERN_WARNING NAME ": probe failed\n");
 458                 goto errout_release;
 459         }
 460
 461         scx200_acb_reset(iface);
 462
 463         if (i2c_add_adapter(adapter) < 0) {
 464                 printk(KERN_ERR NAME ": failed to register\n");
 465                 rc = -ENODEV;
 466                 goto errout_release;
 467         }
 468
 469         down(&scx200_acb_list_mutex);
 470         iface->next = scx200_acb_list;
 471         scx200_acb_list = iface;
 472         up(&scx200_acb_list_mutex);
 473
 474         return 0;
 475
 476  errout_release:
 477         release_region(iface->base, 8);
 478  errout_free:
 479         kfree(iface);
 480  errout:
 481         return rc;
 482 }
 483
 484 static struct pci_device_id scx200[] = {
 485         { PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_SCx200_BRIDGE) },
 486         { PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_DEVICE_ID_NS_SC1100_BRIDGE) },
 487         { },
 488 };
 489
 490 static struct pci_device_id divil_pci[] = {
 491         { PCI_DEVICE(PCI_VENDOR_ID_NS,  PCI_DEVICE_ID_NS_CS5535_ISA) },
 492         { PCI_DEVICE(PCI_VENDOR_ID_AMD, PCI_DEVICE_ID_AMD_CS5536_ISA) },
 493         { } /* NULL entry */
 494 };
 495
 496 #define MSR_LBAR_SMB            0x5140000B
 497
 498 static __init int scx200_add_cs553x(void)
 499 {
 500         u32     low, hi;
 501         u32     smb_base;
 502
 503         /* Grab & reserve the SMB I/O range */
 504         rdmsr(MSR_LBAR_SMB, low, hi);
 505
 506         /* Check the IO mask and whether SMB is enabled */
 507         if (hi != 0x0000F001) {
 508                 printk(KERN_WARNING NAME ": SMBus not enabled\n");
 509                 return -ENODEV;
 510         }
 511
 512         /* SMBus IO size is 8 bytes */
 513         smb_base = low & 0x0000FFF8;
 514
 515         return scx200_acb_create("CS5535", smb_base, 0);
 516 }
 517
 518 static int __init scx200_acb_init(void)
 519 {
 520         int i;
 521         int     rc = -ENODEV;
 522
 523         pr_debug(NAME ": NatSemi SCx200 ACCESS.bus Driver\n");
 524
 525         /* Verify that this really is a SCx200 processor */
 526         if (pci_dev_present(scx200)) {
 527                 for (i = 0; i < MAX_DEVICES; ++i) {
 528                         if (base[i] > 0)
 529                                 rc = scx200_acb_create("SCx200", base[i], i);
 530                 }
 531         } else if (pci_dev_present(divil_pci))
 532                 rc = scx200_add_cs553x();
 533
 534         /* If at least one bus was created, init must succeed */
 535         if (scx200_acb_list)
 536                 return 0;
 537         return rc;
 538 }
 539
 540 static void __exit scx200_acb_cleanup(void)
 541 {
 542         struct scx200_acb_iface *iface;
 543
 544         down(&scx200_acb_list_mutex);
 545         while ((iface = scx200_acb_list) != NULL) {
 546                 scx200_acb_list = iface->next;
 547                 up(&scx200_acb_list_mutex);
 548
 549                 i2c_del_adapter(&iface->adapter);
 550                 release_region(iface->base, 8);
 551                 kfree(iface);
 552                 down(&scx200_acb_list_mutex);
 553         }
 554         up(&scx200_acb_list_mutex);
 555 }
 556
 557 module_init(scx200_acb_init);
 558 module_exit(scx200_acb_cleanup);