1 /* 2 * NCR 5380 defines 3 * 4 * Copyright 1993, Drew Eckhardt 5 * Visionary Computing 6 * (Unix consulting and custom programming) 7 * drew@colorado.edu 8 * +1 (303) 666-5836 9 * 10 * For more information, please consult 11 * 12 * NCR 5380 Family 13 * SCSI Protocol Controller 14 * Databook 15 * NCR Microelectronics 16 * 1635 Aeroplaza Drive 17 * Colorado Springs, CO 80916 18 * 1+ (719) 578-3400 19 * 1+ (800) 334-5454 20 */ 21 22 #ifndef NCR5380_H 23 #define NCR5380_H 24 25 #include <linux/delay.h> 26 #include <linux/interrupt.h> 27 #include <linux/list.h> 28 #include <linux/workqueue.h> 29 #include <scsi/scsi_dbg.h> 30 #include <scsi/scsi_eh.h> 31 #include <scsi/scsi_transport_spi.h> 32 33 #define NDEBUG_ARBITRATION 0x1 34 #define NDEBUG_AUTOSENSE 0x2 35 #define NDEBUG_DMA 0x4 36 #define NDEBUG_HANDSHAKE 0x8 37 #define NDEBUG_INFORMATION 0x10 38 #define NDEBUG_INIT 0x20 39 #define NDEBUG_INTR 0x40 40 #define NDEBUG_LINKED 0x80 41 #define NDEBUG_MAIN 0x100 42 #define NDEBUG_NO_DATAOUT 0x200 43 #define NDEBUG_NO_WRITE 0x400 44 #define NDEBUG_PIO 0x800 45 #define NDEBUG_PSEUDO_DMA 0x1000 46 #define NDEBUG_QUEUES 0x2000 47 #define NDEBUG_RESELECTION 0x4000 48 #define NDEBUG_SELECTION 0x8000 49 #define NDEBUG_USLEEP 0x10000 50 #define NDEBUG_LAST_BYTE_SENT 0x20000 51 #define NDEBUG_RESTART_SELECT 0x40000 52 #define NDEBUG_EXTENDED 0x80000 53 #define NDEBUG_C400_PREAD 0x100000 54 #define NDEBUG_C400_PWRITE 0x200000 55 #define NDEBUG_LISTS 0x400000 56 #define NDEBUG_ABORT 0x800000 57 #define NDEBUG_TAGS 0x1000000 58 #define NDEBUG_MERGING 0x2000000 59 60 #define NDEBUG_ANY 0xFFFFFFFFUL 61 62 /* 63 * The contents of the OUTPUT DATA register are asserted on the bus when 64 * either arbitration is occurring or the phase-indicating signals ( 65 * IO, CD, MSG) in the TARGET COMMAND register and the ASSERT DATA 66 * bit in the INITIATOR COMMAND register is set. 67 */ 68 69 #define OUTPUT_DATA_REG 0 /* wo DATA lines on SCSI bus */ 70 #define CURRENT_SCSI_DATA_REG 0 /* ro same */ 71 72 #define INITIATOR_COMMAND_REG 1 /* rw */ 73 #define ICR_ASSERT_RST 0x80 /* rw Set to assert RST */ 74 #define ICR_ARBITRATION_PROGRESS 0x40 /* ro Indicates arbitration complete */ 75 #define ICR_TRI_STATE 0x40 /* wo Set to tri-state drivers */ 76 #define ICR_ARBITRATION_LOST 0x20 /* ro Indicates arbitration lost */ 77 #define ICR_DIFF_ENABLE 0x20 /* wo Set to enable diff. drivers */ 78 #define ICR_ASSERT_ACK 0x10 /* rw ini Set to assert ACK */ 79 #define ICR_ASSERT_BSY 0x08 /* rw Set to assert BSY */ 80 #define ICR_ASSERT_SEL 0x04 /* rw Set to assert SEL */ 81 #define ICR_ASSERT_ATN 0x02 /* rw Set to assert ATN */ 82 #define ICR_ASSERT_DATA 0x01 /* rw SCSI_DATA_REG is asserted */ 83 84 #define ICR_BASE 0 85 86 #define MODE_REG 2 87 /* 88 * Note : BLOCK_DMA code will keep DRQ asserted for the duration of the 89 * transfer, causing the chip to hog the bus. You probably don't want 90 * this. 91 */ 92 #define MR_BLOCK_DMA_MODE 0x80 /* rw block mode DMA */ 93 #define MR_TARGET 0x40 /* rw target mode */ 94 #define MR_ENABLE_PAR_CHECK 0x20 /* rw enable parity checking */ 95 #define MR_ENABLE_PAR_INTR 0x10 /* rw enable bad parity interrupt */ 96 #define MR_ENABLE_EOP_INTR 0x08 /* rw enable eop interrupt */ 97 #define MR_MONITOR_BSY 0x04 /* rw enable int on unexpected bsy fail */ 98 #define MR_DMA_MODE 0x02 /* rw DMA / pseudo DMA mode */ 99 #define MR_ARBITRATE 0x01 /* rw start arbitration */ 100 101 #define MR_BASE 0 102 103 #define TARGET_COMMAND_REG 3 104 #define TCR_LAST_BYTE_SENT 0x80 /* ro DMA done */ 105 #define TCR_ASSERT_REQ 0x08 /* tgt rw assert REQ */ 106 #define TCR_ASSERT_MSG 0x04 /* tgt rw assert MSG */ 107 #define TCR_ASSERT_CD 0x02 /* tgt rw assert CD */ 108 #define TCR_ASSERT_IO 0x01 /* tgt rw assert IO */ 109 110 #define STATUS_REG 4 /* ro */ 111 /* 112 * Note : a set bit indicates an active signal, driven by us or another 113 * device. 114 */ 115 #define SR_RST 0x80 116 #define SR_BSY 0x40 117 #define SR_REQ 0x20 118 #define SR_MSG 0x10 119 #define SR_CD 0x08 120 #define SR_IO 0x04 121 #define SR_SEL 0x02 122 #define SR_DBP 0x01 123 124 /* 125 * Setting a bit in this register will cause an interrupt to be generated when 126 * BSY is false and SEL true and this bit is asserted on the bus. 127 */ 128 #define SELECT_ENABLE_REG 4 /* wo */ 129 130 #define BUS_AND_STATUS_REG 5 /* ro */ 131 #define BASR_END_DMA_TRANSFER 0x80 /* ro set on end of transfer */ 132 #define BASR_DRQ 0x40 /* ro mirror of DRQ pin */ 133 #define BASR_PARITY_ERROR 0x20 /* ro parity error detected */ 134 #define BASR_IRQ 0x10 /* ro mirror of IRQ pin */ 135 #define BASR_PHASE_MATCH 0x08 /* ro Set when MSG CD IO match TCR */ 136 #define BASR_BUSY_ERROR 0x04 /* ro Unexpected change to inactive state */ 137 #define BASR_ATN 0x02 /* ro BUS status */ 138 #define BASR_ACK 0x01 /* ro BUS status */ 139 140 /* Write any value to this register to start a DMA send */ 141 #define START_DMA_SEND_REG 5 /* wo */ 142 143 /* 144 * Used in DMA transfer mode, data is latched from the SCSI bus on 145 * the falling edge of REQ (ini) or ACK (tgt) 146 */ 147 #define INPUT_DATA_REG 6 /* ro */ 148 149 /* Write any value to this register to start a DMA receive */ 150 #define START_DMA_TARGET_RECEIVE_REG 6 /* wo */ 151 152 /* Read this register to clear interrupt conditions */ 153 #define RESET_PARITY_INTERRUPT_REG 7 /* ro */ 154 155 /* Write any value to this register to start an ini mode DMA receive */ 156 #define START_DMA_INITIATOR_RECEIVE_REG 7 /* wo */ 157 158 /* NCR 53C400(A) Control Status Register bits: */ 159 #define CSR_RESET 0x80 /* wo Resets 53c400 */ 160 #define CSR_53C80_REG 0x80 /* ro 5380 registers busy */ 161 #define CSR_TRANS_DIR 0x40 /* rw Data transfer direction */ 162 #define CSR_SCSI_BUFF_INTR 0x20 /* rw Enable int on transfer ready */ 163 #define CSR_53C80_INTR 0x10 /* rw Enable 53c80 interrupts */ 164 #define CSR_SHARED_INTR 0x08 /* rw Interrupt sharing */ 165 #define CSR_HOST_BUF_NOT_RDY 0x04 /* ro Is Host buffer ready */ 166 #define CSR_SCSI_BUF_RDY 0x02 /* ro SCSI buffer read */ 167 #define CSR_GATED_53C80_IRQ 0x01 /* ro Last block xferred */ 168 169 #define CSR_BASE CSR_53C80_INTR 170 171 /* Note : PHASE_* macros are based on the values of the STATUS register */ 172 #define PHASE_MASK (SR_MSG | SR_CD | SR_IO) 173 174 #define PHASE_DATAOUT 0 175 #define PHASE_DATAIN SR_IO 176 #define PHASE_CMDOUT SR_CD 177 #define PHASE_STATIN (SR_CD | SR_IO) 178 #define PHASE_MSGOUT (SR_MSG | SR_CD) 179 #define PHASE_MSGIN (SR_MSG | SR_CD | SR_IO) 180 #define PHASE_UNKNOWN 0xff 181 182 /* 183 * Convert status register phase to something we can use to set phase in 184 * the target register so we can get phase mismatch interrupts on DMA 185 * transfers. 186 */ 187 188 #define PHASE_SR_TO_TCR(phase) ((phase) >> 2) 189 190 #ifndef NO_IRQ 191 #define NO_IRQ 0 192 #endif 193 194 #define FLAG_DMA_FIXUP 1 /* Use DMA errata workarounds */ 195 #define FLAG_NO_PSEUDO_DMA 8 /* Inhibit DMA */ 196 #define FLAG_LATE_DMA_SETUP 32 /* Setup NCR before DMA H/W */ 197 #define FLAG_TOSHIBA_DELAY 128 /* Allow for borken CD-ROMs */ 198 199 struct NCR5380_hostdata { 200 NCR5380_implementation_fields; /* Board-specific data */ 201 u8 __iomem *io; /* Remapped 5380 address */ 202 u8 __iomem *pdma_io; /* Remapped PDMA address */ 203 unsigned long poll_loops; /* Register polling limit */ 204 spinlock_t lock; /* Protects this struct */ 205 struct scsi_cmnd *connected; /* Currently connected cmnd */ 206 struct list_head disconnected; /* Waiting for reconnect */ 207 struct Scsi_Host *host; /* SCSI host backpointer */ 208 struct workqueue_struct *work_q; /* SCSI host work queue */ 209 struct work_struct main_task; /* Work item for main loop */ 210 int flags; /* Board-specific quirks */ 211 int dma_len; /* Requested length of DMA */ 212 int read_overruns; /* Transfer size reduction for DMA erratum */ 213 unsigned long io_port; /* Device IO port */ 214 unsigned long base; /* Device base address */ 215 struct list_head unissued; /* Waiting to be issued */ 216 struct scsi_cmnd *selecting; /* Cmnd to be connected */ 217 struct list_head autosense; /* Priority cmnd queue */ 218 struct scsi_cmnd *sensing; /* Cmnd needing autosense */ 219 struct scsi_eh_save ses; /* Cmnd state saved for EH */ 220 unsigned char busy[8]; /* Index = target, bit = lun */ 221 unsigned char id_mask; /* 1 << Host ID */ 222 unsigned char id_higher_mask; /* All bits above id_mask */ 223 unsigned char last_message; /* Last Message Out */ 224 unsigned long region_size; /* Size of address/port range */ 225 char info[168]; /* Host banner message */ 226 }; 227 228 struct NCR5380_cmd { 229 struct list_head list; 230 }; 231 232 #define NCR5380_CMD_SIZE (sizeof(struct NCR5380_cmd)) 233 234 #define NCR5380_PIO_CHUNK_SIZE 256 235 236 /* Time limit (ms) to poll registers when IRQs are disabled, e.g. during PDMA */ 237 #define NCR5380_REG_POLL_TIME 15 238 239 static inline struct scsi_cmnd *NCR5380_to_scmd(struct NCR5380_cmd *ncmd_ptr) 240 { 241 return ((struct scsi_cmnd *)ncmd_ptr) - 1; 242 } 243 244 #ifndef NDEBUG 245 #define NDEBUG (0) 246 #endif 247 248 #define dprintk(flg, fmt, ...) \ 249 do { if ((NDEBUG) & (flg)) \ 250 printk(KERN_DEBUG fmt, ## __VA_ARGS__); } while (0) 251 252 #define dsprintk(flg, host, fmt, ...) \ 253 do { if ((NDEBUG) & (flg)) \ 254 shost_printk(KERN_DEBUG, host, fmt, ## __VA_ARGS__); \ 255 } while (0) 256 257 #if NDEBUG 258 #define NCR5380_dprint(flg, arg) \ 259 do { if ((NDEBUG) & (flg)) NCR5380_print(arg); } while (0) 260 #define NCR5380_dprint_phase(flg, arg) \ 261 do { if ((NDEBUG) & (flg)) NCR5380_print_phase(arg); } while (0) 262 static void NCR5380_print_phase(struct Scsi_Host *instance); 263 static void NCR5380_print(struct Scsi_Host *instance); 264 #else 265 #define NCR5380_dprint(flg, arg) do {} while (0) 266 #define NCR5380_dprint_phase(flg, arg) do {} while (0) 267 #endif 268 269 static int NCR5380_init(struct Scsi_Host *instance, int flags); 270 static int NCR5380_maybe_reset_bus(struct Scsi_Host *); 271 static void NCR5380_exit(struct Scsi_Host *instance); 272 static void NCR5380_information_transfer(struct Scsi_Host *instance); 273 static irqreturn_t NCR5380_intr(int irq, void *dev_id); 274 static void NCR5380_main(struct work_struct *work); 275 static const char *NCR5380_info(struct Scsi_Host *instance); 276 static void NCR5380_reselect(struct Scsi_Host *instance); 277 static struct scsi_cmnd *NCR5380_select(struct Scsi_Host *, struct scsi_cmnd *); 278 static int NCR5380_transfer_dma(struct Scsi_Host *instance, unsigned char *phase, int *count, unsigned char **data); 279 static int NCR5380_transfer_pio(struct Scsi_Host *instance, unsigned char *phase, int *count, unsigned char **data); 280 static int NCR5380_poll_politely2(struct NCR5380_hostdata *, 281 unsigned int, u8, u8, 282 unsigned int, u8, u8, unsigned long); 283 284 static inline int NCR5380_poll_politely(struct NCR5380_hostdata *hostdata, 285 unsigned int reg, u8 bit, u8 val, 286 unsigned long wait) 287 { 288 if ((NCR5380_read(reg) & bit) == val) 289 return 0; 290 291 return NCR5380_poll_politely2(hostdata, reg, bit, val, 292 reg, bit, val, wait); 293 } 294 295 static int NCR5380_dma_xfer_len(struct NCR5380_hostdata *, 296 struct scsi_cmnd *); 297 static int NCR5380_dma_send_setup(struct NCR5380_hostdata *, 298 unsigned char *, int); 299 static int NCR5380_dma_recv_setup(struct NCR5380_hostdata *, 300 unsigned char *, int); 301 static int NCR5380_dma_residual(struct NCR5380_hostdata *); 302 303 static inline int NCR5380_dma_xfer_none(struct NCR5380_hostdata *hostdata, 304 struct scsi_cmnd *cmd) 305 { 306 return 0; 307 } 308 309 static inline int NCR5380_dma_setup_none(struct NCR5380_hostdata *hostdata, 310 unsigned char *data, int count) 311 { 312 return 0; 313 } 314 315 static inline int NCR5380_dma_residual_none(struct NCR5380_hostdata *hostdata) 316 { 317 return 0; 318 } 319 320 #endif /* NCR5380_H */ 321