2  * Sun3 SCSI stuff by Erik Verbruggen (erik@bigmama.xtdnet.nl)
 
   4  * Sun3 DMA routines added by Sam Creasey (sammy@sammy.net)
 
   6  * VME support added by Sam Creasey
 
   8  * Adapted from sun3_scsi.c -- see there for other headers
 
  10  * TODO: modify this driver to support multiple Sun3 SCSI VME boards
 
  16 #include <linux/types.h>
 
  17 #include <linux/stddef.h>
 
  18 #include <linux/ctype.h>
 
  19 #include <linux/delay.h>
 
  21 #include <linux/module.h>
 
  22 #include <linux/signal.h>
 
  23 #include <linux/ioport.h>
 
  24 #include <linux/init.h>
 
  25 #include <linux/blkdev.h>
 
  28 #include <asm/system.h>
 
  30 #include <asm/sun3ints.h>
 
  32 #include <asm/idprom.h>
 
  33 #include <asm/machines.h>
 
  37 #undef SUN3_SCSI_DEBUG
 
  44 #include <scsi/scsi_host.h>
 
  45 #include "sun3_scsi.h"
 
  47 extern int sun3_map_test(unsigned long, char *);
 
  50 /*#define RESET_BOOT */
 
  56  * BUG can be used to trigger a strange code-size related hang on 2.1 kernels
 
  63 /* #define SUPPORT_TAGS */
 
  65 //#define       ENABLE_IRQ()    enable_irq( SUN3_VEC_VMESCSI0 ); 
 
  69 static irqreturn_t scsi_sun3_intr(int irq, void *dummy);
 
  70 static inline unsigned char sun3scsi_read(int reg);
 
  71 static inline void sun3scsi_write(int reg, int value);
 
  73 static int setup_can_queue = -1;
 
  74 module_param(setup_can_queue, int, 0);
 
  75 static int setup_cmd_per_lun = -1;
 
  76 module_param(setup_cmd_per_lun, int, 0);
 
  77 static int setup_sg_tablesize = -1;
 
  78 module_param(setup_sg_tablesize, int, 0);
 
  80 static int setup_use_tagged_queuing = -1;
 
  81 module_param(setup_use_tagged_queuing, int, 0);
 
  83 static int setup_hostid = -1;
 
  84 module_param(setup_hostid, int, 0);
 
  86 static struct scsi_cmnd *sun3_dma_setup_done = NULL;
 
  88 #define AFTER_RESET_DELAY       (HZ/2)
 
  90 /* ms to wait after hitting dma regs */
 
  91 #define SUN3_DMA_DELAY 10
 
  93 /* dvma buffer to allocate -- 32k should hopefully be more than sufficient */
 
  94 #define SUN3_DVMA_BUFSIZE 0xe000
 
  96 /* minimum number of bytes to do dma on */
 
  97 #define SUN3_DMA_MINSIZE 128
 
  99 static volatile unsigned char *sun3_scsi_regp;
 
 100 static volatile struct sun3_dma_regs *dregs;
 
 102 static unsigned char *dmabuf = NULL; /* dma memory buffer */
 
 104 static unsigned char *sun3_dma_orig_addr = NULL;
 
 105 static unsigned long sun3_dma_orig_count = 0;
 
 106 static int sun3_dma_active = 0;
 
 107 static unsigned long last_residual = 0;
 
 110  * NCR 5380 register access functions
 
 113 static inline unsigned char sun3scsi_read(int reg)
 
 115         return( sun3_scsi_regp[reg] );
 
 118 static inline void sun3scsi_write(int reg, int value)
 
 120         sun3_scsi_regp[reg] = value;
 
 126 static struct Scsi_Host *default_instance;
 
 129  * Function : int sun3scsi_detect(struct scsi_host_template * tpnt)
 
 131  * Purpose : initializes mac NCR5380 driver based on the
 
 132  *      command line / compile time port and irq definitions.
 
 134  * Inputs : tpnt - template for this SCSI adapter.
 
 136  * Returns : 1 if a host adapter was found, 0 if not.
 
 140 static int sun3scsi_detect(struct scsi_host_template * tpnt)
 
 142         unsigned long ioaddr, irq = 0;
 
 143         static int called = 0;
 
 144         struct Scsi_Host *instance;
 
 146         unsigned long addrs[3] = { IOBASE_SUN3_VMESCSI, 
 
 147                                    IOBASE_SUN3_VMESCSI + 0x4000,
 
 149         unsigned long vecs[3] = { SUN3_VEC_VMESCSI0,
 
 152         /* check that this machine has an onboard 5380 */
 
 153         switch(idprom->id_machtype) {
 
 154         case SM_SUN3|SM_3_160:
 
 155         case SM_SUN3|SM_3_260:
 
 165         tpnt->proc_name = "Sun3 5380 VME SCSI";
 
 167         /* setup variables */
 
 169                 (setup_can_queue > 0) ? setup_can_queue : CAN_QUEUE;
 
 171                 (setup_cmd_per_lun > 0) ? setup_cmd_per_lun : CMD_PER_LUN;
 
 173                 (setup_sg_tablesize >= 0) ? setup_sg_tablesize : SG_TABLESIZE;
 
 175         if (setup_hostid >= 0)
 
 176                 tpnt->this_id = setup_hostid;
 
 178                 /* use 7 as default */
 
 183         for(i = 0; addrs[i] != 0; i++) {
 
 186                 ioaddr = (unsigned long)sun3_ioremap(addrs[i], PAGE_SIZE,
 
 187                                                      SUN3_PAGE_TYPE_VME16);
 
 189                 sun3_scsi_regp = (unsigned char *)ioaddr;
 
 191                 dregs = (struct sun3_dma_regs *)(((unsigned char *)ioaddr) + 8);
 
 193                 if(sun3_map_test((unsigned long)dregs, &x)) {
 
 194                         unsigned short oldcsr;
 
 198                         udelay(SUN3_DMA_DELAY);
 
 199                         if(dregs->csr == 0x1400)
 
 205                 iounmap((void *)ioaddr);
 
 213         if (setup_use_tagged_queuing < 0)
 
 214                 setup_use_tagged_queuing = USE_TAGGED_QUEUING;
 
 217         instance = scsi_register (tpnt, sizeof(struct NCR5380_hostdata));
 
 221         default_instance = instance;
 
 223         instance->io_port = (unsigned long) ioaddr;
 
 226         NCR5380_init(instance, 0);
 
 228         instance->n_io_port = 32;
 
 230         ((struct NCR5380_hostdata *)instance->hostdata)->ctrl = 0;
 
 232         if (request_irq(instance->irq, scsi_sun3_intr,
 
 233                         0, "Sun3SCSI-5380VME", instance)) {
 
 235                 printk("scsi%d: IRQ%d not free, interrupts disabled\n",
 
 236                        instance->host_no, instance->irq);
 
 237                 instance->irq = SCSI_IRQ_NONE;
 
 239                 printk("scsi%d: IRQ%d not free, bailing out\n",
 
 240                        instance->host_no, instance->irq);
 
 245         printk("scsi%d: Sun3 5380 VME at port %lX irq", instance->host_no, instance->io_port);
 
 246         if (instance->irq == SCSI_IRQ_NONE)
 
 247                 printk ("s disabled");
 
 249                 printk (" %d", instance->irq);
 
 250         printk(" options CAN_QUEUE=%d CMD_PER_LUN=%d release=%d",
 
 251                instance->can_queue, instance->cmd_per_lun,
 
 252                SUN3SCSI_PUBLIC_RELEASE);
 
 253         printk("\nscsi%d:", instance->host_no);
 
 254         NCR5380_print_options(instance);
 
 258         udelay(SUN3_DMA_DELAY);
 
 259         dregs->csr = CSR_SCSI | CSR_FIFO | CSR_INTR;
 
 260         udelay(SUN3_DMA_DELAY);
 
 261         dregs->fifo_count = 0;
 
 262         dregs->fifo_count_hi = 0;
 
 263         dregs->dma_addr_hi = 0;
 
 264         dregs->dma_addr_lo = 0;
 
 265         dregs->dma_count_hi = 0;
 
 266         dregs->dma_count_lo = 0;
 
 268         dregs->ivect = VME_DATA24 | (instance->irq & 0xff);
 
 273         sun3_scsi_reset_boot(instance);
 
 279 int sun3scsi_release (struct Scsi_Host *shpnt)
 
 281         if (shpnt->irq != SCSI_IRQ_NONE)
 
 282                 free_irq(shpnt->irq, shpnt);
 
 284         iounmap((void *)sun3_scsi_regp);
 
 291  * Our 'bus reset on boot' function
 
 294 static void sun3_scsi_reset_boot(struct Scsi_Host *instance)
 
 298         NCR5380_local_declare();
 
 299         NCR5380_setup(instance);
 
 302          * Do a SCSI reset to clean up the bus during initialization. No
 
 303          * messing with the queues, interrupts, or locks necessary here.
 
 306         printk( "Sun3 SCSI: resetting the SCSI bus..." );
 
 308         /* switch off SCSI IRQ - catch an interrupt without IRQ bit set else */
 
 309 //              sun3_disable_irq( IRQ_SUN3_SCSI );
 
 312         NCR5380_write( TARGET_COMMAND_REG,
 
 313                       PHASE_SR_TO_TCR( NCR5380_read(STATUS_REG) ));
 
 316         NCR5380_write( INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_RST );
 
 318         /* The min. reset hold time is 25us, so 40us should be enough */
 
 321         /* reset RST and interrupt */
 
 322         NCR5380_write( INITIATOR_COMMAND_REG, ICR_BASE );
 
 323         NCR5380_read( RESET_PARITY_INTERRUPT_REG );
 
 325         for( end = jiffies + AFTER_RESET_DELAY; time_before(jiffies, end); )
 
 328         /* switch on SCSI IRQ again */
 
 329 //              sun3_enable_irq( IRQ_SUN3_SCSI );
 
 335 static const char * sun3scsi_info (struct Scsi_Host *spnt) {
 
 339 // safe bits for the CSR
 
 340 #define CSR_GOOD 0x060f
 
 342 static irqreturn_t scsi_sun3_intr(int irq, void *dummy)
 
 344         unsigned short csr = dregs->csr;
 
 347         dregs->csr &= ~CSR_DMA_ENABLE;
 
 350 #ifdef SUN3_SCSI_DEBUG
 
 351         printk("scsi_intr csr %x\n", csr);
 
 354         if(csr & ~CSR_GOOD) {
 
 355                 if(csr & CSR_DMA_BUSERR) {
 
 356                         printk("scsi%d: bus error in dma\n", default_instance->host_no);
 
 357 #ifdef SUN3_SCSI_DEBUG
 
 358                         printk("scsi: residual %x count %x addr %p dmaaddr %x\n", 
 
 360                                dregs->dma_count_lo | (dregs->dma_count_hi << 16),
 
 362                                dregs->dma_addr_lo | (dregs->dma_addr_hi << 16));
 
 366                 if(csr & CSR_DMA_CONFLICT) {
 
 367                         printk("scsi%d: dma conflict\n", default_instance->host_no);
 
 372         if(csr & (CSR_SDB_INT | CSR_DMA_INT)) {
 
 373                 NCR5380_intr(irq, dummy);
 
 377         return IRQ_RETVAL(handled);
 
 381  * Debug stuff - to be called on NMI, or sysrq key. Use at your own risk; 
 
 382  * reentering NCR5380_print_status seems to have ugly side effects
 
 385 /* this doesn't seem to get used at all -- sam */
 
 387 void sun3_sun3_debug (void)
 
 390         NCR5380_local_declare();
 
 392         if (default_instance) {
 
 393                         local_irq_save(flags);
 
 394                         NCR5380_print_status(default_instance);
 
 395                         local_irq_restore(flags);
 
 401 /* sun3scsi_dma_setup() -- initialize the dma controller for a read/write */
 
 402 static unsigned long sun3scsi_dma_setup(void *data, unsigned long count, int write_flag)
 
 406         if(sun3_dma_orig_addr != NULL)
 
 407                 dvma_unmap(sun3_dma_orig_addr);
 
 409 //      addr = sun3_dvma_page((unsigned long)data, (unsigned long)dmabuf);
 
 410         addr = (void *)dvma_map_vme((unsigned long) data, count);
 
 412         sun3_dma_orig_addr = addr;
 
 413         sun3_dma_orig_count = count;
 
 415 #ifdef SUN3_SCSI_DEBUG
 
 416         printk("scsi: dma_setup addr %p count %x\n", addr, count);
 
 419 //      dregs->fifo_count = 0;
 
 422         dregs->csr &= ~CSR_FIFO;
 
 423         dregs->csr |= CSR_FIFO;
 
 427                 dregs->csr |= CSR_SEND;
 
 429                 dregs->csr &= ~CSR_SEND;
 
 432 //      dregs->csr &= ~CSR_FIFO;
 
 433 //      dregs->csr |= CSR_FIFO;
 
 435         dregs->csr |= CSR_PACK_ENABLE;
 
 437         dregs->dma_addr_hi = ((unsigned long)addr >> 16);
 
 438         dregs->dma_addr_lo = ((unsigned long)addr & 0xffff);
 
 440         dregs->dma_count_hi = 0;
 
 441         dregs->dma_count_lo = 0;
 
 442         dregs->fifo_count_hi = 0;
 
 443         dregs->fifo_count = 0;
 
 445 #ifdef SUN3_SCSI_DEBUG
 
 446         printk("scsi: dma_setup done csr %x\n", dregs->csr);
 
 452 static inline unsigned long sun3scsi_dma_residual(struct Scsi_Host *instance)
 
 454         return last_residual;
 
 457 static inline unsigned long sun3scsi_dma_xfer_len(unsigned long wanted,
 
 458                                                   struct scsi_cmnd *cmd,
 
 461         if(blk_fs_request(cmd->request))
 
 467 static int sun3scsi_dma_start(unsigned long count, char *data)
 
 473 #ifdef SUN3_SCSI_DEBUG
 
 474         printk("scsi: dma_start data %p count %x csr %x fifo %x\n", data, count, csr, dregs->fifo_count);
 
 477         dregs->dma_count_hi = (sun3_dma_orig_count >> 16);
 
 478         dregs->dma_count_lo = (sun3_dma_orig_count & 0xffff);
 
 480         dregs->fifo_count_hi = (sun3_dma_orig_count >> 16);
 
 481         dregs->fifo_count = (sun3_dma_orig_count & 0xffff);
 
 483 //      if(!(csr & CSR_DMA_ENABLE))
 
 484 //              dregs->csr |= CSR_DMA_ENABLE;
 
 489 /* clean up after our dma is done */
 
 490 static int sun3scsi_dma_finish(int write_flag)
 
 497         dregs->csr &= ~CSR_DMA_ENABLE;
 
 499         fifo = dregs->fifo_count;
 
 501                 if((fifo > 0) && (fifo < sun3_dma_orig_count))
 
 505         last_residual = fifo;
 
 506 #ifdef SUN3_SCSI_DEBUG
 
 507         printk("scsi: residual %x total %x\n", fifo, sun3_dma_orig_count);
 
 509         /* empty bytes from the fifo which didn't make it */
 
 510         if((!write_flag) && (dregs->csr & CSR_LEFT)) {
 
 511                 unsigned char *vaddr;
 
 513 #ifdef SUN3_SCSI_DEBUG
 
 514                 printk("scsi: got left over bytes\n");
 
 517                 vaddr = (unsigned char *)dvma_vmetov(sun3_dma_orig_addr);
 
 519                 vaddr += (sun3_dma_orig_count - fifo);
 
 522                 switch(dregs->csr & CSR_LEFT) {
 
 524                         *vaddr = (dregs->bpack_lo & 0xff00) >> 8;
 
 528                         *vaddr = (dregs->bpack_hi & 0x00ff);
 
 532                         *vaddr = (dregs->bpack_hi & 0xff00) >> 8;
 
 539         dvma_unmap(sun3_dma_orig_addr);
 
 540         sun3_dma_orig_addr = NULL;
 
 542         dregs->dma_addr_hi = 0;
 
 543         dregs->dma_addr_lo = 0;
 
 544         dregs->dma_count_hi = 0;
 
 545         dregs->dma_count_lo = 0;
 
 547         dregs->fifo_count = 0;
 
 548         dregs->fifo_count_hi = 0;
 
 550         dregs->csr &= ~CSR_SEND;
 
 552 //      dregs->csr |= CSR_DMA_ENABLE;
 
 556         dregs->csr &= ~CSR_FIFO;
 
 557         dregs->csr |= CSR_FIFO;
 
 559         sun3_dma_setup_done = NULL;
 
 565 #include "sun3_NCR5380.c"
 
 567 static struct scsi_host_template driver_template = {
 
 568         .name                   = SUN3_SCSI_NAME,
 
 569         .detect                 = sun3scsi_detect,
 
 570         .release                = sun3scsi_release,
 
 571         .info                   = sun3scsi_info,
 
 572         .queuecommand           = sun3scsi_queue_command,
 
 573         .eh_abort_handler       = sun3scsi_abort,
 
 574         .eh_bus_reset_handler   = sun3scsi_bus_reset,
 
 575         .can_queue              = CAN_QUEUE,
 
 577         .sg_tablesize           = SG_TABLESIZE,
 
 578         .cmd_per_lun            = CMD_PER_LUN,
 
 579         .use_clustering         = DISABLE_CLUSTERING
 
 583 #include "scsi_module.c"
 
 585 MODULE_LICENSE("GPL");