]>
Commit | Line | Data |
---|---|---|
39e84790 AA |
1 | /* |
2 | * iSCSI User/Kernel Shares (Defines, Constants, Protocol definitions, etc) | |
3 | * | |
4 | * Copyright (C) 2005 Dmitry Yusupov | |
5 | * Copyright (C) 2005 Alex Aizman | |
6 | * maintained by open-iscsi@googlegroups.com | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published | |
10 | * by the Free Software Foundation; either version 2 of the License, or | |
11 | * (at your option) any later version. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, but | |
14 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
16 | * General Public License for more details. | |
17 | * | |
18 | * See the file COPYING included with this distribution for more details. | |
19 | */ | |
20 | ||
21 | #ifndef ISCSI_IF_H | |
22 | #define ISCSI_IF_H | |
23 | ||
24 | #include <scsi/iscsi_proto.h> | |
43514774 MC |
25 | #include <linux/in.h> |
26 | #include <linux/in6.h> | |
27 | ||
28 | #define ISCSI_NL_GRP_ISCSID 1 | |
29 | #define ISCSI_NL_GRP_UIP 2 | |
39e84790 AA |
30 | |
31 | #define UEVENT_BASE 10 | |
32 | #define KEVENT_BASE 100 | |
33 | #define ISCSI_ERR_BASE 1000 | |
34 | ||
35 | enum iscsi_uevent_e { | |
36 | ISCSI_UEVENT_UNKNOWN = 0, | |
37 | ||
38 | /* down events */ | |
39 | ISCSI_UEVENT_CREATE_SESSION = UEVENT_BASE + 1, | |
40 | ISCSI_UEVENT_DESTROY_SESSION = UEVENT_BASE + 2, | |
41 | ISCSI_UEVENT_CREATE_CONN = UEVENT_BASE + 3, | |
42 | ISCSI_UEVENT_DESTROY_CONN = UEVENT_BASE + 4, | |
43 | ISCSI_UEVENT_BIND_CONN = UEVENT_BASE + 5, | |
44 | ISCSI_UEVENT_SET_PARAM = UEVENT_BASE + 6, | |
45 | ISCSI_UEVENT_START_CONN = UEVENT_BASE + 7, | |
46 | ISCSI_UEVENT_STOP_CONN = UEVENT_BASE + 8, | |
47 | ISCSI_UEVENT_SEND_PDU = UEVENT_BASE + 9, | |
48 | ISCSI_UEVENT_GET_STATS = UEVENT_BASE + 10, | |
49 | ISCSI_UEVENT_GET_PARAM = UEVENT_BASE + 11, | |
50 | ||
264faaaa OG |
51 | ISCSI_UEVENT_TRANSPORT_EP_CONNECT = UEVENT_BASE + 12, |
52 | ISCSI_UEVENT_TRANSPORT_EP_POLL = UEVENT_BASE + 13, | |
53 | ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT = UEVENT_BASE + 14, | |
54 | ||
01cb225d | 55 | ISCSI_UEVENT_TGT_DSCVR = UEVENT_BASE + 15, |
1d9bf13a | 56 | ISCSI_UEVENT_SET_HOST_PARAM = UEVENT_BASE + 16, |
26974789 | 57 | ISCSI_UEVENT_UNBIND_SESSION = UEVENT_BASE + 17, |
10eb0f01 MC |
58 | ISCSI_UEVENT_CREATE_BOUND_SESSION = UEVENT_BASE + 18, |
59 | ISCSI_UEVENT_TRANSPORT_EP_CONNECT_THROUGH_HOST = UEVENT_BASE + 19, | |
01cb225d | 60 | |
43514774 | 61 | ISCSI_UEVENT_PATH_UPDATE = UEVENT_BASE + 20, |
56c155b5 | 62 | ISCSI_UEVENT_SET_IFACE_PARAMS = UEVENT_BASE + 21, |
ac20c7bf | 63 | ISCSI_UEVENT_PING = UEVENT_BASE + 22, |
6260a5d2 NJ |
64 | ISCSI_UEVENT_GET_CHAP = UEVENT_BASE + 23, |
65 | ISCSI_UEVENT_DELETE_CHAP = UEVENT_BASE + 24, | |
c6a4bb2e AC |
66 | ISCSI_UEVENT_SET_FLASHNODE_PARAMS = UEVENT_BASE + 25, |
67 | ISCSI_UEVENT_NEW_FLASHNODE = UEVENT_BASE + 26, | |
68 | ISCSI_UEVENT_DEL_FLASHNODE = UEVENT_BASE + 27, | |
69 | ISCSI_UEVENT_LOGIN_FLASHNODE = UEVENT_BASE + 28, | |
70 | ISCSI_UEVENT_LOGOUT_FLASHNODE = UEVENT_BASE + 29, | |
71 | ISCSI_UEVENT_LOGOUT_FLASHNODE_SID = UEVENT_BASE + 30, | |
43514774 | 72 | |
39e84790 AA |
73 | /* up events */ |
74 | ISCSI_KEVENT_RECV_PDU = KEVENT_BASE + 1, | |
75 | ISCSI_KEVENT_CONN_ERROR = KEVENT_BASE + 2, | |
76 | ISCSI_KEVENT_IF_ERROR = KEVENT_BASE + 3, | |
53cb8a1f | 77 | ISCSI_KEVENT_DESTROY_SESSION = KEVENT_BASE + 4, |
26974789 MC |
78 | ISCSI_KEVENT_UNBIND_SESSION = KEVENT_BASE + 5, |
79 | ISCSI_KEVENT_CREATE_SESSION = KEVENT_BASE + 6, | |
43514774 MC |
80 | |
81 | ISCSI_KEVENT_PATH_REQ = KEVENT_BASE + 7, | |
82 | ISCSI_KEVENT_IF_DOWN = KEVENT_BASE + 8, | |
17fa575e | 83 | ISCSI_KEVENT_CONN_LOGIN_STATE = KEVENT_BASE + 9, |
a11e2545 | 84 | ISCSI_KEVENT_HOST_EVENT = KEVENT_BASE + 10, |
ac20c7bf | 85 | ISCSI_KEVENT_PING_COMP = KEVENT_BASE + 11, |
39e84790 AA |
86 | }; |
87 | ||
01cb225d MC |
88 | enum iscsi_tgt_dscvr { |
89 | ISCSI_TGT_DSCVR_SEND_TARGETS = 1, | |
90 | ISCSI_TGT_DSCVR_ISNS = 2, | |
91 | ISCSI_TGT_DSCVR_SLP = 3, | |
92 | }; | |
93 | ||
a11e2545 VC |
94 | enum iscsi_host_event_code { |
95 | ISCSI_EVENT_LINKUP = 1, | |
96 | ISCSI_EVENT_LINKDOWN, | |
97 | /* must always be last */ | |
98 | ISCSI_EVENT_MAX, | |
99 | }; | |
100 | ||
39e84790 AA |
101 | struct iscsi_uevent { |
102 | uint32_t type; /* k/u events type */ | |
103 | uint32_t iferror; /* carries interface or resource errors */ | |
104 | uint64_t transport_handle; | |
105 | ||
106 | union { | |
107 | /* messages u -> k */ | |
108 | struct msg_create_session { | |
109 | uint32_t initial_cmdsn; | |
1548271e MC |
110 | uint16_t cmds_max; |
111 | uint16_t queue_depth; | |
39e84790 | 112 | } c_session; |
40753caa | 113 | struct msg_create_bound_session { |
d82ff9be | 114 | uint64_t ep_handle; |
40753caa MC |
115 | uint32_t initial_cmdsn; |
116 | uint16_t cmds_max; | |
117 | uint16_t queue_depth; | |
118 | } c_bound_session; | |
39e84790 | 119 | struct msg_destroy_session { |
39e84790 AA |
120 | uint32_t sid; |
121 | } d_session; | |
122 | struct msg_create_conn { | |
39e84790 | 123 | uint32_t sid; |
b5c7a12d | 124 | uint32_t cid; |
39e84790 AA |
125 | } c_conn; |
126 | struct msg_bind_conn { | |
b5c7a12d MC |
127 | uint32_t sid; |
128 | uint32_t cid; | |
264faaaa | 129 | uint64_t transport_eph; |
39e84790 AA |
130 | uint32_t is_leading; |
131 | } b_conn; | |
132 | struct msg_destroy_conn { | |
b5c7a12d | 133 | uint32_t sid; |
39e84790 AA |
134 | uint32_t cid; |
135 | } d_conn; | |
136 | struct msg_send_pdu { | |
b5c7a12d MC |
137 | uint32_t sid; |
138 | uint32_t cid; | |
39e84790 AA |
139 | uint32_t hdr_size; |
140 | uint32_t data_size; | |
39e84790 AA |
141 | } send_pdu; |
142 | struct msg_set_param { | |
b5c7a12d MC |
143 | uint32_t sid; |
144 | uint32_t cid; | |
39e84790 | 145 | uint32_t param; /* enum iscsi_param */ |
fd7255f5 | 146 | uint32_t len; |
39e84790 AA |
147 | } set_param; |
148 | struct msg_start_conn { | |
b5c7a12d MC |
149 | uint32_t sid; |
150 | uint32_t cid; | |
39e84790 AA |
151 | } start_conn; |
152 | struct msg_stop_conn { | |
b5c7a12d MC |
153 | uint32_t sid; |
154 | uint32_t cid; | |
39e84790 AA |
155 | uint64_t conn_handle; |
156 | uint32_t flag; | |
157 | } stop_conn; | |
158 | struct msg_get_stats { | |
b5c7a12d MC |
159 | uint32_t sid; |
160 | uint32_t cid; | |
39e84790 | 161 | } get_stats; |
264faaaa OG |
162 | struct msg_transport_connect { |
163 | uint32_t non_blocking; | |
164 | } ep_connect; | |
10eb0f01 MC |
165 | struct msg_transport_connect_through_host { |
166 | uint32_t host_no; | |
167 | uint32_t non_blocking; | |
168 | } ep_connect_through_host; | |
264faaaa OG |
169 | struct msg_transport_poll { |
170 | uint64_t ep_handle; | |
171 | uint32_t timeout_ms; | |
172 | } ep_poll; | |
173 | struct msg_transport_disconnect { | |
174 | uint64_t ep_handle; | |
175 | } ep_disconnect; | |
01cb225d MC |
176 | struct msg_tgt_dscvr { |
177 | enum iscsi_tgt_dscvr type; | |
178 | uint32_t host_no; | |
179 | /* | |
180 | * enable = 1 to establish a new connection | |
181 | * with the server. enable = 0 to disconnect | |
182 | * from the server. Used primarily to switch | |
183 | * from one iSNS server to another. | |
184 | */ | |
185 | uint32_t enable; | |
186 | } tgt_dscvr; | |
1d9bf13a MC |
187 | struct msg_set_host_param { |
188 | uint32_t host_no; | |
189 | uint32_t param; /* enum iscsi_host_param */ | |
190 | uint32_t len; | |
191 | } set_host_param; | |
43514774 MC |
192 | struct msg_set_path { |
193 | uint32_t host_no; | |
194 | } set_path; | |
56c155b5 MC |
195 | struct msg_set_iface_params { |
196 | uint32_t host_no; | |
197 | uint32_t count; | |
198 | } set_iface_params; | |
ac20c7bf VC |
199 | struct msg_iscsi_ping { |
200 | uint32_t host_no; | |
201 | uint32_t iface_num; | |
202 | uint32_t iface_type; | |
203 | uint32_t payload_size; | |
204 | uint32_t pid; /* unique ping id associated | |
205 | with each ping request */ | |
206 | } iscsi_ping; | |
6260a5d2 NJ |
207 | struct msg_get_chap { |
208 | uint32_t host_no; | |
209 | uint32_t num_entries; /* number of CHAP entries | |
210 | * on request, number of | |
211 | * valid CHAP entries on | |
212 | * response */ | |
213 | uint16_t chap_tbl_idx; | |
214 | } get_chap; | |
215 | struct msg_delete_chap { | |
216 | uint32_t host_no; | |
217 | uint16_t chap_tbl_idx; | |
218 | } delete_chap; | |
c6a4bb2e AC |
219 | struct msg_set_flashnode_param { |
220 | uint32_t host_no; | |
221 | uint32_t flashnode_idx; | |
222 | uint32_t count; | |
223 | } set_flashnode; | |
224 | struct msg_new_flashnode { | |
225 | uint32_t host_no; | |
226 | uint32_t len; | |
227 | } new_flashnode; | |
228 | struct msg_del_flashnode { | |
229 | uint32_t host_no; | |
230 | uint32_t flashnode_idx; | |
231 | } del_flashnode; | |
232 | struct msg_login_flashnode { | |
233 | uint32_t host_no; | |
234 | uint32_t flashnode_idx; | |
235 | } login_flashnode; | |
236 | struct msg_logout_flashnode { | |
237 | uint32_t host_no; | |
238 | uint32_t flashnode_idx; | |
239 | } logout_flashnode; | |
240 | struct msg_logout_flashnode_sid { | |
241 | uint32_t host_no; | |
242 | uint32_t sid; | |
243 | } logout_flashnode_sid; | |
39e84790 AA |
244 | } u; |
245 | union { | |
246 | /* messages k -> u */ | |
39e84790 AA |
247 | int retcode; |
248 | struct msg_create_session_ret { | |
39e84790 | 249 | uint32_t sid; |
b5c7a12d | 250 | uint32_t host_no; |
39e84790 | 251 | } c_session_ret; |
b5c7a12d MC |
252 | struct msg_create_conn_ret { |
253 | uint32_t sid; | |
254 | uint32_t cid; | |
255 | } c_conn_ret; | |
26974789 MC |
256 | struct msg_unbind_session { |
257 | uint32_t sid; | |
258 | uint32_t host_no; | |
259 | } unbind_session; | |
39e84790 | 260 | struct msg_recv_req { |
b5c7a12d MC |
261 | uint32_t sid; |
262 | uint32_t cid; | |
39e84790 | 263 | uint64_t recv_handle; |
39e84790 | 264 | } recv_req; |
17fa575e MR |
265 | struct msg_conn_login { |
266 | uint32_t sid; | |
267 | uint32_t cid; | |
268 | uint32_t state; /* enum iscsi_conn_state */ | |
269 | } conn_login; | |
39e84790 | 270 | struct msg_conn_error { |
b5c7a12d MC |
271 | uint32_t sid; |
272 | uint32_t cid; | |
39e84790 AA |
273 | uint32_t error; /* enum iscsi_err */ |
274 | } connerror; | |
53cb8a1f MC |
275 | struct msg_session_destroyed { |
276 | uint32_t host_no; | |
277 | uint32_t sid; | |
278 | } d_session; | |
264faaaa OG |
279 | struct msg_transport_connect_ret { |
280 | uint64_t handle; | |
281 | } ep_connect_ret; | |
43514774 MC |
282 | struct msg_req_path { |
283 | uint32_t host_no; | |
284 | } req_path; | |
285 | struct msg_notify_if_down { | |
286 | uint32_t host_no; | |
287 | } notify_if_down; | |
a11e2545 VC |
288 | struct msg_host_event { |
289 | uint32_t host_no; | |
290 | uint32_t data_size; | |
291 | enum iscsi_host_event_code code; | |
292 | } host_event; | |
ac20c7bf VC |
293 | struct msg_ping_comp { |
294 | uint32_t host_no; | |
1a590cab VC |
295 | uint32_t status; /* enum |
296 | * iscsi_ping_status_code */ | |
ac20c7bf VC |
297 | uint32_t pid; /* unique ping id associated |
298 | with each ping request */ | |
299 | uint32_t data_size; | |
300 | } ping_comp; | |
c6a4bb2e AC |
301 | struct msg_new_flashnode_ret { |
302 | uint32_t flashnode_idx; | |
303 | } new_flashnode_ret; | |
39e84790 AA |
304 | } r; |
305 | } __attribute__ ((aligned (sizeof(uint64_t)))); | |
306 | ||
56c155b5 MC |
307 | enum iscsi_param_type { |
308 | ISCSI_PARAM, /* iscsi_param (session, conn, target, LU) */ | |
309 | ISCSI_HOST_PARAM, /* iscsi_host_param */ | |
310 | ISCSI_NET_PARAM, /* iscsi_net_param */ | |
c6a4bb2e | 311 | ISCSI_FLASHNODE_PARAM, /* iscsi_flashnode_param */ |
56c155b5 MC |
312 | }; |
313 | ||
314 | struct iscsi_iface_param_info { | |
315 | uint32_t iface_num; /* iface number, 0 - n */ | |
316 | uint32_t len; /* Actual length of the param */ | |
317 | uint16_t param; /* iscsi param value */ | |
318 | uint8_t iface_type; /* IPv4 or IPv6 */ | |
319 | uint8_t param_type; /* iscsi_param_type */ | |
320 | uint8_t value[0]; /* length sized value follows */ | |
321 | } __packed; | |
322 | ||
43514774 MC |
323 | /* |
324 | * To keep the struct iscsi_uevent size the same for userspace code | |
325 | * compatibility, the main structure for ISCSI_UEVENT_PATH_UPDATE and | |
326 | * ISCSI_KEVENT_PATH_REQ is defined separately and comes after the | |
327 | * struct iscsi_uevent in the NETLINK_ISCSI message. | |
328 | */ | |
329 | struct iscsi_path { | |
330 | uint64_t handle; | |
331 | uint8_t mac_addr[6]; | |
332 | uint8_t mac_addr_old[6]; | |
333 | uint32_t ip_addr_len; /* 4 or 16 */ | |
334 | union { | |
335 | struct in_addr v4_addr; | |
336 | struct in6_addr v6_addr; | |
337 | } src; | |
338 | union { | |
339 | struct in_addr v4_addr; | |
340 | struct in6_addr v6_addr; | |
341 | } dst; | |
342 | uint16_t vlan_id; | |
343 | uint16_t pmtu; | |
344 | } __attribute__ ((aligned (sizeof(uint64_t)))); | |
345 | ||
56c155b5 MC |
346 | /* iscsi iface enabled/disabled setting */ |
347 | #define ISCSI_IFACE_DISABLE 0x01 | |
348 | #define ISCSI_IFACE_ENABLE 0x02 | |
349 | ||
350 | /* ipv4 bootproto */ | |
351 | #define ISCSI_BOOTPROTO_STATIC 0x01 | |
352 | #define ISCSI_BOOTPROTO_DHCP 0x02 | |
353 | ||
354 | /* ipv6 addr autoconfig type */ | |
355 | #define ISCSI_IPV6_AUTOCFG_DISABLE 0x01 | |
356 | #define ISCSI_IPV6_AUTOCFG_ND_ENABLE 0x02 | |
357 | #define ISCSI_IPV6_AUTOCFG_DHCPV6_ENABLE 0x03 | |
358 | ||
359 | /* ipv6 link local addr type */ | |
360 | #define ISCSI_IPV6_LINKLOCAL_AUTOCFG_ENABLE 0x01 | |
361 | #define ISCSI_IPV6_LINKLOCAL_AUTOCFG_DISABLE 0x02 | |
362 | ||
363 | /* ipv6 router addr type */ | |
364 | #define ISCSI_IPV6_ROUTER_AUTOCFG_ENABLE 0x01 | |
365 | #define ISCSI_IPV6_ROUTER_AUTOCFG_DISABLE 0x02 | |
366 | ||
367 | #define ISCSI_IFACE_TYPE_IPV4 0x01 | |
368 | #define ISCSI_IFACE_TYPE_IPV6 0x02 | |
369 | ||
4223b9e9 MC |
370 | #define ISCSI_MAX_VLAN_ID 4095 |
371 | #define ISCSI_MAX_VLAN_PRIORITY 7 | |
372 | ||
373 | /* iscsi vlan enable/disabled setting */ | |
374 | #define ISCSI_VLAN_DISABLE 0x01 | |
375 | #define ISCSI_VLAN_ENABLE 0x02 | |
376 | ||
56c155b5 MC |
377 | /* iSCSI network params */ |
378 | enum iscsi_net_param { | |
379 | ISCSI_NET_PARAM_IPV4_ADDR = 1, | |
380 | ISCSI_NET_PARAM_IPV4_SUBNET = 2, | |
381 | ISCSI_NET_PARAM_IPV4_GW = 3, | |
382 | ISCSI_NET_PARAM_IPV4_BOOTPROTO = 4, | |
383 | ISCSI_NET_PARAM_MAC = 5, | |
384 | ISCSI_NET_PARAM_IPV6_LINKLOCAL = 6, | |
385 | ISCSI_NET_PARAM_IPV6_ADDR = 7, | |
386 | ISCSI_NET_PARAM_IPV6_ROUTER = 8, | |
387 | ISCSI_NET_PARAM_IPV6_ADDR_AUTOCFG = 9, | |
388 | ISCSI_NET_PARAM_IPV6_LINKLOCAL_AUTOCFG = 10, | |
389 | ISCSI_NET_PARAM_IPV6_ROUTER_AUTOCFG = 11, | |
390 | ISCSI_NET_PARAM_IFACE_ENABLE = 12, | |
391 | ISCSI_NET_PARAM_VLAN_ID = 13, | |
4223b9e9 MC |
392 | ISCSI_NET_PARAM_VLAN_PRIORITY = 14, |
393 | ISCSI_NET_PARAM_VLAN_ENABLED = 15, | |
2d63673b MC |
394 | ISCSI_NET_PARAM_VLAN_TAG = 16, |
395 | ISCSI_NET_PARAM_IFACE_TYPE = 17, | |
396 | ISCSI_NET_PARAM_IFACE_NAME = 18, | |
397 | ISCSI_NET_PARAM_MTU = 19, | |
398 | ISCSI_NET_PARAM_PORT = 20, | |
56c155b5 MC |
399 | }; |
400 | ||
17fa575e MR |
401 | enum iscsi_conn_state { |
402 | ISCSI_CONN_STATE_FREE, | |
403 | ISCSI_CONN_STATE_XPT_WAIT, | |
404 | ISCSI_CONN_STATE_IN_LOGIN, | |
405 | ISCSI_CONN_STATE_LOGGED_IN, | |
406 | ISCSI_CONN_STATE_IN_LOGOUT, | |
407 | ISCSI_CONN_STATE_LOGOUT_REQUESTED, | |
408 | ISCSI_CONN_STATE_CLEANUP_WAIT, | |
409 | }; | |
410 | ||
39e84790 AA |
411 | /* |
412 | * Common error codes | |
413 | */ | |
414 | enum iscsi_err { | |
415 | ISCSI_OK = 0, | |
416 | ||
417 | ISCSI_ERR_DATASN = ISCSI_ERR_BASE + 1, | |
418 | ISCSI_ERR_DATA_OFFSET = ISCSI_ERR_BASE + 2, | |
419 | ISCSI_ERR_MAX_CMDSN = ISCSI_ERR_BASE + 3, | |
420 | ISCSI_ERR_EXP_CMDSN = ISCSI_ERR_BASE + 4, | |
421 | ISCSI_ERR_BAD_OPCODE = ISCSI_ERR_BASE + 5, | |
422 | ISCSI_ERR_DATALEN = ISCSI_ERR_BASE + 6, | |
423 | ISCSI_ERR_AHSLEN = ISCSI_ERR_BASE + 7, | |
424 | ISCSI_ERR_PROTO = ISCSI_ERR_BASE + 8, | |
425 | ISCSI_ERR_LUN = ISCSI_ERR_BASE + 9, | |
426 | ISCSI_ERR_BAD_ITT = ISCSI_ERR_BASE + 10, | |
427 | ISCSI_ERR_CONN_FAILED = ISCSI_ERR_BASE + 11, | |
428 | ISCSI_ERR_R2TSN = ISCSI_ERR_BASE + 12, | |
429 | ISCSI_ERR_SESSION_FAILED = ISCSI_ERR_BASE + 13, | |
430 | ISCSI_ERR_HDR_DGST = ISCSI_ERR_BASE + 14, | |
431 | ISCSI_ERR_DATA_DGST = ISCSI_ERR_BASE + 15, | |
7996a778 MC |
432 | ISCSI_ERR_PARAM_NOT_FOUND = ISCSI_ERR_BASE + 16, |
433 | ISCSI_ERR_NO_SCSI_CMD = ISCSI_ERR_BASE + 17, | |
e5bd7b54 | 434 | ISCSI_ERR_INVALID_HOST = ISCSI_ERR_BASE + 18, |
6f481e3c | 435 | ISCSI_ERR_XMIT_FAILED = ISCSI_ERR_BASE + 19, |
d1af8a32 | 436 | ISCSI_ERR_TCP_CONN_CLOSE = ISCSI_ERR_BASE + 20, |
df4da5cd | 437 | ISCSI_ERR_SCSI_EH_SESSION_RST = ISCSI_ERR_BASE + 21, |
39e84790 AA |
438 | }; |
439 | ||
440 | /* | |
441 | * iSCSI Parameters (RFC3720) | |
442 | */ | |
443 | enum iscsi_param { | |
fd7255f5 MC |
444 | /* passed in using netlink set param */ |
445 | ISCSI_PARAM_MAX_RECV_DLENGTH, | |
446 | ISCSI_PARAM_MAX_XMIT_DLENGTH, | |
447 | ISCSI_PARAM_HDRDGST_EN, | |
448 | ISCSI_PARAM_DATADGST_EN, | |
449 | ISCSI_PARAM_INITIAL_R2T_EN, | |
450 | ISCSI_PARAM_MAX_R2T, | |
451 | ISCSI_PARAM_IMM_DATA_EN, | |
452 | ISCSI_PARAM_FIRST_BURST, | |
453 | ISCSI_PARAM_MAX_BURST, | |
454 | ISCSI_PARAM_PDU_INORDER_EN, | |
455 | ISCSI_PARAM_DATASEQ_INORDER_EN, | |
456 | ISCSI_PARAM_ERL, | |
457 | ISCSI_PARAM_IFMARKER_EN, | |
458 | ISCSI_PARAM_OFMARKER_EN, | |
8d2860b3 | 459 | ISCSI_PARAM_EXP_STATSN, |
fd7255f5 MC |
460 | ISCSI_PARAM_TARGET_NAME, |
461 | ISCSI_PARAM_TPGT, | |
462 | ISCSI_PARAM_PERSISTENT_ADDRESS, | |
463 | ISCSI_PARAM_PERSISTENT_PORT, | |
30a6c652 | 464 | ISCSI_PARAM_SESS_RECOVERY_TMO, |
fd7255f5 | 465 | |
25985edc | 466 | /* passed in through bind conn using transport_fd */ |
fd7255f5 MC |
467 | ISCSI_PARAM_CONN_PORT, |
468 | ISCSI_PARAM_CONN_ADDRESS, | |
469 | ||
b2c64167 MC |
470 | ISCSI_PARAM_USERNAME, |
471 | ISCSI_PARAM_USERNAME_IN, | |
472 | ISCSI_PARAM_PASSWORD, | |
473 | ISCSI_PARAM_PASSWORD_IN, | |
474 | ||
843c0a8a | 475 | ISCSI_PARAM_FAST_ABORT, |
f6d5180c MC |
476 | ISCSI_PARAM_ABORT_TMO, |
477 | ISCSI_PARAM_LU_RESET_TMO, | |
478 | ISCSI_PARAM_HOST_RESET_TMO, | |
479 | ||
480 | ISCSI_PARAM_PING_TMO, | |
481 | ISCSI_PARAM_RECV_TMO, | |
88dfd340 MC |
482 | |
483 | ISCSI_PARAM_IFACE_NAME, | |
484 | ISCSI_PARAM_ISID, | |
485 | ISCSI_PARAM_INITIATOR_NAME, | |
3fe5ae8b MC |
486 | |
487 | ISCSI_PARAM_TGT_RESET_TMO, | |
3b2bef1f | 488 | ISCSI_PARAM_TARGET_ALIAS, |
30534952 MC |
489 | |
490 | ISCSI_PARAM_CHAP_IN_IDX, | |
491 | ISCSI_PARAM_CHAP_OUT_IDX, | |
3b9373e9 EW |
492 | |
493 | ISCSI_PARAM_BOOT_ROOT, | |
494 | ISCSI_PARAM_BOOT_NIC, | |
495 | ISCSI_PARAM_BOOT_TARGET, | |
496 | ||
fd7255f5 MC |
497 | /* must always be last */ |
498 | ISCSI_PARAM_MAX, | |
39e84790 | 499 | }; |
fd7255f5 | 500 | |
1819dc81 MC |
501 | /* iSCSI HBA params */ |
502 | enum iscsi_host_param { | |
503 | ISCSI_HOST_PARAM_HWADDRESS, | |
8ad5781a | 504 | ISCSI_HOST_PARAM_INITIATOR_NAME, |
d8196ed2 | 505 | ISCSI_HOST_PARAM_NETDEV_NAME, |
22236961 | 506 | ISCSI_HOST_PARAM_IPADDRESS, |
aeddde29 VC |
507 | ISCSI_HOST_PARAM_PORT_STATE, |
508 | ISCSI_HOST_PARAM_PORT_SPEED, | |
1819dc81 MC |
509 | ISCSI_HOST_PARAM_MAX, |
510 | }; | |
511 | ||
2902eb49 AC |
512 | /* portal type */ |
513 | #define PORTAL_TYPE_IPV4 "ipv4" | |
514 | #define PORTAL_TYPE_IPV6 "ipv6" | |
515 | ||
c6a4bb2e AC |
516 | /* iSCSI Flash Target params */ |
517 | enum iscsi_flashnode_param { | |
518 | ISCSI_FLASHNODE_IS_FW_ASSIGNED_IPV6, | |
519 | ISCSI_FLASHNODE_PORTAL_TYPE, | |
520 | ISCSI_FLASHNODE_AUTO_SND_TGT_DISABLE, | |
521 | ISCSI_FLASHNODE_DISCOVERY_SESS, | |
522 | ISCSI_FLASHNODE_ENTRY_EN, | |
523 | ISCSI_FLASHNODE_HDR_DGST_EN, | |
524 | ISCSI_FLASHNODE_DATA_DGST_EN, | |
525 | ISCSI_FLASHNODE_IMM_DATA_EN, | |
526 | ISCSI_FLASHNODE_INITIAL_R2T_EN, | |
527 | ISCSI_FLASHNODE_DATASEQ_INORDER, | |
528 | ISCSI_FLASHNODE_PDU_INORDER, | |
529 | ISCSI_FLASHNODE_CHAP_AUTH_EN, | |
530 | ISCSI_FLASHNODE_SNACK_REQ_EN, | |
531 | ISCSI_FLASHNODE_DISCOVERY_LOGOUT_EN, | |
532 | ISCSI_FLASHNODE_BIDI_CHAP_EN, | |
533 | /* make authentication for discovery sessions optional */ | |
534 | ISCSI_FLASHNODE_DISCOVERY_AUTH_OPTIONAL, | |
535 | ISCSI_FLASHNODE_ERL, | |
536 | ISCSI_FLASHNODE_TCP_TIMESTAMP_STAT, | |
537 | ISCSI_FLASHNODE_TCP_NAGLE_DISABLE, | |
538 | ISCSI_FLASHNODE_TCP_WSF_DISABLE, | |
539 | ISCSI_FLASHNODE_TCP_TIMER_SCALE, | |
540 | ISCSI_FLASHNODE_TCP_TIMESTAMP_EN, | |
541 | ISCSI_FLASHNODE_IP_FRAG_DISABLE, | |
542 | ISCSI_FLASHNODE_MAX_RECV_DLENGTH, | |
543 | ISCSI_FLASHNODE_MAX_XMIT_DLENGTH, | |
544 | ISCSI_FLASHNODE_FIRST_BURST, | |
545 | ISCSI_FLASHNODE_DEF_TIME2WAIT, | |
546 | ISCSI_FLASHNODE_DEF_TIME2RETAIN, | |
547 | ISCSI_FLASHNODE_MAX_R2T, | |
548 | ISCSI_FLASHNODE_KEEPALIVE_TMO, | |
549 | ISCSI_FLASHNODE_ISID, | |
550 | ISCSI_FLASHNODE_TSID, | |
551 | ISCSI_FLASHNODE_PORT, | |
552 | ISCSI_FLASHNODE_MAX_BURST, | |
553 | ISCSI_FLASHNODE_DEF_TASKMGMT_TMO, | |
554 | ISCSI_FLASHNODE_IPADDR, | |
555 | ISCSI_FLASHNODE_ALIAS, | |
556 | ISCSI_FLASHNODE_REDIRECT_IPADDR, | |
557 | ISCSI_FLASHNODE_MAX_SEGMENT_SIZE, | |
558 | ISCSI_FLASHNODE_LOCAL_PORT, | |
559 | ISCSI_FLASHNODE_IPV4_TOS, | |
560 | ISCSI_FLASHNODE_IPV6_TC, | |
561 | ISCSI_FLASHNODE_IPV6_FLOW_LABEL, | |
562 | ISCSI_FLASHNODE_NAME, | |
563 | ISCSI_FLASHNODE_TPGT, | |
564 | ISCSI_FLASHNODE_LINK_LOCAL_IPV6, | |
565 | ISCSI_FLASHNODE_DISCOVERY_PARENT_IDX, | |
566 | ISCSI_FLASHNODE_DISCOVERY_PARENT_TYPE, | |
567 | ISCSI_FLASHNODE_TCP_XMIT_WSF, | |
568 | ISCSI_FLASHNODE_TCP_RECV_WSF, | |
569 | ISCSI_FLASHNODE_CHAP_IN_IDX, | |
570 | ISCSI_FLASHNODE_CHAP_OUT_IDX, | |
571 | ISCSI_FLASHNODE_USERNAME, | |
572 | ISCSI_FLASHNODE_USERNAME_IN, | |
573 | ISCSI_FLASHNODE_PASSWORD, | |
574 | ISCSI_FLASHNODE_PASSWORD_IN, | |
575 | ISCSI_FLASHNODE_STATSN, | |
576 | ISCSI_FLASHNODE_EXP_STATSN, | |
577 | ISCSI_FLASHNODE_IS_BOOT_TGT, | |
578 | ||
579 | ISCSI_FLASHNODE_MAX, | |
580 | }; | |
581 | ||
582 | struct iscsi_flashnode_param_info { | |
583 | uint32_t len; /* Actual length of the param */ | |
584 | uint16_t param; /* iscsi param value */ | |
585 | uint8_t value[0]; /* length sized value follows */ | |
586 | } __packed; | |
587 | ||
588 | enum iscsi_discovery_parent_type { | |
589 | ISCSI_DISC_PARENT_UNKNOWN = 0x1, | |
590 | ISCSI_DISC_PARENT_SENDTGT = 0x2, | |
591 | ISCSI_DISC_PARENT_ISNS = 0x3, | |
592 | }; | |
593 | ||
aeddde29 VC |
594 | /* iSCSI port Speed */ |
595 | enum iscsi_port_speed { | |
596 | ISCSI_PORT_SPEED_UNKNOWN = 0x1, | |
597 | ISCSI_PORT_SPEED_10MBPS = 0x2, | |
598 | ISCSI_PORT_SPEED_100MBPS = 0x4, | |
599 | ISCSI_PORT_SPEED_1GBPS = 0x8, | |
600 | ISCSI_PORT_SPEED_10GBPS = 0x10, | |
601 | }; | |
602 | ||
603 | /* iSCSI port state */ | |
604 | enum iscsi_port_state { | |
605 | ISCSI_PORT_STATE_DOWN = 0x1, | |
606 | ISCSI_PORT_STATE_UP = 0x2, | |
607 | }; | |
608 | ||
1a590cab VC |
609 | /* iSCSI PING status/error code */ |
610 | enum iscsi_ping_status_code { | |
611 | ISCSI_PING_SUCCESS = 0, | |
612 | ISCSI_PING_FW_DISABLED = 0x1, | |
613 | ISCSI_PING_IPADDR_INVALID = 0x2, | |
614 | ISCSI_PING_LINKLOCAL_IPV6_ADDR_INVALID = 0x3, | |
615 | ISCSI_PING_TIMEOUT = 0x4, | |
616 | ISCSI_PING_INVALID_DEST_ADDR = 0x5, | |
617 | ISCSI_PING_OVERSIZE_PACKET = 0x6, | |
618 | ISCSI_PING_ICMP_ERROR = 0x7, | |
619 | ISCSI_PING_MAX_REQ_EXCEEDED = 0x8, | |
620 | ISCSI_PING_NO_ARP_RECEIVED = 0x9, | |
621 | }; | |
622 | ||
39e84790 AA |
623 | #define iscsi_ptr(_handle) ((void*)(unsigned long)_handle) |
624 | #define iscsi_handle(_ptr) ((uint64_t)(unsigned long)_ptr) | |
39e84790 AA |
625 | |
626 | /* | |
627 | * These flags presents iSCSI Data-Path capabilities. | |
628 | */ | |
629 | #define CAP_RECOVERY_L0 0x1 | |
630 | #define CAP_RECOVERY_L1 0x2 | |
631 | #define CAP_RECOVERY_L2 0x4 | |
632 | #define CAP_MULTI_R2T 0x8 | |
633 | #define CAP_HDRDGST 0x10 | |
634 | #define CAP_DATADGST 0x20 | |
635 | #define CAP_MULTI_CONN 0x40 | |
636 | #define CAP_TEXT_NEGO 0x80 | |
637 | #define CAP_MARKERS 0x100 | |
0ab823db | 638 | #define CAP_FW_DB 0x200 |
63c62f1c MC |
639 | #define CAP_SENDTARGETS_OFFLOAD 0x400 /* offload discovery process */ |
640 | #define CAP_DATA_PATH_OFFLOAD 0x800 /* offload entire IO path */ | |
641 | #define CAP_DIGEST_OFFLOAD 0x1000 /* offload hdr and data digests */ | |
6df19a79 MC |
642 | #define CAP_PADDING_OFFLOAD 0x2000 /* offload padding insertion, removal, |
643 | and verification */ | |
17fa575e | 644 | #define CAP_LOGIN_OFFLOAD 0x4000 /* offload session login */ |
39e84790 AA |
645 | |
646 | /* | |
647 | * These flags describes reason of stop_conn() call | |
648 | */ | |
649 | #define STOP_CONN_TERM 0x1 | |
650 | #define STOP_CONN_SUSPEND 0x2 | |
651 | #define STOP_CONN_RECOVER 0x3 | |
652 | ||
653 | #define ISCSI_STATS_CUSTOM_MAX 32 | |
654 | #define ISCSI_STATS_CUSTOM_DESC_MAX 64 | |
655 | struct iscsi_stats_custom { | |
656 | char desc[ISCSI_STATS_CUSTOM_DESC_MAX]; | |
657 | uint64_t value; | |
658 | }; | |
659 | ||
660 | /* | |
661 | * struct iscsi_stats - iSCSI Statistics (iSCSI MIB) | |
662 | * | |
663 | * Note: this structure contains counters collected on per-connection basis. | |
664 | */ | |
665 | struct iscsi_stats { | |
666 | /* octets */ | |
667 | uint64_t txdata_octets; | |
668 | uint64_t rxdata_octets; | |
669 | ||
670 | /* xmit pdus */ | |
671 | uint32_t noptx_pdus; | |
672 | uint32_t scsicmd_pdus; | |
673 | uint32_t tmfcmd_pdus; | |
674 | uint32_t login_pdus; | |
675 | uint32_t text_pdus; | |
676 | uint32_t dataout_pdus; | |
677 | uint32_t logout_pdus; | |
678 | uint32_t snack_pdus; | |
679 | ||
680 | /* recv pdus */ | |
681 | uint32_t noprx_pdus; | |
682 | uint32_t scsirsp_pdus; | |
683 | uint32_t tmfrsp_pdus; | |
684 | uint32_t textrsp_pdus; | |
685 | uint32_t datain_pdus; | |
686 | uint32_t logoutrsp_pdus; | |
687 | uint32_t r2t_pdus; | |
688 | uint32_t async_pdus; | |
689 | uint32_t rjt_pdus; | |
690 | ||
691 | /* errors */ | |
692 | uint32_t digest_err; | |
693 | uint32_t timeout_err; | |
694 | ||
695 | /* | |
696 | * iSCSI Custom Statistics support, i.e. Transport could | |
697 | * extend existing MIB statistics with its own specific statistics | |
698 | * up to ISCSI_STATS_CUSTOM_MAX | |
699 | */ | |
700 | uint32_t custom_length; | |
701 | struct iscsi_stats_custom custom[0] | |
702 | __attribute__ ((aligned (sizeof(uint64_t)))); | |
703 | }; | |
704 | ||
6260a5d2 NJ |
705 | enum chap_type_e { |
706 | CHAP_TYPE_OUT, | |
707 | CHAP_TYPE_IN, | |
708 | }; | |
709 | ||
710 | #define ISCSI_CHAP_AUTH_NAME_MAX_LEN 256 | |
711 | #define ISCSI_CHAP_AUTH_SECRET_MAX_LEN 256 | |
712 | struct iscsi_chap_rec { | |
713 | uint16_t chap_tbl_idx; | |
714 | enum chap_type_e chap_type; | |
715 | char username[ISCSI_CHAP_AUTH_NAME_MAX_LEN]; | |
716 | uint8_t password[ISCSI_CHAP_AUTH_SECRET_MAX_LEN]; | |
717 | uint8_t password_length; | |
5a5a15f2 | 718 | }; |
6260a5d2 | 719 | |
39e84790 | 720 | #endif |