Home | History | Annotate | Line # | Download | only in ic
ispvar.h revision 1.41
      1  1.41   mjacob /* $NetBSD: ispvar.h,v 1.41 2001/02/12 23:33:49 mjacob Exp $ */
      2  1.34   mjacob /*
      3  1.34   mjacob  * This driver, which is contained in NetBSD in the files:
      4  1.34   mjacob  *
      5  1.34   mjacob  *	sys/dev/ic/isp.c
      6  1.37      wiz  *	sys/dev/ic/isp_inline.h
      7  1.37      wiz  *	sys/dev/ic/isp_netbsd.c
      8  1.37      wiz  *	sys/dev/ic/isp_netbsd.h
      9  1.37      wiz  *	sys/dev/ic/isp_target.c
     10  1.37      wiz  *	sys/dev/ic/isp_target.h
     11  1.37      wiz  *	sys/dev/ic/isp_tpublic.h
     12  1.37      wiz  *	sys/dev/ic/ispmbox.h
     13  1.37      wiz  *	sys/dev/ic/ispreg.h
     14  1.37      wiz  *	sys/dev/ic/ispvar.h
     15  1.34   mjacob  *	sys/microcode/isp/asm_sbus.h
     16  1.34   mjacob  *	sys/microcode/isp/asm_1040.h
     17  1.34   mjacob  *	sys/microcode/isp/asm_1080.h
     18  1.34   mjacob  *	sys/microcode/isp/asm_12160.h
     19  1.34   mjacob  *	sys/microcode/isp/asm_2100.h
     20  1.34   mjacob  *	sys/microcode/isp/asm_2200.h
     21  1.34   mjacob  *	sys/pci/isp_pci.c
     22  1.34   mjacob  *	sys/sbus/isp_sbus.c
     23  1.34   mjacob  *
     24  1.34   mjacob  * Is being actively maintained by Matthew Jacob (mjacob (at) netbsd.org).
     25  1.34   mjacob  * This driver also is shared source with FreeBSD, OpenBSD, Linux, Solaris,
     26  1.34   mjacob  * Linux versions. This tends to be an interesting maintenance problem.
     27  1.34   mjacob  *
     28  1.34   mjacob  * Please coordinate with Matthew Jacob on changes you wish to make here.
     29  1.34   mjacob  */
     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.26   mjacob #ifdef	ISP_TARGET_MODE
     67  1.26   mjacob #include <dev/ic/isp_target.h>
     68  1.29   mjacob #include <dev/ic/isp_tpublic.h>
     69  1.26   mjacob #endif
     70   1.9   mjacob #endif
     71   1.9   mjacob #ifdef	__FreeBSD__
     72   1.9   mjacob #include <dev/isp/ispmbox.h>
     73  1.26   mjacob #ifdef	ISP_TARGET_MODE
     74  1.26   mjacob #include <dev/isp/isp_target.h>
     75  1.29   mjacob #include <dev/isp/isp_tpublic.h>
     76  1.26   mjacob #endif
     77   1.9   mjacob #endif
     78   1.9   mjacob #ifdef	__linux__
     79  1.15   mjacob #include "ispmbox.h"
     80  1.26   mjacob #ifdef	ISP_TARGET_MODE
     81  1.26   mjacob #include "isp_target.h"
     82  1.29   mjacob #include "isp_tpublic.h"
     83  1.26   mjacob #endif
     84   1.9   mjacob #endif
     85   1.1      cgd 
     86  1.32   mjacob #define	ISP_CORE_VERSION_MAJOR	2
     87  1.32   mjacob #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.32   mjacob 		XS_T *, ispreq_t *, u_int16_t *, u_int16_t));
     99   1.1      cgd 	void		(*dv_dmaclr)
    100  1.32   mjacob 		__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.32   mjacob 	void		(*dv_dregs) __P((struct ispsoftc *, const char *));
    104  1.31   mjacob 	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.32   mjacob /*
    110  1.32   mjacob  * Overall parameters
    111  1.32   mjacob  */
    112   1.1      cgd #define	MAX_TARGETS	16
    113  1.19   mjacob #define	MAX_FC_TARG	256
    114  1.24   mjacob #define	ISP_MAX_TARGETS(isp)	(IS_FC(isp)? MAX_FC_TARG : MAX_TARGETS)
    115  1.31   mjacob #define	ISP_MAX_LUNS(isp)	(isp)->isp_maxluns
    116  1.24   mjacob 
    117  1.26   mjacob 
    118  1.26   mjacob /*
    119  1.32   mjacob  * Macros to access ISP registers through bus specific layers-
    120  1.32   mjacob  * mostly wrappers to vector through the mdvec structure.
    121  1.26   mjacob  */
    122  1.26   mjacob 
    123  1.26   mjacob #define	ISP_READ(isp, reg)	\
    124  1.26   mjacob 	(*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
    125  1.26   mjacob 
    126  1.26   mjacob #define	ISP_WRITE(isp, reg, val)	\
    127  1.26   mjacob 	(*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
    128  1.26   mjacob 
    129  1.26   mjacob #define	ISP_MBOXDMASETUP(isp)	\
    130  1.26   mjacob 	(*(isp)->isp_mdvec->dv_mbxdma)((isp))
    131  1.26   mjacob 
    132  1.26   mjacob #define	ISP_DMASETUP(isp, xs, req, iptrp, optr)	\
    133  1.26   mjacob 	(*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr))
    134  1.26   mjacob 
    135  1.26   mjacob #define	ISP_DMAFREE(isp, xs, hndl)	\
    136  1.26   mjacob 	if ((isp)->isp_mdvec->dv_dmaclr) \
    137  1.26   mjacob 	    (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (hndl))
    138  1.26   mjacob 
    139  1.26   mjacob #define	ISP_RESET0(isp)	\
    140  1.26   mjacob 	if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
    141  1.26   mjacob #define	ISP_RESET1(isp)	\
    142  1.26   mjacob 	if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
    143  1.32   mjacob #define	ISP_DUMPREGS(isp, m)	\
    144  1.32   mjacob 	if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m))
    145  1.26   mjacob 
    146  1.26   mjacob #define	ISP_SETBITS(isp, reg, val)	\
    147  1.26   mjacob  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
    148  1.26   mjacob 
    149  1.26   mjacob #define	ISP_CLRBITS(isp, reg, val)	\
    150  1.26   mjacob  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
    151  1.26   mjacob 
    152  1.32   mjacob /*
    153  1.32   mjacob  * The MEMORYBARRIER macro is defined per platform (to provide synchronization
    154  1.32   mjacob  * on Request and Response Queues, Scratch DMA areas, and Registers)
    155  1.32   mjacob  *
    156  1.32   mjacob  * Defined Memory Barrier Synchronization Types
    157  1.32   mjacob  */
    158  1.32   mjacob #define	SYNC_REQUEST	0	/* request queue synchronization */
    159  1.32   mjacob #define	SYNC_RESULT	1	/* result queue synchronization */
    160  1.32   mjacob #define	SYNC_SFORDEV	2	/* scratch, sync for ISP */
    161  1.32   mjacob #define	SYNC_SFORCPU	3	/* scratch, sync for CPU */
    162  1.32   mjacob #define	SYNC_REG	4	/* for registers */
    163  1.32   mjacob 
    164  1.32   mjacob /*
    165  1.32   mjacob  * Request/Response Queue defines and macros.
    166  1.32   mjacob  * The maximum is defined per platform (and can be based on board type).
    167  1.32   mjacob  */
    168  1.32   mjacob /* This is the size of a queue entry (request and response) */
    169  1.11   mjacob #define	QENTRY_LEN			64
    170  1.32   mjacob /* Both request and result queue length must be a power of two */
    171  1.32   mjacob #define	RQUEST_QUEUE_LEN(x)		MAXISPREQUEST(x)
    172  1.32   mjacob #define	RESULT_QUEUE_LEN(x)		\
    173  1.32   mjacob 	(((MAXISPREQUEST(x) >> 2) < 64)? 64 : MAXISPREQUEST(x) >> 2)
    174  1.11   mjacob #define	ISP_QUEUE_ENTRY(q, idx)		((q) + ((idx) * QENTRY_LEN))
    175  1.11   mjacob #define	ISP_QUEUE_SIZE(n)		((n) * QENTRY_LEN)
    176  1.11   mjacob #define	ISP_NXT_QENTRY(idx, qlen)	(((idx) + 1) & ((qlen)-1))
    177  1.34   mjacob #define	ISP_QFREE(in, out, qlen)	\
    178  1.13   mjacob 	((in == out)? (qlen - 1) : ((in > out)? \
    179  1.25   mjacob 	((qlen - 1) - (in - out)) : (out - in - 1)))
    180  1.34   mjacob #define	ISP_QAVAIL(isp)	\
    181  1.34   mjacob 	ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp))
    182  1.26   mjacob 
    183  1.26   mjacob #define	ISP_ADD_REQUEST(isp, iptr)	\
    184  1.32   mjacob 	MEMORYBARRIER(isp, SYNC_REQUEST, iptr, QENTRY_LEN); \
    185  1.32   mjacob 	ISP_WRITE(isp, INMAILBOX4, iptr); \
    186  1.32   mjacob 	isp->isp_reqidx = iptr
    187  1.26   mjacob 
    188   1.1      cgd /*
    189  1.22   mjacob  * SCSI Specific Host Adapter Parameters- per bus, per target
    190   1.6   mjacob  */
    191   1.6   mjacob 
    192   1.6   mjacob typedef struct {
    193  1.22   mjacob 	u_int		isp_gotdparms		: 1,
    194  1.25   mjacob 			isp_req_ack_active_neg	: 1,
    195  1.25   mjacob 			isp_data_line_active_neg: 1,
    196   1.6   mjacob 			isp_cmd_dma_burst_enable: 1,
    197   1.6   mjacob 			isp_data_dma_burst_enabl: 1,
    198  1.16   mjacob 			isp_fifo_threshold	: 3,
    199  1.17   mjacob 			isp_ultramode		: 1,
    200   1.6   mjacob 			isp_diffmode		: 1,
    201  1.20   mjacob 			isp_lvdmode		: 1,
    202  1.33   mjacob 			isp_fast_mttr		: 1,	/* fast sram */
    203   1.6   mjacob 			isp_initiator_id	: 4,
    204  1.25   mjacob 			isp_async_data_setup	: 4;
    205  1.25   mjacob 	u_int16_t	isp_selection_timeout;
    206  1.25   mjacob 	u_int16_t	isp_max_queue_depth;
    207   1.6   mjacob 	u_int8_t	isp_tag_aging;
    208  1.25   mjacob 	u_int8_t	isp_bus_reset_delay;
    209  1.25   mjacob 	u_int8_t	isp_retry_count;
    210  1.25   mjacob 	u_int8_t	isp_retry_delay;
    211   1.6   mjacob 	struct {
    212  1.22   mjacob 		u_int	dev_enable	:	1,	/* ignored */
    213  1.22   mjacob 					:	1,
    214  1.17   mjacob 			dev_update	:	1,
    215  1.17   mjacob 			dev_refresh	:	1,
    216  1.20   mjacob 			exc_throttle	:	8,
    217  1.20   mjacob 			cur_offset	:	4,
    218  1.20   mjacob 			sync_offset	:	4;
    219  1.20   mjacob 		u_int8_t	cur_period;	/* current sync period */
    220  1.20   mjacob 		u_int8_t	sync_period;	/* goal sync period */
    221  1.20   mjacob 		u_int16_t	dev_flags;	/* goal device flags */
    222  1.20   mjacob 		u_int16_t	cur_dflags;	/* current device flags */
    223   1.6   mjacob 	} isp_devparam[MAX_TARGETS];
    224  1.22   mjacob } sdparam;
    225   1.6   mjacob 
    226   1.6   mjacob /*
    227   1.6   mjacob  * Device Flags
    228   1.6   mjacob  */
    229  1.11   mjacob #define	DPARM_DISC	0x8000
    230  1.11   mjacob #define	DPARM_PARITY	0x4000
    231  1.11   mjacob #define	DPARM_WIDE	0x2000
    232  1.11   mjacob #define	DPARM_SYNC	0x1000
    233  1.11   mjacob #define	DPARM_TQING	0x0800
    234  1.11   mjacob #define	DPARM_ARQ	0x0400
    235  1.11   mjacob #define	DPARM_QFRZ	0x0200
    236  1.11   mjacob #define	DPARM_RENEG	0x0100
    237  1.33   mjacob #define	DPARM_NARROW	0x0080
    238  1.33   mjacob #define	DPARM_ASYNC	0x0040
    239  1.33   mjacob #define	DPARM_PPR	0x0020
    240  1.18   mjacob #define	DPARM_DEFAULT	(0xFF00 & ~DPARM_QFRZ)
    241  1.11   mjacob #define	DPARM_SAFE_DFLT	(DPARM_DEFAULT & ~(DPARM_WIDE|DPARM_SYNC|DPARM_TQING))
    242  1.11   mjacob 
    243   1.6   mjacob 
    244  1.20   mjacob /* technically, not really correct, as they need to be rated based upon clock */
    245  1.33   mjacob #define	ISP_80M_SYNCPARMS	0x0c09
    246  1.33   mjacob #define	ISP_40M_SYNCPARMS	0x0c0a
    247  1.33   mjacob #define	ISP_20M_SYNCPARMS	0x0c0c
    248  1.33   mjacob #define	ISP_20M_SYNCPARMS_1040	0x080c
    249  1.25   mjacob #define	ISP_10M_SYNCPARMS	0x0c19
    250  1.25   mjacob #define	ISP_08M_SYNCPARMS	0x0c25
    251  1.25   mjacob #define	ISP_05M_SYNCPARMS	0x0c32
    252  1.25   mjacob #define	ISP_04M_SYNCPARMS	0x0c41
    253   1.6   mjacob 
    254   1.6   mjacob /*
    255   1.6   mjacob  * Fibre Channel Specifics
    256   1.6   mjacob  */
    257  1.24   mjacob #define	FL_PORT_ID		0x7e	/* FL_Port Special ID */
    258  1.24   mjacob #define	FC_PORT_ID		0x7f	/* Fabric Controller Special ID */
    259  1.24   mjacob #define	FC_SNS_ID		0x80	/* SNS Server Special ID */
    260  1.24   mjacob 
    261   1.6   mjacob typedef struct {
    262  1.25   mjacob 	u_int32_t		isp_fwoptions	: 16,
    263  1.41   mjacob 						: 3,
    264  1.41   mjacob 				isp_iid_set	: 1,
    265  1.23   mjacob 				loop_seen_once	: 1,
    266  1.23   mjacob 				isp_loopstate	: 3,	/* Current Loop State */
    267  1.23   mjacob 				isp_fwstate	: 3,	/* ISP F/W state */
    268  1.23   mjacob 				isp_gotdparms	: 1,
    269  1.30       he 				isp_topo	: 3,
    270  1.23   mjacob 				isp_onfabric	: 1;
    271  1.41   mjacob 	u_int8_t		isp_iid;	/* 'initiator' id */
    272  1.11   mjacob 	u_int8_t		isp_loopid;	/* hard loop id */
    273  1.11   mjacob 	u_int8_t		isp_alpa;	/* ALPA */
    274  1.41   mjacob 	u_int32_t		isp_portid;
    275  1.25   mjacob 	volatile u_int16_t	isp_lipseq;	/* LIP sequence # */
    276  1.41   mjacob 	u_int16_t		isp_xxxxxx;
    277  1.11   mjacob 	u_int8_t		isp_execthrottle;
    278  1.25   mjacob 	u_int8_t		isp_retry_delay;
    279  1.25   mjacob 	u_int8_t		isp_retry_count;
    280  1.25   mjacob 	u_int8_t		isp_reserved;
    281  1.11   mjacob 	u_int16_t		isp_maxalloc;
    282  1.11   mjacob 	u_int16_t		isp_maxfrmlen;
    283  1.23   mjacob 	u_int64_t		isp_nodewwn;
    284  1.23   mjacob 	u_int64_t		isp_portwwn;
    285   1.6   mjacob 	/*
    286  1.23   mjacob 	 * Port Data Base. This is indexed by 'target', which is invariate.
    287  1.23   mjacob 	 * However, elements within can move around due to loop changes,
    288  1.23   mjacob 	 * so the actual loop ID passed to the F/W is in this structure.
    289  1.23   mjacob 	 * The first time the loop is seen up, loopid will match the index
    290  1.23   mjacob 	 * (except for fabric nodes which are above mapped above FC_SNS_ID
    291  1.23   mjacob 	 * and are completely virtual), but subsequent LIPs can cause things
    292  1.23   mjacob 	 * to move around.
    293  1.23   mjacob 	 */
    294  1.23   mjacob 	struct lportdb {
    295  1.25   mjacob 		u_int
    296  1.30       he 					loopid		: 8,
    297  1.41   mjacob 							: 2,
    298  1.41   mjacob 					was_fabric_dev	: 1,
    299  1.41   mjacob 					fabric_dev	: 1,
    300  1.30       he 					loggedin	: 1,
    301  1.30       he 					roles		: 2,
    302  1.30       he 					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.41   mjacob 	} portdb[MAX_FC_TARG], tport[FC_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.41   mjacob #define	LOOP_SCANNING_FABRIC	3
    328  1.41   mjacob #define	LOOP_FSCAN_DONE		4
    329  1.41   mjacob #define	LOOP_SCANNING_LOOP	5
    330  1.41   mjacob #define	LOOP_LSCAN_DONE		4
    331  1.41   mjacob #define	LOOP_SYNCING_PDB	6
    332  1.23   mjacob #define	LOOP_READY		7
    333  1.30       he 
    334  1.30       he #define	TOPO_NL_PORT		0
    335  1.30       he #define	TOPO_FL_PORT		1
    336  1.30       he #define	TOPO_N_PORT		2
    337  1.30       he #define	TOPO_F_PORT		3
    338  1.30       he #define	TOPO_PTP_STUB		4
    339  1.23   mjacob 
    340   1.6   mjacob /*
    341   1.1      cgd  * Soft Structure per host adapter
    342   1.1      cgd  */
    343  1.33   mjacob typedef struct ispsoftc {
    344   1.9   mjacob 	/*
    345   1.9   mjacob 	 * Platform (OS) specific data
    346   1.9   mjacob 	 */
    347   1.9   mjacob 	struct isposinfo	isp_osinfo;
    348   1.9   mjacob 
    349   1.9   mjacob 	/*
    350  1.26   mjacob 	 * Pointer to bus specific functions and data
    351   1.9   mjacob 	 */
    352   1.1      cgd 	struct ispmdvec *	isp_mdvec;
    353   1.9   mjacob 
    354   1.9   mjacob 	/*
    355  1.26   mjacob 	 * (Mostly) nonvolatile state. Board specific parameters
    356  1.26   mjacob 	 * may contain some volatile state (e.g., current loop state).
    357   1.9   mjacob 	 */
    358   1.9   mjacob 
    359  1.26   mjacob 	void * 			isp_param;	/* type specific */
    360  1.26   mjacob 	u_int16_t		isp_fwrev[3];	/* Loaded F/W revision */
    361  1.26   mjacob 	u_int16_t		isp_romfw_rev[3]; /* PROM F/W revision */
    362  1.26   mjacob 	u_int16_t		isp_maxcmds;	/* max possible I/O cmds */
    363  1.26   mjacob 	u_int8_t		isp_type;	/* HBA Chip Type */
    364  1.26   mjacob 	u_int8_t		isp_revision;	/* HBA Chip H/W Revision */
    365  1.31   mjacob 	u_int32_t		isp_maxluns;	/* maximum luns supported */
    366  1.26   mjacob 
    367  1.41   mjacob 	u_int32_t		isp_clock	: 8,	/* input clock */
    368  1.41   mjacob 						: 6,
    369  1.41   mjacob 				isp_role	: 2,
    370  1.41   mjacob 						: 1,
    371  1.26   mjacob 				isp_touched	: 1,	/* board ever seen? */
    372  1.26   mjacob 				isp_bustype	: 1,	/* SBus or PCI */
    373  1.33   mjacob 				isp_loaded_fw	: 1,	/* loaded firmware */
    374  1.41   mjacob 				isp_dblev	: 12;	/* debug log mask */
    375  1.41   mjacob 
    376  1.41   mjacob 	u_int32_t		isp_confopts;		/* config options */
    377  1.41   mjacob 
    378  1.36   mjacob 	/*
    379  1.36   mjacob 	 * Instrumentation
    380  1.36   mjacob 	 */
    381  1.36   mjacob 	u_int64_t		isp_intcnt;		/* total int count */
    382  1.36   mjacob 	u_int64_t		isp_intbogus;		/* spurious int count */
    383   1.6   mjacob 
    384   1.1      cgd 	/*
    385  1.11   mjacob 	 * Volatile state
    386   1.1      cgd 	 */
    387  1.11   mjacob 
    388  1.31   mjacob 	volatile u_int32_t
    389  1.31   mjacob 		isp_mboxbsy	:	8,	/* mailbox command active */
    390  1.31   mjacob 				:	1,
    391  1.11   mjacob 		isp_state	:	3,
    392  1.22   mjacob 		isp_sendmarker	:	2,	/* send a marker entry */
    393  1.22   mjacob 		isp_update	:	2,	/* update parameters */
    394  1.24   mjacob 		isp_nactive	:	16;	/* how many commands active */
    395  1.24   mjacob 	volatile u_int16_t	isp_reqodx;	/* index of last ISP pickup */
    396  1.24   mjacob 	volatile u_int16_t	isp_reqidx;	/* index of next request */
    397  1.24   mjacob 	volatile u_int16_t	isp_residx;	/* index of next result */
    398  1.24   mjacob 	volatile u_int16_t	isp_lasthdls;	/* last handle seed */
    399  1.31   mjacob 	volatile u_int16_t	isp_mboxtmp[MAX_MAILBOX];
    400  1.41   mjacob 	volatile u_int16_t	isp_lastmbxcmd;	/* last mbox command sent */
    401   1.6   mjacob 
    402   1.1      cgd 	/*
    403  1.26   mjacob 	 * Active commands are stored here, indexed by handle functions.
    404   1.1      cgd 	 */
    405  1.32   mjacob 	XS_T **isp_xflist;
    406   1.6   mjacob 
    407   1.1      cgd 	/*
    408  1.24   mjacob 	 * request/result queue pointers and dma handles for them.
    409   1.1      cgd 	 */
    410  1.23   mjacob 	caddr_t			isp_rquest;
    411  1.23   mjacob 	caddr_t			isp_result;
    412   1.5  thorpej 	u_int32_t		isp_rquest_dma;
    413   1.5  thorpej 	u_int32_t		isp_result_dma;
    414  1.33   mjacob } ispsoftc_t;
    415  1.14   mjacob 
    416  1.24   mjacob #define	SDPARAM(isp)	((sdparam *) (isp)->isp_param)
    417  1.24   mjacob #define	FCPARAM(isp)	((fcparam *) (isp)->isp_param)
    418   1.1      cgd 
    419   1.1      cgd /*
    420  1.32   mjacob  * ISP Driver Run States
    421   1.9   mjacob  */
    422   1.9   mjacob #define	ISP_NILSTATE	0
    423   1.9   mjacob #define	ISP_RESETSTATE	1
    424   1.9   mjacob #define	ISP_INITSTATE	2
    425   1.9   mjacob #define	ISP_RUNSTATE	3
    426   1.9   mjacob 
    427   1.9   mjacob /*
    428   1.9   mjacob  * ISP Configuration Options
    429   1.9   mjacob  */
    430   1.9   mjacob #define	ISP_CFG_NORELOAD	0x80	/* don't download f/w */
    431  1.18   mjacob #define	ISP_CFG_NONVRAM		0x40	/* ignore NVRAM */
    432  1.26   mjacob #define	ISP_CFG_FULL_DUPLEX	0x01	/* Full Duplex (Fibre Channel only) */
    433  1.26   mjacob #define	ISP_CFG_OWNWWN		0x02	/* override NVRAM wwn */
    434  1.36   mjacob #define	ISP_CFG_PORT_PREF	0x0C	/* Mask for Port Prefs (2200 only) */
    435  1.36   mjacob #define	ISP_CFG_LPORT		0x00	/* prefer {N/F}L-Port connection */
    436  1.36   mjacob #define	ISP_CFG_NPORT		0x04	/* prefer {N/F}-Port connection */
    437  1.36   mjacob #define	ISP_CFG_NPORT_ONLY	0x08	/* insist on {N/F}-Port connection */
    438  1.36   mjacob #define	ISP_CFG_LPORT_ONLY	0x0C	/* insist on {N/F}L-Port connection */
    439   1.9   mjacob 
    440  1.32   mjacob /*
    441  1.41   mjacob  * Prior to calling isp_reset for the first time, the outer layer
    442  1.41   mjacob  * should set isp_role to one of NONE, INITIATOR, TARGET, BOTH.
    443  1.41   mjacob  *
    444  1.41   mjacob  * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded,
    445  1.41   mjacob  * NVRAM read, and defaults set, but any further initialization (e.g.
    446  1.41   mjacob  * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done.
    447  1.41   mjacob  *
    448  1.41   mjacob  * If INITIATOR MODE isn't set, attempts to run commands will be stopped
    449  1.41   mjacob  * at isp_start and completed with the moral equivalent of SELECTION TIMEOUT.
    450  1.41   mjacob  *
    451  1.41   mjacob  * If TARGET MODE is set, it doesn't mean that the rest of target mode support
    452  1.41   mjacob  * needs to be enabled, or will even work. What happens with the 2X00 cards
    453  1.41   mjacob  * here is that if you have enabled it with TARGET MODE as part of the ICB
    454  1.41   mjacob  * options, but you haven't given the f/w any ram resources for ATIOs or
    455  1.41   mjacob  * Immediate Notifies, the f/w just handles what it can and you never see
    456  1.41   mjacob  * anything. Basically, it sends a single byte of data (the first byte,
    457  1.41   mjacob  * which you can set as part of the INITIALIZE CONTROL BLOCK command) for
    458  1.41   mjacob  * INQUIRY, and sends back QUEUE FULL status for any other command.
    459  1.41   mjacob  *
    460  1.41   mjacob  */
    461  1.41   mjacob #define	ISP_ROLE_NONE		0x0
    462  1.41   mjacob #define	ISP_ROLE_INITIATOR	0x1
    463  1.41   mjacob #define	ISP_ROLE_TARGET		0x2
    464  1.41   mjacob #define	ISP_ROLE_BOTH		(ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
    465  1.41   mjacob #define	ISP_ROLE_EITHER		ISP_ROLE_BOTH
    466  1.41   mjacob #ifndef	ISP_DEFAULT_ROLES
    467  1.41   mjacob #define	ISP_DEFAULT_ROLES	ISP_ROLE_INITIATOR
    468  1.41   mjacob #endif
    469  1.41   mjacob 
    470  1.41   mjacob 
    471  1.41   mjacob /*
    472  1.32   mjacob  * Firmware related defines
    473  1.32   mjacob  */
    474  1.41   mjacob #define	ISP_CODE_ORG			0x1000	/* default f/w code start */
    475  1.21   mjacob #define	ISP_FW_REV(maj, min, mic)	((maj << 24) | (min << 16) | mic)
    476  1.41   mjacob #define	ISP_FW_REVX(xp)			((xp[0]<<24) | (xp[1] << 16) | xp[2])
    477  1.11   mjacob 
    478   1.9   mjacob /*
    479  1.11   mjacob  * Bus (implementation) types
    480  1.11   mjacob  */
    481  1.11   mjacob #define	ISP_BT_PCI		0	/* PCI Implementations */
    482  1.11   mjacob #define	ISP_BT_SBUS		1	/* SBus Implementations */
    483  1.11   mjacob 
    484  1.11   mjacob /*
    485  1.11   mjacob  * Chip Types
    486   1.6   mjacob  */
    487   1.6   mjacob #define	ISP_HA_SCSI		0xf
    488  1.11   mjacob #define	ISP_HA_SCSI_UNKNOWN	0x1
    489  1.11   mjacob #define	ISP_HA_SCSI_1020	0x2
    490  1.11   mjacob #define	ISP_HA_SCSI_1020A	0x3
    491  1.11   mjacob #define	ISP_HA_SCSI_1040	0x4
    492  1.11   mjacob #define	ISP_HA_SCSI_1040A	0x5
    493  1.11   mjacob #define	ISP_HA_SCSI_1040B	0x6
    494  1.21   mjacob #define	ISP_HA_SCSI_1040C	0x7
    495  1.27   mjacob #define	ISP_HA_SCSI_1240	0x8
    496  1.27   mjacob #define	ISP_HA_SCSI_1080	0x9
    497  1.27   mjacob #define	ISP_HA_SCSI_1280	0xa
    498  1.29   mjacob #define	ISP_HA_SCSI_12160	0xb
    499   1.6   mjacob #define	ISP_HA_FC		0xf0
    500   1.6   mjacob #define	ISP_HA_FC_2100		0x10
    501  1.23   mjacob #define	ISP_HA_FC_2200		0x20
    502   1.6   mjacob 
    503  1.19   mjacob #define	IS_SCSI(isp)	(isp->isp_type & ISP_HA_SCSI)
    504  1.27   mjacob #define	IS_1240(isp)	(isp->isp_type == ISP_HA_SCSI_1240)
    505  1.19   mjacob #define	IS_1080(isp)	(isp->isp_type == ISP_HA_SCSI_1080)
    506  1.27   mjacob #define	IS_1280(isp)	(isp->isp_type == ISP_HA_SCSI_1280)
    507  1.29   mjacob #define	IS_12160(isp)	(isp->isp_type == ISP_HA_SCSI_12160)
    508  1.29   mjacob 
    509  1.29   mjacob #define	IS_12X0(isp)	(IS_1240(isp) || IS_1280(isp))
    510  1.29   mjacob #define	IS_DUALBUS(isp)	(IS_12X0(isp) || IS_12160(isp))
    511  1.29   mjacob #define	IS_ULTRA2(isp)	(IS_1080(isp) || IS_1280(isp) || IS_12160(isp))
    512  1.29   mjacob #define	IS_ULTRA3(isp)	(IS_12160(isp))
    513  1.29   mjacob 
    514  1.19   mjacob #define	IS_FC(isp)	(isp->isp_type & ISP_HA_FC)
    515  1.29   mjacob #define	IS_2100(isp)	(isp->isp_type == ISP_HA_FC_2100)
    516  1.29   mjacob #define	IS_2200(isp)	(isp->isp_type == ISP_HA_FC_2200)
    517  1.29   mjacob 
    518  1.32   mjacob /*
    519  1.32   mjacob  * DMA cookie macros
    520  1.32   mjacob  */
    521  1.32   mjacob #define	DMA_MSW(x)	(((x) >> 16) & 0xffff)
    522  1.32   mjacob #define	DMA_LSW(x)	(((x) & 0xffff))
    523  1.19   mjacob 
    524   1.6   mjacob /*
    525  1.32   mjacob  * Core System Function Prototypes
    526   1.1      cgd  */
    527   1.9   mjacob 
    528   1.1      cgd /*
    529   1.9   mjacob  * Reset Hardware. Totally. Assumes that you'll follow this with
    530   1.9   mjacob  * a call to isp_init.
    531   1.1      cgd  */
    532   1.1      cgd void isp_reset __P((struct ispsoftc *));
    533   1.1      cgd 
    534   1.1      cgd /*
    535   1.1      cgd  * Initialize Hardware to known state
    536   1.1      cgd  */
    537   1.1      cgd void isp_init __P((struct ispsoftc *));
    538   1.1      cgd 
    539   1.1      cgd /*
    540  1.10   mjacob  * Reset the ISP and call completion for any orphaned commands.
    541  1.10   mjacob  */
    542  1.32   mjacob void isp_reinit __P((struct ispsoftc *));
    543   1.1      cgd 
    544   1.1      cgd /*
    545   1.1      cgd  * Interrupt Service Routine
    546   1.1      cgd  */
    547   1.1      cgd int isp_intr __P((void *));
    548   1.9   mjacob 
    549   1.9   mjacob /*
    550  1.32   mjacob  * Command Entry Point- Platform Dependent layers call into this
    551  1.32   mjacob  */
    552  1.32   mjacob int isp_start __P((XS_T *));
    553  1.32   mjacob /* these values are what isp_start returns */
    554  1.32   mjacob #define	CMD_COMPLETE	101	/* command completed */
    555  1.32   mjacob #define	CMD_EAGAIN	102	/* busy- maybe retry later */
    556  1.32   mjacob #define	CMD_QUEUED	103	/* command has been queued for execution */
    557  1.32   mjacob #define	CMD_RQLATER 	104	/* requeue this command later */
    558  1.32   mjacob 
    559  1.32   mjacob /*
    560  1.32   mjacob  * Command Completion Point- Core layers call out from this with completed cmds
    561   1.9   mjacob  */
    562  1.32   mjacob void isp_done __P((XS_T *));
    563   1.1      cgd 
    564   1.9   mjacob /*
    565  1.17   mjacob  * Platform Dependent to External to Internal Control Function
    566   1.9   mjacob  *
    567  1.41   mjacob  * Assumes locks are held on entry. You should note that with many of
    568  1.41   mjacob  * these commands and locks may be released while this is occurring.
    569  1.41   mjacob  *
    570  1.41   mjacob  * A few notes about some of these functions:
    571   1.9   mjacob  *
    572  1.41   mjacob  * ISPCTL_FCLINK_TEST tests to make sure we have good fibre channel link.
    573  1.41   mjacob  * The argument is a pointer to an integer which is the time, in microseconds,
    574  1.41   mjacob  * we should wait to see whether we have good link. This test, if successful,
    575  1.41   mjacob  * lets us know our connection topology and our Loop ID/AL_PA and so on.
    576  1.41   mjacob  * You can't get anywhere without this.
    577  1.41   mjacob  *
    578  1.41   mjacob  * ISPCTL_SCAN_FABRIC queries the name server (if we're on a fabric) for
    579  1.41   mjacob  * all entities using the FC Generic Services subcommand GET ALL NEXT.
    580  1.41   mjacob  * For each found entity, an ISPASYNC_FABRICDEV event is generated (see
    581  1.41   mjacob  * below).
    582  1.41   mjacob  *
    583  1.41   mjacob  * ISPCTL_SCAN_LOOP does a local loop scan. This is only done if the connection
    584  1.41   mjacob  * topology is NL or FL port (private or public loop). Since the Qlogic f/w
    585  1.41   mjacob  * 'automatically' manages local loop connections, this function essentially
    586  1.41   mjacob  * notes the arrival, departure, and possible shuffling around of local loop
    587  1.41   mjacob  * entities. Thus for each arrival and departure this generates an isp_async
    588  1.41   mjacob  * event of ISPASYNC_PROMENADE (see below).
    589  1.41   mjacob  *
    590  1.41   mjacob  * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in
    591  1.41   mjacob  * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_FABRIC, and ISPCTL_SCAN_LOOP.
    592  1.41   mjacob  * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging
    593  1.41   mjacob  * and logging out of fabric devices (if one is on a fabric) and then marking
    594  1.41   mjacob  * the 'loop state' as being ready to now be used for sending commands to
    595  1.41   mjacob  * devices. Originally fabric name server and local loop scanning were
    596  1.41   mjacob  * part of this function. It's now been seperated to allow for finer control.
    597   1.9   mjacob  */
    598   1.9   mjacob typedef enum {
    599  1.23   mjacob 	ISPCTL_RESET_BUS,		/* Reset Bus */
    600  1.23   mjacob 	ISPCTL_RESET_DEV,		/* Reset Device */
    601  1.23   mjacob 	ISPCTL_ABORT_CMD,		/* Abort Command */
    602  1.41   mjacob 	ISPCTL_UPDATE_PARAMS,		/* Update Operating Parameters (SCSI) */
    603  1.28   mjacob 	ISPCTL_FCLINK_TEST,		/* Test FC Link Status */
    604  1.41   mjacob 	ISPCTL_SCAN_FABRIC,		/* (Re)scan Fabric Name Server */
    605  1.41   mjacob 	ISPCTL_SCAN_LOOP,		/* (Re)scan Local Loop */
    606  1.28   mjacob 	ISPCTL_PDB_SYNC,		/* Synchronize Port Database */
    607  1.41   mjacob 	ISPCTL_SEND_LIP,		/* Send a LIP */
    608  1.41   mjacob 	ISPCTL_GET_POSMAP,		/* Get FC-AL position map */
    609  1.28   mjacob 	ISPCTL_TOGGLE_TMODE		/* toggle target mode */
    610   1.9   mjacob } ispctl_t;
    611   1.9   mjacob int isp_control __P((struct ispsoftc *, ispctl_t, void *));
    612  1.17   mjacob 
    613  1.17   mjacob 
    614  1.17   mjacob /*
    615  1.17   mjacob  * Platform Dependent to Internal to External Control Function
    616  1.17   mjacob  * (each platform must provide such a function)
    617  1.17   mjacob  *
    618  1.41   mjacob  * Assumes locks are held.
    619  1.41   mjacob  *
    620  1.41   mjacob  * A few notes about some of these functions:
    621  1.41   mjacob  *
    622  1.41   mjacob  * ISPASYNC_CHANGE_NOTIFY notifies the outer layer that a change has
    623  1.41   mjacob  * occurred that invalidates the list of fabric devices known and/or
    624  1.41   mjacob  * the list of known loop devices. The argument passed is a pointer
    625  1.41   mjacob  * whose values are defined below  (local loop change, name server
    626  1.41   mjacob  * change, other). 'Other' may simply be a LIP, or a change in
    627  1.41   mjacob  * connection topology.
    628  1.41   mjacob  *
    629  1.41   mjacob  * ISPASYNC_FABRIC_DEV announces the next element in a list of
    630  1.41   mjacob  * fabric device names we're getting out of the name server. The
    631  1.41   mjacob  * argument points to a GET ALL NEXT response structure. The list
    632  1.41   mjacob  * is known to terminate with an entry that refers to ourselves.
    633  1.41   mjacob  * One of the main purposes of this function is to allow outer
    634  1.41   mjacob  * layers, which are OS dependent, to set policy as to which fabric
    635  1.41   mjacob  * devices might actually be logged into (and made visible) later
    636  1.41   mjacob  * at ISPCTL_PDB_SYNC time. Since there's a finite number of fabric
    637  1.41   mjacob  * devices that we can log into (256 less 3 'reserved' for F-port
    638  1.41   mjacob  * topologies), and fabrics can grow up to 8 million or so entries
    639  1.41   mjacob  * (24 bits of Port Address, less a wad of reserved spaces), clearly
    640  1.41   mjacob  * we had better let the OS determine login policy.
    641  1.41   mjacob  *
    642  1.41   mjacob  * ISPASYNC_PROMENADE has an argument that is a pointer to an integer which
    643  1.41   mjacob  * is an index into the portdb in the softc ('target'). Whether that entrie's
    644  1.41   mjacob  * valid tag is set or not says whether something has arrived or departed.
    645  1.41   mjacob  * The name refers to a favorite pastime of many city dwellers- watching
    646  1.41   mjacob  * people come and go, talking of Michaelangelo, and so on..
    647  1.17   mjacob  */
    648  1.17   mjacob 
    649  1.17   mjacob typedef enum {
    650  1.41   mjacob 	ISPASYNC_NEW_TGT_PARAMS,	/* New Target Parameters Negotiated */
    651  1.23   mjacob 	ISPASYNC_BUS_RESET,		/* Bus Was Reset */
    652  1.23   mjacob 	ISPASYNC_LOOP_DOWN,		/* FC Loop Down */
    653  1.23   mjacob 	ISPASYNC_LOOP_UP,		/* FC Loop Up */
    654  1.41   mjacob 	ISPASYNC_CHANGE_NOTIFY,		/* FC Change Notification */
    655  1.41   mjacob 	ISPASYNC_FABRIC_DEV,		/* FC Fabric Device Arrival */
    656  1.41   mjacob 	ISPASYNC_PROMENADE,		/* FC Objects coming && going */
    657  1.28   mjacob 	ISPASYNC_TARGET_MESSAGE,	/* target message */
    658  1.28   mjacob 	ISPASYNC_TARGET_EVENT,		/* target asynchronous event */
    659  1.41   mjacob 	ISPASYNC_TARGET_ACTION,		/* other target command action */
    660  1.41   mjacob 	ISPASYNC_CONF_CHANGE		/* Platform Configuration Change */
    661  1.17   mjacob } ispasync_t;
    662  1.17   mjacob int isp_async __P((struct ispsoftc *, ispasync_t, void *));
    663   1.1      cgd 
    664  1.41   mjacob #define	ISPASYNC_CHANGE_PDB	((void *) 0)
    665  1.41   mjacob #define	ISPASYNC_CHANGE_SNS	((void *) 1)
    666  1.41   mjacob #define	ISPASYNC_CHANGE_OTHER	((void *) 2)
    667  1.41   mjacob 
    668   1.9   mjacob /*
    669  1.32   mjacob  * Platform Dependent Error and Debug Printout
    670   1.9   mjacob  */
    671  1.39   mjacob #ifdef	__GNUC__
    672  1.39   mjacob void isp_prt __P((struct ispsoftc *, int level, const char *, ...))
    673  1.39   mjacob 	__attribute__((__format__(__printf__,3,4)));
    674  1.39   mjacob #else
    675  1.32   mjacob void isp_prt __P((struct ispsoftc *, int level, const char *, ...));
    676  1.39   mjacob #endif
    677  1.39   mjacob 
    678  1.32   mjacob #define	ISP_LOGALL	0x0	/* log always */
    679  1.32   mjacob #define	ISP_LOGCONFIG	0x1	/* log configuration messages */
    680  1.32   mjacob #define	ISP_LOGINFO	0x2	/* log informational messages */
    681  1.32   mjacob #define	ISP_LOGWARN	0x4	/* log warning messages */
    682  1.32   mjacob #define	ISP_LOGERR	0x8	/* log error messages */
    683  1.32   mjacob #define	ISP_LOGDEBUG0	0x10	/* log simple debug messages */
    684  1.32   mjacob #define	ISP_LOGDEBUG1	0x20	/* log intermediate debug messages */
    685  1.32   mjacob #define	ISP_LOGDEBUG2	0x40	/* log most debug messages */
    686  1.32   mjacob #define	ISP_LOGDEBUG3	0x100	/* log high frequency debug messages */
    687  1.32   mjacob #define	ISP_LOGTDEBUG0	0x200	/* log simple debug messages (target mode) */
    688  1.32   mjacob #define	ISP_LOGTDEBUG1	0x400	/* log intermediate debug messages (target) */
    689  1.32   mjacob #define	ISP_LOGTDEBUG2	0x800	/* log all debug messages (target) */
    690   1.1      cgd 
    691  1.32   mjacob /*
    692  1.32   mjacob  * Each Platform provides it's own isposinfo substructure of the ispsoftc
    693  1.32   mjacob  * defined above.
    694  1.32   mjacob  *
    695  1.32   mjacob  * Each platform must also provide the following macros/defines:
    696  1.32   mjacob  *
    697  1.32   mjacob  *
    698  1.32   mjacob  *	INLINE		-	platform specific define for 'inline' functions
    699  1.32   mjacob  *
    700  1.32   mjacob  *	ISP2100_SCRLEN	-	length for the Fibre Channel scratch DMA area
    701  1.32   mjacob  *
    702  1.32   mjacob  *	MEMZERO(dst, src)			platform zeroing function
    703  1.32   mjacob  *	MEMCPY(dst, src, count)			platform copying function
    704  1.32   mjacob  *	SNPRINTF(buf, bufsize, fmt, ...)	snprintf
    705  1.32   mjacob  *	STRNCAT(dstbuf, size, srcbuf)		strncat
    706  1.32   mjacob  *	USEC_DELAY(usecs)			microsecond spindelay function
    707  1.36   mjacob  *	USEC_SLEEP(isp, usecs)			microsecond sleep function
    708  1.32   mjacob  *
    709  1.32   mjacob  *	NANOTIME_T				nanosecond time type
    710  1.32   mjacob  *
    711  1.32   mjacob  *	GET_NANOTIME(NANOTIME_T *)		get current nanotime.
    712  1.32   mjacob  *
    713  1.32   mjacob  *	GET_NANOSEC(NANOTIME_T *)		get u_int64_t from NANOTIME_T
    714  1.32   mjacob  *
    715  1.32   mjacob  *	NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
    716  1.32   mjacob  *						subtract two NANOTIME_T values
    717  1.32   mjacob  *
    718  1.32   mjacob  *
    719  1.32   mjacob  *	MAXISPREQUEST(struct ispsoftc *)	maximum request queue size
    720  1.32   mjacob  *						for this particular board type
    721  1.32   mjacob  *
    722  1.32   mjacob  *	MEMORYBARRIER(struct ispsoftc *, barrier_type, offset, size)
    723  1.32   mjacob  *
    724  1.32   mjacob  *		Function/Macro the provides memory synchronization on
    725  1.32   mjacob  *		various objects so that the ISP's and the system's view
    726  1.32   mjacob  *		of the same object is consistent.
    727  1.32   mjacob  *
    728  1.32   mjacob  *	MBOX_ACQUIRE(struct ispsoftc *)		acquire lock on mailbox regs
    729  1.32   mjacob  *	MBOX_WAIT_COMPLETE(struct ispsoftc *)	wait for mailbox cmd to be done
    730  1.32   mjacob  *	MBOX_NOTIFY_COMPLETE(struct ispsoftc *)	notification of mbox cmd donee
    731  1.32   mjacob  *	MBOX_RELEASE(struct ispsoftc *)		release lock on mailbox regs
    732  1.41   mjacob  *
    733  1.32   mjacob  *
    734  1.32   mjacob  *	SCSI_GOOD	SCSI 'Good' Status
    735  1.32   mjacob  *	SCSI_CHECK	SCSI 'Check Condition' Status
    736  1.32   mjacob  *	SCSI_BUSY	SCSI 'Busy' Status
    737  1.32   mjacob  *	SCSI_QFULL	SCSI 'Queue Full' Status
    738  1.32   mjacob  *
    739  1.32   mjacob  *	XS_T		Platform SCSI transaction type (i.e., command for HBA)
    740  1.32   mjacob  *	XS_ISP(xs)	gets an instance out of an XS_T
    741  1.32   mjacob  *	XS_CHANNEL(xs)	gets the channel (bus # for DUALBUS cards) ""
    742  1.32   mjacob  *	XS_TGT(xs)	gets the target ""
    743  1.32   mjacob  *	XS_LUN(xs)	gets the lun ""
    744  1.32   mjacob  *	XS_CDBP(xs)	gets a pointer to the scsi CDB ""
    745  1.32   mjacob  *	XS_CDBLEN(xs)	gets the CDB's length ""
    746  1.32   mjacob  *	XS_XFRLEN(xs)	gets the associated data transfer length ""
    747  1.32   mjacob  *	XS_TIME(xs)	gets the time (in milliseconds) for this command
    748  1.32   mjacob  *	XS_RESID(xs)	gets the current residual count
    749  1.32   mjacob  *	XS_STSP(xs)	gets a pointer to the SCSI status byte ""
    750  1.32   mjacob  *	XS_SNSP(xs)	gets a pointer to the associate sense data
    751  1.32   mjacob  *	XS_SNSLEN(xs)	gets the length of sense data storage
    752  1.32   mjacob  *	XS_SNSKEY(xs)	dereferences XS_SNSP to get the current stored Sense Key
    753  1.32   mjacob  *	XS_TAG_P(xs)	predicate of whether this command should be tagged
    754  1.32   mjacob  *	XS_TAG_TYPE(xs)	which type of tag to use
    755  1.32   mjacob  *	XS_SETERR(xs)	set error state
    756  1.32   mjacob  *
    757  1.32   mjacob  *		HBA_NOERROR	command has no erros
    758  1.32   mjacob  *		HBA_BOTCH	hba botched something
    759  1.32   mjacob  *		HBA_CMDTIMEOUT	command timed out
    760  1.32   mjacob  *		HBA_SELTIMEOUT	selection timed out (also port logouts for FC)
    761  1.32   mjacob  *		HBA_TGTBSY	target returned a BUSY status
    762  1.32   mjacob  *		HBA_BUSRESET	bus reset destroyed command
    763  1.32   mjacob  *		HBA_ABORTED	command was aborted (by request)
    764  1.32   mjacob  *		HBA_DATAOVR	a data overrun was detected
    765  1.32   mjacob  *		HBA_ARQFAIL	Automatic Request Sense failed
    766  1.32   mjacob  *
    767  1.32   mjacob  *	XS_ERR(xs)	return current error state
    768  1.32   mjacob  *	XS_NOERR(xs)	there is no error currently set
    769  1.32   mjacob  *	XS_INITERR(xs)	initialize error state
    770  1.32   mjacob  *
    771  1.32   mjacob  *	XS_SAVE_SENSE(xs, sp)		save sense data
    772  1.32   mjacob  *
    773  1.32   mjacob  *	XS_SET_STATE_STAT(isp, sp, xs)	platform dependent interpreter of
    774  1.32   mjacob  *					response queue entry status bits
    775  1.32   mjacob  *
    776  1.32   mjacob  *
    777  1.32   mjacob  *	DEFAULT_IID(struct ispsoftc *)		Default SCSI initiator ID
    778  1.32   mjacob  *	DEFAULT_LOOPID(struct ispsoftc *)	Default FC Loop ID
    779  1.35   mjacob  *	DEFAULT_NODEWWN(struct ispsoftc *)	Default Node WWN
    780  1.35   mjacob  *	DEFAULT_PORTWWN(struct ispsoftc *)	Default Port WWN
    781  1.35   mjacob  *		These establish reasonable defaults for each platform.
    782  1.35   mjacob  * 		These must be available independent of card NVRAM and are
    783  1.35   mjacob  *		to be used should NVRAM not be readable.
    784  1.35   mjacob  *
    785  1.35   mjacob  *	ISP_NODEWWN(struct ispsoftc *)	FC Node WWN to use
    786  1.35   mjacob  *	ISP_PORTWWN(struct ispsoftc *)	FC Port WWN to use
    787  1.35   mjacob  *
    788  1.35   mjacob  *		These are to be used after NVRAM is read. The tags
    789  1.35   mjacob  *		in fcparam.isp_{node,port}wwn reflect the values
    790  1.35   mjacob  *		read from NVRAM (possibly corrected for card botches).
    791  1.35   mjacob  *		Each platform can take that information and override
    792  1.35   mjacob  *		it or ignore and return the Node and Port WWNs to be
    793  1.35   mjacob  * 		used when sending the Qlogic f/w the Initialization Control
    794  1.35   mjacob  *		Block.
    795  1.32   mjacob  *
    796  1.32   mjacob  *	(XXX these do endian specific transformations- in transition XXX)
    797  1.32   mjacob  *	ISP_SWIZZLE_ICB
    798  1.32   mjacob  *	ISP_UNSWIZZLE_AND_COPY_PDBP
    799  1.32   mjacob  *	ISP_SWIZZLE_CONTINUATION
    800  1.32   mjacob  *	ISP_SWIZZLE_REQUEST
    801  1.32   mjacob  *	ISP_UNSWIZZLE_RESPONSE
    802  1.32   mjacob  *	ISP_SWIZZLE_SNS_REQ
    803  1.32   mjacob  *	ISP_UNSWIZZLE_SNS_RSP
    804  1.32   mjacob  *	ISP_SWIZZLE_NVRAM_WORD
    805  1.32   mjacob  *
    806  1.32   mjacob  *
    807  1.32   mjacob  */
    808   1.1      cgd #endif	/* _ISPVAR_H */
    809