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