isp_freebsd.h revision 219098
1/* $FreeBSD: head/sys/dev/isp/isp_freebsd.h 219098 2011-02-28 15:58:30Z mjacob $ */
2/*-
3 * Qlogic ISP SCSI Host Adapter FreeBSD Wrapper Definitions
4 *
5 * Copyright (c) 1997-2008 by Matthew Jacob
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice immediately at the beginning of the file, without modification,
13 *    this list of conditions, and the following disclaimer.
14 * 2. The name of the author may not be used to endorse or promote products
15 *    derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29#ifndef	_ISP_FREEBSD_H
30#define	_ISP_FREEBSD_H
31
32#include <sys/param.h>
33#include <sys/systm.h>
34#include <sys/endian.h>
35#include <sys/lock.h>
36#include <sys/kernel.h>
37#include <sys/queue.h>
38#include <sys/malloc.h>
39#include <sys/mutex.h>
40#include <sys/condvar.h>
41
42#include <sys/proc.h>
43#include <sys/bus.h>
44
45#include <machine/bus.h>
46#include <machine/cpu.h>
47#include <machine/stdarg.h>
48
49#include <cam/cam.h>
50#include <cam/cam_debug.h>
51#include <cam/cam_ccb.h>
52#include <cam/cam_sim.h>
53#include <cam/cam_xpt.h>
54#include <cam/cam_xpt_sim.h>
55#include <cam/cam_debug.h>
56#include <cam/scsi/scsi_all.h>
57#include <cam/scsi/scsi_message.h>
58
59#include "opt_ddb.h"
60#include "opt_isp.h"
61
62#define	ISP_PLATFORM_VERSION_MAJOR	7
63#define	ISP_PLATFORM_VERSION_MINOR	0
64
65/*
66 * Efficiency- get rid of SBus code && tests unless we need them.
67 */
68#ifdef __sparc64__
69#define	ISP_SBUS_SUPPORTED	1
70#else
71#define	ISP_SBUS_SUPPORTED	0
72#endif
73
74#define	ISP_IFLAGS	INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
75
76#ifdef	ISP_TARGET_MODE
77#define	ISP_TARGET_FUNCTIONS	1
78#define	ATPDPSIZE	4096
79
80#include <dev/isp/isp_target.h>
81
82typedef struct {
83	void *		next;
84	uint32_t	orig_datalen;
85	uint32_t	bytes_xfered;
86	uint32_t	last_xframt;
87	uint32_t	tag;
88	uint32_t	lun;
89	uint32_t	nphdl;
90	uint32_t	sid;
91	uint32_t	portid;
92	uint32_t
93			oxid	: 16,
94			cdb0	: 8,
95				: 1,
96			dead	: 1,
97			tattr	: 3,
98			state	: 3;
99} atio_private_data_t;
100#define	ATPD_STATE_FREE			0
101#define	ATPD_STATE_ATIO			1
102#define	ATPD_STATE_CAM			2
103#define	ATPD_STATE_CTIO			3
104#define	ATPD_STATE_LAST_CTIO		4
105#define	ATPD_STATE_PDON			5
106
107typedef union inot_private_data inot_private_data_t;
108union inot_private_data {
109	inot_private_data_t *next;
110	struct {
111		isp_notify_t nt;	/* must be first! */
112		uint8_t data[64];	/* sb QENTRY_LEN, but order of definitions is wrong */
113		uint32_t tag_id, seq_id;
114	} rd;
115};
116
117typedef struct tstate {
118	SLIST_ENTRY(tstate) next;
119	struct cam_path *owner;
120	struct ccb_hdr_slist atios;
121	struct ccb_hdr_slist inots;
122	uint32_t hold;
123	int atio_count;
124	int inot_count;
125	inot_private_data_t *	restart_queue;
126	inot_private_data_t *	ntfree;
127	inot_private_data_t	ntpool[ATPDPSIZE];
128	atio_private_data_t *	atfree;
129	atio_private_data_t	atpool[ATPDPSIZE];
130} tstate_t;
131
132#define	LUN_HASH_SIZE		32
133#define	LUN_HASH_FUNC(lun)	((lun) & (LUN_HASH_SIZE - 1))
134
135#endif
136
137/*
138 * Per command info.
139 */
140struct isp_pcmd {
141	struct isp_pcmd *	next;
142	bus_dmamap_t 		dmap;	/* dma map for this command */
143	struct ispsoftc *	isp;	/* containing isp */
144	struct callout		wdog;	/* watchdog timer */
145};
146#define	ISP_PCMD(ccb)		(ccb)->ccb_h.spriv_ptr1
147#define	PISP_PCMD(ccb)		((struct isp_pcmd *)ISP_PCMD(ccb))
148
149/*
150 * Per channel information
151 */
152SLIST_HEAD(tslist, tstate);
153
154struct isp_fc {
155	struct cam_sim *sim;
156	struct cam_path *path;
157	struct ispsoftc *isp;
158	struct proc *kproc;
159	bus_dma_tag_t tdmat;
160	bus_dmamap_t tdmap;
161	uint64_t def_wwpn;
162	uint64_t def_wwnn;
163	uint32_t loop_down_time;
164	uint32_t loop_down_limit;
165	uint32_t gone_device_time;
166	uint32_t
167#ifdef	ISP_TARGET_MODE
168#ifdef	ISP_INTERNAL_TARGET
169		proc_active	: 1,
170#endif
171		tm_luns_enabled	: 1,
172		tm_enable_defer	: 1,
173		tm_enabled	: 1,
174#endif
175		simqfrozen	: 3,
176		default_id	: 8,
177		hysteresis	: 8,
178		def_role	: 2,	/* default role */
179		gdt_running	: 1,
180		loop_dead	: 1,
181		fcbsy		: 1,
182		ready		: 1;
183	struct callout ldt;	/* loop down timer */
184	struct callout gdt;	/* gone device timer */
185#ifdef	ISP_TARGET_MODE
186	struct tslist lun_hash[LUN_HASH_SIZE];
187#ifdef	ISP_INTERNAL_TARGET
188	struct proc *		target_proc;
189#endif
190#endif
191};
192
193struct isp_spi {
194	struct cam_sim *sim;
195	struct cam_path *path;
196	uint32_t
197#ifdef	ISP_TARGET_MODE
198#ifdef	ISP_INTERNAL_TARGET
199		proc_active	: 1,
200#endif
201		tm_luns_enabled	: 1,
202		tm_enable_defer	: 1,
203		tm_enabled	: 1,
204#endif
205		simqfrozen	: 3,
206		def_role	: 2,
207		iid		: 4;
208#ifdef	ISP_TARGET_MODE
209	struct tslist lun_hash[LUN_HASH_SIZE];
210#ifdef	ISP_INTERNAL_TARGET
211	struct proc *		target_proc;
212#endif
213#endif
214};
215
216struct isposinfo {
217	/*
218	 * Linkage, locking, and identity
219	 */
220	struct mtx		lock;
221	device_t		dev;
222	struct cdev *		cdev;
223	struct intr_config_hook	ehook;
224	struct cam_devq *	devq;
225
226	/*
227	 * Firmware pointer
228	 */
229	const struct firmware *	fw;
230
231	/*
232	 * DMA related sdtuff
233	 */
234	bus_space_tag_t		bus_tag;
235	bus_dma_tag_t		dmat;
236	bus_space_handle_t	bus_handle;
237	bus_dma_tag_t		cdmat;
238	bus_dmamap_t		cdmap;
239
240	/*
241	 * Command and transaction related related stuff
242	 */
243	struct isp_pcmd *	pcmd_pool;
244	struct isp_pcmd *	pcmd_free;
245
246	uint32_t
247#ifdef	ISP_TARGET_MODE
248		tmwanted	: 1,
249		tmbusy		: 1,
250#else
251				: 2,
252#endif
253		forcemulti	: 1,
254		timer_active	: 1,
255		autoconf	: 1,
256		ehook_active	: 1,
257		disabled	: 1,
258		mbox_sleeping	: 1,
259		mbox_sleep_ok	: 1,
260		mboxcmd_done	: 1,
261		mboxbsy		: 1;
262
263	struct callout		tmo;	/* general timer */
264
265	/*
266	 * misc- needs to be sorted better XXXXXX
267	 */
268	int			framesize;
269	int			exec_throttle;
270	int			cont_max;
271
272#ifdef	ISP_TARGET_MODE
273	cam_status *		rptr;
274#endif
275
276	/*
277	 * Per-type private storage...
278	 */
279	union {
280		struct isp_fc *fc;
281		struct isp_spi *spi;
282		void *ptr;
283	} pc;
284};
285#define	ISP_FC_PC(isp, chan)	(&(isp)->isp_osinfo.pc.fc[(chan)])
286#define	ISP_SPI_PC(isp, chan)	(&(isp)->isp_osinfo.pc.spi[(chan)])
287#define	ISP_GET_PC(isp, chan, tag, rslt)		\
288	if (IS_SCSI(isp)) {				\
289		rslt = ISP_SPI_PC(isp, chan)-> tag;	\
290	} else {					\
291		rslt = ISP_FC_PC(isp, chan)-> tag;	\
292	}
293#define	ISP_GET_PC_ADDR(isp, chan, tag, rp)		\
294	if (IS_SCSI(isp)) {				\
295		rp = &ISP_SPI_PC(isp, chan)-> tag;	\
296	} else {					\
297		rp = &ISP_FC_PC(isp, chan)-> tag;	\
298	}
299#define	ISP_SET_PC(isp, chan, tag, val)			\
300	if (IS_SCSI(isp)) {				\
301		ISP_SPI_PC(isp, chan)-> tag = val;	\
302	} else {					\
303		ISP_FC_PC(isp, chan)-> tag = val;	\
304	}
305
306#define	isp_lock	isp_osinfo.lock
307#define	isp_bus_tag	isp_osinfo.bus_tag
308#define	isp_bus_handle	isp_osinfo.bus_handle
309
310/*
311 * Locking macros...
312 */
313#define	ISP_LOCK(isp)	mtx_lock(&isp->isp_osinfo.lock)
314#define	ISP_UNLOCK(isp)	mtx_unlock(&isp->isp_osinfo.lock)
315
316/*
317 * Required Macros/Defines
318 */
319
320#define	ISP_FC_SCRLEN		0x1000
321
322#define	ISP_MEMZERO(a, b)	memset(a, 0, b)
323#define	ISP_MEMCPY		memcpy
324#define	ISP_SNPRINTF		snprintf
325#define	ISP_DELAY		DELAY
326#define	ISP_SLEEP(isp, x)	DELAY(x)
327
328#define	ISP_MIN			imin
329
330#ifndef	DIAGNOSTIC
331#define	ISP_INLINE		__inline
332#else
333#define	ISP_INLINE
334#endif
335
336#define	NANOTIME_T		struct timespec
337#define	GET_NANOTIME		nanotime
338#define	GET_NANOSEC(x)		((x)->tv_sec * 1000000000 + (x)->tv_nsec)
339#define	NANOTIME_SUB		isp_nanotime_sub
340
341#define	MAXISPREQUEST(isp)	((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256)
342
343#define	MEMORYBARRIER(isp, type, offset, size, chan)		\
344switch (type) {							\
345case SYNC_SFORDEV:						\
346{								\
347	struct isp_fc *fc = ISP_FC_PC(isp, chan);		\
348	bus_dmamap_sync(fc->tdmat, fc->tdmap,			\
349	   BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);		\
350	break;							\
351}								\
352case SYNC_REQUEST:						\
353	bus_dmamap_sync(isp->isp_osinfo.cdmat,			\
354	   isp->isp_osinfo.cdmap, 				\
355	   BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);		\
356	break;							\
357case SYNC_SFORCPU:						\
358{								\
359	struct isp_fc *fc = ISP_FC_PC(isp, chan);		\
360	bus_dmamap_sync(fc->tdmat, fc->tdmap,			\
361	   BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);	\
362	break;							\
363}								\
364case SYNC_RESULT:						\
365	bus_dmamap_sync(isp->isp_osinfo.cdmat, 			\
366	   isp->isp_osinfo.cdmap,				\
367	   BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);	\
368	break;							\
369case SYNC_REG:							\
370	bus_space_barrier(isp->isp_osinfo.bus_tag,		\
371	    isp->isp_osinfo.bus_handle, offset, size,		\
372	    BUS_SPACE_BARRIER_READ);				\
373	break;							\
374default:							\
375	break;							\
376}
377
378#define	MBOX_ACQUIRE			isp_mbox_acquire
379#define	MBOX_WAIT_COMPLETE		isp_mbox_wait_complete
380#define	MBOX_NOTIFY_COMPLETE		isp_mbox_notify_done
381#define	MBOX_RELEASE			isp_mbox_release
382
383#define	FC_SCRATCH_ACQUIRE		isp_fc_scratch_acquire
384#define	FC_SCRATCH_RELEASE(isp, chan)	isp->isp_osinfo.pc.fc[chan].fcbsy = 0
385
386#ifndef	SCSI_GOOD
387#define	SCSI_GOOD	SCSI_STATUS_OK
388#endif
389#ifndef	SCSI_CHECK
390#define	SCSI_CHECK	SCSI_STATUS_CHECK_COND
391#endif
392#ifndef	SCSI_BUSY
393#define	SCSI_BUSY	SCSI_STATUS_BUSY
394#endif
395#ifndef	SCSI_QFULL
396#define	SCSI_QFULL	SCSI_STATUS_QUEUE_FULL
397#endif
398
399#define	XS_T			struct ccb_scsiio
400#define	XS_DMA_ADDR_T		bus_addr_t
401#define XS_GET_DMA64_SEG(a, b, c)		\
402{						\
403	ispds64_t *d = a;			\
404	bus_dma_segment_t *e = b;		\
405	uint32_t f = c;				\
406	e += f;					\
407        d->ds_base = DMA_LO32(e->ds_addr);	\
408        d->ds_basehi = DMA_HI32(e->ds_addr);	\
409        d->ds_count = e->ds_len;		\
410}
411#define XS_GET_DMA_SEG(a, b, c)			\
412{						\
413	ispds_t *d = a;				\
414	bus_dma_segment_t *e = b;		\
415	uint32_t f = c;				\
416	e += f;					\
417        d->ds_base = DMA_LO32(e->ds_addr);	\
418        d->ds_count = e->ds_len;		\
419}
420#define	XS_ISP(ccb)		cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path))
421#define	XS_CHANNEL(ccb)		cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
422#define	XS_TGT(ccb)		(ccb)->ccb_h.target_id
423#define	XS_LUN(ccb)		(ccb)->ccb_h.target_lun
424
425#define	XS_CDBP(ccb)	\
426	(((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
427	 (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)
428
429#define	XS_CDBLEN(ccb)		(ccb)->cdb_len
430#define	XS_XFRLEN(ccb)		(ccb)->dxfer_len
431#define	XS_TIME(ccb)		(ccb)->ccb_h.timeout
432#define	XS_GET_RESID(ccb)	(ccb)->resid
433#define	XS_SET_RESID(ccb, r)	(ccb)->resid = r
434#define	XS_STSP(ccb)		(&(ccb)->scsi_status)
435#define	XS_SNSP(ccb)		(&(ccb)->sense_data)
436
437#define	XS_SNSLEN(ccb)		\
438	imin((sizeof((ccb)->sense_data)), ccb->sense_len)
439
440#define	XS_SNSKEY(ccb)		((ccb)->sense_data.flags & 0xf)
441#define	XS_SNSASC(ccb)		((ccb)->sense_data.add_sense_code)
442#define	XS_SNSASCQ(ccb)		((ccb)->sense_data.add_sense_code_qual)
443#define	XS_TAG_P(ccb)	\
444	(((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \
445	 (ccb)->tag_action != CAM_TAG_ACTION_NONE)
446
447#define	XS_TAG_TYPE(ccb)	\
448	((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \
449	 ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG))
450
451
452#define	XS_SETERR(ccb, v)	(ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
453				(ccb)->ccb_h.status |= v, \
454				(ccb)->ccb_h.spriv_field0 |= ISP_SPRIV_ERRSET
455
456#	define	HBA_NOERROR		CAM_REQ_INPROG
457#	define	HBA_BOTCH		CAM_UNREC_HBA_ERROR
458#	define	HBA_CMDTIMEOUT		CAM_CMD_TIMEOUT
459#	define	HBA_SELTIMEOUT		CAM_SEL_TIMEOUT
460#	define	HBA_TGTBSY		CAM_SCSI_STATUS_ERROR
461#	define	HBA_BUSRESET		CAM_SCSI_BUS_RESET
462#	define	HBA_ABORTED		CAM_REQ_ABORTED
463#	define	HBA_DATAOVR		CAM_DATA_RUN_ERR
464#	define	HBA_ARQFAIL		CAM_AUTOSENSE_FAIL
465
466
467#define	XS_ERR(ccb)		((ccb)->ccb_h.status & CAM_STATUS_MASK)
468
469#define	XS_NOERR(ccb)		\
470	(((ccb)->ccb_h.spriv_field0 & ISP_SPRIV_ERRSET) == 0 || \
471	 ((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)
472
473#define	XS_INITERR(ccb)		\
474	XS_SETERR(ccb, CAM_REQ_INPROG), (ccb)->ccb_h.spriv_field0 = 0
475
476#define	XS_SAVE_SENSE(xs, sense_ptr, sense_len)		\
477	(xs)->ccb_h.status |= CAM_AUTOSNS_VALID;	\
478	memcpy(&(xs)->sense_data, sense_ptr, imin(XS_SNSLEN(xs), sense_len))
479
480#define	XS_SENSE_VALID(xs)	(((xs)->ccb_h.status & CAM_AUTOSNS_VALID) != 0)
481
482#define	DEFAULT_FRAMESIZE(isp)		isp->isp_osinfo.framesize
483#define	DEFAULT_EXEC_THROTTLE(isp)	isp->isp_osinfo.exec_throttle
484
485#define	GET_DEFAULT_ROLE(isp, chan)	\
486	(IS_FC(isp)? ISP_FC_PC(isp, chan)->def_role : ISP_SPI_PC(isp, chan)->def_role)
487#define	SET_DEFAULT_ROLE(isp, chan, val)		\
488	if (IS_FC(isp)) { 				\
489		ISP_FC_PC(isp, chan)->def_role = val;	\
490	} else {					\
491		ISP_SPI_PC(isp, chan)->def_role = val;	\
492	}
493
494#define	DEFAULT_IID(isp, chan)		isp->isp_osinfo.pc.spi[chan].iid
495
496#define	DEFAULT_LOOPID(x, chan)		isp->isp_osinfo.pc.fc[chan].default_id
497
498#define DEFAULT_NODEWWN(isp, chan)  	isp_default_wwn(isp, chan, 0, 1)
499#define DEFAULT_PORTWWN(isp, chan)  	isp_default_wwn(isp, chan, 0, 0)
500#define ACTIVE_NODEWWN(isp, chan)   	isp_default_wwn(isp, chan, 1, 1)
501#define ACTIVE_PORTWWN(isp, chan)   	isp_default_wwn(isp, chan, 1, 0)
502
503
504#if	BYTE_ORDER == BIG_ENDIAN
505#ifdef	ISP_SBUS_SUPPORTED
506#define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
507#define	ISP_IOXPUT_16(isp, s, d)				\
508	*(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s)
509#define	ISP_IOXPUT_32(isp, s, d)				\
510	*(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s)
511#define	ISP_IOXGET_8(isp, s, d)		d = (*((uint8_t *)s))
512#define	ISP_IOXGET_16(isp, s, d)				\
513	d = (isp->isp_bustype == ISP_BT_SBUS)?			\
514	*((uint16_t *)s) : bswap16(*((uint16_t *)s))
515#define	ISP_IOXGET_32(isp, s, d)				\
516	d = (isp->isp_bustype == ISP_BT_SBUS)?			\
517	*((uint32_t *)s) : bswap32(*((uint32_t *)s))
518
519#else	/* ISP_SBUS_SUPPORTED */
520#define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
521#define	ISP_IOXPUT_16(isp, s, d)	*(d) = bswap16(s)
522#define	ISP_IOXPUT_32(isp, s, d)	*(d) = bswap32(s)
523#define	ISP_IOXGET_8(isp, s, d)		d = (*((uint8_t *)s))
524#define	ISP_IOXGET_16(isp, s, d)	d = bswap16(*((uint16_t *)s))
525#define	ISP_IOXGET_32(isp, s, d)	d = bswap32(*((uint32_t *)s))
526#endif
527#define	ISP_SWIZZLE_NVRAM_WORD(isp, rp)	*rp = bswap16(*rp)
528#define	ISP_SWIZZLE_NVRAM_LONG(isp, rp)	*rp = bswap32(*rp)
529
530#define	ISP_IOZGET_8(isp, s, d)		d = (*((uint8_t *)s))
531#define	ISP_IOZGET_16(isp, s, d)	d = (*((uint16_t *)s))
532#define	ISP_IOZGET_32(isp, s, d)	d = (*((uint32_t *)s))
533#define	ISP_IOZPUT_8(isp, s, d)		*(d) = s
534#define	ISP_IOZPUT_16(isp, s, d)	*(d) = s
535#define	ISP_IOZPUT_32(isp, s, d)	*(d) = s
536
537
538#else
539#define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
540#define	ISP_IOXPUT_16(isp, s, d)	*(d) = s
541#define	ISP_IOXPUT_32(isp, s, d)	*(d) = s
542#define	ISP_IOXGET_8(isp, s, d)		d = *(s)
543#define	ISP_IOXGET_16(isp, s, d)	d = *(s)
544#define	ISP_IOXGET_32(isp, s, d)	d = *(s)
545#define	ISP_SWIZZLE_NVRAM_WORD(isp, rp)
546#define	ISP_SWIZZLE_NVRAM_LONG(isp, rp)
547
548#define	ISP_IOZPUT_8(isp, s, d)		*(d) = s
549#define	ISP_IOZPUT_16(isp, s, d)	*(d) = bswap16(s)
550#define	ISP_IOZPUT_32(isp, s, d)	*(d) = bswap32(s)
551
552#define	ISP_IOZGET_8(isp, s, d)		d = (*((uint8_t *)(s)))
553#define	ISP_IOZGET_16(isp, s, d)	d = bswap16(*((uint16_t *)(s)))
554#define	ISP_IOZGET_32(isp, s, d)	d = bswap32(*((uint32_t *)(s)))
555
556#endif
557
558#define	ISP_SWAP16(isp, s)	bswap16(s)
559#define	ISP_SWAP32(isp, s)	bswap32(s)
560
561/*
562 * Includes of common header files
563 */
564
565#include <dev/isp/ispreg.h>
566#include <dev/isp/ispvar.h>
567#include <dev/isp/ispmbox.h>
568
569/*
570 * isp_osinfo definiitions && shorthand
571 */
572#define	SIMQFRZ_RESOURCE	0x1
573#define	SIMQFRZ_LOOPDOWN	0x2
574#define	SIMQFRZ_TIMED		0x4
575
576#define	isp_dev		isp_osinfo.dev
577
578/*
579 * prototypes for isp_pci && isp_freebsd to share
580 */
581extern int isp_attach(ispsoftc_t *);
582extern void isp_detach(ispsoftc_t *);
583extern void isp_uninit(ispsoftc_t *);
584extern uint64_t isp_default_wwn(ispsoftc_t *, int, int, int);
585
586/*
587 * driver global data
588 */
589extern int isp_announced;
590extern int isp_fabric_hysteresis;
591extern int isp_loop_down_limit;
592extern int isp_gone_device_time;
593extern int isp_quickboot_time;
594extern int isp_autoconfig;
595
596/*
597 * Platform private flags
598 */
599#define	ISP_SPRIV_ERRSET	0x1
600#define	ISP_SPRIV_DONE		0x8
601
602#define	XS_CMD_S_DONE(sccb)	(sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_DONE
603#define	XS_CMD_C_DONE(sccb)	(sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_DONE
604#define	XS_CMD_DONE_P(sccb)	((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_DONE)
605
606#define	XS_CMD_S_CLEAR(sccb)	(sccb)->ccb_h.spriv_field0 = 0
607
608/*
609 * Platform Library Functions
610 */
611void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4);
612void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) __printflike(4, 5);
613uint64_t isp_nanotime_sub(struct timespec *, struct timespec *);
614int isp_mbox_acquire(ispsoftc_t *);
615void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *);
616void isp_mbox_notify_done(ispsoftc_t *);
617void isp_mbox_release(ispsoftc_t *);
618int isp_fc_scratch_acquire(ispsoftc_t *, int);
619int isp_mstohz(int);
620void isp_platform_intr(void *);
621void isp_common_dmateardown(ispsoftc_t *, struct ccb_scsiio *, uint32_t);
622
623/*
624 * Platform Version specific defines
625 */
626#define	BUS_DMA_ROOTARG(x)	bus_get_dma_tag(x)
627#define	isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)	\
628	bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, \
629	busdma_lock_mutex, &isp->isp_osinfo.lock, z)
630
631#define	isp_setup_intr	bus_setup_intr
632
633#define	isp_sim_alloc(a, b, c, d, e, f, g, h)	\
634	cam_sim_alloc(a, b, c, d, e, &(d)->isp_osinfo.lock, f, g, h)
635
636/* Should be BUS_SPACE_MAXSIZE, but MAXPHYS is larger than BUS_SPACE_MAXSIZE */
637#define ISP_NSEGS ((MAXPHYS / PAGE_SIZE) + 1)
638
639#define	ISP_PATH_PRT(i, l, p, ...)					\
640	if ((l) == ISP_LOGALL || ((l)& (i)->isp_dblev) != 0) {		\
641                xpt_print(p, __VA_ARGS__);				\
642        }
643
644/*
645 * Platform specific inline functions
646 */
647
648/*
649 * ISP General Library functions
650 */
651
652#include <dev/isp/isp_library.h>
653
654#endif	/* _ISP_FREEBSD_H */
655