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