Home | History | Annotate | Line # | Download | only in ic
ispvar.h revision 1.25.2.4
      1  1.25.2.2   bouyer /* $NetBSD: ispvar.h,v 1.25.2.4 2001/01/18 09:23:20 bouyer Exp $ */
      2  1.25.2.1   bouyer /*
      3  1.25.2.1   bouyer  * This driver, which is contained in NetBSD in the files:
      4  1.25.2.1   bouyer  *
      5  1.25.2.1   bouyer  *	sys/dev/ic/isp.c
      6  1.25.2.3   bouyer  *	sys/dev/ic/isp_inline.h
      7  1.25.2.3   bouyer  *	sys/dev/ic/isp_netbsd.c
      8  1.25.2.3   bouyer  *	sys/dev/ic/isp_netbsd.h
      9  1.25.2.3   bouyer  *	sys/dev/ic/isp_target.c
     10  1.25.2.3   bouyer  *	sys/dev/ic/isp_target.h
     11  1.25.2.3   bouyer  *	sys/dev/ic/isp_tpublic.h
     12  1.25.2.3   bouyer  *	sys/dev/ic/ispmbox.h
     13  1.25.2.3   bouyer  *	sys/dev/ic/ispreg.h
     14  1.25.2.3   bouyer  *	sys/dev/ic/ispvar.h
     15  1.25.2.1   bouyer  *	sys/microcode/isp/asm_sbus.h
     16  1.25.2.1   bouyer  *	sys/microcode/isp/asm_1040.h
     17  1.25.2.1   bouyer  *	sys/microcode/isp/asm_1080.h
     18  1.25.2.1   bouyer  *	sys/microcode/isp/asm_12160.h
     19  1.25.2.1   bouyer  *	sys/microcode/isp/asm_2100.h
     20  1.25.2.1   bouyer  *	sys/microcode/isp/asm_2200.h
     21  1.25.2.1   bouyer  *	sys/pci/isp_pci.c
     22  1.25.2.1   bouyer  *	sys/sbus/isp_sbus.c
     23  1.25.2.1   bouyer  *
     24  1.25.2.1   bouyer  * Is being actively maintained by Matthew Jacob (mjacob (at) netbsd.org).
     25  1.25.2.1   bouyer  * This driver also is shared source with FreeBSD, OpenBSD, Linux, Solaris,
     26  1.25.2.1   bouyer  * Linux versions. This tends to be an interesting maintenance problem.
     27  1.25.2.1   bouyer  *
     28  1.25.2.1   bouyer  * Please coordinate with Matthew Jacob on changes you wish to make here.
     29  1.25.2.1   bouyer  */
     30       1.1      cgd /*
     31      1.24   mjacob  * Copyright (C) 1999 National Aeronautics & Space Administration
     32      1.23   mjacob  * All rights reserved.
     33       1.1      cgd  *
     34       1.1      cgd  * Redistribution and use in source and binary forms, with or without
     35       1.1      cgd  * modification, are permitted provided that the following conditions
     36       1.1      cgd  * are met:
     37       1.1      cgd  * 1. Redistributions of source code must retain the above copyright
     38      1.23   mjacob  *    notice, this list of conditions and the following disclaimer.
     39       1.1      cgd  * 2. Redistributions in binary form must reproduce the above copyright
     40       1.1      cgd  *    notice, this list of conditions and the following disclaimer in the
     41       1.1      cgd  *    documentation and/or other materials provided with the distribution.
     42       1.1      cgd  * 3. The name of the author may not be used to endorse or promote products
     43      1.23   mjacob  *    derived from this software without specific prior written permission
     44       1.9   mjacob  *
     45      1.23   mjacob  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     46      1.23   mjacob  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     47      1.23   mjacob  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     48      1.23   mjacob  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     49      1.23   mjacob  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     50      1.23   mjacob  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     51      1.23   mjacob  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     52      1.23   mjacob  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     53      1.23   mjacob  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     54      1.23   mjacob  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     55       1.1      cgd  */
     56       1.2      cgd 
     57      1.23   mjacob /*
     58      1.23   mjacob  * Soft Definitions for for Qlogic ISP SCSI adapters.
     59      1.23   mjacob  * Matthew Jacob <mjacob (at) nas.nasa.gov>
     60      1.23   mjacob  */
     61       1.1      cgd #ifndef	_ISPVAR_H
     62       1.1      cgd #define	_ISPVAR_H
     63       1.1      cgd 
     64      1.19   mjacob #if defined(__NetBSD__) || defined(__OpenBSD__)
     65       1.1      cgd #include <dev/ic/ispmbox.h>
     66  1.25.2.1   bouyer #ifdef	ISP_TARGET_MODE
     67  1.25.2.1   bouyer #include <dev/ic/isp_target.h>
     68  1.25.2.1   bouyer #include <dev/ic/isp_tpublic.h>
     69  1.25.2.1   bouyer #endif
     70       1.9   mjacob #endif
     71       1.9   mjacob #ifdef	__FreeBSD__
     72       1.9   mjacob #include <dev/isp/ispmbox.h>
     73  1.25.2.1   bouyer #ifdef	ISP_TARGET_MODE
     74  1.25.2.1   bouyer #include <dev/isp/isp_target.h>
     75  1.25.2.1   bouyer #include <dev/isp/isp_tpublic.h>
     76  1.25.2.1   bouyer #endif
     77       1.9   mjacob #endif
     78       1.9   mjacob #ifdef	__linux__
     79      1.15   mjacob #include "ispmbox.h"
     80  1.25.2.1   bouyer #ifdef	ISP_TARGET_MODE
     81  1.25.2.1   bouyer #include "isp_target.h"
     82  1.25.2.1   bouyer #include "isp_tpublic.h"
     83  1.25.2.1   bouyer #endif
     84       1.9   mjacob #endif
     85       1.1      cgd 
     86  1.25.2.1   bouyer #define	ISP_CORE_VERSION_MAJOR	2
     87  1.25.2.1   bouyer #define	ISP_CORE_VERSION_MINOR	0
     88      1.10   mjacob 
     89       1.1      cgd /*
     90      1.17   mjacob  * Vector for bus specific code to provide specific services.
     91       1.1      cgd  */
     92       1.1      cgd struct ispsoftc;
     93       1.1      cgd struct ispmdvec {
     94       1.1      cgd 	u_int16_t	(*dv_rd_reg) __P((struct ispsoftc *, int));
     95       1.1      cgd 	void		(*dv_wr_reg) __P((struct ispsoftc *, int, u_int16_t));
     96       1.5  thorpej 	int		(*dv_mbxdma) __P((struct ispsoftc *));
     97       1.1      cgd 	int		(*dv_dmaset) __P((struct ispsoftc *,
     98  1.25.2.1   bouyer 		XS_T *, ispreq_t *, u_int16_t *, u_int16_t));
     99       1.1      cgd 	void		(*dv_dmaclr)
    100  1.25.2.1   bouyer 		__P((struct ispsoftc *, XS_T *, u_int32_t));
    101       1.1      cgd 	void		(*dv_reset0) __P((struct ispsoftc *));
    102       1.1      cgd 	void		(*dv_reset1) __P((struct ispsoftc *));
    103  1.25.2.1   bouyer 	void		(*dv_dregs) __P((struct ispsoftc *, const char *));
    104  1.25.2.1   bouyer 	const u_int16_t	*dv_ispfw;	/* ptr to f/w */
    105       1.1      cgd 	u_int16_t	dv_conf1;
    106       1.4   mjacob 	u_int16_t	dv_clock;	/* clock frequency */
    107       1.1      cgd };
    108       1.1      cgd 
    109  1.25.2.1   bouyer /*
    110  1.25.2.1   bouyer  * Overall parameters
    111  1.25.2.1   bouyer  */
    112       1.1      cgd #define	MAX_TARGETS	16
    113      1.19   mjacob #ifdef	ISP2100_FABRIC
    114      1.19   mjacob #define	MAX_FC_TARG	256
    115      1.19   mjacob #else
    116       1.6   mjacob #define	MAX_FC_TARG	126
    117      1.19   mjacob #endif
    118       1.1      cgd 
    119      1.24   mjacob #define	ISP_MAX_TARGETS(isp)	(IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
    120  1.25.2.1   bouyer #define	ISP_MAX_LUNS(isp)	(isp)->isp_maxluns
    121  1.25.2.1   bouyer 
    122  1.25.2.1   bouyer 
    123  1.25.2.1   bouyer /*
    124  1.25.2.1   bouyer  * Macros to access ISP registers through bus specific layers-
    125  1.25.2.1   bouyer  * mostly wrappers to vector through the mdvec structure.
    126  1.25.2.1   bouyer  */
    127  1.25.2.1   bouyer 
    128  1.25.2.1   bouyer #define	ISP_READ(isp, reg)	\
    129  1.25.2.1   bouyer 	(*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
    130  1.25.2.1   bouyer 
    131  1.25.2.1   bouyer #define	ISP_WRITE(isp, reg, val)	\
    132  1.25.2.1   bouyer 	(*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
    133      1.24   mjacob 
    134  1.25.2.1   bouyer #define	ISP_MBOXDMASETUP(isp)	\
    135  1.25.2.1   bouyer 	(*(isp)->isp_mdvec->dv_mbxdma)((isp))
    136  1.25.2.1   bouyer 
    137  1.25.2.1   bouyer #define	ISP_DMASETUP(isp, xs, req, iptrp, optr)	\
    138  1.25.2.1   bouyer 	(*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr))
    139  1.25.2.1   bouyer 
    140  1.25.2.1   bouyer #define	ISP_DMAFREE(isp, xs, hndl)	\
    141  1.25.2.1   bouyer 	if ((isp)->isp_mdvec->dv_dmaclr) \
    142  1.25.2.1   bouyer 	    (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
    143  1.25.2.1   bouyer 
    144  1.25.2.1   bouyer #define	ISP_RESET0(isp)	\
    145  1.25.2.1   bouyer 	if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
    146  1.25.2.1   bouyer #define	ISP_RESET1(isp)	\
    147  1.25.2.1   bouyer 	if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
    148  1.25.2.1   bouyer #define	ISP_DUMPREGS(isp, m)	\
    149  1.25.2.1   bouyer 	if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m))
    150  1.25.2.1   bouyer 
    151  1.25.2.1   bouyer #define	ISP_SETBITS(isp, reg, val)	\
    152  1.25.2.1   bouyer  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
    153  1.25.2.1   bouyer 
    154  1.25.2.1   bouyer #define	ISP_CLRBITS(isp, reg, val)	\
    155  1.25.2.1   bouyer  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
    156  1.25.2.1   bouyer 
    157  1.25.2.1   bouyer /*
    158  1.25.2.1   bouyer  * The MEMORYBARRIER macro is defined per platform (to provide synchronization
    159  1.25.2.1   bouyer  * on Request and Response Queues, Scratch DMA areas, and Registers)
    160  1.25.2.1   bouyer  *
    161  1.25.2.1   bouyer  * Defined Memory Barrier Synchronization Types
    162  1.25.2.1   bouyer  */
    163  1.25.2.1   bouyer #define	SYNC_REQUEST	0	/* request queue synchronization */
    164  1.25.2.1   bouyer #define	SYNC_RESULT	1	/* result queue synchronization */
    165  1.25.2.1   bouyer #define	SYNC_SFORDEV	2	/* scratch, sync for ISP */
    166  1.25.2.1   bouyer #define	SYNC_SFORCPU	3	/* scratch, sync for CPU */
    167  1.25.2.1   bouyer #define	SYNC_REG	4	/* for registers */
    168  1.25.2.1   bouyer 
    169  1.25.2.1   bouyer /*
    170  1.25.2.1   bouyer  * Request/Response Queue defines and macros.
    171  1.25.2.1   bouyer  * The maximum is defined per platform (and can be based on board type).
    172  1.25.2.1   bouyer  */
    173  1.25.2.1   bouyer /* This is the size of a queue entry (request and response) */
    174      1.11   mjacob #define	QENTRY_LEN			64
    175  1.25.2.1   bouyer /* Both request and result queue length must be a power of two */
    176  1.25.2.1   bouyer #define	RQUEST_QUEUE_LEN(x)		MAXISPREQUEST(x)
    177  1.25.2.1   bouyer #define	RESULT_QUEUE_LEN(x)		\
    178  1.25.2.1   bouyer 	(((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2)
    179      1.11   mjacob #define	ISP_QUEUE_ENTRY(q, idx)		((q) + ((idx) * QENTRY_LEN))
    180      1.11   mjacob #define	ISP_QUEUE_SIZE(n)		((n) * QENTRY_LEN)
    181      1.11   mjacob #define	ISP_NXT_QENTRY(idx, qlen)	(((idx) + 1) & ((qlen)-1))
    182  1.25.2.1   bouyer #define	ISP_QFREE(in, out, qlen)	\
    183      1.13   mjacob 	((in == out)? (qlen - 1) : ((in > out)? \
    184      1.25   mjacob 	((qlen - 1) - (in - out)) : (out - in - 1)))
    185  1.25.2.1   bouyer #define	ISP_QAVAIL(isp)	\
    186  1.25.2.1   bouyer 	ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp))
    187  1.25.2.1   bouyer 
    188  1.25.2.1   bouyer #define	ISP_ADD_REQUEST(isp, iptr)	\
    189  1.25.2.1   bouyer 	MEMORYBARRIER(isp, SYNC_REQUEST, iptr, QENTRY_LEN); \
    190  1.25.2.1   bouyer 	ISP_WRITE(isp, INMAILBOX4, iptr); \
    191  1.25.2.1   bouyer 	isp->isp_reqidx = iptr
    192  1.25.2.1   bouyer 
    193       1.1      cgd /*
    194      1.22   mjacob  * SCSI Specific Host Adapter Parameters- per bus, per target
    195       1.6   mjacob  */
    196       1.6   mjacob 
    197       1.6   mjacob typedef struct {
    198      1.22   mjacob 	u_int		isp_gotdparms		: 1,
    199      1.25   mjacob 			isp_req_ack_active_neg	: 1,
    200      1.25   mjacob 			isp_data_line_active_neg: 1,
    201       1.6   mjacob 			isp_cmd_dma_burst_enable: 1,
    202       1.6   mjacob 			isp_data_dma_burst_enabl: 1,
    203      1.16   mjacob 			isp_fifo_threshold	: 3,
    204      1.17   mjacob 			isp_ultramode		: 1,
    205       1.6   mjacob 			isp_diffmode		: 1,
    206      1.20   mjacob 			isp_lvdmode		: 1,
    207  1.25.2.1   bouyer 			isp_fast_mttr		: 1,	/* fast sram */
    208       1.6   mjacob 			isp_initiator_id	: 4,
    209      1.25   mjacob 			isp_async_data_setup	: 4;
    210      1.25   mjacob 	u_int16_t	isp_selection_timeout;
    211      1.25   mjacob 	u_int16_t	isp_max_queue_depth;
    212       1.6   mjacob 	u_int8_t	isp_tag_aging;
    213      1.25   mjacob 	u_int8_t	isp_bus_reset_delay;
    214      1.25   mjacob 	u_int8_t	isp_retry_count;
    215      1.25   mjacob 	u_int8_t	isp_retry_delay;
    216       1.6   mjacob 	struct {
    217      1.22   mjacob 		u_int	dev_enable	:	1,	/* ignored */
    218      1.22   mjacob 					:	1,
    219      1.17   mjacob 			dev_update	:	1,
    220      1.17   mjacob 			dev_refresh	:	1,
    221      1.20   mjacob 			exc_throttle	:	8,
    222      1.20   mjacob 			cur_offset	:	4,
    223      1.20   mjacob 			sync_offset	:	4;
    224      1.20   mjacob 		u_int8_t	cur_period;	/* current sync period */
    225      1.20   mjacob 		u_int8_t	sync_period;	/* goal sync period */
    226      1.20   mjacob 		u_int16_t	dev_flags;	/* goal device flags */
    227      1.20   mjacob 		u_int16_t	cur_dflags;	/* current device flags */
    228       1.6   mjacob 	} isp_devparam[MAX_TARGETS];
    229      1.22   mjacob } sdparam;
    230       1.6   mjacob 
    231       1.6   mjacob /*
    232       1.6   mjacob  * Device Flags
    233       1.6   mjacob  */
    234      1.11   mjacob #define	DPARM_DISC	0x8000
    235      1.11   mjacob #define	DPARM_PARITY	0x4000
    236      1.11   mjacob #define	DPARM_WIDE	0x2000
    237      1.11   mjacob #define	DPARM_SYNC	0x1000
    238      1.11   mjacob #define	DPARM_TQING	0x0800
    239      1.11   mjacob #define	DPARM_ARQ	0x0400
    240      1.11   mjacob #define	DPARM_QFRZ	0x0200
    241      1.11   mjacob #define	DPARM_RENEG	0x0100
    242  1.25.2.1   bouyer #define	DPARM_NARROW	0x0080
    243  1.25.2.1   bouyer #define	DPARM_ASYNC	0x0040
    244  1.25.2.1   bouyer #define	DPARM_PPR	0x0020
    245      1.18   mjacob #define	DPARM_DEFAULT	(0xFF00 & ~DPARM_QFRZ)
    246      1.11   mjacob #define	DPARM_SAFE_DFLT	(DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING))
    247      1.11   mjacob 
    248       1.6   mjacob 
    249      1.20   mjacob /* technically, not really correct, as they need to be rated based upon clock */
    250  1.25.2.1   bouyer #define	ISP_80M_SYNCPARMS	0x0c09
    251  1.25.2.1   bouyer #define	ISP_40M_SYNCPARMS	0x0c0a
    252  1.25.2.1   bouyer #define	ISP_20M_SYNCPARMS	0x0c0c
    253  1.25.2.1   bouyer #define	ISP_20M_SYNCPARMS_1040	0x080c
    254      1.25   mjacob #define	ISP_10M_SYNCPARMS	0x0c19
    255      1.25   mjacob #define	ISP_08M_SYNCPARMS	0x0c25
    256      1.25   mjacob #define	ISP_05M_SYNCPARMS	0x0c32
    257      1.25   mjacob #define	ISP_04M_SYNCPARMS	0x0c41
    258       1.6   mjacob 
    259       1.6   mjacob /*
    260       1.6   mjacob  * Fibre Channel Specifics
    261       1.6   mjacob  */
    262      1.24   mjacob #define	FL_PORT_ID		0x7e	/* FL_Port Special ID */
    263      1.24   mjacob #define	FC_PORT_ID		0x7f	/* Fabric Controller Special ID */
    264      1.24   mjacob #define	FC_SNS_ID		0x80	/* SNS Server Special ID */
    265      1.24   mjacob 
    266       1.6   mjacob typedef struct {
    267      1.25   mjacob 	u_int32_t		isp_fwoptions	: 16,
    268  1.25.2.1   bouyer 						: 4,
    269      1.23   mjacob 				loop_seen_once	: 1,
    270      1.23   mjacob 				isp_loopstate	: 3,	/* Current Loop State */
    271      1.23   mjacob 				isp_fwstate	: 3,	/* ISP F/W state */
    272      1.23   mjacob 				isp_gotdparms	: 1,
    273  1.25.2.1   bouyer 				isp_topo	: 3,
    274      1.23   mjacob 				isp_onfabric	: 1;
    275      1.11   mjacob 	u_int8_t		isp_loopid;	/* hard loop id */
    276      1.11   mjacob 	u_int8_t		isp_alpa;	/* ALPA */
    277      1.25   mjacob 	volatile u_int16_t	isp_lipseq;	/* LIP sequence # */
    278      1.23   mjacob 	u_int32_t		isp_portid;
    279      1.11   mjacob 	u_int8_t		isp_execthrottle;
    280      1.25   mjacob 	u_int8_t		isp_retry_delay;
    281      1.25   mjacob 	u_int8_t		isp_retry_count;
    282      1.25   mjacob 	u_int8_t		isp_reserved;
    283      1.11   mjacob 	u_int16_t		isp_maxalloc;
    284      1.11   mjacob 	u_int16_t		isp_maxfrmlen;
    285      1.23   mjacob 	u_int64_t		isp_nodewwn;
    286      1.23   mjacob 	u_int64_t		isp_portwwn;
    287       1.6   mjacob 	/*
    288      1.23   mjacob 	 * Port Data Base. This is indexed by 'target', which is invariate.
    289      1.23   mjacob 	 * However, elements within can move around due to loop changes,
    290      1.23   mjacob 	 * so the actual loop ID passed to the F/W is in this structure.
    291      1.23   mjacob 	 * The first time the loop is seen up, loopid will match the index
    292      1.23   mjacob 	 * (except for fabric nodes which are above mapped above FC_SNS_ID
    293      1.23   mjacob 	 * and are completely virtual), but subsequent LIPs can cause things
    294      1.23   mjacob 	 * to move around.
    295      1.23   mjacob 	 */
    296      1.23   mjacob 	struct lportdb {
    297      1.25   mjacob 		u_int
    298  1.25.2.1   bouyer 					loopid		: 8,
    299  1.25.2.1   bouyer 							: 4,
    300  1.25.2.1   bouyer 					loggedin	: 1,
    301  1.25.2.1   bouyer 					roles		: 2,
    302  1.25.2.1   bouyer 					valid		: 1;
    303      1.25   mjacob 		u_int32_t		portid;
    304      1.23   mjacob 		u_int64_t		node_wwn;
    305      1.23   mjacob 		u_int64_t		port_wwn;
    306      1.24   mjacob 	} portdb[MAX_FC_TARG], tport[FL_PORT_ID];
    307      1.19   mjacob 
    308      1.19   mjacob 	/*
    309       1.6   mjacob 	 * Scratch DMA mapped in area to fetch Port Database stuff, etc.
    310       1.6   mjacob 	 */
    311      1.23   mjacob 	caddr_t			isp_scratch;
    312       1.6   mjacob 	u_int32_t		isp_scdma;
    313       1.6   mjacob } fcparam;
    314       1.6   mjacob 
    315      1.23   mjacob #define	FW_CONFIG_WAIT		0
    316      1.23   mjacob #define	FW_WAIT_AL_PA		1
    317      1.23   mjacob #define	FW_WAIT_LOGIN		2
    318      1.23   mjacob #define	FW_READY		3
    319      1.23   mjacob #define	FW_LOSS_OF_SYNC		4
    320      1.23   mjacob #define	FW_ERROR		5
    321      1.23   mjacob #define	FW_REINIT		6
    322      1.23   mjacob #define	FW_NON_PART		7
    323      1.23   mjacob 
    324      1.23   mjacob #define	LOOP_NIL		0
    325      1.23   mjacob #define	LOOP_LIP_RCVD		1
    326      1.23   mjacob #define	LOOP_PDB_RCVD		2
    327      1.23   mjacob #define	LOOP_READY		7
    328      1.23   mjacob 
    329  1.25.2.1   bouyer #define	TOPO_NL_PORT		0
    330  1.25.2.1   bouyer #define	TOPO_FL_PORT		1
    331  1.25.2.1   bouyer #define	TOPO_N_PORT		2
    332  1.25.2.1   bouyer #define	TOPO_F_PORT		3
    333  1.25.2.1   bouyer #define	TOPO_PTP_STUB		4
    334  1.25.2.1   bouyer 
    335       1.6   mjacob /*
    336       1.1      cgd  * Soft Structure per host adapter
    337       1.1      cgd  */
    338  1.25.2.1   bouyer typedef struct ispsoftc {
    339       1.9   mjacob 	/*
    340       1.9   mjacob 	 * Platform (OS) specific data
    341       1.9   mjacob 	 */
    342       1.9   mjacob 	struct isposinfo	isp_osinfo;
    343       1.9   mjacob 
    344       1.9   mjacob 	/*
    345  1.25.2.1   bouyer 	 * Pointer to bus specific functions and data
    346       1.9   mjacob 	 */
    347       1.1      cgd 	struct ispmdvec *	isp_mdvec;
    348       1.9   mjacob 
    349       1.9   mjacob 	/*
    350  1.25.2.1   bouyer 	 * (Mostly) nonvolatile state. Board specific parameters
    351  1.25.2.1   bouyer 	 * may contain some volatile state (e.g., current loop state).
    352       1.9   mjacob 	 */
    353       1.9   mjacob 
    354  1.25.2.1   bouyer 	void * 			isp_param;	/* type specific */
    355  1.25.2.1   bouyer 	u_int16_t		isp_fwrev[3];	/* Loaded F/W revision */
    356  1.25.2.1   bouyer 	u_int16_t		isp_romfw_rev[3]; /* PROM F/W revision */
    357  1.25.2.1   bouyer 	u_int16_t		isp_maxcmds;	/* max possible I/O cmds */
    358  1.25.2.1   bouyer 	u_int8_t		isp_type;	/* HBA Chip Type */
    359  1.25.2.1   bouyer 	u_int8_t		isp_revision;	/* HBA Chip H/W Revision */
    360  1.25.2.1   bouyer 	u_int32_t		isp_maxluns;	/* maximum luns supported */
    361  1.25.2.1   bouyer 
    362  1.25.2.1   bouyer 	u_int32_t
    363  1.25.2.1   bouyer 				isp_touched	: 1,	/* board ever seen? */
    364  1.25.2.1   bouyer 						: 1,
    365  1.25.2.1   bouyer 				isp_bustype	: 1,	/* SBus or PCI */
    366  1.25.2.1   bouyer 				isp_loaded_fw	: 1,	/* loaded firmware */
    367  1.25.2.1   bouyer 				isp_dblev	: 12,	/* debug log mask */
    368  1.25.2.1   bouyer 				isp_clock	: 8,	/* input clock */
    369  1.25.2.1   bouyer 				isp_confopts	: 8;	/* config options */
    370  1.25.2.2   bouyer 	/*
    371  1.25.2.2   bouyer 	 * Instrumentation
    372  1.25.2.2   bouyer 	 */
    373  1.25.2.2   bouyer 	u_int64_t		isp_intcnt;		/* total int count */
    374  1.25.2.2   bouyer 	u_int64_t		isp_intbogus;		/* spurious int count */
    375       1.6   mjacob 
    376       1.1      cgd 	/*
    377      1.11   mjacob 	 * Volatile state
    378       1.1      cgd 	 */
    379      1.11   mjacob 
    380  1.25.2.1   bouyer 	volatile u_int32_t
    381  1.25.2.1   bouyer 		isp_mboxbsy	:	8,	/* mailbox command active */
    382  1.25.2.1   bouyer 				:	1,
    383      1.11   mjacob 		isp_state	:	3,
    384      1.22   mjacob 		isp_sendmarker	:	2,	/* send a marker entry */
    385      1.22   mjacob 		isp_update	:	2,	/* update parameters */
    386      1.24   mjacob 		isp_nactive	:	16;	/* how many commands active */
    387      1.24   mjacob 	volatile u_int16_t	isp_reqodx;	/* index of last ISP pickup */
    388      1.24   mjacob 	volatile u_int16_t	isp_reqidx;	/* index of next request */
    389      1.24   mjacob 	volatile u_int16_t	isp_residx;	/* index of next result */
    390      1.24   mjacob 	volatile u_int16_t	isp_lasthdls;	/* last handle seed */
    391  1.25.2.1   bouyer 	volatile u_int16_t	isp_mboxtmp[MAX_MAILBOX];
    392       1.6   mjacob 
    393       1.1      cgd 	/*
    394  1.25.2.1   bouyer 	 * Active commands are stored here, indexed by handle functions.
    395       1.1      cgd 	 */
    396  1.25.2.1   bouyer 	XS_T **isp_xflist;
    397       1.6   mjacob 
    398       1.1      cgd 	/*
    399      1.24   mjacob 	 * request/result queue pointers and dma handles for them.
    400       1.1      cgd 	 */
    401      1.23   mjacob 	caddr_t			isp_rquest;
    402      1.23   mjacob 	caddr_t			isp_result;
    403       1.5  thorpej 	u_int32_t		isp_rquest_dma;
    404       1.5  thorpej 	u_int32_t		isp_result_dma;
    405  1.25.2.1   bouyer } ispsoftc_t;
    406      1.14   mjacob 
    407      1.24   mjacob #define	SDPARAM(isp)	((sdparam *) (isp)->isp_param)
    408      1.24   mjacob #define	FCPARAM(isp)	((fcparam *) (isp)->isp_param)
    409       1.1      cgd 
    410       1.1      cgd /*
    411  1.25.2.1   bouyer  * ISP Driver Run States
    412       1.9   mjacob  */
    413       1.9   mjacob #define	ISP_NILSTATE	0
    414       1.9   mjacob #define	ISP_RESETSTATE	1
    415       1.9   mjacob #define	ISP_INITSTATE	2
    416       1.9   mjacob #define	ISP_RUNSTATE	3
    417       1.9   mjacob 
    418       1.9   mjacob /*
    419       1.9   mjacob  * ISP Configuration Options
    420       1.9   mjacob  */
    421       1.9   mjacob #define	ISP_CFG_NORELOAD	0x80	/* don't download f/w */
    422      1.18   mjacob #define	ISP_CFG_NONVRAM		0x40	/* ignore NVRAM */
    423  1.25.2.3   bouyer #define	ISP_CFG_NOINIT		0x20	/* just set defaults- don't init */
    424  1.25.2.1   bouyer #define	ISP_CFG_FULL_DUPLEX	0x01	/* Full Duplex (Fibre Channel only) */
    425  1.25.2.1   bouyer #define	ISP_CFG_OWNWWN		0x02	/* override NVRAM wwn */
    426  1.25.2.2   bouyer #define	ISP_CFG_PORT_PREF	0x0C	/* Mask for Port Prefs (2200 only) */
    427  1.25.2.2   bouyer #define	ISP_CFG_LPORT		0x00	/* prefer {N/F}L-Port connection */
    428  1.25.2.2   bouyer #define	ISP_CFG_NPORT		0x04	/* prefer {N/F}-Port connection */
    429  1.25.2.2   bouyer #define	ISP_CFG_NPORT_ONLY	0x08	/* insist on {N/F}-Port connection */
    430  1.25.2.2   bouyer #define	ISP_CFG_LPORT_ONLY	0x0C	/* insist on {N/F}L-Port connection */
    431       1.9   mjacob 
    432  1.25.2.1   bouyer /*
    433  1.25.2.1   bouyer  * Firmware related defines
    434  1.25.2.1   bouyer  */
    435  1.25.2.1   bouyer #define	ISP_CODE_ORG		0x1000	/* default f/w code start */
    436      1.21   mjacob #define	ISP_FW_REV(maj, min, mic)	((maj << 24) | (min << 16) | mic)
    437      1.22   mjacob #define	ISP_FW_REVX(xp)	((xp[0]<<24) | (xp[1] << 16) | xp[2])
    438      1.11   mjacob 
    439       1.9   mjacob /*
    440      1.11   mjacob  * Bus (implementation) types
    441      1.11   mjacob  */
    442      1.11   mjacob #define	ISP_BT_PCI		0	/* PCI Implementations */
    443      1.11   mjacob #define	ISP_BT_SBUS		1	/* SBus Implementations */
    444      1.11   mjacob 
    445      1.11   mjacob /*
    446      1.11   mjacob  * Chip Types
    447       1.6   mjacob  */
    448       1.6   mjacob #define	ISP_HA_SCSI		0xf
    449      1.11   mjacob #define	ISP_HA_SCSI_UNKNOWN	0x1
    450      1.11   mjacob #define	ISP_HA_SCSI_1020	0x2
    451      1.11   mjacob #define	ISP_HA_SCSI_1020A	0x3
    452      1.11   mjacob #define	ISP_HA_SCSI_1040	0x4
    453      1.11   mjacob #define	ISP_HA_SCSI_1040A	0x5
    454      1.11   mjacob #define	ISP_HA_SCSI_1040B	0x6
    455      1.21   mjacob #define	ISP_HA_SCSI_1040C	0x7
    456  1.25.2.1   bouyer #define	ISP_HA_SCSI_1240	0x8
    457  1.25.2.1   bouyer #define	ISP_HA_SCSI_1080	0x9
    458  1.25.2.1   bouyer #define	ISP_HA_SCSI_1280	0xa
    459  1.25.2.1   bouyer #define	ISP_HA_SCSI_12160	0xb
    460       1.6   mjacob #define	ISP_HA_FC		0xf0
    461       1.6   mjacob #define	ISP_HA_FC_2100		0x10
    462      1.23   mjacob #define	ISP_HA_FC_2200		0x20
    463       1.6   mjacob 
    464      1.19   mjacob #define	IS_SCSI(isp)	(isp->isp_type & ISP_HA_SCSI)
    465  1.25.2.1   bouyer #define	IS_1240(isp)	(isp->isp_type == ISP_HA_SCSI_1240)
    466      1.19   mjacob #define	IS_1080(isp)	(isp->isp_type == ISP_HA_SCSI_1080)
    467  1.25.2.1   bouyer #define	IS_1280(isp)	(isp->isp_type == ISP_HA_SCSI_1280)
    468  1.25.2.1   bouyer #define	IS_12160(isp)	(isp->isp_type == ISP_HA_SCSI_12160)
    469  1.25.2.1   bouyer 
    470  1.25.2.1   bouyer #define	IS_12X0(isp)	(IS_1240(isp) || IS_1280(isp))
    471  1.25.2.1   bouyer #define	IS_DUALBUS(isp)	(IS_12X0(isp) || IS_12160(isp))
    472  1.25.2.1   bouyer #define	IS_ULTRA2(isp)	(IS_1080(isp) || IS_1280(isp) || IS_12160(isp))
    473  1.25.2.1   bouyer #define	IS_ULTRA3(isp)	(IS_12160(isp))
    474  1.25.2.1   bouyer 
    475      1.19   mjacob #define	IS_FC(isp)	(isp->isp_type & ISP_HA_FC)
    476  1.25.2.1   bouyer #define	IS_2100(isp)	(isp->isp_type == ISP_HA_FC_2100)
    477  1.25.2.1   bouyer #define	IS_2200(isp)	(isp->isp_type == ISP_HA_FC_2200)
    478      1.19   mjacob 
    479       1.6   mjacob /*
    480  1.25.2.1   bouyer  * DMA cookie macros
    481       1.1      cgd  */
    482  1.25.2.1   bouyer #define	DMA_MSW(x)	(((x) >> 16) & 0xffff)
    483  1.25.2.1   bouyer #define	DMA_LSW(x)	(((x) & 0xffff))
    484       1.1      cgd 
    485       1.1      cgd /*
    486  1.25.2.1   bouyer  * Core System Function Prototypes
    487       1.1      cgd  */
    488       1.9   mjacob 
    489       1.1      cgd /*
    490       1.9   mjacob  * Reset Hardware. Totally. Assumes that you'll follow this with
    491       1.9   mjacob  * a call to isp_init.
    492       1.1      cgd  */
    493       1.1      cgd void isp_reset __P((struct ispsoftc *));
    494       1.1      cgd 
    495       1.1      cgd /*
    496       1.1      cgd  * Initialize Hardware to known state
    497       1.1      cgd  */
    498       1.1      cgd void isp_init __P((struct ispsoftc *));
    499       1.1      cgd 
    500       1.1      cgd /*
    501      1.10   mjacob  * Reset the ISP and call completion for any orphaned commands.
    502      1.10   mjacob  */
    503  1.25.2.1   bouyer void isp_reinit __P((struct ispsoftc *));
    504       1.1      cgd 
    505       1.1      cgd /*
    506       1.1      cgd  * Interrupt Service Routine
    507       1.1      cgd  */
    508       1.1      cgd int isp_intr __P((void *));
    509       1.9   mjacob 
    510       1.9   mjacob /*
    511  1.25.2.1   bouyer  * Command Entry Point- Platform Dependent layers call into this
    512       1.9   mjacob  */
    513  1.25.2.1   bouyer int isp_start __P((XS_T *));
    514  1.25.2.1   bouyer /* these values are what isp_start returns */
    515  1.25.2.1   bouyer #define	CMD_COMPLETE	101	/* command completed */
    516  1.25.2.1   bouyer #define	CMD_EAGAIN	102	/* busy- maybe retry later */
    517  1.25.2.1   bouyer #define	CMD_QUEUED	103	/* command has been queued for execution */
    518  1.25.2.1   bouyer #define	CMD_RQLATER 	104	/* requeue this command later */
    519  1.25.2.1   bouyer 
    520  1.25.2.1   bouyer /*
    521  1.25.2.1   bouyer  * Command Completion Point- Core layers call out from this with completed cmds
    522  1.25.2.1   bouyer  */
    523  1.25.2.1   bouyer void isp_done __P((XS_T *));
    524       1.1      cgd 
    525       1.9   mjacob /*
    526      1.17   mjacob  * Platform Dependent to External to Internal Control Function
    527       1.9   mjacob  *
    528      1.23   mjacob  * Assumes all locks are held and that no reentrancy issues need be dealt with.
    529       1.9   mjacob  *
    530       1.9   mjacob  */
    531       1.9   mjacob typedef enum {
    532      1.23   mjacob 	ISPCTL_RESET_BUS,		/* Reset Bus */
    533      1.23   mjacob 	ISPCTL_RESET_DEV,		/* Reset Device */
    534      1.23   mjacob 	ISPCTL_ABORT_CMD,		/* Abort Command */
    535      1.23   mjacob 	ISPCTL_UPDATE_PARAMS,		/* Update Operating Parameters */
    536  1.25.2.1   bouyer 	ISPCTL_FCLINK_TEST,		/* Test FC Link Status */
    537  1.25.2.1   bouyer 	ISPCTL_PDB_SYNC,		/* Synchronize Port Database */
    538  1.25.2.1   bouyer 	ISPCTL_TOGGLE_TMODE		/* toggle target mode */
    539       1.9   mjacob } ispctl_t;
    540       1.9   mjacob int isp_control __P((struct ispsoftc *, ispctl_t, void *));
    541      1.17   mjacob 
    542      1.17   mjacob 
    543      1.17   mjacob /*
    544      1.17   mjacob  * Platform Dependent to Internal to External Control Function
    545      1.17   mjacob  * (each platform must provide such a function)
    546      1.17   mjacob  *
    547      1.23   mjacob  * Assumes all locks are held and that no reentrancy issues need be dealt with.
    548      1.17   mjacob  */
    549      1.17   mjacob 
    550      1.17   mjacob typedef enum {
    551      1.18   mjacob 	ISPASYNC_NEW_TGT_PARAMS,
    552      1.23   mjacob 	ISPASYNC_BUS_RESET,		/* Bus Was Reset */
    553      1.23   mjacob 	ISPASYNC_LOOP_DOWN,		/* FC Loop Down */
    554      1.23   mjacob 	ISPASYNC_LOOP_UP,		/* FC Loop Up */
    555  1.25.2.4   bouyer 	ISPASYNC_CHANGE_NOTIFY,		/* FC SNS or Port Database Changed */
    556  1.25.2.4   bouyer 	ISPASYNC_FABRIC_DEV,		/* FC Fabric Device Arrived/Left */
    557  1.25.2.4   bouyer 	ISPASYNC_LOGGED_INOUT,		/* FC Object Logged In/Out */
    558  1.25.2.1   bouyer 	ISPASYNC_TARGET_MESSAGE,	/* target message */
    559  1.25.2.1   bouyer 	ISPASYNC_TARGET_EVENT,		/* target asynchronous event */
    560  1.25.2.1   bouyer 	ISPASYNC_TARGET_ACTION		/* other target command action */
    561      1.17   mjacob } ispasync_t;
    562      1.17   mjacob int isp_async __P((struct ispsoftc *, ispasync_t, void *));
    563       1.1      cgd 
    564       1.9   mjacob /*
    565  1.25.2.1   bouyer  * Platform Dependent Error and Debug Printout
    566       1.9   mjacob  */
    567  1.25.2.3   bouyer #ifdef	__GNUC__
    568  1.25.2.3   bouyer void isp_prt __P((struct ispsoftc *, int level, const char *, ...))
    569  1.25.2.3   bouyer 	__attribute__((__format__(__printf__,3,4)));
    570  1.25.2.3   bouyer #else
    571  1.25.2.1   bouyer void isp_prt __P((struct ispsoftc *, int level, const char *, ...));
    572  1.25.2.3   bouyer #endif
    573  1.25.2.3   bouyer 
    574  1.25.2.1   bouyer #define	ISP_LOGALL	0x0	/* log always */
    575  1.25.2.1   bouyer #define	ISP_LOGCONFIG	0x1	/* log configuration messages */
    576  1.25.2.1   bouyer #define	ISP_LOGINFO	0x2	/* log informational messages */
    577  1.25.2.1   bouyer #define	ISP_LOGWARN	0x4	/* log warning messages */
    578  1.25.2.1   bouyer #define	ISP_LOGERR	0x8	/* log error messages */
    579  1.25.2.1   bouyer #define	ISP_LOGDEBUG0	0x10	/* log simple debug messages */
    580  1.25.2.1   bouyer #define	ISP_LOGDEBUG1	0x20	/* log intermediate debug messages */
    581  1.25.2.1   bouyer #define	ISP_LOGDEBUG2	0x40	/* log most debug messages */
    582  1.25.2.1   bouyer #define	ISP_LOGDEBUG3	0x100	/* log high frequency debug messages */
    583  1.25.2.1   bouyer #define	ISP_LOGTDEBUG0	0x200	/* log simple debug messages (target mode) */
    584  1.25.2.1   bouyer #define	ISP_LOGTDEBUG1	0x400	/* log intermediate debug messages (target) */
    585  1.25.2.1   bouyer #define	ISP_LOGTDEBUG2	0x800	/* log all debug messages (target) */
    586       1.1      cgd 
    587  1.25.2.1   bouyer /*
    588  1.25.2.1   bouyer  * Each Platform provides it's own isposinfo substructure of the ispsoftc
    589  1.25.2.1   bouyer  * defined above.
    590  1.25.2.1   bouyer  *
    591  1.25.2.1   bouyer  * Each platform must also provide the following macros/defines:
    592  1.25.2.1   bouyer  *
    593  1.25.2.1   bouyer  *
    594  1.25.2.1   bouyer  *	INLINE		-	platform specific define for 'inline' functions
    595  1.25.2.1   bouyer  *
    596  1.25.2.1   bouyer  *	ISP2100_FABRIC	-	defines whether FABRIC support is enabled
    597  1.25.2.1   bouyer  *	ISP2100_SCRLEN	-	length for the Fibre Channel scratch DMA area
    598  1.25.2.1   bouyer  *
    599  1.25.2.1   bouyer  *	MEMZERO(dst, src)			platform zeroing function
    600  1.25.2.1   bouyer  *	MEMCPY(dst, src, count)			platform copying function
    601  1.25.2.1   bouyer  *	SNPRINTF(buf, bufsize, fmt, ...)	snprintf
    602  1.25.2.1   bouyer  *	STRNCAT(dstbuf, size, srcbuf)		strncat
    603  1.25.2.1   bouyer  *	USEC_DELAY(usecs)			microsecond spindelay function
    604  1.25.2.2   bouyer  *	USEC_SLEEP(isp, usecs)			microsecond sleep function
    605  1.25.2.1   bouyer  *
    606  1.25.2.1   bouyer  *	NANOTIME_T				nanosecond time type
    607  1.25.2.1   bouyer  *
    608  1.25.2.1   bouyer  *	GET_NANOTIME(NANOTIME_T *)		get current nanotime.
    609  1.25.2.1   bouyer  *
    610  1.25.2.1   bouyer  *	GET_NANOSEC(NANOTIME_T *)		get u_int64_t from NANOTIME_T
    611  1.25.2.1   bouyer  *
    612  1.25.2.1   bouyer  *	NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
    613  1.25.2.1   bouyer  *						subtract two NANOTIME_T values
    614  1.25.2.1   bouyer  *
    615  1.25.2.1   bouyer  *
    616  1.25.2.1   bouyer  *	MAXISPREQUEST(struct ispsoftc *)	maximum request queue size
    617  1.25.2.1   bouyer  *						for this particular board type
    618  1.25.2.1   bouyer  *
    619  1.25.2.1   bouyer  *	MEMORYBARRIER(struct ispsoftc *, barrier_type, offset, size)
    620  1.25.2.1   bouyer  *
    621  1.25.2.1   bouyer  *		Function/Macro the provides memory synchronization on
    622  1.25.2.1   bouyer  *		various objects so that the ISP's and the system's view
    623  1.25.2.1   bouyer  *		of the same object is consistent.
    624  1.25.2.1   bouyer  *
    625  1.25.2.1   bouyer  *	MBOX_ACQUIRE(struct ispsoftc *)		acquire lock on mailbox regs
    626  1.25.2.1   bouyer  *	MBOX_WAIT_COMPLETE(struct ispsoftc *)	wait for mailbox cmd to be done
    627  1.25.2.1   bouyer  *	MBOX_NOTIFY_COMPLETE(struct ispsoftc *)	notification of mbox cmd donee
    628  1.25.2.1   bouyer  *	MBOX_RELEASE(struct ispsoftc *)		release lock on mailbox regs
    629  1.25.2.1   bouyer  *
    630  1.25.2.1   bouyer  *
    631  1.25.2.1   bouyer  *	SCSI_GOOD	SCSI 'Good' Status
    632  1.25.2.1   bouyer  *	SCSI_CHECK	SCSI 'Check Condition' Status
    633  1.25.2.1   bouyer  *	SCSI_BUSY	SCSI 'Busy' Status
    634  1.25.2.1   bouyer  *	SCSI_QFULL	SCSI 'Queue Full' Status
    635  1.25.2.1   bouyer  *
    636  1.25.2.1   bouyer  *	XS_T		Platform SCSI transaction type (i.e., command for HBA)
    637  1.25.2.1   bouyer  *	XS_ISP(xs)	gets an instance out of an XS_T
    638  1.25.2.1   bouyer  *	XS_CHANNEL(xs)	gets the channel (bus # for DUALBUS cards) ""
    639  1.25.2.1   bouyer  *	XS_TGT(xs)	gets the target ""
    640  1.25.2.1   bouyer  *	XS_LUN(xs)	gets the lun ""
    641  1.25.2.1   bouyer  *	XS_CDBP(xs)	gets a pointer to the scsi CDB ""
    642  1.25.2.1   bouyer  *	XS_CDBLEN(xs)	gets the CDB's length ""
    643  1.25.2.1   bouyer  *	XS_XFRLEN(xs)	gets the associated data transfer length ""
    644  1.25.2.1   bouyer  *	XS_TIME(xs)	gets the time (in milliseconds) for this command
    645  1.25.2.1   bouyer  *	XS_RESID(xs)	gets the current residual count
    646  1.25.2.1   bouyer  *	XS_STSP(xs)	gets a pointer to the SCSI status byte ""
    647  1.25.2.1   bouyer  *	XS_SNSP(xs)	gets a pointer to the associate sense data
    648  1.25.2.1   bouyer  *	XS_SNSLEN(xs)	gets the length of sense data storage
    649  1.25.2.1   bouyer  *	XS_SNSKEY(xs)	dereferences XS_SNSP to get the current stored Sense Key
    650  1.25.2.1   bouyer  *	XS_TAG_P(xs)	predicate of whether this command should be tagged
    651  1.25.2.1   bouyer  *	XS_TAG_TYPE(xs)	which type of tag to use
    652  1.25.2.1   bouyer  *	XS_SETERR(xs)	set error state
    653  1.25.2.1   bouyer  *
    654  1.25.2.1   bouyer  *		HBA_NOERROR	command has no erros
    655  1.25.2.1   bouyer  *		HBA_BOTCH	hba botched something
    656  1.25.2.1   bouyer  *		HBA_CMDTIMEOUT	command timed out
    657  1.25.2.1   bouyer  *		HBA_SELTIMEOUT	selection timed out (also port logouts for FC)
    658  1.25.2.1   bouyer  *		HBA_TGTBSY	target returned a BUSY status
    659  1.25.2.1   bouyer  *		HBA_BUSRESET	bus reset destroyed command
    660  1.25.2.1   bouyer  *		HBA_ABORTED	command was aborted (by request)
    661  1.25.2.1   bouyer  *		HBA_DATAOVR	a data overrun was detected
    662  1.25.2.1   bouyer  *		HBA_ARQFAIL	Automatic Request Sense failed
    663  1.25.2.1   bouyer  *
    664  1.25.2.1   bouyer  *	XS_ERR(xs)	return current error state
    665  1.25.2.1   bouyer  *	XS_NOERR(xs)	there is no error currently set
    666  1.25.2.1   bouyer  *	XS_INITERR(xs)	initialize error state
    667  1.25.2.1   bouyer  *
    668  1.25.2.1   bouyer  *	XS_SAVE_SENSE(xs, sp)		save sense data
    669  1.25.2.1   bouyer  *
    670  1.25.2.1   bouyer  *	XS_SET_STATE_STAT(isp, sp, xs)	platform dependent interpreter of
    671  1.25.2.1   bouyer  *					response queue entry status bits
    672  1.25.2.1   bouyer  *
    673  1.25.2.1   bouyer  *
    674  1.25.2.1   bouyer  *	DEFAULT_IID(struct ispsoftc *)		Default SCSI initiator ID
    675  1.25.2.1   bouyer  *	DEFAULT_LOOPID(struct ispsoftc *)	Default FC Loop ID
    676  1.25.2.1   bouyer  *	DEFAULT_NODEWWN(struct ispsoftc *)	Default Node WWN
    677  1.25.2.1   bouyer  *	DEFAULT_PORTWWN(struct ispsoftc *)	Default Port WWN
    678  1.25.2.1   bouyer  *		These establish reasonable defaults for each platform.
    679  1.25.2.1   bouyer  * 		These must be available independent of card NVRAM and are
    680  1.25.2.1   bouyer  *		to be used should NVRAM not be readable.
    681  1.25.2.1   bouyer  *
    682  1.25.2.1   bouyer  *	ISP_NODEWWN(struct ispsoftc *)	FC Node WWN to use
    683  1.25.2.1   bouyer  *	ISP_PORTWWN(struct ispsoftc *)	FC Port WWN to use
    684  1.25.2.1   bouyer  *
    685  1.25.2.1   bouyer  *		These are to be used after NVRAM is read. The tags
    686  1.25.2.1   bouyer  *		in fcparam.isp_{node,port}wwn reflect the values
    687  1.25.2.1   bouyer  *		read from NVRAM (possibly corrected for card botches).
    688  1.25.2.1   bouyer  *		Each platform can take that information and override
    689  1.25.2.1   bouyer  *		it or ignore and return the Node and Port WWNs to be
    690  1.25.2.1   bouyer  * 		used when sending the Qlogic f/w the Initialization Control
    691  1.25.2.1   bouyer  *		Block.
    692  1.25.2.1   bouyer  *
    693  1.25.2.1   bouyer  *	(XXX these do endian specific transformations- in transition XXX)
    694  1.25.2.1   bouyer  *	ISP_SWIZZLE_ICB
    695  1.25.2.1   bouyer  *	ISP_UNSWIZZLE_AND_COPY_PDBP
    696  1.25.2.1   bouyer  *	ISP_SWIZZLE_CONTINUATION
    697  1.25.2.1   bouyer  *	ISP_SWIZZLE_REQUEST
    698  1.25.2.1   bouyer  *	ISP_UNSWIZZLE_RESPONSE
    699  1.25.2.1   bouyer  *	ISP_SWIZZLE_SNS_REQ
    700  1.25.2.1   bouyer  *	ISP_UNSWIZZLE_SNS_RSP
    701  1.25.2.1   bouyer  *	ISP_SWIZZLE_NVRAM_WORD
    702  1.25.2.1   bouyer  *
    703  1.25.2.1   bouyer  *
    704  1.25.2.1   bouyer  */
    705       1.1      cgd #endif	/* _ISPVAR_H */
    706