drivers/scsi/mac_scsi.c

   1 /*
   2  * Generic Macintosh NCR5380 driver
   3  *
   4  * Copyright 1998, Michael Schmitz <mschmitz@lbl.gov>
   5  *
   6  * derived in part from:
   7  */
   8 /*
   9  * Generic Generic NCR5380 driver
  10  *
  11  * Copyright 1995, Russell King
  12  */
  13
  14 #include <linux/types.h>
  15 #include <linux/module.h>
  16 #include <linux/ioport.h>
  17 #include <linux/init.h>
  18 #include <linux/blkdev.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/platform_device.h>
  21
  22 #include <asm/hwtest.h>
  23 #include <asm/io.h>
  24 #include <asm/macints.h>
  25 #include <asm/setup.h>
  26
  27 #include <scsi/scsi_host.h>
  28
  29 /* Definitions for the core NCR5380 driver. */
  30
  31 #define NCR5380_implementation_fields   unsigned char *pdma_base
  32
  33 #define NCR5380_read(reg)               macscsi_read(instance, reg)
  34 #define NCR5380_write(reg, value)       macscsi_write(instance, reg, value)
  35
  36 #define NCR5380_dma_xfer_len(instance, cmd, phase) \
  37         macscsi_dma_xfer_len(instance, cmd)
  38 #define NCR5380_dma_recv_setup          macscsi_pread
  39 #define NCR5380_dma_send_setup          macscsi_pwrite
  40
  41 #define NCR5380_intr                    macscsi_intr
  42 #define NCR5380_queue_command           macscsi_queue_command
  43 #define NCR5380_abort                   macscsi_abort
  44 #define NCR5380_bus_reset               macscsi_bus_reset
  45 #define NCR5380_info                    macscsi_info
  46
  47 #include "NCR5380.h"
  48
  49 static int setup_can_queue = -1;
  50 module_param(setup_can_queue, int, 0);
  51 static int setup_cmd_per_lun = -1;
  52 module_param(setup_cmd_per_lun, int, 0);
  53 static int setup_sg_tablesize = -1;
  54 module_param(setup_sg_tablesize, int, 0);
  55 static int setup_use_pdma = -1;
  56 module_param(setup_use_pdma, int, 0);
  57 static int setup_use_tagged_queuing = -1;
  58 module_param(setup_use_tagged_queuing, int, 0);
  59 static int setup_hostid = -1;
  60 module_param(setup_hostid, int, 0);
  61 static int setup_toshiba_delay = -1;
  62 module_param(setup_toshiba_delay, int, 0);
  63
  64 /*
  65  * NCR 5380 register access functions
  66  */
  67
  68 static inline char macscsi_read(struct Scsi_Host *instance, int reg)
  69 {
  70         return in_8(instance->base + (reg << 4));
  71 }
  72
  73 static inline void macscsi_write(struct Scsi_Host *instance, int reg, int value)
  74 {
  75         out_8(instance->base + (reg << 4), value);
  76 }
  77
  78 #ifndef MODULE
  79 static int __init mac_scsi_setup(char *str)
  80 {
  81         int ints[8];
  82
  83         (void)get_options(str, ARRAY_SIZE(ints), ints);
  84
  85         if (ints[0] < 1) {
  86                 pr_err("Usage: mac5380=<can_queue>[,<cmd_per_lun>[,<sg_tablesize>[,<hostid>[,<use_tags>[,<use_pdma>[,<toshiba_delay>]]]]]]\n");
  87                 return 0;
  88         }
  89         if (ints[0] >= 1)
  90                 setup_can_queue = ints[1];
  91         if (ints[0] >= 2)
  92                 setup_cmd_per_lun = ints[2];
  93         if (ints[0] >= 3)
  94                 setup_sg_tablesize = ints[3];
  95         if (ints[0] >= 4)
  96                 setup_hostid = ints[4];
  97         if (ints[0] >= 5)
  98                 setup_use_tagged_queuing = ints[5];
  99         if (ints[0] >= 6)
 100                 setup_use_pdma = ints[6];
 101         if (ints[0] >= 7)
 102                 setup_toshiba_delay = ints[7];
 103         return 1;
 104 }
 105
 106 __setup("mac5380=", mac_scsi_setup);
 107 #endif /* !MODULE */
 108
 109 /*
 110    Pseudo-DMA: (Ove Edlund)
 111    The code attempts to catch bus errors that occur if one for example
 112    "trips over the cable".
 113    XXX: Since bus errors in the PDMA routines never happen on my
 114    computer, the bus error code is untested.
 115    If the code works as intended, a bus error results in Pseudo-DMA
 116    being disabled, meaning that the driver switches to slow handshake.
 117    If bus errors are NOT extremely rare, this has to be changed.
 118 */
 119
 120 #define CP_IO_TO_MEM(s,d,len)                           \
 121 __asm__ __volatile__                                    \
 122     ("    cmp.w  #4,%2\n"                               \
 123      "    bls    8f\n"                                  \
 124      "    move.w %1,%%d0\n"                             \
 125      "    neg.b  %%d0\n"                                \
 126      "    and.w  #3,%%d0\n"                             \
 127      "    sub.w  %%d0,%2\n"                             \
 128      "    bra    2f\n"                                  \
 129      " 1: move.b (%0),(%1)+\n"                          \
 130      " 2: dbf    %%d0,1b\n"                             \
 131      "    move.w %2,%%d0\n"                             \
 132      "    lsr.w  #5,%%d0\n"                             \
 133      "    bra    4f\n"                                  \
 134      " 3: move.l (%0),(%1)+\n"                          \
 135      "31: move.l (%0),(%1)+\n"                          \
 136      "32: move.l (%0),(%1)+\n"                          \
 137      "33: move.l (%0),(%1)+\n"                          \
 138      "34: move.l (%0),(%1)+\n"                          \
 139      "35: move.l (%0),(%1)+\n"                          \
 140      "36: move.l (%0),(%1)+\n"                          \
 141      "37: move.l (%0),(%1)+\n"                          \
 142      " 4: dbf    %%d0,3b\n"                             \
 143      "    move.w %2,%%d0\n"                             \
 144      "    lsr.w  #2,%%d0\n"                             \
 145      "    and.w  #7,%%d0\n"                             \
 146      "    bra    6f\n"                                  \
 147      " 5: move.l (%0),(%1)+\n"                          \
 148      " 6: dbf    %%d0,5b\n"                             \
 149      "    and.w  #3,%2\n"                               \
 150      "    bra    8f\n"                                  \
 151      " 7: move.b (%0),(%1)+\n"                          \
 152      " 8: dbf    %2,7b\n"                               \
 153      "    moveq.l #0, %2\n"                             \
 154      " 9: \n"                                           \
 155      ".section .fixup,\"ax\"\n"                         \
 156      "    .even\n"                                      \
 157      "90: moveq.l #1, %2\n"                             \
 158      "    jra 9b\n"                                     \
 159      ".previous\n"                                      \
 160      ".section __ex_table,\"a\"\n"                      \
 161      "   .align 4\n"                                    \
 162      "   .long  1b,90b\n"                               \
 163      "   .long  3b,90b\n"                               \
 164      "   .long 31b,90b\n"                               \
 165      "   .long 32b,90b\n"                               \
 166      "   .long 33b,90b\n"                               \
 167      "   .long 34b,90b\n"                               \
 168      "   .long 35b,90b\n"                               \
 169      "   .long 36b,90b\n"                               \
 170      "   .long 37b,90b\n"                               \
 171      "   .long  5b,90b\n"                               \
 172      "   .long  7b,90b\n"                               \
 173      ".previous"                                        \
 174      : "=a"(s), "=a"(d), "=d"(len)                      \
 175      : "0"(s), "1"(d), "2"(len)                         \
 176      : "d0")
 177
 178 static int macscsi_pread(struct Scsi_Host *instance,
 179                          unsigned char *dst, int len)
 180 {
 181         struct NCR5380_hostdata *hostdata = shost_priv(instance);
 182         unsigned char *d;
 183         unsigned char *s;
 184
 185         s = hostdata->pdma_base + (INPUT_DATA_REG << 4);
 186         d = dst;
 187
 188         /* These conditions are derived from MacOS */
 189
 190         while (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_DRQ) &&
 191                !(NCR5380_read(STATUS_REG) & SR_REQ))
 192                 ;
 193
 194         if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_DRQ) &&
 195             (NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH)) {
 196                 pr_err("Error in macscsi_pread\n");
 197                 return -1;
 198         }
 199
 200         CP_IO_TO_MEM(s, d, len);
 201
 202         if (len != 0) {
 203                 pr_notice("Bus error in macscsi_pread\n");
 204                 return -1;
 205         }
 206
 207         return 0;
 208 }
 209
 210
 211 #define CP_MEM_TO_IO(s,d,len)                           \
 212 __asm__ __volatile__                                    \
 213     ("    cmp.w  #4,%2\n"                               \
 214      "    bls    8f\n"                                  \
 215      "    move.w %0,%%d0\n"                             \
 216      "    neg.b  %%d0\n"                                \
 217      "    and.w  #3,%%d0\n"                             \
 218      "    sub.w  %%d0,%2\n"                             \
 219      "    bra    2f\n"                                  \
 220      " 1: move.b (%0)+,(%1)\n"                          \
 221      " 2: dbf    %%d0,1b\n"                             \
 222      "    move.w %2,%%d0\n"                             \
 223      "    lsr.w  #5,%%d0\n"                             \
 224      "    bra    4f\n"                                  \
 225      " 3: move.l (%0)+,(%1)\n"                          \
 226      "31: move.l (%0)+,(%1)\n"                          \
 227      "32: move.l (%0)+,(%1)\n"                          \
 228      "33: move.l (%0)+,(%1)\n"                          \
 229      "34: move.l (%0)+,(%1)\n"                          \
 230      "35: move.l (%0)+,(%1)\n"                          \
 231      "36: move.l (%0)+,(%1)\n"                          \
 232      "37: move.l (%0)+,(%1)\n"                          \
 233      " 4: dbf    %%d0,3b\n"                             \
 234      "    move.w %2,%%d0\n"                             \
 235      "    lsr.w  #2,%%d0\n"                             \
 236      "    and.w  #7,%%d0\n"                             \
 237      "    bra    6f\n"                                  \
 238      " 5: move.l (%0)+,(%1)\n"                          \
 239      " 6: dbf    %%d0,5b\n"                             \
 240      "    and.w  #3,%2\n"                               \
 241      "    bra    8f\n"                                  \
 242      " 7: move.b (%0)+,(%1)\n"                          \
 243      " 8: dbf    %2,7b\n"                               \
 244      "    moveq.l #0, %2\n"                             \
 245      " 9: \n"                                           \
 246      ".section .fixup,\"ax\"\n"                         \
 247      "    .even\n"                                      \
 248      "90: moveq.l #1, %2\n"                             \
 249      "    jra 9b\n"                                     \
 250      ".previous\n"                                      \
 251      ".section __ex_table,\"a\"\n"                      \
 252      "   .align 4\n"                                    \
 253      "   .long  1b,90b\n"                               \
 254      "   .long  3b,90b\n"                               \
 255      "   .long 31b,90b\n"                               \
 256      "   .long 32b,90b\n"                               \
 257      "   .long 33b,90b\n"                               \
 258      "   .long 34b,90b\n"                               \
 259      "   .long 35b,90b\n"                               \
 260      "   .long 36b,90b\n"                               \
 261      "   .long 37b,90b\n"                               \
 262      "   .long  5b,90b\n"                               \
 263      "   .long  7b,90b\n"                               \
 264      ".previous"                                        \
 265      : "=a"(s), "=a"(d), "=d"(len)                      \
 266      : "0"(s), "1"(d), "2"(len)                         \
 267      : "d0")
 268
 269 static int macscsi_pwrite(struct Scsi_Host *instance,
 270                           unsigned char *src, int len)
 271 {
 272         struct NCR5380_hostdata *hostdata = shost_priv(instance);
 273         unsigned char *s;
 274         unsigned char *d;
 275
 276         s = src;
 277         d = hostdata->pdma_base + (OUTPUT_DATA_REG << 4);
 278
 279         /* These conditions are derived from MacOS */
 280
 281         while (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_DRQ) &&
 282                (!(NCR5380_read(STATUS_REG) & SR_REQ) ||
 283                 (NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH)))
 284                 ;
 285
 286         if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_DRQ)) {
 287                 pr_err("Error in macscsi_pwrite\n");
 288                 return -1;
 289         }
 290
 291         CP_MEM_TO_IO(s, d, len);
 292
 293         if (len != 0) {
 294                 pr_notice("Bus error in macscsi_pwrite\n");
 295                 return -1;
 296         }
 297
 298         return 0;
 299 }
 300
 301 static int macscsi_dma_xfer_len(struct Scsi_Host *instance,
 302                                 struct scsi_cmnd *cmd)
 303 {
 304         struct NCR5380_hostdata *hostdata = shost_priv(instance);
 305
 306         if (hostdata->flags & FLAG_NO_PSEUDO_DMA)
 307                 return 0;
 308
 309         return cmd->transfersize;
 310 }
 311
 312 #include "NCR5380.c"
 313
 314 #define DRV_MODULE_NAME         "mac_scsi"
 315 #define PFX                     DRV_MODULE_NAME ": "
 316
 317 static struct scsi_host_template mac_scsi_template = {
 318         .module                 = THIS_MODULE,
 319         .proc_name              = DRV_MODULE_NAME,
 320         .name                   = "Macintosh NCR5380 SCSI",
 321         .info                   = macscsi_info,
 322         .queuecommand           = macscsi_queue_command,
 323         .eh_abort_handler       = macscsi_abort,
 324         .eh_bus_reset_handler   = macscsi_bus_reset,
 325         .can_queue              = 16,
 326         .this_id                = 7,
 327         .sg_tablesize           = SG_ALL,
 328         .cmd_per_lun            = 2,
 329         .use_clustering         = DISABLE_CLUSTERING,
 330         .cmd_size               = NCR5380_CMD_SIZE,
 331         .max_sectors            = 128,
 332 };
 333
 334 static int __init mac_scsi_probe(struct platform_device *pdev)
 335 {
 336         struct Scsi_Host *instance;
 337         int error;
 338         int host_flags = 0;
 339         struct resource *irq, *pio_mem, *pdma_mem = NULL;
 340
 341         pio_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 342         if (!pio_mem)
 343                 return -ENODEV;
 344
 345         pdma_mem = platform_get_resource(pdev, IORESOURCE_MEM, 1);
 346
 347         irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 348
 349         if (!hwreg_present((unsigned char *)pio_mem->start +
 350                            (STATUS_REG << 4))) {
 351                 pr_info(PFX "no device detected at %pap\n", &pio_mem->start);
 352                 return -ENODEV;
 353         }
 354
 355         if (setup_can_queue > 0)
 356                 mac_scsi_template.can_queue = setup_can_queue;
 357         if (setup_cmd_per_lun > 0)
 358                 mac_scsi_template.cmd_per_lun = setup_cmd_per_lun;
 359         if (setup_sg_tablesize >= 0)
 360                 mac_scsi_template.sg_tablesize = setup_sg_tablesize;
 361         if (setup_hostid >= 0)
 362                 mac_scsi_template.this_id = setup_hostid & 7;
 363         if (setup_use_pdma < 0)
 364                 setup_use_pdma = 0;
 365
 366         instance = scsi_host_alloc(&mac_scsi_template,
 367                                    sizeof(struct NCR5380_hostdata));
 368         if (!instance)
 369                 return -ENOMEM;
 370
 371         instance->base = pio_mem->start;
 372         if (irq)
 373                 instance->irq = irq->start;
 374         else
 375                 instance->irq = NO_IRQ;
 376
 377         if (pdma_mem && setup_use_pdma) {
 378                 struct NCR5380_hostdata *hostdata = shost_priv(instance);
 379
 380                 hostdata->pdma_base = (unsigned char *)pdma_mem->start;
 381         } else
 382                 host_flags |= FLAG_NO_PSEUDO_DMA;
 383
 384 #ifdef SUPPORT_TAGS
 385         host_flags |= setup_use_tagged_queuing > 0 ? FLAG_TAGGED_QUEUING : 0;
 386 #endif
 387         host_flags |= setup_toshiba_delay > 0 ? FLAG_TOSHIBA_DELAY : 0;
 388
 389         error = NCR5380_init(instance, host_flags);
 390         if (error)
 391                 goto fail_init;
 392
 393         if (instance->irq != NO_IRQ) {
 394                 error = request_irq(instance->irq, macscsi_intr, IRQF_SHARED,
 395                                     "NCR5380", instance);
 396                 if (error)
 397                         goto fail_irq;
 398         }
 399
 400         NCR5380_maybe_reset_bus(instance);
 401
 402         error = scsi_add_host(instance, NULL);
 403         if (error)
 404                 goto fail_host;
 405
 406         platform_set_drvdata(pdev, instance);
 407
 408         scsi_scan_host(instance);
 409         return 0;
 410
 411 fail_host:
 412         if (instance->irq != NO_IRQ)
 413                 free_irq(instance->irq, instance);
 414 fail_irq:
 415         NCR5380_exit(instance);
 416 fail_init:
 417         scsi_host_put(instance);
 418         return error;
 419 }
 420
 421 static int __exit mac_scsi_remove(struct platform_device *pdev)
 422 {
 423         struct Scsi_Host *instance = platform_get_drvdata(pdev);
 424
 425         scsi_remove_host(instance);
 426         if (instance->irq != NO_IRQ)
 427                 free_irq(instance->irq, instance);
 428         NCR5380_exit(instance);
 429         scsi_host_put(instance);
 430         return 0;
 431 }
 432
 433 static struct platform_driver mac_scsi_driver = {
 434         .remove = __exit_p(mac_scsi_remove),
 435         .driver = {
 436                 .name   = DRV_MODULE_NAME,
 437         },
 438 };
 439
 440 module_platform_driver_probe(mac_scsi_driver, mac_scsi_probe);
 441
 442 MODULE_ALIAS("platform:" DRV_MODULE_NAME);
 443 MODULE_LICENSE("GPL");