xref: /freebsd/sys/dev/isp/isp_freebsd.h (revision 83d9fd40d5cb67ff1e805523a6fae48c3389f396)
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/jail.h>
36 #include <sys/lock.h>
37 #include <sys/kernel.h>
38 #include <sys/queue.h>
39 #include <sys/malloc.h>
40 #include <sys/mutex.h>
41 #include <sys/condvar.h>
42 #include <sys/rman.h>
43 #include <sys/sysctl.h>
44 
45 #include <sys/proc.h>
46 #include <sys/bus.h>
47 #include <sys/taskqueue.h>
48 
49 #include <machine/bus.h>
50 #include <machine/cpu.h>
51 #include <machine/stdarg.h>
52 
53 #include <cam/cam.h>
54 #include <cam/cam_debug.h>
55 #include <cam/cam_ccb.h>
56 #include <cam/cam_sim.h>
57 #include <cam/cam_xpt.h>
58 #include <cam/cam_xpt_sim.h>
59 #include <cam/cam_debug.h>
60 #include <cam/scsi/scsi_all.h>
61 #include <cam/scsi/scsi_message.h>
62 
63 #include "opt_ddb.h"
64 #include "opt_isp.h"
65 
66 #define	ISP_PLATFORM_VERSION_MAJOR	7
67 #define	ISP_PLATFORM_VERSION_MINOR	10
68 
69 /*
70  * Efficiency- get rid of SBus code && tests unless we need them.
71  */
72 #ifdef __sparc64__
73 #define	ISP_SBUS_SUPPORTED	1
74 #else
75 #define	ISP_SBUS_SUPPORTED	0
76 #endif
77 
78 #define	ISP_IFLAGS	INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
79 
80 #define	N_XCMDS		64
81 #define	XCMD_SIZE	512
82 struct ispsoftc;
83 typedef union isp_ecmd {
84 	union isp_ecmd *	next;
85 	uint8_t			data[XCMD_SIZE];
86 } isp_ecmd_t;
87 isp_ecmd_t *	isp_get_ecmd(struct ispsoftc *);
88 void		isp_put_ecmd(struct ispsoftc *, isp_ecmd_t *);
89 
90 #ifdef	ISP_TARGET_MODE
91 #define	ATPDPSIZE	4096
92 #define	ATPDPHASHSIZE	32
93 #define	ATPDPHASH(x)	((((x) >> 24) ^ ((x) >> 16) ^ ((x) >> 8) ^ (x)) &  \
94 			    ((ATPDPHASHSIZE) - 1))
95 
96 #include <dev/isp/isp_target.h>
97 typedef struct atio_private_data {
98 	LIST_ENTRY(atio_private_data)	next;
99 	uint32_t	orig_datalen;
100 	uint32_t	bytes_xfered;
101 	uint32_t	bytes_in_transit;
102 	uint32_t	tag;		/* typically f/w RX_ID */
103 	lun_id_t	lun;
104 	uint32_t	nphdl;
105 	uint32_t	sid;
106 	uint32_t	did;
107 	uint16_t	rxid;	/* wire rxid */
108 	uint16_t	oxid;	/* wire oxid */
109 	uint16_t	word3;	/* PRLI word3 params */
110 	uint16_t	ctcnt;	/* number of CTIOs currently active */
111 	uint8_t		seqno;	/* CTIO sequence number */
112 	uint32_t
113 			srr_notify_rcvd	: 1,
114 			cdb0		: 8,
115 			sendst		: 1,
116 			dead		: 1,
117 			tattr		: 3,
118 			state		: 3;
119 	void *		ests;
120 	/*
121 	 * The current SRR notify copy
122 	 */
123 	uint8_t		srr[64];	/*  sb QENTRY_LEN, but order of definitions is wrong */
124 	void *		srr_ccb;
125 	uint32_t	nsrr;
126 } atio_private_data_t;
127 #define	ATPD_STATE_FREE			0
128 #define	ATPD_STATE_ATIO			1
129 #define	ATPD_STATE_CAM			2
130 #define	ATPD_STATE_CTIO			3
131 #define	ATPD_STATE_LAST_CTIO		4
132 #define	ATPD_STATE_PDON			5
133 
134 #define	ATPD_CCB_OUTSTANDING		16
135 
136 #define	ATPD_SEQ_MASK			0x7f
137 #define	ATPD_SEQ_NOTIFY_CAM		0x80
138 #define	ATPD_SET_SEQNO(hdrp, atp)	((isphdr_t *)hdrp)->rqs_seqno &= ~ATPD_SEQ_MASK, ((isphdr_t *)hdrp)->rqs_seqno |= (atp)->seqno
139 #define	ATPD_GET_SEQNO(hdrp)		(((isphdr_t *)hdrp)->rqs_seqno & ATPD_SEQ_MASK)
140 #define	ATPD_GET_NCAM(hdrp)		((((isphdr_t *)hdrp)->rqs_seqno & ATPD_SEQ_NOTIFY_CAM) != 0)
141 
142 typedef struct inot_private_data inot_private_data_t;
143 struct inot_private_data {
144 	STAILQ_ENTRY(inot_private_data)	next;
145 	isp_notify_t nt;
146 	uint8_t data[64];	/* sb QENTRY_LEN, but order of definitions is wrong */
147 	uint32_t tag_id, seq_id;
148 };
149 typedef struct isp_timed_notify_ack {
150 	void *isp;
151 	void *not;
152 	uint8_t data[64];	 /* sb QENTRY_LEN, but order of definitions is wrong */
153 	struct callout timer;
154 } isp_tna_t;
155 
156 STAILQ_HEAD(ntpdlist, inot_private_data);
157 typedef struct tstate {
158 	SLIST_ENTRY(tstate)	next;
159 	lun_id_t		ts_lun;
160 	struct ccb_hdr_slist	atios;
161 	struct ccb_hdr_slist	inots;
162 	struct ntpdlist		restart_queue;
163 } tstate_t;
164 
165 #define	LUN_HASH_SIZE		32
166 #define	LUN_HASH_FUNC(lun)	((lun) & (LUN_HASH_SIZE - 1))
167 
168 #endif
169 
170 /*
171  * Per command info.
172  */
173 struct isp_pcmd {
174 	struct isp_pcmd *	next;
175 	bus_dmamap_t 		dmap;		/* dma map for this command */
176 	struct ispsoftc *	isp;		/* containing isp */
177 	struct callout		wdog;		/* watchdog timer */
178 	uint32_t		datalen;	/* data length for this command (target mode only) */
179 	uint8_t			totslen;	/* sense length on status response */
180 	uint8_t			cumslen;	/* sense length on status response */
181 	uint8_t 		crn;		/* command reference number */
182 };
183 #define	ISP_PCMD(ccb)		(ccb)->ccb_h.spriv_ptr1
184 #define	PISP_PCMD(ccb)		((struct isp_pcmd *)ISP_PCMD(ccb))
185 
186 /*
187  * Per nexus info.
188  */
189 struct isp_nexus {
190 	uint64_t lun;			/* LUN for target */
191 	uint32_t tgt;			/* TGT for target */
192 	uint8_t crnseed;		/* next command reference number */
193 	struct isp_nexus *next;
194 };
195 #define	NEXUS_HASH_WIDTH	32
196 #define	INITIAL_NEXUS_COUNT	MAX_FC_TARG
197 #define	NEXUS_HASH(tgt, lun)	((tgt + lun) % NEXUS_HASH_WIDTH)
198 
199 /*
200  * Per channel information
201  */
202 SLIST_HEAD(tslist, tstate);
203 TAILQ_HEAD(isp_ccbq, ccb_hdr);
204 LIST_HEAD(atpdlist, atio_private_data);
205 
206 struct isp_fc {
207 	struct cam_sim *sim;
208 	struct cam_path *path;
209 	struct ispsoftc *isp;
210 	struct proc *kproc;
211 	bus_dmamap_t scmap;
212 	uint64_t def_wwpn;
213 	uint64_t def_wwnn;
214 	time_t loop_down_time;
215 	int loop_down_limit;
216 	int gone_device_time;
217 	/*
218 	 * Per target/lun info- just to keep a per-ITL nexus crn count
219 	 */
220 	struct isp_nexus *nexus_hash[NEXUS_HASH_WIDTH];
221 	struct isp_nexus *nexus_free_list;
222 	uint32_t
223 		simqfrozen	: 3,
224 		default_id	: 8,
225 		def_role	: 2,	/* default role */
226 		loop_seen_once	: 1,
227 		fcbsy		: 1,
228 		ready		: 1;
229 	struct callout gdt;	/* gone device timer */
230 	struct task gtask;
231 #ifdef	ISP_TARGET_MODE
232 	struct tslist		lun_hash[LUN_HASH_SIZE];
233 	struct isp_ccbq		waitq;		/* waiting CCBs */
234 	struct ntpdlist		ntfree;
235 	inot_private_data_t	ntpool[ATPDPSIZE];
236 	struct atpdlist		atfree;
237 	struct atpdlist		atused[ATPDPHASHSIZE];
238 	atio_private_data_t	atpool[ATPDPSIZE];
239 #if defined(DEBUG)
240 	unsigned int inject_lost_data_frame;
241 #endif
242 #endif
243 	int			num_threads;
244 };
245 
246 struct isp_spi {
247 	struct cam_sim *sim;
248 	struct cam_path *path;
249 	uint32_t
250 		simqfrozen	: 3,
251 		iid		: 4;
252 #ifdef	ISP_TARGET_MODE
253 	struct tslist		lun_hash[LUN_HASH_SIZE];
254 	struct isp_ccbq		waitq;		/* waiting CCBs */
255 	struct ntpdlist		ntfree;
256 	inot_private_data_t	ntpool[ATPDPSIZE];
257 	struct atpdlist		atfree;
258 	struct atpdlist		atused[ATPDPHASHSIZE];
259 	atio_private_data_t	atpool[ATPDPSIZE];
260 #endif
261 	int			num_threads;
262 };
263 
264 struct isposinfo {
265 	/*
266 	 * Linkage, locking, and identity
267 	 */
268 	struct mtx		lock;
269 	device_t		dev;
270 	struct cdev *		cdev;
271 	struct cam_devq *	devq;
272 
273 	/*
274 	 * Firmware pointer
275 	 */
276 	const struct firmware *	fw;
277 
278 	/*
279 	 * DMA related stuff
280 	 */
281 	struct resource *	regs;
282 	struct resource *	regs2;
283 	bus_dma_tag_t		dmat;
284 	bus_dma_tag_t		reqdmat;
285 	bus_dma_tag_t		respdmat;
286 	bus_dma_tag_t		atiodmat;
287 	bus_dma_tag_t		iocbdmat;
288 	bus_dma_tag_t		scdmat;
289 	bus_dmamap_t		reqmap;
290 	bus_dmamap_t		respmap;
291 	bus_dmamap_t		atiomap;
292 	bus_dmamap_t		iocbmap;
293 
294 	/*
295 	 * Command and transaction related related stuff
296 	 */
297 	struct isp_pcmd *	pcmd_pool;
298 	struct isp_pcmd *	pcmd_free;
299 
300 	uint32_t
301 #ifdef	ISP_TARGET_MODE
302 		tmwanted	: 1,
303 		tmbusy		: 1,
304 #else
305 				: 2,
306 #endif
307 		sixtyfourbit	: 1,	/* sixtyfour bit platform */
308 		timer_active	: 1,
309 		autoconf	: 1;
310 	int			mbox_sleeping;
311 	int			mbox_sleep_ok;
312 	int			mboxbsy;
313 	int			mboxcmd_done;
314 
315 	struct callout		tmo;	/* general timer */
316 
317 	/*
318 	 * misc- needs to be sorted better XXXXXX
319 	 */
320 	int			framesize;
321 	int			exec_throttle;
322 	int			cont_max;
323 
324 	bus_addr_t		ecmd_dma;
325 	isp_ecmd_t *		ecmd_base;
326 	isp_ecmd_t *		ecmd_free;
327 
328 	/*
329 	 * Per-type private storage...
330 	 */
331 	union {
332 		struct isp_fc *fc;
333 		struct isp_spi *spi;
334 		void *ptr;
335 	} pc;
336 
337 	int			is_exiting;
338 };
339 #define	ISP_FC_PC(isp, chan)	(&(isp)->isp_osinfo.pc.fc[(chan)])
340 #define	ISP_SPI_PC(isp, chan)	(&(isp)->isp_osinfo.pc.spi[(chan)])
341 #define	ISP_GET_PC(isp, chan, tag, rslt)		\
342 	if (IS_SCSI(isp)) {				\
343 		rslt = ISP_SPI_PC(isp, chan)-> tag;	\
344 	} else {					\
345 		rslt = ISP_FC_PC(isp, chan)-> tag;	\
346 	}
347 #define	ISP_GET_PC_ADDR(isp, chan, tag, rp)		\
348 	if (IS_SCSI(isp)) {				\
349 		rp = &ISP_SPI_PC(isp, chan)-> tag;	\
350 	} else {					\
351 		rp = &ISP_FC_PC(isp, chan)-> tag;	\
352 	}
353 #define	ISP_SET_PC(isp, chan, tag, val)			\
354 	if (IS_SCSI(isp)) {				\
355 		ISP_SPI_PC(isp, chan)-> tag = val;	\
356 	} else {					\
357 		ISP_FC_PC(isp, chan)-> tag = val;	\
358 	}
359 
360 #define	FCP_NEXT_CRN	isp_fcp_next_crn
361 #define	isp_lock	isp_osinfo.lock
362 #define	isp_regs	isp_osinfo.regs
363 #define	isp_regs2	isp_osinfo.regs2
364 
365 /*
366  * Locking macros...
367  */
368 #define	ISP_LOCK(isp)	mtx_lock(&(isp)->isp_osinfo.lock)
369 #define	ISP_UNLOCK(isp)	mtx_unlock(&(isp)->isp_osinfo.lock)
370 #define	ISP_ASSERT_LOCKED(isp)	mtx_assert(&(isp)->isp_osinfo.lock, MA_OWNED)
371 
372 /*
373  * Required Macros/Defines
374  */
375 #define	ISP_FC_SCRLEN		0x1000
376 
377 #define	ISP_MEMZERO(a, b)	memset(a, 0, b)
378 #define	ISP_MEMCPY		memcpy
379 #define	ISP_SNPRINTF		snprintf
380 #define	ISP_DELAY(x)		DELAY(x)
381 #define	ISP_SLEEP(isp, x)	msleep_sbt(&(isp)->isp_osinfo.is_exiting, \
382     &(isp)->isp_osinfo.lock, 0, "isp_sleep", (x) * SBT_1US, 0, 0)
383 
384 #define	ISP_MIN			imin
385 
386 #ifndef	DIAGNOSTIC
387 #define	ISP_INLINE		__inline
388 #else
389 #define	ISP_INLINE
390 #endif
391 
392 #define	NANOTIME_T		struct timespec
393 #define	GET_NANOTIME		nanotime
394 #define	GET_NANOSEC(x)		((x)->tv_sec * 1000000000 + (x)->tv_nsec)
395 #define	NANOTIME_SUB		isp_nanotime_sub
396 
397 #define	MAXISPREQUEST(isp)	((IS_FC(isp) || IS_ULTRA2(isp))? 1024 : 256)
398 
399 #define	MEMORYBARRIER(isp, type, offset, size, chan)		\
400 switch (type) {							\
401 case SYNC_REQUEST:						\
402 	bus_dmamap_sync(isp->isp_osinfo.reqdmat,		\
403 	   isp->isp_osinfo.reqmap, BUS_DMASYNC_PREWRITE);	\
404 	break;							\
405 case SYNC_RESULT:						\
406 	bus_dmamap_sync(isp->isp_osinfo.respdmat, 		\
407 	   isp->isp_osinfo.respmap, BUS_DMASYNC_POSTREAD);	\
408 	break;							\
409 case SYNC_SFORDEV:						\
410 {								\
411 	struct isp_fc *fc = ISP_FC_PC(isp, chan);		\
412 	bus_dmamap_sync(isp->isp_osinfo.scdmat, fc->scmap,	\
413 	   BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);		\
414 	break;							\
415 }								\
416 case SYNC_SFORCPU:						\
417 {								\
418 	struct isp_fc *fc = ISP_FC_PC(isp, chan);		\
419 	bus_dmamap_sync(isp->isp_osinfo.scdmat, fc->scmap,	\
420 	   BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);	\
421 	break;							\
422 }								\
423 case SYNC_REG:							\
424 	bus_barrier(isp->isp_osinfo.regs, offset, size,		\
425 	    BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);	\
426 	break;							\
427 case SYNC_ATIOQ:						\
428 	bus_dmamap_sync(isp->isp_osinfo.atiodmat, 		\
429 	   isp->isp_osinfo.atiomap, BUS_DMASYNC_POSTREAD);	\
430 	break;							\
431 case SYNC_IFORDEV:						\
432 	bus_dmamap_sync(isp->isp_osinfo.iocbdmat, isp->isp_osinfo.iocbmap, \
433 	   BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);		\
434 	break;							\
435 case SYNC_IFORCPU:						\
436 	bus_dmamap_sync(isp->isp_osinfo.iocbdmat, isp->isp_osinfo.iocbmap, \
437 	   BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);	\
438 	break;							\
439 default:							\
440 	break;							\
441 }
442 
443 #define	MEMORYBARRIERW(isp, type, offset, size, chan)		\
444 switch (type) {							\
445 case SYNC_REQUEST:						\
446 	bus_dmamap_sync(isp->isp_osinfo.reqdmat,		\
447 	   isp->isp_osinfo.reqmap, BUS_DMASYNC_PREWRITE);	\
448 	break;							\
449 case SYNC_SFORDEV:						\
450 {								\
451 	struct isp_fc *fc = ISP_FC_PC(isp, chan);		\
452 	bus_dmamap_sync(isp->isp_osinfo.scdmat, fc->scmap,	\
453 	   BUS_DMASYNC_PREWRITE);				\
454 	break;							\
455 }								\
456 case SYNC_SFORCPU:						\
457 {								\
458 	struct isp_fc *fc = ISP_FC_PC(isp, chan);		\
459 	bus_dmamap_sync(isp->isp_osinfo.scdmat, fc->scmap,	\
460 	   BUS_DMASYNC_POSTWRITE);				\
461 	break;							\
462 }								\
463 case SYNC_REG:							\
464 	bus_barrier(isp->isp_osinfo.regs, offset, size,		\
465 	    BUS_SPACE_BARRIER_WRITE);				\
466 	break;							\
467 case SYNC_IFORDEV:						\
468 	bus_dmamap_sync(isp->isp_osinfo.iocbdmat, isp->isp_osinfo.iocbmap, \
469 	   BUS_DMASYNC_PREWRITE);				\
470 	break;							\
471 case SYNC_IFORCPU:						\
472 	bus_dmamap_sync(isp->isp_osinfo.iocbdmat, isp->isp_osinfo.iocbmap, \
473 	   BUS_DMASYNC_POSTWRITE);				\
474 	break;							\
475 default:							\
476 	break;							\
477 }
478 
479 #define	MBOX_ACQUIRE			isp_mbox_acquire
480 #define	MBOX_WAIT_COMPLETE		isp_mbox_wait_complete
481 #define	MBOX_NOTIFY_COMPLETE		isp_mbox_notify_done
482 #define	MBOX_RELEASE			isp_mbox_release
483 
484 #define	FC_SCRATCH_ACQUIRE		isp_fc_scratch_acquire
485 #define	FC_SCRATCH_RELEASE(isp, chan)	isp->isp_osinfo.pc.fc[chan].fcbsy = 0
486 
487 #ifndef	SCSI_GOOD
488 #define	SCSI_GOOD	SCSI_STATUS_OK
489 #endif
490 #ifndef	SCSI_CHECK
491 #define	SCSI_CHECK	SCSI_STATUS_CHECK_COND
492 #endif
493 #ifndef	SCSI_BUSY
494 #define	SCSI_BUSY	SCSI_STATUS_BUSY
495 #endif
496 #ifndef	SCSI_QFULL
497 #define	SCSI_QFULL	SCSI_STATUS_QUEUE_FULL
498 #endif
499 
500 #define	XS_T			struct ccb_scsiio
501 #define	XS_DMA_ADDR_T		bus_addr_t
502 #define XS_GET_DMA64_SEG(a, b, c)		\
503 {						\
504 	ispds64_t *d = a;			\
505 	bus_dma_segment_t *e = b;		\
506 	uint32_t f = c;				\
507 	e += f;					\
508         d->ds_base = DMA_LO32(e->ds_addr);	\
509         d->ds_basehi = DMA_HI32(e->ds_addr);	\
510         d->ds_count = e->ds_len;		\
511 }
512 #define XS_GET_DMA_SEG(a, b, c)			\
513 {						\
514 	ispds_t *d = a;				\
515 	bus_dma_segment_t *e = b;		\
516 	uint32_t f = c;				\
517 	e += f;					\
518         d->ds_base = DMA_LO32(e->ds_addr);	\
519         d->ds_count = e->ds_len;		\
520 }
521 #define	XS_ISP(ccb)		cam_sim_softc(xpt_path_sim((ccb)->ccb_h.path))
522 #define	XS_CHANNEL(ccb)		cam_sim_bus(xpt_path_sim((ccb)->ccb_h.path))
523 #define	XS_TGT(ccb)		(ccb)->ccb_h.target_id
524 #define	XS_LUN(ccb)		(ccb)->ccb_h.target_lun
525 
526 #define	XS_CDBP(ccb)	\
527 	(((ccb)->ccb_h.flags & CAM_CDB_POINTER)? \
528 	 (ccb)->cdb_io.cdb_ptr : (ccb)->cdb_io.cdb_bytes)
529 
530 #define	XS_CDBLEN(ccb)		(ccb)->cdb_len
531 #define	XS_XFRLEN(ccb)		(ccb)->dxfer_len
532 #define	XS_TIME(ccb)		(ccb)->ccb_h.timeout
533 #define	XS_GET_RESID(ccb)	(ccb)->resid
534 #define	XS_SET_RESID(ccb, r)	(ccb)->resid = r
535 #define	XS_STSP(ccb)		(&(ccb)->scsi_status)
536 #define	XS_SNSP(ccb)		(&(ccb)->sense_data)
537 
538 #define	XS_TOT_SNSLEN(ccb)	ccb->sense_len
539 #define	XS_CUR_SNSLEN(ccb)	(ccb->sense_len - ccb->sense_resid)
540 
541 #define	XS_SNSKEY(ccb)		(scsi_get_sense_key(&(ccb)->sense_data, \
542 				 ccb->sense_len - ccb->sense_resid, 1))
543 
544 #define	XS_SNSASC(ccb)		(scsi_get_asc(&(ccb)->sense_data,	\
545 				 ccb->sense_len - ccb->sense_resid, 1))
546 
547 #define	XS_SNSASCQ(ccb)		(scsi_get_ascq(&(ccb)->sense_data,	\
548 				 ccb->sense_len - ccb->sense_resid, 1))
549 #define	XS_TAG_P(ccb)	\
550 	(((ccb)->ccb_h.flags & CAM_TAG_ACTION_VALID) && \
551 	 (ccb)->tag_action != CAM_TAG_ACTION_NONE)
552 
553 #define	XS_TAG_TYPE(ccb)	\
554 	((ccb->tag_action == MSG_SIMPLE_Q_TAG)? REQFLAG_STAG : \
555 	 ((ccb->tag_action == MSG_HEAD_OF_Q_TAG)? REQFLAG_HTAG : REQFLAG_OTAG))
556 
557 
558 #define	XS_SETERR(ccb, v)	(ccb)->ccb_h.status &= ~CAM_STATUS_MASK, \
559 				(ccb)->ccb_h.status |= v
560 
561 #	define	HBA_NOERROR		CAM_REQ_INPROG
562 #	define	HBA_BOTCH		CAM_UNREC_HBA_ERROR
563 #	define	HBA_CMDTIMEOUT		CAM_CMD_TIMEOUT
564 #	define	HBA_SELTIMEOUT		CAM_SEL_TIMEOUT
565 #	define	HBA_TGTBSY		CAM_SCSI_STATUS_ERROR
566 #	define	HBA_REQINVAL		CAM_REQ_INVALID
567 #	define	HBA_BUSRESET		CAM_SCSI_BUS_RESET
568 #	define	HBA_ABORTED		CAM_REQ_ABORTED
569 #	define	HBA_DATAOVR		CAM_DATA_RUN_ERR
570 #	define	HBA_ARQFAIL		CAM_AUTOSENSE_FAIL
571 
572 
573 #define	XS_ERR(ccb)		((ccb)->ccb_h.status & CAM_STATUS_MASK)
574 
575 #define	XS_NOERR(ccb)		(((ccb)->ccb_h.status & CAM_STATUS_MASK) == CAM_REQ_INPROG)
576 
577 #define	XS_INITERR(ccb)		XS_SETERR(ccb, CAM_REQ_INPROG), ccb->sense_resid = ccb->sense_len
578 
579 #define	XS_SAVE_SENSE(xs, sense_ptr, totslen, slen)	do {			\
580 		uint32_t tlen = slen;						\
581 		if (tlen > (xs)->sense_len)					\
582 			tlen = (xs)->sense_len;					\
583 		PISP_PCMD(xs)->totslen = imin((xs)->sense_len, totslen);	\
584 		PISP_PCMD(xs)->cumslen = tlen;					\
585 		memcpy(&(xs)->sense_data, sense_ptr, tlen);			\
586 		(xs)->sense_resid = (xs)->sense_len - tlen;			\
587 		(xs)->ccb_h.status |= CAM_AUTOSNS_VALID;			\
588 	} while (0)
589 
590 #define	XS_SENSE_APPEND(xs, xsnsp, xsnsl)	do {				\
591 		uint32_t off = PISP_PCMD(xs)->cumslen;				\
592 		uint8_t *ptr = &((uint8_t *)(&(xs)->sense_data))[off];		\
593 		uint32_t amt = imin(xsnsl, PISP_PCMD(xs)->totslen - off);	\
594 		if (amt) {							\
595 			memcpy(ptr, xsnsp, amt);				\
596 			(xs)->sense_resid -= amt;				\
597 			PISP_PCMD(xs)->cumslen += amt;				\
598 		}								\
599 	} while (0)
600 
601 #define	XS_SENSE_VALID(xs)	(((xs)->ccb_h.status & CAM_AUTOSNS_VALID) != 0)
602 
603 #define	DEFAULT_FRAMESIZE(isp)		isp->isp_osinfo.framesize
604 #define	DEFAULT_EXEC_THROTTLE(isp)	isp->isp_osinfo.exec_throttle
605 
606 #define	DEFAULT_ROLE(isp, chan)	\
607 	(IS_FC(isp)? ISP_FC_PC(isp, chan)->def_role : ISP_ROLE_INITIATOR)
608 
609 #define	DEFAULT_IID(isp, chan)		isp->isp_osinfo.pc.spi[chan].iid
610 
611 #define	DEFAULT_LOOPID(x, chan)		isp->isp_osinfo.pc.fc[chan].default_id
612 
613 #define DEFAULT_NODEWWN(isp, chan)  	isp_default_wwn(isp, chan, 0, 1)
614 #define DEFAULT_PORTWWN(isp, chan)  	isp_default_wwn(isp, chan, 0, 0)
615 #define ACTIVE_NODEWWN(isp, chan)   	isp_default_wwn(isp, chan, 1, 1)
616 #define ACTIVE_PORTWWN(isp, chan)   	isp_default_wwn(isp, chan, 1, 0)
617 
618 
619 #if	BYTE_ORDER == BIG_ENDIAN
620 #ifdef	ISP_SBUS_SUPPORTED
621 #define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
622 #define	ISP_IOXPUT_16(isp, s, d)				\
623 	*(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap16(s)
624 #define	ISP_IOXPUT_32(isp, s, d)				\
625 	*(d) = (isp->isp_bustype == ISP_BT_SBUS)? s : bswap32(s)
626 #define	ISP_IOXGET_8(isp, s, d)		d = (*((uint8_t *)s))
627 #define	ISP_IOXGET_16(isp, s, d)				\
628 	d = (isp->isp_bustype == ISP_BT_SBUS)?			\
629 	*((uint16_t *)s) : bswap16(*((uint16_t *)s))
630 #define	ISP_IOXGET_32(isp, s, d)				\
631 	d = (isp->isp_bustype == ISP_BT_SBUS)?			\
632 	*((uint32_t *)s) : bswap32(*((uint32_t *)s))
633 
634 #else	/* ISP_SBUS_SUPPORTED */
635 #define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
636 #define	ISP_IOXPUT_16(isp, s, d)	*(d) = bswap16(s)
637 #define	ISP_IOXPUT_32(isp, s, d)	*(d) = bswap32(s)
638 #define	ISP_IOXGET_8(isp, s, d)		d = (*((uint8_t *)s))
639 #define	ISP_IOXGET_16(isp, s, d)	d = bswap16(*((uint16_t *)s))
640 #define	ISP_IOXGET_32(isp, s, d)	d = bswap32(*((uint32_t *)s))
641 #endif
642 #define	ISP_SWIZZLE_NVRAM_WORD(isp, rp)	*rp = bswap16(*rp)
643 #define	ISP_SWIZZLE_NVRAM_LONG(isp, rp)	*rp = bswap32(*rp)
644 
645 #define	ISP_IOZGET_8(isp, s, d)		d = (*((uint8_t *)s))
646 #define	ISP_IOZGET_16(isp, s, d)	d = (*((uint16_t *)s))
647 #define	ISP_IOZGET_32(isp, s, d)	d = (*((uint32_t *)s))
648 #define	ISP_IOZPUT_8(isp, s, d)		*(d) = s
649 #define	ISP_IOZPUT_16(isp, s, d)	*(d) = s
650 #define	ISP_IOZPUT_32(isp, s, d)	*(d) = s
651 
652 
653 #else
654 #define	ISP_IOXPUT_8(isp, s, d)		*(d) = s
655 #define	ISP_IOXPUT_16(isp, s, d)	*(d) = s
656 #define	ISP_IOXPUT_32(isp, s, d)	*(d) = s
657 #define	ISP_IOXGET_8(isp, s, d)		d = *(s)
658 #define	ISP_IOXGET_16(isp, s, d)	d = *(s)
659 #define	ISP_IOXGET_32(isp, s, d)	d = *(s)
660 #define	ISP_SWIZZLE_NVRAM_WORD(isp, rp)
661 #define	ISP_SWIZZLE_NVRAM_LONG(isp, rp)
662 
663 #define	ISP_IOZPUT_8(isp, s, d)		*(d) = s
664 #define	ISP_IOZPUT_16(isp, s, d)	*(d) = bswap16(s)
665 #define	ISP_IOZPUT_32(isp, s, d)	*(d) = bswap32(s)
666 
667 #define	ISP_IOZGET_8(isp, s, d)		d = (*((uint8_t *)(s)))
668 #define	ISP_IOZGET_16(isp, s, d)	d = bswap16(*((uint16_t *)(s)))
669 #define	ISP_IOZGET_32(isp, s, d)	d = bswap32(*((uint32_t *)(s)))
670 
671 #endif
672 
673 #define	ISP_SWAP16(isp, s)	bswap16(s)
674 #define	ISP_SWAP32(isp, s)	bswap32(s)
675 
676 /*
677  * Includes of common header files
678  */
679 
680 #include <dev/isp/ispreg.h>
681 #include <dev/isp/ispvar.h>
682 #include <dev/isp/ispmbox.h>
683 
684 /*
685  * isp_osinfo definiitions && shorthand
686  */
687 #define	SIMQFRZ_RESOURCE	0x1
688 #define	SIMQFRZ_LOOPDOWN	0x2
689 #define	SIMQFRZ_TIMED		0x4
690 
691 #define	isp_dev		isp_osinfo.dev
692 
693 /*
694  * prototypes for isp_pci && isp_freebsd to share
695  */
696 extern int isp_attach(ispsoftc_t *);
697 extern int isp_detach(ispsoftc_t *);
698 extern uint64_t isp_default_wwn(ispsoftc_t *, int, int, int);
699 
700 /*
701  * driver global data
702  */
703 extern int isp_announced;
704 extern int isp_loop_down_limit;
705 extern int isp_gone_device_time;
706 extern int isp_quickboot_time;
707 
708 /*
709  * Platform private flags
710  */
711 
712 /*
713  * Platform Library Functions
714  */
715 void isp_prt(ispsoftc_t *, int level, const char *, ...) __printflike(3, 4);
716 void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...) __printflike(4, 5);
717 uint64_t isp_nanotime_sub(struct timespec *, struct timespec *);
718 int isp_mbox_acquire(ispsoftc_t *);
719 void isp_mbox_wait_complete(ispsoftc_t *, mbreg_t *);
720 void isp_mbox_notify_done(ispsoftc_t *);
721 void isp_mbox_release(ispsoftc_t *);
722 int isp_fc_scratch_acquire(ispsoftc_t *, int);
723 int isp_mstohz(int);
724 void isp_platform_intr(void *);
725 void isp_common_dmateardown(ispsoftc_t *, struct ccb_scsiio *, uint32_t);
726 void isp_fcp_reset_crn(ispsoftc_t *, int, uint32_t, int);
727 int isp_fcp_next_crn(ispsoftc_t *, uint8_t *, XS_T *);
728 
729 /*
730  * Platform Version specific defines
731  */
732 #define	BUS_DMA_ROOTARG(x)	bus_get_dma_tag(x)
733 #define	isp_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, z)	\
734 	bus_dma_tag_create(a, b, c, d, e, f, g, h, i, j, k, \
735 	busdma_lock_mutex, &isp->isp_osinfo.lock, z)
736 
737 #define	isp_setup_intr	bus_setup_intr
738 
739 #define	isp_sim_alloc(a, b, c, d, e, f, g, h)	\
740 	cam_sim_alloc(a, b, c, d, e, &(d)->isp_osinfo.lock, f, g, h)
741 
742 #define	ISP_PATH_PRT(i, l, p, ...)					\
743 	if ((l) == ISP_LOGALL || ((l)& (i)->isp_dblev) != 0) {		\
744                 xpt_print(p, __VA_ARGS__);				\
745         }
746 
747 /*
748  * Platform specific inline functions
749  */
750 
751 /*
752  * ISP General Library functions
753  */
754 
755 #include <dev/isp/isp_library.h>
756 
757 #endif	/* _ISP_FREEBSD_H */
758