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