xref: /netbsd-src/sys/dev/ic/ispvar.h (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /* $NetBSD: ispvar.h,v 1.67 2007/07/07 00:49:49 mjacob Exp $ */
2 /*
3  * Copyright (C) 1999 National Aeronautics & Space Administration
4  * All rights reserved.
5  *
6  * Additional Copyright (C) 2000-2007 by Matthew Jacob
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. The name of the author may not be used to endorse or promote products
18  *    derived from this software without specific prior written permission
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
21  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
22  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
25  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 /*
32  * Additional Copyright (c) 1997-2006 by Matthew Jacob
33  * All rights reserved.
34  *
35  * Redistribution and use in source and binary forms, with or without
36  * modification, are permitted provided that the following conditions
37  * are met:
38  *
39  *  1. Redistributions of source code must retain the above copyright
40  *     notice, this list of conditions, and the following disclaimer,
41  *     without modification, immediately at the beginning of the file.
42  *  2. The name of the author may not be used to endorse or promote products
43  *     derived from this software without specific prior written permission.
44  *
45  *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
46  *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48  *  ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
49  *  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50  *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51  *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53  *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54  *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55  *  SUCH DAMAGE.
56  */
57 /*
58  * Soft Definitions for for Qlogic ISP SCSI adapters.
59  */
60 
61 #ifndef	_ISPVAR_H
62 #define	_ISPVAR_H
63 
64 #if defined(__NetBSD__) || defined(__OpenBSD__)
65 #include <dev/ic/isp_stds.h>
66 #include <dev/ic/ispmbox.h>
67 #endif
68 #ifdef	__FreeBSD__
69 #include <dev/isp/isp_stds.h>
70 #include <dev/isp/ispmbox.h>
71 #endif
72 #ifdef	__linux__
73 #include "isp_stds.h"
74 #include "ispmbox.h"
75 #endif
76 #ifdef	__svr4__
77 #include "isp_stds.h"
78 #include "ispmbox.h"
79 #endif
80 
81 #define	ISP_CORE_VERSION_MAJOR	3
82 #define	ISP_CORE_VERSION_MINOR	0
83 
84 /*
85  * Vector for bus specific code to provide specific services.
86  */
87 typedef struct ispsoftc ispsoftc_t;
88 struct ispmdvec {
89 	int		(*dv_rd_isr)
90 	    (ispsoftc_t *, uint32_t *, uint16_t *, uint16_t *);
91 	uint32_t	(*dv_rd_reg) (ispsoftc_t *, int);
92 	void		(*dv_wr_reg) (ispsoftc_t *, int, uint32_t);
93 	int		(*dv_mbxdma) (ispsoftc_t *);
94 	int		(*dv_dmaset)
95 	    (ispsoftc_t *, XS_T *, ispreq_t *, uint32_t *, uint32_t);
96 	void		(*dv_dmaclr) (ispsoftc_t *, XS_T *, uint32_t);
97 	void		(*dv_reset0) (ispsoftc_t *);
98 	void		(*dv_reset1) (ispsoftc_t *);
99 	void		(*dv_dregs) (ispsoftc_t *, const char *);
100 	const void *	dv_ispfw;	/* ptr to f/w */
101 	uint16_t	dv_conf1;
102 	uint16_t	dv_clock;	/* clock frequency */
103 };
104 
105 /*
106  * Overall parameters
107  */
108 #define	MAX_TARGETS		16
109 #define	MAX_FC_TARG		512
110 #define	ISP_MAX_TARGETS(isp)	(IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
111 #define	ISP_MAX_LUNS(isp)	(isp)->isp_maxluns
112 
113 /*
114  * Macros to access ISP registers through bus specific layers-
115  * mostly wrappers to vector through the mdvec structure.
116  */
117 #define	ISP_READ_ISR(isp, isrp, semap, mbox0p)	\
118 	(*(isp)->isp_mdvec->dv_rd_isr)(isp, isrp, semap, mbox0p)
119 
120 #define	ISP_READ(isp, reg)	\
121 	(*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
122 
123 #define	ISP_WRITE(isp, reg, val)	\
124 	(*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
125 
126 #define	ISP_MBOXDMASETUP(isp)	\
127 	(*(isp)->isp_mdvec->dv_mbxdma)((isp))
128 
129 #define	ISP_DMASETUP(isp, xs, req, iptrp, optr)	\
130 	(*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr))
131 
132 #define	ISP_DMAFREE(isp, xs, hndl)		\
133 	if ((isp)->isp_mdvec->dv_dmaclr)	\
134 	    (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
135 
136 #define	ISP_RESET0(isp)	\
137 	if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
138 #define	ISP_RESET1(isp)	\
139 	if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
140 #define	ISP_DUMPREGS(isp, m)	\
141 	if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m))
142 
143 #define	ISP_SETBITS(isp, reg, val)	\
144  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
145 
146 #define	ISP_CLRBITS(isp, reg, val)	\
147  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
148 
149 /*
150  * The MEMORYBARRIER macro is defined per platform (to provide synchronization
151  * on Request and Response Queues, Scratch DMA areas, and Registers)
152  *
153  * Defined Memory Barrier Synchronization Types
154  */
155 #define	SYNC_REQUEST	0	/* request queue synchronization */
156 #define	SYNC_RESULT	1	/* result queue synchronization */
157 #define	SYNC_SFORDEV	2	/* scratch, sync for ISP */
158 #define	SYNC_SFORCPU	3	/* scratch, sync for CPU */
159 #define	SYNC_REG	4	/* for registers */
160 #define	SYNC_ATIOQ	5	/* atio result queue (24xx) */
161 
162 /*
163  * Request/Response Queue defines and macros.
164  * The maximum is defined per platform (and can be based on board type).
165  */
166 /* This is the size of a queue entry (request and response) */
167 #define	QENTRY_LEN			64
168 /* Both request and result queue length must be a power of two */
169 #define	RQUEST_QUEUE_LEN(x)		MAXISPREQUEST(x)
170 #ifdef	ISP_TARGET_MODE
171 #define	RESULT_QUEUE_LEN(x)		MAXISPREQUEST(x)
172 #else
173 #define	RESULT_QUEUE_LEN(x)		\
174 	(((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2)
175 #endif
176 #define	ISP_QUEUE_ENTRY(q, idx)		(((uint8_t *)q) + ((idx) * QENTRY_LEN))
177 #define	ISP_QUEUE_SIZE(n)		((n) * QENTRY_LEN)
178 #define	ISP_NXT_QENTRY(idx, qlen)	(((idx) + 1) & ((qlen)-1))
179 #define	ISP_QFREE(in, out, qlen)	\
180 	((in == out)? (qlen - 1) : ((in > out)? \
181 	((qlen - 1) - (in - out)) : (out - in - 1)))
182 #define	ISP_QAVAIL(isp)	\
183 	ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp))
184 
185 #define	ISP_ADD_REQUEST(isp, nxti)					\
186 	MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN);	\
187 	ISP_WRITE(isp, isp->isp_rqstinrp, nxti);			\
188 	isp->isp_reqidx = nxti
189 
190 /*
191  * SCSI Specific Host Adapter Parameters- per bus, per target
192  */
193 typedef struct {
194 	uint32_t 				: 10,
195 			isp_bad_nvram		: 1,
196 			isp_gotdparms		: 1,
197 			isp_req_ack_active_neg	: 1,
198 			isp_data_line_active_neg: 1,
199 			isp_cmd_dma_burst_enable: 1,
200 			isp_data_dma_burst_enabl: 1,
201 			isp_fifo_threshold	: 3,
202 			isp_ptisp		: 1,
203 			isp_ultramode		: 1,
204 			isp_diffmode		: 1,
205 			isp_lvdmode		: 1,
206 			isp_fast_mttr		: 1,	/* fast sram */
207 			isp_initiator_id	: 4,
208 			isp_async_data_setup	: 4;
209 	uint16_t	isp_selection_timeout;
210 	uint16_t	isp_max_queue_depth;
211 	uint8_t		isp_tag_aging;
212 	uint8_t		isp_bus_reset_delay;
213 	uint8_t		isp_retry_count;
214 	uint8_t		isp_retry_delay;
215 	struct {
216 		uint32_t
217 			exc_throttle	:	8,
218 					:	1,
219 			dev_enable	:	1,	/* ignored */
220 			dev_update	:	1,
221 			dev_refresh	:	1,
222 			actv_offset	:	4,
223 			goal_offset	:	4,
224 			nvrm_offset	:	4;
225 		uint8_t		actv_period;	/* current sync period */
226 		uint8_t		goal_period;	/* goal sync period */
227 		uint8_t		nvrm_period;	/* nvram sync period */
228 		uint16_t	actv_flags;	/* current device flags */
229 		uint16_t	goal_flags;	/* goal device flags */
230 		uint16_t	nvrm_flags;	/* nvram device flags */
231 	} isp_devparam[MAX_TARGETS];
232 } sdparam;
233 
234 /*
235  * Device Flags
236  */
237 #define	DPARM_DISC	0x8000
238 #define	DPARM_PARITY	0x4000
239 #define	DPARM_WIDE	0x2000
240 #define	DPARM_SYNC	0x1000
241 #define	DPARM_TQING	0x0800
242 #define	DPARM_ARQ	0x0400
243 #define	DPARM_QFRZ	0x0200
244 #define	DPARM_RENEG	0x0100
245 #define	DPARM_NARROW	0x0080
246 #define	DPARM_ASYNC	0x0040
247 #define	DPARM_PPR	0x0020
248 #define	DPARM_DEFAULT	(0xFF00 & ~DPARM_QFRZ)
249 #define	DPARM_SAFE_DFLT	(DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING))
250 
251 /* technically, not really correct, as they need to be rated based upon clock */
252 #define	ISP_80M_SYNCPARMS	0x0c09
253 #define	ISP_40M_SYNCPARMS	0x0c0a
254 #define	ISP_20M_SYNCPARMS	0x0c0c
255 #define	ISP_20M_SYNCPARMS_1040	0x080c
256 #define	ISP_10M_SYNCPARMS	0x0c19
257 #define	ISP_08M_SYNCPARMS	0x0c25
258 #define	ISP_05M_SYNCPARMS	0x0c32
259 #define	ISP_04M_SYNCPARMS	0x0c41
260 
261 /*
262  * Fibre Channel Specifics
263  */
264 /* These are for non-2K Login Firmware cards */
265 #define	FL_ID			0x7e	/* FL_Port Special ID */
266 #define	SNS_ID			0x80	/* SNS Server Special ID */
267 #define	NPH_MAX			0xfe
268 
269 /* These are for 2K Login Firmware cards */
270 #define	NPH_RESERVED		0x7F0	/* begin of reserved N-port handles */
271 #define	NPH_MGT_ID		0x7FA	/* Management Server Special ID */
272 #define	NPH_SNS_ID		0x7FC	/* SNS Server Special ID */
273 #define	NPH_FL_ID		0x7FE	/* FL Port Special ID */
274 #define	NPH_MAX_2K		0x800
275 
276 /*
277  * "Unassigned" handle to be used internally
278  */
279 #define	NIL_HANDLE		0xffff
280 
281 /*
282  * Limit for devices on an arbitrated loop.
283  */
284 #define	LOCAL_LOOP_LIM		126
285 
286 /*
287  * Special Port IDs
288  */
289 #define	MANAGEMENT_PORT_ID	0xFFFFFA
290 #define	SNS_PORT_ID		0xFFFFFC
291 #define	FABRIC_PORT_ID		0xFFFFFE
292 
293 
294 /*
295  * FC Port Database entry.
296  *
297  * It has a handle that the f/w uses to address commands to a device.
298  * This handle's value may be assigned by the firmware (e.g., for local loop
299  * devices) or by the driver (e.g., for fabric devices).
300  *
301  * It has a state. If the state if VALID, that means that we've logged into
302  * the device. We also *may* have a initiator map index entry. This is a value
303  * from 0..MAX_FC_TARG that is used to index into the isp_ini_map array. If
304  * the value therein is non-zero, then that value minus one is used to index
305  * into the Port Database to find the handle for forming commands. There is
306  * back-index minus one value within to Port Database entry that tells us
307  * which entry in isp_ini_map points to us (to avoid searching).
308  *
309  * Local loop devices the firmware automatically performs PLOGI on for us
310  * (which is why that handle is imposed upon us). Fabric devices we assign
311  * a handle to and perform the PLOGI on.
312  *
313  * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID
314  * entries as PROBATIONAL. This allows us, if policy says to, just keep track
315  * of devices whose handles change but are otherwise the same device (and
316  * thus keep 'target' constant).
317  *
318  * In any case, we search all possible local loop handles. For each one that
319  * has a port database entity returned, we search for any PROBATIONAL entry
320  * that matches it and update as appropriate. Otherwise, as a new entry, we
321  * find room for it in the Port Database. We *try* and use the handle as the
322  * index to put it into the Database, but that's just an optimization. We mark
323  * the entry VALID and make sure that the target index is updated and correct.
324  *
325  * When we get done searching the local loop, we then search similarily for
326  * a list of devices we've gotten from the fabric name controller (if we're
327  * on a fabric). VALID marking is also done similarily.
328  *
329  * When all of this is done, we can march through the database and clean up
330  * any entry that is still PROBATIONAL (these represent devices which have
331  * departed). Then we're done and can resume normal operations.
332  *
333  * Negative invariants that we try and test for are:
334  *
335  *  + There can never be two non-NIL entries with the same { Port, Node } WWN
336  *    duples.
337  *
338  *  + There can never be two non-NIL entries with the same handle.
339  *
340  *  + There can never be two non-NIL entries which have the same ini_map_idx
341  *    value.
342  */
343 typedef struct {
344 	/*
345 	 * This is the handle that the firmware needs in order for us to
346 	 * send commands to the device. For pre-24XX cards, this would be
347 	 * the 'loopid'.
348 	 */
349 	uint16_t	handle;
350 	/*
351 	 * The ini_map_idx, if nonzero, is the system virtual target ID (+1)
352 	 * as a cross-reference with the isp_ini_map.
353 	 *
354 	 * A device is 'autologin' if the firmware automatically logs into
355 	 * it (re-logins as needed). Basically, local private loop devices.
356 	 *
357 	 * The state is the current state of thsi entry.
358 	 *
359 	 * Role is Initiator, Target, Both
360 	 *
361 	 * Portid is obvious, as or node && port WWNs. The new_role and
362 	 * new_portid is for when we are pending a change.
363 	 */
364 	uint16_t	ini_map_idx	: 12,
365 			autologin	: 1,	/* F/W does PLOGI/PLOGO */
366 			state		: 3;
367 	uint32_t	reserved	: 6,
368 			roles		: 2,
369 			portid		: 24;
370 	uint32_t	new_reserved	: 6,
371 			new_roles	: 2,
372 			new_portid	: 24;
373 	uint64_t	node_wwn;
374 	uint64_t	port_wwn;
375 } fcportdb_t;
376 
377 #define	FC_PORTDB_STATE_NIL		0
378 #define	FC_PORTDB_STATE_PROBATIONAL	1
379 #define	FC_PORTDB_STATE_DEAD		2
380 #define	FC_PORTDB_STATE_CHANGED		3
381 #define	FC_PORTDB_STATE_NEW		4
382 #define	FC_PORTDB_STATE_PENDING_VALID	5
383 #define	FC_PORTDB_STATE_ZOMBIE		6
384 #define	FC_PORTDB_STATE_VALID		7
385 
386 /*
387  * FC card specific information
388  */
389 typedef struct {
390 	uint32_t				: 10,
391 				isp_tmode	: 1,
392 				isp_2klogin	: 1,
393 				isp_sccfw	: 1,
394 				isp_gbspeed	: 3,
395 						: 1,
396 						: 1,
397 				isp_gotdparms	: 1,
398 				isp_bad_nvram	: 1,
399 				isp_loopstate	: 4,	/* Current Loop State */
400 				isp_fwstate	: 4,	/* ISP F/W state */
401 				isp_topo	: 3,
402 				loop_seen_once	: 1;
403 	uint32_t				: 8,
404 				isp_portid	: 24;	/* S_ID */
405 	uint16_t		isp_fwoptions;
406 	uint16_t		isp_xfwoptions;
407 	uint16_t		isp_zfwoptions;
408 	uint16_t		isp_loopid;	/* hard loop id */
409 	uint16_t		isp_fwattr;	/* firmware attributes */
410 	uint16_t		isp_execthrottle;
411 	uint8_t			isp_retry_delay;
412 	uint8_t			isp_retry_count;
413 	uint8_t			isp_reserved;
414 	uint16_t		isp_maxalloc;
415 	uint16_t		isp_maxfrmlen;
416 	uint64_t		isp_wwnn_nvram;
417 	uint64_t		isp_wwpn_nvram;
418 
419 	/*
420 	 * Our Port Data Base
421 	 */
422 	fcportdb_t		portdb[MAX_FC_TARG];
423 
424 	/*
425 	 * This maps system virtual 'target' id to a portdb entry.
426 	 *
427 	 * The mapping function is to take any non-zero entry and
428 	 * subtract one to get the portdb index. This means that
429 	 * entries which are zero are unmapped (i.e., don't exist).
430 	 */
431 	uint16_t		isp_ini_map[MAX_FC_TARG];
432 
433 	/*
434 	 * Scratch DMA mapped in area to fetch Port Database stuff, etc.
435 	 */
436 	void *			isp_scratch;
437 	XS_DMA_ADDR_T		isp_scdma;
438 #ifdef	ISP_FW_CRASH_DUMP
439 	uint16_t *		isp_dump_data;
440 #endif
441 } fcparam;
442 
443 #define	FW_CONFIG_WAIT		0
444 #define	FW_WAIT_AL_PA		1
445 #define	FW_WAIT_LOGIN		2
446 #define	FW_READY		3
447 #define	FW_LOSS_OF_SYNC		4
448 #define	FW_ERROR		5
449 #define	FW_REINIT		6
450 #define	FW_NON_PART		7
451 
452 #define	LOOP_NIL		0
453 #define	LOOP_LIP_RCVD		1
454 #define	LOOP_PDB_RCVD		2
455 #define	LOOP_SCANNING_LOOP	3
456 #define	LOOP_LSCAN_DONE		4
457 #define	LOOP_SCANNING_FABRIC	5
458 #define	LOOP_FSCAN_DONE		6
459 #define	LOOP_SYNCING_PDB	7
460 #define	LOOP_READY		8
461 
462 #define	TOPO_NL_PORT		0
463 #define	TOPO_FL_PORT		1
464 #define	TOPO_N_PORT		2
465 #define	TOPO_F_PORT		3
466 #define	TOPO_PTP_STUB		4
467 
468 /*
469  * Soft Structure per host adapter
470  */
471 struct ispsoftc {
472 	/*
473 	 * Platform (OS) specific data
474 	 */
475 	struct isposinfo	isp_osinfo;
476 
477 	/*
478 	 * Pointer to bus specific functions and data
479 	 */
480 	struct ispmdvec *	isp_mdvec;
481 
482 	/*
483 	 * (Mostly) nonvolatile state. Board specific parameters
484 	 * may contain some volatile state (e.g., current loop state).
485 	 */
486 
487 	void * 			isp_param;	/* type specific */
488 	uint16_t		isp_fwrev[3];	/* Loaded F/W revision */
489 	uint16_t		isp_romfw_rev[3]; /* PROM F/W revision */
490 	uint16_t		isp_maxcmds;	/* max possible I/O cmds */
491 	uint8_t			isp_type;	/* HBA Chip Type */
492 	uint8_t			isp_revision;	/* HBA Chip H/W Revision */
493 	uint32_t		isp_maxluns;	/* maximum luns supported */
494 
495 	uint32_t		isp_clock	: 8,	/* input clock */
496 						: 4,
497 				isp_port	: 1,	/* 23XX/24XX only */
498 				isp_failed	: 1,	/* board failed */
499 				isp_open	: 1,	/* opened (ioctl) */
500 				isp_touched	: 1,	/* board ever seen? */
501 				isp_bustype	: 1,	/* SBus or PCI */
502 				isp_loaded_fw	: 1,	/* loaded firmware */
503 				isp_role	: 2,	/* roles supported */
504 				isp_dblev	: 12;	/* debug log mask */
505 
506 	uint32_t		isp_confopts;		/* config options */
507 
508 	uint32_t		isp_rqstinrp;	/* register for REQINP */
509 	uint32_t		isp_rqstoutrp;	/* register for REQOUTP */
510 	uint32_t		isp_respinrp;	/* register for RESINP */
511 	uint32_t		isp_respoutrp;	/* register for RESOUTP */
512 	uint32_t		isp_atioinrp;	/* register for ATIOINP */
513 	uint32_t		isp_atiooutrp;	/* register for ATIOOUTP */
514 
515 	/*
516 	 * Instrumentation
517 	 */
518 	uint64_t		isp_intcnt;		/* total int count */
519 	uint64_t		isp_intbogus;		/* spurious int count */
520 	uint64_t		isp_intmboxc;		/* mbox completions */
521 	uint64_t		isp_intoasync;		/* other async */
522 	uint64_t		isp_rsltccmplt;		/* CMDs on result q */
523 	uint64_t		isp_fphccmplt;		/* CMDs via fastpost */
524 	uint16_t		isp_rscchiwater;
525 	uint16_t		isp_fpcchiwater;
526 
527 	/*
528 	 * Volatile state
529 	 */
530 
531 	volatile uint32_t	:	8,
532 		isp_mboxbsy	:	1,	/* mailbox command active */
533 		isp_state	:	3,
534 		isp_sendmarker	:	2,	/* send a marker entry */
535 		isp_update	:	2,	/* update parameters */
536 		isp_nactive	:	16;	/* how many commands active */
537 	volatile uint32_t	isp_reqodx;	/* index of last ISP pickup */
538 	volatile uint32_t	isp_reqidx;	/* index of next request */
539 	volatile uint32_t	isp_residx;	/* index of next result */
540 	volatile uint32_t	isp_resodx;	/* index of next result */
541 	volatile uint32_t	isp_rspbsy;
542 	volatile uint32_t	isp_lasthdls;	/* last handle seed */
543 	volatile uint32_t	isp_obits;	/* mailbox command output */
544 	volatile uint16_t	isp_mboxtmp[MAILBOX_STORAGE];
545 	volatile uint16_t	isp_lastmbxcmd;	/* last mbox command sent */
546 	volatile uint16_t	isp_mbxwrk0;
547 	volatile uint16_t	isp_mbxwrk1;
548 	volatile uint16_t	isp_mbxwrk2;
549 	volatile uint16_t	isp_mbxwrk8;
550 	void *			isp_mbxworkp;
551 
552 	/*
553 	 * Active commands are stored here, indexed by handle functions.
554 	 */
555 	XS_T **isp_xflist;
556 
557 #ifdef	ISP_TARGET_MODE
558 	/*
559 	 * Active target commands are stored here, indexed by handle function.
560 	 */
561 	void **isp_tgtlist;
562 #endif
563 
564 	/*
565 	 * request/result queue pointers and DMA handles for them.
566 	 */
567 	void *			isp_rquest;
568 	void *			isp_result;
569 	XS_DMA_ADDR_T		isp_rquest_dma;
570 	XS_DMA_ADDR_T		isp_result_dma;
571 #ifdef	ISP_TARGET_MODE
572 	/* for 24XX only */
573 	void *			isp_atioq;
574 	XS_DMA_ADDR_T		isp_atioq_dma;
575 #endif
576 };
577 
578 #define	SDPARAM(isp)	((sdparam *) (isp)->isp_param)
579 #define	FCPARAM(isp)	((fcparam *) (isp)->isp_param)
580 
581 /*
582  * ISP Driver Run States
583  */
584 #define	ISP_NILSTATE	0
585 #define	ISP_CRASHED	1
586 #define	ISP_RESETSTATE	2
587 #define	ISP_INITSTATE	3
588 #define	ISP_RUNSTATE	4
589 
590 /*
591  * ISP Configuration Options
592  */
593 #define	ISP_CFG_NORELOAD	0x80	/* don't download f/w */
594 #define	ISP_CFG_NONVRAM		0x40	/* ignore NVRAM */
595 #define	ISP_CFG_TWOGB		0x20	/* force 2GB connection (23XX only) */
596 #define	ISP_CFG_ONEGB		0x10	/* force 1GB connection (23XX only) */
597 #define	ISP_CFG_FULL_DUPLEX	0x01	/* Full Duplex (Fibre Channel only) */
598 #define	ISP_CFG_PORT_PREF	0x0C	/* Mask for Port Prefs (2200 only) */
599 #define	ISP_CFG_LPORT		0x00	/* prefer {N/F}L-Port connection */
600 #define	ISP_CFG_NPORT		0x04	/* prefer {N/F}-Port connection */
601 #define	ISP_CFG_NPORT_ONLY	0x08	/* insist on {N/F}-Port connection */
602 #define	ISP_CFG_LPORT_ONLY	0x0C	/* insist on {N/F}L-Port connection */
603 #define	ISP_CFG_OWNWWPN		0x100	/* override NVRAM wwpn */
604 #define	ISP_CFG_OWNWWNN		0x200	/* override NVRAM wwnn */
605 #define	ISP_CFG_OWNFSZ		0x400	/* override NVRAM frame size */
606 #define	ISP_CFG_OWNLOOPID	0x800	/* override NVRAM loopid */
607 #define	ISP_CFG_OWNEXCTHROTTLE	0x1000	/* override NVRAM execution throttle */
608 #define	ISP_CFG_FOURGB		0x2000	/* force 4GB connection (24XX only) */
609 
610 /*
611  * Prior to calling isp_reset for the first time, the outer layer
612  * should set isp_role to one of NONE, INITIATOR, TARGET, BOTH.
613  *
614  * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded,
615  * NVRAM read, and defaults set, but any further initialization (e.g.
616  * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done.
617  *
618  * If INITIATOR MODE isn't set, attempts to run commands will be stopped
619  * at isp_start and completed with the moral equivalent of SELECTION TIMEOUT.
620  *
621  * If TARGET MODE is set, it doesn't mean that the rest of target mode support
622  * needs to be enabled, or will even work. What happens with the 2X00 cards
623  * here is that if you have enabled it with TARGET MODE as part of the ICB
624  * options, but you haven't given the f/w any ram resources for ATIOs or
625  * Immediate Notifies, the f/w just handles what it can and you never see
626  * anything. Basically, it sends a single byte of data (the first byte,
627  * which you can set as part of the INITIALIZE CONTROL BLOCK command) for
628  * INQUIRY, and sends back QUEUE FULL status for any other command.
629  *
630  */
631 #define	ISP_ROLE_NONE		0x0
632 #define	ISP_ROLE_TARGET		0x1
633 #define	ISP_ROLE_INITIATOR	0x2
634 #define	ISP_ROLE_BOTH		(ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
635 #define	ISP_ROLE_EITHER		ISP_ROLE_BOTH
636 #ifndef	ISP_DEFAULT_ROLES
637 #define	ISP_DEFAULT_ROLES	ISP_ROLE_INITIATOR
638 #endif
639 
640 
641 /*
642  * Firmware related defines
643  */
644 #define	ISP_CODE_ORG			0x1000	/* default f/w code start */
645 #define	ISP_CODE_ORG_2300		0x0800	/* ..except for 2300s */
646 #define	ISP_CODE_ORG_2400		0x100000 /* ..and 2400s */
647 #define	ISP_FW_REV(maj, min, mic)	((maj << 24) | (min << 16) | mic)
648 #define	ISP_FW_MAJOR(code)		((code >> 24) & 0xff)
649 #define	ISP_FW_MINOR(code)		((code >> 16) & 0xff)
650 #define	ISP_FW_MICRO(code)		((code >>  8) & 0xff)
651 #define	ISP_FW_REVX(xp)			((xp[0]<<24) | (xp[1] << 16) | xp[2])
652 #define	ISP_FW_MAJORX(xp)		(xp[0])
653 #define	ISP_FW_MINORX(xp)		(xp[1])
654 #define	ISP_FW_MICROX(xp)		(xp[2])
655 #define	ISP_FW_NEWER_THAN(i, major, minor, micro)		\
656  (ISP_FW_REVX((i)->isp_fwrev) > ISP_FW_REV(major, minor, micro))
657 #define	ISP_FW_OLDER_THAN(i, major, minor, micro)		\
658  (ISP_FW_REVX((i)->isp_fwrev) < ISP_FW_REV(major, minor, micro))
659 
660 /*
661  * Bus (implementation) types
662  */
663 #define	ISP_BT_PCI		0	/* PCI Implementations */
664 #define	ISP_BT_SBUS		1	/* SBus Implementations */
665 
666 /*
667  * If we have not otherwise defined SBus support away make sure
668  * it is defined here such that the code is included as default
669  */
670 #ifndef	ISP_SBUS_SUPPORTED
671 #define	ISP_SBUS_SUPPORTED	1
672 #endif
673 
674 /*
675  * Chip Types
676  */
677 #define	ISP_HA_SCSI		0xf
678 #define	ISP_HA_SCSI_UNKNOWN	0x1
679 #define	ISP_HA_SCSI_1020	0x2
680 #define	ISP_HA_SCSI_1020A	0x3
681 #define	ISP_HA_SCSI_1040	0x4
682 #define	ISP_HA_SCSI_1040A	0x5
683 #define	ISP_HA_SCSI_1040B	0x6
684 #define	ISP_HA_SCSI_1040C	0x7
685 #define	ISP_HA_SCSI_1240	0x8
686 #define	ISP_HA_SCSI_1080	0x9
687 #define	ISP_HA_SCSI_1280	0xa
688 #define	ISP_HA_SCSI_10160	0xb
689 #define	ISP_HA_SCSI_12160	0xc
690 #define	ISP_HA_FC		0xf0
691 #define	ISP_HA_FC_2100		0x10
692 #define	ISP_HA_FC_2200		0x20
693 #define	ISP_HA_FC_2300		0x30
694 #define	ISP_HA_FC_2312		0x40
695 #define	ISP_HA_FC_2322		0x50
696 #define	ISP_HA_FC_2400		0x60
697 
698 #define	IS_SCSI(isp)	(isp->isp_type & ISP_HA_SCSI)
699 #define	IS_1240(isp)	(isp->isp_type == ISP_HA_SCSI_1240)
700 #define	IS_1080(isp)	(isp->isp_type == ISP_HA_SCSI_1080)
701 #define	IS_1280(isp)	(isp->isp_type == ISP_HA_SCSI_1280)
702 #define	IS_10160(isp)	(isp->isp_type == ISP_HA_SCSI_10160)
703 #define	IS_12160(isp)	(isp->isp_type == ISP_HA_SCSI_12160)
704 
705 #define	IS_12X0(isp)	(IS_1240(isp) || IS_1280(isp))
706 #define	IS_1X160(isp)	(IS_10160(isp) || IS_12160(isp))
707 #define	IS_DUALBUS(isp)	(IS_12X0(isp) || IS_12160(isp))
708 #define	IS_ULTRA2(isp)	(IS_1080(isp) || IS_1280(isp) || IS_1X160(isp))
709 #define	IS_ULTRA3(isp)	(IS_1X160(isp))
710 
711 #define	IS_FC(isp)	((isp)->isp_type & ISP_HA_FC)
712 #define	IS_2100(isp)	((isp)->isp_type == ISP_HA_FC_2100)
713 #define	IS_2200(isp)	((isp)->isp_type == ISP_HA_FC_2200)
714 #define	IS_23XX(isp)	((isp)->isp_type >= ISP_HA_FC_2300 && \
715 				(isp)->isp_type < ISP_HA_FC_2400)
716 #define	IS_2300(isp)	((isp)->isp_type == ISP_HA_FC_2300)
717 #define	IS_2312(isp)	((isp)->isp_type == ISP_HA_FC_2312)
718 #define	IS_2322(isp)	((isp)->isp_type == ISP_HA_FC_2322)
719 #define	IS_24XX(isp)	((isp)->isp_type >= ISP_HA_FC_2400)
720 
721 /*
722  * DMA related macros
723  */
724 #define	DMA_WD3(x)	(((uint16_t)(((uint64_t)x) >> 48)) & 0xffff)
725 #define	DMA_WD2(x)	(((uint16_t)(((uint64_t)x) >> 32)) & 0xffff)
726 #define	DMA_WD1(x)	((uint16_t)((x) >> 16) & 0xffff)
727 #define	DMA_WD0(x)	((uint16_t)((x) & 0xffff))
728 
729 #define	DMA_LO32(x)	((uint32_t) (x))
730 #define	DMA_HI32(x)	((uint32_t)(((uint64_t)x) >> 32))
731 
732 /*
733  * Core System Function Prototypes
734  */
735 
736 /*
737  * Reset Hardware. Totally. Assumes that you'll follow this with
738  * a call to isp_init.
739  */
740 void isp_reset(ispsoftc_t *);
741 
742 /*
743  * Initialize Hardware to known state
744  */
745 void isp_init(ispsoftc_t *);
746 
747 /*
748  * Reset the ISP and call completion for any orphaned commands.
749  */
750 void isp_reinit(ispsoftc_t *);
751 
752 #ifdef	ISP_FW_CRASH_DUMP
753 /*
754  * Dump firmware entry point.
755  */
756 void isp_fw_dump(ispsoftc_t *isp);
757 #endif
758 
759 /*
760  * Internal Interrupt Service Routine
761  *
762  * The outer layers do the spade work to get the appropriate status register,
763  * semaphore register and first mailbox register (if appropriate). This also
764  * means that most spurious/bogus interrupts not for us can be filtered first.
765  */
766 void isp_intr(ispsoftc_t *, uint32_t, uint16_t, uint16_t);
767 
768 
769 /*
770  * Command Entry Point- Platform Dependent layers call into this
771  */
772 int isp_start(XS_T *);
773 
774 /* these values are what isp_start returns */
775 #define	CMD_COMPLETE	101	/* command completed */
776 #define	CMD_EAGAIN	102	/* busy- maybe retry later */
777 #define	CMD_QUEUED	103	/* command has been queued for execution */
778 #define	CMD_RQLATER 	104	/* requeue this command later */
779 
780 /*
781  * Command Completion Point- Core layers call out from this with completed cmds
782  */
783 void isp_done(XS_T *);
784 
785 /*
786  * Platform Dependent to External to Internal Control Function
787  *
788  * Assumes locks are held on entry. You should note that with many of
789  * these commands and locks may be released while this is occurring.
790  *
791  * A few notes about some of these functions:
792  *
793  * ISPCTL_FCLINK_TEST tests to make sure we have good fibre channel link.
794  * The argument is a pointer to an integer which is the time, in microseconds,
795  * we should wait to see whether we have good link. This test, if successful,
796  * lets us know our connection topology and our Loop ID/AL_PA and so on.
797  * You can't get anywhere without this.
798  *
799  * ISPCTL_SCAN_FABRIC queries the name server (if we're on a fabric) for
800  * all entities using the FC Generic Services subcommand GET ALL NEXT.
801  * For each found entity, an ISPASYNC_FABRICDEV event is generated (see
802  * below).
803  *
804  * ISPCTL_SCAN_LOOP does a local loop scan. This is only done if the connection
805  * topology is NL or FL port (private or public loop). Since the Qlogic f/w
806  * 'automatically' manages local loop connections, this function essentially
807  * notes the arrival, departure, and possible shuffling around of local loop
808  * entities. Thus for each arrival and departure this generates an isp_async
809  * event of ISPASYNC_PROMENADE (see below).
810  *
811  * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in
812  * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP.
813  * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging
814  * and logging out of fabric devices (if one is on a fabric) and then marking
815  * the 'loop state' as being ready to now be used for sending commands to
816  * devices. Originally fabric name server and local loop scanning were
817  * part of this function. It's now been separated to allow for finer control.
818  */
819 typedef enum {
820 	ISPCTL_RESET_BUS,		/* Reset Bus */
821 	ISPCTL_RESET_DEV,		/* Reset Device */
822 	ISPCTL_ABORT_CMD,		/* Abort Command */
823 	ISPCTL_UPDATE_PARAMS,		/* Update Operating Parameters (SCSI) */
824 	ISPCTL_FCLINK_TEST,		/* Test FC Link Status */
825 	ISPCTL_SCAN_FABRIC,		/* (Re)scan Fabric Name Server */
826 	ISPCTL_SCAN_LOOP,		/* (Re)scan Local Loop */
827 	ISPCTL_PDB_SYNC,		/* Synchronize Port Database */
828 	ISPCTL_SEND_LIP,		/* Send a LIP */
829 	ISPCTL_GET_PORTNAME,		/* get portname from an N-port handle */
830 	ISPCTL_RUN_MBOXCMD,		/* run a mailbox command */
831 	ISPCTL_TOGGLE_TMODE,		/* toggle target mode */
832 	ISPCTL_GET_PDB,			/* get a single port database entry */
833 	ISPCTL_PLOGX			/* do a port login/logout */
834 } ispctl_t;
835 int isp_control(ispsoftc_t *, ispctl_t, void *);
836 
837 
838 /*
839  * Platform Dependent to Internal to External Control Function
840  * (each platform must provide such a function)
841  *
842  * Assumes locks are held.
843  *
844  * A few notes about some of these functions:
845  *
846  * ISPASYNC_CHANGE_NOTIFY notifies the outer layer that a change has
847  * occurred that invalidates the list of fabric devices known and/or
848  * the list of known loop devices. The argument passed is a pointer
849  * whose values are defined below  (local loop change, name server
850  * change, other). 'Other' may simply be a LIP, or a change in
851  * connection topology.
852  *
853  * ISPASYNC_FABRIC_DEV announces the next element in a list of
854  * fabric device names we're getting out of the name server. The
855  * argument points to a GET ALL NEXT response structure. The list
856  * is known to terminate with an entry that refers to ourselves.
857  * One of the main purposes of this function is to allow outer
858  * layers, which are OS dependent, to set policy as to which fabric
859  * devices might actually be logged into (and made visible) later
860  * at ISPCTL_PDB_SYNC time. Since there's a finite number of fabric
861  * devices that we can log into (256 less 3 'reserved' for F-port
862  * topologies), and fabrics can grow up to 8 million or so entries
863  * (24 bits of Port Address, less a wad of reserved spaces), clearly
864  * we had better let the OS determine login policy.
865  *
866  * ISPASYNC_PROMENADE has an argument that is a pointer to an integer which
867  * is an index into the portdb in the softc ('target'). Whether that entry's
868  * valid tag is set or not says whether something has arrived or departed.
869  * The name refers to a favorite pastime of many city dwellers- watching
870  * people come and go, talking of Michaelangelo, and so on..
871  *
872  * ISPASYNC_UNHANDLED_RESPONSE gives outer layers a chance to parse a
873  * response queue entry not otherwise handled. The outer layer should
874  * return non-zero if it handled it. The 'arg' points to an unmassaged
875  * response queue entry.
876  */
877 
878 typedef enum {
879 	ISPASYNC_NEW_TGT_PARAMS,	/* New Target Parameters Negotiated */
880 	ISPASYNC_BUS_RESET,		/* Bus Was Reset */
881 	ISPASYNC_LOOP_DOWN,		/* FC Loop Down */
882 	ISPASYNC_LOOP_UP,		/* FC Loop Up */
883 	ISPASYNC_LIP,			/* LIP Received */
884 	ISPASYNC_LOOP_RESET,		/* Loop Reset Received */
885 	ISPASYNC_CHANGE_NOTIFY,		/* FC Change Notification */
886 	ISPASYNC_DEV_ARRIVED,		/* FC Device Arrival */
887 	ISPASYNC_DEV_CHANGED,		/* FC Device Change */
888 	ISPASYNC_DEV_STAYED,		/* FC Device Stayed the Same */
889 	ISPASYNC_DEV_GONE,		/* FC Device Depart */
890 	ISPASYNC_TARGET_NOTIFY,		/* target asynchronous notification event */
891 	ISPASYNC_TARGET_ACTION,		/* target action requested */
892 	ISPASYNC_CONF_CHANGE,		/* Platform Configuration Change */
893 	ISPASYNC_UNHANDLED_RESPONSE,	/* Unhandled Response Entry */
894 	ISPASYNC_FW_CRASH,		/* Firmware has crashed */
895 	ISPASYNC_FW_DUMPED,		/* Firmware crashdump taken */
896 	ISPASYNC_FW_RESTARTED		/* Firmware has been restarted */
897 } ispasync_t;
898 int isp_async(ispsoftc_t *, ispasync_t, void *);
899 
900 #define	ISPASYNC_CHANGE_PDB	((void *) 0)
901 #define	ISPASYNC_CHANGE_SNS	((void *) 1)
902 #define	ISPASYNC_CHANGE_OTHER	((void *) 2)
903 
904 /*
905  * Platform Dependent Error and Debug Printout
906  *
907  * Generally this is:
908  *
909  *    void isp_prt(ispsoftc_t *, int level, const char *, ...)
910  *
911  * but due to compiler differences on different platforms this won't be
912  * formally done here. Instead, it goes in each platform definition file.
913  */
914 
915 #define	ISP_LOGALL	0x0	/* log always */
916 #define	ISP_LOGCONFIG	0x1	/* log configuration messages */
917 #define	ISP_LOGINFO	0x2	/* log informational messages */
918 #define	ISP_LOGWARN	0x4	/* log warning messages */
919 #define	ISP_LOGERR	0x8	/* log error messages */
920 #define	ISP_LOGDEBUG0	0x10	/* log simple debug messages */
921 #define	ISP_LOGDEBUG1	0x20	/* log intermediate debug messages */
922 #define	ISP_LOGDEBUG2	0x40	/* log most debug messages */
923 #define	ISP_LOGDEBUG3	0x80	/* log high frequency debug messages */
924 #define	ISP_LOGSANCFG	0x100	/* log SAN configuration */
925 #define	ISP_LOGTDEBUG0	0x200	/* log simple debug messages (target mode) */
926 #define	ISP_LOGTDEBUG1	0x400	/* log intermediate debug messages (target) */
927 #define	ISP_LOGTDEBUG2	0x800	/* log all debug messages (target) */
928 
929 /*
930  * Each Platform provides it's own isposinfo substructure of the ispsoftc
931  * defined above.
932  *
933  * Each platform must also provide the following macros/defines:
934  *
935  *
936  *	ISP2100_SCRLEN	-	length for the Fibre Channel scratch DMA area
937  *
938  *	MEMZERO(dst, src)			platform zeroing function
939  *	MEMCPY(dst, src, count)			platform copying function
940  *	SNPRINTF(buf, bufsize, fmt, ...)	snprintf
941  *	USEC_DELAY(usecs)			microsecond spindelay function
942  *	USEC_SLEEP(isp, usecs)			microsecond sleep function
943  *
944  *	NANOTIME_T				nanosecond time type
945  *
946  *	GET_NANOTIME(NANOTIME_T *)		get current nanotime.
947  *
948  *	GET_NANOSEC(NANOTIME_T *)		get uint64_t from NANOTIME_T
949  *
950  *	NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
951  *						subtract two NANOTIME_T values
952  *
953  *
954  *	MAXISPREQUEST(ispsoftc_t *)	maximum request queue size
955  *						for this particular board type
956  *
957  *	MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size)
958  *
959  *		Function/Macro the provides memory synchronization on
960  *		various objects so that the ISP's and the system's view
961  *		of the same object is consistent.
962  *
963  *	MBOX_ACQUIRE(ispsoftc_t *)		acquire lock on mailbox regs
964  *	MBOX_WAIT_COMPLETE(ispsoftc_t *, mbreg_t *) wait for cmd to be done
965  *	MBOX_NOTIFY_COMPLETE(ispsoftc_t *)	notification of mbox cmd donee
966  *	MBOX_RELEASE(ispsoftc_t *)		release lock on mailbox regs
967  *
968  *	FC_SCRATCH_ACQUIRE(ispsoftc_t *)	acquire lock on FC scratch area
969  *	FC_SCRATCH_RELEASE(ispsoftc_t *)	acquire lock on FC scratch area
970  *
971  *	SCSI_GOOD	SCSI 'Good' Status
972  *	SCSI_CHECK	SCSI 'Check Condition' Status
973  *	SCSI_BUSY	SCSI 'Busy' Status
974  *	SCSI_QFULL	SCSI 'Queue Full' Status
975  *
976  *	XS_T		Platform SCSI transaction type (i.e., command for HBA)
977  *	XS_DMA_ADDR_T	Platform PCI DMA Address Type
978  *	XS_ISP(xs)	gets an instance out of an XS_T
979  *	XS_CHANNEL(xs)	gets the channel (bus # for DUALBUS cards) ""
980  *	XS_TGT(xs)	gets the target ""
981  *	XS_LUN(xs)	gets the lun ""
982  *	XS_CDBP(xs)	gets a pointer to the scsi CDB ""
983  *	XS_CDBLEN(xs)	gets the CDB's length ""
984  *	XS_XFRLEN(xs)	gets the associated data transfer length ""
985  *	XS_TIME(xs)	gets the time (in milliseconds) for this command
986  *	XS_RESID(xs)	gets the current residual count
987  *	XS_STSP(xs)	gets a pointer to the SCSI status byte ""
988  *	XS_SNSP(xs)	gets a pointer to the associate sense data
989  *	XS_SNSLEN(xs)	gets the length of sense data storage
990  *	XS_SNSKEY(xs)	dereferences XS_SNSP to get the current stored Sense Key
991  *	XS_TAG_P(xs)	predicate of whether this command should be tagged
992  *	XS_TAG_TYPE(xs)	which type of tag to use
993  *	XS_SETERR(xs)	set error state
994  *
995  *		HBA_NOERROR	command has no erros
996  *		HBA_BOTCH	hba botched something
997  *		HBA_CMDTIMEOUT	command timed out
998  *		HBA_SELTIMEOUT	selection timed out (also port logouts for FC)
999  *		HBA_TGTBSY	target returned a BUSY status
1000  *		HBA_BUSRESET	bus reset destroyed command
1001  *		HBA_ABORTED	command was aborted (by request)
1002  *		HBA_DATAOVR	a data overrun was detected
1003  *		HBA_ARQFAIL	Automatic Request Sense failed
1004  *
1005  *	XS_ERR(xs)	return current error state
1006  *	XS_NOERR(xs)	there is no error currently set
1007  *	XS_INITERR(xs)	initialize error state
1008  *
1009  *	XS_SAVE_SENSE(xs, sp, len)	save sense data
1010  *
1011  *	XS_SET_STATE_STAT(isp, sp, xs)	platform dependent interpreter of
1012  *					response queue entry status bits
1013  *
1014  *
1015  *	DEFAULT_IID(ispsoftc_t *)		Default SCSI initiator ID
1016  *	DEFAULT_LOOPID(ispsoftc_t *)		Default FC Loop ID
1017  *	DEFAULT_NODEWWN(ispsoftc_t *)		Default Node WWN
1018  *	DEFAULT_PORTWWN(ispsoftc_t *)		Default Port WWN
1019  *	DEFAULT_FRAMESIZE(ispsoftc_t *)		Default Frame Size
1020  *	DEFAULT_EXEC_THROTTLE(ispsoftc_t *) Default Execution Throttle
1021  *		These establish reasonable defaults for each platform.
1022  * 		These must be available independent of card NVRAM and are
1023  *		to be used should NVRAM not be readable.
1024  *
1025  *	ISP_NODEWWN(ispsoftc_t *)		FC Node WWN to use
1026  *	ISP_PORTWWN(ispsoftc_t *)		FC Port WWN to use
1027  *
1028  *		These are to be used after NVRAM is read. The tags
1029  *		in fcparam.isp_ww{n,p}n_nvram reflect the values
1030  *		read from NVRAM (possibly corrected for card botches).
1031  *		Each platform can take that information and override
1032  *		it or ignore and return the Node and Port WWNs to be
1033  * 		used when sending the Qlogic f/w the Initialization
1034  *		Control Block.
1035  *
1036  *	(XXX these do endian specific transformations- in transition XXX)
1037  *
1038  *	ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr)
1039  *	ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr)
1040  *	ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr)
1041  *
1042  *	ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval)
1043  *	ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval)
1044  *	ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval)
1045  *
1046  *	ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *)
1047  *	ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *)
1048  *	ISP_SWAP16(ispsoftc_t *, uint16_t srcval)
1049  *	ISP_SWAP32(ispsoftc_t *, uint32_t srcval)
1050  */
1051 
1052 #endif	/* _ISPVAR_H */
1053