Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* NCR53C9x.c: Defines and structures for the NCR53C9x generic driver. |
| 2 | * |
| 3 | * Originaly esp.h: Defines and structures for the Sparc ESP |
| 4 | * (Enhanced SCSI Processor) driver under Linux. |
| 5 | * |
| 6 | * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu) |
| 7 | * |
| 8 | * Generalization by Jesper Skov (jskov@cygnus.co.uk) |
| 9 | * |
| 10 | * More generalization (for i386 stuff) by Tymm Twillman (tymm@computer.org) |
| 11 | */ |
| 12 | |
| 13 | #ifndef NCR53C9X_H |
| 14 | #define NCR53C9X_H |
| 15 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | #include <linux/interrupt.h> |
| 17 | |
| 18 | /* djweis for mac driver */ |
| 19 | #if defined(CONFIG_MAC) |
| 20 | #define PAD_SIZE 15 |
| 21 | #else |
| 22 | #define PAD_SIZE 3 |
| 23 | #endif |
| 24 | |
| 25 | /* Handle multiple hostadapters on Amiga |
| 26 | * generally PAD_SIZE = 3 |
| 27 | * but there is one exception: Oktagon (PAD_SIZE = 1) */ |
| 28 | #if defined(CONFIG_OKTAGON_SCSI) || defined(CONFIG_OKTAGON_SCSI_MODULE) |
| 29 | #undef PAD_SIZE |
| 30 | #if defined(CONFIG_BLZ1230_SCSI) || defined(CONFIG_BLZ1230_SCSI_MODULE) || \ |
| 31 | defined(CONFIG_BLZ2060_SCSI) || defined(CONFIG_BLZ2060_SCSI_MODULE) || \ |
| 32 | defined(CONFIG_CYBERSTORM_SCSI) || defined(CONFIG_CYBERSTORM_SCSI_MODULE) || \ |
| 33 | defined(CONFIG_CYBERSTORMII_SCSI) || defined(CONFIG_CYBERSTORMII_SCSI_MODULE) || \ |
| 34 | defined(CONFIG_FASTLANE_SCSI) || defined(CONFIG_FASTLANE_SCSI_MODULE) |
| 35 | #define MULTIPLE_PAD_SIZES |
| 36 | #else |
| 37 | #define PAD_SIZE 1 |
| 38 | #endif |
| 39 | #endif |
| 40 | |
| 41 | /* Macros for debugging messages */ |
| 42 | |
| 43 | #define DEBUG_ESP |
| 44 | /* #define DEBUG_ESP_DATA */ |
| 45 | /* #define DEBUG_ESP_QUEUE */ |
| 46 | /* #define DEBUG_ESP_DISCONNECT */ |
| 47 | /* #define DEBUG_ESP_STATUS */ |
| 48 | /* #define DEBUG_ESP_PHASES */ |
| 49 | /* #define DEBUG_ESP_WORKBUS */ |
| 50 | /* #define DEBUG_STATE_MACHINE */ |
| 51 | /* #define DEBUG_ESP_CMDS */ |
| 52 | /* #define DEBUG_ESP_IRQS */ |
| 53 | /* #define DEBUG_SDTR */ |
| 54 | /* #define DEBUG_ESP_SG */ |
| 55 | |
| 56 | /* Use the following to sprinkle debugging messages in a way which |
| 57 | * suits you if combinations of the above become too verbose when |
| 58 | * trying to track down a specific problem. |
| 59 | */ |
| 60 | /* #define DEBUG_ESP_MISC */ |
| 61 | |
| 62 | #if defined(DEBUG_ESP) |
| 63 | #define ESPLOG(foo) printk foo |
| 64 | #else |
| 65 | #define ESPLOG(foo) |
| 66 | #endif /* (DEBUG_ESP) */ |
| 67 | |
| 68 | #if defined(DEBUG_ESP_DATA) |
| 69 | #define ESPDATA(foo) printk foo |
| 70 | #else |
| 71 | #define ESPDATA(foo) |
| 72 | #endif |
| 73 | |
| 74 | #if defined(DEBUG_ESP_QUEUE) |
| 75 | #define ESPQUEUE(foo) printk foo |
| 76 | #else |
| 77 | #define ESPQUEUE(foo) |
| 78 | #endif |
| 79 | |
| 80 | #if defined(DEBUG_ESP_DISCONNECT) |
| 81 | #define ESPDISC(foo) printk foo |
| 82 | #else |
| 83 | #define ESPDISC(foo) |
| 84 | #endif |
| 85 | |
| 86 | #if defined(DEBUG_ESP_STATUS) |
| 87 | #define ESPSTAT(foo) printk foo |
| 88 | #else |
| 89 | #define ESPSTAT(foo) |
| 90 | #endif |
| 91 | |
| 92 | #if defined(DEBUG_ESP_PHASES) |
| 93 | #define ESPPHASE(foo) printk foo |
| 94 | #else |
| 95 | #define ESPPHASE(foo) |
| 96 | #endif |
| 97 | |
| 98 | #if defined(DEBUG_ESP_WORKBUS) |
| 99 | #define ESPBUS(foo) printk foo |
| 100 | #else |
| 101 | #define ESPBUS(foo) |
| 102 | #endif |
| 103 | |
| 104 | #if defined(DEBUG_ESP_IRQS) |
| 105 | #define ESPIRQ(foo) printk foo |
| 106 | #else |
| 107 | #define ESPIRQ(foo) |
| 108 | #endif |
| 109 | |
| 110 | #if defined(DEBUG_SDTR) |
| 111 | #define ESPSDTR(foo) printk foo |
| 112 | #else |
| 113 | #define ESPSDTR(foo) |
| 114 | #endif |
| 115 | |
| 116 | #if defined(DEBUG_ESP_MISC) |
| 117 | #define ESPMISC(foo) printk foo |
| 118 | #else |
| 119 | #define ESPMISC(foo) |
| 120 | #endif |
| 121 | |
| 122 | /* |
| 123 | * padding for register structure |
| 124 | */ |
| 125 | #ifdef CONFIG_JAZZ_ESP |
| 126 | #define EREGS_PAD(n) |
| 127 | #else |
| 128 | #ifndef MULTIPLE_PAD_SIZES |
| 129 | #define EREGS_PAD(n) unchar n[PAD_SIZE]; |
| 130 | #endif |
| 131 | #endif |
| 132 | |
| 133 | /* The ESP SCSI controllers have their register sets in three |
| 134 | * "classes": |
| 135 | * |
| 136 | * 1) Registers which are both read and write. |
| 137 | * 2) Registers which are read only. |
| 138 | * 3) Registers which are write only. |
| 139 | * |
| 140 | * Yet, they all live within the same IO space. |
| 141 | */ |
| 142 | |
| 143 | #if !defined(__i386__) && !defined(__x86_64__) |
| 144 | |
| 145 | #ifndef MULTIPLE_PAD_SIZES |
| 146 | |
| 147 | #ifdef CONFIG_CPU_HAS_WB |
| 148 | #include <asm/wbflush.h> |
| 149 | #define esp_write(__reg, __val) do{(__reg) = (__val); wbflush();} while(0) |
| 150 | #else |
| 151 | #define esp_write(__reg, __val) ((__reg) = (__val)) |
| 152 | #endif |
| 153 | #define esp_read(__reg) (__reg) |
| 154 | |
| 155 | struct ESP_regs { |
| 156 | /* Access Description Offset */ |
| 157 | volatile unchar esp_tclow; /* rw Low bits of the transfer count 0x00 */ |
| 158 | EREGS_PAD(tlpad1); |
| 159 | volatile unchar esp_tcmed; /* rw Mid bits of the transfer count 0x04 */ |
| 160 | EREGS_PAD(fdpad); |
| 161 | volatile unchar esp_fdata; /* rw FIFO data bits 0x08 */ |
| 162 | EREGS_PAD(cbpad); |
| 163 | volatile unchar esp_cmnd; /* rw SCSI command bits 0x0c */ |
| 164 | EREGS_PAD(stpad); |
| 165 | volatile unchar esp_status; /* ro ESP status register 0x10 */ |
| 166 | #define esp_busid esp_status /* wo Bus ID for select/reselect 0x10 */ |
| 167 | EREGS_PAD(irqpd); |
| 168 | volatile unchar esp_intrpt; /* ro Kind of interrupt 0x14 */ |
| 169 | #define esp_timeo esp_intrpt /* wo Timeout value for select/resel 0x14 */ |
| 170 | EREGS_PAD(sspad); |
| 171 | volatile unchar esp_sstep; /* ro Sequence step register 0x18 */ |
| 172 | #define esp_stp esp_sstep /* wo Transfer period per sync 0x18 */ |
| 173 | EREGS_PAD(ffpad); |
| 174 | volatile unchar esp_fflags; /* ro Bits of current FIFO info 0x1c */ |
| 175 | #define esp_soff esp_fflags /* wo Sync offset 0x1c */ |
| 176 | EREGS_PAD(cf1pd); |
| 177 | volatile unchar esp_cfg1; /* rw First configuration register 0x20 */ |
| 178 | EREGS_PAD(cfpad); |
| 179 | volatile unchar esp_cfact; /* wo Clock conversion factor 0x24 */ |
| 180 | EREGS_PAD(ctpad); |
| 181 | volatile unchar esp_ctest; /* wo Chip test register 0x28 */ |
| 182 | EREGS_PAD(cf2pd); |
| 183 | volatile unchar esp_cfg2; /* rw Second configuration register 0x2c */ |
| 184 | EREGS_PAD(cf3pd); |
| 185 | |
| 186 | /* The following is only found on the 53C9X series SCSI chips */ |
| 187 | volatile unchar esp_cfg3; /* rw Third configuration register 0x30 */ |
| 188 | EREGS_PAD(cf4pd); |
| 189 | volatile unchar esp_cfg4; /* rw Fourth configuration register 0x34 */ |
| 190 | EREGS_PAD(thpd); |
| 191 | /* The following is found on all chips except the NCR53C90 (ESP100) */ |
| 192 | volatile unchar esp_tchi; /* rw High bits of transfer count 0x38 */ |
| 193 | #define esp_uid esp_tchi /* ro Unique ID code 0x38 */ |
| 194 | EREGS_PAD(fgpad); |
| 195 | volatile unchar esp_fgrnd; /* rw Data base for fifo 0x3c */ |
| 196 | }; |
| 197 | |
| 198 | #else /* MULTIPLE_PAD_SIZES */ |
| 199 | |
| 200 | #define esp_write(__reg, __val) (*(__reg) = (__val)) |
| 201 | #define esp_read(__reg) (*(__reg)) |
| 202 | |
| 203 | struct ESP_regs { |
| 204 | unsigned char io_addr[64]; /* dummy */ |
| 205 | /* Access Description Offset */ |
| 206 | #define esp_tclow io_addr /* rw Low bits of the transfer count 0x00 */ |
| 207 | #define esp_tcmed io_addr + (1<<(esp->shift)) /* rw Mid bits of the transfer count 0x04 */ |
| 208 | #define esp_fdata io_addr + (2<<(esp->shift)) /* rw FIFO data bits 0x08 */ |
| 209 | #define esp_cmnd io_addr + (3<<(esp->shift)) /* rw SCSI command bits 0x0c */ |
| 210 | #define esp_status io_addr + (4<<(esp->shift)) /* ro ESP status register 0x10 */ |
| 211 | #define esp_busid esp_status /* wo Bus ID for select/reselect 0x10 */ |
| 212 | #define esp_intrpt io_addr + (5<<(esp->shift)) /* ro Kind of interrupt 0x14 */ |
| 213 | #define esp_timeo esp_intrpt /* wo Timeout value for select/resel 0x14 */ |
| 214 | #define esp_sstep io_addr + (6<<(esp->shift)) /* ro Sequence step register 0x18 */ |
| 215 | #define esp_stp esp_sstep /* wo Transfer period per sync 0x18 */ |
| 216 | #define esp_fflags io_addr + (7<<(esp->shift)) /* ro Bits of current FIFO info 0x1c */ |
| 217 | #define esp_soff esp_fflags /* wo Sync offset 0x1c */ |
| 218 | #define esp_cfg1 io_addr + (8<<(esp->shift)) /* rw First configuration register 0x20 */ |
| 219 | #define esp_cfact io_addr + (9<<(esp->shift)) /* wo Clock conversion factor 0x24 */ |
| 220 | #define esp_ctest io_addr + (10<<(esp->shift)) /* wo Chip test register 0x28 */ |
| 221 | #define esp_cfg2 io_addr + (11<<(esp->shift)) /* rw Second configuration register 0x2c */ |
| 222 | |
| 223 | /* The following is only found on the 53C9X series SCSI chips */ |
| 224 | #define esp_cfg3 io_addr + (12<<(esp->shift)) /* rw Third configuration register 0x30 */ |
| 225 | #define esp_cfg4 io_addr + (13<<(esp->shift)) /* rw Fourth configuration register 0x34 */ |
| 226 | |
| 227 | /* The following is found on all chips except the NCR53C90 (ESP100) */ |
| 228 | #define esp_tchi io_addr + (14<<(esp->shift)) /* rw High bits of transfer count 0x38 */ |
| 229 | #define esp_uid esp_tchi /* ro Unique ID code 0x38 */ |
| 230 | #define esp_fgrnd io_addr + (15<<(esp->shift)) /* rw Data base for fifo 0x3c */ |
| 231 | }; |
| 232 | |
| 233 | #endif |
| 234 | |
| 235 | #else /* !defined(__i386__) && !defined(__x86_64__) */ |
| 236 | |
| 237 | #define esp_write(__reg, __val) outb((__val), (__reg)) |
| 238 | #define esp_read(__reg) inb((__reg)) |
| 239 | |
| 240 | struct ESP_regs { |
| 241 | unsigned int io_addr; |
| 242 | /* Access Description Offset */ |
| 243 | #define esp_tclow io_addr /* rw Low bits of the transfer count 0x00 */ |
| 244 | #define esp_tcmed io_addr + 1 /* rw Mid bits of the transfer count 0x04 */ |
| 245 | #define esp_fdata io_addr + 2 /* rw FIFO data bits 0x08 */ |
| 246 | #define esp_cmnd io_addr + 3 /* rw SCSI command bits 0x0c */ |
| 247 | #define esp_status io_addr + 4 /* ro ESP status register 0x10 */ |
| 248 | #define esp_busid esp_status /* wo Bus ID for select/reselect 0x10 */ |
| 249 | #define esp_intrpt io_addr + 5 /* ro Kind of interrupt 0x14 */ |
| 250 | #define esp_timeo esp_intrpt /* wo Timeout value for select/resel 0x14 */ |
| 251 | #define esp_sstep io_addr + 6 /* ro Sequence step register 0x18 */ |
| 252 | #define esp_stp esp_sstep /* wo Transfer period per sync 0x18 */ |
| 253 | #define esp_fflags io_addr + 7 /* ro Bits of current FIFO info 0x1c */ |
| 254 | #define esp_soff esp_fflags /* wo Sync offset 0x1c */ |
| 255 | #define esp_cfg1 io_addr + 8 /* rw First configuration register 0x20 */ |
| 256 | #define esp_cfact io_addr + 9 /* wo Clock conversion factor 0x24 */ |
| 257 | #define esp_ctest io_addr + 10 /* wo Chip test register 0x28 */ |
| 258 | #define esp_cfg2 io_addr + 11 /* rw Second configuration register 0x2c */ |
| 259 | |
| 260 | /* The following is only found on the 53C9X series SCSI chips */ |
| 261 | #define esp_cfg3 io_addr + 12 /* rw Third configuration register 0x30 */ |
| 262 | #define esp_cfg4 io_addr + 13 /* rw Fourth configuration register 0x34 */ |
| 263 | |
| 264 | /* The following is found on all chips except the NCR53C90 (ESP100) */ |
| 265 | #define esp_tchi io_addr + 14 /* rw High bits of transfer count 0x38 */ |
| 266 | #define esp_uid esp_tchi /* ro Unique ID code 0x38 */ |
| 267 | #define esp_fgrnd io_addr + 15 /* rw Data base for fifo 0x3c */ |
| 268 | }; |
| 269 | |
| 270 | #endif /* !defined(__i386__) && !defined(__x86_64__) */ |
| 271 | |
| 272 | /* Various revisions of the ESP board. */ |
| 273 | enum esp_rev { |
| 274 | esp100 = 0x00, /* NCR53C90 - very broken */ |
| 275 | esp100a = 0x01, /* NCR53C90A */ |
| 276 | esp236 = 0x02, |
| 277 | fas236 = 0x03, |
| 278 | fas100a = 0x04, |
| 279 | fast = 0x05, |
| 280 | fas366 = 0x06, |
| 281 | fas216 = 0x07, |
| 282 | fsc = 0x08, /* SYM53C94-2 */ |
| 283 | espunknown = 0x09 |
| 284 | }; |
| 285 | |
| 286 | /* We allocate one of these for each scsi device and attach it to |
| 287 | * SDptr->hostdata for use in the driver |
| 288 | */ |
| 289 | struct esp_device { |
| 290 | unsigned char sync_min_period; |
| 291 | unsigned char sync_max_offset; |
| 292 | unsigned sync:1; |
| 293 | unsigned wide:1; |
| 294 | unsigned disconnect:1; |
| 295 | }; |
| 296 | |
| 297 | /* We get one of these for each ESP probed. */ |
| 298 | struct NCR_ESP { |
| 299 | struct NCR_ESP *next; /* Next ESP on probed or NULL */ |
| 300 | struct ESP_regs *eregs; /* All esp registers */ |
| 301 | int dma; /* Who I do transfers with. */ |
| 302 | void *dregs; /* And his registers. */ |
| 303 | struct Scsi_Host *ehost; /* Backpointer to SCSI Host */ |
| 304 | |
| 305 | void *edev; /* Pointer to controller base/SBus */ |
| 306 | int esp_id; /* Unique per-ESP ID number */ |
| 307 | |
| 308 | /* ESP Configuration Registers */ |
| 309 | unsigned char config1; /* Copy of the 1st config register */ |
| 310 | unsigned char config2; /* Copy of the 2nd config register */ |
| 311 | unsigned char config3[16]; /* Copy of the 3rd config register */ |
| 312 | |
| 313 | /* The current command we are sending to the ESP chip. This esp_command |
| 314 | * ptr needs to be mapped in DVMA area so we can send commands and read |
| 315 | * from the ESP fifo without burning precious CPU cycles. Programmed I/O |
| 316 | * sucks when we have the DVMA to do it for us. The ESP is stupid and will |
| 317 | * only send out 6, 10, and 12 byte SCSI commands, others we need to send |
| 318 | * one byte at a time. esp_slowcmd being set says that we are doing one |
| 319 | * of the command types ESP doesn't understand, esp_scmdp keeps track of |
| 320 | * which byte we are sending, esp_scmdleft says how many bytes to go. |
| 321 | */ |
| 322 | volatile unchar *esp_command; /* Location of command (CPU view) */ |
| 323 | __u32 esp_command_dvma; /* Location of command (DVMA view) */ |
| 324 | unsigned char esp_clen; /* Length of this command */ |
| 325 | unsigned char esp_slowcmd; |
| 326 | unsigned char *esp_scmdp; |
| 327 | unsigned char esp_scmdleft; |
| 328 | |
| 329 | /* The following are used to determine the cause of an IRQ. Upon every |
| 330 | * IRQ entry we synchronize these with the hardware registers. |
| 331 | */ |
| 332 | unchar ireg; /* Copy of ESP interrupt register */ |
| 333 | unchar sreg; /* Same for ESP status register */ |
| 334 | unchar seqreg; /* The ESP sequence register */ |
| 335 | |
| 336 | /* The following is set when a premature interrupt condition is detected |
| 337 | * in some FAS revisions. |
| 338 | */ |
| 339 | unchar fas_premature_intr_workaround; |
| 340 | |
| 341 | /* To save register writes to the ESP, which can be expensive, we |
| 342 | * keep track of the previous value that various registers had for |
| 343 | * the last target we connected to. If they are the same for the |
| 344 | * current target, we skip the register writes as they are not needed. |
| 345 | */ |
| 346 | unchar prev_soff, prev_stp, prev_cfg3; |
| 347 | |
| 348 | /* For each target we keep track of save/restore data |
| 349 | * pointer information. This needs to be updated majorly |
| 350 | * when we add support for tagged queueing. -DaveM |
| 351 | */ |
| 352 | struct esp_pointers { |
| 353 | char *saved_ptr; |
| 354 | struct scatterlist *saved_buffer; |
| 355 | int saved_this_residual; |
| 356 | int saved_buffers_residual; |
| 357 | } data_pointers[16] /*XXX [MAX_TAGS_PER_TARGET]*/; |
| 358 | |
| 359 | /* Clock periods, frequencies, synchronization, etc. */ |
| 360 | unsigned int cfreq; /* Clock frequency in HZ */ |
| 361 | unsigned int cfact; /* Clock conversion factor */ |
| 362 | unsigned int ccycle; /* One ESP clock cycle */ |
| 363 | unsigned int ctick; /* One ESP clock time */ |
| 364 | unsigned int radelay; /* FAST chip req/ack delay */ |
| 365 | unsigned int neg_defp; /* Default negotiation period */ |
| 366 | unsigned int sync_defp; /* Default sync transfer period */ |
| 367 | unsigned int max_period; /* longest our period can be */ |
| 368 | unsigned int min_period; /* shortest period we can withstand */ |
| 369 | /* For slow to medium speed input clock rates we shoot for 5mb/s, |
| 370 | * but for high input clock rates we try to do 10mb/s although I |
| 371 | * don't think a transfer can even run that fast with an ESP even |
| 372 | * with DMA2 scatter gather pipelining. |
| 373 | */ |
| 374 | #define SYNC_DEFP_SLOW 0x32 /* 5mb/s */ |
| 375 | #define SYNC_DEFP_FAST 0x19 /* 10mb/s */ |
| 376 | |
| 377 | unsigned int snip; /* Sync. negotiation in progress */ |
| 378 | unsigned int wnip; /* WIDE negotiation in progress */ |
| 379 | unsigned int targets_present; /* targets spoken to before */ |
| 380 | |
| 381 | int current_transfer_size; /* Set at beginning of data dma */ |
| 382 | |
| 383 | unchar espcmdlog[32]; /* Log of current esp cmds sent. */ |
| 384 | unchar espcmdent; /* Current entry in esp cmd log. */ |
| 385 | |
| 386 | /* Misc. info about this ESP */ |
| 387 | enum esp_rev erev; /* ESP revision */ |
| 388 | int irq; /* IRQ for this ESP */ |
| 389 | int scsi_id; /* Who am I as initiator? */ |
| 390 | int scsi_id_mask; /* Bitmask of 'me'. */ |
| 391 | int diff; /* Differential SCSI bus? */ |
| 392 | int slot; /* Slot the adapter occupies */ |
| 393 | |
| 394 | /* Our command queues, only one cmd lives in the current_SC queue. */ |
| 395 | Scsi_Cmnd *issue_SC; /* Commands to be issued */ |
| 396 | Scsi_Cmnd *current_SC; /* Who is currently working the bus */ |
| 397 | Scsi_Cmnd *disconnected_SC; /* Commands disconnected from the bus */ |
| 398 | |
| 399 | /* Message goo */ |
| 400 | unchar cur_msgout[16]; |
| 401 | unchar cur_msgin[16]; |
| 402 | unchar prevmsgout, prevmsgin; |
| 403 | unchar msgout_len, msgin_len; |
| 404 | unchar msgout_ctr, msgin_ctr; |
| 405 | |
| 406 | /* States that we cannot keep in the per cmd structure because they |
| 407 | * cannot be assosciated with any specific command. |
| 408 | */ |
| 409 | unchar resetting_bus; |
| 410 | wait_queue_head_t reset_queue; |
| 411 | |
| 412 | unchar do_pio_cmds; /* Do command transfer with pio */ |
| 413 | |
| 414 | /* How much bits do we have to shift the registers */ |
| 415 | unsigned char shift; |
| 416 | |
| 417 | /* Functions handling DMA |
| 418 | */ |
| 419 | /* Required functions */ |
| 420 | int (*dma_bytes_sent)(struct NCR_ESP *, int); |
| 421 | int (*dma_can_transfer)(struct NCR_ESP *, Scsi_Cmnd *); |
| 422 | void (*dma_dump_state)(struct NCR_ESP *); |
| 423 | void (*dma_init_read)(struct NCR_ESP *, __u32, int); |
| 424 | void (*dma_init_write)(struct NCR_ESP *, __u32, int); |
| 425 | void (*dma_ints_off)(struct NCR_ESP *); |
| 426 | void (*dma_ints_on)(struct NCR_ESP *); |
| 427 | int (*dma_irq_p)(struct NCR_ESP *); |
| 428 | int (*dma_ports_p)(struct NCR_ESP *); |
| 429 | void (*dma_setup)(struct NCR_ESP *, __u32, int, int); |
| 430 | |
| 431 | /* Optional functions (i.e. may be initialized to 0) */ |
| 432 | void (*dma_barrier)(struct NCR_ESP *); |
| 433 | void (*dma_drain)(struct NCR_ESP *); |
| 434 | void (*dma_invalidate)(struct NCR_ESP *); |
| 435 | void (*dma_irq_entry)(struct NCR_ESP *); |
| 436 | void (*dma_irq_exit)(struct NCR_ESP *); |
| 437 | void (*dma_led_off)(struct NCR_ESP *); |
| 438 | void (*dma_led_on)(struct NCR_ESP *); |
| 439 | void (*dma_poll)(struct NCR_ESP *, unsigned char *); |
| 440 | void (*dma_reset)(struct NCR_ESP *); |
| 441 | |
| 442 | /* Optional virtual DMA functions */ |
| 443 | void (*dma_mmu_get_scsi_one)(struct NCR_ESP *, Scsi_Cmnd *); |
| 444 | void (*dma_mmu_get_scsi_sgl)(struct NCR_ESP *, Scsi_Cmnd *); |
| 445 | void (*dma_mmu_release_scsi_one)(struct NCR_ESP *, Scsi_Cmnd *); |
| 446 | void (*dma_mmu_release_scsi_sgl)(struct NCR_ESP *, Scsi_Cmnd *); |
| 447 | void (*dma_advance_sg)(Scsi_Cmnd *); |
| 448 | }; |
| 449 | |
| 450 | /* Bitfield meanings for the above registers. */ |
| 451 | |
| 452 | /* ESP config reg 1, read-write, found on all ESP chips */ |
| 453 | #define ESP_CONFIG1_ID 0x07 /* My BUS ID bits */ |
| 454 | #define ESP_CONFIG1_CHTEST 0x08 /* Enable ESP chip tests */ |
| 455 | #define ESP_CONFIG1_PENABLE 0x10 /* Enable parity checks */ |
| 456 | #define ESP_CONFIG1_PARTEST 0x20 /* Parity test mode enabled? */ |
| 457 | #define ESP_CONFIG1_SRRDISAB 0x40 /* Disable SCSI reset reports */ |
| 458 | #define ESP_CONFIG1_SLCABLE 0x80 /* Enable slow cable mode */ |
| 459 | |
| 460 | /* ESP config reg 2, read-write, found only on esp100a+esp200+esp236+fsc chips */ |
| 461 | #define ESP_CONFIG2_DMAPARITY 0x01 /* enable DMA Parity (200,236,fsc) */ |
| 462 | #define ESP_CONFIG2_REGPARITY 0x02 /* enable reg Parity (200,236,fsc) */ |
| 463 | #define ESP_CONFIG2_BADPARITY 0x04 /* Bad parity target abort */ |
| 464 | #define ESP_CONFIG2_SCSI2ENAB 0x08 /* Enable SCSI-2 features (tmode only) */ |
| 465 | #define ESP_CONFIG2_HI 0x10 /* High Impedance DREQ ??? */ |
| 466 | #define ESP_CONFIG2_HMEFENAB 0x10 /* HME features enable */ |
| 467 | #define ESP_CONFIG2_BCM 0x20 /* Enable byte-ctrl (236,fsc) */ |
| 468 | #define ESP_CONFIG2_FENAB 0x40 /* Enable features (fas100,esp216,fsc) */ |
| 469 | #define ESP_CONFIG2_SPL 0x40 /* Enable status-phase latch (esp236) */ |
| 470 | #define ESP_CONFIG2_RFB 0x80 /* Reserve FIFO byte (fsc) */ |
| 471 | #define ESP_CONFIG2_MAGIC 0xe0 /* Invalid bits... */ |
| 472 | |
| 473 | /* ESP config register 3 read-write, found only esp236+fas236+fas100a+fsc chips */ |
| 474 | #define ESP_CONFIG3_FCLOCK 0x01 /* FAST SCSI clock rate (esp100a/fas366) */ |
| 475 | #define ESP_CONFIG3_TEM 0x01 /* Enable thresh-8 mode (esp/fas236/fsc) */ |
| 476 | #define ESP_CONFIG3_FAST 0x02 /* Enable FAST SCSI (esp100a) */ |
| 477 | #define ESP_CONFIG3_ADMA 0x02 /* Enable alternate-dma (esp/fas236/fsc) */ |
| 478 | #define ESP_CONFIG3_TENB 0x04 /* group2 SCSI2 support (esp100a) */ |
| 479 | #define ESP_CONFIG3_SRB 0x04 /* Save residual byte (esp/fas236/fsc) */ |
| 480 | #define ESP_CONFIG3_TMS 0x08 /* Three-byte msg's ok (esp100a) */ |
| 481 | #define ESP_CONFIG3_FCLK 0x08 /* Fast SCSI clock rate (esp/fas236/fsc) */ |
| 482 | #define ESP_CONFIG3_IDMSG 0x10 /* ID message checking (esp100a) */ |
| 483 | #define ESP_CONFIG3_FSCSI 0x10 /* Enable FAST SCSI (esp/fas236/fsc) */ |
| 484 | #define ESP_CONFIG3_GTM 0x20 /* group2 SCSI2 support (esp/fas236/fsc) */ |
| 485 | #define ESP_CONFIG3_TBMS 0x40 /* Three-byte msg's ok (esp/fas236/fsc) */ |
| 486 | #define ESP_CONFIG3_IMS 0x80 /* ID msg chk'ng (esp/fas236/fsc) */ |
| 487 | |
| 488 | /* ESP config register 4 read-write, found only on fsc chips */ |
| 489 | #define ESP_CONFIG4_BBTE 0x01 /* Back-to-Back transfer enable */ |
| 490 | #define ESP_CONFIG4_TEST 0x02 /* Transfer counter test mode */ |
| 491 | #define ESP_CONFIG4_EAN 0x04 /* Enable Active Negotiation */ |
| 492 | |
| 493 | /* ESP command register read-write */ |
| 494 | /* Group 1 commands: These may be sent at any point in time to the ESP |
| 495 | * chip. None of them can generate interrupts 'cept |
| 496 | * the "SCSI bus reset" command if you have not disabled |
| 497 | * SCSI reset interrupts in the config1 ESP register. |
| 498 | */ |
| 499 | #define ESP_CMD_NULL 0x00 /* Null command, ie. a nop */ |
| 500 | #define ESP_CMD_FLUSH 0x01 /* FIFO Flush */ |
| 501 | #define ESP_CMD_RC 0x02 /* Chip reset */ |
| 502 | #define ESP_CMD_RS 0x03 /* SCSI bus reset */ |
| 503 | |
| 504 | /* Group 2 commands: ESP must be an initiator and connected to a target |
| 505 | * for these commands to work. |
| 506 | */ |
| 507 | #define ESP_CMD_TI 0x10 /* Transfer Information */ |
| 508 | #define ESP_CMD_ICCSEQ 0x11 /* Initiator cmd complete sequence */ |
| 509 | #define ESP_CMD_MOK 0x12 /* Message okie-dokie */ |
| 510 | #define ESP_CMD_TPAD 0x18 /* Transfer Pad */ |
| 511 | #define ESP_CMD_SATN 0x1a /* Set ATN */ |
| 512 | #define ESP_CMD_RATN 0x1b /* De-assert ATN */ |
| 513 | |
| 514 | /* Group 3 commands: ESP must be in the MSGOUT or MSGIN state and be connected |
| 515 | * to a target as the initiator for these commands to work. |
| 516 | */ |
| 517 | #define ESP_CMD_SMSG 0x20 /* Send message */ |
| 518 | #define ESP_CMD_SSTAT 0x21 /* Send status */ |
| 519 | #define ESP_CMD_SDATA 0x22 /* Send data */ |
| 520 | #define ESP_CMD_DSEQ 0x23 /* Discontinue Sequence */ |
| 521 | #define ESP_CMD_TSEQ 0x24 /* Terminate Sequence */ |
| 522 | #define ESP_CMD_TCCSEQ 0x25 /* Target cmd cmplt sequence */ |
| 523 | #define ESP_CMD_DCNCT 0x27 /* Disconnect */ |
| 524 | #define ESP_CMD_RMSG 0x28 /* Receive Message */ |
| 525 | #define ESP_CMD_RCMD 0x29 /* Receive Command */ |
| 526 | #define ESP_CMD_RDATA 0x2a /* Receive Data */ |
| 527 | #define ESP_CMD_RCSEQ 0x2b /* Receive cmd sequence */ |
| 528 | |
| 529 | /* Group 4 commands: The ESP must be in the disconnected state and must |
| 530 | * not be connected to any targets as initiator for |
| 531 | * these commands to work. |
| 532 | */ |
| 533 | #define ESP_CMD_RSEL 0x40 /* Reselect */ |
| 534 | #define ESP_CMD_SEL 0x41 /* Select w/o ATN */ |
| 535 | #define ESP_CMD_SELA 0x42 /* Select w/ATN */ |
| 536 | #define ESP_CMD_SELAS 0x43 /* Select w/ATN & STOP */ |
| 537 | #define ESP_CMD_ESEL 0x44 /* Enable selection */ |
| 538 | #define ESP_CMD_DSEL 0x45 /* Disable selections */ |
| 539 | #define ESP_CMD_SA3 0x46 /* Select w/ATN3 */ |
| 540 | #define ESP_CMD_RSEL3 0x47 /* Reselect3 */ |
| 541 | |
| 542 | /* This bit enables the ESP's DMA */ |
| 543 | #define ESP_CMD_DMA 0x80 /* Do DMA? */ |
| 544 | |
| 545 | /* ESP status register read-only */ |
| 546 | #define ESP_STAT_PIO 0x01 /* IO phase bit */ |
| 547 | #define ESP_STAT_PCD 0x02 /* CD phase bit */ |
| 548 | #define ESP_STAT_PMSG 0x04 /* MSG phase bit */ |
| 549 | #define ESP_STAT_PMASK 0x07 /* Mask of phase bits */ |
| 550 | #define ESP_STAT_TDONE 0x08 /* Transfer Completed */ |
| 551 | #define ESP_STAT_TCNT 0x10 /* Transfer Counter Is Zero */ |
| 552 | #define ESP_STAT_PERR 0x20 /* Parity error */ |
| 553 | #define ESP_STAT_SPAM 0x40 /* Real bad error */ |
| 554 | /* This indicates the 'interrupt pending' condition, it is a reserved |
| 555 | * bit on old revs of the ESP (ESP100, ESP100A, FAS100A). |
| 556 | */ |
| 557 | #define ESP_STAT_INTR 0x80 /* Interrupt */ |
| 558 | |
| 559 | /* The status register can be masked with ESP_STAT_PMASK and compared |
| 560 | * with the following values to determine the current phase the ESP |
| 561 | * (at least thinks it) is in. For our purposes we also add our own |
| 562 | * software 'done' bit for our phase management engine. |
| 563 | */ |
| 564 | #define ESP_DOP (0) /* Data Out */ |
| 565 | #define ESP_DIP (ESP_STAT_PIO) /* Data In */ |
| 566 | #define ESP_CMDP (ESP_STAT_PCD) /* Command */ |
| 567 | #define ESP_STATP (ESP_STAT_PCD|ESP_STAT_PIO) /* Status */ |
| 568 | #define ESP_MOP (ESP_STAT_PMSG|ESP_STAT_PCD) /* Message Out */ |
| 569 | #define ESP_MIP (ESP_STAT_PMSG|ESP_STAT_PCD|ESP_STAT_PIO) /* Message In */ |
| 570 | |
| 571 | /* ESP interrupt register read-only */ |
| 572 | #define ESP_INTR_S 0x01 /* Select w/o ATN */ |
| 573 | #define ESP_INTR_SATN 0x02 /* Select w/ATN */ |
| 574 | #define ESP_INTR_RSEL 0x04 /* Reselected */ |
| 575 | #define ESP_INTR_FDONE 0x08 /* Function done */ |
| 576 | #define ESP_INTR_BSERV 0x10 /* Bus service */ |
| 577 | #define ESP_INTR_DC 0x20 /* Disconnect */ |
| 578 | #define ESP_INTR_IC 0x40 /* Illegal command given */ |
| 579 | #define ESP_INTR_SR 0x80 /* SCSI bus reset detected */ |
| 580 | |
| 581 | /* Interrupt status macros */ |
| 582 | #define ESP_SRESET_IRQ(esp) ((esp)->intreg & (ESP_INTR_SR)) |
| 583 | #define ESP_ILLCMD_IRQ(esp) ((esp)->intreg & (ESP_INTR_IC)) |
| 584 | #define ESP_SELECT_WITH_ATN_IRQ(esp) ((esp)->intreg & (ESP_INTR_SATN)) |
| 585 | #define ESP_SELECT_WITHOUT_ATN_IRQ(esp) ((esp)->intreg & (ESP_INTR_S)) |
| 586 | #define ESP_SELECTION_IRQ(esp) ((ESP_SELECT_WITH_ATN_IRQ(esp)) || \ |
| 587 | (ESP_SELECT_WITHOUT_ATN_IRQ(esp))) |
| 588 | #define ESP_RESELECTION_IRQ(esp) ((esp)->intreg & (ESP_INTR_RSEL)) |
| 589 | |
| 590 | /* ESP sequence step register read-only */ |
| 591 | #define ESP_STEP_VBITS 0x07 /* Valid bits */ |
| 592 | #define ESP_STEP_ASEL 0x00 /* Selection&Arbitrate cmplt */ |
| 593 | #define ESP_STEP_SID 0x01 /* One msg byte sent */ |
| 594 | #define ESP_STEP_NCMD 0x02 /* Was not in command phase */ |
| 595 | #define ESP_STEP_PPC 0x03 /* Early phase chg caused cmnd |
| 596 | * bytes to be lost |
| 597 | */ |
| 598 | #define ESP_STEP_FINI4 0x04 /* Command was sent ok */ |
| 599 | |
| 600 | /* Ho hum, some ESP's set the step register to this as well... */ |
| 601 | #define ESP_STEP_FINI5 0x05 |
| 602 | #define ESP_STEP_FINI6 0x06 |
| 603 | #define ESP_STEP_FINI7 0x07 |
| 604 | #define ESP_STEP_SOM 0x08 /* Synchronous Offset Max */ |
| 605 | |
| 606 | /* ESP chip-test register read-write */ |
| 607 | #define ESP_TEST_TARG 0x01 /* Target test mode */ |
| 608 | #define ESP_TEST_INI 0x02 /* Initiator test mode */ |
| 609 | #define ESP_TEST_TS 0x04 /* Tristate test mode */ |
| 610 | |
| 611 | /* ESP unique ID register read-only, found on fas236+fas100a+fsc only */ |
| 612 | #define ESP_UID_F100A 0x00 /* FAS100A */ |
| 613 | #define ESP_UID_F236 0x02 /* FAS236 */ |
| 614 | #define ESP_UID_FSC 0xa2 /* NCR53CF9x-2 */ |
| 615 | #define ESP_UID_REV 0x07 /* ESP revision */ |
| 616 | #define ESP_UID_FAM 0xf8 /* ESP family */ |
| 617 | |
| 618 | /* ESP fifo flags register read-only */ |
| 619 | /* Note that the following implies a 16 byte FIFO on the ESP. */ |
| 620 | #define ESP_FF_FBYTES 0x1f /* Num bytes in FIFO */ |
| 621 | #define ESP_FF_ONOTZERO 0x20 /* offset ctr not zero (esp100,fsc) */ |
| 622 | #define ESP_FF_SSTEP 0xe0 /* Sequence step */ |
| 623 | |
| 624 | /* ESP clock conversion factor register write-only */ |
| 625 | #define ESP_CCF_F0 0x00 /* 35.01MHz - 40MHz */ |
| 626 | #define ESP_CCF_NEVER 0x01 /* Set it to this and die */ |
| 627 | #define ESP_CCF_F2 0x02 /* 10MHz */ |
| 628 | #define ESP_CCF_F3 0x03 /* 10.01MHz - 15MHz */ |
| 629 | #define ESP_CCF_F4 0x04 /* 15.01MHz - 20MHz */ |
| 630 | #define ESP_CCF_F5 0x05 /* 20.01MHz - 25MHz */ |
| 631 | #define ESP_CCF_F6 0x06 /* 25.01MHz - 30MHz */ |
| 632 | #define ESP_CCF_F7 0x07 /* 30.01MHz - 35MHz */ |
| 633 | |
| 634 | #define ESP_BUS_TIMEOUT 275 /* In milli-seconds */ |
| 635 | #define ESP_TIMEO_CONST 8192 |
| 636 | #define FSC_TIMEO_CONST 7668 |
| 637 | #define ESP_NEG_DEFP(mhz, cfact) \ |
| 638 | ((ESP_BUS_TIMEOUT * ((mhz) / 1000)) / (8192 * (cfact))) |
| 639 | #define FSC_NEG_DEFP(mhz, cfact) \ |
| 640 | ((ESP_BUS_TIMEOUT * ((mhz) / 1000)) / (7668 * (cfact))) |
| 641 | #define ESP_MHZ_TO_CYCLE(mhertz) ((1000000000) / ((mhertz) / 1000)) |
| 642 | #define ESP_TICK(ccf, cycle) ((7682 * (ccf) * (cycle) / 1000)) |
| 643 | |
| 644 | |
| 645 | /* UGLY, UGLY, UGLY! */ |
| 646 | extern int nesps, esps_in_use, esps_running; |
| 647 | |
| 648 | /* For our interrupt engine. */ |
| 649 | #define for_each_esp(esp) \ |
| 650 | for((esp) = espchain; (esp); (esp) = (esp)->next) |
| 651 | |
| 652 | |
| 653 | /* External functions */ |
| 654 | extern void esp_bootup_reset(struct NCR_ESP *esp, struct ESP_regs *eregs); |
Maciej W. Rozycki | 4df4db5 | 2007-02-05 16:28:29 -0800 | [diff] [blame] | 655 | extern struct NCR_ESP *esp_allocate(struct scsi_host_template *, void *, int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 656 | extern void esp_deallocate(struct NCR_ESP *); |
| 657 | extern void esp_release(void); |
| 658 | extern void esp_initialize(struct NCR_ESP *); |
David Howells | 7d12e78 | 2006-10-05 14:55:46 +0100 | [diff] [blame] | 659 | extern irqreturn_t esp_intr(int, void *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 660 | extern const char *esp_info(struct Scsi_Host *); |
| 661 | extern int esp_queue(Scsi_Cmnd *, void (*done)(Scsi_Cmnd *)); |
| 662 | extern int esp_abort(Scsi_Cmnd *); |
| 663 | extern int esp_reset(Scsi_Cmnd *); |
| 664 | extern int esp_proc_info(struct Scsi_Host *shost, char *buffer, char **start, off_t offset, int length, |
| 665 | int inout); |
Christoph Hellwig | f64a181 | 2005-10-31 18:32:08 +0100 | [diff] [blame] | 666 | extern int esp_slave_alloc(struct scsi_device *); |
| 667 | extern void esp_slave_destroy(struct scsi_device *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 668 | #endif /* !(NCR53C9X_H) */ |