Home | History | Annotate | Line # | Download | only in ic
isp_netbsd.h revision 1.5
      1 /* $NetBSD: isp_netbsd.h,v 1.5 1998/11/19 21:53:00 thorpej Exp $ */
      2 /*
      3  * NetBSD Specific definitions for the Qlogic ISP Host Adapter
      4  *
      5  *---------------------------------------
      6  * Copyright (c) 1997, 1998 by Matthew Jacob
      7  * NASA/Ames Research Center
      8  * All rights reserved.
      9  *---------------------------------------
     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	_ISP_NETBSD_H
     38 #define	_ISP_NETBSD_H
     39 
     40 #include <sys/types.h>
     41 #include <sys/param.h>
     42 #include <sys/systm.h>
     43 #include <sys/kernel.h>
     44 #include <sys/errno.h>
     45 #include <sys/ioctl.h>
     46 #include <sys/device.h>
     47 #include <sys/malloc.h>
     48 #include <sys/buf.h>
     49 #include <sys/proc.h>
     50 #include <sys/user.h>
     51 
     52 
     53 #include <dev/scsipi/scsi_all.h>
     54 #include <dev/scsipi/scsipi_all.h>
     55 #include <dev/scsipi/scsiconf.h>
     56 
     57 #include <dev/scsipi/scsi_message.h>
     58 #include <dev/scsipi/scsipi_debug.h>
     59 
     60 #include <vm/vm.h>
     61 #include <vm/vm_param.h>
     62 #include <vm/pmap.h>
     63 
     64 #define	ISP_PLATFORM_VERSION_MAJOR	0
     65 #define	ISP_PLATFORM_VERSION_MINOR	98
     66 
     67 #define	ISP_SCSI_XFER_T		struct scsipi_xfer
     68 struct isposinfo {
     69 	struct device		_dev;
     70 	struct scsipi_link	_link;
     71 	struct scsipi_adapter	_adapter;
     72 };
     73 #define	MAXISPREQUEST	256
     74 
     75 #include <dev/ic/ispreg.h>
     76 #include <dev/ic/ispvar.h>
     77 #include <dev/ic/ispmbox.h>
     78 
     79 #define	PRINTF			printf
     80 #define	IDPRINTF(lev, x)	if (isp->isp_dblev >= lev) printf x
     81 
     82 #if	defined(SCSIDEBUG)
     83 #define	DFLT_DBLEVEL		3
     84 #else
     85 #if	defined(DEBUG)
     86 #define	DFLT_DBLEVEL		2
     87 #else
     88 #define	DFLT_DBLEVEL		1
     89 #endif
     90 #endif
     91 
     92 #define	ISP_LOCKVAL_DECL	int isp_spl_save
     93 #define	ISP_LOCK(x)		isp_spl_save = splbio()
     94 #define	ISP_UNLOCK(x)		(void) splx(isp_spl_save)
     95 #define	ISP_ILOCK		ISP_LOCK
     96 #define	ISP_IUNLOCK		ISP_UNLOCK
     97 
     98 
     99 #define	XS_NULL(xs)		xs == NULL || xs->sc_link == NULL
    100 #define	XS_ISP(xs)		(xs)->sc_link->adapter_softc
    101 #define	XS_LUN(xs)		(xs)->sc_link->scsipi_scsi.lun
    102 #define	XS_TGT(xs)		(xs)->sc_link->scsipi_scsi.target
    103 #define	XS_RESID(xs)		(xs)->resid
    104 #define	XS_XFRLEN(xs)		(xs)->datalen
    105 #define	XS_CDBLEN(xs)		(xs)->cmdlen
    106 #define	XS_CDBP(xs)		(xs)->cmd
    107 #define	XS_STS(xs)		(xs)->status
    108 #define	XS_TIME(xs)		(xs)->timeout
    109 #define	XS_SNSP(xs)		(&(xs)->sense.scsi_sense)
    110 #define	XS_SNSLEN(xs)		(sizeof (xs)->sense.scsi_sense)
    111 #define	XS_SNSKEY(xs)		((xs)->sense.scsi_sense.flags)
    112 
    113 #define	HBA_NOERROR		XS_NOERROR
    114 #define	HBA_BOTCH		XS_DRIVER_STUFFUP
    115 #define	HBA_CMDTIMEOUT		XS_TIMEOUT
    116 #define	HBA_SELTIMEOUT		XS_SELTIMEOUT
    117 #define	HBA_TGTBSY		XS_BUSY
    118 #ifdef	XS_RESET
    119 #define	HBA_BUSRESET		XS_RESET
    120 #else
    121 #define	HBA_BUSRESET		XS_DRIVER_STUFFUP
    122 #endif
    123 #define	HBA_ABORTED		XS_DRIVER_STUFFUP
    124 #define	HBA_DATAOVR		XS_DRIVER_STUFFUP
    125 #define	HBA_ARQFAIL		XS_DRIVER_STUFFUP
    126 
    127 #define	XS_SNS_IS_VALID(xs)	(xs)->error = XS_SENSE
    128 #define	XS_IS_SNS_VALID(xs)	((xs)->error == XS_SENSE)
    129 
    130 #define	XS_INITERR(xs)		(xs)->error = 0
    131 #define	XS_SETERR(xs, v)	(xs)->error = v
    132 #define	XS_ERR(xs)		(xs)->error
    133 #define	XS_NOERR(xs)		(xs)->error == XS_NOERROR
    134 
    135 #define	XS_CMD_DONE(xs)		(xs)->flags |= ITSDONE, scsipi_done(xs)
    136 #define	XS_IS_CMD_DONE(xs)	(((xs)->flags & ITSDONE) != 0)
    137 
    138 /*
    139  * We use whether or not we're a polled command to decide about tagging.
    140  */
    141 #define	XS_CANTAG(xs)		(((xs)->flags & SCSI_POLL) != 0)
    142 
    143 /*
    144  * This is our default tag (ordered).
    145  */
    146 #define	XS_KINDOF_TAG(xs)	\
    147 	(((xs)->flags & SCSI_URGENT)? REQFLAG_HTAG : REQFLAG_STAG)
    148 
    149 #define	CMD_COMPLETE		COMPLETE
    150 #define	CMD_EAGAIN		TRY_AGAIN_LATER
    151 #define	CMD_QUEUED		SUCCESSFULLY_QUEUED
    152 
    153 
    154 
    155 #define	isp_name	isp_osinfo._dev.dv_xname
    156 
    157 
    158 #define	SYS_DELAY(x)	delay(x)
    159 
    160 #define	WATCH_INTERVAL		30
    161 #define	START_WATCHDOG(f, s)	\
    162 	timeout(f, s, WATCH_INTERVAL * hz), s->isp_dogactive = 1
    163 
    164 #define	RESTART_WATCHDOG(f, s)		START_WATCHDOG(f, s)
    165 #define	STOP_WATCHDOG(f, s)		untimeout(f, s), s->isp_dogactive = 0
    166 
    167 
    168 extern void isp_attach __P((struct ispsoftc *));
    169 
    170 #endif	/* _ISP_NETBSD_H */
    171