drivers/scsi/sun3_scsi.h

   1 /*
   2  * Sun3 SCSI stuff by Erik Verbruggen (erik@bigmama.xtdnet.nl)
   3  *
   4  * Sun3 DMA additions by Sam Creasey (sammy@oh.verio.com)
   5  *
   6  * Adapted from mac_scsinew.h:
   7  */
   8 /*
   9  * Cumana Generic NCR5380 driver defines
  10  *
  11  * Copyright 1993, Drew Eckhardt
  12  *      Visionary Computing
  13  *      (Unix and Linux consulting and custom programming)
  14  *      drew@colorado.edu
  15  *      +1 (303) 440-4894
  16  *
  17  * ALPHA RELEASE 1.
  18  *
  19  * For more information, please consult
  20  *
  21  * NCR 5380 Family
  22  * SCSI Protocol Controller
  23  * Databook
  24  *
  25  * NCR Microelectronics
  26  * 1635 Aeroplaza Drive
  27  * Colorado Springs, CO 80916
  28  * 1+ (719) 578-3400
  29  * 1+ (800) 334-5454
  30  */
  31
  32 /*
  33  * $Log: sun3_scsi.h,v $
  34  * Revision 1.1.1.1  2005/04/11 02:50:37  jack
  35  * first release
  36  *
  37  * Revision 1.1.1.1  2005/01/10 13:16:36  jack
  38  * First release
  39  *
  40  */
  41
  42 #ifndef SUN3_NCR5380_H
  43 #define SUN3_NCR5380_H
  44
  45 #define SUN3SCSI_PUBLIC_RELEASE 1
  46
  47 /*
  48  * Int: level 2 autovector
  49  * IO: type 1, base 0x00140000, 5 bits phys space: A<4..0>
  50  */
  51 #define IRQ_SUN3_SCSI 2
  52 #define IOBASE_SUN3_SCSI 0x00140000
  53
  54 int sun3scsi_abort (Scsi_Cmnd *);
  55 int sun3scsi_detect (Scsi_Host_Template *);
  56 int sun3scsi_release (struct Scsi_Host *);
  57 const char *sun3scsi_info (struct Scsi_Host *);
  58 int sun3scsi_reset(Scsi_Cmnd *, unsigned int);
  59 int sun3scsi_queue_command (Scsi_Cmnd *, void (*done)(Scsi_Cmnd *));
  60 int sun3scsi_proc_info (char *buffer, char **start, off_t offset,
  61                         int length, int hostno, int inout);
  62
  63 #ifndef NULL
  64 #define NULL 0
  65 #endif
  66
  67 #ifndef CMD_PER_LUN
  68 #define CMD_PER_LUN 2
  69 #endif
  70
  71 #ifndef CAN_QUEUE
  72 #define CAN_QUEUE 16
  73 #endif
  74
  75 #ifndef SG_TABLESIZE
  76 #define SG_TABLESIZE SG_NONE
  77 #endif
  78
  79 #ifndef USE_TAGGED_QUEUING
  80 #define USE_TAGGED_QUEUING 0
  81 #endif
  82
  83 #include <scsi/scsicam.h>
  84
  85 #define SUN3_NCR5380 {                                                  \
  86 name:                   "Sun3 NCR5380 SCSI",                            \
  87 detect:                 sun3scsi_detect,                                \
  88 release:                sun3scsi_release,       /* Release */           \
  89 info:                   sun3scsi_info,                                  \
  90 queuecommand:           sun3scsi_queue_command,                         \
  91 abort:                  sun3scsi_abort,                                 \
  92 reset:                  sun3scsi_reset,                                 \
  93 bios_param:             scsicam_bios_param,     /* biosparam */         \
  94 can_queue:              CAN_QUEUE,              /* can queue */         \
  95 this_id:                7,                      /* id */                \
  96 sg_tablesize:           SG_ALL,                 /* sg_tablesize */      \
  97 cmd_per_lun:            CMD_PER_LUN,            /* cmd per lun */       \
  98 unchecked_isa_dma:      0,                      /* unchecked_isa_dma */ \
  99 use_clustering:         DISABLE_CLUSTERING                              \
 100         }
 101
 102 #ifndef HOSTS_C
 103
 104 #define NCR5380_implementation_fields \
 105     int port, ctrl
 106
 107 #define NCR5380_local_declare() \
 108         struct Scsi_Host *_instance
 109
 110 #define NCR5380_setup(instance) \
 111         _instance = instance
 112
 113 #define NCR5380_read(reg) sun3scsi_read(reg)
 114 #define NCR5380_write(reg, value) sun3scsi_write(reg, value)
 115
 116 #define NCR5380_intr sun3scsi_intr
 117 #define NCR5380_queue_command sun3scsi_queue_command
 118 #define NCR5380_reset sun3scsi_reset
 119 #define NCR5380_abort sun3scsi_abort
 120 #define NCR5380_proc_info sun3scsi_proc_info
 121 #define NCR5380_dma_xfer_len(i, cmd, phase) \
 122         sun3scsi_dma_xfer_len(cmd->SCp.this_residual,cmd,((phase) & SR_IO) ? 0 : 1)
 123
 124 #define NCR5380_dma_write_setup(instance, data, count) sun3scsi_dma_setup(data, count, 1)
 125 #define NCR5380_dma_read_setup(instance, data, count) sun3scsi_dma_setup(data, count, 0)
 126 #define NCR5380_dma_residual sun3scsi_dma_residual
 127
 128 #define BOARD_NORMAL    0
 129 #define BOARD_NCR53C400 1
 130
 131 /* additional registers - mainly DMA control regs */
 132 /* these start at regbase + 8 -- directly after the NCR regs */
 133 struct sun3_dma_regs {
 134         unsigned short vmeregs[4];  /* unimpl vme stuff */
 135         unsigned short udc_data; /* udc dma data reg */
 136         unsigned short udc_addr; /* uda dma addr reg */
 137         unsigned short fifo_data; /* fifo data reg, holds extra byte on
 138                                      odd dma reads */
 139         unsigned short fifo_count;
 140         unsigned short csr; /* control/status reg */
 141 };
 142
 143 /* ucd chip specific regs - live in dvma space */
 144 struct sun3_udc_regs {
 145      unsigned short rsel; /* select regs to load */
 146      unsigned short addr_hi; /* high word of addr */
 147      unsigned short addr_lo; /* low word */
 148      unsigned short count; /* words to be xfer'd */
 149      unsigned short mode_hi; /* high word of channel mode */
 150      unsigned short mode_lo; /* low word of channel mode */
 151 };
 152
 153 /* addresses of the udc registers */
 154 #define UDC_MODE 0x38
 155 #define UDC_CSR 0x2e /* command/status */
 156 #define UDC_CHN_HI 0x26 /* chain high word */
 157 #define UDC_CHN_LO 0x22 /* chain lo word */
 158 #define UDC_CURA_HI 0x1a /* cur reg A high */
 159 #define UDC_CURA_LO 0x0a /* cur reg A low */
 160 #define UDC_CURB_HI 0x12 /* cur reg B high */
 161 #define UDC_CURB_LO 0x02 /* cur reg B low */
 162 #define UDC_MODE_HI 0x56 /* mode reg high */
 163 #define UDC_MODE_LO 0x52 /* mode reg low */
 164 #define UDC_COUNT 0x32 /* words to xfer */
 165
 166 /* some udc commands */
 167 #define UDC_RESET 0
 168 #define UDC_CHN_START 0xa0 /* start chain */
 169 #define UDC_INT_ENABLE 0x32 /* channel 1 int on */
 170
 171 /* udc mode words */
 172 #define UDC_MODE_HIWORD 0x40
 173 #define UDC_MODE_LSEND 0xc2
 174 #define UDC_MODE_LRECV 0xd2
 175
 176 /* udc reg selections */
 177 #define UDC_RSEL_SEND 0x282
 178 #define UDC_RSEL_RECV 0x182
 179
 180 /* bits in csr reg */
 181 #define CSR_DMA_ACTIVE 0x8000
 182 #define CSR_DMA_CONFLICT 0x4000
 183 #define CSR_DMA_BUSERR 0x2000
 184
 185 #define CSR_FIFO_EMPTY 0x400 /* fifo flushed? */
 186 #define CSR_SDB_INT 0x200 /* sbc interrupt pending */
 187 #define CSR_DMA_INT 0x100 /* dma interrupt pending */
 188
 189 #define CSR_SEND 0x8 /* 1 = send  0 = recv */
 190 #define CSR_FIFO 0x2 /* reset fifo */
 191 #define CSR_INTR 0x4 /* interrupt enable */
 192 #define CSR_SCSI 0x1
 193
 194 // debugging printk's, taken from atari_scsi.h
 195 /* Debugging printk definitions:
 196  *
 197  *  ARB  -> arbitration
 198  *  ASEN -> auto-sense
 199  *  DMA  -> DMA
 200  *  HSH  -> PIO handshake
 201  *  INF  -> information transfer
 202  *  INI  -> initialization
 203  *  INT  -> interrupt
 204  *  LNK  -> linked commands
 205  *  MAIN -> NCR5380_main() control flow
 206  *  NDAT -> no data-out phase
 207  *  NWR  -> no write commands
 208  *  PIO  -> PIO transfers
 209  *  PDMA -> pseudo DMA (unused on Atari)
 210  *  QU   -> queues
 211  *  RSL  -> reselections
 212  *  SEL  -> selections
 213  *  USL  -> usleep cpde (unused on Atari)
 214  *  LBS  -> last byte sent (unused on Atari)
 215  *  RSS  -> restarting of selections
 216  *  EXT  -> extended messages
 217  *  ABRT -> aborting and resetting
 218  *  TAG  -> queue tag handling
 219  *  MER  -> merging of consec. buffers
 220  *
 221  */
 222
 223
 224
 225 #if NDEBUG & NDEBUG_ARBITRATION
 226 #define ARB_PRINTK(format, args...) \
 227         printk(KERN_DEBUG format , ## args)
 228 #else
 229 #define ARB_PRINTK(format, args...)
 230 #endif
 231 #if NDEBUG & NDEBUG_AUTOSENSE
 232 #define ASEN_PRINTK(format, args...) \
 233         printk(KERN_DEBUG format , ## args)
 234 #else
 235 #define ASEN_PRINTK(format, args...)
 236 #endif
 237 #if NDEBUG & NDEBUG_DMA
 238 #define DMA_PRINTK(format, args...) \
 239         printk(KERN_DEBUG format , ## args)
 240 #else
 241 #define DMA_PRINTK(format, args...)
 242 #endif
 243 #if NDEBUG & NDEBUG_HANDSHAKE
 244 #define HSH_PRINTK(format, args...) \
 245         printk(KERN_DEBUG format , ## args)
 246 #else
 247 #define HSH_PRINTK(format, args...)
 248 #endif
 249 #if NDEBUG & NDEBUG_INFORMATION
 250 #define INF_PRINTK(format, args...) \
 251         printk(KERN_DEBUG format , ## args)
 252 #else
 253 #define INF_PRINTK(format, args...)
 254 #endif
 255 #if NDEBUG & NDEBUG_INIT
 256 #define INI_PRINTK(format, args...) \
 257         printk(KERN_DEBUG format , ## args)
 258 #else
 259 #define INI_PRINTK(format, args...)
 260 #endif
 261 #if NDEBUG & NDEBUG_INTR
 262 #define INT_PRINTK(format, args...) \
 263         printk(KERN_DEBUG format , ## args)
 264 #else
 265 #define INT_PRINTK(format, args...)
 266 #endif
 267 #if NDEBUG & NDEBUG_LINKED
 268 #define LNK_PRINTK(format, args...) \
 269         printk(KERN_DEBUG format , ## args)
 270 #else
 271 #define LNK_PRINTK(format, args...)
 272 #endif
 273 #if NDEBUG & NDEBUG_MAIN
 274 #define MAIN_PRINTK(format, args...) \
 275         printk(KERN_DEBUG format , ## args)
 276 #else
 277 #define MAIN_PRINTK(format, args...)
 278 #endif
 279 #if NDEBUG & NDEBUG_NO_DATAOUT
 280 #define NDAT_PRINTK(format, args...) \
 281         printk(KERN_DEBUG format , ## args)
 282 #else
 283 #define NDAT_PRINTK(format, args...)
 284 #endif
 285 #if NDEBUG & NDEBUG_NO_WRITE
 286 #define NWR_PRINTK(format, args...) \
 287         printk(KERN_DEBUG format , ## args)
 288 #else
 289 #define NWR_PRINTK(format, args...)
 290 #endif
 291 #if NDEBUG & NDEBUG_PIO
 292 #define PIO_PRINTK(format, args...) \
 293         printk(KERN_DEBUG format , ## args)
 294 #else
 295 #define PIO_PRINTK(format, args...)
 296 #endif
 297 #if NDEBUG & NDEBUG_PSEUDO_DMA
 298 #define PDMA_PRINTK(format, args...) \
 299         printk(KERN_DEBUG format , ## args)
 300 #else
 301 #define PDMA_PRINTK(format, args...)
 302 #endif
 303 #if NDEBUG & NDEBUG_QUEUES
 304 #define QU_PRINTK(format, args...) \
 305         printk(KERN_DEBUG format , ## args)
 306 #else
 307 #define QU_PRINTK(format, args...)
 308 #endif
 309 #if NDEBUG & NDEBUG_RESELECTION
 310 #define RSL_PRINTK(format, args...) \
 311         printk(KERN_DEBUG format , ## args)
 312 #else
 313 #define RSL_PRINTK(format, args...)
 314 #endif
 315 #if NDEBUG & NDEBUG_SELECTION
 316 #define SEL_PRINTK(format, args...) \
 317         printk(KERN_DEBUG format , ## args)
 318 #else
 319 #define SEL_PRINTK(format, args...)
 320 #endif
 321 #if NDEBUG & NDEBUG_USLEEP
 322 #define USL_PRINTK(format, args...) \
 323         printk(KERN_DEBUG format , ## args)
 324 #else
 325 #define USL_PRINTK(format, args...)
 326 #endif
 327 #if NDEBUG & NDEBUG_LAST_BYTE_SENT
 328 #define LBS_PRINTK(format, args...) \
 329         printk(KERN_DEBUG format , ## args)
 330 #else
 331 #define LBS_PRINTK(format, args...)
 332 #endif
 333 #if NDEBUG & NDEBUG_RESTART_SELECT
 334 #define RSS_PRINTK(format, args...) \
 335         printk(KERN_DEBUG format , ## args)
 336 #else
 337 #define RSS_PRINTK(format, args...)
 338 #endif
 339 #if NDEBUG & NDEBUG_EXTENDED
 340 #define EXT_PRINTK(format, args...) \
 341         printk(KERN_DEBUG format , ## args)
 342 #else
 343 #define EXT_PRINTK(format, args...)
 344 #endif
 345 #if NDEBUG & NDEBUG_ABORT
 346 #define ABRT_PRINTK(format, args...) \
 347         printk(KERN_DEBUG format , ## args)
 348 #else
 349 #define ABRT_PRINTK(format, args...)
 350 #endif
 351 #if NDEBUG & NDEBUG_TAGS
 352 #define TAG_PRINTK(format, args...) \
 353         printk(KERN_DEBUG format , ## args)
 354 #else
 355 #define TAG_PRINTK(format, args...)
 356 #endif
 357 #if NDEBUG & NDEBUG_MERGING
 358 #define MER_PRINTK(format, args...) \
 359         printk(KERN_DEBUG format , ## args)
 360 #else
 361 #define MER_PRINTK(format, args...)
 362 #endif
 363
 364 /* conditional macros for NCR5380_print_{,phase,status} */
 365
 366 #define NCR_PRINT(mask) \
 367         ((NDEBUG & (mask)) ? NCR5380_print(instance) : (void)0)
 368
 369 #define NCR_PRINT_PHASE(mask) \
 370         ((NDEBUG & (mask)) ? NCR5380_print_phase(instance) : (void)0)
 371
 372 #define NCR_PRINT_STATUS(mask) \
 373         ((NDEBUG & (mask)) ? NCR5380_print_status(instance) : (void)0)
 374
 375 #define NDEBUG_ANY      0xffffffff
 376
 377
 378
 379 #endif /* ndef HOSTS_C */
 380 #endif /* SUN3_NCR5380_H */
 381