1 /* $Id: isp_freebsd.h,v 1.13 1999/03/25 22:52:45 mjacob Exp $ */ 2 /* release_4_3_99 */ 3 /* 4 * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions (non CAM version) 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 #ifndef _ISP_FREEBSD_H 36 #define _ISP_FREEBSD_H 37 38 #define ISP_PLATFORM_VERSION_MAJOR 0 39 #define ISP_PLATFORM_VERSION_MINOR 991 40 41 #include <sys/param.h> 42 43 #ifndef __FreeBSD_version 44 #define __FreeBSD_version 226000 45 #endif 46 47 #if __FreeBSD_version >= 300004 48 #define MAXISPREQUEST 256 49 #include <dev/isp/isp_freebsd_cam.h> 50 #else 51 #define MAXISPREQUEST 64 52 #ifndef SCSI_ISP_PREFER_MEM_MAP 53 #define SCSI_ISP_PREFER_MEM_MAP 0 54 #endif 55 56 #include <sys/systm.h> 57 #include <sys/malloc.h> 58 #include <sys/buf.h> 59 #include <sys/proc.h> 60 61 #include <scsi/scsiconf.h> 62 #include <machine/clock.h> 63 #include <vm/vm.h> 64 #include <vm/vm_param.h> 65 #include <vm/pmap.h> 66 #include <sys/kernel.h> 67 68 69 #define ISP_SCSI_XFER_T struct scsi_xfer 70 71 struct isposinfo { 72 char name[8]; 73 int unit; 74 struct scsi_link _link; 75 int8_t delay_throttle_count; 76 }; 77 78 #include <dev/isp/ispreg.h> 79 #include <dev/isp/ispvar.h> 80 #include <dev/isp/ispmbox.h> 81 82 #define PVS "Qlogic ISP Driver, FreeBSD Non-Cam" 83 #define DFLT_DBLEVEL 1 84 #define ISP_LOCKVAL_DECL int isp_spl_save 85 #define ISP_ILOCKVAL_DECL ISP_LOCKVAL_DECL 86 #define ISP_UNLOCK(isp) (void) splx(isp_spl_save) 87 #define ISP_LOCK(isp) isp_spl_save = splbio() 88 #define ISP_ILOCK(isp) ISP_LOCK(isp) 89 #define ISP_IUNLOCK(isp) ISP_UNLOCK(isp) 90 #define IMASK bio_imask 91 92 #define XS_NULL(xs) xs == NULL || xs->sc_link == NULL 93 #define XS_ISP(xs) \ 94 ((struct ispsoftc *) (xs)->sc_link->adapter_softc) 95 #define XS_LUN(xs) ((int) (xs)->sc_link->lun) 96 #define XS_TGT(xs) ((int) (xs)->sc_link->target) 97 #define XS_RESID(xs) (xs)->resid 98 #define XS_XFRLEN(xs) (xs)->datalen 99 #define XS_CDBLEN(xs) (xs)->cmdlen 100 #define XS_CDBP(xs) (xs)->cmd 101 #define XS_STS(xs) (xs)->status 102 #define XS_TIME(xs) (xs)->timeout 103 #define XS_SNSP(xs) (&(xs)->sense) 104 #define XS_SNSLEN(xs) (sizeof((xs)->sense)) 105 #define XS_SNSKEY(xs) ((xs)->sense.ext.extended.flags) 106 107 #define HBA_NOERROR XS_NOERROR 108 #define HBA_BOTCH XS_DRIVER_STUFFUP 109 #define HBA_CMDTIMEOUT XS_TIMEOUT 110 #define HBA_SELTIMEOUT XS_SELTIMEOUT 111 #define HBA_TGTBSY XS_BUSY 112 #define HBA_BUSRESET XS_DRIVER_STUFFUP 113 #define HBA_ABORTED XS_DRIVER_STUFFUP 114 #define HBA_DATAOVR XS_DRIVER_STUFFUP 115 #define HBA_ARQFAIL XS_DRIVER_STUFFUP 116 117 #define XS_SNS_IS_VALID(xs) (xs)->error = XS_SENSE 118 #define XS_IS_SNS_VALID(xs) ((xs)->error == XS_SENSE) 119 120 #define XS_INITERR(xs) (xs)->error = 0 121 #define XS_SETERR(xs, v) (xs)->error = v 122 #define XS_ERR(xs) (xs)->error 123 #define XS_NOERR(xs) (xs)->error == XS_NOERROR 124 125 #define XS_CMD_DONE(xs) (xs)->flags |= ITSDONE, scsi_done(xs) 126 #define XS_IS_CMD_DONE(xs) (((xs)->flags & ITSDONE) != 0) 127 128 /* 129 * We decide whether to use tags based upon whether we're polling. 130 */ 131 #define XS_CANTAG(xs) (((xs)->flags & SCSI_NOMASK) != 0) 132 133 /* 134 * Our default tag 135 */ 136 #define XS_KINDOF_TAG(xs) REQFLAG_STAG 137 138 139 #define CMD_COMPLETE COMPLETE 140 #define CMD_EAGAIN TRY_AGAIN_LATER 141 #define CMD_QUEUED SUCCESSFULLY_QUEUED 142 143 #define isp_name isp_osinfo.name 144 145 #endif /* __FreeBSD_version >= 300004 */ 146 147 extern void isp_attach(struct ispsoftc *); 148 extern void isp_uninit(struct ispsoftc *); 149 150 #define MEMZERO bzero 151 #define MEMCPY(dst, src, amt) bcopy((src), (dst), (amt)) 152 #ifdef __alpha__ 153 #define MemoryBarrier alpha_mb 154 #else 155 #define MemoryBarrier() 156 #endif 157 158 159 #define DMA_MSW(x) (((x) >> 16) & 0xffff) 160 #define DMA_LSW(x) (((x) & 0xffff)) 161 162 #define IDPRINTF(lev, x) if (isp->isp_dblev >= lev) printf x 163 #define PRINTF printf 164 165 #define SYS_DELAY(x) DELAY(x) 166 167 #define FC_FW_READY_DELAY (5 * 1000000) 168 169 static __inline void isp_prtstst(ispstatusreq_t *sp); 170 static __inline const char *isp2100_fw_statename(int state); 171 static __inline const char *isp2100_pdb_statename(int pdb_state); 172 173 static __inline void isp_prtstst(ispstatusreq_t *sp) 174 { 175 char buf[128]; 176 sprintf(buf, "states->"); 177 if (sp->req_state_flags & RQSF_GOT_BUS) 178 sprintf(buf, "%s%s", buf, "GOT_BUS "); 179 if (sp->req_state_flags & RQSF_GOT_TARGET) 180 sprintf(buf, "%s%s", buf, "GOT_TGT "); 181 if (sp->req_state_flags & RQSF_SENT_CDB) 182 sprintf(buf, "%s%s", buf, "SENT_CDB "); 183 if (sp->req_state_flags & RQSF_XFRD_DATA) 184 sprintf(buf, "%s%s", buf, "XFRD_DATA "); 185 if (sp->req_state_flags & RQSF_GOT_STATUS) 186 sprintf(buf, "%s%s", buf, "GOT_STS "); 187 if (sp->req_state_flags & RQSF_GOT_SENSE) 188 sprintf(buf, "%s%s", buf, "GOT_SNS "); 189 if (sp->req_state_flags & RQSF_XFER_COMPLETE) 190 sprintf(buf, "%s%s", buf, "XFR_CMPLT "); 191 sprintf(buf, "%s%s", buf, "\n"); 192 sprintf(buf, "%s%s", buf, "status->"); 193 if (sp->req_status_flags & RQSTF_DISCONNECT) 194 sprintf(buf, "%s%s", buf, "Disconnect "); 195 if (sp->req_status_flags & RQSTF_SYNCHRONOUS) 196 sprintf(buf, "%s%s", buf, "Sync_xfr "); 197 if (sp->req_status_flags & RQSTF_PARITY_ERROR) 198 sprintf(buf, "%s%s", buf, "Parity "); 199 if (sp->req_status_flags & RQSTF_BUS_RESET) 200 sprintf(buf, "%s%s", buf, "Bus_Reset "); 201 if (sp->req_status_flags & RQSTF_DEVICE_RESET) 202 sprintf(buf, "%s%s", buf, "Device_Reset "); 203 if (sp->req_status_flags & RQSTF_ABORTED) 204 sprintf(buf, "%s%s", buf, "Aborted "); 205 if (sp->req_status_flags & RQSTF_TIMEOUT) 206 sprintf(buf, "%s%s", buf, "Timeout "); 207 if (sp->req_status_flags & RQSTF_NEGOTIATION) 208 sprintf(buf, "%s%s", buf, "Negotiation "); 209 sprintf(buf, "%s%s", buf, "\n"); 210 } 211 212 static __inline const char *isp2100_fw_statename(int state) 213 { 214 static char buf[16]; 215 switch(state) { 216 case FW_CONFIG_WAIT: return "Config Wait"; 217 case FW_WAIT_AL_PA: return "Waiting for AL_PA"; 218 case FW_WAIT_LOGIN: return "Wait Login"; 219 case FW_READY: return "Ready"; 220 case FW_LOSS_OF_SYNC: return "Loss Of Sync"; 221 case FW_ERROR: return "Error"; 222 case FW_REINIT: return "Re-Init"; 223 case FW_NON_PART: return "Nonparticipating"; 224 default: 225 sprintf(buf, "?0x%x?", state); 226 return buf; 227 } 228 } 229 230 static __inline const char *isp2100_pdb_statename(int pdb_state) 231 { 232 static char buf[16]; 233 switch(pdb_state) { 234 case PDB_STATE_DISCOVERY: return "Port Discovery"; 235 case PDB_STATE_WDISC_ACK: return "Waiting Port Discovery ACK"; 236 case PDB_STATE_PLOGI: return "Port Login"; 237 case PDB_STATE_PLOGI_ACK: return "Wait Port Login ACK"; 238 case PDB_STATE_PRLI: return "Process Login"; 239 case PDB_STATE_PRLI_ACK: return "Wait Process Login ACK"; 240 case PDB_STATE_LOGGED_IN: return "Logged In"; 241 case PDB_STATE_PORT_UNAVAIL: return "Port Unavailable"; 242 case PDB_STATE_PRLO: return "Process Logout"; 243 case PDB_STATE_PRLO_ACK: return "Wait Process Logout ACK"; 244 case PDB_STATE_PLOGO: return "Port Logout"; 245 case PDB_STATE_PLOG_ACK: return "Wait Port Logout ACK"; 246 default: 247 sprintf(buf, "?0x%x?", pdb_state); 248 return buf; 249 } 250 } 251 252 #endif /* _ISP_FREEBSD_H */ 253