Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | * | |
1da177e4 LT |
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 | ||
1da177e4 LT |
22 | #ifndef NCR5380_H |
23 | #define NCR5380_H | |
24 | ||
25 | #include <linux/interrupt.h> | |
28424d3a | 26 | #include <scsi/scsi_eh.h> |
28424d3a | 27 | |
1da177e4 LT |
28 | #define NDEBUG_ARBITRATION 0x1 |
29 | #define NDEBUG_AUTOSENSE 0x2 | |
30 | #define NDEBUG_DMA 0x4 | |
31 | #define NDEBUG_HANDSHAKE 0x8 | |
32 | #define NDEBUG_INFORMATION 0x10 | |
33 | #define NDEBUG_INIT 0x20 | |
34 | #define NDEBUG_INTR 0x40 | |
35 | #define NDEBUG_LINKED 0x80 | |
36 | #define NDEBUG_MAIN 0x100 | |
37 | #define NDEBUG_NO_DATAOUT 0x200 | |
38 | #define NDEBUG_NO_WRITE 0x400 | |
39 | #define NDEBUG_PIO 0x800 | |
40 | #define NDEBUG_PSEUDO_DMA 0x1000 | |
41 | #define NDEBUG_QUEUES 0x2000 | |
42 | #define NDEBUG_RESELECTION 0x4000 | |
43 | #define NDEBUG_SELECTION 0x8000 | |
44 | #define NDEBUG_USLEEP 0x10000 | |
45 | #define NDEBUG_LAST_BYTE_SENT 0x20000 | |
46 | #define NDEBUG_RESTART_SELECT 0x40000 | |
47 | #define NDEBUG_EXTENDED 0x80000 | |
48 | #define NDEBUG_C400_PREAD 0x100000 | |
49 | #define NDEBUG_C400_PWRITE 0x200000 | |
50 | #define NDEBUG_LISTS 0x400000 | |
9829e528 FT |
51 | #define NDEBUG_ABORT 0x800000 |
52 | #define NDEBUG_TAGS 0x1000000 | |
53 | #define NDEBUG_MERGING 0x2000000 | |
1da177e4 LT |
54 | |
55 | #define NDEBUG_ANY 0xFFFFFFFFUL | |
56 | ||
57 | /* | |
58 | * The contents of the OUTPUT DATA register are asserted on the bus when | |
59 | * either arbitration is occurring or the phase-indicating signals ( | |
60 | * IO, CD, MSG) in the TARGET COMMAND register and the ASSERT DATA | |
61 | * bit in the INITIATOR COMMAND register is set. | |
62 | */ | |
63 | ||
64 | #define OUTPUT_DATA_REG 0 /* wo DATA lines on SCSI bus */ | |
65 | #define CURRENT_SCSI_DATA_REG 0 /* ro same */ | |
66 | ||
67 | #define INITIATOR_COMMAND_REG 1 /* rw */ | |
68 | #define ICR_ASSERT_RST 0x80 /* rw Set to assert RST */ | |
69 | #define ICR_ARBITRATION_PROGRESS 0x40 /* ro Indicates arbitration complete */ | |
70 | #define ICR_TRI_STATE 0x40 /* wo Set to tri-state drivers */ | |
71 | #define ICR_ARBITRATION_LOST 0x20 /* ro Indicates arbitration lost */ | |
72 | #define ICR_DIFF_ENABLE 0x20 /* wo Set to enable diff. drivers */ | |
73 | #define ICR_ASSERT_ACK 0x10 /* rw ini Set to assert ACK */ | |
74 | #define ICR_ASSERT_BSY 0x08 /* rw Set to assert BSY */ | |
75 | #define ICR_ASSERT_SEL 0x04 /* rw Set to assert SEL */ | |
76 | #define ICR_ASSERT_ATN 0x02 /* rw Set to assert ATN */ | |
77 | #define ICR_ASSERT_DATA 0x01 /* rw SCSI_DATA_REG is asserted */ | |
78 | ||
79 | #ifdef DIFFERENTIAL | |
80 | #define ICR_BASE ICR_DIFF_ENABLE | |
81 | #else | |
82 | #define ICR_BASE 0 | |
83 | #endif | |
84 | ||
85 | #define MODE_REG 2 | |
86 | /* | |
87 | * Note : BLOCK_DMA code will keep DRQ asserted for the duration of the | |
88 | * transfer, causing the chip to hog the bus. You probably don't want | |
89 | * this. | |
90 | */ | |
91 | #define MR_BLOCK_DMA_MODE 0x80 /* rw block mode DMA */ | |
92 | #define MR_TARGET 0x40 /* rw target mode */ | |
93 | #define MR_ENABLE_PAR_CHECK 0x20 /* rw enable parity checking */ | |
94 | #define MR_ENABLE_PAR_INTR 0x10 /* rw enable bad parity interrupt */ | |
95 | #define MR_ENABLE_EOP_INTR 0x08 /* rw enable eop interrupt */ | |
96 | #define MR_MONITOR_BSY 0x04 /* rw enable int on unexpected bsy fail */ | |
97 | #define MR_DMA_MODE 0x02 /* rw DMA / pseudo DMA mode */ | |
98 | #define MR_ARBITRATE 0x01 /* rw start arbitration */ | |
99 | ||
100 | #ifdef PARITY | |
101 | #define MR_BASE MR_ENABLE_PAR_CHECK | |
102 | #else | |
103 | #define MR_BASE 0 | |
104 | #endif | |
105 | ||
106 | #define TARGET_COMMAND_REG 3 | |
107 | #define TCR_LAST_BYTE_SENT 0x80 /* ro DMA done */ | |
108 | #define TCR_ASSERT_REQ 0x08 /* tgt rw assert REQ */ | |
109 | #define TCR_ASSERT_MSG 0x04 /* tgt rw assert MSG */ | |
110 | #define TCR_ASSERT_CD 0x02 /* tgt rw assert CD */ | |
111 | #define TCR_ASSERT_IO 0x01 /* tgt rw assert IO */ | |
112 | ||
113 | #define STATUS_REG 4 /* ro */ | |
114 | /* | |
115 | * Note : a set bit indicates an active signal, driven by us or another | |
116 | * device. | |
117 | */ | |
118 | #define SR_RST 0x80 | |
119 | #define SR_BSY 0x40 | |
120 | #define SR_REQ 0x20 | |
121 | #define SR_MSG 0x10 | |
122 | #define SR_CD 0x08 | |
123 | #define SR_IO 0x04 | |
124 | #define SR_SEL 0x02 | |
125 | #define SR_DBP 0x01 | |
126 | ||
127 | /* | |
128 | * Setting a bit in this register will cause an interrupt to be generated when | |
129 | * BSY is false and SEL true and this bit is asserted on the bus. | |
130 | */ | |
131 | #define SELECT_ENABLE_REG 4 /* wo */ | |
132 | ||
133 | #define BUS_AND_STATUS_REG 5 /* ro */ | |
134 | #define BASR_END_DMA_TRANSFER 0x80 /* ro set on end of transfer */ | |
135 | #define BASR_DRQ 0x40 /* ro mirror of DRQ pin */ | |
136 | #define BASR_PARITY_ERROR 0x20 /* ro parity error detected */ | |
137 | #define BASR_IRQ 0x10 /* ro mirror of IRQ pin */ | |
138 | #define BASR_PHASE_MATCH 0x08 /* ro Set when MSG CD IO match TCR */ | |
139 | #define BASR_BUSY_ERROR 0x04 /* ro Unexpected change to inactive state */ | |
140 | #define BASR_ATN 0x02 /* ro BUS status */ | |
141 | #define BASR_ACK 0x01 /* ro BUS status */ | |
142 | ||
143 | /* Write any value to this register to start a DMA send */ | |
144 | #define START_DMA_SEND_REG 5 /* wo */ | |
145 | ||
146 | /* | |
147 | * Used in DMA transfer mode, data is latched from the SCSI bus on | |
148 | * the falling edge of REQ (ini) or ACK (tgt) | |
149 | */ | |
150 | #define INPUT_DATA_REG 6 /* ro */ | |
151 | ||
152 | /* Write any value to this register to start a DMA receive */ | |
153 | #define START_DMA_TARGET_RECEIVE_REG 6 /* wo */ | |
154 | ||
155 | /* Read this register to clear interrupt conditions */ | |
156 | #define RESET_PARITY_INTERRUPT_REG 7 /* ro */ | |
157 | ||
158 | /* Write any value to this register to start an ini mode DMA receive */ | |
159 | #define START_DMA_INITIATOR_RECEIVE_REG 7 /* wo */ | |
160 | ||
161 | #define C400_CONTROL_STATUS_REG NCR53C400_register_offset-8 /* rw */ | |
162 | ||
163 | #define CSR_RESET 0x80 /* wo Resets 53c400 */ | |
164 | #define CSR_53C80_REG 0x80 /* ro 5380 registers busy */ | |
165 | #define CSR_TRANS_DIR 0x40 /* rw Data transfer direction */ | |
166 | #define CSR_SCSI_BUFF_INTR 0x20 /* rw Enable int on transfer ready */ | |
167 | #define CSR_53C80_INTR 0x10 /* rw Enable 53c80 interrupts */ | |
168 | #define CSR_SHARED_INTR 0x08 /* rw Interrupt sharing */ | |
169 | #define CSR_HOST_BUF_NOT_RDY 0x04 /* ro Is Host buffer ready */ | |
170 | #define CSR_SCSI_BUF_RDY 0x02 /* ro SCSI buffer read */ | |
171 | #define CSR_GATED_53C80_IRQ 0x01 /* ro Last block xferred */ | |
172 | ||
173 | #if 0 | |
174 | #define CSR_BASE CSR_SCSI_BUFF_INTR | CSR_53C80_INTR | |
175 | #else | |
176 | #define CSR_BASE CSR_53C80_INTR | |
177 | #endif | |
178 | ||
179 | /* Number of 128-byte blocks to be transferred */ | |
180 | #define C400_BLOCK_COUNTER_REG NCR53C400_register_offset-7 /* rw */ | |
181 | ||
182 | /* Resume transfer after disconnect */ | |
183 | #define C400_RESUME_TRANSFER_REG NCR53C400_register_offset-6 /* wo */ | |
184 | ||
185 | /* Access to host buffer stack */ | |
186 | #define C400_HOST_BUFFER NCR53C400_register_offset-4 /* rw */ | |
187 | ||
188 | ||
189 | /* Note : PHASE_* macros are based on the values of the STATUS register */ | |
190 | #define PHASE_MASK (SR_MSG | SR_CD | SR_IO) | |
191 | ||
192 | #define PHASE_DATAOUT 0 | |
193 | #define PHASE_DATAIN SR_IO | |
194 | #define PHASE_CMDOUT SR_CD | |
195 | #define PHASE_STATIN (SR_CD | SR_IO) | |
196 | #define PHASE_MSGOUT (SR_MSG | SR_CD) | |
197 | #define PHASE_MSGIN (SR_MSG | SR_CD | SR_IO) | |
198 | #define PHASE_UNKNOWN 0xff | |
199 | ||
200 | /* | |
201 | * Convert status register phase to something we can use to set phase in | |
202 | * the target register so we can get phase mismatch interrupts on DMA | |
203 | * transfers. | |
204 | */ | |
205 | ||
206 | #define PHASE_SR_TO_TCR(phase) ((phase) >> 2) | |
207 | ||
208 | /* | |
209 | * The internal should_disconnect() function returns these based on the | |
210 | * expected length of a disconnect if a device supports disconnect/ | |
211 | * reconnect. | |
212 | */ | |
213 | ||
214 | #define DISCONNECT_NONE 0 | |
215 | #define DISCONNECT_TIME_TO_DATA 1 | |
216 | #define DISCONNECT_LONG 2 | |
217 | ||
218 | /* | |
76f13b93 FT |
219 | * "Special" value for the (unsigned char) command tag, to indicate |
220 | * I_T_L nexus instead of I_T_L_Q. | |
1da177e4 LT |
221 | */ |
222 | ||
76f13b93 | 223 | #define TAG_NONE 0xff |
1da177e4 LT |
224 | |
225 | /* | |
226 | * These are "special" values for the irq and dma_channel fields of the | |
227 | * Scsi_Host structure | |
228 | */ | |
229 | ||
1da177e4 LT |
230 | #define DMA_NONE 255 |
231 | #define IRQ_AUTO 254 | |
232 | #define DMA_AUTO 254 | |
233 | #define PORT_AUTO 0xffff /* autoprobe io port for 53c400a */ | |
234 | ||
22f5f10d FT |
235 | #ifndef NO_IRQ |
236 | #define NO_IRQ 0 | |
237 | #endif | |
238 | ||
1da177e4 LT |
239 | #define FLAG_HAS_LAST_BYTE_SENT 1 /* NCR53c81 or better */ |
240 | #define FLAG_CHECK_LAST_BYTE_SENT 2 /* Only test once */ | |
241 | #define FLAG_NCR53C400 4 /* NCR53c400 */ | |
242 | #define FLAG_NO_PSEUDO_DMA 8 /* Inhibit DMA */ | |
243 | #define FLAG_DTC3181E 16 /* DTC3181E */ | |
ef1081cb | 244 | #define FLAG_LATE_DMA_SETUP 32 /* Setup NCR before DMA H/W */ |
ca513fc9 | 245 | #define FLAG_TAGGED_QUEUING 64 /* as X3T9.2 spelled it */ |
1da177e4 LT |
246 | |
247 | #ifndef ASM | |
61d739a4 FT |
248 | |
249 | #ifdef SUPPORT_TAGS | |
250 | struct tag_alloc { | |
251 | DECLARE_BITMAP(allocated, MAX_TAGS); | |
252 | int nr_allocated; | |
253 | int queue_size; | |
254 | }; | |
255 | #endif | |
256 | ||
1da177e4 LT |
257 | struct NCR5380_hostdata { |
258 | NCR5380_implementation_fields; /* implementation specific */ | |
259 | struct Scsi_Host *host; /* Host backpointer */ | |
260 | unsigned char id_mask, id_higher_mask; /* 1 << id, all bits greater */ | |
261 | unsigned char targets_present; /* targets we have connected | |
262 | to, so we can call a select | |
263 | failure a retryable condition */ | |
264 | volatile unsigned char busy[8]; /* index = target, bit = lun */ | |
265 | #if defined(REAL_DMA) || defined(REAL_DMA_POLL) | |
266 | volatile int dma_len; /* requested length of DMA */ | |
267 | #endif | |
268 | volatile unsigned char last_message; /* last message OUT */ | |
710ddd0d FT |
269 | volatile struct scsi_cmnd *connected; /* currently connected command */ |
270 | volatile struct scsi_cmnd *issue_queue; /* waiting to be issued */ | |
271 | volatile struct scsi_cmnd *disconnected_queue; /* waiting for reconnect */ | |
1da177e4 LT |
272 | volatile int restart_select; /* we have disconnected, |
273 | used to restart | |
274 | NCR5380_select() */ | |
275 | volatile unsigned aborted:1; /* flag, says aborted */ | |
276 | int flags; | |
277 | unsigned long time_expires; /* in jiffies, set prior to sleeping */ | |
278 | int select_time; /* timer in select for target response */ | |
710ddd0d | 279 | volatile struct scsi_cmnd *selecting; |
c4028958 | 280 | struct delayed_work coroutine; /* our co-routine */ |
28424d3a | 281 | struct scsi_eh_save ses; |
8c32513b | 282 | char info[256]; |
ef1081cb FT |
283 | int read_overruns; /* number of bytes to cut from a |
284 | * transfer to handle chip overruns */ | |
285 | int retain_dma_intr; | |
a53a21e4 FT |
286 | struct work_struct main_task; |
287 | volatile int main_running; | |
61d739a4 FT |
288 | #ifdef SUPPORT_TAGS |
289 | struct tag_alloc TagAlloc[8][8]; /* 8 targets and 8 LUNs */ | |
290 | #endif | |
a9c2dc43 FT |
291 | #ifdef PSEUDO_DMA |
292 | unsigned spin_max_r; | |
293 | unsigned spin_max_w; | |
294 | #endif | |
1da177e4 LT |
295 | }; |
296 | ||
297 | #ifdef __KERNEL__ | |
298 | ||
9829e528 FT |
299 | #ifndef NDEBUG |
300 | #define NDEBUG (0) | |
301 | #endif | |
302 | ||
16b9d870 | 303 | #define dprintk(flg, fmt, ...) \ |
d61c5427 FT |
304 | do { if ((NDEBUG) & (flg)) \ |
305 | printk(KERN_DEBUG fmt, ## __VA_ARGS__); } while (0) | |
16b9d870 | 306 | |
9829e528 | 307 | #if NDEBUG |
9829e528 FT |
308 | #define NCR5380_dprint(flg, arg) \ |
309 | do { if ((NDEBUG) & (flg)) NCR5380_print(arg); } while (0) | |
310 | #define NCR5380_dprint_phase(flg, arg) \ | |
311 | do { if ((NDEBUG) & (flg)) NCR5380_print_phase(arg); } while (0) | |
312 | static void NCR5380_print_phase(struct Scsi_Host *instance); | |
313 | static void NCR5380_print(struct Scsi_Host *instance); | |
314 | #else | |
52a6a1cb FT |
315 | #define NCR5380_dprint(flg, arg) do {} while (0) |
316 | #define NCR5380_dprint_phase(flg, arg) do {} while (0) | |
9829e528 | 317 | #endif |
1da177e4 LT |
318 | |
319 | #if defined(AUTOPROBE_IRQ) | |
320 | static int NCR5380_probe_irq(struct Scsi_Host *instance, int possible); | |
321 | #endif | |
322 | static int NCR5380_init(struct Scsi_Host *instance, int flags); | |
323 | static void NCR5380_exit(struct Scsi_Host *instance); | |
324 | static void NCR5380_information_transfer(struct Scsi_Host *instance); | |
325 | #ifndef DONT_USE_INTR | |
7d12e780 | 326 | static irqreturn_t NCR5380_intr(int irq, void *dev_id); |
1da177e4 | 327 | #endif |
c4028958 | 328 | static void NCR5380_main(struct work_struct *work); |
8c32513b | 329 | static const char *NCR5380_info(struct Scsi_Host *instance); |
1da177e4 | 330 | static void NCR5380_reselect(struct Scsi_Host *instance); |
710ddd0d | 331 | static int NCR5380_select(struct Scsi_Host *instance, struct scsi_cmnd *cmd); |
1da177e4 LT |
332 | #if defined(PSEUDO_DMA) || defined(REAL_DMA) || defined(REAL_DMA_POLL) |
333 | static int NCR5380_transfer_dma(struct Scsi_Host *instance, unsigned char *phase, int *count, unsigned char **data); | |
334 | #endif | |
335 | static int NCR5380_transfer_pio(struct Scsi_Host *instance, unsigned char *phase, int *count, unsigned char **data); | |
336 | ||
337 | #if (defined(REAL_DMA) || defined(REAL_DMA_POLL)) | |
338 | ||
339 | #if defined(i386) || defined(__alpha__) | |
340 | ||
341 | /** | |
342 | * NCR5380_pc_dma_setup - setup ISA DMA | |
343 | * @instance: adapter to set up | |
344 | * @ptr: block to transfer (virtual address) | |
345 | * @count: number of bytes to transfer | |
346 | * @mode: DMA controller mode to use | |
347 | * | |
348 | * Program the DMA controller ready to perform an ISA DMA transfer | |
349 | * on this chip. | |
350 | * | |
351 | * Locks: takes and releases the ISA DMA lock. | |
352 | */ | |
353 | ||
354 | static __inline__ int NCR5380_pc_dma_setup(struct Scsi_Host *instance, unsigned char *ptr, unsigned int count, unsigned char mode) | |
355 | { | |
356 | unsigned limit; | |
357 | unsigned long bus_addr = virt_to_bus(ptr); | |
358 | unsigned long flags; | |
359 | ||
360 | if (instance->dma_channel <= 3) { | |
361 | if (count > 65536) | |
362 | count = 65536; | |
363 | limit = 65536 - (bus_addr & 0xFFFF); | |
364 | } else { | |
365 | if (count > 65536 * 2) | |
366 | count = 65536 * 2; | |
367 | limit = 65536 * 2 - (bus_addr & 0x1FFFF); | |
368 | } | |
369 | ||
370 | if (count > limit) | |
371 | count = limit; | |
372 | ||
373 | if ((count & 1) || (bus_addr & 1)) | |
374 | panic("scsi%d : attempted unaligned DMA transfer\n", instance->host_no); | |
375 | ||
376 | flags=claim_dma_lock(); | |
377 | disable_dma(instance->dma_channel); | |
378 | clear_dma_ff(instance->dma_channel); | |
379 | set_dma_addr(instance->dma_channel, bus_addr); | |
380 | set_dma_count(instance->dma_channel, count); | |
381 | set_dma_mode(instance->dma_channel, mode); | |
382 | enable_dma(instance->dma_channel); | |
383 | release_dma_lock(flags); | |
384 | ||
385 | return count; | |
386 | } | |
387 | ||
388 | /** | |
389 | * NCR5380_pc_dma_write_setup - setup ISA DMA write | |
390 | * @instance: adapter to set up | |
391 | * @ptr: block to transfer (virtual address) | |
392 | * @count: number of bytes to transfer | |
393 | * | |
394 | * Program the DMA controller ready to perform an ISA DMA write to the | |
395 | * SCSI controller. | |
396 | * | |
397 | * Locks: called routines take and release the ISA DMA lock. | |
398 | */ | |
399 | ||
400 | static __inline__ int NCR5380_pc_dma_write_setup(struct Scsi_Host *instance, unsigned char *src, unsigned int count) | |
401 | { | |
402 | return NCR5380_pc_dma_setup(instance, src, count, DMA_MODE_WRITE); | |
403 | } | |
404 | ||
405 | /** | |
406 | * NCR5380_pc_dma_read_setup - setup ISA DMA read | |
407 | * @instance: adapter to set up | |
408 | * @ptr: block to transfer (virtual address) | |
409 | * @count: number of bytes to transfer | |
410 | * | |
411 | * Program the DMA controller ready to perform an ISA DMA read from the | |
412 | * SCSI controller. | |
413 | * | |
414 | * Locks: called routines take and release the ISA DMA lock. | |
415 | */ | |
416 | ||
417 | static __inline__ int NCR5380_pc_dma_read_setup(struct Scsi_Host *instance, unsigned char *src, unsigned int count) | |
418 | { | |
419 | return NCR5380_pc_dma_setup(instance, src, count, DMA_MODE_READ); | |
420 | } | |
421 | ||
422 | /** | |
423 | * NCR5380_pc_dma_residual - return bytes left | |
424 | * @instance: adapter | |
425 | * | |
426 | * Reports the number of bytes left over after the DMA was terminated. | |
427 | * | |
428 | * Locks: takes and releases the ISA DMA lock. | |
429 | */ | |
430 | ||
431 | static __inline__ int NCR5380_pc_dma_residual(struct Scsi_Host *instance) | |
432 | { | |
433 | unsigned long flags; | |
434 | int tmp; | |
435 | ||
436 | flags = claim_dma_lock(); | |
437 | clear_dma_ff(instance->dma_channel); | |
438 | tmp = get_dma_residue(instance->dma_channel); | |
439 | release_dma_lock(flags); | |
440 | ||
441 | return tmp; | |
442 | } | |
443 | #endif /* defined(i386) || defined(__alpha__) */ | |
444 | #endif /* defined(REAL_DMA) */ | |
445 | #endif /* __KERNEL__ */ | |
446 | #endif /* ndef ASM */ | |
447 | #endif /* NCR5380_H */ |