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