xref: /freebsd/sys/dev/isp/isp_freebsd.h (revision 409a390c3341fb4f162cd7de1fd595a323ebbfd8)
1 /* $FreeBSD$ */
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 
82 typedef 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 
107 typedef union inot_private_data inot_private_data_t;
108 union 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 
117 typedef 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  */
140 struct 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  */
152 SLIST_HEAD(tslist, tstate);
153 
154 struct 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 		role		: 2,
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 
193 struct 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 		role		: 3,
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 
216 struct 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 #ifndef	DIAGNOSTIC
329 #define	ISP_INLINE		__inline
330 #else
331 #define	ISP_INLINE
332 #endif
333 
334 #define	NANOTIME_T		struct timespec
335 #define	GET_NANOTIME		nanotime
336 #define	GET_NANOSEC(x)		((x)->tv_sec * 1000000000 + (x)->tv_nsec)
337 #define	NANOTIME_SUB		isp_nanotime_sub
338 
339 #define	MAXISPREQUEST(isp)	((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256)
340 
341 #define	MEMORYBARRIER(isp, type, offset, size)			\
342 switch (type) {							\
343 case SYNC_SFORDEV:						\
344 case SYNC_REQUEST:						\
345 	bus_dmamap_sync(isp->isp_osinfo.cdmat,			\
346 	   isp->isp_osinfo.cdmap, 				\
347 	   BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);		\
348 	break;							\
349 case SYNC_SFORCPU:						\
350 case SYNC_RESULT:						\
351 	bus_dmamap_sync(isp->isp_osinfo.cdmat, 			\
352 	   isp->isp_osinfo.cdmap,				\
353 	   BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);	\
354 	break;							\
355 case SYNC_REG:							\
356 	bus_space_barrier(isp->isp_osinfo.bus_tag,		\
357 	    isp->isp_osinfo.bus_handle, offset, size,		\
358 	    BUS_SPACE_BARRIER_READ);				\
359 	break;							\
360 default:							\
361 	break;							\
362 }
363 
364 #define	MBOX_ACQUIRE			isp_mbox_acquire
365 #define	MBOX_WAIT_COMPLETE		isp_mbox_wait_complete
366 #define	MBOX_NOTIFY_COMPLETE		isp_mbox_notify_done
367 #define	MBOX_RELEASE			isp_mbox_release
368 
369 #define	FC_SCRATCH_ACQUIRE		isp_fc_scratch_acquire
370 #define	FC_SCRATCH_RELEASE(isp, chan)	isp->isp_osinfo.pc.fc[chan].fcbsy = 0
371 
372 #ifndef	SCSI_GOOD
373 #define	SCSI_GOOD	SCSI_STATUS_OK
374 #endif
375 #ifndef	SCSI_CHECK
376 #define	SCSI_CHECK	SCSI_STATUS_CHECK_COND
377 #endif
378 #ifndef	SCSI_BUSY
379 #define	SCSI_BUSY	SCSI_STATUS_BUSY
380 #endif
381 #ifndef	SCSI_QFULL
382 #define	SCSI_QFULL	SCSI_STATUS_QUEUE_FULL
383 #endif
384 
385 #define	XS_T			struct ccb_scsiio
386 #define	XS_DMA_ADDR_T		bus_addr_t
387 #define XS_GET_DMA64_SEG(a, b, c)		\
388 {						\
389 	ispds64_t *d = a;			\
390 	bus_dma_segment_t *e = b;		\
391 	uint32_t f = c;				\
392 	e += f;					\
393         d->ds_base = DMA_LO32(e->ds_addr);	\
394         d->ds_basehi = DMA_HI32(e->ds_addr);	\
395         d->ds_count = e->ds_len;		\
396 }
397 #define XS_GET_DMA_SEG(a, b, c)			\
398 {						\
399 	ispds_t *d = a;				\
400 	bus_dma_segment_t *e = b;		\
401 	uint32_t f = c;				\
402 	e += f;					\
403         d->ds_base = DMA_LO32(e->ds_addr);	\
404         d->ds_count = e->ds_len;		\
405 }
406 #define	XS_ISP(ccb)		cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path))
407 #define	XS_CHANNEL(ccb)		cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
408 #define	XS_TGT(ccb)		(ccb)->ccb_h.target_id
409 #define	XS_LUN(ccb)		(ccb)->ccb_h.target_lun
410 
411 #define	XS_CDBP(ccb)	\
412 	(((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
413 	 (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)
414 
415 #define	XS_CDBLEN(ccb)		(ccb)->cdb_len
416 #define	XS_XFRLEN(ccb)		(ccb)->dxfer_len
417 #define	XS_TIME(ccb)		(ccb)->ccb_h.timeout
418 #define	XS_GET_RESID(ccb)	(ccb)->resid
419 #define	XS_SET_RESID(ccb, r)	(ccb)->resid = r
420 #define	XS_STSP(ccb)		(&(ccb)->scsi_status)
421 #define	XS_SNSP(ccb)		(&(ccb)->sense_data)
422 
423 #define	XS_SNSLEN(ccb)		\
424 	imin((sizeof((ccb)->sense_data)), ccb->sense_len)
425 
426 #define	XS_SNSKEY(ccb)		((ccb)->sense_data.flags & 0xf)
427 #define	XS_TAG_P(ccb)	\
428 	(((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \
429 	 (ccb)->tag_action != CAM_TAG_ACTION_NONE)
430 
431 #define	XS_TAG_TYPE(ccb)	\
432 	((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \
433 	 ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG))
434 
435 
436 #define	XS_SETERR(ccb, v)	(ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
437 				(ccb)->ccb_h.status |= v, \
438 				(ccb)->ccb_h.spriv_field0 |= ISP_SPRIV_ERRSET
439 
440 #	define	HBA_NOERROR		CAM_REQ_INPROG
441 #	define	HBA_BOTCH		CAM_UNREC_HBA_ERROR
442 #	define	HBA_CMDTIMEOUT		CAM_CMD_TIMEOUT
443 #	define	HBA_SELTIMEOUT		CAM_SEL_TIMEOUT
444 #	define	HBA_TGTBSY		CAM_SCSI_STATUS_ERROR
445 #	define	HBA_BUSRESET		CAM_SCSI_BUS_RESET
446 #	define	HBA_ABORTED		CAM_REQ_ABORTED
447 #	define	HBA_DATAOVR		CAM_DATA_RUN_ERR
448 #	define	HBA_ARQFAIL		CAM_AUTOSENSE_FAIL
449 
450 
451 #define	XS_ERR(ccb)		((ccb)->ccb_h.status & CAM_STATUS_MASK)
452 
453 #define	XS_NOERR(ccb)		\
454 	(((ccb)->ccb_h.spriv_field0 & ISP_SPRIV_ERRSET) == 0 || \
455 	 ((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)
456 
457 #define	XS_INITERR(ccb)		\
458 	XS_SETERR(ccb, CAM_REQ_INPROG), (ccb)->ccb_h.spriv_field0 = 0
459 
460 #define	XS_SAVE_SENSE(xs, sense_ptr, sense_len)		\
461 	(xs)->ccb_h.status |= CAM_AUTOSNS_VALID;	\
462 	memcpy(&(xs)->sense_data, sense_ptr, imin(XS_SNSLEN(xs), sense_len))
463 
464 #define	XS_SET_STATE_STAT(a, b, c)
465 
466 #define	DEFAULT_FRAMESIZE(isp)		isp->isp_osinfo.framesize
467 #define	DEFAULT_EXEC_THROTTLE(isp)	isp->isp_osinfo.exec_throttle
468 
469 #define	GET_DEFAULT_ROLE(isp, chan)	\
470 	(IS_FC(isp)? ISP_FC_PC(isp, chan)->role : ISP_SPI_PC(isp, chan)->role)
471 #define	SET_DEFAULT_ROLE(isp, chan, val)		\
472 	if (IS_FC(isp)) { 				\
473 		ISP_FC_PC(isp, chan)->role = val;	\
474 	} else {					\
475 		ISP_SPI_PC(isp, chan)->role = val;	\
476 	}
477 
478 #define	DEFAULT_IID(isp, chan)		isp->isp_osinfo.pc.spi[chan].iid
479 
480 #define	DEFAULT_LOOPID(x, chan)		isp->isp_osinfo.pc.fc[chan].default_id
481 
482 #define DEFAULT_NODEWWN(isp, chan)  	isp_default_wwn(isp, chan, 0, 1)
483 #define DEFAULT_PORTWWN(isp, chan)  	isp_default_wwn(isp, chan, 0, 0)
484 #define ACTIVE_NODEWWN(isp, chan)   	isp_default_wwn(isp, chan, 1, 1)
485 #define ACTIVE_PORTWWN(isp, chan)   	isp_default_wwn(isp, chan, 1, 0)
486 
487 
488 #if	BYTE_ORDER == BIG_ENDIAN
489 #ifdef	ISP_SBUS_SUPPORTED
490 #define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
491 #define	ISP_IOXPUT_16(isp, s, d)				\
492 	*(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s)
493 #define	ISP_IOXPUT_32(isp, s, d)				\
494 	*(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s)
495 #define	ISP_IOXGET_8(isp, s, d)		d = (*((uint8_t *)s))
496 #define	ISP_IOXGET_16(isp, s, d)				\
497 	d = (isp->isp_bustype == ISP_BT_SBUS)?			\
498 	*((uint16_t *)s) : bswap16(*((uint16_t *)s))
499 #define	ISP_IOXGET_32(isp, s, d)				\
500 	d = (isp->isp_bustype == ISP_BT_SBUS)?			\
501 	*((uint32_t *)s) : bswap32(*((uint32_t *)s))
502 
503 #else	/* ISP_SBUS_SUPPORTED */
504 #define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
505 #define	ISP_IOXPUT_16(isp, s, d)	*(d) = bswap16(s)
506 #define	ISP_IOXPUT_32(isp, s, d)	*(d) = bswap32(s)
507 #define	ISP_IOXGET_8(isp, s, d)		d = (*((uint8_t *)s))
508 #define	ISP_IOXGET_16(isp, s, d)	d = bswap16(*((uint16_t *)s))
509 #define	ISP_IOXGET_32(isp, s, d)	d = bswap32(*((uint32_t *)s))
510 #endif
511 #define	ISP_SWIZZLE_NVRAM_WORD(isp, rp)	*rp = bswap16(*rp)
512 #define	ISP_SWIZZLE_NVRAM_LONG(isp, rp)	*rp = bswap32(*rp)
513 
514 #define	ISP_IOZGET_8(isp, s, d)		d = (*((uint8_t *)s))
515 #define	ISP_IOZGET_16(isp, s, d)	d = (*((uint16_t *)s))
516 #define	ISP_IOZGET_32(isp, s, d)	d = (*((uint32_t *)s))
517 #define	ISP_IOZPUT_8(isp, s, d)		*(d) = s
518 #define	ISP_IOZPUT_16(isp, s, d)	*(d) = s
519 #define	ISP_IOZPUT_32(isp, s, d)	*(d) = s
520 
521 
522 #else
523 #define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
524 #define	ISP_IOXPUT_16(isp, s, d)	*(d) = s
525 #define	ISP_IOXPUT_32(isp, s, d)	*(d) = s
526 #define	ISP_IOXGET_8(isp, s, d)		d = *(s)
527 #define	ISP_IOXGET_16(isp, s, d)	d = *(s)
528 #define	ISP_IOXGET_32(isp, s, d)	d = *(s)
529 #define	ISP_SWIZZLE_NVRAM_WORD(isp, rp)
530 #define	ISP_SWIZZLE_NVRAM_LONG(isp, rp)
531 
532 #define	ISP_IOZPUT_8(isp, s, d)		*(d) = s
533 #define	ISP_IOZPUT_16(isp, s, d)	*(d) = bswap16(s)
534 #define	ISP_IOZPUT_32(isp, s, d)	*(d) = bswap32(s)
535 
536 #define	ISP_IOZGET_8(isp, s, d)		d = (*((uint8_t *)(s)))
537 #define	ISP_IOZGET_16(isp, s, d)	d = bswap16(*((uint16_t *)(s)))
538 #define	ISP_IOZGET_32(isp, s, d)	d = bswap32(*((uint32_t *)(s)))
539 
540 #endif
541 
542 #define	ISP_SWAP16(isp, s)	bswap16(s)
543 #define	ISP_SWAP32(isp, s)	bswap32(s)
544 
545 /*
546  * Includes of common header files
547  */
548 
549 #include <dev/isp/ispreg.h>
550 #include <dev/isp/ispvar.h>
551 #include <dev/isp/ispmbox.h>
552 
553 /*
554  * isp_osinfo definiitions && shorthand
555  */
556 #define	SIMQFRZ_RESOURCE	0x1
557 #define	SIMQFRZ_LOOPDOWN	0x2
558 #define	SIMQFRZ_TIMED		0x4
559 
560 #define	isp_dev		isp_osinfo.dev
561 
562 /*
563  * prototypes for isp_pci && isp_freebsd to share
564  */
565 extern int isp_attach(ispsoftc_t *);
566 extern void isp_detach(ispsoftc_t *);
567 extern void isp_uninit(ispsoftc_t *);
568 extern uint64_t isp_default_wwn(ispsoftc_t *, int, int, int);
569 
570 /*
571  * driver global data
572  */
573 extern int isp_announced;
574 extern int isp_fabric_hysteresis;
575 extern int isp_loop_down_limit;
576 extern int isp_gone_device_time;
577 extern int isp_quickboot_time;
578 extern int isp_autoconfig;
579 
580 /*
581  * Platform private flags
582  */
583 #define	ISP_SPRIV_ERRSET	0x1
584 #define	ISP_SPRIV_DONE		0x8
585 
586 #define	XS_CMD_S_DONE(sccb)	(sccb)->ccb_h.spriv_field0 |= ISP_SPRIV_DONE
587 #define	XS_CMD_C_DONE(sccb)	(sccb)->ccb_h.spriv_field0 &= ~ISP_SPRIV_DONE
588 #define	XS_CMD_DONE_P(sccb)	((sccb)->ccb_h.spriv_field0 & ISP_SPRIV_DONE)
589 
590 #define	XS_CMD_S_CLEAR(sccb)	(sccb)->ccb_h.spriv_field0 = 0
591 
592 /*
593  * Platform Library Functions
594  */
595 void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4);
596 uint64_t isp_nanotime_sub(struct timespec *, struct timespec *);
597 int isp_mbox_acquire(ispsoftc_t *);
598 void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *);
599 void isp_mbox_notify_done(ispsoftc_t *);
600 void isp_mbox_release(ispsoftc_t *);
601 int isp_fc_scratch_acquire(ispsoftc_t *, int);
602 int isp_mstohz(int);
603 void isp_platform_intr(void *);
604 void isp_common_dmateardown(ispsoftc_t *, struct ccb_scsiio *, uint32_t);
605 
606 /*
607  * Platform Version specific defines
608  */
609 #define	BUS_DMA_ROOTARG(x)	bus_get_dma_tag(x)
610 #define	isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)	\
611 	bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, \
612 	busdma_lock_mutex, &isp->isp_osinfo.lock, z)
613 
614 #define	isp_setup_intr	bus_setup_intr
615 
616 #define	isp_sim_alloc(a, b, c, d, e, f, g, h)	\
617 	cam_sim_alloc(a, b, c, d, e, &(d)->isp_osinfo.lock, f, g, h)
618 
619 /* Should be BUS_SPACE_MAXSIZE, but MAXPHYS is larger than BUS_SPACE_MAXSIZE */
620 #define ISP_NSEGS ((MAXPHYS / PAGE_SIZE) + 1)
621 
622 #define	ISP_PATH_PRT(i, l, p, ...)					\
623 	if ((l) == ISP_LOGALL || ((l)& (i)->isp_dblev) != 0) {		\
624                 xpt_print(p, __VA_ARGS__);				\
625         }
626 
627 /*
628  * Platform specific inline functions
629  */
630 
631 /*
632  * ISP General Library functions
633  */
634 
635 #include <dev/isp/isp_library.h>
636 
637 #endif	/* _ISP_FREEBSD_H */
638