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 <asm/io.h>
 101
 102 #include "scsi.h"
 103 #include "hosts.h"
 104
 105 #include "53c700.h"
 106 #include "NCR_D700.h"
 107
 108 char *NCR_D700;                 /* command line from insmod */
 109
 110 MODULE_AUTHOR("James Bottomley");
 111 MODULE_DESCRIPTION("NCR Dual700 SCSI Driver");
 112 MODULE_LICENSE("GPL");
 113 MODULE_PARM(NCR_D700, "s");
 114
 115 static __u8 __initdata id_array[2*(MCA_MAX_SLOT_NR + 1)] =
 116         { [0 ... 2*(MCA_MAX_SLOT_NR + 1)-1] = 7 };
 117
 118 #ifdef MODULE
 119 #define ARG_SEP ' '
 120 #else
 121 #define ARG_SEP ','
 122 #endif
 123
 124 static int __init
 125 param_setup(char *string)
 126 {
 127         char *pos = string, *next;
 128         int slot = -1, siop = -1;
 129
 130         while(pos != NULL && (next = strchr(pos, ':')) != NULL) {
 131                 int val = (int)simple_strtoul(++next, NULL, 0);
 132
 133                 if(!strncmp(pos, "slot:", 5))
 134                         slot = val;
 135                 else if(!strncmp(pos, "siop:", 5))
 136                         siop = val;
 137                 else if(!strncmp(pos, "id:", 3)) {
 138                         if(slot == -1) {
 139                                 printk(KERN_WARNING "NCR D700: Must specify slot for id parameter\n");
 140                         } else if(slot > MCA_MAX_SLOT_NR) {
 141                                 printk(KERN_WARNING "NCR D700: Illegal slot %d for id %d\n", slot, val);
 142                         } else {
 143                                 if(siop != 0 && siop != 1) {
 144                                         id_array[slot*2] = val;
 145                                         id_array[slot*2 + 1] =val;
 146                                 } else {
 147                                         id_array[slot*2 + siop] = val;
 148                                 }
 149                         }
 150                 }
 151                 if((pos = strchr(pos, ARG_SEP)) != NULL)
 152                         pos++;
 153         }
 154         return 1;
 155 }
 156
 157 /* Host template.  The 53c700 routine NCR_700_detect will
 158  * fill in all of the missing routines */
 159 static Scsi_Host_Template NCR_D700_driver_template = {
 160         .module                 = THIS_MODULE,
 161         .name                   = "NCR Dual 700 MCA",
 162         .proc_name              = "NCR_D700",
 163         .this_id                = 7,
 164 };
 165
 166 /* We needs this helper because we have two hosts per struct device */
 167 struct NCR_D700_private {
 168         struct device           *dev;
 169         struct Scsi_Host        *hosts[2];
 170 };
 171
 172 static int
 173 NCR_D700_probe_one(struct NCR_D700_private *p, int siop,
 174                 int irq, int slot, u32 region, int differential)
 175 {
 176         struct NCR_700_Host_Parameters *hostdata;
 177         struct Scsi_Host *host;
 178         int ret;
 179
 180         hostdata = kmalloc(sizeof(*hostdata), GFP_KERNEL);
 181         if (!hostdata) {
 182                 printk(KERN_ERR "NCR D700: SIOP%d: Failed to allocate host"
 183                        "data, detatching\n", siop);
 184                 return -ENOMEM;
 185         }
 186         memset(hostdata, 0, sizeof(*hostdata));
 187
 188         if (!request_region(region, 64, "NCR_D700")) {
 189                 printk(KERN_ERR "NCR D700: Failed to reserve IO region 0x%x\n",
 190                                 region);
 191                 ret = -ENODEV;
 192                 goto region_failed;
 193         }
 194
 195         /* Fill in the three required pieces of hostdata */
 196         hostdata->base = region;
 197         hostdata->differential = (((1<<siop) & differential) != 0);
 198         hostdata->clock = NCR_D700_CLOCK_MHZ;
 199
 200         NCR_700_set_io_mapped(hostdata);
 201
 202         /* and register the siop */
 203         host = NCR_700_detect(&NCR_D700_driver_template, hostdata);
 204         if (!host) {
 205                 ret = -ENOMEM;
 206                 goto detect_failed;
 207         }
 208
 209         host->irq = irq;
 210         /* FIXME: Read this from SUS */
 211         host->this_id = id_array[slot * 2 + siop];
 212         printk(KERN_NOTICE "NCR D700: SIOP%d, SCSI id is %d\n",
 213                         siop, host->this_id);
 214         if (request_irq(irq, NCR_700_intr, SA_SHIRQ, "NCR_D700", host)) {
 215                 printk(KERN_ERR "NCR D700: SIOP%d: irq problem, "
 216                                 "detatching\n", siop);
 217                 ret = -ENODEV;
 218                 goto irq_failed;
 219         }
 220
 221         scsi_add_host(host, p->dev); /* XXX handle failure */
 222         scsi_scan_host(host);
 223
 224         p->hosts[siop] = host;
 225         hostdata->dev = p->dev;
 226         return 0;
 227
 228  irq_failed:
 229         scsi_host_put(host);
 230         NCR_700_release(host);
 231  detect_failed:
 232         release_region(host->base, 64);
 233  region_failed:
 234         kfree(hostdata);
 235
 236         return ret;
 237 }
 238
 239 /* Detect a D700 card.  Note, because of the setup --- the chips are
 240  * essentially connectecd to the MCA bus independently, it is easier
 241  * to set them up as two separate host adapters, rather than one
 242  * adapter with two channels */
 243 static int
 244 NCR_D700_probe(struct device *dev)
 245 {
 246         struct NCR_D700_private *p;
 247         int differential;
 248         static int banner = 1;
 249         struct mca_device *mca_dev = to_mca_device(dev);
 250         int slot = mca_dev->slot;
 251         int found = 0;
 252         int irq, i;
 253         int pos3j, pos3k, pos3a, pos3b, pos4;
 254         __u32 base_addr, offset_addr;
 255
 256         /* enable board interrupt */
 257         pos4 = mca_device_read_pos(mca_dev, 4);
 258         pos4 |= 0x4;
 259         mca_device_write_pos(mca_dev, 4, pos4);
 260
 261         mca_device_write_pos(mca_dev, 6, 9);
 262         pos3j = mca_device_read_pos(mca_dev, 3);
 263         mca_device_write_pos(mca_dev, 6, 10);
 264         pos3k = mca_device_read_pos(mca_dev, 3);
 265         mca_device_write_pos(mca_dev, 6, 0);
 266         pos3a = mca_device_read_pos(mca_dev, 3);
 267         mca_device_write_pos(mca_dev, 6, 1);
 268         pos3b = mca_device_read_pos(mca_dev, 3);
 269
 270         base_addr = ((pos3j << 8) | pos3k) & 0xfffffff0;
 271         offset_addr = ((pos3a << 8) | pos3b) & 0xffffff70;
 272
 273         irq = (pos4 & 0x3) + 11;
 274         if(irq >= 13)
 275                 irq++;
 276         if(banner) {
 277                 printk(KERN_NOTICE "NCR D700: Driver Version " NCR_D700_VERSION "\n"
 278                        "NCR D700:  Copyright (c) 2001 by James.Bottomley@HansenPartnership.com\n"
 279                        "NCR D700:\n");
 280                 banner = 0;
 281         }
 282         /* now do the bus related transforms */
 283         irq = mca_device_transform_irq(mca_dev, irq);
 284         base_addr = mca_device_transform_ioport(mca_dev, base_addr);
 285         offset_addr = mca_device_transform_ioport(mca_dev, offset_addr);
 286
 287         printk(KERN_NOTICE "NCR D700: found in slot %d  irq = %d  I/O base = 0x%x\n", slot, irq, offset_addr);
 288
 289         /*outb(BOARD_RESET, base_addr);*/
 290
 291         /* clear any pending interrupts */
 292         (void)inb(base_addr + 0x08);
 293         /* get modctl, used later for setting diff bits */
 294         switch(differential = (inb(base_addr + 0x08) >> 6)) {
 295         case 0x00:
 296                 /* only SIOP1 differential */
 297                 differential = 0x02;
 298                 break;
 299         case 0x01:
 300                 /* Both SIOPs differential */
 301                 differential = 0x03;
 302                 break;
 303         case 0x03:
 304                 /* No SIOPs differential */
 305                 differential = 0x00;
 306                 break;
 307         default:
 308                 printk(KERN_ERR "D700: UNEXPECTED DIFFERENTIAL RESULT 0x%02x\n",
 309                        differential);
 310                 differential = 0x00;
 311                 break;
 312         }
 313
 314         p = kmalloc(sizeof(*p), GFP_KERNEL);
 315         if (!p)
 316                 return -ENOMEM;
 317         p->dev = dev;
 318
 319         /* plumb in both 700 chips */
 320         for (i = 0; i < 2; i++) {
 321                 int err;
 322
 323                 if ((err = NCR_D700_probe_one(p, i, irq, slot,
 324                                               offset_addr + (0x80 * i),
 325                                               differential)) != 0)
 326                         printk("D700: SIOP%d: probe failed, error = %d\n",
 327                                i, err);
 328                 else
 329                         found++;
 330         }
 331
 332         if (!found) {
 333                 kfree(p);
 334                 return -ENODEV;
 335         }
 336
 337         mca_device_set_claim(mca_dev, 1);
 338         mca_device_set_name(mca_dev, "NCR_D700");
 339         dev_set_drvdata(dev, p);
 340         return 0;
 341 }
 342
 343 static void
 344 NCR_D700_remove_one(struct Scsi_Host *host)
 345 {
 346         scsi_remove_host(host);
 347         NCR_700_release(host);
 348         kfree((struct NCR_700_Host_Parameters *)host->hostdata[0]);
 349         free_irq(host->irq, host);
 350         release_region(host->base, 64);
 351 }
 352
 353 static int
 354 NCR_D700_remove(struct device *dev)
 355 {
 356         struct NCR_D700_private *p = dev_get_drvdata(dev);
 357         int i;
 358
 359         for (i = 0; i < 2; i++)
 360                 NCR_D700_remove_one(p->hosts[i]);
 361
 362         kfree(p);
 363         return 0;
 364 }
 365
 366 static short NCR_D700_id_table[] = { NCR_D700_MCA_ID, 0 };
 367
 368 struct mca_driver NCR_D700_driver = {
 369         .id_table = NCR_D700_id_table,
 370         .driver = {
 371                 .name           = "NCR_D700",
 372                 .bus            = &mca_bus_type,
 373                 .probe          = NCR_D700_probe,
 374                 .remove         = NCR_D700_remove,
 375         },
 376 };
 377
 378 static int __init NCR_D700_init(void)
 379 {
 380 #ifdef MODULE
 381         if (NCR_D700)
 382                 param_setup(NCR_D700);
 383 #endif
 384
 385         return mca_register_driver(&NCR_D700_driver);
 386 }
 387
 388 static void __exit NCR_D700_exit(void)
 389 {
 390         mca_unregister_driver(&NCR_D700_driver);
 391 }
 392
 393 module_init(NCR_D700_init);
 394 module_exit(NCR_D700_exit);
 395
 396 __setup("NCR_D700=", param_setup);