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