xref: /freebsd/sys/dev/isp/isp_ioctl.h (revision 87569f75a91f298c52a71823c04d41cf53c88889)
1 /* $FreeBSD$ */
2 /*-
3  *
4  * Copyright (c) 1997-2006 by Matthew Jacob
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice immediately at the beginning of the file, without modification,
12  *    this list of conditions, and the following disclaimer.
13  * 2. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 /*
29  * ioctl definitions for Qlogic FC/SCSI HBA driver
30  */
31 #define	ISP_IOC		(021)	/* 'Ctrl-Q' */
32 
33 /*
34  * This ioctl sets/retrieves the debugging level for this hba instance.
35  * Note that this is not a simple integer level- see ispvar.h for definitions.
36  *
37  * The arguments is a pointer to an integer with the new debugging level.
38  * The old value is written into this argument.
39  */
40 
41 #define	ISP_SDBLEV	_IOWR(ISP_IOC, 1, int)
42 
43 /*
44  * This ioctl resets the HBA. Use with caution.
45  */
46 #define	ISP_RESETHBA	_IO(ISP_IOC, 2)
47 
48 /*
49  * This ioctl performs a fibre chanel rescan.
50  */
51 #define	ISP_RESCAN	_IO(ISP_IOC, 3)
52 
53 /*
54  * This ioctl performs a reset and then will set the adapter to the
55  * role that was passed in (the old role will be returned). It almost
56  * goes w/o saying: use with caution.
57  */
58 #define ISP_SETROLE     _IOWR(ISP_IOC, 4, int)
59 
60 #define ISP_ROLE_NONE           0x0
61 #define ISP_ROLE_TARGET         0x1
62 #define ISP_ROLE_INITIATOR      0x2
63 #define ISP_ROLE_BOTH           (ISP_ROLE_TARGET|ISP_ROLE_INITIATOR)
64 #ifndef ISP_DEFAULT_ROLES
65 #define ISP_DEFAULT_ROLES       ISP_ROLE_BOTH
66 #endif
67 
68 /*
69  * Get the current adapter role
70  */
71 #define ISP_GETROLE     _IOR(ISP_IOC, 5, int)
72 
73 /*
74  * Get/Clear Stats
75  */
76 #define	ISP_STATS_VERSION	0
77 typedef struct {
78 	uint8_t		isp_stat_version;
79 	uint8_t		isp_type;		/* (ro) reflects chip type */
80 	uint8_t		isp_revision;		/* (ro) reflects chip version */
81 	uint8_t		unused1;
82 	uint32_t	unused2;
83 	/*
84 	 * Statistics Counters
85 	 */
86 #define	ISP_NSTATS	16
87 #define	ISP_INTCNT	0
88 #define	ISP_INTBOGUS	1
89 #define	ISP_INTMBOXC	2
90 #define	ISP_INGOASYNC	3
91 #define	ISP_RSLTCCMPLT	4
92 #define	ISP_FPHCCMCPLT	5
93 #define	ISP_RSCCHIWAT	6
94 #define	ISP_FPCCHIWAT	7
95 	uint64_t	isp_stats[ISP_NSTATS];
96 } isp_stats_t;
97 
98 #define	ISP_GET_STATS	_IOR(ISP_IOC, 6, isp_stats_t)
99 #define	ISP_CLR_STATS	_IO(ISP_IOC, 7)
100 
101 /*
102  * Initiate a LIP
103  */
104 #define	ISP_FC_LIP	_IO(ISP_IOC, 8)
105 
106 /*
107  * Return the Port Database structure for the named device, or ENODEV if none.
108  * Caller fills in virtual loopid (0..255), aka 'target'. The driver returns
109  * ENODEV (if nothing valid there) or the actual loopid (for local loop devices
110  * only), 24 bit Port ID and Node and Port WWNs.
111  */
112 struct isp_fc_device {
113 	uint32_t	loopid;		/* 0..255 */
114 	uint32_t		: 6,
115 			role 	: 2,
116 			portid	: 24;	/* 24 bit Port ID */
117 	uint64_t	node_wwn;
118 	uint64_t	port_wwn;
119 };
120 #define	ISP_FC_GETDINFO	_IOWR(ISP_IOC, 9, struct isp_fc_device)
121 
122 /*
123  * Get F/W crash dump
124  */
125 #define	ISP_GET_FW_CRASH_DUMP	_IO(ISP_IOC, 10)
126 #define	ISP_FORCE_CRASH_DUMP	_IO(ISP_IOC, 11)
127 
128 /*
129  * Get information about this Host Adapter, including current connection
130  * topology and capabilities.
131  */
132 struct isp_hba_device {
133 	uint32_t
134 					: 8,
135 					: 4,
136 		fc_speed		: 4,	/* Gbps */
137 					: 2,
138 		fc_class2		: 1,
139 		fc_ip_supported		: 1,
140 		fc_scsi_supported	: 1,
141 		fc_topology		: 3,
142 		fc_loopid		: 8;
143 	uint8_t		fc_fw_major;
144 	uint8_t		fc_fw_minor;
145 	uint8_t		fc_fw_micro;
146 	uint8_t		reserved;
147 	uint64_t	nvram_node_wwn;
148 	uint64_t	nvram_port_wwn;
149 	uint64_t	active_node_wwn;
150 	uint64_t	active_port_wwn;
151 };
152 
153 #define	ISP_TOPO_UNKNOWN	0	/* connection topology unknown */
154 #define	ISP_TOPO_FCAL		1	/* private or PL_DA */
155 #define	ISP_TOPO_LPORT		2	/* public loop */
156 #define	ISP_TOPO_NPORT		3	/* N-port */
157 #define	ISP_TOPO_FPORT		4	/* F-port */
158 
159 #define	ISP_FC_GETHINFO	_IOR(ISP_IOC, 12, struct isp_hba_device)
160 /*
161  * Set some internal parameters. This doesn't take effect until
162  * the chip is reset.
163  *
164  * Each parameter is generalized to be a name string with an integer value.
165  *
166  * Known parameters are:
167  *
168  *	Name				Value Range
169  *
170  *	"framelength"			512,1024,2048
171  *	"exec_throttle"			16..255
172  *	"fullduplex"			0,1
173  *	"loopid"			0..125
174  */
175 
176 struct isp_fc_param {
177 	char		param_name[16];	/* null terminated */
178 	uint32_t	parameter;
179 };
180 
181 #define	ISP_GET_FC_PARAM	_IOWR(ISP_IOC, 98, struct isp_fc_param)
182 #define	ISP_SET_FC_PARAM	_IOWR(ISP_IOC, 99, struct isp_fc_param)
183 
184 /*
185  * Various Reset Goodies
186  */
187 struct isp_fc_tsk_mgmt {
188 	uint32_t	loopid;		/* 0..255 */
189 	uint32_t	lun;
190 	enum {
191 	    CLEAR_ACA, TARGET_RESET, LUN_RESET, CLEAR_TASK_SET, ABORT_TASK_SET
192 	} action;
193 };
194 #define	ISP_TSK_MGMT		_IOWR(ISP_IOC, 97, struct isp_fc_tsk_mgmt)
195