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