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