isp_freebsd.h revision 59452
1/* $FreeBSD: head/sys/dev/isp/isp_freebsd.h 59452 2000-04-21 02:05:13Z mjacob $ */ 2/* 3 * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions (CAM version) 4 *--------------------------------------- 5 * Copyright (c) 1997, 1998, 1999 by Matthew Jacob 6 * NASA/Ames Research Center 7 * All rights reserved. 8 *--------------------------------------- 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 immediately at the beginning of the file, without modification, 15 * this list of conditions, and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 26 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 */ 34#ifndef _ISP_FREEBSD_H 35#define _ISP_FREEBSD_H 36 37#define ISP_PLATFORM_VERSION_MAJOR 5 38#define ISP_PLATFORM_VERSION_MINOR 0 39 40 41#include <sys/param.h> 42#include <sys/param.h> 43#include <sys/systm.h> 44#include <sys/kernel.h> 45#include <sys/queue.h> 46#include <sys/malloc.h> 47 48#include <machine/bus_memio.h> 49#include <machine/bus_pio.h> 50#include <machine/bus.h> 51#include <machine/clock.h> 52 53#include <cam/cam.h> 54#include <cam/cam_debug.h> 55#include <cam/cam_ccb.h> 56#include <cam/cam_sim.h> 57#include <cam/cam_xpt.h> 58#include <cam/cam_xpt_sim.h> 59#include <cam/cam_debug.h> 60#include <cam/scsi/scsi_all.h> 61#include <cam/scsi/scsi_message.h> 62 63#include "opt_ddb.h" 64#include "opt_isp.h" 65#ifdef SCSI_ISP_FABRIC 66#define ISP2100_FABRIC 1 67#define ISP2100_SCRLEN 0x400 68#else 69#define ISP2100_SCRLEN 0x100 70#endif 71#ifdef SCSI_ISP_SCCLUN 72#define ISP2100_SCCLUN 1 73#endif 74 75#ifndef SCSI_CHECK 76#define SCSI_CHECK SCSI_STATUS_CHECK_COND 77#endif 78#ifndef SCSI_BUSY 79#define SCSI_BUSY SCSI_STATUS_BUSY 80#endif 81#ifndef SCSI_QFULL 82#define SCSI_QFULL SCSI_STATUS_QUEUE_FULL 83#endif 84 85#define ISP_SCSI_XFER_T struct ccb_scsiio 86 87#ifdef ISP_TARGET_MODE 88typedef struct tstate { 89 struct tstate *next; 90 struct cam_path *owner; 91 struct ccb_hdr_slist atios; 92 struct ccb_hdr_slist inots; 93 lun_id_t lun; 94 u_int32_t hold; 95} tstate_t; 96 97/* 98 * This should work very well for 100% of parallel SCSI cases, 100% 99 * of non-SCCLUN FC cases, and hopefully some larger fraction of the 100 * SCCLUN FC cases. Basically, we index by the low 5 bits of lun and 101 * then linear search. This has to be reasonably zippy, but not crucially 102 * so. 103 */ 104#define LUN_HASH_SIZE 32 105#define LUN_HASH_FUNC(lun) ((lun) & 0x1f) 106 107#endif 108 109struct isposinfo { 110 struct ispsoftc * next; 111 u_int64_t default_wwn; 112 char name[8]; 113 int unit; 114 struct cam_sim *sim; 115 struct cam_path *path; 116 struct cam_sim *sim2; 117 struct cam_path *path2; 118 volatile char simqfrozen; 119#ifdef ISP_TARGET_MODE 120#define TM_WANTED 0x01 121#define TM_BUSY 0x02 122#define TM_TMODE_ENABLED 0x80 123 u_int8_t tmflags; 124 u_int8_t rstatus; 125 u_int16_t rollinfo; 126 tstate_t tsdflt; 127 tstate_t *lun_hash[LUN_HASH_SIZE]; 128#endif 129}; 130#define SIMQFRZ_RESOURCE 0x1 131#define SIMQFRZ_LOOPDOWN 0x2 132#define SIMQFRZ_TIMED 0x4 133 134#define isp_sim isp_osinfo.sim 135#define isp_path isp_osinfo.path 136#define isp_sim2 isp_osinfo.sim2 137#define isp_path2 isp_osinfo.path2 138#define isp_unit isp_osinfo.unit 139#define isp_name isp_osinfo.name 140 141#define MAXISPREQUEST 256 142 143#include <dev/isp/ispreg.h> 144#include <dev/isp/ispvar.h> 145#include <dev/isp/ispmbox.h> 146 147#define DFLT_DBLEVEL isp_debug 148extern int isp_debug; 149#define ISP_LOCKVAL_DECL int isp_spl_save 150#define ISP_ILOCKVAL_DECL ISP_LOCKVAL_DECL 151#define ISP_UNLOCK(isp) (void) splx(isp_spl_save) 152#define ISP_LOCK(isp) isp_spl_save = splcam() 153#define ISP_ILOCK(isp) ISP_LOCK(isp) 154#define ISP_IUNLOCK(isp) ISP_UNLOCK(isp) 155#define IMASK cam_imask 156 157#define XS_NULL(ccb) ccb == NULL 158#define XS_ISP(ccb) ((struct ispsoftc *) (ccb)->ccb_h.spriv_ptr1) 159 160#define XS_LUN(ccb) (ccb)->ccb_h.target_lun 161#define XS_TGT(ccb) (ccb)->ccb_h.target_id 162#define XS_CHANNEL(ccb) cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path)) 163#define XS_RESID(ccb) (ccb)->resid 164#define XS_XFRLEN(ccb) (ccb)->dxfer_len 165#define XS_CDBLEN(ccb) (ccb)->cdb_len 166#define XS_CDBP(ccb) (((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \ 167 (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes) 168#define XS_STS(ccb) (ccb)->scsi_status 169#define XS_TIME(ccb) (ccb)->ccb_h.timeout 170#define XS_SNSP(ccb) (&(ccb)->sense_data) 171#define XS_SNSLEN(ccb) \ 172 imin((sizeof((ccb)->sense_data)), ccb->sense_len) 173#define XS_SNSKEY(ccb) ((ccb)->sense_data.flags & 0xf) 174 175/* 176 * A little tricky- HBA_NOERROR is "in progress" so 177 * that XS_CMD_DONE can transition this to CAM_REQ_CMP. 178 */ 179#define HBA_NOERROR CAM_REQ_INPROG 180#define HBA_BOTCH CAM_UNREC_HBA_ERROR 181#define HBA_CMDTIMEOUT CAM_CMD_TIMEOUT 182#define HBA_SELTIMEOUT CAM_SEL_TIMEOUT 183#define HBA_TGTBSY CAM_SCSI_STATUS_ERROR 184#define HBA_BUSRESET CAM_SCSI_BUS_RESET 185#define HBA_ABORTED CAM_REQ_ABORTED 186#define HBA_DATAOVR CAM_DATA_RUN_ERR 187#define HBA_ARQFAIL CAM_AUTOSENSE_FAIL 188 189#define XS_SNS_IS_VALID(ccb) ((ccb)->ccb_h.status |= CAM_AUTOSNS_VALID) 190#define XS_IS_SNS_VALID(ccb) (((ccb)->ccb_h.status & CAM_AUTOSNS_VALID) != 0) 191 192#define XS_INITERR(ccb) \ 193 (ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \ 194 (ccb)->ccb_h.status |= CAM_REQ_INPROG, \ 195 (ccb)->ccb_h.spriv_field0 = CAM_REQ_INPROG 196#define XS_SETERR(ccb, v) (ccb)->ccb_h.spriv_field0 = v 197#define XS_ERR(ccb) (ccb)->ccb_h.spriv_field0 198#define XS_NOERR(ccb) \ 199 ((ccb)->ccb_h.spriv_field0 == CAM_REQ_INPROG) 200 201extern void isp_done(struct ccb_scsiio *); 202#define XS_CMD_DONE(sccb) isp_done(sccb) 203 204#define XS_IS_CMD_DONE(ccb) \ 205 (((ccb)->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) 206 207/* 208 * Can we tag? 209 */ 210#define XS_CANTAG(ccb) (((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) \ 211 && (ccb)->tag_action != CAM_TAG_ACTION_NONE) 212/* 213 * And our favorite tag is.... 214 */ 215#define XS_KINDOF_TAG(ccb) \ 216 ((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \ 217 ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG)) 218 219#define CMD_COMPLETE 0 220#define CMD_EAGAIN 1 221#define CMD_QUEUED 2 222#define CMD_RQLATER 3 223#define STOP_WATCHDOG(f, s) 224 225extern void isp_attach(struct ispsoftc *); 226extern void isp_uninit(struct ispsoftc *); 227 228#define MEMZERO bzero 229#define MEMCPY(dst, src, amt) bcopy((src), (dst), (amt)) 230#ifdef __alpha__ 231#define MemoryBarrier alpha_mb 232#else 233#define MemoryBarrier() 234#endif 235 236 237#define DMA_MSW(x) (((x) >> 16) & 0xffff) 238#define DMA_LSW(x) (((x) & 0xffff)) 239 240#define ISP_UNSWIZZLE_AND_COPY_PDBP(isp, dest, src) \ 241 bcopy(src, dest, sizeof (isp_pdb_t)) 242#define ISP_SWIZZLE_ICB(a, b) 243#define ISP_SWIZZLE_REQUEST(a, b) 244#define ISP_UNSWIZZLE_RESPONSE(a, b) 245#define ISP_SWIZZLE_SNS_REQ(a, b) 246#define ISP_UNSWIZZLE_SNS_RSP(a, b, c) 247 248#define IDPRINTF(lev, x) if (isp->isp_dblev >= (u_int8_t) lev) printf x 249#define PRINTF printf 250#define CFGPRINTF if (bootverbose || DFLT_DBLEVEL > 1) printf 251 252#define SYS_DELAY(x) DELAY(x) 253 254#define FC_FW_READY_DELAY (5 * 1000000) 255#define DEFAULT_LOOPID(x) 109 256#define DEFAULT_WWN(x) (x)->isp_osinfo.default_wwn 257 258#define INLINE __inline 259#include <dev/isp/isp_inline.h> 260#endif /* _ISP_FREEBSD_H */ 261