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