scsi/NCR5380: remove old CVS keywords
[firefly-linux-kernel-4.4.55.git] / 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@sammy.net)
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 #ifndef SUN3_NCR5380_H
33 #define SUN3_NCR5380_H
34
35 #define SUN3SCSI_PUBLIC_RELEASE 1
36
37 /*
38  * Int: level 2 autovector
39  * IO: type 1, base 0x00140000, 5 bits phys space: A<4..0>
40  */
41 #define IRQ_SUN3_SCSI 2
42 #define IOBASE_SUN3_SCSI 0x00140000
43
44 #define IOBASE_SUN3_VMESCSI 0xff200000
45
46 static int sun3scsi_abort(struct scsi_cmnd *);
47 static int sun3scsi_detect (struct scsi_host_template *);
48 static const char *sun3scsi_info (struct Scsi_Host *);
49 static int sun3scsi_bus_reset(struct scsi_cmnd *);
50 static int sun3scsi_queue_command(struct Scsi_Host *, struct scsi_cmnd *);
51 static int sun3scsi_release (struct Scsi_Host *);
52
53 #ifndef CMD_PER_LUN
54 #define CMD_PER_LUN 2
55 #endif
56
57 #ifndef CAN_QUEUE
58 #define CAN_QUEUE 16
59 #endif
60
61 #ifndef SG_TABLESIZE
62 #define SG_TABLESIZE SG_NONE
63 #endif
64
65 #ifndef MAX_TAGS
66 #define MAX_TAGS 32
67 #endif
68
69 #ifndef USE_TAGGED_QUEUING
70 #define USE_TAGGED_QUEUING 1
71 #endif
72
73 #include <scsi/scsicam.h>
74
75 #ifdef SUN3_SCSI_VME
76 #define SUN3_SCSI_NAME "Sun3 NCR5380 VME SCSI"
77 #else
78 #define SUN3_SCSI_NAME "Sun3 NCR5380 SCSI"
79 #endif
80
81 #define NCR5380_implementation_fields \
82     int port, ctrl
83
84 #define NCR5380_local_declare() \
85         struct Scsi_Host *_instance
86
87 #define NCR5380_setup(instance) \
88         _instance = instance
89
90 #define NCR5380_read(reg) sun3scsi_read(reg)
91 #define NCR5380_write(reg, value) sun3scsi_write(reg, value)
92
93 #define NCR5380_intr sun3scsi_intr
94 #define NCR5380_queue_command sun3scsi_queue_command
95 #define NCR5380_bus_reset sun3scsi_bus_reset
96 #define NCR5380_abort sun3scsi_abort
97 #define NCR5380_show_info sun3scsi_show_info
98 #define NCR5380_dma_xfer_len(i, cmd, phase) \
99         sun3scsi_dma_xfer_len(cmd->SCp.this_residual,cmd,((phase) & SR_IO) ? 0 : 1)
100
101 #define NCR5380_dma_write_setup(instance, data, count) sun3scsi_dma_setup(data, count, 1)
102 #define NCR5380_dma_read_setup(instance, data, count) sun3scsi_dma_setup(data, count, 0)
103 #define NCR5380_dma_residual sun3scsi_dma_residual
104
105 /* additional registers - mainly DMA control regs */
106 /* these start at regbase + 8 -- directly after the NCR regs */
107 struct sun3_dma_regs {
108         unsigned short dma_addr_hi; /* vme only */
109         unsigned short dma_addr_lo; /* vme only */
110         unsigned short dma_count_hi; /* vme only */
111         unsigned short dma_count_lo; /* vme only */
112         unsigned short udc_data; /* udc dma data reg (obio only) */
113         unsigned short udc_addr; /* uda dma addr reg (obio only) */
114         unsigned short fifo_data; /* fifo data reg, holds extra byte on
115                                      odd dma reads */
116         unsigned short fifo_count; 
117         unsigned short csr; /* control/status reg */
118         unsigned short bpack_hi; /* vme only */
119         unsigned short bpack_lo; /* vme only */
120         unsigned short ivect; /* vme only */
121         unsigned short fifo_count_hi; /* vme only */
122 };
123
124 /* ucd chip specific regs - live in dvma space */
125 struct sun3_udc_regs {
126      unsigned short rsel; /* select regs to load */
127      unsigned short addr_hi; /* high word of addr */
128      unsigned short addr_lo; /* low word */
129      unsigned short count; /* words to be xfer'd */
130      unsigned short mode_hi; /* high word of channel mode */
131      unsigned short mode_lo; /* low word of channel mode */
132 };
133
134 /* addresses of the udc registers */
135 #define UDC_MODE 0x38 
136 #define UDC_CSR 0x2e /* command/status */
137 #define UDC_CHN_HI 0x26 /* chain high word */
138 #define UDC_CHN_LO 0x22 /* chain lo word */
139 #define UDC_CURA_HI 0x1a /* cur reg A high */
140 #define UDC_CURA_LO 0x0a /* cur reg A low */
141 #define UDC_CURB_HI 0x12 /* cur reg B high */
142 #define UDC_CURB_LO 0x02 /* cur reg B low */
143 #define UDC_MODE_HI 0x56 /* mode reg high */
144 #define UDC_MODE_LO 0x52 /* mode reg low */
145 #define UDC_COUNT 0x32 /* words to xfer */
146
147 /* some udc commands */
148 #define UDC_RESET 0
149 #define UDC_CHN_START 0xa0 /* start chain */
150 #define UDC_INT_ENABLE 0x32 /* channel 1 int on */
151
152 /* udc mode words */
153 #define UDC_MODE_HIWORD 0x40
154 #define UDC_MODE_LSEND 0xc2
155 #define UDC_MODE_LRECV 0xd2
156
157 /* udc reg selections */
158 #define UDC_RSEL_SEND 0x282
159 #define UDC_RSEL_RECV 0x182
160
161 /* bits in csr reg */
162 #define CSR_DMA_ACTIVE 0x8000
163 #define CSR_DMA_CONFLICT 0x4000
164 #define CSR_DMA_BUSERR 0x2000
165
166 #define CSR_FIFO_EMPTY 0x400 /* fifo flushed? */
167 #define CSR_SDB_INT 0x200 /* sbc interrupt pending */
168 #define CSR_DMA_INT 0x100 /* dma interrupt pending */
169
170 #define CSR_LEFT 0xc0
171 #define CSR_LEFT_3 0xc0
172 #define CSR_LEFT_2 0x80
173 #define CSR_LEFT_1 0x40
174 #define CSR_PACK_ENABLE 0x20
175
176 #define CSR_DMA_ENABLE 0x10
177
178 #define CSR_SEND 0x8 /* 1 = send  0 = recv */
179 #define CSR_FIFO 0x2 /* reset fifo */
180 #define CSR_INTR 0x4 /* interrupt enable */
181 #define CSR_SCSI 0x1 
182
183 #define VME_DATA24 0x3d00
184
185 // debugging printk's, taken from atari_scsi.h 
186 /* Debugging printk definitions:
187  *
188  *  ARB  -> arbitration
189  *  ASEN -> auto-sense
190  *  DMA  -> DMA
191  *  HSH  -> PIO handshake
192  *  INF  -> information transfer
193  *  INI  -> initialization
194  *  INT  -> interrupt
195  *  LNK  -> linked commands
196  *  MAIN -> NCR5380_main() control flow
197  *  NDAT -> no data-out phase
198  *  NWR  -> no write commands
199  *  PIO  -> PIO transfers
200  *  PDMA -> pseudo DMA (unused on Atari)
201  *  QU   -> queues
202  *  RSL  -> reselections
203  *  SEL  -> selections
204  *  USL  -> usleep cpde (unused on Atari)
205  *  LBS  -> last byte sent (unused on Atari)
206  *  RSS  -> restarting of selections
207  *  EXT  -> extended messages
208  *  ABRT -> aborting and resetting
209  *  TAG  -> queue tag handling
210  *  MER  -> merging of consec. buffers
211  *
212  */
213
214 #include "NCR5380.h"
215
216 #if NDEBUG & NDEBUG_ARBITRATION
217 #define ARB_PRINTK(format, args...) \
218         printk(KERN_DEBUG format , ## args)
219 #else
220 #define ARB_PRINTK(format, args...)
221 #endif
222 #if NDEBUG & NDEBUG_AUTOSENSE
223 #define ASEN_PRINTK(format, args...) \
224         printk(KERN_DEBUG format , ## args)
225 #else
226 #define ASEN_PRINTK(format, args...)
227 #endif
228 #if NDEBUG & NDEBUG_DMA
229 #define DMA_PRINTK(format, args...) \
230         printk(KERN_DEBUG format , ## args)
231 #else
232 #define DMA_PRINTK(format, args...)
233 #endif
234 #if NDEBUG & NDEBUG_HANDSHAKE
235 #define HSH_PRINTK(format, args...) \
236         printk(KERN_DEBUG format , ## args)
237 #else
238 #define HSH_PRINTK(format, args...)
239 #endif
240 #if NDEBUG & NDEBUG_INFORMATION
241 #define INF_PRINTK(format, args...) \
242         printk(KERN_DEBUG format , ## args)
243 #else
244 #define INF_PRINTK(format, args...)
245 #endif
246 #if NDEBUG & NDEBUG_INIT
247 #define INI_PRINTK(format, args...) \
248         printk(KERN_DEBUG format , ## args)
249 #else
250 #define INI_PRINTK(format, args...)
251 #endif
252 #if NDEBUG & NDEBUG_INTR
253 #define INT_PRINTK(format, args...) \
254         printk(KERN_DEBUG format , ## args)
255 #else
256 #define INT_PRINTK(format, args...)
257 #endif
258 #if NDEBUG & NDEBUG_LINKED
259 #define LNK_PRINTK(format, args...) \
260         printk(KERN_DEBUG format , ## args)
261 #else
262 #define LNK_PRINTK(format, args...)
263 #endif
264 #if NDEBUG & NDEBUG_MAIN
265 #define MAIN_PRINTK(format, args...) \
266         printk(KERN_DEBUG format , ## args)
267 #else
268 #define MAIN_PRINTK(format, args...)
269 #endif
270 #if NDEBUG & NDEBUG_NO_DATAOUT
271 #define NDAT_PRINTK(format, args...) \
272         printk(KERN_DEBUG format , ## args)
273 #else
274 #define NDAT_PRINTK(format, args...)
275 #endif
276 #if NDEBUG & NDEBUG_NO_WRITE
277 #define NWR_PRINTK(format, args...) \
278         printk(KERN_DEBUG format , ## args)
279 #else
280 #define NWR_PRINTK(format, args...)
281 #endif
282 #if NDEBUG & NDEBUG_PIO
283 #define PIO_PRINTK(format, args...) \
284         printk(KERN_DEBUG format , ## args)
285 #else
286 #define PIO_PRINTK(format, args...)
287 #endif
288 #if NDEBUG & NDEBUG_PSEUDO_DMA
289 #define PDMA_PRINTK(format, args...) \
290         printk(KERN_DEBUG format , ## args)
291 #else
292 #define PDMA_PRINTK(format, args...)
293 #endif
294 #if NDEBUG & NDEBUG_QUEUES
295 #define QU_PRINTK(format, args...) \
296         printk(KERN_DEBUG format , ## args)
297 #else
298 #define QU_PRINTK(format, args...)
299 #endif
300 #if NDEBUG & NDEBUG_RESELECTION
301 #define RSL_PRINTK(format, args...) \
302         printk(KERN_DEBUG format , ## args)
303 #else
304 #define RSL_PRINTK(format, args...)
305 #endif
306 #if NDEBUG & NDEBUG_SELECTION
307 #define SEL_PRINTK(format, args...) \
308         printk(KERN_DEBUG format , ## args)
309 #else
310 #define SEL_PRINTK(format, args...)
311 #endif
312 #if NDEBUG & NDEBUG_USLEEP
313 #define USL_PRINTK(format, args...) \
314         printk(KERN_DEBUG format , ## args)
315 #else
316 #define USL_PRINTK(format, args...)
317 #endif
318 #if NDEBUG & NDEBUG_LAST_BYTE_SENT
319 #define LBS_PRINTK(format, args...) \
320         printk(KERN_DEBUG format , ## args)
321 #else
322 #define LBS_PRINTK(format, args...)
323 #endif
324 #if NDEBUG & NDEBUG_RESTART_SELECT
325 #define RSS_PRINTK(format, args...) \
326         printk(KERN_DEBUG format , ## args)
327 #else
328 #define RSS_PRINTK(format, args...)
329 #endif
330 #if NDEBUG & NDEBUG_EXTENDED
331 #define EXT_PRINTK(format, args...) \
332         printk(KERN_DEBUG format , ## args)
333 #else
334 #define EXT_PRINTK(format, args...)
335 #endif
336 #if NDEBUG & NDEBUG_ABORT
337 #define ABRT_PRINTK(format, args...) \
338         printk(KERN_DEBUG format , ## args)
339 #else
340 #define ABRT_PRINTK(format, args...)
341 #endif
342 #if NDEBUG & NDEBUG_TAGS
343 #define TAG_PRINTK(format, args...) \
344         printk(KERN_DEBUG format , ## args)
345 #else
346 #define TAG_PRINTK(format, args...)
347 #endif
348 #if NDEBUG & NDEBUG_MERGING
349 #define MER_PRINTK(format, args...) \
350         printk(KERN_DEBUG format , ## args)
351 #else
352 #define MER_PRINTK(format, args...)
353 #endif
354
355 /* conditional macros for NCR5380_print_{,phase,status} */
356
357 #define NCR_PRINT(mask) \
358         ((NDEBUG & (mask)) ? NCR5380_print(instance) : (void)0)
359
360 #define NCR_PRINT_PHASE(mask) \
361         ((NDEBUG & (mask)) ? NCR5380_print_phase(instance) : (void)0)
362
363 #define NCR_PRINT_STATUS(mask) \
364         ((NDEBUG & (mask)) ? NCR5380_print_status(instance) : (void)0)
365
366
367
368 #endif /* SUN3_NCR5380_H */
369