ispmbox.h revision 1.23 1 1.23 he /* $NetBSD: ispmbox.h,v 1.23 2000/05/13 16:53:04 he Exp $ */
2 1.1 cgd /*
3 1.18 mjacob * Copyright (C) 1997, 1998, 1999 National Aeronautics & Space Administration
4 1.1 cgd * All rights reserved.
5 1.1 cgd *
6 1.1 cgd * Redistribution and use in source and binary forms, with or without
7 1.1 cgd * modification, are permitted provided that the following conditions
8 1.1 cgd * are met:
9 1.1 cgd * 1. Redistributions of source code must retain the above copyright
10 1.18 mjacob * notice, this list of conditions and the following disclaimer.
11 1.1 cgd * 2. Redistributions in binary form must reproduce the above copyright
12 1.1 cgd * notice, this list of conditions and the following disclaimer in the
13 1.1 cgd * documentation and/or other materials provided with the distribution.
14 1.1 cgd * 3. The name of the author may not be used to endorse or promote products
15 1.18 mjacob * derived from this software without specific prior written permission
16 1.6 mjacob *
17 1.18 mjacob * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 1.18 mjacob * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 1.18 mjacob * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 1.18 mjacob * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 1.18 mjacob * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 1.18 mjacob * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 1.18 mjacob * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 1.18 mjacob * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 1.18 mjacob * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 1.18 mjacob * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 1.18 mjacob */
28 1.18 mjacob
29 1.18 mjacob /*
30 1.18 mjacob * Mailbox and Queue Entry Definitions for for Qlogic ISP SCSI adapters.
31 1.18 mjacob * <mjacob (at) nas.nasa.gov>
32 1.1 cgd */
33 1.1 cgd #ifndef _ISPMBOX_H
34 1.1 cgd #define _ISPMBOX_H
35 1.1 cgd
36 1.1 cgd /*
37 1.1 cgd * Mailbox Command Opcodes
38 1.1 cgd */
39 1.1 cgd
40 1.1 cgd #define MBOX_NO_OP 0x0000
41 1.1 cgd #define MBOX_LOAD_RAM 0x0001
42 1.1 cgd #define MBOX_EXEC_FIRMWARE 0x0002
43 1.1 cgd #define MBOX_DUMP_RAM 0x0003
44 1.1 cgd #define MBOX_WRITE_RAM_WORD 0x0004
45 1.1 cgd #define MBOX_READ_RAM_WORD 0x0005
46 1.1 cgd #define MBOX_MAILBOX_REG_TEST 0x0006
47 1.1 cgd #define MBOX_VERIFY_CHECKSUM 0x0007
48 1.1 cgd #define MBOX_ABOUT_FIRMWARE 0x0008
49 1.1 cgd /* 9 */
50 1.1 cgd /* a */
51 1.1 cgd /* b */
52 1.1 cgd /* c */
53 1.1 cgd /* d */
54 1.1 cgd #define MBOX_CHECK_FIRMWARE 0x000e
55 1.1 cgd /* f */
56 1.1 cgd #define MBOX_INIT_REQ_QUEUE 0x0010
57 1.1 cgd #define MBOX_INIT_RES_QUEUE 0x0011
58 1.1 cgd #define MBOX_EXECUTE_IOCB 0x0012
59 1.1 cgd #define MBOX_WAKE_UP 0x0013
60 1.1 cgd #define MBOX_STOP_FIRMWARE 0x0014
61 1.1 cgd #define MBOX_ABORT 0x0015
62 1.1 cgd #define MBOX_ABORT_DEVICE 0x0016
63 1.1 cgd #define MBOX_ABORT_TARGET 0x0017
64 1.1 cgd #define MBOX_BUS_RESET 0x0018
65 1.1 cgd #define MBOX_STOP_QUEUE 0x0019
66 1.1 cgd #define MBOX_START_QUEUE 0x001a
67 1.1 cgd #define MBOX_SINGLE_STEP_QUEUE 0x001b
68 1.1 cgd #define MBOX_ABORT_QUEUE 0x001c
69 1.1 cgd #define MBOX_GET_DEV_QUEUE_STATUS 0x001d
70 1.1 cgd /* 1e */
71 1.1 cgd #define MBOX_GET_FIRMWARE_STATUS 0x001f
72 1.1 cgd #define MBOX_GET_INIT_SCSI_ID 0x0020
73 1.1 cgd #define MBOX_GET_SELECT_TIMEOUT 0x0021
74 1.1 cgd #define MBOX_GET_RETRY_COUNT 0x0022
75 1.1 cgd #define MBOX_GET_TAG_AGE_LIMIT 0x0023
76 1.1 cgd #define MBOX_GET_CLOCK_RATE 0x0024
77 1.1 cgd #define MBOX_GET_ACT_NEG_STATE 0x0025
78 1.1 cgd #define MBOX_GET_ASYNC_DATA_SETUP_TIME 0x0026
79 1.1 cgd #define MBOX_GET_SBUS_PARAMS 0x0027
80 1.1 cgd #define MBOX_GET_TARGET_PARAMS 0x0028
81 1.1 cgd #define MBOX_GET_DEV_QUEUE_PARAMS 0x0029
82 1.17 mjacob #define MBOX_GET_RESET_DELAY_PARAMS 0x002a
83 1.1 cgd /* 2b */
84 1.1 cgd /* 2c */
85 1.1 cgd /* 2d */
86 1.1 cgd /* 2e */
87 1.1 cgd /* 2f */
88 1.1 cgd #define MBOX_SET_INIT_SCSI_ID 0x0030
89 1.1 cgd #define MBOX_SET_SELECT_TIMEOUT 0x0031
90 1.1 cgd #define MBOX_SET_RETRY_COUNT 0x0032
91 1.1 cgd #define MBOX_SET_TAG_AGE_LIMIT 0x0033
92 1.1 cgd #define MBOX_SET_CLOCK_RATE 0x0034
93 1.17 mjacob #define MBOX_SET_ACT_NEG_STATE 0x0035
94 1.1 cgd #define MBOX_SET_ASYNC_DATA_SETUP_TIME 0x0036
95 1.1 cgd #define MBOX_SET_SBUS_CONTROL_PARAMS 0x0037
96 1.3 mjacob #define MBOX_SET_PCI_PARAMETERS 0x0037
97 1.1 cgd #define MBOX_SET_TARGET_PARAMS 0x0038
98 1.1 cgd #define MBOX_SET_DEV_QUEUE_PARAMS 0x0039
99 1.17 mjacob #define MBOX_SET_RESET_DELAY_PARAMS 0x003a
100 1.1 cgd /* 3b */
101 1.1 cgd /* 3c */
102 1.1 cgd /* 3d */
103 1.1 cgd /* 3e */
104 1.1 cgd /* 3f */
105 1.1 cgd #define MBOX_RETURN_BIOS_BLOCK_ADDR 0x0040
106 1.1 cgd #define MBOX_WRITE_FOUR_RAM_WORDS 0x0041
107 1.1 cgd #define MBOX_EXEC_BIOS_IOCB 0x0042
108 1.12 mjacob #define MBOX_SET_FW_FEATURES 0x004a
109 1.12 mjacob #define MBOX_GET_FW_FEATURES 0x004b
110 1.12 mjacob #define FW_FEATURE_LVD_NOTIFY 0x2
111 1.12 mjacob #define FW_FEATURE_FAST_POST 0x1
112 1.1 cgd
113 1.20 mjacob #define MBOX_ENABLE_TARGET_MODE 0x55
114 1.20 mjacob #define ENABLE_TARGET_FLAG 0x8000
115 1.20 mjacob
116 1.3 mjacob /* These are for the ISP2100 FC cards */
117 1.4 mjacob #define MBOX_GET_LOOP_ID 0x20
118 1.4 mjacob #define MBOX_EXEC_COMMAND_IOCB_A64 0x54
119 1.3 mjacob #define MBOX_INIT_FIRMWARE 0x60
120 1.3 mjacob #define MBOX_GET_INIT_CONTROL_BLOCK 0x61
121 1.3 mjacob #define MBOX_INIT_LIP 0x62
122 1.3 mjacob #define MBOX_GET_FC_AL_POSITION_MAP 0x63
123 1.3 mjacob #define MBOX_GET_PORT_DB 0x64
124 1.3 mjacob #define MBOX_CLEAR_ACA 0x65
125 1.3 mjacob #define MBOX_TARGET_RESET 0x66
126 1.3 mjacob #define MBOX_CLEAR_TASK_SET 0x67
127 1.3 mjacob #define MBOX_ABORT_TASK_SET 0x68
128 1.4 mjacob #define MBOX_GET_FW_STATE 0x69
129 1.14 mjacob #define MBOX_GET_PORT_NAME 0x6a
130 1.14 mjacob #define MBOX_GET_LINK_STATUS 0x6b
131 1.8 mjacob #define MBOX_INIT_LIP_RESET 0x6c
132 1.18 mjacob #define MBOX_SEND_SNS 0x6e
133 1.18 mjacob #define MBOX_FABRIC_LOGIN 0x6f
134 1.18 mjacob #define MBOX_SEND_CHANGE_REQUEST 0x70
135 1.18 mjacob #define MBOX_FABRIC_LOGOUT 0x71
136 1.8 mjacob #define MBOX_INIT_LIP_LOGIN 0x72
137 1.3 mjacob
138 1.3 mjacob #define ISP2100_SET_PCI_PARAM 0x00ff
139 1.3 mjacob
140 1.1 cgd #define MBOX_BUSY 0x04
141 1.1 cgd
142 1.1 cgd typedef struct {
143 1.3 mjacob u_int16_t param[8];
144 1.1 cgd } mbreg_t;
145 1.1 cgd
146 1.1 cgd /*
147 1.8 mjacob * Mailbox Command Complete Status Codes
148 1.8 mjacob */
149 1.8 mjacob #define MBOX_COMMAND_COMPLETE 0x4000
150 1.8 mjacob #define MBOX_INVALID_COMMAND 0x4001
151 1.8 mjacob #define MBOX_HOST_INTERFACE_ERROR 0x4002
152 1.8 mjacob #define MBOX_TEST_FAILED 0x4003
153 1.8 mjacob #define MBOX_COMMAND_ERROR 0x4005
154 1.8 mjacob #define MBOX_COMMAND_PARAM_ERROR 0x4006
155 1.22 mjacob #define MBOX_PORT_ID_USED 0x4007
156 1.22 mjacob #define MBOX_LOOP_ID_USED 0x4008
157 1.22 mjacob #define MBOX_ALL_IDS_USED 0x4009
158 1.22 mjacob #define MBOX_NOT_LOGGED_IN 0x400A
159 1.8 mjacob
160 1.8 mjacob /*
161 1.8 mjacob * Asynchronous event status codes
162 1.8 mjacob */
163 1.8 mjacob #define ASYNC_BUS_RESET 0x8001
164 1.8 mjacob #define ASYNC_SYSTEM_ERROR 0x8002
165 1.8 mjacob #define ASYNC_RQS_XFER_ERR 0x8003
166 1.8 mjacob #define ASYNC_RSP_XFER_ERR 0x8004
167 1.8 mjacob #define ASYNC_QWAKEUP 0x8005
168 1.8 mjacob #define ASYNC_TIMEOUT_RESET 0x8006
169 1.10 mjacob #define ASYNC_DEVICE_RESET 0x8007
170 1.8 mjacob #define ASYNC_EXTMSG_UNDERRUN 0x800A
171 1.8 mjacob #define ASYNC_SCAM_INT 0x800B
172 1.8 mjacob #define ASYNC_HUNG_SCSI 0x800C
173 1.8 mjacob #define ASYNC_KILLED_BUS 0x800D
174 1.8 mjacob #define ASYNC_BUS_TRANSIT 0x800E /* LVD -> HVD, eg. */
175 1.8 mjacob #define ASYNC_CMD_CMPLT 0x8020
176 1.8 mjacob #define ASYNC_CTIO_DONE 0x8021
177 1.8 mjacob
178 1.8 mjacob /* for ISP2100 only */
179 1.8 mjacob #define ASYNC_LIP_OCCURRED 0x8010
180 1.8 mjacob #define ASYNC_LOOP_UP 0x8011
181 1.8 mjacob #define ASYNC_LOOP_DOWN 0x8012
182 1.8 mjacob #define ASYNC_LOOP_RESET 0x8013
183 1.10 mjacob #define ASYNC_PDB_CHANGED 0x8014
184 1.8 mjacob #define ASYNC_CHANGE_NOTIFY 0x8015
185 1.8 mjacob
186 1.21 mjacob /* for ISP2200 only */
187 1.21 mjacob #define ASYNC_PTPMODE 0x8030
188 1.21 mjacob #define ASYNC_CONNMODE 0x8036
189 1.21 mjacob #define ISP_CONN_LOOP 1
190 1.21 mjacob #define ISP_CONN_PTP 2
191 1.21 mjacob #define ISP_CONN_BADLIP 3
192 1.21 mjacob #define ISP_CONN_FATAL 4
193 1.21 mjacob #define ISP_CONN_LOOPBACK 5
194 1.21 mjacob
195 1.8 mjacob /*
196 1.1 cgd * Command Structure Definitions
197 1.1 cgd */
198 1.1 cgd
199 1.1 cgd typedef struct {
200 1.1 cgd u_int32_t ds_base;
201 1.1 cgd u_int32_t ds_count;
202 1.1 cgd } ispds_t;
203 1.1 cgd
204 1.16 mjacob #define _ISP_SWAP8(a, b) { \
205 1.16 mjacob u_int8_t tmp; \
206 1.16 mjacob tmp = a; \
207 1.16 mjacob a = b; \
208 1.16 mjacob b = tmp; \
209 1.16 mjacob }
210 1.16 mjacob
211 1.16 mjacob /*
212 1.16 mjacob * These elements get swizzled around for SBus instances.
213 1.16 mjacob */
214 1.1 cgd typedef struct {
215 1.1 cgd u_int8_t rqs_entry_type;
216 1.1 cgd u_int8_t rqs_entry_count;
217 1.1 cgd u_int8_t rqs_seqno;
218 1.1 cgd u_int8_t rqs_flags;
219 1.16 mjacob } isphdr_t;
220 1.16 mjacob /*
221 1.16 mjacob * There are no (for all intents and purposes) non-sparc SBus machines
222 1.16 mjacob */
223 1.16 mjacob #ifdef __sparc__
224 1.16 mjacob #define ISP_SBUSIFY_ISPHDR(isp, hdrp) \
225 1.16 mjacob if ((isp)->isp_bustype == ISP_BT_SBUS) { \
226 1.16 mjacob _ISP_SWAP8((hdrp)->rqs_entry_count, (hdrp)->rqs_entry_type); \
227 1.16 mjacob _ISP_SWAP8((hdrp)->rqs_flags, (hdrp)->rqs_seqno); \
228 1.16 mjacob }
229 1.16 mjacob #else
230 1.16 mjacob #define ISP_SBUSIFY_ISPHDR(a, b)
231 1.1 cgd #endif
232 1.1 cgd
233 1.1 cgd /* RQS Flag definitions */
234 1.1 cgd #define RQSFLAG_CONTINUATION 0x01
235 1.1 cgd #define RQSFLAG_FULL 0x02
236 1.1 cgd #define RQSFLAG_BADHEADER 0x04
237 1.1 cgd #define RQSFLAG_BADPACKET 0x08
238 1.3 mjacob
239 1.1 cgd /* RQS entry_type definitions */
240 1.8 mjacob #define RQSTYPE_REQUEST 0x01
241 1.8 mjacob #define RQSTYPE_DATASEG 0x02
242 1.8 mjacob #define RQSTYPE_RESPONSE 0x03
243 1.8 mjacob #define RQSTYPE_MARKER 0x04
244 1.8 mjacob #define RQSTYPE_CMDONLY 0x05
245 1.8 mjacob #define RQSTYPE_ATIO 0x06 /* Target Mode */
246 1.20 mjacob #define RQSTYPE_CTIO 0x07 /* Target Mode */
247 1.8 mjacob #define RQSTYPE_SCAM 0x08
248 1.8 mjacob #define RQSTYPE_A64 0x09
249 1.8 mjacob #define RQSTYPE_A64_CONT 0x0a
250 1.8 mjacob #define RQSTYPE_ENABLE_LUN 0x0b /* Target Mode */
251 1.8 mjacob #define RQSTYPE_MODIFY_LUN 0x0c /* Target Mode */
252 1.8 mjacob #define RQSTYPE_NOTIFY 0x0d /* Target Mode */
253 1.8 mjacob #define RQSTYPE_NOTIFY_ACK 0x0e /* Target Mode */
254 1.8 mjacob #define RQSTYPE_CTIO1 0x0f /* Target Mode */
255 1.8 mjacob #define RQSTYPE_STATUS_CONT 0x10
256 1.8 mjacob #define RQSTYPE_T2RQS 0x11
257 1.8 mjacob
258 1.8 mjacob #define RQSTYPE_T4RQS 0x15
259 1.8 mjacob #define RQSTYPE_ATIO2 0x16
260 1.8 mjacob #define RQSTYPE_CTIO2 0x17
261 1.8 mjacob #define RQSTYPE_CSET0 0x18
262 1.8 mjacob #define RQSTYPE_T3RQS 0x19
263 1.8 mjacob
264 1.8 mjacob #define RQSTYPE_CTIO3 0x1f
265 1.1 cgd
266 1.1 cgd
267 1.1 cgd #define ISP_RQDSEG 4
268 1.1 cgd typedef struct {
269 1.1 cgd isphdr_t req_header;
270 1.1 cgd u_int32_t req_handle;
271 1.1 cgd u_int8_t req_lun_trn;
272 1.1 cgd u_int8_t req_target;
273 1.1 cgd u_int16_t req_cdblen;
274 1.1 cgd #define req_modifier req_cdblen /* marker packet */
275 1.1 cgd u_int16_t req_flags;
276 1.10 mjacob u_int16_t req_reserved;
277 1.1 cgd u_int16_t req_time;
278 1.1 cgd u_int16_t req_seg_count;
279 1.1 cgd u_int8_t req_cdb[12];
280 1.1 cgd ispds_t req_dataseg[ISP_RQDSEG];
281 1.1 cgd } ispreq_t;
282 1.1 cgd
283 1.16 mjacob /*
284 1.16 mjacob * A request packet can also be a marker packet.
285 1.16 mjacob */
286 1.16 mjacob #define SYNC_DEVICE 0
287 1.16 mjacob #define SYNC_TARGET 1
288 1.16 mjacob #define SYNC_ALL 2
289 1.16 mjacob
290 1.16 mjacob /*
291 1.16 mjacob * There are no (for all intents and purposes) non-sparc SBus machines
292 1.16 mjacob */
293 1.16 mjacob #ifdef __sparc__
294 1.16 mjacob #define ISP_SBUSIFY_ISPREQ(isp, rqp) \
295 1.16 mjacob if ((isp)->isp_bustype == ISP_BT_SBUS) { \
296 1.16 mjacob _ISP_SWAP8((rqp)->req_target, (rqp)->req_lun_trn); \
297 1.16 mjacob }
298 1.16 mjacob #else
299 1.16 mjacob #define ISP_SBUSIFY_ISPREQ(a, b)
300 1.16 mjacob #endif
301 1.16 mjacob
302 1.3 mjacob #define ISP_RQDSEG_T2 3
303 1.3 mjacob typedef struct {
304 1.3 mjacob isphdr_t req_header;
305 1.3 mjacob u_int32_t req_handle;
306 1.3 mjacob u_int8_t req_lun_trn;
307 1.3 mjacob u_int8_t req_target;
308 1.10 mjacob u_int16_t req_scclun;
309 1.4 mjacob u_int16_t req_flags;
310 1.4 mjacob u_int16_t _res2;
311 1.3 mjacob u_int16_t req_time;
312 1.3 mjacob u_int16_t req_seg_count;
313 1.3 mjacob u_int32_t req_cdb[4];
314 1.3 mjacob u_int32_t req_totalcnt;
315 1.3 mjacob ispds_t req_dataseg[ISP_RQDSEG_T2];
316 1.3 mjacob } ispreqt2_t;
317 1.3 mjacob
318 1.1 cgd /* req_flag values */
319 1.1 cgd #define REQFLAG_NODISCON 0x0001
320 1.1 cgd #define REQFLAG_HTAG 0x0002
321 1.1 cgd #define REQFLAG_OTAG 0x0004
322 1.1 cgd #define REQFLAG_STAG 0x0008
323 1.1 cgd #define REQFLAG_TARGET_RTN 0x0010
324 1.1 cgd
325 1.1 cgd #define REQFLAG_NODATA 0x0000
326 1.1 cgd #define REQFLAG_DATA_IN 0x0020
327 1.1 cgd #define REQFLAG_DATA_OUT 0x0040
328 1.1 cgd #define REQFLAG_DATA_UNKNOWN 0x0060
329 1.1 cgd
330 1.1 cgd #define REQFLAG_DISARQ 0x0100
331 1.8 mjacob #define REQFLAG_FRC_ASYNC 0x0200
332 1.8 mjacob #define REQFLAG_FRC_SYNC 0x0400
333 1.8 mjacob #define REQFLAG_FRC_WIDE 0x0800
334 1.8 mjacob #define REQFLAG_NOPARITY 0x1000
335 1.8 mjacob #define REQFLAG_STOPQ 0x2000
336 1.8 mjacob #define REQFLAG_XTRASNS 0x4000
337 1.8 mjacob #define REQFLAG_PRIORITY 0x8000
338 1.1 cgd
339 1.1 cgd typedef struct {
340 1.1 cgd isphdr_t req_header;
341 1.1 cgd u_int32_t req_handle;
342 1.1 cgd u_int8_t req_lun_trn;
343 1.1 cgd u_int8_t req_target;
344 1.1 cgd u_int16_t req_cdblen;
345 1.1 cgd u_int16_t req_flags;
346 1.1 cgd u_int16_t _res1;
347 1.1 cgd u_int16_t req_time;
348 1.1 cgd u_int16_t req_seg_count;
349 1.1 cgd u_int8_t req_cdb[44];
350 1.1 cgd } ispextreq_t;
351 1.1 cgd
352 1.1 cgd #define ISP_CDSEG 7
353 1.1 cgd typedef struct {
354 1.1 cgd isphdr_t req_header;
355 1.1 cgd u_int32_t _res1;
356 1.1 cgd ispds_t req_dataseg[ISP_CDSEG];
357 1.1 cgd } ispcontreq_t;
358 1.1 cgd
359 1.1 cgd typedef struct {
360 1.1 cgd isphdr_t req_header;
361 1.1 cgd u_int32_t req_handle;
362 1.1 cgd u_int16_t req_scsi_status;
363 1.1 cgd u_int16_t req_completion_status;
364 1.1 cgd u_int16_t req_state_flags;
365 1.1 cgd u_int16_t req_status_flags;
366 1.1 cgd u_int16_t req_time;
367 1.20 mjacob #define req_response_len req_time /* FC only */
368 1.1 cgd u_int16_t req_sense_len;
369 1.1 cgd u_int32_t req_resid;
370 1.1 cgd u_int8_t _res1[8];
371 1.1 cgd u_int8_t req_sense_data[32];
372 1.1 cgd } ispstatusreq_t;
373 1.1 cgd
374 1.3 mjacob /*
375 1.3 mjacob * For Qlogic 2100, the high order byte of SCSI status has
376 1.3 mjacob * additional meaning.
377 1.3 mjacob */
378 1.3 mjacob #define RQCS_RU 0x800 /* Residual Under */
379 1.3 mjacob #define RQCS_RO 0x400 /* Residual Over */
380 1.3 mjacob #define RQCS_SV 0x200 /* Sense Length Valid */
381 1.3 mjacob #define RQCS_RV 0x100 /* Residual Valid */
382 1.3 mjacob
383 1.3 mjacob /*
384 1.3 mjacob * Completion Status Codes.
385 1.3 mjacob */
386 1.1 cgd #define RQCS_COMPLETE 0x0000
387 1.1 cgd #define RQCS_INCOMPLETE 0x0001
388 1.1 cgd #define RQCS_DMA_ERROR 0x0002
389 1.1 cgd #define RQCS_TRANSPORT_ERROR 0x0003
390 1.1 cgd #define RQCS_RESET_OCCURRED 0x0004
391 1.1 cgd #define RQCS_ABORTED 0x0005
392 1.1 cgd #define RQCS_TIMEOUT 0x0006
393 1.1 cgd #define RQCS_DATA_OVERRUN 0x0007
394 1.1 cgd #define RQCS_COMMAND_OVERRUN 0x0008
395 1.1 cgd #define RQCS_STATUS_OVERRUN 0x0009
396 1.1 cgd #define RQCS_BAD_MESSAGE 0x000a
397 1.1 cgd #define RQCS_NO_MESSAGE_OUT 0x000b
398 1.1 cgd #define RQCS_EXT_ID_FAILED 0x000c
399 1.1 cgd #define RQCS_IDE_MSG_FAILED 0x000d
400 1.1 cgd #define RQCS_ABORT_MSG_FAILED 0x000e
401 1.1 cgd #define RQCS_REJECT_MSG_FAILED 0x000f
402 1.1 cgd #define RQCS_NOP_MSG_FAILED 0x0010
403 1.1 cgd #define RQCS_PARITY_ERROR_MSG_FAILED 0x0011
404 1.1 cgd #define RQCS_DEVICE_RESET_MSG_FAILED 0x0012
405 1.1 cgd #define RQCS_ID_MSG_FAILED 0x0013
406 1.1 cgd #define RQCS_UNEXP_BUS_FREE 0x0014
407 1.1 cgd #define RQCS_DATA_UNDERRUN 0x0015
408 1.8 mjacob #define RQCS_XACT_ERR1 0x0018
409 1.8 mjacob #define RQCS_XACT_ERR2 0x0019
410 1.8 mjacob #define RQCS_XACT_ERR3 0x001A
411 1.8 mjacob #define RQCS_BAD_ENTRY 0x001B
412 1.8 mjacob #define RQCS_QUEUE_FULL 0x001C
413 1.8 mjacob #define RQCS_PHASE_SKIPPED 0x001D
414 1.8 mjacob #define RQCS_ARQS_FAILED 0x001E
415 1.8 mjacob #define RQCS_WIDE_FAILED 0x001F
416 1.8 mjacob #define RQCS_SYNCXFER_FAILED 0x0020
417 1.8 mjacob #define RQCS_LVD_BUSERR 0x0021
418 1.8 mjacob
419 1.3 mjacob /* 2100 Only Completion Codes */
420 1.3 mjacob #define RQCS_PORT_UNAVAILABLE 0x0028
421 1.3 mjacob #define RQCS_PORT_LOGGED_OUT 0x0029
422 1.3 mjacob #define RQCS_PORT_CHANGED 0x002A
423 1.3 mjacob #define RQCS_PORT_BUSY 0x002B
424 1.1 cgd
425 1.3 mjacob /*
426 1.3 mjacob * State Flags (not applicable to 2100)
427 1.3 mjacob */
428 1.1 cgd #define RQSF_GOT_BUS 0x0100
429 1.1 cgd #define RQSF_GOT_TARGET 0x0200
430 1.1 cgd #define RQSF_SENT_CDB 0x0400
431 1.5 mjacob #define RQSF_XFRD_DATA 0x0800
432 1.1 cgd #define RQSF_GOT_STATUS 0x1000
433 1.1 cgd #define RQSF_GOT_SENSE 0x2000
434 1.5 mjacob #define RQSF_XFER_COMPLETE 0x4000
435 1.1 cgd
436 1.3 mjacob /*
437 1.3 mjacob * Status Flags (not applicable to 2100)
438 1.3 mjacob */
439 1.1 cgd #define RQSTF_DISCONNECT 0x0001
440 1.1 cgd #define RQSTF_SYNCHRONOUS 0x0002
441 1.1 cgd #define RQSTF_PARITY_ERROR 0x0004
442 1.1 cgd #define RQSTF_BUS_RESET 0x0008
443 1.1 cgd #define RQSTF_DEVICE_RESET 0x0010
444 1.1 cgd #define RQSTF_ABORTED 0x0020
445 1.1 cgd #define RQSTF_TIMEOUT 0x0040
446 1.1 cgd #define RQSTF_NEGOTIATION 0x0080
447 1.3 mjacob
448 1.3 mjacob /*
449 1.14 mjacob * FC (ISP2100) specific data structures
450 1.3 mjacob */
451 1.3 mjacob
452 1.3 mjacob /*
453 1.3 mjacob * Initialization Control Block
454 1.8 mjacob *
455 1.19 mjacob * Version One (prime) format.
456 1.3 mjacob */
457 1.19 mjacob typedef struct isp_icb {
458 1.3 mjacob u_int8_t icb_version;
459 1.3 mjacob u_int8_t _reserved0;
460 1.19 mjacob u_int16_t icb_fwoptions;
461 1.19 mjacob u_int16_t icb_maxfrmlen;
462 1.3 mjacob u_int16_t icb_maxalloc;
463 1.3 mjacob u_int16_t icb_execthrottle;
464 1.3 mjacob u_int8_t icb_retry_count;
465 1.3 mjacob u_int8_t icb_retry_delay;
466 1.19 mjacob u_int8_t icb_portname[8];
467 1.3 mjacob u_int16_t icb_hardaddr;
468 1.8 mjacob u_int8_t icb_iqdevtype;
469 1.19 mjacob u_int8_t icb_logintime;
470 1.19 mjacob u_int8_t icb_nodename[8];
471 1.3 mjacob u_int16_t icb_rqstout;
472 1.3 mjacob u_int16_t icb_rspnsin;
473 1.19 mjacob u_int16_t icb_rqstqlen;
474 1.19 mjacob u_int16_t icb_rsltqlen;
475 1.19 mjacob u_int16_t icb_rqstaddr[4];
476 1.19 mjacob u_int16_t icb_respaddr[4];
477 1.19 mjacob u_int16_t icb_lunenables;
478 1.19 mjacob u_int8_t icb_ccnt;
479 1.19 mjacob u_int8_t icb_icnt;
480 1.19 mjacob u_int16_t icb_lunetimeout;
481 1.19 mjacob u_int16_t _reserved1;
482 1.19 mjacob u_int16_t icb_xfwoptions;
483 1.19 mjacob u_int8_t icb_racctimer;
484 1.19 mjacob u_int8_t icb_idelaytimer;
485 1.19 mjacob u_int16_t icb_zfwoptions;
486 1.19 mjacob u_int16_t _reserved2[13];
487 1.3 mjacob } isp_icb_t;
488 1.8 mjacob #define ICB_VERSION1 1
489 1.8 mjacob
490 1.18 mjacob #define ICBOPT_HARD_ADDRESS 0x0001
491 1.18 mjacob #define ICBOPT_FAIRNESS 0x0002
492 1.18 mjacob #define ICBOPT_FULL_DUPLEX 0x0004
493 1.18 mjacob #define ICBOPT_FAST_POST 0x0008
494 1.18 mjacob #define ICBOPT_TGT_ENABLE 0x0010
495 1.18 mjacob #define ICBOPT_INI_DISABLE 0x0020
496 1.18 mjacob #define ICBOPT_INI_ADISC 0x0040
497 1.18 mjacob #define ICBOPT_INI_TGTTYPE 0x0080
498 1.18 mjacob #define ICBOPT_PDBCHANGE_AE 0x0100
499 1.18 mjacob #define ICBOPT_NOLIP 0x0200
500 1.18 mjacob #define ICBOPT_SRCHDOWN 0x0400
501 1.18 mjacob #define ICBOPT_PREVLOOP 0x0800
502 1.18 mjacob #define ICBOPT_STOP_ON_QFULL 0x1000
503 1.18 mjacob #define ICBOPT_FULL_LOGIN 0x2000
504 1.18 mjacob #define ICBOPT_USE_PORTNAME 0x4000
505 1.19 mjacob #define ICBOPT_EXTENDED 0x8000
506 1.21 mjacob
507 1.21 mjacob #define ICBXOPT_CLASS2_ACK0 0x0200
508 1.21 mjacob #define ICBXOPT_CLASS2 0x0100
509 1.21 mjacob #define ICBXOPT_LOOP_ONLY (0 << 4)
510 1.21 mjacob #define ICBXOPT_PTP_ONLY (1 << 4)
511 1.21 mjacob #define ICBXOPT_LOOP_2_PTP (2 << 4)
512 1.21 mjacob #define ICBXOPT_PTP_2_LOOP (3 << 4)
513 1.21 mjacob
514 1.21 mjacob #define ICBXOPT_RIO_OFF 0
515 1.21 mjacob #define ICBXOPT_RIO_16BIT 1
516 1.21 mjacob #define ICBXOPT_RIO_32BIT 2
517 1.21 mjacob #define ICBXOPT_RIO_16BIT_DELAY 3
518 1.21 mjacob #define ICBXOPT_RIO_32BIT_DELAY 4
519 1.21 mjacob
520 1.8 mjacob
521 1.8 mjacob
522 1.8 mjacob #define ICB_MIN_FRMLEN 256
523 1.8 mjacob #define ICB_MAX_FRMLEN 2112
524 1.8 mjacob #define ICB_DFLT_FRMLEN 1024
525 1.18 mjacob #define ICB_DFLT_ALLOC 256
526 1.18 mjacob #define ICB_DFLT_THROTTLE 16
527 1.18 mjacob #define ICB_DFLT_RDELAY 5
528 1.18 mjacob #define ICB_DFLT_RCOUNT 3
529 1.18 mjacob
530 1.8 mjacob
531 1.8 mjacob #define RQRSP_ADDR0015 0
532 1.8 mjacob #define RQRSP_ADDR1631 1
533 1.8 mjacob #define RQRSP_ADDR3247 2
534 1.8 mjacob #define RQRSP_ADDR4863 3
535 1.8 mjacob
536 1.8 mjacob
537 1.8 mjacob #define ICB_NNM0 7
538 1.8 mjacob #define ICB_NNM1 6
539 1.8 mjacob #define ICB_NNM2 5
540 1.8 mjacob #define ICB_NNM3 4
541 1.8 mjacob #define ICB_NNM4 3
542 1.8 mjacob #define ICB_NNM5 2
543 1.8 mjacob #define ICB_NNM6 1
544 1.8 mjacob #define ICB_NNM7 0
545 1.3 mjacob
546 1.8 mjacob #define MAKE_NODE_NAME_FROM_WWN(array, wwn) \
547 1.8 mjacob array[ICB_NNM0] = (u_int8_t) ((wwn >> 0) & 0xff), \
548 1.8 mjacob array[ICB_NNM1] = (u_int8_t) ((wwn >> 8) & 0xff), \
549 1.8 mjacob array[ICB_NNM2] = (u_int8_t) ((wwn >> 16) & 0xff), \
550 1.8 mjacob array[ICB_NNM3] = (u_int8_t) ((wwn >> 24) & 0xff), \
551 1.8 mjacob array[ICB_NNM4] = (u_int8_t) ((wwn >> 32) & 0xff), \
552 1.8 mjacob array[ICB_NNM5] = (u_int8_t) ((wwn >> 40) & 0xff), \
553 1.8 mjacob array[ICB_NNM6] = (u_int8_t) ((wwn >> 48) & 0xff), \
554 1.8 mjacob array[ICB_NNM7] = (u_int8_t) ((wwn >> 56) & 0xff)
555 1.14 mjacob
556 1.14 mjacob /*
557 1.14 mjacob * Port Data Base Element
558 1.14 mjacob */
559 1.14 mjacob
560 1.14 mjacob typedef struct {
561 1.14 mjacob u_int16_t pdb_options;
562 1.14 mjacob u_int8_t pdb_mstate;
563 1.14 mjacob u_int8_t pdb_sstate;
564 1.23 he #define BITS2WORD(x) ((x)[0] << 16 | (x)[3] << 8 | (x)[2])
565 1.14 mjacob u_int8_t pdb_hardaddr_bits[4];
566 1.14 mjacob u_int8_t pdb_portid_bits[4];
567 1.14 mjacob u_int8_t pdb_nodename[8];
568 1.14 mjacob u_int8_t pdb_portname[8];
569 1.14 mjacob u_int16_t pdb_execthrottle;
570 1.14 mjacob u_int16_t pdb_exec_count;
571 1.14 mjacob u_int8_t pdb_retry_count;
572 1.14 mjacob u_int8_t pdb_retry_delay;
573 1.14 mjacob u_int16_t pdb_resalloc;
574 1.14 mjacob u_int16_t pdb_curalloc;
575 1.14 mjacob u_int16_t pdb_qhead;
576 1.14 mjacob u_int16_t pdb_qtail;
577 1.14 mjacob u_int16_t pdb_tl_next;
578 1.14 mjacob u_int16_t pdb_tl_last;
579 1.14 mjacob u_int16_t pdb_features; /* PLOGI, Common Service */
580 1.14 mjacob u_int16_t pdb_pconcurrnt; /* PLOGI, Common Service */
581 1.14 mjacob u_int16_t pdb_roi; /* PLOGI, Common Service */
582 1.14 mjacob u_int8_t pdb_target;
583 1.14 mjacob u_int8_t pdb_initiator; /* PLOGI, Class 3 Control Flags */
584 1.14 mjacob u_int16_t pdb_rdsiz; /* PLOGI, Class 3 */
585 1.14 mjacob u_int16_t pdb_ncseq; /* PLOGI, Class 3 */
586 1.14 mjacob u_int16_t pdb_noseq; /* PLOGI, Class 3 */
587 1.14 mjacob u_int16_t pdb_labrtflg;
588 1.14 mjacob u_int16_t pdb_lstopflg;
589 1.14 mjacob u_int16_t pdb_sqhead;
590 1.14 mjacob u_int16_t pdb_sqtail;
591 1.14 mjacob u_int16_t pdb_ptimer;
592 1.14 mjacob u_int16_t pdb_nxt_seqid;
593 1.14 mjacob u_int16_t pdb_fcount;
594 1.14 mjacob u_int16_t pdb_prli_len;
595 1.14 mjacob u_int16_t pdb_prli_svc0;
596 1.14 mjacob u_int16_t pdb_prli_svc3;
597 1.14 mjacob u_int16_t pdb_loopid;
598 1.14 mjacob u_int16_t pdb_il_ptr;
599 1.14 mjacob u_int16_t pdb_sl_ptr;
600 1.14 mjacob } isp_pdb_t;
601 1.14 mjacob
602 1.14 mjacob #define PDB_OPTIONS_XMITTING (1<<11)
603 1.14 mjacob #define PDB_OPTIONS_LNKXMIT (1<<10)
604 1.14 mjacob #define PDB_OPTIONS_ABORTED (1<<9)
605 1.14 mjacob #define PDB_OPTIONS_ADISC (1<<1)
606 1.14 mjacob
607 1.14 mjacob #define PDB_STATE_DISCOVERY 0
608 1.14 mjacob #define PDB_STATE_WDISC_ACK 1
609 1.14 mjacob #define PDB_STATE_PLOGI 2
610 1.14 mjacob #define PDB_STATE_PLOGI_ACK 3
611 1.14 mjacob #define PDB_STATE_PRLI 4
612 1.14 mjacob #define PDB_STATE_PRLI_ACK 5
613 1.14 mjacob #define PDB_STATE_LOGGED_IN 6
614 1.14 mjacob #define PDB_STATE_PORT_UNAVAIL 7
615 1.14 mjacob #define PDB_STATE_PRLO 8
616 1.14 mjacob #define PDB_STATE_PRLO_ACK 9
617 1.14 mjacob #define PDB_STATE_PLOGO 10
618 1.14 mjacob #define PDB_STATE_PLOG_ACK 11
619 1.14 mjacob
620 1.14 mjacob #define SVC3_TGT_ROLE 0x10
621 1.14 mjacob #define SVC3_INI_ROLE 0x20
622 1.14 mjacob #define SVC3_ROLE_MASK 0x30
623 1.18 mjacob #define SVC3_ROLE_SHIFT 4
624 1.18 mjacob
625 1.18 mjacob #define SNS_GAN 0x100
626 1.18 mjacob #define SNS_GP3 0x171
627 1.18 mjacob typedef struct {
628 1.18 mjacob u_int16_t snscb_rblen; /* response buffer length (words) */
629 1.18 mjacob u_int16_t snscb_res0;
630 1.18 mjacob u_int16_t snscb_addr[4]; /* response buffer address */
631 1.18 mjacob u_int16_t snscb_sblen; /* subcommand buffer length (words) */
632 1.18 mjacob u_int16_t snscb_res1;
633 1.18 mjacob u_int16_t snscb_data[1]; /* variable data */
634 1.18 mjacob } sns_screq_t; /* Subcommand Request Structure */
635 1.18 mjacob #define SNS_GAN_REQ_SIZE (sizeof (sns_screq_t)+(5*(sizeof (u_int16_t))))
636 1.18 mjacob #define SNS_GP3_REQ_SIZE (sizeof (sns_screq_t)+(5*(sizeof (u_int16_t))))
637 1.18 mjacob
638 1.18 mjacob typedef struct {
639 1.18 mjacob u_int8_t snscb_cthdr[16];
640 1.18 mjacob u_int8_t snscb_port_type;
641 1.18 mjacob u_int8_t snscb_port_id[3];
642 1.18 mjacob u_int8_t snscb_portname[8];
643 1.18 mjacob u_int16_t snscb_data[1]; /* variable data */
644 1.18 mjacob } sns_scrsp_t; /* Subcommand Response Structure */
645 1.18 mjacob #define SNS_GAN_RESP_SIZE 608 /* Maximum response size (bytes) */
646 1.18 mjacob #define SNS_GP3_RESP_SIZE 532 /* XXX: For 128 ports */
647 1.22 mjacob
648 1.22 mjacob typedef struct {
649 1.22 mjacob u_int8_t snscb_cthdr[16];
650 1.22 mjacob u_int8_t snscb_port_type;
651 1.22 mjacob u_int8_t snscb_port_id[3];
652 1.22 mjacob u_int8_t snscb_portname[8];
653 1.22 mjacob u_int8_t snscb_pnlen; /* symbolic port name length */
654 1.22 mjacob u_int8_t snscb_pname[255]; /* symbolic port name */
655 1.22 mjacob u_int8_t snscb_nodename[8];
656 1.22 mjacob u_int8_t snscb_nnlen; /* symbolic node name length */
657 1.22 mjacob u_int8_t snscb_nname[255]; /* symbolic node name */
658 1.22 mjacob u_int8_t snscb_ipassoc[8];
659 1.22 mjacob u_int8_t snscb_ipaddr[16];
660 1.22 mjacob u_int8_t snscb_svc_class[4];
661 1.22 mjacob u_int8_t snscb_fc4_types[32];
662 1.22 mjacob u_int8_t snscb_fpname[8];
663 1.22 mjacob u_int8_t snscb_reserved;
664 1.22 mjacob u_int8_t snscb_hardaddr[3];
665 1.22 mjacob } sns_ganrsp_t; /* Subcommand Response Structure */
666 1.1 cgd
667 1.1 cgd #endif /* _ISPMBOX_H */
668