drivers/scsi/NCR_D700.c

   1 /* -*- mode: c; c-basic-offset: 8 -*- */
   2
   3 /* NCR Dual 700 MCA SCSI Driver
   4  *
   5  * Copyright (C) 2001 by James.Bottomley@HansenPartnership.com
   6 **-----------------------------------------------------------------------------
   7 **
   8 **  This program is free software; you can redistribute it and/or modify
   9 **  it under the terms of the GNU General Public License as published by
  10 **  the Free Software Foundation; either version 2 of the License, or
  11 **  (at your option) any later version.
  12 **
  13 **  This program is distributed in the hope that it will be useful,
  14 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 **  GNU General Public License for more details.
  17 **
  18 **  You should have received a copy of the GNU General Public License
  19 **  along with this program; if not, write to the Free Software
  20 **  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 **
  22 **-----------------------------------------------------------------------------
  23  */
  24
  25 /* Notes:
  26  *
  27  * Most of the work is done in the chip specific module, 53c700.o
  28  *
  29  * TODO List:
  30  *
  31  * 1. Extract the SCSI ID from the voyager CMOS table (necessary to
  32  *    support multi-host environments.
  33  *
  34  * */
  35
  36
  37 /* CHANGELOG
  38  *
  39  * Version 2.2
  40  *
  41  * Added mca_set_adapter_name().
  42  *
  43  * Version 2.1
  44  *
  45  * Modularise the driver into a Board piece (this file) and a chip
  46  * piece 53c700.[ch] and 53c700.scr, added module options.  You can
  47  * now specify the scsi id by the parameters
  48  *
  49  * NCR_D700=slot:<n> [siop:<n>] id:<n> ....
  50  *
  51  * They need to be comma separated if compiled into the kernel
  52  *
  53  * Version 2.0
  54  *
  55  * Initial implementation of TCQ (Tag Command Queueing).  TCQ is full
  56  * featured and uses the clock algorithm to keep track of outstanding
  57  * tags and guard against individual tag starvation.  Also fixed a bug
  58  * in all of the 1.x versions where the D700_data_residue() function
  59  * was returning results off by 32 bytes (and thus causing the same 32
  60  * bytes to be written twice corrupting the data block).  It turns out
  61  * the 53c700 only has a 6 bit DBC and DFIFO registers not 7 bit ones
  62  * like the 53c710 (The 710 is the only data manual still available,
  63  * which I'd been using to program the 700).
  64  *
  65  * Version 1.2
  66  *
  67  * Much improved message handling engine
  68  *
  69  * Version 1.1
  70  *
  71  * Add code to handle selection reasonably correctly.  By the time we
  72  * get the selection interrupt, we've already responded, but drop off the
  73  * bus and hope the selector will go away.
  74  *
  75  * Version 1.0:
  76  *
  77  *   Initial release.  Fully functional except for procfs and tag
  78  * command queueing.  Has only been tested on cards with 53c700-66
  79  * chips and only single ended. Features are
  80  *
  81  * 1. Synchronous data transfers to offset 8 (limit of 700-66) and
  82  *    100ns (10MHz) limit of SCSI-2
  83  *
  84  * 2. Disconnection and reselection
  85  *
  86  * Testing:
  87  *
  88  *  I've only really tested this with the 700-66 chip, but have done
  89  * soak tests in multi-device environments to verify that
  90  * disconnections and reselections are being processed correctly.
  91  * */
  92
  93 #define NCR_D700_VERSION "2.2"
  94
  95 #include <linux/blkdev.h>
  96 #include <linux/interrupt.h>
  97 #include <linux/kernel.h>
  98 #include <linux/module.h>
  99 #include <linux/mca.h>
 100 #include <linux/slab.h>
 101 #include <asm/io.h>
 102 #include <scsi/scsi_host.h>
 103 #include <scsi/scsi_device.h>
 104 #include <scsi/scsi_transport.h>
 105 #include <scsi/scsi_transport_spi.h>
 106
 107 #include "53c700.h"
 108 #include "NCR_D700.h"
 109
 110 static char *NCR_D700;          /* command line from insmod */
 111
 112 MODULE_AUTHOR("James Bottomley");
 113 MODULE_DESCRIPTION("NCR Dual700 SCSI Driver");
 114 MODULE_LICENSE("GPL");
 115 module_param(NCR_D700, charp, 0);
 116
 117 static __u8 __devinitdata id_array[2*(MCA_MAX_SLOT_NR + 1)] =
 118         { [0 ... 2*(MCA_MAX_SLOT_NR + 1)-1] = 7 };
 119
 120 #ifdef MODULE
 121 #define ARG_SEP ' '
 122 #else
 123 #define ARG_SEP ','
 124 #endif
 125
 126 static int __init
 127 param_setup(char *string)
 128 {
 129         char *pos = string, *next;
 130         int slot = -1, siop = -1;
 131
 132         while(pos != NULL && (next = strchr(pos, ':')) != NULL) {
 133                 int val = (int)simple_strtoul(++next, NULL, 0);
 134
 135                 if(!strncmp(pos, "slot:", 5))
 136                         slot = val;
 137                 else if(!strncmp(pos, "siop:", 5))
 138                         siop = val;
 139                 else if(!strncmp(pos, "id:", 3)) {
 140                         if(slot == -1) {
 141                                 printk(KERN_WARNING "NCR D700: Must specify slot for id parameter\n");
 142                         } else if(slot > MCA_MAX_SLOT_NR) {
 143                                 printk(KERN_WARNING "NCR D700: Illegal slot %d for id %d\n", slot, val);
 144                         } else {
 145                                 if(siop != 0 && siop != 1) {
 146                                         id_array[slot*2] = val;
 147                                         id_array[slot*2 + 1] =val;
 148                                 } else {
 149                                         id_array[slot*2 + siop] = val;
 150                                 }
 151                         }
 152                 }
 153                 if((pos = strchr(pos, ARG_SEP)) != NULL)
 154                         pos++;
 155         }
 156         return 1;
 157 }
 158
 159 /* Host template.  The 53c700 routine NCR_700_detect will
 160  * fill in all of the missing routines */
 161 static struct scsi_host_template NCR_D700_driver_template = {
 162         .module                 = THIS_MODULE,
 163         .name                   = "NCR Dual 700 MCA",
 164         .proc_name              = "NCR_D700",
 165         .this_id                = 7,
 166 };
 167
 168 /* We needs this helper because we have two hosts per struct device */
 169 struct NCR_D700_private {
 170         struct device           *dev;
 171         struct Scsi_Host        *hosts[2];
 172         char                    name[30];
 173         char                    pad;
 174 };
 175
 176 static int __devinit
 177 NCR_D700_probe_one(struct NCR_D700_private *p, int siop, int irq,
 178                    int slot, u32 region, int differential)
 179 {
 180         struct NCR_700_Host_Parameters *hostdata;
 181         struct Scsi_Host *host;
 182         int ret;
 183
 184         hostdata = kzalloc(sizeof(*hostdata), GFP_KERNEL);
 185         if (!hostdata) {
 186                 printk(KERN_ERR "NCR D700: SIOP%d: Failed to allocate host"
 187                        "data, detatching\n", siop);
 188                 return -ENOMEM;
 189         }
 190
 191         if (!request_region(region, 64, "NCR_D700")) {
 192                 printk(KERN_ERR "NCR D700: Failed to reserve IO region 0x%x\n",
 193                                 region);
 194                 ret = -ENODEV;
 195                 goto region_failed;
 196         }
 197
 198         /* Fill in the three required pieces of hostdata */
 199         hostdata->base = ioport_map(region, 64);
 200         hostdata->differential = (((1<<siop) & differential) != 0);
 201         hostdata->clock = NCR_D700_CLOCK_MHZ;
 202         hostdata->burst_length = 8;
 203
 204         /* and register the siop */
 205         host = NCR_700_detect(&NCR_D700_driver_template, hostdata, p->dev);
 206         if (!host) {
 207                 ret = -ENOMEM;
 208                 goto detect_failed;
 209         }
 210
 211         p->hosts[siop] = host;
 212         /* FIXME: read this from SUS */
 213         host->this_id = id_array[slot * 2 + siop];
 214         host->irq = irq;
 215         host->base = region;
 216         scsi_scan_host(host);
 217
 218         return 0;
 219
 220  detect_failed:
 221         release_region(region, 64);
 222  region_failed:
 223         kfree(hostdata);
 224
 225         return ret;
 226 }
 227
 228 static irqreturn_t
 229 NCR_D700_intr(int irq, void *data)
 230 {
 231         struct NCR_D700_private *p = (struct NCR_D700_private *)data;
 232         int i, found = 0;
 233
 234         for (i = 0; i < 2; i++)
 235                 if (p->hosts[i] &&
 236                     NCR_700_intr(irq, p->hosts[i]) == IRQ_HANDLED)
 237                         found++;
 238
 239         return found ? IRQ_HANDLED : IRQ_NONE;
 240 }
 241
 242 /* Detect a D700 card.  Note, because of the setup --- the chips are
 243  * essentially connectecd to the MCA bus independently, it is easier
 244  * to set them up as two separate host adapters, rather than one
 245  * adapter with two channels */
 246 static int __devinit
 247 NCR_D700_probe(struct device *dev)
 248 {
 249         struct NCR_D700_private *p;
 250         int differential;
 251         static int banner = 1;
 252         struct mca_device *mca_dev = to_mca_device(dev);
 253         int slot = mca_dev->slot;
 254         int found = 0;
 255         int irq, i;
 256         int pos3j, pos3k, pos3a, pos3b, pos4;
 257         __u32 base_addr, offset_addr;
 258
 259         /* enable board interrupt */
 260         pos4 = mca_device_read_pos(mca_dev, 4);
 261         pos4 |= 0x4;
 262         mca_device_write_pos(mca_dev, 4, pos4);
 263
 264         mca_device_write_pos(mca_dev, 6, 9);
 265         pos3j = mca_device_read_pos(mca_dev, 3);
 266         mca_device_write_pos(mca_dev, 6, 10);
 267         pos3k = mca_device_read_pos(mca_dev, 3);
 268         mca_device_write_pos(mca_dev, 6, 0);
 269         pos3a = mca_device_read_pos(mca_dev, 3);
 270         mca_device_write_pos(mca_dev, 6, 1);
 271         pos3b = mca_device_read_pos(mca_dev, 3);
 272
 273         base_addr = ((pos3j << 8) | pos3k) & 0xfffffff0;
 274         offset_addr = ((pos3a << 8) | pos3b) & 0xffffff70;
 275
 276         irq = (pos4 & 0x3) + 11;
 277         if(irq >= 13)
 278                 irq++;
 279         if(banner) {
 280                 printk(KERN_NOTICE "NCR D700: Driver Version " NCR_D700_VERSION "\n"
 281                        "NCR D700:  Copyright (c) 2001 by James.Bottomley@HansenPartnership.com\n"
 282                        "NCR D700:\n");
 283                 banner = 0;
 284         }
 285         /* now do the bus related transforms */
 286         irq = mca_device_transform_irq(mca_dev, irq);
 287         base_addr = mca_device_transform_ioport(mca_dev, base_addr);
 288         offset_addr = mca_device_transform_ioport(mca_dev, offset_addr);
 289
 290         printk(KERN_NOTICE "NCR D700: found in slot %d  irq = %d  I/O base = 0x%x\n", slot, irq, offset_addr);
 291
 292         /*outb(BOARD_RESET, base_addr);*/
 293
 294         /* clear any pending interrupts */
 295         (void)inb(base_addr + 0x08);
 296         /* get modctl, used later for setting diff bits */
 297         switch(differential = (inb(base_addr + 0x08) >> 6)) {
 298         case 0x00:
 299                 /* only SIOP1 differential */
 300                 differential = 0x02;
 301                 break;
 302         case 0x01:
 303                 /* Both SIOPs differential */
 304                 differential = 0x03;
 305                 break;
 306         case 0x03:
 307                 /* No SIOPs differential */
 308                 differential = 0x00;
 309                 break;
 310         default:
 311                 printk(KERN_ERR "D700: UNEXPECTED DIFFERENTIAL RESULT 0x%02x\n",
 312                        differential);
 313                 differential = 0x00;
 314                 break;
 315         }
 316
 317         p = kzalloc(sizeof(*p), GFP_KERNEL);
 318         if (!p)
 319                 return -ENOMEM;
 320
 321         p->dev = dev;
 322         snprintf(p->name, sizeof(p->name), "D700(%s)", dev_name(dev));
 323         if (request_irq(irq, NCR_D700_intr, IRQF_SHARED, p->name, p)) {
 324                 printk(KERN_ERR "D700: request_irq failed\n");
 325                 kfree(p);
 326                 return -EBUSY;
 327         }
 328         /* plumb in both 700 chips */
 329         for (i = 0; i < 2; i++) {
 330                 int err;
 331
 332                 if ((err = NCR_D700_probe_one(p, i, irq, slot,
 333                                               offset_addr + (0x80 * i),
 334                                               differential)) != 0)
 335                         printk("D700: SIOP%d: probe failed, error = %d\n",
 336                                i, err);
 337                 else
 338                         found++;
 339         }
 340
 341         if (!found) {
 342                 kfree(p);
 343                 return -ENODEV;
 344         }
 345
 346         mca_device_set_claim(mca_dev, 1);
 347         mca_device_set_name(mca_dev, "NCR_D700");
 348         dev_set_drvdata(dev, p);
 349         return 0;
 350 }
 351
 352 static void __devexit
 353 NCR_D700_remove_one(struct Scsi_Host *host)
 354 {
 355         scsi_remove_host(host);
 356         NCR_700_release(host);
 357         kfree((struct NCR_700_Host_Parameters *)host->hostdata[0]);
 358         free_irq(host->irq, host);
 359         release_region(host->base, 64);
 360 }
 361
 362 static int __devexit
 363 NCR_D700_remove(struct device *dev)
 364 {
 365         struct NCR_D700_private *p = dev_get_drvdata(dev);
 366         int i;
 367
 368         for (i = 0; i < 2; i++)
 369                 NCR_D700_remove_one(p->hosts[i]);
 370
 371         kfree(p);
 372         return 0;
 373 }
 374
 375 static short NCR_D700_id_table[] = { NCR_D700_MCA_ID, 0 };
 376
 377 static struct mca_driver NCR_D700_driver = {
 378         .id_table = NCR_D700_id_table,
 379         .driver = {
 380                 .name           = "NCR_D700",
 381                 .bus            = &mca_bus_type,
 382                 .probe          = NCR_D700_probe,
 383                 .remove         = __devexit_p(NCR_D700_remove),
 384         },
 385 };
 386
 387 static int __init NCR_D700_init(void)
 388 {
 389 #ifdef MODULE
 390         if (NCR_D700)
 391                 param_setup(NCR_D700);
 392 #endif
 393
 394         return mca_register_driver(&NCR_D700_driver);
 395 }
 396
 397 static void __exit NCR_D700_exit(void)
 398 {
 399         mca_unregister_driver(&NCR_D700_driver);
 400 }
 401
 402 module_init(NCR_D700_init);
 403 module_exit(NCR_D700_exit);
 404
 405 __setup("NCR_D700=", param_setup);