2 * iSCSI User/Kernel Shares (Defines, Constants, Protocol definitions, etc)
4 * Copyright (C) 2005 Dmitry Yusupov
5 * Copyright (C) 2005 Alex Aizman
6 * maintained by open-iscsi@googlegroups.com
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.
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.
18 * See the file COPYING included with this distribution for more details.
24 #include <scsi/iscsi_proto.h>
26 #include <linux/in6.h>
28 #define ISCSI_NL_GRP_ISCSID 1
29 #define ISCSI_NL_GRP_UIP 2
31 #define UEVENT_BASE 10
32 #define KEVENT_BASE 100
33 #define ISCSI_ERR_BASE 1000
36 ISCSI_UEVENT_UNKNOWN
= 0,
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,
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,
55 ISCSI_UEVENT_TGT_DSCVR
= UEVENT_BASE
+ 15,
56 ISCSI_UEVENT_SET_HOST_PARAM
= UEVENT_BASE
+ 16,
57 ISCSI_UEVENT_UNBIND_SESSION
= UEVENT_BASE
+ 17,
58 ISCSI_UEVENT_CREATE_BOUND_SESSION
= UEVENT_BASE
+ 18,
59 ISCSI_UEVENT_TRANSPORT_EP_CONNECT_THROUGH_HOST
= UEVENT_BASE
+ 19,
61 ISCSI_UEVENT_PATH_UPDATE
= UEVENT_BASE
+ 20,
62 ISCSI_UEVENT_SET_IFACE_PARAMS
= UEVENT_BASE
+ 21,
63 ISCSI_UEVENT_PING
= UEVENT_BASE
+ 22,
64 ISCSI_UEVENT_GET_CHAP
= UEVENT_BASE
+ 23,
65 ISCSI_UEVENT_DELETE_CHAP
= UEVENT_BASE
+ 24,
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,
72 ISCSI_UEVENT_SET_CHAP
= UEVENT_BASE
+ 31,
73 ISCSI_UEVENT_GET_HOST_STATS
= UEVENT_BASE
+ 32,
76 ISCSI_KEVENT_RECV_PDU
= KEVENT_BASE
+ 1,
77 ISCSI_KEVENT_CONN_ERROR
= KEVENT_BASE
+ 2,
78 ISCSI_KEVENT_IF_ERROR
= KEVENT_BASE
+ 3,
79 ISCSI_KEVENT_DESTROY_SESSION
= KEVENT_BASE
+ 4,
80 ISCSI_KEVENT_UNBIND_SESSION
= KEVENT_BASE
+ 5,
81 ISCSI_KEVENT_CREATE_SESSION
= KEVENT_BASE
+ 6,
83 ISCSI_KEVENT_PATH_REQ
= KEVENT_BASE
+ 7,
84 ISCSI_KEVENT_IF_DOWN
= KEVENT_BASE
+ 8,
85 ISCSI_KEVENT_CONN_LOGIN_STATE
= KEVENT_BASE
+ 9,
86 ISCSI_KEVENT_HOST_EVENT
= KEVENT_BASE
+ 10,
87 ISCSI_KEVENT_PING_COMP
= KEVENT_BASE
+ 11,
90 enum iscsi_tgt_dscvr
{
91 ISCSI_TGT_DSCVR_SEND_TARGETS
= 1,
92 ISCSI_TGT_DSCVR_ISNS
= 2,
93 ISCSI_TGT_DSCVR_SLP
= 3,
96 enum iscsi_host_event_code
{
97 ISCSI_EVENT_LINKUP
= 1,
99 /* must always be last */
103 struct iscsi_uevent
{
104 uint32_t type
; /* k/u events type */
105 uint32_t iferror
; /* carries interface or resource errors */
106 uint64_t transport_handle
;
109 /* messages u -> k */
110 struct msg_create_session
{
111 uint32_t initial_cmdsn
;
113 uint16_t queue_depth
;
115 struct msg_create_bound_session
{
117 uint32_t initial_cmdsn
;
119 uint16_t queue_depth
;
121 struct msg_destroy_session
{
124 struct msg_create_conn
{
128 struct msg_bind_conn
{
131 uint64_t transport_eph
;
134 struct msg_destroy_conn
{
138 struct msg_send_pdu
{
144 struct msg_set_param
{
147 uint32_t param
; /* enum iscsi_param */
150 struct msg_start_conn
{
154 struct msg_stop_conn
{
157 uint64_t conn_handle
;
160 struct msg_get_stats
{
164 struct msg_transport_connect
{
165 uint32_t non_blocking
;
167 struct msg_transport_connect_through_host
{
169 uint32_t non_blocking
;
170 } ep_connect_through_host
;
171 struct msg_transport_poll
{
175 struct msg_transport_disconnect
{
178 struct msg_tgt_dscvr
{
179 enum iscsi_tgt_dscvr type
;
182 * enable = 1 to establish a new connection
183 * with the server. enable = 0 to disconnect
184 * from the server. Used primarily to switch
185 * from one iSNS server to another.
189 struct msg_set_host_param
{
191 uint32_t param
; /* enum iscsi_host_param */
194 struct msg_set_path
{
197 struct msg_set_iface_params
{
201 struct msg_iscsi_ping
{
205 uint32_t payload_size
;
206 uint32_t pid
; /* unique ping id associated
207 with each ping request */
209 struct msg_get_chap
{
211 uint32_t num_entries
; /* number of CHAP entries
212 * on request, number of
213 * valid CHAP entries on
215 uint16_t chap_tbl_idx
;
217 struct msg_delete_chap
{
219 uint16_t chap_tbl_idx
;
221 struct msg_set_flashnode_param
{
223 uint32_t flashnode_idx
;
226 struct msg_new_flashnode
{
230 struct msg_del_flashnode
{
232 uint32_t flashnode_idx
;
234 struct msg_login_flashnode
{
236 uint32_t flashnode_idx
;
238 struct msg_logout_flashnode
{
240 uint32_t flashnode_idx
;
242 struct msg_logout_flashnode_sid
{
245 } logout_flashnode_sid
;
246 struct msg_get_host_stats
{
251 /* messages k -> u */
253 struct msg_create_session_ret
{
257 struct msg_create_conn_ret
{
261 struct msg_unbind_session
{
265 struct msg_recv_req
{
268 uint64_t recv_handle
;
270 struct msg_conn_login
{
273 uint32_t state
; /* enum iscsi_conn_state */
275 struct msg_conn_error
{
278 uint32_t error
; /* enum iscsi_err */
280 struct msg_session_destroyed
{
284 struct msg_transport_connect_ret
{
287 struct msg_req_path
{
290 struct msg_notify_if_down
{
293 struct msg_host_event
{
296 enum iscsi_host_event_code code
;
298 struct msg_ping_comp
{
300 uint32_t status
; /* enum
301 * iscsi_ping_status_code */
302 uint32_t pid
; /* unique ping id associated
303 with each ping request */
306 struct msg_new_flashnode_ret
{
307 uint32_t flashnode_idx
;
310 } __attribute__ ((aligned (sizeof(uint64_t))));
312 enum iscsi_param_type
{
313 ISCSI_PARAM
, /* iscsi_param (session, conn, target, LU) */
314 ISCSI_HOST_PARAM
, /* iscsi_host_param */
315 ISCSI_NET_PARAM
, /* iscsi_net_param */
316 ISCSI_FLASHNODE_PARAM
, /* iscsi_flashnode_param */
317 ISCSI_CHAP_PARAM
, /* iscsi_chap_param */
318 ISCSI_IFACE_PARAM
, /* iscsi_iface_param */
321 /* structure for minimalist usecase */
322 struct iscsi_param_info
{
323 uint32_t len
; /* Actual length of the param value */
324 uint16_t param
; /* iscsi param */
325 uint8_t value
[0]; /* length sized value follows */
328 struct iscsi_iface_param_info
{
329 uint32_t iface_num
; /* iface number, 0 - n */
330 uint32_t len
; /* Actual length of the param */
331 uint16_t param
; /* iscsi param value */
332 uint8_t iface_type
; /* IPv4 or IPv6 */
333 uint8_t param_type
; /* iscsi_param_type */
334 uint8_t value
[0]; /* length sized value follows */
338 * To keep the struct iscsi_uevent size the same for userspace code
339 * compatibility, the main structure for ISCSI_UEVENT_PATH_UPDATE and
340 * ISCSI_KEVENT_PATH_REQ is defined separately and comes after the
341 * struct iscsi_uevent in the NETLINK_ISCSI message.
346 uint8_t mac_addr_old
[6];
347 uint32_t ip_addr_len
; /* 4 or 16 */
349 struct in_addr v4_addr
;
350 struct in6_addr v6_addr
;
353 struct in_addr v4_addr
;
354 struct in6_addr v6_addr
;
358 } __attribute__ ((aligned (sizeof(uint64_t))));
360 /* iscsi iface enabled/disabled setting */
361 #define ISCSI_IFACE_DISABLE 0x01
362 #define ISCSI_IFACE_ENABLE 0x02
365 #define ISCSI_BOOTPROTO_STATIC 0x01
366 #define ISCSI_BOOTPROTO_DHCP 0x02
368 /* ipv6 addr autoconfig type */
369 #define ISCSI_IPV6_AUTOCFG_DISABLE 0x01
370 #define ISCSI_IPV6_AUTOCFG_ND_ENABLE 0x02
371 #define ISCSI_IPV6_AUTOCFG_DHCPV6_ENABLE 0x03
373 /* ipv6 link local addr type */
374 #define ISCSI_IPV6_LINKLOCAL_AUTOCFG_ENABLE 0x01
375 #define ISCSI_IPV6_LINKLOCAL_AUTOCFG_DISABLE 0x02
377 /* ipv6 router addr type */
378 #define ISCSI_IPV6_ROUTER_AUTOCFG_ENABLE 0x01
379 #define ISCSI_IPV6_ROUTER_AUTOCFG_DISABLE 0x02
381 #define ISCSI_IFACE_TYPE_IPV4 0x01
382 #define ISCSI_IFACE_TYPE_IPV6 0x02
384 #define ISCSI_MAX_VLAN_ID 4095
385 #define ISCSI_MAX_VLAN_PRIORITY 7
387 /* iscsi vlan enable/disabled setting */
388 #define ISCSI_VLAN_DISABLE 0x01
389 #define ISCSI_VLAN_ENABLE 0x02
391 /* iscsi generic enable/disabled setting for various features */
392 #define ISCSI_NET_PARAM_DISABLE 0x01
393 #define ISCSI_NET_PARAM_ENABLE 0x02
395 /* iSCSI network params */
396 enum iscsi_net_param
{
397 ISCSI_NET_PARAM_IPV4_ADDR
= 1,
398 ISCSI_NET_PARAM_IPV4_SUBNET
,
399 ISCSI_NET_PARAM_IPV4_GW
,
400 ISCSI_NET_PARAM_IPV4_BOOTPROTO
,
402 ISCSI_NET_PARAM_IPV6_LINKLOCAL
,
403 ISCSI_NET_PARAM_IPV6_ADDR
,
404 ISCSI_NET_PARAM_IPV6_ROUTER
,
405 ISCSI_NET_PARAM_IPV6_ADDR_AUTOCFG
,
406 ISCSI_NET_PARAM_IPV6_LINKLOCAL_AUTOCFG
,
407 ISCSI_NET_PARAM_IPV6_ROUTER_AUTOCFG
,
408 ISCSI_NET_PARAM_IFACE_ENABLE
,
409 ISCSI_NET_PARAM_VLAN_ID
,
410 ISCSI_NET_PARAM_VLAN_PRIORITY
,
411 ISCSI_NET_PARAM_VLAN_ENABLED
,
412 ISCSI_NET_PARAM_VLAN_TAG
,
413 ISCSI_NET_PARAM_IFACE_TYPE
,
414 ISCSI_NET_PARAM_IFACE_NAME
,
416 ISCSI_NET_PARAM_PORT
,
417 ISCSI_NET_PARAM_IPADDR_STATE
,
418 ISCSI_NET_PARAM_IPV6_LINKLOCAL_STATE
,
419 ISCSI_NET_PARAM_IPV6_ROUTER_STATE
,
420 ISCSI_NET_PARAM_DELAYED_ACK_EN
,
421 ISCSI_NET_PARAM_TCP_NAGLE_DISABLE
,
422 ISCSI_NET_PARAM_TCP_WSF_DISABLE
,
423 ISCSI_NET_PARAM_TCP_WSF
,
424 ISCSI_NET_PARAM_TCP_TIMER_SCALE
,
425 ISCSI_NET_PARAM_TCP_TIMESTAMP_EN
,
426 ISCSI_NET_PARAM_CACHE_ID
,
427 ISCSI_NET_PARAM_IPV4_DHCP_DNS_ADDR_EN
,
428 ISCSI_NET_PARAM_IPV4_DHCP_SLP_DA_EN
,
429 ISCSI_NET_PARAM_IPV4_TOS_EN
,
430 ISCSI_NET_PARAM_IPV4_TOS
,
431 ISCSI_NET_PARAM_IPV4_GRAT_ARP_EN
,
432 ISCSI_NET_PARAM_IPV4_DHCP_ALT_CLIENT_ID_EN
,
433 ISCSI_NET_PARAM_IPV4_DHCP_ALT_CLIENT_ID
,
434 ISCSI_NET_PARAM_IPV4_DHCP_REQ_VENDOR_ID_EN
,
435 ISCSI_NET_PARAM_IPV4_DHCP_USE_VENDOR_ID_EN
,
436 ISCSI_NET_PARAM_IPV4_DHCP_VENDOR_ID
,
437 ISCSI_NET_PARAM_IPV4_DHCP_LEARN_IQN_EN
,
438 ISCSI_NET_PARAM_IPV4_FRAGMENT_DISABLE
,
439 ISCSI_NET_PARAM_IPV4_IN_FORWARD_EN
,
440 ISCSI_NET_PARAM_IPV4_TTL
,
441 ISCSI_NET_PARAM_IPV6_GRAT_NEIGHBOR_ADV_EN
,
442 ISCSI_NET_PARAM_IPV6_MLD_EN
,
443 ISCSI_NET_PARAM_IPV6_FLOW_LABEL
,
444 ISCSI_NET_PARAM_IPV6_TRAFFIC_CLASS
,
445 ISCSI_NET_PARAM_IPV6_HOP_LIMIT
,
446 ISCSI_NET_PARAM_IPV6_ND_REACHABLE_TMO
,
447 ISCSI_NET_PARAM_IPV6_ND_REXMIT_TIME
,
448 ISCSI_NET_PARAM_IPV6_ND_STALE_TMO
,
449 ISCSI_NET_PARAM_IPV6_DUP_ADDR_DETECT_CNT
,
450 ISCSI_NET_PARAM_IPV6_RTR_ADV_LINK_MTU
,
451 ISCSI_NET_PARAM_REDIRECT_EN
,
454 enum iscsi_ipaddress_state
{
455 ISCSI_IPDDRESS_STATE_UNCONFIGURED
,
456 ISCSI_IPDDRESS_STATE_ACQUIRING
,
457 ISCSI_IPDDRESS_STATE_TENTATIVE
,
458 ISCSI_IPDDRESS_STATE_VALID
,
459 ISCSI_IPDDRESS_STATE_DISABLING
,
460 ISCSI_IPDDRESS_STATE_INVALID
,
461 ISCSI_IPDDRESS_STATE_DEPRECATED
,
464 enum iscsi_router_state
{
465 ISCSI_ROUTER_STATE_UNKNOWN
,
466 ISCSI_ROUTER_STATE_ADVERTISED
,
467 ISCSI_ROUTER_STATE_MANUAL
,
468 ISCSI_ROUTER_STATE_STALE
,
471 /* iSCSI specific settings params for iface */
472 enum iscsi_iface_param
{
473 ISCSI_IFACE_PARAM_DEF_TASKMGMT_TMO
,
474 ISCSI_IFACE_PARAM_HDRDGST_EN
,
475 ISCSI_IFACE_PARAM_DATADGST_EN
,
476 ISCSI_IFACE_PARAM_IMM_DATA_EN
,
477 ISCSI_IFACE_PARAM_INITIAL_R2T_EN
,
478 ISCSI_IFACE_PARAM_DATASEQ_INORDER_EN
,
479 ISCSI_IFACE_PARAM_PDU_INORDER_EN
,
480 ISCSI_IFACE_PARAM_ERL
,
481 ISCSI_IFACE_PARAM_MAX_RECV_DLENGTH
,
482 ISCSI_IFACE_PARAM_FIRST_BURST
,
483 ISCSI_IFACE_PARAM_MAX_R2T
,
484 ISCSI_IFACE_PARAM_MAX_BURST
,
485 ISCSI_IFACE_PARAM_CHAP_AUTH_EN
,
486 ISCSI_IFACE_PARAM_BIDI_CHAP_EN
,
487 ISCSI_IFACE_PARAM_DISCOVERY_AUTH_OPTIONAL
,
488 ISCSI_IFACE_PARAM_DISCOVERY_LOGOUT_EN
,
489 ISCSI_IFACE_PARAM_STRICT_LOGIN_COMP_EN
,
490 ISCSI_IFACE_PARAM_INITIATOR_NAME
,
493 enum iscsi_conn_state
{
494 ISCSI_CONN_STATE_FREE
,
495 ISCSI_CONN_STATE_XPT_WAIT
,
496 ISCSI_CONN_STATE_IN_LOGIN
,
497 ISCSI_CONN_STATE_LOGGED_IN
,
498 ISCSI_CONN_STATE_IN_LOGOUT
,
499 ISCSI_CONN_STATE_LOGOUT_REQUESTED
,
500 ISCSI_CONN_STATE_CLEANUP_WAIT
,
509 ISCSI_ERR_DATASN
= ISCSI_ERR_BASE
+ 1,
510 ISCSI_ERR_DATA_OFFSET
= ISCSI_ERR_BASE
+ 2,
511 ISCSI_ERR_MAX_CMDSN
= ISCSI_ERR_BASE
+ 3,
512 ISCSI_ERR_EXP_CMDSN
= ISCSI_ERR_BASE
+ 4,
513 ISCSI_ERR_BAD_OPCODE
= ISCSI_ERR_BASE
+ 5,
514 ISCSI_ERR_DATALEN
= ISCSI_ERR_BASE
+ 6,
515 ISCSI_ERR_AHSLEN
= ISCSI_ERR_BASE
+ 7,
516 ISCSI_ERR_PROTO
= ISCSI_ERR_BASE
+ 8,
517 ISCSI_ERR_LUN
= ISCSI_ERR_BASE
+ 9,
518 ISCSI_ERR_BAD_ITT
= ISCSI_ERR_BASE
+ 10,
519 ISCSI_ERR_CONN_FAILED
= ISCSI_ERR_BASE
+ 11,
520 ISCSI_ERR_R2TSN
= ISCSI_ERR_BASE
+ 12,
521 ISCSI_ERR_SESSION_FAILED
= ISCSI_ERR_BASE
+ 13,
522 ISCSI_ERR_HDR_DGST
= ISCSI_ERR_BASE
+ 14,
523 ISCSI_ERR_DATA_DGST
= ISCSI_ERR_BASE
+ 15,
524 ISCSI_ERR_PARAM_NOT_FOUND
= ISCSI_ERR_BASE
+ 16,
525 ISCSI_ERR_NO_SCSI_CMD
= ISCSI_ERR_BASE
+ 17,
526 ISCSI_ERR_INVALID_HOST
= ISCSI_ERR_BASE
+ 18,
527 ISCSI_ERR_XMIT_FAILED
= ISCSI_ERR_BASE
+ 19,
528 ISCSI_ERR_TCP_CONN_CLOSE
= ISCSI_ERR_BASE
+ 20,
529 ISCSI_ERR_SCSI_EH_SESSION_RST
= ISCSI_ERR_BASE
+ 21,
530 ISCSI_ERR_NOP_TIMEDOUT
= ISCSI_ERR_BASE
+ 22,
534 * iSCSI Parameters (RFC3720)
537 /* passed in using netlink set param */
538 ISCSI_PARAM_MAX_RECV_DLENGTH
,
539 ISCSI_PARAM_MAX_XMIT_DLENGTH
,
540 ISCSI_PARAM_HDRDGST_EN
,
541 ISCSI_PARAM_DATADGST_EN
,
542 ISCSI_PARAM_INITIAL_R2T_EN
,
544 ISCSI_PARAM_IMM_DATA_EN
,
545 ISCSI_PARAM_FIRST_BURST
,
546 ISCSI_PARAM_MAX_BURST
,
547 ISCSI_PARAM_PDU_INORDER_EN
,
548 ISCSI_PARAM_DATASEQ_INORDER_EN
,
550 ISCSI_PARAM_IFMARKER_EN
,
551 ISCSI_PARAM_OFMARKER_EN
,
552 ISCSI_PARAM_EXP_STATSN
,
553 ISCSI_PARAM_TARGET_NAME
,
555 ISCSI_PARAM_PERSISTENT_ADDRESS
,
556 ISCSI_PARAM_PERSISTENT_PORT
,
557 ISCSI_PARAM_SESS_RECOVERY_TMO
,
559 /* passed in through bind conn using transport_fd */
560 ISCSI_PARAM_CONN_PORT
,
561 ISCSI_PARAM_CONN_ADDRESS
,
563 ISCSI_PARAM_USERNAME
,
564 ISCSI_PARAM_USERNAME_IN
,
565 ISCSI_PARAM_PASSWORD
,
566 ISCSI_PARAM_PASSWORD_IN
,
568 ISCSI_PARAM_FAST_ABORT
,
569 ISCSI_PARAM_ABORT_TMO
,
570 ISCSI_PARAM_LU_RESET_TMO
,
571 ISCSI_PARAM_HOST_RESET_TMO
,
573 ISCSI_PARAM_PING_TMO
,
574 ISCSI_PARAM_RECV_TMO
,
576 ISCSI_PARAM_IFACE_NAME
,
578 ISCSI_PARAM_INITIATOR_NAME
,
580 ISCSI_PARAM_TGT_RESET_TMO
,
581 ISCSI_PARAM_TARGET_ALIAS
,
583 ISCSI_PARAM_CHAP_IN_IDX
,
584 ISCSI_PARAM_CHAP_OUT_IDX
,
586 ISCSI_PARAM_BOOT_ROOT
,
587 ISCSI_PARAM_BOOT_NIC
,
588 ISCSI_PARAM_BOOT_TARGET
,
590 ISCSI_PARAM_AUTO_SND_TGT_DISABLE
,
591 ISCSI_PARAM_DISCOVERY_SESS
,
592 ISCSI_PARAM_PORTAL_TYPE
,
593 ISCSI_PARAM_CHAP_AUTH_EN
,
594 ISCSI_PARAM_DISCOVERY_LOGOUT_EN
,
595 ISCSI_PARAM_BIDI_CHAP_EN
,
596 ISCSI_PARAM_DISCOVERY_AUTH_OPTIONAL
,
598 ISCSI_PARAM_DEF_TIME2WAIT
,
599 ISCSI_PARAM_DEF_TIME2RETAIN
,
600 ISCSI_PARAM_MAX_SEGMENT_SIZE
,
602 ISCSI_PARAM_KEEPALIVE_TMO
,
603 ISCSI_PARAM_LOCAL_PORT
,
605 ISCSI_PARAM_DEF_TASKMGMT_TMO
,
607 ISCSI_PARAM_TCP_TIMESTAMP_STAT
,
608 ISCSI_PARAM_TCP_WSF_DISABLE
,
609 ISCSI_PARAM_TCP_NAGLE_DISABLE
,
610 ISCSI_PARAM_TCP_TIMER_SCALE
,
611 ISCSI_PARAM_TCP_TIMESTAMP_EN
,
612 ISCSI_PARAM_TCP_XMIT_WSF
,
613 ISCSI_PARAM_TCP_RECV_WSF
,
614 ISCSI_PARAM_IP_FRAGMENT_DISABLE
,
615 ISCSI_PARAM_IPV4_TOS
,
617 ISCSI_PARAM_IPV6_FLOW_LABEL
,
618 ISCSI_PARAM_IS_FW_ASSIGNED_IPV6
,
620 ISCSI_PARAM_DISCOVERY_PARENT_IDX
,
621 ISCSI_PARAM_DISCOVERY_PARENT_TYPE
,
622 ISCSI_PARAM_LOCAL_IPADDR
,
623 /* must always be last */
627 /* iSCSI HBA params */
628 enum iscsi_host_param
{
629 ISCSI_HOST_PARAM_HWADDRESS
,
630 ISCSI_HOST_PARAM_INITIATOR_NAME
,
631 ISCSI_HOST_PARAM_NETDEV_NAME
,
632 ISCSI_HOST_PARAM_IPADDRESS
,
633 ISCSI_HOST_PARAM_PORT_STATE
,
634 ISCSI_HOST_PARAM_PORT_SPEED
,
635 ISCSI_HOST_PARAM_MAX
,
639 #define PORTAL_TYPE_IPV4 "ipv4"
640 #define PORTAL_TYPE_IPV6 "ipv6"
642 /* iSCSI Flash Target params */
643 enum iscsi_flashnode_param
{
644 ISCSI_FLASHNODE_IS_FW_ASSIGNED_IPV6
,
645 ISCSI_FLASHNODE_PORTAL_TYPE
,
646 ISCSI_FLASHNODE_AUTO_SND_TGT_DISABLE
,
647 ISCSI_FLASHNODE_DISCOVERY_SESS
,
648 ISCSI_FLASHNODE_ENTRY_EN
,
649 ISCSI_FLASHNODE_HDR_DGST_EN
,
650 ISCSI_FLASHNODE_DATA_DGST_EN
,
651 ISCSI_FLASHNODE_IMM_DATA_EN
,
652 ISCSI_FLASHNODE_INITIAL_R2T_EN
,
653 ISCSI_FLASHNODE_DATASEQ_INORDER
,
654 ISCSI_FLASHNODE_PDU_INORDER
,
655 ISCSI_FLASHNODE_CHAP_AUTH_EN
,
656 ISCSI_FLASHNODE_SNACK_REQ_EN
,
657 ISCSI_FLASHNODE_DISCOVERY_LOGOUT_EN
,
658 ISCSI_FLASHNODE_BIDI_CHAP_EN
,
659 /* make authentication for discovery sessions optional */
660 ISCSI_FLASHNODE_DISCOVERY_AUTH_OPTIONAL
,
662 ISCSI_FLASHNODE_TCP_TIMESTAMP_STAT
,
663 ISCSI_FLASHNODE_TCP_NAGLE_DISABLE
,
664 ISCSI_FLASHNODE_TCP_WSF_DISABLE
,
665 ISCSI_FLASHNODE_TCP_TIMER_SCALE
,
666 ISCSI_FLASHNODE_TCP_TIMESTAMP_EN
,
667 ISCSI_FLASHNODE_IP_FRAG_DISABLE
,
668 ISCSI_FLASHNODE_MAX_RECV_DLENGTH
,
669 ISCSI_FLASHNODE_MAX_XMIT_DLENGTH
,
670 ISCSI_FLASHNODE_FIRST_BURST
,
671 ISCSI_FLASHNODE_DEF_TIME2WAIT
,
672 ISCSI_FLASHNODE_DEF_TIME2RETAIN
,
673 ISCSI_FLASHNODE_MAX_R2T
,
674 ISCSI_FLASHNODE_KEEPALIVE_TMO
,
675 ISCSI_FLASHNODE_ISID
,
676 ISCSI_FLASHNODE_TSID
,
677 ISCSI_FLASHNODE_PORT
,
678 ISCSI_FLASHNODE_MAX_BURST
,
679 ISCSI_FLASHNODE_DEF_TASKMGMT_TMO
,
680 ISCSI_FLASHNODE_IPADDR
,
681 ISCSI_FLASHNODE_ALIAS
,
682 ISCSI_FLASHNODE_REDIRECT_IPADDR
,
683 ISCSI_FLASHNODE_MAX_SEGMENT_SIZE
,
684 ISCSI_FLASHNODE_LOCAL_PORT
,
685 ISCSI_FLASHNODE_IPV4_TOS
,
686 ISCSI_FLASHNODE_IPV6_TC
,
687 ISCSI_FLASHNODE_IPV6_FLOW_LABEL
,
688 ISCSI_FLASHNODE_NAME
,
689 ISCSI_FLASHNODE_TPGT
,
690 ISCSI_FLASHNODE_LINK_LOCAL_IPV6
,
691 ISCSI_FLASHNODE_DISCOVERY_PARENT_IDX
,
692 ISCSI_FLASHNODE_DISCOVERY_PARENT_TYPE
,
693 ISCSI_FLASHNODE_TCP_XMIT_WSF
,
694 ISCSI_FLASHNODE_TCP_RECV_WSF
,
695 ISCSI_FLASHNODE_CHAP_IN_IDX
,
696 ISCSI_FLASHNODE_CHAP_OUT_IDX
,
697 ISCSI_FLASHNODE_USERNAME
,
698 ISCSI_FLASHNODE_USERNAME_IN
,
699 ISCSI_FLASHNODE_PASSWORD
,
700 ISCSI_FLASHNODE_PASSWORD_IN
,
701 ISCSI_FLASHNODE_STATSN
,
702 ISCSI_FLASHNODE_EXP_STATSN
,
703 ISCSI_FLASHNODE_IS_BOOT_TGT
,
708 struct iscsi_flashnode_param_info
{
709 uint32_t len
; /* Actual length of the param */
710 uint16_t param
; /* iscsi param value */
711 uint8_t value
[0]; /* length sized value follows */
714 enum iscsi_discovery_parent_type
{
715 ISCSI_DISC_PARENT_UNKNOWN
= 0x1,
716 ISCSI_DISC_PARENT_SENDTGT
= 0x2,
717 ISCSI_DISC_PARENT_ISNS
= 0x3,
720 /* iSCSI port Speed */
721 enum iscsi_port_speed
{
722 ISCSI_PORT_SPEED_UNKNOWN
= 0x1,
723 ISCSI_PORT_SPEED_10MBPS
= 0x2,
724 ISCSI_PORT_SPEED_100MBPS
= 0x4,
725 ISCSI_PORT_SPEED_1GBPS
= 0x8,
726 ISCSI_PORT_SPEED_10GBPS
= 0x10,
729 /* iSCSI port state */
730 enum iscsi_port_state
{
731 ISCSI_PORT_STATE_DOWN
= 0x1,
732 ISCSI_PORT_STATE_UP
= 0x2,
735 /* iSCSI PING status/error code */
736 enum iscsi_ping_status_code
{
737 ISCSI_PING_SUCCESS
= 0,
738 ISCSI_PING_FW_DISABLED
= 0x1,
739 ISCSI_PING_IPADDR_INVALID
= 0x2,
740 ISCSI_PING_LINKLOCAL_IPV6_ADDR_INVALID
= 0x3,
741 ISCSI_PING_TIMEOUT
= 0x4,
742 ISCSI_PING_INVALID_DEST_ADDR
= 0x5,
743 ISCSI_PING_OVERSIZE_PACKET
= 0x6,
744 ISCSI_PING_ICMP_ERROR
= 0x7,
745 ISCSI_PING_MAX_REQ_EXCEEDED
= 0x8,
746 ISCSI_PING_NO_ARP_RECEIVED
= 0x9,
749 #define iscsi_ptr(_handle) ((void*)(unsigned long)_handle)
750 #define iscsi_handle(_ptr) ((uint64_t)(unsigned long)_ptr)
753 * These flags presents iSCSI Data-Path capabilities.
755 #define CAP_RECOVERY_L0 0x1
756 #define CAP_RECOVERY_L1 0x2
757 #define CAP_RECOVERY_L2 0x4
758 #define CAP_MULTI_R2T 0x8
759 #define CAP_HDRDGST 0x10
760 #define CAP_DATADGST 0x20
761 #define CAP_MULTI_CONN 0x40
762 #define CAP_TEXT_NEGO 0x80
763 #define CAP_MARKERS 0x100
764 #define CAP_FW_DB 0x200
765 #define CAP_SENDTARGETS_OFFLOAD 0x400 /* offload discovery process */
766 #define CAP_DATA_PATH_OFFLOAD 0x800 /* offload entire IO path */
767 #define CAP_DIGEST_OFFLOAD 0x1000 /* offload hdr and data digests */
768 #define CAP_PADDING_OFFLOAD 0x2000 /* offload padding insertion, removal,
770 #define CAP_LOGIN_OFFLOAD 0x4000 /* offload session login */
773 * These flags describes reason of stop_conn() call
775 #define STOP_CONN_TERM 0x1
776 #define STOP_CONN_SUSPEND 0x2
777 #define STOP_CONN_RECOVER 0x3
779 #define ISCSI_STATS_CUSTOM_MAX 32
780 #define ISCSI_STATS_CUSTOM_DESC_MAX 64
781 struct iscsi_stats_custom
{
782 char desc
[ISCSI_STATS_CUSTOM_DESC_MAX
];
787 * struct iscsi_stats - iSCSI Statistics (iSCSI MIB)
789 * Note: this structure contains counters collected on per-connection basis.
793 uint64_t txdata_octets
;
794 uint64_t rxdata_octets
;
798 uint32_t scsicmd_pdus
;
799 uint32_t tmfcmd_pdus
;
802 uint32_t dataout_pdus
;
803 uint32_t logout_pdus
;
808 uint32_t scsirsp_pdus
;
809 uint32_t tmfrsp_pdus
;
810 uint32_t textrsp_pdus
;
811 uint32_t datain_pdus
;
812 uint32_t logoutrsp_pdus
;
819 uint32_t timeout_err
;
822 * iSCSI Custom Statistics support, i.e. Transport could
823 * extend existing MIB statistics with its own specific statistics
824 * up to ISCSI_STATS_CUSTOM_MAX
826 uint32_t custom_length
;
827 struct iscsi_stats_custom custom
[0]
828 __attribute__ ((aligned (sizeof(uint64_t))));
836 enum iscsi_chap_param
{
837 ISCSI_CHAP_PARAM_INDEX
,
838 ISCSI_CHAP_PARAM_CHAP_TYPE
,
839 ISCSI_CHAP_PARAM_USERNAME
,
840 ISCSI_CHAP_PARAM_PASSWORD
,
841 ISCSI_CHAP_PARAM_PASSWORD_LEN
844 #define ISCSI_CHAP_AUTH_NAME_MAX_LEN 256
845 #define ISCSI_CHAP_AUTH_SECRET_MAX_LEN 256
846 struct iscsi_chap_rec
{
847 uint16_t chap_tbl_idx
;
848 enum chap_type_e chap_type
;
849 char username
[ISCSI_CHAP_AUTH_NAME_MAX_LEN
];
850 uint8_t password
[ISCSI_CHAP_AUTH_SECRET_MAX_LEN
];
851 uint8_t password_length
;
854 #define ISCSI_HOST_STATS_CUSTOM_MAX 32
855 #define ISCSI_HOST_STATS_CUSTOM_DESC_MAX 64
856 struct iscsi_host_stats_custom
{
857 char desc
[ISCSI_HOST_STATS_CUSTOM_DESC_MAX
];
861 /* struct iscsi_offload_host_stats: Host statistics,
862 * Include statistics for MAC, IP, TCP & iSCSI.
864 struct iscsi_offload_host_stats
{
866 uint64_t mactx_frames
;
867 uint64_t mactx_bytes
;
868 uint64_t mactx_multicast_frames
;
869 uint64_t mactx_broadcast_frames
;
870 uint64_t mactx_pause_frames
;
871 uint64_t mactx_control_frames
;
872 uint64_t mactx_deferral
;
873 uint64_t mactx_excess_deferral
;
874 uint64_t mactx_late_collision
;
875 uint64_t mactx_abort
;
876 uint64_t mactx_single_collision
;
877 uint64_t mactx_multiple_collision
;
878 uint64_t mactx_collision
;
879 uint64_t mactx_frames_dropped
;
880 uint64_t mactx_jumbo_frames
;
881 uint64_t macrx_frames
;
882 uint64_t macrx_bytes
;
883 uint64_t macrx_unknown_control_frames
;
884 uint64_t macrx_pause_frames
;
885 uint64_t macrx_control_frames
;
886 uint64_t macrx_dribble
;
887 uint64_t macrx_frame_length_error
;
888 uint64_t macrx_jabber
;
889 uint64_t macrx_carrier_sense_error
;
890 uint64_t macrx_frame_discarded
;
891 uint64_t macrx_frames_dropped
;
892 uint64_t mac_crc_error
;
893 uint64_t mac_encoding_error
;
894 uint64_t macrx_length_error_large
;
895 uint64_t macrx_length_error_small
;
896 uint64_t macrx_multicast_frames
;
897 uint64_t macrx_broadcast_frames
;
899 uint64_t iptx_packets
;
901 uint64_t iptx_fragments
;
902 uint64_t iprx_packets
;
904 uint64_t iprx_fragments
;
905 uint64_t ip_datagram_reassembly
;
906 uint64_t ip_invalid_address_error
;
907 uint64_t ip_error_packets
;
908 uint64_t ip_fragrx_overlap
;
909 uint64_t ip_fragrx_outoforder
;
910 uint64_t ip_datagram_reassembly_timeout
;
911 uint64_t ipv6tx_packets
;
912 uint64_t ipv6tx_bytes
;
913 uint64_t ipv6tx_fragments
;
914 uint64_t ipv6rx_packets
;
915 uint64_t ipv6rx_bytes
;
916 uint64_t ipv6rx_fragments
;
917 uint64_t ipv6_datagram_reassembly
;
918 uint64_t ipv6_invalid_address_error
;
919 uint64_t ipv6_error_packets
;
920 uint64_t ipv6_fragrx_overlap
;
921 uint64_t ipv6_fragrx_outoforder
;
922 uint64_t ipv6_datagram_reassembly_timeout
;
924 uint64_t tcptx_segments
;
925 uint64_t tcptx_bytes
;
926 uint64_t tcprx_segments
;
928 uint64_t tcp_duplicate_ack_retx
;
929 uint64_t tcp_retx_timer_expired
;
930 uint64_t tcprx_duplicate_ack
;
931 uint64_t tcprx_pure_ackr
;
932 uint64_t tcptx_delayed_ack
;
933 uint64_t tcptx_pure_ack
;
934 uint64_t tcprx_segment_error
;
935 uint64_t tcprx_segment_outoforder
;
936 uint64_t tcprx_window_probe
;
937 uint64_t tcprx_window_update
;
938 uint64_t tcptx_window_probe_persist
;
940 uint64_t ecc_error_correction
;
942 uint64_t iscsi_pdu_tx
;
943 uint64_t iscsi_data_bytes_tx
;
944 uint64_t iscsi_pdu_rx
;
945 uint64_t iscsi_data_bytes_rx
;
946 uint64_t iscsi_io_completed
;
947 uint64_t iscsi_unexpected_io_rx
;
948 uint64_t iscsi_format_error
;
949 uint64_t iscsi_hdr_digest_error
;
950 uint64_t iscsi_data_digest_error
;
951 uint64_t iscsi_sequence_error
;
953 * iSCSI Custom Host Statistics support, i.e. Transport could
954 * extend existing host statistics with its own specific statistics
955 * up to ISCSI_HOST_STATS_CUSTOM_MAX
957 uint32_t custom_length
;
958 struct iscsi_host_stats_custom custom
[0]
959 __aligned(sizeof(uint64_t));