Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * wd33c93.h - Linux device driver definitions for the | |
3 | * Commodore Amiga A2091/590 SCSI controller card | |
4 | * | |
5 | * IMPORTANT: This file is for version 1.25 - 09/Jul/1997 | |
6 | * | |
7 | * Copyright (c) 1996 John Shifflett, GeoLog Consulting | |
8 | * john@geolog.com | |
9 | * jshiffle@netcom.com | |
10 | * | |
11 | * This program is free software; you can redistribute it and/or modify | |
12 | * it under the terms of the GNU General Public License as published by | |
13 | * the Free Software Foundation; either version 2, or (at your option) | |
14 | * any later version. | |
15 | * | |
16 | * This program is distributed in the hope that it will be useful, | |
17 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | * GNU General Public License for more details. | |
20 | * | |
21 | */ | |
22 | #ifndef WD33C93_H | |
23 | #define WD33C93_H | |
24 | ||
25 | #include <linux/config.h> | |
26 | ||
27 | #define PROC_INTERFACE /* add code for /proc/scsi/wd33c93/xxx interface */ | |
28 | #ifdef PROC_INTERFACE | |
29 | #define PROC_STATISTICS /* add code for keeping various real time stats */ | |
30 | #endif | |
31 | ||
32 | #define SYNC_DEBUG /* extra info on sync negotiation printed */ | |
33 | #define DEBUGGING_ON /* enable command-line debugging bitmask */ | |
34 | #define DEBUG_DEFAULTS 0 /* default debugging bitmask */ | |
35 | ||
36 | ||
37 | #ifdef DEBUGGING_ON | |
38 | #define DB(f,a) if (hostdata->args & (f)) a; | |
39 | #else | |
40 | #define DB(f,a) | |
41 | #endif | |
42 | ||
43 | #define uchar unsigned char | |
44 | ||
45 | ||
46 | /* wd register names */ | |
47 | #define WD_OWN_ID 0x00 | |
48 | #define WD_CONTROL 0x01 | |
49 | #define WD_TIMEOUT_PERIOD 0x02 | |
50 | #define WD_CDB_1 0x03 | |
51 | #define WD_CDB_2 0x04 | |
52 | #define WD_CDB_3 0x05 | |
53 | #define WD_CDB_4 0x06 | |
54 | #define WD_CDB_5 0x07 | |
55 | #define WD_CDB_6 0x08 | |
56 | #define WD_CDB_7 0x09 | |
57 | #define WD_CDB_8 0x0a | |
58 | #define WD_CDB_9 0x0b | |
59 | #define WD_CDB_10 0x0c | |
60 | #define WD_CDB_11 0x0d | |
61 | #define WD_CDB_12 0x0e | |
62 | #define WD_TARGET_LUN 0x0f | |
63 | #define WD_COMMAND_PHASE 0x10 | |
64 | #define WD_SYNCHRONOUS_TRANSFER 0x11 | |
65 | #define WD_TRANSFER_COUNT_MSB 0x12 | |
66 | #define WD_TRANSFER_COUNT 0x13 | |
67 | #define WD_TRANSFER_COUNT_LSB 0x14 | |
68 | #define WD_DESTINATION_ID 0x15 | |
69 | #define WD_SOURCE_ID 0x16 | |
70 | #define WD_SCSI_STATUS 0x17 | |
71 | #define WD_COMMAND 0x18 | |
72 | #define WD_DATA 0x19 | |
73 | #define WD_QUEUE_TAG 0x1a | |
74 | #define WD_AUXILIARY_STATUS 0x1f | |
75 | ||
76 | /* WD commands */ | |
77 | #define WD_CMD_RESET 0x00 | |
78 | #define WD_CMD_ABORT 0x01 | |
79 | #define WD_CMD_ASSERT_ATN 0x02 | |
80 | #define WD_CMD_NEGATE_ACK 0x03 | |
81 | #define WD_CMD_DISCONNECT 0x04 | |
82 | #define WD_CMD_RESELECT 0x05 | |
83 | #define WD_CMD_SEL_ATN 0x06 | |
84 | #define WD_CMD_SEL 0x07 | |
85 | #define WD_CMD_SEL_ATN_XFER 0x08 | |
86 | #define WD_CMD_SEL_XFER 0x09 | |
87 | #define WD_CMD_RESEL_RECEIVE 0x0a | |
88 | #define WD_CMD_RESEL_SEND 0x0b | |
89 | #define WD_CMD_WAIT_SEL_RECEIVE 0x0c | |
90 | #define WD_CMD_TRANS_ADDR 0x18 | |
91 | #define WD_CMD_TRANS_INFO 0x20 | |
92 | #define WD_CMD_TRANSFER_PAD 0x21 | |
93 | #define WD_CMD_SBT_MODE 0x80 | |
94 | ||
95 | /* ASR register */ | |
96 | #define ASR_INT (0x80) | |
97 | #define ASR_LCI (0x40) | |
98 | #define ASR_BSY (0x20) | |
99 | #define ASR_CIP (0x10) | |
100 | #define ASR_PE (0x02) | |
101 | #define ASR_DBR (0x01) | |
102 | ||
103 | /* SCSI Bus Phases */ | |
104 | #define PHS_DATA_OUT 0x00 | |
105 | #define PHS_DATA_IN 0x01 | |
106 | #define PHS_COMMAND 0x02 | |
107 | #define PHS_STATUS 0x03 | |
108 | #define PHS_MESS_OUT 0x06 | |
109 | #define PHS_MESS_IN 0x07 | |
110 | ||
111 | /* Command Status Register definitions */ | |
112 | ||
113 | /* reset state interrupts */ | |
114 | #define CSR_RESET 0x00 | |
115 | #define CSR_RESET_AF 0x01 | |
116 | ||
117 | /* successful completion interrupts */ | |
118 | #define CSR_RESELECT 0x10 | |
119 | #define CSR_SELECT 0x11 | |
120 | #define CSR_SEL_XFER_DONE 0x16 | |
121 | #define CSR_XFER_DONE 0x18 | |
122 | ||
123 | /* paused or aborted interrupts */ | |
124 | #define CSR_MSGIN 0x20 | |
125 | #define CSR_SDP 0x21 | |
126 | #define CSR_SEL_ABORT 0x22 | |
127 | #define CSR_RESEL_ABORT 0x25 | |
128 | #define CSR_RESEL_ABORT_AM 0x27 | |
129 | #define CSR_ABORT 0x28 | |
130 | ||
131 | /* terminated interrupts */ | |
132 | #define CSR_INVALID 0x40 | |
133 | #define CSR_UNEXP_DISC 0x41 | |
134 | #define CSR_TIMEOUT 0x42 | |
135 | #define CSR_PARITY 0x43 | |
136 | #define CSR_PARITY_ATN 0x44 | |
137 | #define CSR_BAD_STATUS 0x45 | |
138 | #define CSR_UNEXP 0x48 | |
139 | ||
140 | /* service required interrupts */ | |
141 | #define CSR_RESEL 0x80 | |
142 | #define CSR_RESEL_AM 0x81 | |
143 | #define CSR_DISC 0x85 | |
144 | #define CSR_SRV_REQ 0x88 | |
145 | ||
146 | /* Own ID/CDB Size register */ | |
147 | #define OWNID_EAF 0x08 | |
148 | #define OWNID_EHP 0x10 | |
149 | #define OWNID_RAF 0x20 | |
150 | #define OWNID_FS_8 0x00 | |
151 | #define OWNID_FS_12 0x40 | |
152 | #define OWNID_FS_16 0x80 | |
153 | ||
154 | /* define these so we don't have to change a2091.c, etc. */ | |
155 | #define WD33C93_FS_8_10 OWNID_FS_8 | |
156 | #define WD33C93_FS_12_15 OWNID_FS_12 | |
157 | #define WD33C93_FS_16_20 OWNID_FS_16 | |
158 | ||
159 | /* Control register */ | |
160 | #define CTRL_HSP 0x01 | |
161 | #define CTRL_HA 0x02 | |
162 | #define CTRL_IDI 0x04 | |
163 | #define CTRL_EDI 0x08 | |
164 | #define CTRL_HHP 0x10 | |
165 | #define CTRL_POLLED 0x00 | |
166 | #define CTRL_BURST 0x20 | |
167 | #define CTRL_BUS 0x40 | |
168 | #define CTRL_DMA 0x80 | |
169 | ||
170 | /* Timeout Period register */ | |
171 | #define TIMEOUT_PERIOD_VALUE 20 /* 20 = 200 ms */ | |
172 | ||
173 | /* Synchronous Transfer Register */ | |
174 | #define STR_FSS 0x80 | |
175 | ||
176 | /* Destination ID register */ | |
177 | #define DSTID_DPD 0x40 | |
178 | #define DATA_OUT_DIR 0 | |
179 | #define DATA_IN_DIR 1 | |
180 | #define DSTID_SCC 0x80 | |
181 | ||
182 | /* Source ID register */ | |
183 | #define SRCID_MASK 0x07 | |
184 | #define SRCID_SIV 0x08 | |
185 | #define SRCID_DSP 0x20 | |
186 | #define SRCID_ES 0x40 | |
187 | #define SRCID_ER 0x80 | |
188 | ||
189 | /* This is what the 3393 chip looks like to us */ | |
190 | typedef struct { | |
191 | #ifdef CONFIG_WD33C93_PIO | |
192 | unsigned int SASR; | |
193 | unsigned int SCMD; | |
194 | #else | |
195 | volatile unsigned char *SASR; | |
196 | volatile unsigned char *SCMD; | |
197 | #endif | |
198 | } wd33c93_regs; | |
199 | ||
200 | ||
201 | typedef int (*dma_setup_t) (struct scsi_cmnd *SCpnt, int dir_in); | |
202 | typedef void (*dma_stop_t) (struct Scsi_Host *instance, | |
203 | struct scsi_cmnd *SCpnt, int status); | |
204 | ||
205 | ||
206 | #define ILLEGAL_STATUS_BYTE 0xff | |
207 | ||
208 | #define DEFAULT_SX_PER 376 /* (ns) fairly safe */ | |
209 | #define DEFAULT_SX_OFF 0 /* aka async */ | |
210 | ||
211 | #define OPTIMUM_SX_PER 252 /* (ns) best we can do (mult-of-4) */ | |
212 | #define OPTIMUM_SX_OFF 12 /* size of wd3393 fifo */ | |
213 | ||
214 | struct sx_period { | |
215 | unsigned int period_ns; | |
216 | uchar reg_value; | |
217 | }; | |
218 | ||
219 | /* FEF: defines for hostdata->dma_buffer_pool */ | |
220 | ||
221 | #define BUF_CHIP_ALLOCED 0 | |
222 | #define BUF_SCSI_ALLOCED 1 | |
223 | ||
224 | struct WD33C93_hostdata { | |
225 | struct Scsi_Host *next; | |
226 | wd33c93_regs regs; | |
227 | spinlock_t lock; | |
228 | uchar clock_freq; | |
229 | uchar chip; /* what kind of wd33c93? */ | |
230 | uchar microcode; /* microcode rev */ | |
231 | uchar dma_buffer_pool; /* FEF: buffer from chip_ram? */ | |
232 | int dma_dir; /* data transfer dir. */ | |
233 | dma_setup_t dma_setup; | |
234 | dma_stop_t dma_stop; | |
235 | unsigned int dma_xfer_mask; | |
236 | uchar *dma_bounce_buffer; | |
237 | unsigned int dma_bounce_len; | |
238 | volatile uchar busy[8]; /* index = target, bit = lun */ | |
239 | volatile struct scsi_cmnd *input_Q; /* commands waiting to be started */ | |
240 | volatile struct scsi_cmnd *selecting; /* trying to select this command */ | |
241 | volatile struct scsi_cmnd *connected; /* currently connected command */ | |
242 | volatile struct scsi_cmnd *disconnected_Q;/* commands waiting for reconnect */ | |
243 | uchar state; /* what we are currently doing */ | |
244 | uchar dma; /* current state of DMA (on/off) */ | |
245 | uchar level2; /* extent to which Level-2 commands are used */ | |
246 | uchar disconnect; /* disconnect/reselect policy */ | |
247 | unsigned int args; /* set from command-line argument */ | |
248 | uchar incoming_msg[8]; /* filled during message_in phase */ | |
249 | int incoming_ptr; /* mainly used with EXTENDED messages */ | |
250 | uchar outgoing_msg[8]; /* send this during next message_out */ | |
251 | int outgoing_len; /* length of outgoing message */ | |
252 | unsigned int default_sx_per; /* default transfer period for SCSI bus */ | |
253 | uchar sync_xfer[8]; /* sync_xfer reg settings per target */ | |
254 | uchar sync_stat[8]; /* status of sync negotiation per target */ | |
255 | uchar no_sync; /* bitmask: don't do sync on these targets */ | |
256 | uchar no_dma; /* set this flag to disable DMA */ | |
257 | #ifdef PROC_INTERFACE | |
258 | uchar proc; /* bitmask: what's in proc output */ | |
259 | #ifdef PROC_STATISTICS | |
260 | unsigned long cmd_cnt[8]; /* # of commands issued per target */ | |
261 | unsigned long int_cnt; /* # of interrupts serviced */ | |
262 | unsigned long pio_cnt; /* # of pio data transfers */ | |
263 | unsigned long dma_cnt; /* # of DMA data transfers */ | |
264 | unsigned long disc_allowed_cnt[8]; /* # of disconnects allowed per target */ | |
265 | unsigned long disc_done_cnt[8]; /* # of disconnects done per target*/ | |
266 | #endif | |
267 | #endif | |
268 | }; | |
269 | ||
270 | ||
271 | /* defines for hostdata->chip */ | |
272 | ||
273 | #define C_WD33C93 0 | |
274 | #define C_WD33C93A 1 | |
275 | #define C_WD33C93B 2 | |
276 | #define C_UNKNOWN_CHIP 100 | |
277 | ||
278 | /* defines for hostdata->state */ | |
279 | ||
280 | #define S_UNCONNECTED 0 | |
281 | #define S_SELECTING 1 | |
282 | #define S_RUNNING_LEVEL2 2 | |
283 | #define S_CONNECTED 3 | |
284 | #define S_PRE_TMP_DISC 4 | |
285 | #define S_PRE_CMP_DISC 5 | |
286 | ||
287 | /* defines for hostdata->dma */ | |
288 | ||
289 | #define D_DMA_OFF 0 | |
290 | #define D_DMA_RUNNING 1 | |
291 | ||
292 | /* defines for hostdata->level2 */ | |
293 | /* NOTE: only the first 3 are implemented so far */ | |
294 | ||
295 | #define L2_NONE 1 /* no combination commands - we get lots of ints */ | |
296 | #define L2_SELECT 2 /* start with SEL_ATN_XFER, but never resume it */ | |
297 | #define L2_BASIC 3 /* resume after STATUS ints & RDP messages */ | |
298 | #define L2_DATA 4 /* resume after DATA_IN/OUT ints */ | |
299 | #define L2_MOST 5 /* resume after anything except a RESELECT int */ | |
300 | #define L2_RESELECT 6 /* resume after everything, including RESELECT ints */ | |
301 | #define L2_ALL 7 /* always resume */ | |
302 | ||
303 | /* defines for hostdata->disconnect */ | |
304 | ||
305 | #define DIS_NEVER 0 | |
306 | #define DIS_ADAPTIVE 1 | |
307 | #define DIS_ALWAYS 2 | |
308 | ||
309 | /* defines for hostdata->args */ | |
310 | ||
311 | #define DB_TEST1 1<<0 | |
312 | #define DB_TEST2 1<<1 | |
313 | #define DB_QUEUE_COMMAND 1<<2 | |
314 | #define DB_EXECUTE 1<<3 | |
315 | #define DB_INTR 1<<4 | |
316 | #define DB_TRANSFER 1<<5 | |
317 | #define DB_MASK 0x3f | |
318 | ||
319 | /* defines for hostdata->sync_stat[] */ | |
320 | ||
321 | #define SS_UNSET 0 | |
322 | #define SS_FIRST 1 | |
323 | #define SS_WAITING 2 | |
324 | #define SS_SET 3 | |
325 | ||
326 | /* defines for hostdata->proc */ | |
327 | ||
328 | #define PR_VERSION 1<<0 | |
329 | #define PR_INFO 1<<1 | |
330 | #define PR_STATISTICS 1<<2 | |
331 | #define PR_CONNECTED 1<<3 | |
332 | #define PR_INPUTQ 1<<4 | |
333 | #define PR_DISCQ 1<<5 | |
334 | #define PR_TEST 1<<6 | |
335 | #define PR_STOP 1<<7 | |
336 | ||
337 | ||
338 | void wd33c93_init (struct Scsi_Host *instance, const wd33c93_regs regs, | |
339 | dma_setup_t setup, dma_stop_t stop, int clock_freq); | |
340 | int wd33c93_abort (struct scsi_cmnd *cmd); | |
341 | int wd33c93_queuecommand (struct scsi_cmnd *cmd, | |
342 | void (*done)(struct scsi_cmnd *)); | |
343 | void wd33c93_intr (struct Scsi_Host *instance); | |
344 | int wd33c93_proc_info(struct Scsi_Host *, char *, char **, off_t, int, int); | |
345 | int wd33c93_host_reset (struct scsi_cmnd *); | |
346 | void wd33c93_release(void); | |
347 | ||
348 | #endif /* WD33C93_H */ |