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