?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Revert last change. Bug noticed by Linus.
[linux-2.6/linux-mips.git] / drivers / acorn / scsi / fas216.h
blob4381888fd29d42c1fc6fb774efda40661ffc055a
1 /*
2 * FAS216 generic driver
3 *
4 * Copyright (C) 1997-2000 Russell King
5 */
6 #ifndef FAS216_H
7 #define FAS216_H
8
9 #ifndef NO_IRQ
10 #define NO_IRQ 255
11 #endif
12
13 #include "queue.h"
14 #include "msgqueue.h"
15
16 /* FAS register definitions */
17
18 /* transfer count low */
19 #define REG_CTCL(x) ((x)->scsi.io_port)
20 #define REG_STCL(x) ((x)->scsi.io_port)
21
22 /* transfer count medium */
23 #define REG_CTCM(x) ((x)->scsi.io_port + (1 << (x)->scsi.io_shift))
24 #define REG_STCM(x) ((x)->scsi.io_port + (1 << (x)->scsi.io_shift))
25
26 /* fifo data */
27 #define REG_FF(x) ((x)->scsi.io_port + (2 << (x)->scsi.io_shift))
28
29 /* command */
30 #define REG_CMD(x) ((x)->scsi.io_port + (3 << (x)->scsi.io_shift))
31 #define CMD_NOP 0x00
32 #define CMD_FLUSHFIFO 0x01
33 #define CMD_RESETCHIP 0x02
34 #define CMD_RESETSCSI 0x03
35
36 #define CMD_TRANSFERINFO 0x10
37 #define CMD_INITCMDCOMPLETE 0x11
38 #define CMD_MSGACCEPTED 0x12
39 #define CMD_PADBYTES 0x18
40 #define CMD_SETATN 0x1a
41 #define CMD_RSETATN 0x1b
42
43 #define CMD_SELECTWOATN 0x41
44 #define CMD_SELECTATN 0x42
45 #define CMD_SELECTATNSTOP 0x43
46 #define CMD_ENABLESEL 0x44
47 #define CMD_DISABLESEL 0x45
48 #define CMD_SELECTATN3 0x46
49 #define CMD_RESEL3 0x47
50
51 #define CMD_WITHDMA 0x80
52
53 /* status register (read) */
54 #define REG_STAT(x) ((x)->scsi.io_port + (4 << (x)->scsi.io_shift))
55 #define STAT_IO (1 << 0) /* IO phase */
56 #define STAT_CD (1 << 1) /* CD phase */
57 #define STAT_MSG (1 << 2) /* MSG phase */
58 #define STAT_TRANSFERDONE (1 << 3) /* Transfer completed */
59 #define STAT_TRANSFERCNTZ (1 << 4) /* Transfer counter is zero */
60 #define STAT_PARITYERROR (1 << 5) /* Parity error */
61 #define STAT_REALBAD (1 << 6) /* Something bad */
62 #define STAT_INT (1 << 7) /* Interrupt */
63
64 #define STAT_BUSMASK (STAT_MSG|STAT_CD|STAT_IO)
65 #define STAT_DATAOUT (0) /* Data out */
66 #define STAT_DATAIN (STAT_IO) /* Data in */
67 #define STAT_COMMAND (STAT_CD) /* Command out */
68 #define STAT_STATUS (STAT_CD|STAT_IO) /* Status In */
69 #define STAT_MESGOUT (STAT_MSG|STAT_CD) /* Message out */
70 #define STAT_MESGIN (STAT_MSG|STAT_CD|STAT_IO) /* Message In */
71
72 /* bus ID for select / reselect */
73 #define REG_SDID(x) ((x)->scsi.io_port + (4 << (x)->scsi.io_shift))
74 #define BUSID(target) ((target) & 7)
75
76 /* Interrupt status register (read) */
77 #define REG_INST(x) ((x)->scsi.io_port + (5 << (x)->scsi.io_shift))
78 #define INST_SELWOATN (1 << 0) /* Select w/o ATN */
79 #define INST_SELATN (1 << 1) /* Select w/ATN */
80 #define INST_RESELECTED (1 << 2) /* Reselected */
81 #define INST_FUNCDONE (1 << 3) /* Function done */
82 #define INST_BUSSERVICE (1 << 4) /* Bus service */
83 #define INST_DISCONNECT (1 << 5) /* Disconnect */
84 #define INST_ILLEGALCMD (1 << 6) /* Illegal command */
85 #define INST_BUSRESET (1 << 7) /* SCSI Bus reset */
86
87 /* Timeout register (write) */
88 #define REG_STIM(x) ((x)->scsi.io_port + (5 << (x)->scsi.io_shift))
89
90 /* Sequence step register (read) */
91 #define REG_IS(x) ((x)->scsi.io_port + (6 << (x)->scsi.io_shift))
92 #define IS_BITS 0x07
93 #define IS_SELARB 0x00 /* Select & Arb ok */
94 #define IS_MSGBYTESENT 0x01 /* One byte message sent*/
95 #define IS_NOTCOMMAND 0x02 /* Not in command state */
96 #define IS_EARLYPHASE 0x03 /* Early phase change */
97 #define IS_COMPLETE 0x04 /* Command ok */
98 #define IS_SOF 0x08 /* Sync off flag */
99
100 /* Transfer period step (write) */
101 #define REG_STP(x) ((x)->scsi.io_port + (6 << (x)->scsi.io_shift))
102
103 /* Synchronous Offset (write) */
104 #define REG_SOF(x) ((x)->scsi.io_port + (7 << (x)->scsi.io_shift))
105
106 /* Fifo state register (read) */
107 #define REG_CFIS(x) ((x)->scsi.io_port + (7 << (x)->scsi.io_shift))
108 #define CFIS_CF 0x1f /* Num bytes in FIFO */
109 #define CFIS_IS 0xe0 /* Step */
110
111 /* config register 1 */
112 #define REG_CNTL1(x) ((x)->scsi.io_port + (8 << (x)->scsi.io_shift))
113 #define CNTL1_CID (7 << 0) /* Chip ID */
114 #define CNTL1_STE (1 << 3) /* Self test enable */
115 #define CNTL1_PERE (1 << 4) /* Parity enable reporting en. */
116 #define CNTL1_PTE (1 << 5) /* Parity test enable */
117 #define CNTL1_DISR (1 << 6) /* Disable Irq on SCSI reset */
118 #define CNTL1_ETM (1 << 7) /* Extended Timing Mode */
119
120 /* Clock conversion factor (read) */
121 #define REG_CLKF(x) ((x)->scsi.io_port + (9 << (x)->scsi.io_shift))
122 #define CLKF_F37MHZ 0x00 /* 35.01 - 40 MHz */
123 #define CLKF_F10MHZ 0x02 /* 10 MHz */
124 #define CLKF_F12MHZ 0x03 /* 10.01 - 15 MHz */
125 #define CLKF_F17MHZ 0x04 /* 15.01 - 20 MHz */
126 #define CLKF_F22MHZ 0x05 /* 20.01 - 25 MHz */
127 #define CLKF_F27MHZ 0x06 /* 25.01 - 30 MHz */
128 #define CLKF_F32MHZ 0x07 /* 30.01 - 35 MHz */
129
130 /* Chip test register (write) */
131 #define REG0_FTM(x) ((x)->scsi.io_port + (10 << (x)->scsi.io_shift))
132 #define TEST_FTM 0x01 /* Force target mode */
133 #define TEST_FIM 0x02 /* Force initiator mode */
134 #define TEST_FHI 0x04 /* Force high impedance mode */
135
136 /* Configuration register 2 (read/write) */
137 #define REG_CNTL2(x) ((x)->scsi.io_port + (11 << (x)->scsi.io_shift))
138 #define CNTL2_PGDP (1 << 0) /* Pass Th/Generate Data Parity */
139 #define CNTL2_PGRP (1 << 1) /* Pass Th/Generate Reg Parity */
140 #define CNTL2_ACDPE (1 << 2) /* Abort on Cmd/Data Parity Err */
141 #define CNTL2_S2FE (1 << 3) /* SCSI2 Features Enable */
142 #define CNTL2_TSDR (1 << 4) /* Tristate DREQ */
143 #define CNTL2_SBO (1 << 5) /* Select Byte Order */
144 #define CNTL2_ENF (1 << 6) /* Enable features */
145 #define CNTL2_DAE (1 << 7) /* Data Alignment Enable */
146
147 /* Configuration register 3 (read/write) */
148 #define REG_CNTL3(x) ((x)->scsi.io_port + (12 << (x)->scsi.io_shift))
149 #define CNTL3_BS8 (1 << 0) /* Burst size 8 */
150 #define CNTL3_MDM (1 << 1) /* Modify DMA mode */
151 #define CNTL3_LBTM (1 << 2) /* Last Byte Transfer mode */
152 #define CNTL3_FASTCLK (1 << 3) /* Fast SCSI clocking */
153 #define CNTL3_FASTSCSI (1 << 4) /* Fast SCSI */
154 #define CNTL3_G2CB (1 << 5) /* Group2 SCSI support */
155 #define CNTL3_QTAG (1 << 6) /* Enable 3 byte msgs */
156 #define CNTL3_ADIDCHK (1 << 7) /* Additional ID check */
157
158 /* High transfer count (read/write) */
159 #define REG_CTCH(x) ((x)->scsi.io_port + (14 << (x)->scsi.io_shift))
160 #define REG_STCH(x) ((x)->scsi.io_port + (14 << (x)->scsi.io_shift))
161
162 /* ID reigster (read only) */
163 #define REG1_ID(x) ((x)->scsi.io_port + (14 << (x)->scsi.io_shift))
164
165 /* Data alignment */
166 #define REG0_DAL(x) ((x)->scsi.io_port + (15 << (x)->scsi.io_shift))
167
168 typedef enum {
169 PHASE_IDLE, /* we're not planning on doing anything */
170 PHASE_SELECTION, /* selecting a device */
171 PHASE_SELSTEPS, /* selection with command steps */
172 PHASE_COMMAND, /* command sent */
173 PHASE_MESSAGESENT, /* selected, and we're sending cmd */
174 PHASE_RECONNECTED, /* reconnected */
175 PHASE_DATAOUT, /* data out to device */
176 PHASE_DATAIN, /* data in from device */
177 PHASE_MSGIN, /* message in from device */
178 PHASE_MSGIN_DISCONNECT, /* disconnecting from bus */
179 PHASE_MSGOUT, /* after message out phase */
180 PHASE_MSGOUT_EXPECT, /* expecting message out */
181 PHASE_STATUS, /* status from device */
182 PHASE_DONE /* Command complete */
183 } phase_t;
184
185 typedef enum {
186 DMA_OUT, /* DMA from memory to chip */
187 DMA_IN /* DMA from chip to memory */
188 } fasdmadir_t;
189
190 typedef enum {
191 fasdma_none, /* No dma */
192 fasdma_pio, /* PIO mode */
193 fasdma_pseudo, /* Pseudo DMA */
194 fasdma_real_block, /* Real DMA, on block by block basis */
195 fasdma_real_all /* Real DMA, on request by request */
196 } fasdmatype_t;
197
198 typedef enum {
199 neg_wait, /* Negociate with device */
200 neg_inprogress, /* Negociation sent */
201 neg_complete, /* Negociation complete */
202 neg_targcomplete, /* Target completed negociation */
203 neg_invalid /* Negociation not supported */
204 } neg_t;
205
206 #define MAGIC 0x441296bdUL
207 #define NR_MSGS 8
208
209 typedef struct {
210 unsigned long magic_start;
211 struct Scsi_Host *host; /* host */
212 Scsi_Cmnd *SCpnt; /* currently processing command */
213 Scsi_Cmnd *origSCpnt; /* original connecting command */
214 Scsi_Cmnd *reqSCpnt; /* request sense command */
215
216 /* driver information */
217 struct {
218 unsigned int io_port; /* base address of FAS216 */
219 unsigned int io_shift; /* shift to adjust reg offsets by */
220 unsigned int irq; /* interrupt */
221 unsigned char cfg[4]; /* configuration registers */
222 const char *type; /* chip type */
223 phase_t phase; /* current phase */
224
225 struct {
226 unsigned char target; /* reconnected target */
227 unsigned char lun; /* reconnected lun */
228 unsigned char tag; /* reconnected tag */
229 } reconnected;
230
231 Scsi_Pointer SCp; /* current commands data pointer */
232
233 MsgQueue_t msgs; /* message queue for connected device */
234
235 unsigned int async_stp; /* Async transfer STP value */
236 unsigned char msgin_fifo; /* bytes in fifo at time of message in */
237 unsigned char message[256]; /* last message received from device */
238 unsigned int msglen; /* length of last message received */
239
240 unsigned char disconnectable:1; /* this command can be disconnected */
241 unsigned char aborting:1; /* aborting command */
242 } scsi;
243
244 /* statistics information */
245 struct {
246 unsigned int queues;
247 unsigned int removes;
248 unsigned int fins;
249 unsigned int reads;
250 unsigned int writes;
251 unsigned int miscs;
252 unsigned int disconnects;
253 unsigned int aborts;
254 unsigned int bus_resets;
255 unsigned int host_resets;
256 } stats;
257
258 /* configuration information */
259 struct {
260 unsigned char clockrate; /* clock rate of FAS device (MHz) */
261 unsigned char select_timeout; /* timeout (R5) */
262 unsigned char sync_max_depth; /* Synchronous xfer max fifo depth */
263 unsigned char wide_max_size; /* Maximum wide transfer size */
264 unsigned char cntl3; /* Control Reg 3 */
265 unsigned int asyncperiod; /* Async transfer period (ns) */
266 unsigned int disconnect_ok:1; /* Disconnects allowed? */
267 } ifcfg;
268
269 /* queue handling */
270 struct {
271 Queue_t issue; /* issue queue */
272 Queue_t disconnected; /* disconnected command queue */
273 } queues;
274
275 /* per-device info */
276 struct fas216_device {
277 unsigned char disconnect_ok:1; /* device can disconnect */
278 unsigned char period; /* sync xfer period in (*4ns) */
279 unsigned char stp; /* synchronous transfer period */
280 unsigned char sof; /* synchronous offset register */
281 unsigned char wide_xfer; /* currently negociated wide transfer */
282 neg_t sync_state; /* synchronous transfer mode */
283 neg_t wide_state; /* wide transfer mode */
284 } device[8];
285 unsigned char busyluns[8]; /* array of bits indicating LUNs busy */
286
287 /* dma */
288 struct {
289 fasdmatype_t transfer_type; /* current type of DMA transfer */
290 fasdmatype_t (*setup) (struct Scsi_Host *host, Scsi_Pointer *SCp, fasdmadir_t direction, fasdmatype_t min_dma);
291 void (*pseudo)(struct Scsi_Host *host, Scsi_Pointer *SCp, fasdmadir_t direction, int transfer);
292 void (*stop) (struct Scsi_Host *host, Scsi_Pointer *SCp);
293 } dma;
294
295 /* miscellaneous */
296 int internal_done; /* flag to indicate request done */
297
298 unsigned long magic_end;
299 } FAS216_Info;
300
301 /* Function: int fas216_init (struct Scsi_Host *instance)
302 * Purpose : initialise FAS/NCR/AMD SCSI ic.
303 * Params : instance - a driver-specific filled-out structure
304 * Returns : 0 on success
305 */
306 extern int fas216_init (struct Scsi_Host *instance);
307
308 /* Function: int fas216_abort (Scsi_Cmnd *SCpnt)
309 * Purpose : abort a command if something horrible happens.
310 * Params : SCpnt - Command that is believed to be causing a problem.
311 * Returns : one of SCSI_ABORT_ macros.
312 */
313 extern int fas216_abort (Scsi_Cmnd *);
314
315 /* Function: int fas216_reset (Scsi_Cmnd *SCpnt, unsigned int reset_flags)
316 * Purpose : resets the adapter if something horrible happens.
317 * Params : SCpnt - Command that is believed to be causing a problem.
318 * reset_flags - flags indicating reset type that is believed to be required.
319 * Returns : one of SCSI_RESET_ macros, or'd with the SCSI_RESET_*_RESET macros.
320 */
321 extern int fas216_reset (Scsi_Cmnd *, unsigned int);
322
323 /* Function: int fas216_queue_command (Scsi_Cmnd *SCpnt, void (*done)(Scsi_Cmnd *))
324 * Purpose : queue a command for adapter to process.
325 * Params : SCpnt - Command to queue
326 * done - done function to call once command is complete
327 * Returns : 0 - success, else error
328 */
329 extern int fas216_queue_command (Scsi_Cmnd *, void (*done)(Scsi_Cmnd *));
330
331 /* Function: int fas216_command (Scsi_Cmnd *SCpnt)
332 * Purpose : queue a command for adapter to process.
333 * Params : SCpnt - Command to queue
334 * Returns : scsi result code
335 */
336 extern int fas216_command (Scsi_Cmnd *);
337
338 /* Function: void fas216_intr (struct Scsi_Host *instance)
339 * Purpose : handle interrupts from the interface to progress a command
340 * Params : instance - interface to service
341 */
342 extern void fas216_intr (struct Scsi_Host *instance);
343
344 /* Function: int fas216_release (struct Scsi_Host *instance)
345 * Purpose : release all resources and put everything to bed for FAS/NCR/AMD SCSI ic.
346 * Params : instance - a driver-specific filled-out structure
347 * Returns : 0 on success
348 */
349 extern int fas216_release (struct Scsi_Host *instance);
350
351 extern int fas216_info(FAS216_Info *info, char *buffer);
352 extern int fas216_print_host(FAS216_Info *info, char *buffer);
353 extern int fas216_print_stats(FAS216_Info *info, char *buffer);
354 extern int fas216_print_device(FAS216_Info *info, Scsi_Device *scd, char *buffer);
355
356 /* Function: int fas216_eh_abort(Scsi_Cmnd *SCpnt)
357 * Purpose : abort this command
358 * Params : SCpnt - command to abort
359 * Returns : FAILED if unable to abort
360 */
361 extern int fas216_eh_abort(Scsi_Cmnd *SCpnt);
362
363 /* Function: int fas216_eh_device_reset(Scsi_Cmnd *SCpnt)
364 * Purpose : Reset the device associated with this command
365 * Params : SCpnt - command specifing device to reset
366 * Returns : FAILED if unable to reset
367 */
368 extern int fas216_eh_device_reset(Scsi_Cmnd *SCpnt);
369
370 /* Function: int fas216_eh_bus_reset(Scsi_Cmnd *SCpnt)
371 * Purpose : Reset the complete bus associated with this command
372 * Params : SCpnt - command specifing bus to reset
373 * Returns : FAILED if unable to reset
374 */
375 extern int fas216_eh_bus_reset(Scsi_Cmnd *SCpnt);
376
377 /* Function: int fas216_eh_host_reset(Scsi_Cmnd *SCpnt)
378 * Purpose : Reset the host associated with this command
379 * Params : SCpnt - command specifing host to reset
380 * Returns : FAILED if unable to reset
381 */
382 extern int fas216_eh_host_reset(Scsi_Cmnd *SCpnt);
383
384 #endif /* FAS216_H */
Mirror of the linux-mips.org kernel tree