isp_freebsd.h revision 42472 
1/* $Id: isp_freebsd.h,v 1.8 1999/01/10 02:51:06 mjacob Exp $ */
2/* release_12_28_98_A+ */
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	98
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#include <dev/isp/isp_freebsd_cam.h>
49#else
50
51#include <sys/systm.h>
52#include <sys/malloc.h>
53#include <sys/buf.h>
54#include <sys/proc.h>
55
56#include <scsi/scsiconf.h>
57#include <machine/clock.h>
58#include <vm/vm.h>
59#include <vm/vm_param.h>
60#include <vm/pmap.h>
61#include <sys/kernel.h>
62
63#define	ISP_SCSI_XFER_T		struct scsi_xfer
64struct isposinfo {
65	char			name[8];
66	int			unit;
67	struct scsi_link	_link;
68#if	__FreeBSD_version >=	300001
69	struct callout_handle	watchid;
70#endif
71};
72
73#define	MAXISPREQUEST	64
74
75#include <dev/isp/ispreg.h>
76#include <dev/isp/ispvar.h>
77#include <dev/isp/ispmbox.h>
78
79#define	PRINTF			printf
80#define	IDPRINTF(lev, x)	if (isp->isp_dblev >= lev) printf x
81#define	DFLT_DBLEVEL		1
82
83#define	MEMZERO			BZERO
84#define	MEMCPY(dst, src, amt)	bcopy((src), (dst), (amt))
85
86#define	ISP_LOCKVAL_DECL	int isp_spl_save
87#define	ISP_ILOCKVAL_DECL	ISP_LOCKVAL_DECL
88#define	ISP_UNLOCK(isp)		(void) splx(isp_spl_save)
89#define	ISP_LOCK(isp)		isp_spl_save = splbio()
90#define	ISP_ILOCK(isp)		ISP_LOCK(isp)
91#define	ISP_IUNLOCK(isp)	ISP_UNLOCK(isp)
92#define	IMASK			bio_imask
93
94#define	XS_NULL(xs)		xs == NULL || xs->sc_link == NULL
95#define	XS_ISP(xs)		\
96	((struct ispsoftc *) (xs)->sc_link->adapter_softc)
97#define	XS_LUN(xs)		(xs)->sc_link->lun
98#define	XS_TGT(xs)		(xs)->sc_link->target
99#define	XS_RESID(xs)		(xs)->resid
100#define	XS_XFRLEN(xs)		(xs)->datalen
101#define	XS_CDBLEN(xs)		(xs)->cmdlen
102#define	XS_CDBP(xs)		(xs)->cmd
103#define	XS_STS(xs)		(xs)->status
104#define	XS_TIME(xs)		(xs)->timeout
105#define	XS_SNSP(xs)		(&(xs)->sense)
106#define	XS_SNSLEN(xs)		(sizeof((xs)->sense))
107#define	XS_SNSKEY(xs)		((xs)->sense.ext.extended.flags)
108
109#define	HBA_NOERROR		XS_NOERROR
110#define	HBA_BOTCH		XS_DRIVER_STUFFUP
111#define	HBA_CMDTIMEOUT		XS_TIMEOUT
112#define	HBA_SELTIMEOUT		XS_SELTIMEOUT
113#define	HBA_TGTBSY		XS_BUSY
114#define	HBA_BUSRESET		XS_DRIVER_STUFFUP
115#define	HBA_ABORTED		XS_DRIVER_STUFFUP
116#define	HBA_DATAOVR		XS_DRIVER_STUFFUP
117#define	HBA_ARQFAIL		XS_DRIVER_STUFFUP
118
119#define	XS_SNS_IS_VALID(xs)	(xs)->error = XS_SENSE
120#define	XS_IS_SNS_VALID(xs)	((xs)->error == XS_SENSE)
121
122#define	XS_INITERR(xs)		(xs)->error = 0
123#define	XS_SETERR(xs, v)	(xs)->error = v
124#define	XS_ERR(xs)		(xs)->error
125#define	XS_NOERR(xs)		(xs)->error == XS_NOERROR
126
127#define	XS_CMD_DONE(xs)		(xs)->flags |= ITSDONE, scsi_done(xs)
128#define	XS_IS_CMD_DONE(xs)	(((xs)->flags & ITSDONE) != 0)
129
130/*
131 * We decide whether to use tags based upon whether we're polling.
132 */
133#define	XS_CANTAG(xs)		(((xs)->flags & SCSI_NOMASK) != 0)
134
135/*
136 * Our default tag
137 */
138#define	XS_KINDOF_TAG(xs)	REQFLAG_STAG
139
140
141#define	CMD_COMPLETE		COMPLETE
142#define	CMD_EAGAIN		TRY_AGAIN_LATER
143#define	CMD_QUEUED		SUCCESSFULLY_QUEUED
144
145#define	isp_name	isp_osinfo.name
146
147#define	SYS_DELAY(x)	DELAY(x)
148
149#define	WATCH_INTERVAL		30
150#if	__FreeBSD_version >=	300001
151#define	START_WATCHDOG(f, s)	\
152	(s)->isp_osinfo.watchid = timeout(f, s, WATCH_INTERVAL * hz), \
153	s->isp_dogactive = 1
154#define	STOP_WATCHDOG(f, s)	untimeout(f, s, (s)->isp_osinfo.watchid),\
155	(s)->isp_dogactive = 0
156#else
157#define	START_WATCHDOG(f, s)	\
158	timeout(f, s, WATCH_INTERVAL * hz), s->isp_dogactive = 1
159#define	STOP_WATCHDOG(f, s)	untimeout(f, s), (s)->isp_dogactive = 0
160#endif
161
162#define	RESTART_WATCHDOG(f, s)	START_WATCHDOG(f, s)
163extern void isp_attach __P((struct ispsoftc *));
164extern void isp_uninit __P((struct ispsoftc *));
165
166#define	PVS 				"Qlogic ISP Driver, FreeBSD Non-Cam"
167
168#endif	/* __FreeBSD_version >= 300004 */
169#endif	/* _ISP_FREEBSD_H */
170