xref: /freebsd/sys/dev/isp/isp_freebsd.h (revision 0a70657fcc012f03d2e0064bb31e48dc6a8414b5)
1c3aac50fSPeter Wemm /* $FreeBSD$ */
2098ca2bdSWarner Losh /*-
33910362aSMatt Jacob  * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions
4e5265237SMatt Jacob  *
5e5265237SMatt Jacob  * Copyright (c) 1997-2006 by Matthew Jacob
6e5265237SMatt Jacob  * All rights reserved.
76054c3f6SMatt Jacob  *
86054c3f6SMatt Jacob  * Redistribution and use in source and binary forms, with or without
96054c3f6SMatt Jacob  * modification, are permitted provided that the following conditions
106054c3f6SMatt Jacob  * are met:
116054c3f6SMatt Jacob  * 1. Redistributions of source code must retain the above copyright
126054c3f6SMatt Jacob  *    notice immediately at the beginning of the file, without modification,
136054c3f6SMatt Jacob  *    this list of conditions, and the following disclaimer.
14aa57fd6fSMatt Jacob  * 2. The name of the author may not be used to endorse or promote products
15aa57fd6fSMatt Jacob  *    derived from this software without specific prior written permission.
166054c3f6SMatt Jacob  *
176054c3f6SMatt Jacob  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
186054c3f6SMatt Jacob  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
196054c3f6SMatt Jacob  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
206054c3f6SMatt Jacob  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
216054c3f6SMatt Jacob  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
226054c3f6SMatt Jacob  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
236054c3f6SMatt Jacob  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
246054c3f6SMatt Jacob  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
256054c3f6SMatt Jacob  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
266054c3f6SMatt Jacob  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
276054c3f6SMatt Jacob  * SUCH DAMAGE.
286054c3f6SMatt Jacob  */
296054c3f6SMatt Jacob #ifndef	_ISP_FREEBSD_H
306054c3f6SMatt Jacob #define	_ISP_FREEBSD_H
316054c3f6SMatt Jacob 
323dd37e43SMatt Jacob #include <sys/param.h>
336054c3f6SMatt Jacob #include <sys/systm.h>
34a30d4b32SMike Barcroft #include <sys/endian.h>
359cd7268eSMatt Jacob #if __FreeBSD_version < 500000
366054c3f6SMatt Jacob #include <sys/kernel.h>
37b460c5c9SMatt Jacob #include <sys/queue.h>
389cd7268eSMatt Jacob #include <sys/malloc.h>
399cd7268eSMatt Jacob #else
40f34fa851SJohn Baldwin #include <sys/lock.h>
419cd7268eSMatt Jacob #include <sys/kernel.h>
429cd7268eSMatt Jacob #include <sys/queue.h>
4305914a3fSMatt Jacob #include <sys/malloc.h>
4435e0e5b3SJohn Baldwin #include <sys/mutex.h>
455d571944SMatt Jacob #include <sys/condvar.h>
469cd7268eSMatt Jacob #endif
479cd7268eSMatt Jacob 
48df9d46b6SMatt Jacob #include <sys/proc.h>
49c9a6d60bSMatt Jacob #include <sys/bus.h>
506054c3f6SMatt Jacob 
51b460c5c9SMatt Jacob #include <machine/bus.h>
529b58ff96SMatt Jacob #if __FreeBSD_version < 500000
539b58ff96SMatt Jacob #include <machine/clock.h>
549b58ff96SMatt Jacob #endif
55df9d46b6SMatt Jacob #include <machine/cpu.h>
5657c801f5SMatt Jacob 
57b460c5c9SMatt Jacob #include <cam/cam.h>
58b460c5c9SMatt Jacob #include <cam/cam_debug.h>
59b460c5c9SMatt Jacob #include <cam/cam_ccb.h>
60b460c5c9SMatt Jacob #include <cam/cam_sim.h>
61b460c5c9SMatt Jacob #include <cam/cam_xpt.h>
62b460c5c9SMatt Jacob #include <cam/cam_xpt_sim.h>
63b460c5c9SMatt Jacob #include <cam/cam_debug.h>
64b460c5c9SMatt Jacob #include <cam/scsi/scsi_all.h>
65b460c5c9SMatt Jacob #include <cam/scsi/scsi_message.h>
66bc3dacd6SMatt Jacob 
6767b6f02bSMatt Jacob #include "opt_ddb.h"
68b460c5c9SMatt Jacob #include "opt_isp.h"
69a11af9c9SMatt Jacob 
70452de53aSMatt Jacob #if __FreeBSD_version < 500000
71452de53aSMatt Jacob #define	ISP_PLATFORM_VERSION_MAJOR	4
72452de53aSMatt Jacob #define	ISP_PLATFORM_VERSION_MINOR	17
73452de53aSMatt Jacob #else
74452de53aSMatt Jacob #define	ISP_PLATFORM_VERSION_MAJOR	5
75452de53aSMatt Jacob #define	ISP_PLATFORM_VERSION_MINOR	9
76452de53aSMatt Jacob #endif
77452de53aSMatt Jacob 
784fd13c1bSMatt Jacob /*
794fd13c1bSMatt Jacob  * Efficiency- get rid of SBus code && tests unless we need them.
804fd13c1bSMatt Jacob  */
81f4e98881SRuslan Ermilov #ifdef __sparc64__
824fd13c1bSMatt Jacob #define	ISP_SBUS_SUPPORTED	1
834fd13c1bSMatt Jacob #else
844fd13c1bSMatt Jacob #define	ISP_SBUS_SUPPORTED	0
854fd13c1bSMatt Jacob #endif
86b460c5c9SMatt Jacob 
8772429e49SMatt Jacob 
889cd7268eSMatt Jacob #if __FreeBSD_version < 500000
899cd7268eSMatt Jacob #define	ISP_IFLAGS	INTR_TYPE_CAM
900a70657fSMatt Jacob #elif __FreeBSD_version < 700037
9172429e49SMatt Jacob #define	ISP_IFLAGS	INTR_TYPE_CAM | INTR_ENTROPY
920a70657fSMatt Jacob #else
930a70657fSMatt Jacob #define	ISP_IFLAGS	INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
949cd7268eSMatt Jacob #endif
955d571944SMatt Jacob 
968070de63SMatt Jacob #if __FreeBSD_version < 700000
970a70657fSMatt Jacob typedef void ispfwfunc(int, int, int, const void **);
988070de63SMatt Jacob #endif
998070de63SMatt Jacob 
10040b27503SMatt Jacob #ifdef	ISP_TARGET_MODE
1014fd13c1bSMatt Jacob #define	ISP_TARGET_FUNCTIONS	1
10253036e92SMatt Jacob #define	ATPDPSIZE	256
10353036e92SMatt Jacob typedef struct {
1041dae40ebSMatt Jacob 	uint32_t	orig_datalen;
1051dae40ebSMatt Jacob 	uint32_t	bytes_xfered;
1061dae40ebSMatt Jacob 	uint32_t	last_xframt;
1071dae40ebSMatt Jacob 	uint32_t	tag	: 16,
108759981f4SMatt Jacob 			lun	: 13,	/* not enough */
109759981f4SMatt Jacob 			state	: 3;
11053036e92SMatt Jacob } atio_private_data_t;
111759981f4SMatt Jacob #define	ATPD_STATE_FREE			0
112759981f4SMatt Jacob #define	ATPD_STATE_ATIO			1
113759981f4SMatt Jacob #define	ATPD_STATE_CAM			2
114759981f4SMatt Jacob #define	ATPD_STATE_CTIO			3
115759981f4SMatt Jacob #define	ATPD_STATE_LAST_CTIO		4
116759981f4SMatt Jacob #define	ATPD_STATE_PDON			5
11753036e92SMatt Jacob 
11840b27503SMatt Jacob typedef struct tstate {
11940b27503SMatt Jacob 	struct tstate *next;
12040b27503SMatt Jacob 	struct cam_path *owner;
12140b27503SMatt Jacob 	struct ccb_hdr_slist atios;
12240b27503SMatt Jacob 	struct ccb_hdr_slist inots;
12340b27503SMatt Jacob 	lun_id_t lun;
1241209134aSMatt Jacob 	int bus;
1251dae40ebSMatt Jacob 	uint32_t hold;
126759981f4SMatt Jacob 	int atio_count;
1272cd44270SMatt Jacob 	int inot_count;
12840b27503SMatt Jacob } tstate_t;
12940b27503SMatt Jacob 
13040b27503SMatt Jacob #define	LUN_HASH_SIZE			32
1311209134aSMatt Jacob #define	LUN_HASH_FUNC(isp, port, lun)					\
1321209134aSMatt Jacob 	((IS_DUALBUS(isp)) ?						\
1331209134aSMatt Jacob 		(((lun) & ((LUN_HASH_SIZE >> 1) - 1)) << (port)) :	\
1341209134aSMatt Jacob 		((lun) & (LUN_HASH_SIZE - 1)))
13540b27503SMatt Jacob #endif
13640b27503SMatt Jacob 
1370a70657fSMatt Jacob /*
1380a70657fSMatt Jacob  * Per command info.
1390a70657fSMatt Jacob  */
1400a70657fSMatt Jacob struct isp_pcmd {
1410a70657fSMatt Jacob 	struct isp_pcmd *	next;
1420a70657fSMatt Jacob 	bus_dmamap_t 		dmap;	/* dma map for this command */
1430a70657fSMatt Jacob 	struct ispsoftc *	isp;	/* containing isp */
1440a70657fSMatt Jacob 	struct callout		wdog;	/* watchdog timer */
1450a70657fSMatt Jacob };
1460a70657fSMatt Jacob #define	ISP_PCMD(ccb)		(ccb)->ccb_h.spriv_ptr1
1470a70657fSMatt Jacob #define	PISP_PCMD(ccb)		((struct isp_pcmd *)ISP_PCMD(ccb))
1480a70657fSMatt Jacob 
1496054c3f6SMatt Jacob struct isposinfo {
15040b27503SMatt Jacob 	struct ispsoftc *	next;
1516a7d12e1SMatt Jacob 	bus_space_tag_t		bus_tag;
1526a7d12e1SMatt Jacob 	bus_space_handle_t	bus_handle;
1530a70657fSMatt Jacob 	bus_dma_tag_t		dmat;
1541dae40ebSMatt Jacob 	uint64_t		default_port_wwn;
1551dae40ebSMatt Jacob 	uint64_t		default_node_wwn;
1561dae40ebSMatt Jacob 	uint32_t		default_id;
157c9a6d60bSMatt Jacob 	device_t		dev;
158b460c5c9SMatt Jacob 	struct cam_sim		*sim;
159b460c5c9SMatt Jacob 	struct cam_path		*path;
160b460c5c9SMatt Jacob 	struct cam_sim		*sim2;
161b460c5c9SMatt Jacob 	struct cam_path		*path2;
162df9d46b6SMatt Jacob 	struct intr_config_hook	ehook;
163f7c631bcSMatt Jacob 	uint32_t		loop_down_time;
164f7c631bcSMatt Jacob 	uint32_t		loop_down_limit;
165f7c631bcSMatt Jacob 	uint32_t		gone_device_time;
16610365e5aSMatt Jacob 	uint32_t		: 5,
16710365e5aSMatt Jacob 		simqfrozen	: 3,
16810365e5aSMatt Jacob 		hysteresis	: 8,
169f7c631bcSMatt Jacob 		gdt_running	: 1,
170f7c631bcSMatt Jacob 		ldt_running	: 1,
1719cd7268eSMatt Jacob 		disabled	: 1,
172fdeb9f2fSMatt Jacob 		fcbsy		: 1,
173f7c631bcSMatt Jacob 		mbox_sleeping	: 1,
174f7c631bcSMatt Jacob 		mbox_sleep_ok	: 1,
17510365e5aSMatt Jacob 		mboxcmd_done	: 1,
17610365e5aSMatt Jacob 		mboxbsy		: 1;
1770a70657fSMatt Jacob 	struct callout		ldt;	/* loop down timer */
1780a70657fSMatt Jacob 	struct callout		gdt;	/* gone device timer */
1790a70657fSMatt Jacob #if __FreeBSD_version < 500000
1800a70657fSMatt Jacob 	uint32_t		splcount;
1810a70657fSMatt Jacob 	uint32_t		splsaved;
1820a70657fSMatt Jacob #else
183e92fbe47SMatt Jacob 	struct mtx		lock;
1840a70657fSMatt Jacob 	const struct firmware *	fw;
1859311717dSMatt Jacob 	union {
1869311717dSMatt Jacob 		struct {
1879311717dSMatt Jacob 			char wwnn[17];
1889311717dSMatt Jacob 			char wwpn[17];
1899311717dSMatt Jacob 		} fc;
1909311717dSMatt Jacob 	} sysctl_info;
1919cd7268eSMatt Jacob #endif
1925d571944SMatt Jacob 	struct proc		*kproc;
1931923f739SMatt Jacob 	bus_dma_tag_t		cdmat;
1941923f739SMatt Jacob 	bus_dmamap_t		cdmap;
1951923f739SMatt Jacob #define	isp_cdmat		isp_osinfo.cdmat
1961923f739SMatt Jacob #define	isp_cdmap		isp_osinfo.cdmap
1970a70657fSMatt Jacob 	/*
1980a70657fSMatt Jacob 	 * Per command information.
1990a70657fSMatt Jacob 	 */
2000a70657fSMatt Jacob 	struct isp_pcmd *	pcmd_pool;
2010a70657fSMatt Jacob 	struct isp_pcmd *	pcmd_free;
2020a70657fSMatt Jacob 
20340b27503SMatt Jacob #ifdef	ISP_TARGET_MODE
204f6a3bcf8SMatt Jacob #define	TM_WILDCARD_ENABLED	0x02
205f6a3bcf8SMatt Jacob #define	TM_TMODE_ENABLED	0x01
2061dae40ebSMatt Jacob 	uint8_t			tmflags[2];	/* two busses */
207c98d7aa4SMatt Jacob #define	NLEACT	4
208c98d7aa4SMatt Jacob 	union ccb *		leact[NLEACT];
2091209134aSMatt Jacob 	tstate_t		tsdflt[2];	/* two busses */
21040b27503SMatt Jacob 	tstate_t		*lun_hash[LUN_HASH_SIZE];
21153036e92SMatt Jacob 	atio_private_data_t	atpdp[ATPDPSIZE];
21240b27503SMatt Jacob #endif
2136054c3f6SMatt Jacob };
2140a70657fSMatt Jacob #define	ISP_KT_WCHAN(isp)	(&(isp)->isp_osinfo.kproc)
21518ccaecdSMatt Jacob 
2165d571944SMatt Jacob #define	isp_lock	isp_osinfo.lock
2176a7d12e1SMatt Jacob #define	isp_bus_tag	isp_osinfo.bus_tag
2186a7d12e1SMatt Jacob #define	isp_bus_handle	isp_osinfo.bus_handle
2195d571944SMatt Jacob 
22018ccaecdSMatt Jacob /*
221e5f2f488SMatt Jacob  * Locking macros...
222e5f2f488SMatt Jacob  */
223f7c631bcSMatt Jacob #if __FreeBSD_version < 500000
2240a70657fSMatt Jacob #define	ISP_LOCK(isp)						\
2250a70657fSMatt Jacob 	if (isp->isp_osinfo.splcount++ == 0) {			\
2260a70657fSMatt Jacob 		 isp->isp_osinfo.splsaved = splcam();		\
2270a70657fSMatt Jacob 	}
2280a70657fSMatt Jacob #define	ISP_UNLOCK(isp)						\
2290a70657fSMatt Jacob 	if (isp->isp_osinfo.splcount > 1) {			\
2300a70657fSMatt Jacob 		isp->isp_osinfo.splcount--;			\
2310a70657fSMatt Jacob 	} else {						\
2320a70657fSMatt Jacob 		isp->isp_osinfo.splcount = 0;			\
2330a70657fSMatt Jacob 		splx(isp->isp_osinfo.splsaved);			\
2340a70657fSMatt Jacob 	}
2350a70657fSMatt Jacob #elif	__FreeBSD_version < 700037
2360a70657fSMatt Jacob #define	ISP_LOCK(isp)	do {} while (0)
2370a70657fSMatt Jacob #define	ISP_UNLOCK(isp)	do {} while (0)
238f7c631bcSMatt Jacob #else
2390a70657fSMatt Jacob #define	ISP_LOCK(isp)	mtx_lock(&isp->isp_osinfo.lock)
2400a70657fSMatt Jacob #define	ISP_UNLOCK(isp)	mtx_unlock(&isp->isp_osinfo.lock)
241162e9893SMatt Jacob #endif
242e5f2f488SMatt Jacob 
243e5f2f488SMatt Jacob /*
24418ccaecdSMatt Jacob  * Required Macros/Defines
24518ccaecdSMatt Jacob  */
24618ccaecdSMatt Jacob 
24710365e5aSMatt Jacob #define	ISP2100_SCRLEN		0x1000
24818ccaecdSMatt Jacob 
2498f725baeSMatt Jacob #define	MEMZERO(a, b)		memset(a, 0, b)
2508f725baeSMatt Jacob #define	MEMCPY			memcpy
25118ccaecdSMatt Jacob #define	SNPRINTF		snprintf
25218ccaecdSMatt Jacob #define	USEC_DELAY		DELAY
25310365e5aSMatt Jacob #define	USEC_SLEEP(isp, x)	DELAY(x)
25418ccaecdSMatt Jacob 
25518ccaecdSMatt Jacob #define	NANOTIME_T		struct timespec
25618ccaecdSMatt Jacob #define	GET_NANOTIME		nanotime
25718ccaecdSMatt Jacob #define	GET_NANOSEC(x)		((x)->tv_sec * 1000000000 + (x)->tv_nsec)
258f7c631bcSMatt Jacob #define	NANOTIME_SUB		isp_nanotime_sub
25918ccaecdSMatt Jacob 
260fdeb9f2fSMatt Jacob #define	MAXISPREQUEST(isp)	((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256)
26118ccaecdSMatt Jacob 
26271793c0dSMatt Jacob #define	MEMORYBARRIER(isp, type, offset, size)			\
2631923f739SMatt Jacob switch (type) {							\
2641923f739SMatt Jacob case SYNC_SFORDEV:						\
2651923f739SMatt Jacob case SYNC_REQUEST:						\
2661923f739SMatt Jacob 	bus_dmamap_sync(isp->isp_cdmat, isp->isp_cdmap, 	\
2671923f739SMatt Jacob 	   BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);		\
2681923f739SMatt Jacob 	break;							\
2691923f739SMatt Jacob case SYNC_SFORCPU:						\
2701923f739SMatt Jacob case SYNC_RESULT:						\
2711923f739SMatt Jacob 	bus_dmamap_sync(isp->isp_cdmat, isp->isp_cdmap,		\
2721923f739SMatt Jacob 	   BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);	\
2731923f739SMatt Jacob 	break;							\
2746a7d12e1SMatt Jacob case SYNC_REG:							\
2756a7d12e1SMatt Jacob 	bus_space_barrier(isp->isp_bus_tag,			\
2766a7d12e1SMatt Jacob 	    isp->isp_bus_handle, offset, size, 			\
2776a7d12e1SMatt Jacob 	    BUS_SPACE_BARRIER_READ);				\
2786a7d12e1SMatt Jacob 	break;							\
2791923f739SMatt Jacob default:							\
2801923f739SMatt Jacob 	break;							\
2811923f739SMatt Jacob }
28218ccaecdSMatt Jacob 
28310365e5aSMatt Jacob #define	MBOX_ACQUIRE			isp_mbox_acquire
28418ccaecdSMatt Jacob #define	MBOX_WAIT_COMPLETE		isp_mbox_wait_complete
285f7c631bcSMatt Jacob #define	MBOX_NOTIFY_COMPLETE		isp_mbox_notify_done
28610365e5aSMatt Jacob #define	MBOX_RELEASE			isp_mbox_release
28718ccaecdSMatt Jacob 
288fdeb9f2fSMatt Jacob #define	FC_SCRATCH_ACQUIRE(isp)						\
289fdeb9f2fSMatt Jacob 	if (isp->isp_osinfo.fcbsy) {					\
290fdeb9f2fSMatt Jacob 		isp_prt(isp, ISP_LOGWARN,				\
291fdeb9f2fSMatt Jacob 		    "FC scratch area busy (line %d)!", __LINE__);	\
292fdeb9f2fSMatt Jacob 	} else								\
293fdeb9f2fSMatt Jacob 		isp->isp_osinfo.fcbsy = 1
294fdeb9f2fSMatt Jacob #define	FC_SCRATCH_RELEASE(isp)		 isp->isp_osinfo.fcbsy = 0
29575c1e828SMatt Jacob 
29618ccaecdSMatt Jacob #ifndef	SCSI_GOOD
29718ccaecdSMatt Jacob #define	SCSI_GOOD	SCSI_STATUS_OK
29818ccaecdSMatt Jacob #endif
29918ccaecdSMatt Jacob #ifndef	SCSI_CHECK
30018ccaecdSMatt Jacob #define	SCSI_CHECK	SCSI_STATUS_CHECK_COND
30118ccaecdSMatt Jacob #endif
30218ccaecdSMatt Jacob #ifndef	SCSI_BUSY
30318ccaecdSMatt Jacob #define	SCSI_BUSY	SCSI_STATUS_BUSY
30418ccaecdSMatt Jacob #endif
30518ccaecdSMatt Jacob #ifndef	SCSI_QFULL
30618ccaecdSMatt Jacob #define	SCSI_QFULL	SCSI_STATUS_QUEUE_FULL
30718ccaecdSMatt Jacob #endif
30818ccaecdSMatt Jacob 
30918ccaecdSMatt Jacob #define	XS_T			struct ccb_scsiio
3101dae40ebSMatt Jacob #define	XS_DMA_ADDR_T		bus_addr_t
3110a70657fSMatt Jacob #define	XS_ISP(ccb)		cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path))
31218ccaecdSMatt Jacob #define	XS_CHANNEL(ccb)		cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
31318ccaecdSMatt Jacob #define	XS_TGT(ccb)		(ccb)->ccb_h.target_id
31418ccaecdSMatt Jacob #define	XS_LUN(ccb)		(ccb)->ccb_h.target_lun
31518ccaecdSMatt Jacob 
31618ccaecdSMatt Jacob #define	XS_CDBP(ccb)	\
31718ccaecdSMatt Jacob 	(((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
31818ccaecdSMatt Jacob 	 (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)
31918ccaecdSMatt Jacob 
32018ccaecdSMatt Jacob #define	XS_CDBLEN(ccb)		(ccb)->cdb_len
32118ccaecdSMatt Jacob #define	XS_XFRLEN(ccb)		(ccb)->dxfer_len
32218ccaecdSMatt Jacob #define	XS_TIME(ccb)		(ccb)->ccb_h.timeout
32318ccaecdSMatt Jacob #define	XS_RESID(ccb)		(ccb)->resid
32418ccaecdSMatt Jacob #define	XS_STSP(ccb)		(&(ccb)->scsi_status)
32518ccaecdSMatt Jacob #define	XS_SNSP(ccb)		(&(ccb)->sense_data)
32618ccaecdSMatt Jacob 
32718ccaecdSMatt Jacob #define	XS_SNSLEN(ccb)		\
32818ccaecdSMatt Jacob 	imin((sizeof((ccb)->sense_data)), ccb->sense_len)
32918ccaecdSMatt Jacob 
33018ccaecdSMatt Jacob #define	XS_SNSKEY(ccb)		((ccb)->sense_data.flags & 0xf)
33118ccaecdSMatt Jacob #define	XS_TAG_P(ccb)	\
33218ccaecdSMatt Jacob 	(((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \
33318ccaecdSMatt Jacob 	 (ccb)->tag_action != CAM_TAG_ACTION_NONE)
33418ccaecdSMatt Jacob 
33518ccaecdSMatt Jacob #define	XS_TAG_TYPE(ccb)	\
33618ccaecdSMatt Jacob 	((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \
33718ccaecdSMatt Jacob 	 ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG))
33818ccaecdSMatt Jacob 
33918ccaecdSMatt Jacob 
34018ccaecdSMatt Jacob #define	XS_SETERR(ccb, v)	(ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
34118ccaecdSMatt Jacob 				(ccb)->ccb_h.status |= v, \
34218ccaecdSMatt Jacob 				(ccb)->ccb_h.spriv_field0 |= ISP_SPRIV_ERRSET
34318ccaecdSMatt Jacob 
34418ccaecdSMatt Jacob #	define	HBA_NOERROR		CAM_REQ_INPROG
34518ccaecdSMatt Jacob #	define	HBA_BOTCH		CAM_UNREC_HBA_ERROR
34618ccaecdSMatt Jacob #	define	HBA_CMDTIMEOUT		CAM_CMD_TIMEOUT
34718ccaecdSMatt Jacob #	define	HBA_SELTIMEOUT		CAM_SEL_TIMEOUT
34818ccaecdSMatt Jacob #	define	HBA_TGTBSY		CAM_SCSI_STATUS_ERROR
34918ccaecdSMatt Jacob #	define	HBA_BUSRESET		CAM_SCSI_BUS_RESET
35018ccaecdSMatt Jacob #	define	HBA_ABORTED		CAM_REQ_ABORTED
35118ccaecdSMatt Jacob #	define	HBA_DATAOVR		CAM_DATA_RUN_ERR
35218ccaecdSMatt Jacob #	define	HBA_ARQFAIL		CAM_AUTOSENSE_FAIL
35318ccaecdSMatt Jacob 
35418ccaecdSMatt Jacob 
35518ccaecdSMatt Jacob #define	XS_ERR(ccb)		((ccb)->ccb_h.status & CAM_STATUS_MASK)
35618ccaecdSMatt Jacob 
35718ccaecdSMatt Jacob #define	XS_NOERR(ccb)		\
35818ccaecdSMatt Jacob 	(((ccb)->ccb_h.spriv_field0 & ISP_SPRIV_ERRSET) == 0 || \
35918ccaecdSMatt Jacob 	 ((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)
36018ccaecdSMatt Jacob 
36118ccaecdSMatt Jacob #define	XS_INITERR(ccb)		\
36218ccaecdSMatt Jacob 	XS_SETERR(ccb, CAM_REQ_INPROG), (ccb)->ccb_h.spriv_field0 = 0
36318ccaecdSMatt Jacob 
364f7c631bcSMatt Jacob #define	XS_SAVE_SENSE(xs, sense_ptr, sense_len)		\
365f7c631bcSMatt Jacob 	(xs)->ccb_h.status |= CAM_AUTOSNS_VALID;	\
366f7c631bcSMatt Jacob 	memcpy(&(xs)->sense_data, sense_ptr, imin(XS_SNSLEN(xs), sense_len))
36718ccaecdSMatt Jacob 
36818ccaecdSMatt Jacob #define	XS_SET_STATE_STAT(a, b, c)
36918ccaecdSMatt Jacob 
370fdeb9f2fSMatt Jacob #define	DEFAULT_IID(x)		(isp)->isp_osinfo.default_id
371fdeb9f2fSMatt Jacob #define	DEFAULT_LOOPID(x)	(isp)->isp_osinfo.default_id
372c9a6d60bSMatt Jacob #define	DEFAULT_NODEWWN(isp)	(isp)->isp_osinfo.default_node_wwn
373c9a6d60bSMatt Jacob #define	DEFAULT_PORTWWN(isp)	(isp)->isp_osinfo.default_port_wwn
3746c81a0aeSMatt Jacob #define	ISP_NODEWWN(isp)	FCPARAM(isp)->isp_wwnn_nvram
3756c81a0aeSMatt Jacob #define	ISP_PORTWWN(isp)	FCPARAM(isp)->isp_wwpn_nvram
37618ccaecdSMatt Jacob 
37770273f90SMatt Jacob 
37870273f90SMatt Jacob #if __FreeBSD_version < 500000
37970273f90SMatt Jacob #if _BYTE_ORDER == _LITTLE_ENDIAN
38070273f90SMatt Jacob #define	bswap16		htobe16
38170273f90SMatt Jacob #define	bswap32		htobe32
38270273f90SMatt Jacob #else
38370273f90SMatt Jacob #define	bswap16		htole16
38470273f90SMatt Jacob #define	bswap32		htole32
38570273f90SMatt Jacob #endif
38670273f90SMatt Jacob #endif
38770273f90SMatt Jacob 
3884fd13c1bSMatt Jacob #if	BYTE_ORDER == BIG_ENDIAN
3894fd13c1bSMatt Jacob #ifdef	ISP_SBUS_SUPPORTED
3904fd13c1bSMatt Jacob #define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
3914fd13c1bSMatt Jacob #define	ISP_IOXPUT_16(isp, s, d)				\
3924fd13c1bSMatt Jacob 	*(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s)
3934fd13c1bSMatt Jacob #define	ISP_IOXPUT_32(isp, s, d)				\
3944fd13c1bSMatt Jacob 	*(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s)
3951dae40ebSMatt Jacob #define	ISP_IOXGET_8(isp, s, d)		d = (*((uint8_t *)s))
3964fd13c1bSMatt Jacob #define	ISP_IOXGET_16(isp, s, d)				\
3974fd13c1bSMatt Jacob 	d = (isp->isp_bustype == ISP_BT_SBUS)?			\
3981dae40ebSMatt Jacob 	*((uint16_t *)s) : bswap16(*((uint16_t *)s))
3994fd13c1bSMatt Jacob #define	ISP_IOXGET_32(isp, s, d)				\
4004fd13c1bSMatt Jacob 	d = (isp->isp_bustype == ISP_BT_SBUS)?			\
4011dae40ebSMatt Jacob 	*((uint32_t *)s) : bswap32(*((uint32_t *)s))
40210365e5aSMatt Jacob 
40310365e5aSMatt Jacob #else	/* ISP_SBUS_SUPPORTED */
4044fd13c1bSMatt Jacob #define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
4054fd13c1bSMatt Jacob #define	ISP_IOXPUT_16(isp, s, d)	*(d) = bswap16(s)
4064fd13c1bSMatt Jacob #define	ISP_IOXPUT_32(isp, s, d)	*(d) = bswap32(s)
4071dae40ebSMatt Jacob #define	ISP_IOXGET_8(isp, s, d)		d = (*((uint8_t *)s))
4081dae40ebSMatt Jacob #define	ISP_IOXGET_16(isp, s, d)	d = bswap16(*((uint16_t *)s))
4091dae40ebSMatt Jacob #define	ISP_IOXGET_32(isp, s, d)	d = bswap32(*((uint32_t *)s))
4104fd13c1bSMatt Jacob #endif
4114fd13c1bSMatt Jacob #define	ISP_SWIZZLE_NVRAM_WORD(isp, rp)	*rp = bswap16(*rp)
41210365e5aSMatt Jacob 
41310365e5aSMatt Jacob #define	ISP_IOZGET_8(isp, s, d)		d = (*((uint8_t *)s))
41410365e5aSMatt Jacob #define	ISP_IOZGET_16(isp, s, d)	d = (*((uint16_t *)s))
41510365e5aSMatt Jacob #define	ISP_IOZGET_32(isp, s, d)	d = (*((uint32_t *)s))
41610365e5aSMatt Jacob #define	ISP_IOZPUT_8(isp, s, d)		*(d) = s
41710365e5aSMatt Jacob #define	ISP_IOZPUT_16(isp, s, d)	*(d) = s
41810365e5aSMatt Jacob #define	ISP_IOZPUT_32(isp, s, d)	*(d) = s
41910365e5aSMatt Jacob 
42010365e5aSMatt Jacob 
4214fd13c1bSMatt Jacob #else
4224fd13c1bSMatt Jacob #define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
4234fd13c1bSMatt Jacob #define	ISP_IOXPUT_16(isp, s, d)	*(d) = s
4244fd13c1bSMatt Jacob #define	ISP_IOXPUT_32(isp, s, d)	*(d) = s
4254fd13c1bSMatt Jacob #define	ISP_IOXGET_8(isp, s, d)		d = *(s)
4264fd13c1bSMatt Jacob #define	ISP_IOXGET_16(isp, s, d)	d = *(s)
4274fd13c1bSMatt Jacob #define	ISP_IOXGET_32(isp, s, d)	d = *(s)
4284fd13c1bSMatt Jacob #define	ISP_SWIZZLE_NVRAM_WORD(isp, rp)
42910365e5aSMatt Jacob 
43010365e5aSMatt Jacob #define	ISP_IOZPUT_8(isp, s, d)		*(d) = s
43110365e5aSMatt Jacob #define	ISP_IOZPUT_16(isp, s, d)	*(d) = bswap16(s)
43210365e5aSMatt Jacob #define	ISP_IOZPUT_32(isp, s, d)	*(d) = bswap32(s)
43310365e5aSMatt Jacob 
43410365e5aSMatt Jacob #define	ISP_IOZGET_8(isp, s, d)		d = (*((uint8_t *)(s)))
43510365e5aSMatt Jacob #define	ISP_IOZGET_16(isp, s, d)	d = bswap16(*((uint16_t *)(s)))
43610365e5aSMatt Jacob #define	ISP_IOZGET_32(isp, s, d)	d = bswap32(*((uint32_t *)(s)))
43710365e5aSMatt Jacob 
4384fd13c1bSMatt Jacob #endif
43918ccaecdSMatt Jacob 
44018ccaecdSMatt Jacob /*
44118ccaecdSMatt Jacob  * Includes of common header files
44218ccaecdSMatt Jacob  */
44318ccaecdSMatt Jacob 
44418ccaecdSMatt Jacob #include <dev/isp/ispreg.h>
44518ccaecdSMatt Jacob #include <dev/isp/ispvar.h>
44618ccaecdSMatt Jacob #include <dev/isp/ispmbox.h>
44718ccaecdSMatt Jacob 
4481dae40ebSMatt Jacob #ifdef	ISP_TARGET_MODE
4491dae40ebSMatt Jacob #include <dev/isp/isp_tpublic.h>
4501dae40ebSMatt Jacob #endif
4511dae40ebSMatt Jacob 
45218ccaecdSMatt Jacob /*
45318ccaecdSMatt Jacob  * isp_osinfo definiitions && shorthand
45418ccaecdSMatt Jacob  */
455b460c5c9SMatt Jacob #define	SIMQFRZ_RESOURCE	0x1
456b460c5c9SMatt Jacob #define	SIMQFRZ_LOOPDOWN	0x2
4571a43c1fcSMatt Jacob #define	SIMQFRZ_TIMED		0x4
458b460c5c9SMatt Jacob 
459b460c5c9SMatt Jacob #define	isp_sim		isp_osinfo.sim
460b460c5c9SMatt Jacob #define	isp_path	isp_osinfo.path
461b460c5c9SMatt Jacob #define	isp_sim2	isp_osinfo.sim2
462b460c5c9SMatt Jacob #define	isp_path2	isp_osinfo.path2
463c9a6d60bSMatt Jacob #define	isp_dev		isp_osinfo.dev
464b460c5c9SMatt Jacob 
46518ccaecdSMatt Jacob /*
46618ccaecdSMatt Jacob  * prototypes for isp_pci && isp_freebsd to share
46718ccaecdSMatt Jacob  */
4689cd7268eSMatt Jacob extern void isp_attach(ispsoftc_t *);
4699cd7268eSMatt Jacob extern void isp_uninit(ispsoftc_t *);
470478f8a96SJustin T. Gibbs 
47118ccaecdSMatt Jacob /*
47273030e03SMatt Jacob  * driver global data
47373030e03SMatt Jacob  */
47473030e03SMatt Jacob extern int isp_announced;
47510365e5aSMatt Jacob extern int isp_fabric_hysteresis;
47610365e5aSMatt Jacob extern int isp_loop_down_limit;
477f7c631bcSMatt Jacob extern int isp_gone_device_time;
47810365e5aSMatt Jacob extern int isp_quickboot_time;
47973030e03SMatt Jacob 
48073030e03SMatt Jacob /*
48118ccaecdSMatt Jacob  * Platform private flags
482478f8a96SJustin T. Gibbs  */
483cc287907SMatt Jacob #define	ISP_SPRIV_ERRSET	0x1
484cc287907SMatt Jacob #define	ISP_SPRIV_INWDOG	0x2
485cc287907SMatt Jacob #define	ISP_SPRIV_GRACE		0x4
486cc287907SMatt Jacob #define	ISP_SPRIV_DONE		0x8
487cc287907SMatt Jacob 
488cc287907SMatt Jacob #define	XS_CMD_S_WDOG(sccb)	(sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_INWDOG
489cc287907SMatt Jacob #define	XS_CMD_C_WDOG(sccb)	(sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_INWDOG
490cc287907SMatt Jacob #define	XS_CMD_WDOG_P(sccb)	((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_INWDOG)
491cc287907SMatt Jacob 
492cc287907SMatt Jacob #define	XS_CMD_S_GRACE(sccb)	(sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_GRACE
493cc287907SMatt Jacob #define	XS_CMD_C_GRACE(sccb)	(sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_GRACE
494cc287907SMatt Jacob #define	XS_CMD_GRACE_P(sccb)	((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_GRACE)
495cc287907SMatt Jacob 
496cc287907SMatt Jacob #define	XS_CMD_S_DONE(sccb)	(sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_DONE
497cc287907SMatt Jacob #define	XS_CMD_C_DONE(sccb)	(sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_DONE
498cc287907SMatt Jacob #define	XS_CMD_DONE_P(sccb)	((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_DONE)
499cc287907SMatt Jacob 
500cc287907SMatt Jacob #define	XS_CMD_S_CLEAR(sccb)	(sccb)->ccb_h.spriv_field0 = 0
50153af7d22SMatt Jacob 
502478f8a96SJustin T. Gibbs /*
503f7c631bcSMatt Jacob  * Platform Library Functions
504f7c631bcSMatt Jacob  */
505f7c631bcSMatt Jacob void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4);
506f7c631bcSMatt Jacob uint64_t isp_nanotime_sub(struct timespec *, struct timespec *);
507f7c631bcSMatt Jacob int isp_mbox_acquire(ispsoftc_t *);
508f7c631bcSMatt Jacob void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *);
509f7c631bcSMatt Jacob void isp_mbox_notify_done(ispsoftc_t *);
510f7c631bcSMatt Jacob void isp_mbox_release(ispsoftc_t *);
511f7c631bcSMatt Jacob int isp_mstohz(int);
5120a70657fSMatt Jacob void isp_platform_intr(void *);
5130a70657fSMatt Jacob void isp_common_dmateardown(ispsoftc_t *, struct ccb_scsiio *, uint32_t);
514f7c631bcSMatt Jacob 
515f7c631bcSMatt Jacob /*
5160a70657fSMatt Jacob  * Platform Version specific defines
517f9734398SMatt Jacob  */
518f9734398SMatt Jacob #if __FreeBSD_version < 500000
519f9734398SMatt Jacob #define	BUS_DMA_ROOTARG(x)	NULL
520f9734398SMatt Jacob #define	isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)	\
521f9734398SMatt Jacob 	bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)
522f9734398SMatt Jacob #elif	__FreeBSD_version < 700020
523f9734398SMatt Jacob #define	BUS_DMA_ROOTARG(x)	NULL
524f9734398SMatt Jacob #define	isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)	\
525f9734398SMatt Jacob 	bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, \
526f9734398SMatt Jacob 	busdma_lock_mutex, &Giant, z)
5270a70657fSMatt Jacob #elif __FreeBSD_version < 700037
528f9734398SMatt Jacob #define	BUS_DMA_ROOTARG(x)	bus_get_dma_tag(x)
529f9734398SMatt Jacob #define	isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)	\
530f9734398SMatt Jacob 	bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, \
531f9734398SMatt Jacob 	busdma_lock_mutex, &Giant, z)
5320a70657fSMatt Jacob #else
5330a70657fSMatt Jacob #define	BUS_DMA_ROOTARG(x)	bus_get_dma_tag(x)
5340a70657fSMatt Jacob #define	isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)	\
5350a70657fSMatt Jacob 	bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, \
5360a70657fSMatt Jacob 	busdma_lock_mutex, &isp->isp_osinfo.lock, z)
537f9734398SMatt Jacob #endif
5380a70657fSMatt Jacob 
5395f538376SMatt Jacob #if __FreeBSD_version < 700031
5405f538376SMatt Jacob #define	isp_setup_intr(d, i, f, U, if, ifa, hp)	\
5415f538376SMatt Jacob 	bus_setup_intr(d, i, f, if, ifa, hp)
5425f538376SMatt Jacob #else
5435f538376SMatt Jacob #define	isp_setup_intr	bus_setup_intr
5445f538376SMatt Jacob #endif
545f9734398SMatt Jacob 
5460a70657fSMatt Jacob #if __FreeBSD_version < 500000
5470a70657fSMatt Jacob #define	isp_sim_alloc	cam_sim_alloc
5480a70657fSMatt Jacob #define	isp_callout_init(x)	callout_init(x)
5490a70657fSMatt Jacob #elif	__FreeBSD_version < 700037
5500a70657fSMatt Jacob #define	isp_callout_init(x)	callout_init(x, 0)
5510a70657fSMatt Jacob #define	isp_sim_alloc		cam_sim_alloc
5520a70657fSMatt Jacob #else
5530a70657fSMatt Jacob #define	isp_callout_init(x)	callout_init(x, 1)
5540a70657fSMatt Jacob #define	isp_sim_alloc(a, b, c, d, e, f, g, h)	\
5550a70657fSMatt Jacob 	cam_sim_alloc(a, b, c, d, e, &(d)->isp_osinfo.lock, f, g, h)
5560a70657fSMatt Jacob #endif
5570a70657fSMatt Jacob 
558f9734398SMatt Jacob /* Should be BUS_SPACE_MAXSIZE, but MAXPHYS is larger than BUS_SPACE_MAXSIZE */
559f9734398SMatt Jacob #define ISP_NSEGS ((MAXPHYS / PAGE_SIZE) + 1)
560f9734398SMatt Jacob 
561f9734398SMatt Jacob /*
56218ccaecdSMatt Jacob  * Platform specific inline functions
563478f8a96SJustin T. Gibbs  */
5640a70657fSMatt Jacob static __inline int isp_get_pcmd(ispsoftc_t *, union ccb *);
5650a70657fSMatt Jacob static __inline void isp_free_pcmd(ispsoftc_t *, union ccb *);
5660a70657fSMatt Jacob 
5670a70657fSMatt Jacob static __inline int
5680a70657fSMatt Jacob isp_get_pcmd(ispsoftc_t *isp, union ccb *ccb)
5690a70657fSMatt Jacob {
5700a70657fSMatt Jacob 	ISP_PCMD(ccb) = isp->isp_osinfo.pcmd_free;
5710a70657fSMatt Jacob 	if (ISP_PCMD(ccb) == NULL) {
5720a70657fSMatt Jacob 		return (-1);
5730a70657fSMatt Jacob 	}
5740a70657fSMatt Jacob 	isp->isp_osinfo.pcmd_free = ((struct isp_pcmd *)ISP_PCMD(ccb))->next;
5750a70657fSMatt Jacob 	return (0);
5760a70657fSMatt Jacob }
5770a70657fSMatt Jacob 
5780a70657fSMatt Jacob static __inline void
5790a70657fSMatt Jacob isp_free_pcmd(ispsoftc_t *isp, union ccb *ccb)
5800a70657fSMatt Jacob {
5810a70657fSMatt Jacob 	((struct isp_pcmd *)ISP_PCMD(ccb))->next = isp->isp_osinfo.pcmd_free;
5820a70657fSMatt Jacob 	isp->isp_osinfo.pcmd_free = ISP_PCMD(ccb);
5830a70657fSMatt Jacob 	ISP_PCMD(ccb) = NULL;
5840a70657fSMatt Jacob }
5850a70657fSMatt Jacob 
58657c801f5SMatt Jacob 
58718ccaecdSMatt Jacob /*
588f7c631bcSMatt Jacob  * ISP General Library functions
58918ccaecdSMatt Jacob  */
59057c801f5SMatt Jacob 
59153af7d22SMatt Jacob #include <dev/isp/isp_library.h>
59253af7d22SMatt Jacob 
5936054c3f6SMatt Jacob #endif	/* _ISP_FREEBSD_H */
594