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