Home | History | Annotate | Line # | Download | only in ic
isp_netbsd.h revision 1.19
      1 /* $NetBSD: isp_netbsd.h,v 1.19 1999/12/04 02:59:29 mjacob Exp $ */
      2 /*
      3  * NetBSD Specific definitions for the Qlogic ISP Host Adapter
      4  * Matthew Jacob <mjacob (at) nas.nasa.gov>
      5  */
      6 /*
      7  * Copyright (C) 1997, 1998, 1999 National Aeronautics & Space Administration
      8  * All rights reserved.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. The name of the author may not be used to endorse or promote products
     19  *    derived from this software without specific prior written permission
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     31  */
     32 #ifndef	_ISP_NETBSD_H
     33 #define	_ISP_NETBSD_H
     34 
     35 #include <sys/types.h>
     36 #include <sys/param.h>
     37 #include <sys/systm.h>
     38 #include <sys/kernel.h>
     39 #include <sys/errno.h>
     40 #include <sys/ioctl.h>
     41 #include <sys/device.h>
     42 #include <sys/malloc.h>
     43 #include <sys/buf.h>
     44 #include <sys/proc.h>
     45 #include <sys/user.h>
     46 
     47 
     48 #include <dev/scsipi/scsi_all.h>
     49 #include <dev/scsipi/scsipi_all.h>
     50 #include <dev/scsipi/scsiconf.h>
     51 
     52 #include <dev/scsipi/scsi_message.h>
     53 #include <dev/scsipi/scsipi_debug.h>
     54 
     55 #include <vm/vm.h>
     56 #include <vm/vm_param.h>
     57 #include <vm/pmap.h>
     58 
     59 #include "opt_isp.h"
     60 
     61 #define	ISP_PLATFORM_VERSION_MAJOR	0
     62 #define	ISP_PLATFORM_VERSION_MINOR	997
     63 
     64 #define	ISP_SCSI_XFER_T		struct scsipi_xfer
     65 struct isposinfo {
     66 	struct device		_dev;
     67 	struct scsipi_link	_link;
     68 	struct scsipi_link	_link_b;
     69 	struct scsipi_adapter   _adapter;
     70 	int			blocked;
     71 	union {
     72 		int		_seed;
     73 		u_int16_t	_discovered[2];
     74 	} un;
     75 #define	seed		un._seed
     76 #define	discovered	un._discovered
     77 	TAILQ_HEAD(, scsipi_xfer) waitq;
     78 };
     79 
     80 #define	MAXISPREQUEST	256
     81 #ifdef	ISP2100_FABRIC
     82 #define	ISP2100_SCRLEN		0x400
     83 #else
     84 #define	ISP2100_SCRLEN		0x100
     85 #endif
     86 
     87 #include <dev/ic/ispreg.h>
     88 #include <dev/ic/ispvar.h>
     89 #include <dev/ic/ispmbox.h>
     90 
     91 #define	IDPRINTF(lev, x)	if (isp->isp_dblev >= lev) printf x
     92 #define	PRINTF			printf
     93 
     94 #define	MEMZERO			bzero
     95 #define	MEMCPY(dst, src, count)	bcopy((src), (dst), (count))
     96 #ifdef	__alpha__
     97 #define	MemoryBarrier	alpha_mb
     98 #else
     99 #define	MemoryBarrier()
    100 #endif
    101 
    102 #define	DMA_MSW(x)	(((x) >> 16) & 0xffff)
    103 #define	DMA_LSW(x)	(((x) & 0xffff))
    104 
    105 #if	defined(SCSIDEBUG)
    106 #define	DFLT_DBLEVEL		3
    107 #define	CFGPRINTF		printf
    108 #elif	defined(DEBUG)
    109 #define	DFLT_DBLEVEL		2
    110 #define	CFGPRINTF		printf
    111 #elif	defined(DIAGNOSTIC)
    112 #define	DFLT_DBLEVEL		1
    113 #define	CFGPRINTF		if (0) printf
    114 #else
    115 #define	DFLT_DBLEVEL		0
    116 #define	CFGPRINTF		if (0) printf
    117 #endif
    118 
    119 #define	ISP_LOCKVAL_DECL	int isp_spl_save
    120 #define	ISP_ILOCKVAL_DECL	ISP_LOCKVAL_DECL
    121 #define	ISP_LOCK(x)		isp_spl_save = splbio()
    122 #define	ISP_UNLOCK(x)		(void) splx(isp_spl_save)
    123 #define	ISP_ILOCK		ISP_LOCK
    124 #define	ISP_IUNLOCK		ISP_UNLOCK
    125 
    126 
    127 #define	XS_NULL(xs)		xs == NULL || xs->sc_link == NULL
    128 #define	XS_ISP(xs)		(xs)->sc_link->adapter_softc
    129 #define	XS_LUN(xs)		((int) (xs)->sc_link->scsipi_scsi.lun)
    130 #define	XS_TGT(xs)		((int) (xs)->sc_link->scsipi_scsi.target)
    131 #define	XS_CHANNEL(xs)		\
    132     (((xs)->sc_link == &(((struct ispsoftc *)XS_ISP(xs))->isp_osinfo._link_b))?\
    133     1 : 0)
    134 #define	XS_RESID(xs)		(xs)->resid
    135 #define	XS_XFRLEN(xs)		(xs)->datalen
    136 #define	XS_CDBLEN(xs)		(xs)->cmdlen
    137 #define	XS_CDBP(xs)		((caddr_t) (xs)->cmd)
    138 #define	XS_STS(xs)		(xs)->status
    139 #define	XS_TIME(xs)		(xs)->timeout
    140 #define	XS_SNSP(xs)		(&(xs)->sense.scsi_sense)
    141 #define	XS_SNSLEN(xs)		(sizeof (xs)->sense.scsi_sense)
    142 #define	XS_SNSKEY(xs)		((xs)->sense.scsi_sense.flags)
    143 
    144 #define	HBA_NOERROR		XS_NOERROR
    145 #define	HBA_BOTCH		XS_DRIVER_STUFFUP
    146 #define	HBA_CMDTIMEOUT		XS_TIMEOUT
    147 #define	HBA_SELTIMEOUT		XS_SELTIMEOUT
    148 #define	HBA_TGTBSY		XS_BUSY
    149 #ifdef	XS_RESET
    150 #define	HBA_BUSRESET		XS_RESET
    151 #else
    152 #define	HBA_BUSRESET		XS_DRIVER_STUFFUP
    153 #endif
    154 #define	HBA_ABORTED		XS_DRIVER_STUFFUP
    155 #define	HBA_DATAOVR		XS_DRIVER_STUFFUP
    156 #define	HBA_ARQFAIL		XS_DRIVER_STUFFUP
    157 
    158 #define	XS_SNS_IS_VALID(xs)	(xs)->error = XS_SENSE
    159 #define	XS_IS_SNS_VALID(xs)	((xs)->error == XS_SENSE)
    160 
    161 #define	XS_INITERR(xs)		(xs)->error = 0
    162 #define	XS_SETERR(xs, v)	(xs)->error = v
    163 #define	XS_ERR(xs)		(xs)->error
    164 #define	XS_NOERR(xs)		(xs)->error == XS_NOERROR
    165 
    166 #define	XS_CMD_DONE(xs)		(xs)->xs_status |= XS_STS_DONE, scsipi_done(xs)
    167 #define	XS_IS_CMD_DONE(xs)	(((xs)->xs_status & XS_STS_DONE) != 0)
    168 
    169 /*
    170  * We use whether or not we're a polled command to decide about tagging.
    171  */
    172 #define	XS_CANTAG(xs)		(((xs)->xs_control & XS_CTL_POLL) != 0)
    173 
    174 /*
    175  * This is our default tag (simple).
    176  */
    177 #define	XS_KINDOF_TAG(xs)	\
    178 	(((xs)->xs_control & XS_CTL_URGENT) ? REQFLAG_HTAG : REQFLAG_OTAG)
    179 
    180 /*
    181  * These get turned into NetBSD midlayer codes
    182  */
    183 #define	CMD_COMPLETE		100
    184 #define	CMD_EAGAIN		101
    185 #define	CMD_QUEUED		102
    186 #define	CMD_RQLATER		103
    187 
    188 
    189 #define	isp_name	isp_osinfo._dev.dv_xname
    190 #define	isp_unit	isp_osinfo._dev.dv_unit
    191 
    192 #define	SCSI_QFULL	0x28
    193 
    194 #define	SYS_DELAY(x)	delay(x)
    195 
    196 #define	WATCH_INTERVAL	30
    197 
    198 #define	FC_FW_READY_DELAY	(12 * 1000000)
    199 #define	DEFAULT_LOOPID(x)	108
    200 #define	DEFAULT_WWN(x)		(0x1000beed00000000LL + (x)->isp_osinfo.seed)
    201 
    202 extern void isp_attach __P((struct ispsoftc *));
    203 extern void isp_uninit __P((struct ispsoftc *));
    204 
    205 #define ISP_UNSWIZZLE_AND_COPY_PDBP(isp, dest, src)	\
    206         bcopy(src, dest, sizeof (isp_pdb_t))
    207 #define ISP_SWIZZLE_ICB(a, b)
    208 #ifdef	__sparc__
    209 #define ISP_SWIZZLE_REQUEST(a, b)			\
    210 	ISP_SBUSIFY_ISPHDR(a, &(b)->req_header);	\
    211         ISP_SBUSIFY_ISPREQ(a, b)
    212 #define ISP_UNSWIZZLE_RESPONSE(a, b)			\
    213 	ISP_SBUSIFY_ISPHDR(a, &(b)->req_header)
    214 #else
    215 #define ISP_SWIZZLE_REQUEST(a, b)
    216 #define ISP_UNSWIZZLE_RESPONSE(a, b)
    217 #endif
    218 #define	ISP_SWIZZLE_SNS_REQ(a, b)
    219 #define	ISP_UNSWIZZLE_SNS_RSP(a, b, c)
    220 
    221 #define	INLINE	inline
    222 #include <dev/ic/isp_inline.h>
    223 
    224 #if	!defined(ISP_DISABLE_FW) && !defined(ISP_COMPILE_FW)
    225 #define	ISP_COMPILE_FW	1
    226 #endif
    227 #endif	/* _ISP_NETBSD_H */
    228