1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 *  Copyright (c) 2009-2020 Alexander Motin <mav@FreeBSD.org>
5 *  Copyright (c) 1997-2009 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 *
12 *  1. Redistributions of source code must retain the above copyright
13 *     notice, this list of conditions and the following disclaimer.
14 *  2. Redistributions in binary form must reproduce the above copyright
15 *     notice, this list of conditions and the following disclaimer in the
16 *     documentation and/or other materials provided with the distribution.
17 *
18 *  THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 *  ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22 *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 *  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 *  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 *  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 *  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 *  SUCH DAMAGE.
29 *
30 */
31/*
32 * Soft Definitions for Qlogic ISP SCSI adapters.
33 */
34
35#ifndef	_ISPVAR_H
36#define	_ISPVAR_H
37
38#if defined(__NetBSD__) || defined(__OpenBSD__)
39#include <dev/ic/isp_stds.h>
40#include <dev/ic/ispmbox.h>
41#endif
42#ifdef	__FreeBSD__
43#include <dev/isp/isp_stds.h>
44#include <dev/isp/ispmbox.h>
45#endif
46#ifdef	__linux__
47#include "isp_stds.h"
48#include "ispmbox.h"
49#endif
50#ifdef	__svr4__
51#include "isp_stds.h"
52#include "ispmbox.h"
53#endif
54
55#define	ISP_CORE_VERSION_MAJOR	7
56#define	ISP_CORE_VERSION_MINOR	0
57
58/*
59 * Vector for bus specific code to provide specific services.
60 */
61typedef struct ispsoftc ispsoftc_t;
62struct ispmdvec {
63	void		(*dv_run_isr) (ispsoftc_t *);
64	uint32_t	(*dv_rd_reg) (ispsoftc_t *, int);
65	void		(*dv_wr_reg) (ispsoftc_t *, int, uint32_t);
66	int		(*dv_mbxdma) (ispsoftc_t *);
67	int		(*dv_send_cmd) (ispsoftc_t *, void *, void *, uint32_t);
68	int		(*dv_irqsetup) (ispsoftc_t *);
69	void		(*dv_dregs) (ispsoftc_t *, const char *);
70	const void *	dv_ispfw;	/* ptr to f/w of ispfw(4)*/
71};
72
73/*
74 * Overall parameters
75 */
76#define	MAX_TARGETS		16
77#ifndef	MAX_FC_TARG
78#define	MAX_FC_TARG		1024
79#endif
80#define	ISP_MAX_TARGETS(isp)	MAX_FC_TARG
81#define	ISP_MAX_IRQS		3
82
83/*
84 * Macros to access ISP registers through bus specific layers-
85 * mostly wrappers to vector through the mdvec structure.
86 */
87#define	ISP_RUN_ISR(isp)	\
88	(*(isp)->isp_mdvec->dv_run_isr)(isp)
89
90#define	ISP_READ(isp, reg)	\
91	(*(isp)->isp_mdvec->dv_rd_reg)((isp), (reg))
92
93#define	ISP_WRITE(isp, reg, val)	\
94	(*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), (val))
95
96#define	ISP_MBOXDMASETUP(isp)	\
97	(*(isp)->isp_mdvec->dv_mbxdma)((isp))
98
99#define	ISP_SEND_CMD(isp, qe, segp, nseg)	\
100	(*(isp)->isp_mdvec->dv_send_cmd)((isp), (qe), (segp), (nseg))
101
102#define	ISP_IRQSETUP(isp)	\
103	(((isp)->isp_mdvec->dv_irqsetup) ? (*(isp)->isp_mdvec->dv_irqsetup)(isp) : 0)
104#define	ISP_DUMPREGS(isp, m)	\
105	if ((isp)->isp_mdvec->dv_dregs) (*(isp)->isp_mdvec->dv_dregs)((isp),(m))
106
107#define	ISP_SETBITS(isp, reg, val)	\
108 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) | (val))
109
110#define	ISP_CLRBITS(isp, reg, val)	\
111 (*(isp)->isp_mdvec->dv_wr_reg)((isp), (reg), ISP_READ((isp), (reg)) & ~(val))
112
113/*
114 * The MEMORYBARRIER macro is defined per platform (to provide synchronization
115 * on Request and Response Queues, Scratch DMA areas, and Registers)
116 *
117 * Defined Memory Barrier Synchronization Types
118 */
119#define	SYNC_REQUEST	0	/* request queue synchronization */
120#define	SYNC_RESULT	1	/* result queue synchronization */
121#define	SYNC_SFORDEV	2	/* scratch, sync for ISP */
122#define	SYNC_SFORCPU	3	/* scratch, sync for CPU */
123#define	SYNC_REG	4	/* for registers */
124#define	SYNC_ATIOQ	5	/* atio result queue (24xx) */
125#define	SYNC_IFORDEV	6	/* synchrounous IOCB, sync for ISP */
126#define	SYNC_IFORCPU	7	/* synchrounous IOCB, sync for CPU */
127
128/*
129 * Request/Response Queue defines and macros.
130 */
131/* This is the size of a queue entry (request and response) */
132#define	QENTRY_LEN			64
133/*
134 * Hardware requires queue lengths of at least 8 elements.  Driver requires
135 * lengths to be a power of two, and request queue of at least 256 elements.
136 */
137#define	RQUEST_QUEUE_LEN(x)		8192
138#define	RESULT_QUEUE_LEN(x)		1024
139#define	ATIO_QUEUE_LEN(x)		1024
140#define	ISP_QUEUE_ENTRY(q, idx)		(((uint8_t *)q) + ((size_t)(idx) * QENTRY_LEN))
141#define	ISP_QUEUE_SIZE(n)		((size_t)(n) * QENTRY_LEN)
142#define	ISP_NXT_QENTRY(idx, qlen)	(((idx) + 1) & ((qlen)-1))
143#define	ISP_QFREE(in, out, qlen)	((out - in - 1) & ((qlen) - 1))
144#define	ISP_QAVAIL(isp)	\
145	ISP_QFREE(isp->isp_reqidx, isp->isp_reqodx, RQUEST_QUEUE_LEN(isp))
146
147#define	ISP_ADD_REQUEST(isp, nxti)						\
148	MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1);	\
149	ISP_WRITE(isp, BIU2400_REQINP, nxti);					\
150	isp->isp_reqidx = nxti
151
152#define	ISP_SYNC_REQUEST(isp)								\
153	MEMORYBARRIER(isp, SYNC_REQUEST, isp->isp_reqidx, QENTRY_LEN, -1);		\
154	isp->isp_reqidx = ISP_NXT_QENTRY(isp->isp_reqidx, RQUEST_QUEUE_LEN(isp));	\
155	ISP_WRITE(isp, BIU2400_REQINP, isp->isp_reqidx)
156
157/*
158 * Fibre Channel Specifics
159 */
160#define	NPH_RESERVED		0x7F0	/* begin of reserved N-port handles */
161#define	NPH_MGT_ID		0x7FA	/* Management Server Special ID */
162#define	NPH_SNS_ID		0x7FC	/* SNS Server Special ID */
163#define	NPH_FABRIC_CTLR		0x7FD	/* Fabric Controller (0xFFFFFD) */
164#define	NPH_FL_ID		0x7FE	/* F Port Special ID (0xFFFFFE) */
165#define	NPH_IP_BCST		0x7FF	/* IP Broadcast Special ID (0xFFFFFF) */
166#define	NPH_MAX_2K		0x800
167
168/*
169 * "Unassigned" handle to be used internally
170 */
171#define	NIL_HANDLE		0xffff
172
173/*
174 * Limit for devices on an arbitrated loop.
175 */
176#define	LOCAL_LOOP_LIM		126
177
178/*
179 * Limit for (2K login) N-port handle amounts
180 */
181#define	MAX_NPORT_HANDLE	2048
182
183/*
184 * Special Constants
185 */
186#define	INI_NONE    		((uint64_t) 0)
187#define	ISP_NOCHAN		0xff
188
189/*
190 * Special Port IDs
191 */
192#define	MANAGEMENT_PORT_ID	0xFFFFFA
193#define	SNS_PORT_ID		0xFFFFFC
194#define	FABRIC_PORT_ID		0xFFFFFE
195#define	PORT_ANY		0xFFFFFF
196#define	PORT_NONE		0
197#define	VALID_PORT(port)	(port != PORT_NONE && port != PORT_ANY)
198#define	DOMAIN_CONTROLLER_BASE	0xFFFC00
199#define	DOMAIN_CONTROLLER_END	0xFFFCFF
200
201/*
202 * Command Handles
203 *
204 * Most QLogic initiator or target have 32 bit handles associated with them.
205 * We want to have a quick way to index back and forth between a local SCSI
206 * command context and what the firmware is passing back to us. We also
207 * want to avoid working on stale information. This structure handles both
208 * at the expense of some local memory.
209 *
210 * The handle is architected thusly:
211 *
212 *	0 means "free handle"
213 *	bits  0..12 index commands
214 *	bits 13..15 bits index usage
215 *	bits 16..31 contain a rolling sequence
216 *
217 *
218 */
219typedef struct {
220	void *		cmd;	/* associated command context */
221	uint32_t	handle;	/* handle associated with this command */
222} isp_hdl_t;
223#define	ISP_HANDLE_FREE		0x00000000
224#define	ISP_HANDLE_CMD_MASK	0x00003fff
225#define	ISP_HANDLE_USAGE_MASK	0x0000c000
226#define	ISP_HANDLE_USAGE_SHIFT	14
227#define	ISP_H2HT(hdl)	((hdl & ISP_HANDLE_USAGE_MASK) >> ISP_HANDLE_USAGE_SHIFT)
228#	define	ISP_HANDLE_NONE		0
229#	define	ISP_HANDLE_INITIATOR	1
230#	define	ISP_HANDLE_TARGET	2
231#	define	ISP_HANDLE_CTRL		3
232#define	ISP_HANDLE_SEQ_MASK	0xffff0000
233#define	ISP_HANDLE_SEQ_SHIFT	16
234#define	ISP_H2SEQ(hdl)	((hdl & ISP_HANDLE_SEQ_MASK) >> ISP_HANDLE_SEQ_SHIFT)
235#define	ISP_HANDLE_MAX		(ISP_HANDLE_CMD_MASK + 1)
236#define	ISP_HANDLE_RESERVE	256
237#define	ISP_HANDLE_NUM(isp)	((isp)->isp_maxcmds + ISP_HANDLE_RESERVE)
238#define	ISP_VALID_HANDLE(isp, hdl)	\
239	((ISP_H2HT(hdl) == ISP_HANDLE_INITIATOR || \
240	  ISP_H2HT(hdl) == ISP_HANDLE_TARGET || \
241	  ISP_H2HT(hdl) == ISP_HANDLE_CTRL) && \
242	 ((hdl) & ISP_HANDLE_CMD_MASK) < ISP_HANDLE_NUM(isp) && \
243	 (hdl) == ((isp)->isp_xflist[(hdl) & ISP_HANDLE_CMD_MASK].handle))
244
245
246/*
247 * FC Port Database entry.
248 *
249 * It has a handle that the f/w uses to address commands to a device.
250 * This handle's value may be assigned by the firmware (e.g., for local loop
251 * devices) or by the driver (e.g., for fabric devices).
252 *
253 * It has a state. If the state if VALID, that means that we've logged into
254 * the device.
255 *
256 * Local loop devices the firmware automatically performs PLOGI on for us
257 * (which is why that handle is imposed upon us). Fabric devices we assign
258 * a handle to and perform the PLOGI on.
259 *
260 * When a PORT DATABASE CHANGED asynchronous event occurs, we mark all VALID
261 * entries as PROBATIONAL. This allows us, if policy says to, just keep track
262 * of devices whose handles change but are otherwise the same device (and
263 * thus keep 'target' constant).
264 *
265 * In any case, we search all possible local loop handles. For each one that
266 * has a port database entity returned, we search for any PROBATIONAL entry
267 * that matches it and update as appropriate. Otherwise, as a new entry, we
268 * find room for it in the Port Database. We *try* and use the handle as the
269 * index to put it into the Database, but that's just an optimization. We mark
270 * the entry VALID and make sure that the target index is updated and correct.
271 *
272 * When we get done searching the local loop, we then search similarly for
273 * a list of devices we've gotten from the fabric name controller (if we're
274 * on a fabric). VALID marking is also done similarly.
275 *
276 * When all of this is done, we can march through the database and clean up
277 * any entry that is still PROBATIONAL (these represent devices which have
278 * departed). Then we're done and can resume normal operations.
279 *
280 * Negative invariants that we try and test for are:
281 *
282 *  + There can never be two non-NIL entries with the same { Port, Node } WWN
283 *    duples.
284 *
285 *  + There can never be two non-NIL entries with the same handle.
286 */
287typedef struct {
288	/*
289	 * This is the handle that the firmware needs in order for us to
290	 * send commands to the device. For pre-24XX cards, this would be
291	 * the 'loopid'.
292	 */
293	uint16_t	handle;
294
295	/*
296	 * PRLI word 0 contains the Establish Image Pair bit, which is
297	 * important for knowing when to reset the CRN.
298	 *
299	 * PRLI word 3 parameters contains role as well as other things.
300	 *
301	 * The state is the current state of this entry.
302	 *
303	 * The is_target is the current state of target on this port.
304	 *
305	 * The is_initiator is the current state of initiator on this port.
306	 *
307	 * Portid is obvious, as are node && port WWNs. The new_role and
308	 * new_portid is for when we are pending a change.
309	 */
310	uint16_t	prli_word0;		/* PRLI parameters */
311	uint16_t	prli_word3;		/* PRLI parameters */
312	uint16_t	new_prli_word0;		/* Incoming new PRLI parameters */
313	uint16_t	new_prli_word3;		/* Incoming new PRLI parameters */
314	uint16_t			: 12,
315			probational	: 1,
316			state		: 3;
317	uint32_t			: 6,
318			is_target	: 1,
319			is_initiator	: 1,
320			portid		: 24;
321	uint32_t
322					: 8,
323			new_portid	: 24;
324	uint64_t	node_wwn;
325	uint64_t	port_wwn;
326	uint32_t	gone_timer;
327} fcportdb_t;
328
329#define	FC_PORTDB_STATE_NIL		0	/* Empty DB slot */
330#define	FC_PORTDB_STATE_DEAD		1	/* Was valid, but no more. */
331#define	FC_PORTDB_STATE_CHANGED		2	/* Was valid, but changed. */
332#define	FC_PORTDB_STATE_NEW		3	/* Logged in, not announced. */
333#define	FC_PORTDB_STATE_ZOMBIE		4	/* Invalid, but announced. */
334#define	FC_PORTDB_STATE_VALID		5	/* Valid */
335
336#define	FC_PORTDB_TGT(isp, bus, pdb)		(int)(lp - FCPARAM(isp, bus)->portdb)
337
338/*
339 * FC card specific information
340 *
341 * This structure is replicated across multiple channels for multi-id
342 * capapble chipsets, with some entities different on a per-channel basis.
343 */
344
345typedef struct {
346	int			isp_gbspeed;		/* Connection speed */
347	int			isp_linkstate;		/* Link state */
348	int			isp_fwstate;		/* ISP F/W state */
349	int			isp_loopstate;		/* Loop State */
350	int			isp_topo;		/* Connection Type */
351
352	uint32_t				: 4,
353				fctape_enabled	: 1,
354				sendmarker	: 1,
355				role		: 2,
356				isp_portid	: 24;	/* S_ID */
357
358	uint16_t		isp_fwoptions;
359	uint16_t		isp_xfwoptions;
360	uint16_t		isp_zfwoptions;
361	uint16_t		isp_loopid;		/* hard loop id */
362	uint16_t		isp_sns_hdl;		/* N-port handle for SNS */
363	uint16_t		isp_lasthdl;		/* only valid for channel 0 */
364	uint16_t		isp_fabric_params;
365	uint16_t		isp_login_hdl;		/* Logging in handle */
366	uint8_t			isp_retry_delay;
367	uint8_t			isp_retry_count;
368	int			isp_use_gft_id;		/* Use GFT_ID */
369	int			isp_use_gff_id;		/* Use GFF_ID */
370
371	uint32_t		flash_data_addr;
372	uint32_t		fw_flashrev[4]; /* Flash F/W revision */
373	uint32_t		fw_ispfwrev[4]; /* ispfw(4) F/W revision */
374	char			fw_version_flash[12];
375	char			fw_version_ispfw[12];
376	char			fw_version_run[12];
377	uint32_t		fw_ability_mask;
378	uint16_t		max_supported_speed;
379
380	/*
381	 * FLT
382	 */
383	uint16_t		flt_length;
384	uint32_t		flt_region_entries;
385	uint32_t		flt_region_flt;
386	uint32_t		flt_region_fdt;
387	uint32_t		flt_region_boot;
388	uint32_t		flt_region_boot_sec;
389	uint32_t		flt_region_fw;
390	uint32_t		flt_region_fw_sec;
391	uint32_t		flt_region_vpd_nvram;
392	uint32_t		flt_region_vpd_nvram_sec;
393	uint32_t		flt_region_vpd;
394	uint32_t		flt_region_vpd_sec;
395	uint32_t		flt_region_nvram;
396	uint32_t		flt_region_nvram_sec;
397	uint32_t		flt_region_npiv_conf;
398	uint32_t		flt_region_gold_fw;
399	uint32_t		flt_region_fcp_prio;
400	uint32_t		flt_region_bootload;
401	uint32_t		flt_region_img_status_pri;
402	uint32_t		flt_region_img_status_sec;
403	uint32_t		flt_region_aux_img_status_pri;
404	uint32_t		flt_region_aux_img_status_sec;
405
406	/*
407	 * Current active WWNN/WWPN
408	 */
409	uint64_t		isp_wwnn;
410	uint64_t		isp_wwpn;
411
412	/*
413	 * NVRAM WWNN/WWPN
414	 */
415	uint64_t		isp_wwnn_nvram;
416	uint64_t		isp_wwpn_nvram;
417
418	/*
419	 * Our Port Data Base
420	 */
421	fcportdb_t		portdb[MAX_FC_TARG];
422
423	/*
424	 * Scratch DMA mapped in area to fetch Port Database stuff, etc.
425	 */
426	void *			isp_scratch;
427	XS_DMA_ADDR_T		isp_scdma;
428
429	uint8_t			isp_scanscratch[ISP_FC_SCRLEN];
430} fcparam;
431
432/*
433 * Image status
434 */
435struct isp_image_status{
436	uint8_t		image_status_mask;
437	uint16_t	generation;
438	uint8_t		ver_major;
439	uint8_t		ver_minor;
440	uint8_t		bitmap;		/* 28xx only */
441	uint8_t		reserved[2];
442	uint32_t	checksum;
443	uint32_t	signature;
444} __packed;
445
446/* 28xx aux image status bitmap values */
447#define ISP28XX_AUX_IMG_BOARD_CONFIG		0x1
448#define ISP28XX_AUX_IMG_VPD_NVRAM		0x2
449#define ISP28XX_AUX_IMG_NPIV_CONFIG_0_1		0x4
450#define ISP28XX_AUX_IMG_NPIV_CONFIG_2_3		0x8
451#define ISP28XX_AUX_IMG_NVME_PARAMS		0x10
452
453/*
454 * Active regions
455 */
456struct active_regions {
457	uint8_t global;
458	struct {
459		uint8_t	board_config;
460		uint8_t	vpd_nvram;
461		uint8_t	npiv_config_0_1;
462		uint8_t	npiv_config_2_3;
463		uint8_t	nvme_params;
464	} aux;
465};
466
467#define	FW_CONFIG_WAIT		0
468#define	FW_WAIT_LINK		1
469#define	FW_WAIT_LOGIN		2
470#define	FW_READY		3
471#define	FW_LOSS_OF_SYNC		4
472#define	FW_ERROR		5
473#define	FW_REINIT		6
474#define	FW_NON_PART		7
475
476#define	LOOP_NIL		0
477#define	LOOP_HAVE_LINK		1
478#define	LOOP_HAVE_ADDR		2
479#define	LOOP_TESTING_LINK	3
480#define	LOOP_LTEST_DONE		4
481#define	LOOP_SCANNING_LOOP	5
482#define	LOOP_LSCAN_DONE		6
483#define	LOOP_SCANNING_FABRIC	7
484#define	LOOP_FSCAN_DONE		8
485#define	LOOP_SYNCING_PDB	9
486#define	LOOP_READY		10
487
488#define	TOPO_NL_PORT		0
489#define	TOPO_FL_PORT		1
490#define	TOPO_N_PORT		2
491#define	TOPO_F_PORT		3
492#define	TOPO_PTP_STUB		4
493
494#define TOPO_IS_FABRIC(x)	((x) == TOPO_FL_PORT || (x) == TOPO_F_PORT)
495
496#define FCP_AL_DA_ALL		0xFF
497#define FCP_AL_PA(fcp) ((uint8_t)(fcp->isp_portid))
498#define FCP_IS_DEST_ALPD(fcp, alpd) (FCP_AL_PA((fcp)) == FCP_AL_DA_ALL || FCP_AL_PA((fcp)) == alpd)
499
500/*
501 * Soft Structure per host adapter
502 */
503struct ispsoftc {
504	/*
505	 * Platform (OS) specific data
506	 */
507	struct isposinfo	isp_osinfo;
508
509	/*
510	 * Pointer to bus specific functions and data
511	 */
512	struct ispmdvec *	isp_mdvec;
513
514	/*
515	 * (Mostly) nonvolatile state. Board specific parameters
516	 * may contain some volatile state (e.g., current loop state).
517	 */
518
519	fcparam			*isp_param;	/* Per-channel storage. */
520	uint16_t		isp_fwattr;	/* firmware attributes */
521	uint16_t		isp_fwattr_h;	/* firmware attributes */
522	uint16_t		isp_fwattr_ext[2]; /* firmware attributes */
523	uint16_t		isp_fwrev[3];	/* Loaded F/W revision */
524	uint16_t		isp_maxcmds;	/* max possible I/O cmds */
525	uint16_t		isp_nchan;	/* number of channels */
526	uint16_t		isp_dblev;	/* debug log mask */
527	uint32_t		isp_did;	/* DID */
528	uint8_t			isp_type;	/* HBA Chip Type */
529	uint8_t			isp_revision;	/* HBA Chip H/W Revision */
530	uint8_t			isp_nirq;	/* number of IRQs */
531	uint8_t			isp_port;	/* physical port on a card */
532	uint32_t		isp_confopts;	/* config options */
533
534	/*
535	 * Volatile state
536	 */
537	volatile u_int		isp_mboxbsy;	/* mailbox command active */
538	volatile u_int		isp_state;
539	volatile uint32_t	isp_reqodx;	/* index of last ISP pickup */
540	volatile uint32_t	isp_reqidx;	/* index of next request */
541	volatile uint32_t	isp_resodx;	/* index of next result */
542	volatile uint32_t	isp_atioodx;	/* index of next ATIO */
543	volatile uint32_t	isp_obits;	/* mailbox command output */
544	volatile uint32_t	isp_serno;	/* rolling serial number */
545	volatile uint16_t	isp_mboxtmp[MAX_MAILBOX];
546	volatile uint16_t	isp_seqno;	/* running sequence number */
547	u_int			isp_rqovf;	/* request queue overflow */
548
549	/*
550	 * Active commands are stored here, indexed by handle functions.
551	 */
552	isp_hdl_t		*isp_xflist;
553	isp_hdl_t		*isp_xffree;
554
555	/*
556	 * DMA mapped in area for synchronous IOCB requests.
557	 */
558	void *			isp_iocb;
559	XS_DMA_ADDR_T		isp_iocb_dma;
560
561	/*
562	 * request/result queue pointers and DMA handles for them.
563	 */
564	void *			isp_rquest;
565	void *			isp_result;
566	XS_DMA_ADDR_T		isp_rquest_dma;
567	XS_DMA_ADDR_T		isp_result_dma;
568#ifdef	ISP_TARGET_MODE
569	/* for 24XX only */
570	void *			isp_atioq;
571	XS_DMA_ADDR_T		isp_atioq_dma;
572#endif
573};
574
575#define	FCPARAM(isp, chan)	(&(isp)->isp_param[(chan)])
576
577#define	ISP_SET_SENDMARKER(isp, chan, val)	\
578    FCPARAM(isp, chan)->sendmarker = val	\
579
580#define	ISP_TST_SENDMARKER(isp, chan)		\
581    (FCPARAM(isp, chan)->sendmarker != 0)
582
583/*
584 * ISP Driver Run States
585 */
586#define	ISP_NILSTATE	0
587#define	ISP_CRASHED	1
588#define	ISP_RESETSTATE	2
589#define	ISP_INITSTATE	3
590#define	ISP_RUNSTATE	4
591
592/*
593 * ISP Runtime Configuration Options
594 */
595#define	ISP_CFG_FULL_DUPLEX	0x01	/* Full Duplex (Fibre Channel only) */
596#define	ISP_CFG_PORT_PREF	0x0e	/* Mask for Port Prefs (all FC except 2100) */
597#define	ISP_CFG_PORT_DEF	0x00	/* prefer connection type from NVRAM */
598#define	ISP_CFG_LPORT_ONLY	0x02	/* insist on {N/F}L-Port connection */
599#define	ISP_CFG_NPORT_ONLY	0x04	/* insist on {N/F}-Port connection */
600#define	ISP_CFG_LPORT		0x06	/* prefer {N/F}L-Port connection */
601#define	ISP_CFG_NPORT		0x08	/* prefer {N/F}-Port connection */
602#define	ISP_CFG_1GB		0x10	/* force 1Gb connection (23XX only) */
603#define	ISP_CFG_2GB		0x20	/* force 2Gb connection (23XX only) */
604#define	ISP_CFG_NONVRAM		0x40	/* ignore NVRAM */
605#define	ISP_CFG_NORELOAD	0x80	/* don't download f/w */
606#define	ISP_CFG_NOFCTAPE	0x100	/* disable FC-Tape */
607#define	ISP_CFG_FCTAPE		0x200	/* enable FC-Tape */
608#define	ISP_CFG_OWNFSZ		0x400	/* override NVRAM frame size */
609#define	ISP_CFG_OWNLOOPID	0x800	/* override NVRAM loopid */
610#define	ISP_CFG_4GB		0x2000	/* force 4Gb connection (24XX only) */
611#define	ISP_CFG_8GB		0x4000	/* force 8Gb connection (25XX only) */
612#define	ISP_CFG_16GB		0x8000	/* force 16Gb connection (26XX only) */
613#define	ISP_CFG_32GB		0x10000	/* force 32Gb connection (27XX only) */
614#define	ISP_CFG_64GB		0x20000	/* force 64Gb connection (28XX only) */
615
616/*
617 * For each channel, the outer layers should know what role that channel
618 * will take: ISP_ROLE_NONE, ISP_ROLE_INITIATOR, ISP_ROLE_TARGET,
619 * ISP_ROLE_BOTH.
620 *
621 * If you set ISP_ROLE_NONE, the cards will be reset, new firmware loaded,
622 * NVRAM read, and defaults set, but any further initialization (e.g.
623 * INITIALIZE CONTROL BLOCK commands for 2X00 cards) won't be done.
624 *
625 * If INITIATOR MODE isn't set, attempts to run commands will be stopped
626 * at isp_start and completed with the equivalent of SELECTION TIMEOUT.
627 *
628 * If TARGET MODE is set, it doesn't mean that the rest of target mode support
629 * needs to be enabled, or will even work. What happens with the 2X00 cards
630 * here is that if you have enabled it with TARGET MODE as part of the ICB
631 * options, but you haven't given the f/w any ram resources for ATIOs or
632 * Immediate Notifies, the f/w just handles what it can and you never see
633 * anything. Basically, it sends a single byte of data (the first byte,
634 * which you can set as part of the INITIALIZE CONTROL BLOCK command) for
635 * INQUIRY, and sends back QUEUE FULL status for any other command.
636 *
637 */
638#define	ISP_ROLE_NONE		0x0
639#define	ISP_ROLE_TARGET		0x1
640#define	ISP_ROLE_INITIATOR	0x2
641#define	ISP_ROLE_BOTH		(ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
642#define	ISP_ROLE_EITHER		ISP_ROLE_BOTH
643#ifndef	ISP_DEFAULT_ROLES
644/*
645 * Counterintuitively, we prefer to default to role 'none'
646 * if we are enable target mode support. This gives us the
647 * maximum flexibility as to which port will do what.
648 */
649#ifdef	ISP_TARGET_MODE
650#define	ISP_DEFAULT_ROLES	ISP_ROLE_NONE
651#else
652#define	ISP_DEFAULT_ROLES	ISP_ROLE_INITIATOR
653#endif
654#endif
655
656
657/*
658 * Firmware related defines
659 */
660#define	ISP_CODE_ORG			0x1000	/* default f/w code start */
661#define	ISP_CODE_ORG_2300		0x0800	/* ..except for 2300s */
662#define	ISP_CODE_ORG_2400		0x100000 /* ..and 2400s */
663#define	ISP_FW_REV(maj, min, mic)	(((maj) << 16) | ((min) << 8) | (mic))
664#define	ISP_FW_MAJOR(code)		(((code) >> 16) & 0xff)
665#define	ISP_FW_MINOR(code)		(((code) >> 8) & 0xff)
666#define	ISP_FW_MICRO(code)		((code) & 0xff)
667#define	ISP_FW_REVX(xp)			(((xp)[0] << 16) | ((xp)[1] << 8) | (xp)[2])
668#define	ISP_FW_MAJORX(xp)		(xp[0])
669#define	ISP_FW_MINORX(xp)		(xp[1])
670#define	ISP_FW_MICROX(xp)		(xp[2])
671#define	ISP_FW_NEWER_THAN(i, major, minor, micro)		\
672	(ISP_FW_REVX(i) > ISP_FW_REV(major, minor, micro))
673#define	ISP_FW_OLDER_THAN(i, major, minor, micro)		\
674	(ISP_FW_REVX(i) < ISP_FW_REV(major, minor, micro))
675#define	ISP_FW_NEWER_THANX(i, j)		\
676	(ISP_FW_REVX(i) > ISP_FW_REVX(j))
677#define	ISP_FW_OLDER_THANX(i, j)		\
678	(ISP_FW_REVX(i) < ISP_FW_REVX(j))
679
680/*
681 * Chip Types
682 */
683#define	ISP_HA_FC_2400		0x04
684#define	ISP_HA_FC_2500		0x05
685#define	ISP_HA_FC_2600		0x06
686#define	ISP_HA_FC_2700		0x07
687#define	ISP_HA_FC_2800		0x08
688
689#define	IS_25XX(isp)	((isp)->isp_type >= ISP_HA_FC_2500)
690#define	IS_26XX(isp)	((isp)->isp_type >= ISP_HA_FC_2600)
691#define	IS_27XX(isp)	((isp)->isp_type >= ISP_HA_FC_2700)
692#define	IS_28XX(isp)	((isp)->isp_type >= ISP_HA_FC_2800)
693
694/*
695 * DMA related macros
696 */
697#define	DMA_WD3(x)	(((uint16_t)(((uint64_t)x) >> 48)) & 0xffff)
698#define	DMA_WD2(x)	(((uint16_t)(((uint64_t)x) >> 32)) & 0xffff)
699#define	DMA_WD1(x)	((uint16_t)((x) >> 16) & 0xffff)
700#define	DMA_WD0(x)	((uint16_t)((x) & 0xffff))
701
702#define	DMA_LO32(x)	((uint32_t) (x))
703#define	DMA_HI32(x)	((uint32_t)(((uint64_t)x) >> 32))
704
705/*
706 * function return status codes
707 */
708#define MBS_MASK		0x3fff
709
710#define ISP_SUCCESS		(MBOX_COMMAND_COMPLETE & MBS_MASK)
711#define ISP_INVALID_COMMAND	(MBOX_INVALID_COMMAND & MBS_MASK)
712#define ISP_INTERFACE_ERROR	(MBOX_HOST_INTERFACE_ERROR & MBS_MASK)
713#define ISP_TEST_FAILED		(MBOX_TEST_FAILED & MBS_MASK)
714#define ISP_COMMAND_ERROR	(MBOX_COMMAND_ERROR & MBS_MASK)
715#define ISP_PARAMETER_ERROR	(MBOX_COMMAND_PARAMETER_ERROR & MBS_MASK)
716#define ISP_PORT_ID_USED	(MBOX_PORT_ID_USED & MBS_MASK)
717#define ISP_LOOP_ID_USED	(MBOX_LOOP_ID_USED & MBS_MASK)
718#define ISP_ALL_IDS_IN_USE	(MBOX_ALL_IDS_IN_USE & MBS_MASK)
719#define ISP_NOT_LOGGED_IN	(MBOX_NOT_LOGGED_IN & MBS_MASK)
720
721#define ISP_FUNCTION_TIMEOUT		0x100
722#define ISP_FUNCTION_PARAMETER_ERROR	0x101
723#define ISP_FUNCTION_FAILED		0x102
724#define ISP_MEMORY_ALLOC_FAILED		0x103
725#define ISP_LOCK_TIMEOUT		0x104
726#define ISP_ABORTED			0x105
727#define ISP_SUSPENDED			0x106
728#define ISP_BUSY			0x107
729#define ISP_ALREADY_REGISTERED		0x109
730#define ISP_OS_TIMER_EXPIRED		0x10a
731#define ISP_ERR_NO_QPAIR		0x10b
732#define ISP_ERR_NOT_FOUND		0x10c
733#define ISP_ERR_FROM_FW			0x10d
734
735/*
736 * Core System Function Prototypes
737 */
738
739/*
740 * Reset Hardware. Totally. Assumes that you'll follow this with a call to isp_init.
741 */
742void isp_reset(ispsoftc_t *, int);
743
744/*
745 * Initialize Hardware to known state
746 */
747void isp_init(ispsoftc_t *);
748
749/*
750 * Reset the ISP and call completion for any orphaned commands.
751 */
752int isp_reinit(ispsoftc_t *, int);
753
754/*
755 * Shutdown hardware after use.
756 */
757void isp_shutdown(ispsoftc_t *);
758
759/*
760 * Internal Interrupt Service Routine
761 */
762#ifdef	ISP_TARGET_MODE
763void isp_intr_atioq(ispsoftc_t *);
764#endif
765void isp_intr_async(ispsoftc_t *, uint16_t event);
766void isp_intr_mbox(ispsoftc_t *, uint16_t mbox0);
767void isp_intr_respq(ispsoftc_t *);
768
769
770/*
771 * Command Entry Point- Platform Dependent layers call into this
772 */
773int isp_start(XS_T *);
774
775/* these values are what isp_start returns */
776#define	CMD_COMPLETE	101	/* command completed */
777#define	CMD_EAGAIN	102	/* busy- maybe retry later */
778#define	CMD_RQLATER	103	/* requeue this command later */
779
780/*
781 * Command Completion Point- Core layers call out from this with completed cmds
782 */
783void isp_done(XS_T *);
784
785/*
786 * Platform Dependent to External to Internal Control Function
787 *
788 * Assumes locks are held on entry. You should note that with many of
789 * these commands locks may be released while this function is called.
790 *
791 * ... ISPCTL_RESET_BUS, int channel);
792 *        Reset BUS on this channel
793 * ... ISPCTL_RESET_DEV, int channel, int target);
794 *        Reset Device on this channel at this target.
795 * ... ISPCTL_ABORT_CMD, XS_T *xs);
796 *        Abort active transaction described by xs.
797 * ... IPCTL_UPDATE_PARAMS);
798 *        Update any operating parameters (speed, etc.)
799 * ... ISPCTL_FCLINK_TEST, int channel);
800 *        Test FC link status on this channel
801 * ... ISPCTL_SCAN_LOOP, int channel);
802 *        Scan local loop on this channel
803 * ... ISPCTL_SCAN_FABRIC, int channel);
804 *        Scan fabric on this channel
805 * ... ISPCTL_PDB_SYNC, int channel);
806 *        Synchronize port database on this channel
807 * ... ISPCTL_SEND_LIP, int channel);
808 *        Send a LIP on this channel
809 * ... ISPCTL_GET_NAMES, int channel, int np, uint64_t *wwnn, uint64_t *wwpn)
810 *        Get a WWNN/WWPN for this N-port handle on this channel
811 * ... ISPCTL_RUN_MBOXCMD, mbreg_t *mbp)
812 *        Run this mailbox command
813 * ... ISPCTL_GET_PDB, int channel, int nphandle, isp_pdb_t *pdb)
814 *        Get PDB on this channel for this N-port handle
815 * ... ISPCTL_PLOGX, isp_plcmd_t *)
816 *        Performa a port login/logout
817 * ... ISPCTL_CHANGE_ROLE, int channel, int role);
818 *        Change role of specified channel
819 *
820 * ISPCTL_PDB_SYNC is somewhat misnamed. It actually is the final step, in
821 * order, of ISPCTL_FCLINK_TEST, ISPCTL_SCAN_LOOP, and ISPCTL_SCAN_FABRIC.
822 * The main purpose of ISPCTL_PDB_SYNC is to complete management of logging
823 * and logging out of fabric devices (if one is on a fabric) and then marking
824 * the 'loop state' as being ready to now be used for sending commands to
825 * devices.
826 */
827typedef enum {
828	ISPCTL_RESET_BUS,
829	ISPCTL_RESET_DEV,
830	ISPCTL_ABORT_CMD,
831	ISPCTL_UPDATE_PARAMS,
832	ISPCTL_FCLINK_TEST,
833	ISPCTL_SCAN_FABRIC,
834	ISPCTL_SCAN_LOOP,
835	ISPCTL_PDB_SYNC,
836	ISPCTL_SEND_LIP,
837	ISPCTL_GET_NAMES,
838	ISPCTL_RUN_MBOXCMD,
839	ISPCTL_GET_PDB,
840	ISPCTL_PLOGX,
841	ISPCTL_CHANGE_ROLE
842} ispctl_t;
843int isp_control(ispsoftc_t *, ispctl_t, ...);
844
845/*
846 * Platform Dependent to Internal to External Control Function
847 */
848
849typedef enum {
850	ISPASYNC_LOOP_DOWN,		/* FC Loop Down */
851	ISPASYNC_LOOP_UP,		/* FC Loop Up */
852	ISPASYNC_LIP,			/* FC LIP Received */
853	ISPASYNC_LOOP_RESET,		/* FC Loop Reset Received */
854	ISPASYNC_CHANGE_NOTIFY,		/* FC Change Notification */
855	ISPASYNC_DEV_ARRIVED,		/* FC Device Arrived */
856	ISPASYNC_DEV_CHANGED,		/* FC Device Changed */
857	ISPASYNC_DEV_STAYED,		/* FC Device Stayed */
858	ISPASYNC_DEV_GONE,		/* FC Device Departure */
859	ISPASYNC_TARGET_NOTIFY,		/* All target async notification */
860	ISPASYNC_TARGET_NOTIFY_ACK,	/* All target notify ack required */
861	ISPASYNC_TARGET_ACTION,		/* All target action requested */
862	ISPASYNC_FW_CRASH,		/* All Firmware has crashed */
863	ISPASYNC_FW_RESTARTED		/* All Firmware has been restarted */
864} ispasync_t;
865void isp_async(ispsoftc_t *, ispasync_t, ...);
866
867#define	ISPASYNC_CHANGE_PDB	0
868#define	ISPASYNC_CHANGE_SNS	1
869#define	ISPASYNC_CHANGE_OTHER	2
870
871/*
872 * Platform Dependent Error and Debug Printout
873 *
874 * Two required functions for each platform must be provided:
875 *
876 *    void isp_prt(ispsoftc_t *, int level, const char *, ...)
877 *    void isp_xs_prt(ispsoftc_t *, XS_T *, int level, const char *, ...)
878 *
879 * but due to compiler differences on different platforms this won't be
880 * formally defined here. Instead, they go in each platform definition file.
881 */
882
883#define	ISP_LOGALL	0x0	/* log always */
884#define	ISP_LOGCONFIG	0x1	/* log configuration messages */
885#define	ISP_LOGINFO	0x2	/* log informational messages */
886#define	ISP_LOGWARN	0x4	/* log warning messages */
887#define	ISP_LOGERR	0x8	/* log error messages */
888#define	ISP_LOGDEBUG0	0x10	/* log simple debug messages */
889#define	ISP_LOGDEBUG1	0x20	/* log intermediate debug messages */
890#define	ISP_LOGDEBUG2	0x40	/* log most debug messages */
891#define	ISP_LOGDEBUG3	0x80	/* log high frequency debug messages */
892#define	ISP_LOG_SANCFG	0x100	/* log SAN configuration */
893#define	ISP_LOG_CWARN	0x200	/* log SCSI command "warnings" (e.g., check conditions) */
894#define	ISP_LOG_WARN1	0x400	/* log WARNS we might be interested at some time */
895#define	ISP_LOGTINFO	0x1000	/* log informational messages (target mode) */
896#define	ISP_LOGTDEBUG0	0x2000	/* log simple debug messages (target mode) */
897#define	ISP_LOGTDEBUG1	0x4000	/* log intermediate debug messages (target) */
898#define	ISP_LOGTDEBUG2	0x8000	/* log all debug messages (target) */
899
900/*
901 * Each Platform provides it's own isposinfo substructure of the ispsoftc
902 * defined above.
903 *
904 * Each platform must also provide the following macros/defines:
905 *
906 *
907 *	ISP_FC_SCRLEN				FC scratch area DMA length
908 *
909 *	ISP_MEMZERO(dst, src)			platform zeroing function
910 *	ISP_MEMCPY(dst, src, count)		platform copying function
911 *	ISP_SNPRINTF(buf, bufsize, fmt, ...)	snprintf
912 *	ISP_DELAY(usecs)			microsecond spindelay function
913 *	ISP_SLEEP(isp, usecs)			microsecond sleep function
914 *
915 *	ISP_INLINE				___inline or not- depending on how
916 *						good your debugger is
917 *	ISP_MIN					shorthand for ((a) < (b))? (a) : (b)
918 *
919 *	NANOTIME_T				nanosecond time type
920 *
921 *	GET_NANOTIME(NANOTIME_T *)		get current nanotime.
922 *
923 *	GET_NANOSEC(NANOTIME_T *)		get uint64_t from NANOTIME_T
924 *
925 *	NANOTIME_SUB(NANOTIME_T *, NANOTIME_T *)
926 *						subtract two NANOTIME_T values
927 *
928 *	MAXISPREQUEST(ispsoftc_t *)		maximum request queue size
929 *						for this particular board type
930 *
931 *	MEMORYBARRIER(ispsoftc_t *, barrier_type, offset, size, chan)
932 *
933 *		Function/Macro the provides memory synchronization on
934 *		various objects so that the ISP's and the system's view
935 *		of the same object is consistent.
936 *
937 *	FC_SCRATCH_ACQUIRE(ispsoftc_t *, chan)	acquire lock on FC scratch area
938 *						return -1 if you cannot
939 *	FC_SCRATCH_RELEASE(ispsoftc_t *, chan)	acquire lock on FC scratch area
940 *
941 *	FCP_NEXT_CRN(ispsoftc_t *, XS_T *, rslt, channel, target, lun)	generate the next command reference number. XS_T * may be null.
942 *
943 *	SCSI_GOOD	SCSI 'Good' Status
944 *	SCSI_CHECK	SCSI 'Check Condition' Status
945 *	SCSI_BUSY	SCSI 'Busy' Status
946 *	SCSI_QFULL	SCSI 'Queue Full' Status
947 *
948 *	XS_T			Platform SCSI transaction type (i.e., command for HBA)
949 *	XS_DMA_ADDR_T		Platform PCI DMA Address Type
950 *	XS_GET_DMA64_SEG(..)	Get 64 bit dma segment list value
951 *	XS_ISP(xs)		gets an instance out of an XS_T
952 *	XS_CHANNEL(xs)		gets the channel (bus # for DUALBUS cards) ""
953 *	XS_TGT(xs)		gets the target ""
954 *	XS_LUN(xs)		gets the lun ""
955 *	XS_CDBP(xs)		gets a pointer to the scsi CDB ""
956 *	XS_CDBLEN(xs)		gets the CDB's length ""
957 *	XS_XFRLEN(xs)		gets the associated data transfer length ""
958 *	XS_XFRIN(xs)		gets IN direction
959 *	XS_XFROUT(xs)		gets OUT direction
960 *	XS_TIME(xs)		gets the time (in seconds) for this command
961 *	XS_GET_RESID(xs)	gets the current residual count
962 *	XS_GET_RESID(xs, resid)	sets the current residual count
963 *	XS_STSP(xs)		gets a pointer to the SCSI status byte ""
964 *	XS_SNSP(xs)		gets a pointer to the associate sense data
965 *	XS_TOT_SNSLEN(xs)	gets the total length of sense data storage
966 *	XS_CUR_SNSLEN(xs)	gets the currently used length of sense data storage
967 *	XS_SNSKEY(xs)		dereferences XS_SNSP to get the current stored Sense Key
968 *	XS_SNSASC(xs)		dereferences XS_SNSP to get the current stored Additional Sense Code
969 *	XS_SNSASCQ(xs)		dereferences XS_SNSP to get the current stored Additional Sense Code Qualifier
970 *	XS_TAG_P(xs)		predicate of whether this command should be tagged
971 *	XS_TAG_TYPE(xs)		which type of tag to use
972 *	XS_PRIORITY(xs)		command priority for SIMPLE tag
973 *	XS_SETERR(xs)		set error state
974 *
975 *		HBA_NOERROR	command has no erros
976 *		HBA_BOTCH	hba botched something
977 *		HBA_CMDTIMEOUT	command timed out
978 *		HBA_SELTIMEOUT	selection timed out (also port logouts for FC)
979 *		HBA_TGTBSY	target returned a BUSY status
980 *		HBA_BUSRESET	bus reset destroyed command
981 *		HBA_ABORTED	command was aborted (by request)
982 *		HBA_DATAOVR	a data overrun was detected
983 *		HBA_ARQFAIL	Automatic Request Sense failed
984 *
985 *	XS_ERR(xs)	return current error state
986 *	XS_NOERR(xs)	there is no error currently set
987 *	XS_INITERR(xs)	initialize error state
988 *
989 *	XS_SAVE_SENSE(xs, sp, len)	save sense data
990 *	XS_APPEND_SENSE(xs, sp, len)	append more sense data
991 *
992 *	XS_SENSE_VALID(xs)		indicates whether sense is valid
993 *
994 *	DEFAULT_FRAMESIZE(ispsoftc_t *)		Default Frame Size
995 *
996 *	DEFAULT_ROLE(ispsoftc_t *, int)		Get Default Role for a channel
997 *	DEFAULT_LOOPID(ispsoftc_t *, int)	Default FC Loop ID
998 *
999 *		These establish reasonable defaults for each platform.
1000 * 		These must be available independent of card NVRAM and are
1001 *		to be used should NVRAM not be readable.
1002 *
1003 *	DEFAULT_NODEWWN(ispsoftc_t *, chan)	Default FC Node WWN to use
1004 *	DEFAULT_PORTWWN(ispsoftc_t *, chan)	Default FC Port WWN to use
1005 *
1006 *		These defines are hooks to allow the setting of node and
1007 *		port WWNs when NVRAM cannot be read or is to be overridden.
1008 *
1009 *	ACTIVE_NODEWWN(ispsoftc_t *, chan)	FC Node WWN to use
1010 *	ACTIVE_PORTWWN(ispsoftc_t *, chan)	FC Port WWN to use
1011 *
1012 *		After NVRAM is read, these will be invoked to get the
1013 *		node and port WWNs that will actually be used for this
1014 *		channel.
1015 *
1016 *
1017 *	ISP_IOXPUT_8(ispsoftc_t *, uint8_t srcval, uint8_t *dstptr)
1018 *	ISP_IOXPUT_16(ispsoftc_t *, uint16_t srcval, uint16_t *dstptr)
1019 *	ISP_IOXPUT_32(ispsoftc_t *, uint32_t srcval, uint32_t *dstptr)
1020 *
1021 *	ISP_IOXGET_8(ispsoftc_t *, uint8_t *srcptr, uint8_t dstrval)
1022 *	ISP_IOXGET_16(ispsoftc_t *, uint16_t *srcptr, uint16_t dstrval)
1023 *	ISP_IOXGET_32(ispsoftc_t *, uint32_t *srcptr, uint32_t dstrval)
1024 *
1025 *	ISP_SWIZZLE_NVRAM_WORD(ispsoftc_t *, uint16_t *)
1026 *	ISP_SWIZZLE_NVRAM_LONG(ispsoftc_t *, uint32_t *)
1027 *	ISP_SWAP16(ispsoftc_t *, uint16_t srcval)
1028 *	ISP_SWAP32(ispsoftc_t *, uint32_t srcval)
1029 */
1030
1031#ifdef	ISP_TARGET_MODE
1032/*
1033 * The functions below are for the publicly available
1034 * target mode functions that are internal to the Qlogic driver.
1035 */
1036
1037/*
1038 * This function handles new response queue entry appropriate for target mode.
1039 */
1040int isp_target_notify(ispsoftc_t *, void *, uint32_t *, uint16_t);
1041
1042/*
1043 * This function externalizes the ability to acknowledge an Immediate Notify request.
1044 */
1045int isp_notify_ack(ispsoftc_t *, void *);
1046
1047/*
1048 * This function externalized acknowledging (success/fail) an ABTS frame
1049 */
1050int isp_acknak_abts(ispsoftc_t *, void *, int);
1051
1052/*
1053 * General routine to send a final CTIO for a command- used mostly for
1054 * local responses.
1055 */
1056int isp_endcmd(ispsoftc_t *, ...);
1057#define	ECMD_SVALID	0x100
1058#define	ECMD_RVALID	0x200
1059#define	ECMD_TERMINATE	0x400
1060
1061/*
1062 * Handle an asynchronous event
1063 */
1064void isp_target_async(ispsoftc_t *, int, int);
1065#endif
1066#endif	/* _ISPVAR_H */
1067