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