isp_freebsd.h revision 35388
1/* $FreeBSD: head/sys/dev/isp/isp_freebsd.h 35388 1998-04-22 17:54:58Z mjacob $ */
2/* $Id: isp_freebsd.h,v 1.9 1998/04/17 17:09:29 mjacob Exp $ */
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#include <pci.h>
39#include <sys/param.h>
40#include <sys/systm.h>
41#include <sys/malloc.h>
42#include <sys/buf.h>
43#include <sys/proc.h>
44
45#include <scsi/scsiconf.h>
46#include <scsi/scsi_debug.h>
47
48#include <machine/clock.h>
49#include <vm/vm.h>
50#include <vm/vm_param.h>
51#include <vm/pmap.h>
52#include <sys/kernel.h>
53
54#include <osreldate.h>
55
56#define	ISP_SCSI_XFER_T		struct scsi_xfer
57struct isposinfo {
58	char			name[8];
59	int			unit;
60	struct scsi_link	_link;
61#if	__FreeBSD_version >=	300001
62	struct callout_handle	watchid;
63#endif
64};
65/*
66 * XXXX: UNTIL WE PUT CODE IN THAT CHECKS RETURNS FROM MALLOC
67 * XXXX: FOR CONTIGOUS PAGES, WE LIMIT TO PAGE_SIZE THE SIZE
68 * XXXX: OF MAILBOXES.
69 */
70#define	MAXISPREQUEST	64
71
72#define	ISP_VERSION_STRING	\
73	"Version 0.92 Alpha Fri Apr 17 09:34:03 PDT 1998"
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#ifdef	SCSIDEBUG
82#define	DFLT_DBLEVEL		2
83#else
84#define	DFLT_DBLEVEL		1
85#endif
86
87#define	ISP_LOCKVAL_DECL	int isp_spl_save
88#define	ISP_UNLOCK		(void) splx(isp_spl_save)
89#define	ISP_LOCK		isp_spl_save = splbio()
90#define	IMASK			bio_imask
91
92#define	XS_NULL(xs)		xs == NULL || xs->sc_link == NULL
93#define	XS_ISP(xs)		(xs)->sc_link->adapter_softc
94#define	XS_LUN(xs)		(xs)->sc_link->lun
95#define	XS_TGT(xs)		(xs)->sc_link->target
96#define	XS_RESID(xs)		(xs)->resid
97#define	XS_XFRLEN(xs)		(xs)->datalen
98#define	XS_CDBLEN(xs)		(xs)->cmdlen
99#define	XS_CDBP(xs)		(xs)->cmd
100#define	XS_STS(xs)		(xs)->status
101#define	XS_TIME(xs)		(xs)->timeout
102#define	XS_SNSP(xs)		(&(xs)->sense)
103#define	XS_SNSLEN(xs)		(sizeof (xs)->sense)
104#define	XS_SNSKEY(xs)		((xs)->sense.ext.extended.flags)
105
106#define	HBA_NOERROR		XS_NOERROR
107#define	HBA_BOTCH		XS_DRIVER_STUFFUP
108#define	HBA_CMDTIMEOUT		XS_TIMEOUT
109#define	HBA_SELTIMEOUT		XS_SELTIMEOUT
110#define	HBA_TGTBSY		XS_BUSY
111#define	HBA_BUSRESET		XS_DRIVER_STUFFUP
112#define	HBA_ABORTED		XS_DRIVER_STUFFUP
113
114#define	XS_SNS_IS_VALID(xs)	(xs)->error = XS_SENSE
115#define	XS_IS_SNS_VALID(xs)	((xs)->error == XS_SENSE)
116
117#define	XS_INITERR(xs)		(xs)->error = 0
118#define	XS_SETERR(xs, v)	(xs)->error = v
119#define	XS_ERR(xs)		(xs)->error
120#define	XS_NOERR(xs)		(xs)->error == XS_NOERROR
121
122#define	XS_CMD_DONE(xs)		(xs)->flags |= ITSDONE, scsi_done(xs)
123#define	XS_IS_CMD_DONE(xs)	(((xs)->flags & ITSDONE) != 0)
124
125#define	XS_POLLDCMD(xs)		((xs)->flags & SCSI_NOMASK)
126
127#define	CMD_COMPLETE		COMPLETE
128#define	CMD_EAGAIN		TRY_AGAIN_LATER
129#define	CMD_QUEUED		SUCCESSFULLY_QUEUED
130
131
132
133#define	isp_name	isp_osinfo.name
134
135
136#define	SYS_DELAY(x)	DELAY(x)
137
138#define	WATCH_INTERVAL		30
139#if	__FreeBSD_version >=	300001
140#define	START_WATCHDOG(f, s)	\
141	(s)->isp_osinfo.watchid = timeout(f, s, WATCH_INTERVAL * hz), \
142	s->isp_dogactive = 1
143#define	STOP_WATCHDOG(f, s)	untimeout(f, s, (s)->isp_osinfo.watchid),\
144	(s)->isp_dogactive = 0
145#else
146#define	START_WATCHDOG(f, s)	\
147	timeout(f, s, WATCH_INTERVAL * hz), s->isp_dogactive = 1
148#define	STOP_WATCHDOG(f, s)	untimeout(f, s), (s)->isp_dogactive = 0
149#endif
150
151#define	RESTART_WATCHDOG(f, s)	START_WATCHDOG(f, s)
152extern void isp_attach __P((struct ispsoftc *));
153
154#endif	/* _ISP_FREEBSD_H */
155