Home | History | Annotate | Line # | Download | only in ic
ispvar.h revision 1.9 
      1 /* $NetBSD: ispvar.h,v 1.9 1998/07/15 19:50:16 mjacob Exp $ */
      2 /* $Id: ispvar.h,v 1.9 1998/07/15 19:50:16 mjacob Exp $ */
      3 /*
      4  * Soft Definitions for for Qlogic ISP SCSI adapters.
      5  *
      6  *---------------------------------------
      7  * Copyright (c) 1997, 1998 by Matthew Jacob
      8  * NASA/Ames Research Center
      9  * All rights reserved.
     10  *---------------------------------------
     11  * Redistribution and use in source and binary forms, with or without
     12  * modification, are permitted provided that the following conditions
     13  * are met:
     14  * 1. Redistributions of source code must retain the above copyright
     15  *    notice immediately at the beginning of the file, without modification,
     16  *    this list of conditions, and the following disclaimer.
     17  * 2. Redistributions in binary form must reproduce the above copyright
     18  *    notice, this list of conditions and the following disclaimer in the
     19  *    documentation and/or other materials provided with the distribution.
     20  * 3. The name of the author may not be used to endorse or promote products
     21  *    derived from this software without specific prior written permission.
     22  *
     23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     26  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
     27  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     33  * SUCH DAMAGE.
     34  *
     35  */
     36 
     37 #ifndef	_ISPVAR_H
     38 #define	_ISPVAR_H
     39 
     40 #ifdef	__NetBSD__
     41 #include <dev/ic/ispmbox.h>
     42 #endif
     43 #ifdef	__FreeBSD__
     44 #include <dev/isp/ispmbox.h>
     45 #endif
     46 #ifdef	__linux__
     47 #include <ispmbox.h>
     48 #endif
     49 
     50 /*
     51  * Vector for MD code to provide specific services.
     52  */
     53 struct ispsoftc;
     54 struct ispmdvec {
     55 	u_int16_t	(*dv_rd_reg) __P((struct ispsoftc *, int));
     56 	void		(*dv_wr_reg) __P((struct ispsoftc *, int, u_int16_t));
     57 	int		(*dv_mbxdma) __P((struct ispsoftc *));
     58 	int		(*dv_dmaset) __P((struct ispsoftc *,
     59 		ISP_SCSI_XFER_T *, ispreq_t *, u_int8_t *, u_int8_t));
     60 	void		(*dv_dmaclr)
     61 		__P((struct ispsoftc *, ISP_SCSI_XFER_T *, u_int32_t));
     62 	void		(*dv_reset0) __P((struct ispsoftc *));
     63 	void		(*dv_reset1) __P((struct ispsoftc *));
     64 	void		(*dv_dregs) __P((struct ispsoftc *));
     65 	const u_int16_t *dv_ispfw;	/* ptr to f/w */
     66 	u_int16_t 	dv_fwlen;	/* length of f/w */
     67 	u_int16_t	dv_codeorg;	/* code ORG for f/w */
     68 	u_int16_t	dv_fwrev;	/* f/w revision */
     69 	/*
     70 	 * Initial values for conf1 register
     71 	 */
     72 	u_int16_t	dv_conf1;
     73 	u_int16_t	dv_clock;	/* clock frequency */
     74 };
     75 
     76 #define	MAX_TARGETS	16
     77 #define	MAX_LUNS	8
     78 #define	MAX_FC_TARG	126
     79 
     80 #define	RQUEST_QUEUE_LEN	MAXISPREQUEST
     81 #define	RESULT_QUEUE_LEN	(MAXISPREQUEST/4)
     82 
     83 #define	QENTRY_LEN		64
     84 
     85 #define	ISP_QUEUE_ENTRY(q, idx)	((q) + ((idx) * QENTRY_LEN))
     86 #define	ISP_QUEUE_SIZE(n)	((n) * QENTRY_LEN)
     87 
     88 /*
     89  * SCSI (as opposed to FC-PH) Specific Host Adapter Parameters
     90  */
     91 
     92 typedef struct {
     93         u_int		isp_adapter_enabled	: 1,
     94         		isp_req_ack_active_neg	: 1,
     95 	        	isp_data_line_active_neg: 1,
     96 			isp_cmd_dma_burst_enable: 1,
     97 			isp_data_dma_burst_enabl: 1,
     98 			isp_fifo_threshold	: 2,
     99 			isp_diffmode		: 1,
    100 			isp_initiator_id	: 4,
    101         		isp_async_data_setup	: 4;
    102         u_int16_t	isp_selection_timeout;
    103         u_int16_t	isp_max_queue_depth;
    104 	u_int16_t	isp_clock;
    105 	u_int8_t	isp_tag_aging;
    106        	u_int8_t	isp_bus_reset_delay;
    107         u_int8_t	isp_retry_count;
    108         u_int8_t	isp_retry_delay;
    109 	struct {
    110 		u_int		dev_flags	: 8,	/* Device Flags - see below */
    111 				exc_throttle	: 8,
    112 				sync_period	: 8,
    113 				sync_offset	: 4,
    114 				dev_enable	: 1;
    115 	} isp_devparam[MAX_TARGETS];
    116 } sdparam;	/* scsi device parameters */
    117 
    118 /*
    119  * Device Flags
    120  */
    121 #define	DPARM_DISC	0x80
    122 #define	DPARM_PARITY	0x40
    123 #define	DPARM_WIDE	0x20
    124 #define	DPARM_SYNC	0x10
    125 #define	DPARM_TQING	0x08
    126 #define	DPARM_ARQ	0x04
    127 #define	DPARM_QFRZ	0x02
    128 #define	DPARM_RENEG	0x01
    129 #define	DPARM_DEFAULT	(0xff & ~DPARM_QFRZ)
    130 
    131 #define ISP_20M_SYNCPARMS	0x080c
    132 #define ISP_10M_SYNCPARMS	0x0c19
    133 #define ISP_08M_SYNCPARMS	0x0c25
    134 #define ISP_05M_SYNCPARMS	0x0c32
    135 #define ISP_04M_SYNCPARMS	0x0c41
    136 
    137 /*
    138  * Fibre Channel Specifics
    139  */
    140 typedef struct {
    141 #if	0
    142 	/*
    143 	 * Not gathered yet.
    144 	 */
    145 	u_int64_t		isp_wwn;	/* WWN of adapter */
    146 #endif
    147 	u_int8_t		isp_loopid;	/* FCAL of this adapter inst */
    148         u_int8_t		isp_retry_count;
    149         u_int8_t		isp_retry_delay;
    150 	u_int8_t		isp_fwstate;	/* ISP F/W state */
    151 
    152 	/*
    153 	 * Scratch DMA mapped in area to fetch Port Database stuff, etc.
    154 	 */
    155 	volatile caddr_t	isp_scratch;
    156 	u_int32_t		isp_scdma;
    157 } fcparam;
    158 
    159 #define	ISP2100_SCRLEN		0x100
    160 
    161 #define	FW_CONFIG_WAIT		0x0000
    162 #define	FW_WAIT_AL_PA		0x0001
    163 #define	FW_WAIT_LOGIN		0x0002
    164 #define	FW_READY		0x0003
    165 #define	FW_LOSS_OF_SYNC		0x0004
    166 #define	FW_ERROR		0x0005
    167 #define	FW_REINIT		0x0006
    168 #define	FW_NON_PART		0x0007
    169 
    170 static __inline char *fw_statename __P((u_int8_t x));
    171 static __inline char *
    172 fw_statename(x)
    173 	u_int8_t x;
    174 {
    175 	switch(x) {
    176 	case FW_CONFIG_WAIT:	return "Config Wait";
    177 	case FW_WAIT_AL_PA:	return "Waiting for AL/PA";
    178 	case FW_WAIT_LOGIN:	return "Wait Login";
    179 	case FW_READY:		return "Ready";
    180 	case FW_LOSS_OF_SYNC:	return "Loss Of Sync";
    181 	case FW_ERROR:		return "Error";
    182 	case FW_REINIT:		return "Re-Init";
    183 	case FW_NON_PART:	return "Nonparticipating";
    184 	default:		return "eh?";
    185 	}
    186 }
    187 
    188 /*
    189  * Soft Structure per host adapter
    190  */
    191 struct ispsoftc {
    192 	/*
    193 	 * Platform (OS) specific data
    194 	 */
    195 	struct isposinfo	isp_osinfo;
    196 
    197 	/*
    198 	 * Pointer to bus specific data
    199 	 */
    200 	struct ispmdvec *	isp_mdvec;
    201 
    202 	/*
    203 	 * State, debugging, etc..
    204 	 */
    205 
    206 	u_int32_t	isp_state	: 3,
    207 			isp_dogactive	: 1,
    208 			isp_dblev	: 4,
    209 			isp_confopts	: 8,
    210 			isp_fwrev	: 16;
    211 
    212 	/*
    213 	 * Host Adapter Type and Parameters.
    214 	 * Some parameters nominally stored in NVRAM on card.
    215 	 */
    216 	void * 			isp_param;
    217 	u_int8_t		isp_type;
    218 	int16_t			isp_nactive;
    219 
    220 	/*
    221 	 * Result and Request Queues.
    222 	 */
    223 	volatile u_int8_t	isp_reqidx;	/* index of next request */
    224 	volatile u_int8_t	isp_residx;	/* index of next result */
    225 	volatile u_int8_t	isp_sendmarker;
    226 	volatile u_int8_t	isp_seqno;
    227 
    228 	/*
    229 	 * Sheer laziness, but it gets us around the problem
    230 	 * where we don't have a clean way of remembering
    231 	 * which transaction is bound to which ISP queue entry.
    232 	 *
    233 	 * There are other more clever ways to do this, but,
    234 	 * jeez, so I blow a couple of KB per host adapter...
    235 	 * and it *is* faster.
    236 	 */
    237 	volatile ISP_SCSI_XFER_T *isp_xflist[RQUEST_QUEUE_LEN];
    238 
    239 	/*
    240 	 * request/result queues
    241 	 */
    242 	volatile caddr_t	isp_rquest;
    243 	volatile caddr_t	isp_result;
    244 	u_int32_t		isp_rquest_dma;
    245 	u_int32_t		isp_result_dma;
    246 };
    247 
    248 /*
    249  * ISP States
    250  */
    251 #define	ISP_NILSTATE	0
    252 #define	ISP_RESETSTATE	1
    253 #define	ISP_INITSTATE	2
    254 #define	ISP_RUNSTATE	3
    255 
    256 /*
    257  * ISP Configuration Options
    258  */
    259 #define	ISP_CFG_NORELOAD	0x80	/* don't download f/w */
    260 
    261 /*
    262  * Adapter Types
    263  */
    264 #define	ISP_HA_SCSI		0xf
    265 #define	ISP_HA_SCSI_UNKNOWN	0x0
    266 #define	ISP_HA_SCSI_1020	0x1
    267 #define	ISP_HA_SCSI_1020A	0x2
    268 #define	ISP_HA_SCSI_1040A	0x3
    269 #define	ISP_HA_SCSI_1040B	0x4
    270 #define	ISP_HA_FC		0xf0
    271 #define	ISP_HA_FC_2100		0x10
    272 
    273 /*
    274  * Macros to read, write ISP registers through MD code
    275  */
    276 
    277 #define	ISP_READ(isp, reg)	\
    278 	(*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
    279 
    280 #define	ISP_WRITE(isp, reg, val)	\
    281 	(*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
    282 
    283 #define	ISP_MBOXDMASETUP(isp)	\
    284 	(*(isp)->isp_mdvec->dv_mbxdma)((isp))
    285 
    286 #define	ISP_DMASETUP(isp, xs, req, iptrp, optr)	\
    287 	(*(isp)->isp_mdvec->dv_dmaset)((isp), (xs), (req), (iptrp), (optr))
    288 
    289 #define	ISP_DMAFREE(isp, xs, seqno)	\
    290 	if ((isp)->isp_mdvec->dv_dmaclr) \
    291 		 (*(isp)->isp_mdvec->dv_dmaclr)((isp), (xs), (seqno))
    292 
    293 #define	ISP_RESET0(isp)	\
    294 	if ((isp)->isp_mdvec->dv_reset0) (*(isp)->isp_mdvec->dv_reset0)((isp))
    295 #define	ISP_RESET1(isp)	\
    296 	if ((isp)->isp_mdvec->dv_reset1) (*(isp)->isp_mdvec->dv_reset1)((isp))
    297 #define	ISP_DUMPREGS(isp)	\
    298 	if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp))
    299 
    300 #define	ISP_SETBITS(isp, reg, val)	\
    301  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
    302 
    303 #define	ISP_CLRBITS(isp, reg, val)	\
    304  (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
    305 
    306 /*
    307  * Function Prototypes
    308  */
    309 
    310 /*
    311  * Reset Hardware. Totally. Assumes that you'll follow this with
    312  * a call to isp_init.
    313  */
    314 void isp_reset __P((struct ispsoftc *));
    315 
    316 /*
    317  * Initialize Hardware to known state
    318  */
    319 void isp_init __P((struct ispsoftc *));
    320 
    321 /*
    322  * Free any associated resources prior to decommissioning.
    323  */
    324 void isp_uninit __P((struct ispsoftc *));
    325 
    326 /*
    327  * Interrupt Service Routine
    328  */
    329 int isp_intr __P((void *));
    330 
    331 /*
    332  * Watchdog Routine
    333  */
    334 void isp_watch __P((void *));
    335 
    336 /*
    337  * Command Entry Point
    338  */
    339 extern int32_t ispscsicmd __P((ISP_SCSI_XFER_T *));
    340 
    341 /*
    342  * Platform Dependent to Internal Control Point
    343  *
    344  * For: 	Aborting a running command	- arg is an ISP_SCSI_XFER_T *
    345  *		Resetting a Device		- arg is target to reset
    346  *		Resetting a BUS			- arg is ignored
    347  *
    348  * Second argument is an index into xflist array.
    349  * Assumes all locks must be held already.
    350  */
    351 typedef enum {
    352 	ISPCTL_RESET_BUS,
    353 	ISPCTL_RESET_DEV,
    354 	ISPCTL_ABORT_CMD
    355 } ispctl_t;
    356 int isp_control __P((struct ispsoftc *, ispctl_t, void *));
    357 
    358 /*
    359  * lost command routine (XXXX IN TRANSITION XXXX)
    360  */
    361 extern void isp_lostcmd __P((struct ispsoftc *, ISP_SCSI_XFER_T *));
    362 
    363 #endif	/* _ISPVAR_H */
    364