Home | History | Annotate | Line # | Download | only in ic
isp_netbsd.h revision 1.14
      1 /* $NetBSD: isp_netbsd.h,v 1.14 1999/05/12 18:59:24 mjacob Exp $ */
      2 /* release_5_11_99 */
      3 /*
      4  * NetBSD Specific definitions for the Qlogic ISP Host Adapter
      5  *
      6  *---------------------------------------
      7  * Copyright (c) 1997, 1998 by Matthew Jacob
      8  * NASA/Ames Research Center
      9  * All rights reserved.
     10  *---------------------------------------
     11  *
     12  * Redistribution and use in source and binary forms, with or without
     13  * modification, are permitted provided that the following conditions
     14  * are met:
     15  * 1. Redistributions of source code must retain the above copyright
     16  *    notice immediately at the beginning of the file, without modification,
     17  *    this list of conditions, and the following disclaimer.
     18  * 2. Redistributions in binary form must reproduce the above copyright
     19  *    notice, this list of conditions and the following disclaimer in the
     20  *    documentation and/or other materials provided with the distribution.
     21  * 3. The name of the author may not be used to endorse or promote products
     22  *    derived from this software without specific prior written permission.
     23  *
     24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     27  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
     28  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     34  * SUCH DAMAGE.
     35  *
     36  */
     37 
     38 #ifndef	_ISP_NETBSD_H
     39 #define	_ISP_NETBSD_H
     40 
     41 #include <sys/types.h>
     42 #include <sys/param.h>
     43 #include <sys/systm.h>
     44 #include <sys/kernel.h>
     45 #include <sys/errno.h>
     46 #include <sys/ioctl.h>
     47 #include <sys/device.h>
     48 #include <sys/malloc.h>
     49 #include <sys/buf.h>
     50 #include <sys/proc.h>
     51 #include <sys/user.h>
     52 
     53 
     54 #include <dev/scsipi/scsi_all.h>
     55 #include <dev/scsipi/scsipi_all.h>
     56 #include <dev/scsipi/scsiconf.h>
     57 
     58 #include <dev/scsipi/scsi_message.h>
     59 #include <dev/scsipi/scsipi_debug.h>
     60 
     61 #include <vm/vm.h>
     62 #include <vm/vm_param.h>
     63 #include <vm/pmap.h>
     64 
     65 #define	ISP_PLATFORM_VERSION_MAJOR	0
     66 #define	ISP_PLATFORM_VERSION_MINOR	995
     67 
     68 #define	ISP_SCSI_XFER_T		struct scsipi_xfer
     69 struct isposinfo {
     70 	struct device		_dev;
     71 	struct scsipi_link	_link;
     72 	struct scsipi_link	_link_b;
     73 	struct scsipi_adapter   _adapter;
     74 	int			blocked;
     75 	TAILQ_HEAD(, scsipi_xfer) waitq;
     76 };
     77 #define	MAXISPREQUEST	256
     78 
     79 #include <dev/ic/ispreg.h>
     80 #include <dev/ic/ispvar.h>
     81 #include <dev/ic/ispmbox.h>
     82 
     83 #define	PRINTF			printf
     84 #define	IDPRINTF(lev, x)	if (isp->isp_dblev >= lev) printf x
     85 
     86 #define	MEMZERO			bzero
     87 #define	MEMCPY(dst, src, count)	bcopy((src), (dst), (count))
     88 #ifdef	__alpha__
     89 #define	MemoryBarrier	alpha_mb
     90 #else
     91 #define	MemoryBarrier()
     92 #endif
     93 
     94 #define	DMA_MSW(x)	(((x) >> 16) & 0xffff)
     95 #define	DMA_LSW(x)	(((x) & 0xffff))
     96 
     97 #if	defined(SCSIDEBUG)
     98 #define	DFLT_DBLEVEL		3
     99 #else
    100 #if	defined(DEBUG)
    101 #define	DFLT_DBLEVEL		2
    102 #else
    103 #define	DFLT_DBLEVEL		1
    104 #endif
    105 #endif
    106 
    107 #define	ISP_LOCKVAL_DECL	int isp_spl_save
    108 #define	ISP_ILOCKVAL_DECL	ISP_LOCKVAL_DECL
    109 #define	ISP_LOCK(x)		isp_spl_save = splbio()
    110 #define	ISP_UNLOCK(x)		(void) splx(isp_spl_save)
    111 #define	ISP_ILOCK		ISP_LOCK
    112 #define	ISP_IUNLOCK		ISP_UNLOCK
    113 
    114 
    115 #define	XS_NULL(xs)		xs == NULL || xs->sc_link == NULL
    116 #define	XS_ISP(xs)		(xs)->sc_link->adapter_softc
    117 #define	XS_LUN(xs)		((int) (xs)->sc_link->scsipi_scsi.lun)
    118 #define	XS_TGT(xs)		((int) (xs)->sc_link->scsipi_scsi.target)
    119 #define	XS_CHANNEL(xs)		\
    120     (((xs)->sc_link == &(((struct ispsoftc *)XS_ISP(xs))->isp_osinfo._link_b))?\
    121     1 : 0)
    122 #define	XS_RESID(xs)		(xs)->resid
    123 #define	XS_XFRLEN(xs)		(xs)->datalen
    124 #define	XS_CDBLEN(xs)		(xs)->cmdlen
    125 #define	XS_CDBP(xs)		((caddr_t) (xs)->cmd)
    126 #define	XS_STS(xs)		(xs)->status
    127 #define	XS_TIME(xs)		(xs)->timeout
    128 #define	XS_SNSP(xs)		(&(xs)->sense.scsi_sense)
    129 #define	XS_SNSLEN(xs)		(sizeof (xs)->sense.scsi_sense)
    130 #define	XS_SNSKEY(xs)		((xs)->sense.scsi_sense.flags)
    131 
    132 #define	HBA_NOERROR		XS_NOERROR
    133 #define	HBA_BOTCH		XS_DRIVER_STUFFUP
    134 #define	HBA_CMDTIMEOUT		XS_TIMEOUT
    135 #define	HBA_SELTIMEOUT		XS_SELTIMEOUT
    136 #define	HBA_TGTBSY		XS_BUSY
    137 #ifdef	XS_RESET
    138 #define	HBA_BUSRESET		XS_RESET
    139 #else
    140 #define	HBA_BUSRESET		XS_DRIVER_STUFFUP
    141 #endif
    142 #define	HBA_ABORTED		XS_DRIVER_STUFFUP
    143 #define	HBA_DATAOVR		XS_DRIVER_STUFFUP
    144 #define	HBA_ARQFAIL		XS_DRIVER_STUFFUP
    145 
    146 #define	XS_SNS_IS_VALID(xs)	(xs)->error = XS_SENSE
    147 #define	XS_IS_SNS_VALID(xs)	((xs)->error == XS_SENSE)
    148 
    149 #define	XS_INITERR(xs)		(xs)->error = 0
    150 #define	XS_SETERR(xs, v)	(xs)->error = v
    151 #define	XS_ERR(xs)		(xs)->error
    152 #define	XS_NOERR(xs)		(xs)->error == XS_NOERROR
    153 
    154 #define	XS_CMD_DONE(xs)		(xs)->flags |= ITSDONE, scsipi_done(xs)
    155 #define	XS_IS_CMD_DONE(xs)	(((xs)->flags & ITSDONE) != 0)
    156 
    157 /*
    158  * We use whether or not we're a polled command to decide about tagging.
    159  */
    160 #define	XS_CANTAG(xs)		(((xs)->flags & SCSI_POLL) != 0)
    161 
    162 /*
    163  * This is our default tag (ordered).
    164  */
    165 #define	XS_KINDOF_TAG(xs)	\
    166 	(((xs)->flags & SCSI_URGENT)? REQFLAG_HTAG : REQFLAG_STAG)
    167 
    168 #define	CMD_COMPLETE		COMPLETE
    169 #define	CMD_EAGAIN		TRY_AGAIN_LATER
    170 #define	CMD_QUEUED		SUCCESSFULLY_QUEUED
    171 
    172 
    173 
    174 #define	isp_name	isp_osinfo._dev.dv_xname
    175 
    176 #define	SCSI_QFULL	0x28
    177 
    178 
    179 #define	SYS_DELAY(x)	delay(x)
    180 
    181 #define	WATCH_INTERVAL	30
    182 
    183 #define	FC_FW_READY_DELAY	(12 * 1000000)
    184 
    185 extern void isp_attach __P((struct ispsoftc *));
    186 extern void isp_uninit __P((struct ispsoftc *));
    187 
    188 static inline void isp_prtstst(ispstatusreq_t *sp)
    189 {
    190 	char buf[128];
    191 	sprintf(buf, "states->");
    192 	if (sp->req_state_flags & RQSF_GOT_BUS)
    193 		sprintf(buf, "%s%s", buf, "GOT_BUS ");
    194 	if (sp->req_state_flags & RQSF_GOT_TARGET)
    195 		sprintf(buf, "%s%s", buf, "GOT_TGT ");
    196 	if (sp->req_state_flags & RQSF_SENT_CDB)
    197 		sprintf(buf, "%s%s", buf, "SENT_CDB ");
    198 	if (sp->req_state_flags & RQSF_XFRD_DATA)
    199 		sprintf(buf, "%s%s", buf, "XFRD_DATA ");
    200 	if (sp->req_state_flags & RQSF_GOT_STATUS)
    201 		sprintf(buf, "%s%s", buf, "GOT_STS ");
    202 	if (sp->req_state_flags & RQSF_GOT_SENSE)
    203 		sprintf(buf, "%s%s", buf, "GOT_SNS ");
    204 	if (sp->req_state_flags & RQSF_XFER_COMPLETE)
    205 		sprintf(buf, "%s%s", buf, "XFR_CMPLT ");
    206 	sprintf(buf, "%s%s", buf, "\n");
    207 	sprintf(buf, "%s%s", buf, "status->");
    208 	if (sp->req_status_flags & RQSTF_DISCONNECT)
    209 		sprintf(buf, "%s%s", buf, "Disconnect ");
    210 	if (sp->req_status_flags & RQSTF_SYNCHRONOUS)
    211 		sprintf(buf, "%s%s", buf, "Sync_xfr ");
    212 	if (sp->req_status_flags & RQSTF_PARITY_ERROR)
    213 		sprintf(buf, "%s%s", buf, "Parity ");
    214 	if (sp->req_status_flags & RQSTF_BUS_RESET)
    215 		sprintf(buf, "%s%s", buf, "Bus_Reset ");
    216 	if (sp->req_status_flags & RQSTF_DEVICE_RESET)
    217 		sprintf(buf, "%s%s", buf, "Device_Reset ");
    218 	if (sp->req_status_flags & RQSTF_ABORTED)
    219 		sprintf(buf, "%s%s", buf, "Aborted ");
    220 	if (sp->req_status_flags & RQSTF_TIMEOUT)
    221 		sprintf(buf, "%s%s", buf, "Timeout ");
    222 	if (sp->req_status_flags & RQSTF_NEGOTIATION)
    223 		sprintf(buf, "%s%s", buf, "Negotiation ");
    224 	printf("%s\n", buf);
    225 }
    226 
    227 static inline const char *isp2100_fw_statename(int state)
    228 {
    229 	static char buf[16];
    230 	switch(state) {
    231 	case FW_CONFIG_WAIT:	return "Config Wait";
    232 	case FW_WAIT_AL_PA:	return "Waiting for AL_PA";
    233 	case FW_WAIT_LOGIN:	return "Wait Login";
    234 	case FW_READY:		return "Ready";
    235 	case FW_LOSS_OF_SYNC:	return "Loss Of Sync";
    236 	case FW_ERROR:		return "Error";
    237 	case FW_REINIT:		return "Re-Init";
    238 	case FW_NON_PART:	return "Nonparticipating";
    239 	default:
    240 		sprintf(buf, "0x%x", state);
    241 		return buf;
    242     }
    243 }
    244 
    245 static inline const char *isp2100_pdb_statename(int pdb_state)
    246 {
    247 	static char buf[16];
    248 	switch(pdb_state) {
    249 	case PDB_STATE_DISCOVERY:	return "Port Discovery";
    250 	case PDB_STATE_WDISC_ACK:	return "Waiting Port Discovery ACK";
    251 	case PDB_STATE_PLOGI:		return "Port Login";
    252 	case PDB_STATE_PLOGI_ACK:	return "Wait Port Login ACK";
    253 	case PDB_STATE_PRLI:		return "Process Login";
    254 	case PDB_STATE_PRLI_ACK:	return "Wait Process Login ACK";
    255 	case PDB_STATE_LOGGED_IN:	return "Logged In";
    256 	case PDB_STATE_PORT_UNAVAIL:	return "Port Unavailable";
    257 	case PDB_STATE_PRLO:		return "Process Logout";
    258 	case PDB_STATE_PRLO_ACK:	return "Wait Process Logout ACK";
    259 	case PDB_STATE_PLOGO:		return "Port Logout";
    260 	case PDB_STATE_PLOG_ACK:	return "Wait Port Logout ACK";
    261 	default:
    262 		sprintf(buf, "0x%x", pdb_state);
    263 		return buf;
    264 	}
    265 }
    266 
    267 /*
    268  * Keep these off for now...
    269  */
    270 
    271 #define	ISP_NO_FASTPOST_SCSI	1
    272 #define	ISP_NO_FASTPOST_FC	1
    273 
    274 #endif	/* _ISP_NETBSD_H */
    275