isp_freebsd.h revision 61773 
1/* $FreeBSD: head/sys/dev/isp/isp_freebsd.h 61773 2000-06-18 04:47:12Z 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	2
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/*
66 * We are now always supporting fabric mode.
67 */
68#define	ISP2100_FABRIC		1
69#define	ISP2100_SCRLEN		0x400
70
71#ifndef	SCSI_CHECK
72#define	SCSI_CHECK	SCSI_STATUS_CHECK_COND
73#endif
74#ifndef	SCSI_BUSY
75#define	SCSI_BUSY	SCSI_STATUS_BUSY
76#endif
77#ifndef	SCSI_QFULL
78#define	SCSI_QFULL	SCSI_STATUS_QUEUE_FULL
79#endif
80
81#define	ISP_SCSI_XFER_T		struct ccb_scsiio
82typedef void ispfwfunc __P((int, int, int, const u_int16_t **));
83
84#ifdef	ISP_TARGET_MODE
85typedef struct tstate {
86	struct tstate *next;
87	struct cam_path *owner;
88	struct ccb_hdr_slist atios;
89	struct ccb_hdr_slist inots;
90	lun_id_t lun;
91	u_int32_t hold;
92} tstate_t;
93
94/*
95 * This should work very well for 100% of parallel SCSI cases, 100%
96 * of non-SCCLUN FC cases, and hopefully some larger fraction of the
97 * SCCLUN FC cases. Basically, we index by the low 5 bits of lun and
98 * then linear search. This has to be reasonably zippy, but not crucially
99 * so.
100 */
101#define	LUN_HASH_SIZE		32
102#define	LUN_HASH_FUNC(lun)	((lun) & 0x1f)
103
104#endif
105
106struct isposinfo {
107	struct ispsoftc *	next;
108	u_int64_t		default_wwn;
109	char			name[8];
110	int			unit;
111	struct cam_sim		*sim;
112	struct cam_path		*path;
113	struct cam_sim		*sim2;
114	struct cam_path		*path2;
115	volatile char		simqfrozen;
116#ifdef	ISP_TARGET_MODE
117#define	TM_WANTED		0x01
118#define	TM_BUSY			0x02
119#define	TM_TMODE_ENABLED	0x80
120	u_int8_t		tmflags;
121	u_int8_t		rstatus;
122	u_int16_t		rollinfo;
123	tstate_t		tsdflt;
124	tstate_t		*lun_hash[LUN_HASH_SIZE];
125#endif
126};
127#define	SIMQFRZ_RESOURCE	0x1
128#define	SIMQFRZ_LOOPDOWN	0x2
129#define	SIMQFRZ_TIMED		0x4
130
131#define	isp_sim		isp_osinfo.sim
132#define	isp_path	isp_osinfo.path
133#define	isp_sim2	isp_osinfo.sim2
134#define	isp_path2	isp_osinfo.path2
135#define	isp_unit	isp_osinfo.unit
136#define	isp_name	isp_osinfo.name
137
138#define	MAXISPREQUEST		256
139
140#include <dev/isp/ispreg.h>
141#include <dev/isp/ispvar.h>
142#include <dev/isp/ispmbox.h>
143
144#define	DFLT_DBLEVEL		isp_debug
145extern int isp_debug;
146#define	ISP_LOCKVAL_DECL	int isp_spl_save
147#define	ISP_ILOCKVAL_DECL	ISP_LOCKVAL_DECL
148#define	ISP_UNLOCK(isp)		(void) splx(isp_spl_save)
149#define	ISP_LOCK(isp)		isp_spl_save = splcam()
150#define	ISP_ILOCK(isp)		ISP_LOCK(isp)
151#define	ISP_IUNLOCK(isp)	ISP_UNLOCK(isp)
152#define	IMASK			cam_imask
153
154#define	XS_NULL(ccb)		ccb == NULL
155#define	XS_ISP(ccb)		((struct ispsoftc *) (ccb)->ccb_h.spriv_ptr1)
156
157#define	XS_LUN(ccb)		(ccb)->ccb_h.target_lun
158#define	XS_TGT(ccb)		(ccb)->ccb_h.target_id
159#define	XS_CHANNEL(ccb)		cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
160#define	XS_RESID(ccb)		(ccb)->resid
161#define	XS_XFRLEN(ccb)		(ccb)->dxfer_len
162#define	XS_CDBLEN(ccb)		(ccb)->cdb_len
163#define	XS_CDBP(ccb)		(((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
164	(ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)
165#define	XS_STS(ccb)		(ccb)->scsi_status
166#define	XS_TIME(ccb)		(ccb)->ccb_h.timeout
167#define	XS_SNSP(ccb)		(&(ccb)->sense_data)
168#define	XS_SNSLEN(ccb)		\
169	imin((sizeof((ccb)->sense_data)), ccb->sense_len)
170#define	XS_SNSKEY(ccb)		((ccb)->sense_data.flags & 0xf)
171
172/*
173 * A little tricky- HBA_NOERROR is "in progress" so
174 * that XS_CMD_DONE can transition this to CAM_REQ_CMP.
175 */
176#define	HBA_NOERROR		CAM_REQ_INPROG
177#define	HBA_BOTCH		CAM_UNREC_HBA_ERROR
178#define	HBA_CMDTIMEOUT		CAM_CMD_TIMEOUT
179#define	HBA_SELTIMEOUT		CAM_SEL_TIMEOUT
180#define	HBA_TGTBSY		CAM_SCSI_STATUS_ERROR
181#define	HBA_BUSRESET		CAM_SCSI_BUS_RESET
182#define	HBA_ABORTED		CAM_REQ_ABORTED
183#define	HBA_DATAOVR		CAM_DATA_RUN_ERR
184#define	HBA_ARQFAIL		CAM_AUTOSENSE_FAIL
185
186#define	XS_SNS_IS_VALID(ccb) ((ccb)->ccb_h.status |= CAM_AUTOSNS_VALID)
187#define	XS_IS_SNS_VALID(ccb) (((ccb)->ccb_h.status & CAM_AUTOSNS_VALID) != 0)
188
189#define	XS_INITERR(ccb)		\
190	(ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
191	(ccb)->ccb_h.status |= CAM_REQ_INPROG, \
192	(ccb)->ccb_h.spriv_field0 = CAM_REQ_INPROG
193#define	XS_SETERR(ccb, v)	(ccb)->ccb_h.spriv_field0 = v
194#define	XS_ERR(ccb)		(ccb)->ccb_h.spriv_field0
195#define	XS_NOERR(ccb)		\
196	((ccb)->ccb_h.spriv_field0 == CAM_REQ_INPROG)
197
198extern void isp_done(struct ccb_scsiio *);
199#define	XS_CMD_DONE(sccb)	isp_done(sccb)
200
201#define	XS_IS_CMD_DONE(ccb)	\
202	(((ccb)->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG)
203
204/*
205 * Can we tag?
206 */
207#define	XS_CANTAG(ccb)		(((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) \
208				  && (ccb)->tag_action != CAM_TAG_ACTION_NONE)
209/*
210 * And our favorite tag is....
211 */
212#define	XS_KINDOF_TAG(ccb)	\
213	((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \
214	  ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG))
215
216#define	CMD_COMPLETE		0
217#define	CMD_EAGAIN		1
218#define	CMD_QUEUED		2
219#define	CMD_RQLATER		3
220#define	STOP_WATCHDOG(f, s)
221
222extern void isp_attach(struct ispsoftc *);
223extern void isp_uninit(struct ispsoftc *);
224
225#define	MEMZERO			bzero
226#define	MEMCPY(dst, src, amt)	bcopy((src), (dst), (amt))
227#ifdef	__alpha__
228#define	MemoryBarrier	alpha_mb
229#else
230#define	MemoryBarrier()
231#endif
232
233
234#define	DMA_MSW(x)	(((x) >> 16) & 0xffff)
235#define	DMA_LSW(x)	(((x) & 0xffff))
236
237#define	ISP_UNSWIZZLE_AND_COPY_PDBP(isp, dest, src)	\
238	bcopy(src, dest, sizeof (isp_pdb_t))
239#define	ISP_SWIZZLE_ICB(a, b)
240#define	ISP_SWIZZLE_REQUEST(a, b)
241#define	ISP_UNSWIZZLE_RESPONSE(a, b)
242#define	ISP_SWIZZLE_SNS_REQ(a, b)
243#define	ISP_UNSWIZZLE_SNS_RSP(a, b, c)
244
245#define	IDPRINTF(lev, x)	if (isp->isp_dblev >= (u_int8_t) lev) printf x
246#define	PRINTF			printf
247#define	CFGPRINTF		if (bootverbose || DFLT_DBLEVEL > 1) printf
248
249#define	SYS_DELAY(x)	DELAY(x)
250
251#define	FC_FW_READY_DELAY	(5 * 1000000)
252#define	DEFAULT_LOOPID(x)	109
253#define	DEFAULT_WWN(x)		(x)->isp_osinfo.default_wwn
254
255#define	INLINE	__inline
256#include <dev/isp/isp_inline.h>
257#endif	/* _ISP_FREEBSD_H */
258
259