[mirror_ubuntu-bionic-kernel.git] / include / scsi / iscsi_if.h

/*
 * iSCSI User/Kernel Shares (Defines, Constants, Protocol definitions, etc)
 *
 * Copyright (C) 2005 Dmitry Yusupov
 * Copyright (C) 2005 Alex Aizman
 * maintained by open-iscsi@googlegroups.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * See the file COPYING included with this distribution for more details.
 */

#ifndef ISCSI_IF_H
#define ISCSI_IF_H

#include <scsi/iscsi_proto.h>
#include <linux/in.h>
#include <linux/in6.h>

#define ISCSI_NL_GRP_ISCSID	1
#define ISCSI_NL_GRP_UIP	2

#define UEVENT_BASE			10
#define KEVENT_BASE			100
#define ISCSI_ERR_BASE			1000

enum iscsi_uevent_e {
	ISCSI_UEVENT_UNKNOWN		= 0,

	/* down events */
	ISCSI_UEVENT_CREATE_SESSION	= UEVENT_BASE + 1,
	ISCSI_UEVENT_DESTROY_SESSION	= UEVENT_BASE + 2,
	ISCSI_UEVENT_CREATE_CONN	= UEVENT_BASE + 3,
	ISCSI_UEVENT_DESTROY_CONN	= UEVENT_BASE + 4,
	ISCSI_UEVENT_BIND_CONN		= UEVENT_BASE + 5,
	ISCSI_UEVENT_SET_PARAM		= UEVENT_BASE + 6,
	ISCSI_UEVENT_START_CONN		= UEVENT_BASE + 7,
	ISCSI_UEVENT_STOP_CONN		= UEVENT_BASE + 8,
	ISCSI_UEVENT_SEND_PDU		= UEVENT_BASE + 9,
	ISCSI_UEVENT_GET_STATS		= UEVENT_BASE + 10,
	ISCSI_UEVENT_GET_PARAM		= UEVENT_BASE + 11,

	ISCSI_UEVENT_TRANSPORT_EP_CONNECT	= UEVENT_BASE + 12,
	ISCSI_UEVENT_TRANSPORT_EP_POLL		= UEVENT_BASE + 13,
	ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT	= UEVENT_BASE + 14,

	ISCSI_UEVENT_TGT_DSCVR		= UEVENT_BASE + 15,
	ISCSI_UEVENT_SET_HOST_PARAM	= UEVENT_BASE + 16,
	ISCSI_UEVENT_UNBIND_SESSION	= UEVENT_BASE + 17,
	ISCSI_UEVENT_CREATE_BOUND_SESSION		= UEVENT_BASE + 18,
	ISCSI_UEVENT_TRANSPORT_EP_CONNECT_THROUGH_HOST	= UEVENT_BASE + 19,

	ISCSI_UEVENT_PATH_UPDATE	= UEVENT_BASE + 20,
	ISCSI_UEVENT_SET_IFACE_PARAMS	= UEVENT_BASE + 21,

	/* up events */
	ISCSI_KEVENT_RECV_PDU		= KEVENT_BASE + 1,
	ISCSI_KEVENT_CONN_ERROR		= KEVENT_BASE + 2,
	ISCSI_KEVENT_IF_ERROR		= KEVENT_BASE + 3,
	ISCSI_KEVENT_DESTROY_SESSION	= KEVENT_BASE + 4,
	ISCSI_KEVENT_UNBIND_SESSION	= KEVENT_BASE + 5,
	ISCSI_KEVENT_CREATE_SESSION	= KEVENT_BASE + 6,

	ISCSI_KEVENT_PATH_REQ		= KEVENT_BASE + 7,
	ISCSI_KEVENT_IF_DOWN		= KEVENT_BASE + 8,
	ISCSI_KEVENT_CONN_LOGIN_STATE   = KEVENT_BASE + 9,
};

enum iscsi_tgt_dscvr {
	ISCSI_TGT_DSCVR_SEND_TARGETS	= 1,
	ISCSI_TGT_DSCVR_ISNS		= 2,
	ISCSI_TGT_DSCVR_SLP		= 3,
};

struct iscsi_uevent {
	uint32_t type; /* k/u events type */
	uint32_t iferror; /* carries interface or resource errors */
	uint64_t transport_handle;

	union {
		/* messages u -> k */
		struct msg_create_session {
			uint32_t	initial_cmdsn;
			uint16_t	cmds_max;
			uint16_t	queue_depth;
		} c_session;
		struct msg_create_bound_session {
			uint64_t	ep_handle;
			uint32_t	initial_cmdsn;
			uint16_t	cmds_max;
			uint16_t	queue_depth;
		} c_bound_session;
		struct msg_destroy_session {
			uint32_t	sid;
		} d_session;
		struct msg_create_conn {
			uint32_t	sid;
			uint32_t	cid;
		} c_conn;
		struct msg_bind_conn {
			uint32_t	sid;
			uint32_t	cid;
			uint64_t	transport_eph;
			uint32_t	is_leading;
		} b_conn;
		struct msg_destroy_conn {
			uint32_t	sid;
			uint32_t	cid;
		} d_conn;
		struct msg_send_pdu {
			uint32_t	sid;
			uint32_t	cid;
			uint32_t	hdr_size;
			uint32_t	data_size;
		} send_pdu;
		struct msg_set_param {
			uint32_t	sid;
			uint32_t	cid;
			uint32_t	param; /* enum iscsi_param */
			uint32_t	len;
		} set_param;
		struct msg_start_conn {
			uint32_t	sid;
			uint32_t	cid;
		} start_conn;
		struct msg_stop_conn {
			uint32_t	sid;
			uint32_t	cid;
			uint64_t	conn_handle;
			uint32_t	flag;
		} stop_conn;
		struct msg_get_stats {
			uint32_t	sid;
			uint32_t	cid;
		} get_stats;
		struct msg_transport_connect {
			uint32_t	non_blocking;
		} ep_connect;
		struct msg_transport_connect_through_host {
			uint32_t	host_no;
			uint32_t	non_blocking;
		} ep_connect_through_host;
		struct msg_transport_poll {
			uint64_t	ep_handle;
			uint32_t	timeout_ms;
		} ep_poll;
		struct msg_transport_disconnect {
			uint64_t	ep_handle;
		} ep_disconnect;
		struct msg_tgt_dscvr {
			enum iscsi_tgt_dscvr	type;
			uint32_t	host_no;
			/*
 			 * enable = 1 to establish a new connection
			 * with the server. enable = 0 to disconnect
			 * from the server. Used primarily to switch
			 * from one iSNS server to another.
			 */
			uint32_t	enable;
		} tgt_dscvr;
		struct msg_set_host_param {
			uint32_t	host_no;
			uint32_t	param; /* enum iscsi_host_param */
			uint32_t	len;
		} set_host_param;
		struct msg_set_path {
			uint32_t	host_no;
		} set_path;
		struct msg_set_iface_params {
			uint32_t	host_no;
			uint32_t	count;
		} set_iface_params;
	} u;
	union {
		/* messages k -> u */
		int			retcode;
		struct msg_create_session_ret {
			uint32_t	sid;
			uint32_t	host_no;
		} c_session_ret;
		struct msg_create_conn_ret {
			uint32_t	sid;
			uint32_t	cid;
		} c_conn_ret;
		struct msg_unbind_session {
			uint32_t	sid;
			uint32_t	host_no;
		} unbind_session;
		struct msg_recv_req {
			uint32_t	sid;
			uint32_t	cid;
			uint64_t	recv_handle;
		} recv_req;
		struct msg_conn_login {
			uint32_t        sid;
			uint32_t        cid;
			uint32_t        state; /* enum iscsi_conn_state */
		} conn_login;
		struct msg_conn_error {
			uint32_t	sid;
			uint32_t	cid;
			uint32_t	error; /* enum iscsi_err */
		} connerror;
		struct msg_session_destroyed {
			uint32_t	host_no;
			uint32_t	sid;
		} d_session;
		struct msg_transport_connect_ret {
			uint64_t	handle;
		} ep_connect_ret;
		struct msg_req_path {
			uint32_t	host_no;
		} req_path;
		struct msg_notify_if_down {
			uint32_t	host_no;
		} notify_if_down;
	} r;
} __attribute__ ((aligned (sizeof(uint64_t))));

enum iscsi_param_type {
	ISCSI_PARAM,		/* iscsi_param (session, conn, target, LU) */
	ISCSI_HOST_PARAM,	/* iscsi_host_param */
	ISCSI_NET_PARAM,	/* iscsi_net_param */
};

struct iscsi_iface_param_info {
	uint32_t iface_num;	/* iface number, 0 - n */
	uint32_t len;		/* Actual length of the param */
	uint16_t param;		/* iscsi param value */
	uint8_t iface_type;	/* IPv4 or IPv6 */
	uint8_t param_type;	/* iscsi_param_type */
	uint8_t value[0];	/* length sized value follows */
} __packed;

/*
 * To keep the struct iscsi_uevent size the same for userspace code
 * compatibility, the main structure for ISCSI_UEVENT_PATH_UPDATE and
 * ISCSI_KEVENT_PATH_REQ is defined separately and comes after the
 * struct iscsi_uevent in the NETLINK_ISCSI message.
 */
struct iscsi_path {
	uint64_t	handle;
	uint8_t		mac_addr[6];
	uint8_t		mac_addr_old[6];
	uint32_t	ip_addr_len;	/* 4 or 16 */
	union {
		struct in_addr	v4_addr;
		struct in6_addr	v6_addr;
	} src;
	union {
		struct in_addr	v4_addr;
		struct in6_addr	v6_addr;
	} dst;
	uint16_t	vlan_id;
	uint16_t	pmtu;
} __attribute__ ((aligned (sizeof(uint64_t))));

/* iscsi iface enabled/disabled setting */
#define ISCSI_IFACE_DISABLE	0x01
#define ISCSI_IFACE_ENABLE	0x02

/* ipv4 bootproto */
#define ISCSI_BOOTPROTO_STATIC		0x01
#define ISCSI_BOOTPROTO_DHCP		0x02

/* ipv6 addr autoconfig type */
#define ISCSI_IPV6_AUTOCFG_DISABLE		0x01
#define ISCSI_IPV6_AUTOCFG_ND_ENABLE		0x02
#define ISCSI_IPV6_AUTOCFG_DHCPV6_ENABLE	0x03

/* ipv6 link local addr type */
#define ISCSI_IPV6_LINKLOCAL_AUTOCFG_ENABLE	0x01
#define ISCSI_IPV6_LINKLOCAL_AUTOCFG_DISABLE	0x02

/* ipv6 router addr type */
#define ISCSI_IPV6_ROUTER_AUTOCFG_ENABLE	0x01
#define ISCSI_IPV6_ROUTER_AUTOCFG_DISABLE	0x02

#define ISCSI_IFACE_TYPE_IPV4		0x01
#define ISCSI_IFACE_TYPE_IPV6		0x02

#define ISCSI_MAX_VLAN_ID		4095
#define ISCSI_MAX_VLAN_PRIORITY		7

/* iscsi vlan enable/disabled setting */
#define ISCSI_VLAN_DISABLE	0x01
#define ISCSI_VLAN_ENABLE	0x02

/* iSCSI network params */
enum iscsi_net_param {
	ISCSI_NET_PARAM_IPV4_ADDR		= 1,
	ISCSI_NET_PARAM_IPV4_SUBNET		= 2,
	ISCSI_NET_PARAM_IPV4_GW			= 3,
	ISCSI_NET_PARAM_IPV4_BOOTPROTO		= 4,
	ISCSI_NET_PARAM_MAC			= 5,
	ISCSI_NET_PARAM_IPV6_LINKLOCAL		= 6,
	ISCSI_NET_PARAM_IPV6_ADDR		= 7,
	ISCSI_NET_PARAM_IPV6_ROUTER		= 8,
	ISCSI_NET_PARAM_IPV6_ADDR_AUTOCFG	= 9,
	ISCSI_NET_PARAM_IPV6_LINKLOCAL_AUTOCFG	= 10,
	ISCSI_NET_PARAM_IPV6_ROUTER_AUTOCFG	= 11,
	ISCSI_NET_PARAM_IFACE_ENABLE		= 12,
	ISCSI_NET_PARAM_VLAN_ID			= 13,
	ISCSI_NET_PARAM_VLAN_PRIORITY		= 14,
	ISCSI_NET_PARAM_VLAN_ENABLED		= 15,
	ISCSI_NET_PARAM_IFACE_TYPE		= 16,
	ISCSI_NET_PARAM_IFACE_NAME		= 17,
	ISCSI_NET_PARAM_MTU			= 18,
	ISCSI_NET_PARAM_PORT			= 19,
};

enum iscsi_conn_state {
	ISCSI_CONN_STATE_FREE,
	ISCSI_CONN_STATE_XPT_WAIT,
	ISCSI_CONN_STATE_IN_LOGIN,
	ISCSI_CONN_STATE_LOGGED_IN,
	ISCSI_CONN_STATE_IN_LOGOUT,
	ISCSI_CONN_STATE_LOGOUT_REQUESTED,
	ISCSI_CONN_STATE_CLEANUP_WAIT,
};

/*
 * Common error codes
 */
enum iscsi_err {
	ISCSI_OK			= 0,

	ISCSI_ERR_DATASN		= ISCSI_ERR_BASE + 1,
	ISCSI_ERR_DATA_OFFSET		= ISCSI_ERR_BASE + 2,
	ISCSI_ERR_MAX_CMDSN		= ISCSI_ERR_BASE + 3,
	ISCSI_ERR_EXP_CMDSN		= ISCSI_ERR_BASE + 4,
	ISCSI_ERR_BAD_OPCODE		= ISCSI_ERR_BASE + 5,
	ISCSI_ERR_DATALEN		= ISCSI_ERR_BASE + 6,
	ISCSI_ERR_AHSLEN		= ISCSI_ERR_BASE + 7,
	ISCSI_ERR_PROTO			= ISCSI_ERR_BASE + 8,
	ISCSI_ERR_LUN			= ISCSI_ERR_BASE + 9,
	ISCSI_ERR_BAD_ITT		= ISCSI_ERR_BASE + 10,
	ISCSI_ERR_CONN_FAILED		= ISCSI_ERR_BASE + 11,
	ISCSI_ERR_R2TSN			= ISCSI_ERR_BASE + 12,
	ISCSI_ERR_SESSION_FAILED	= ISCSI_ERR_BASE + 13,
	ISCSI_ERR_HDR_DGST		= ISCSI_ERR_BASE + 14,
	ISCSI_ERR_DATA_DGST		= ISCSI_ERR_BASE + 15,
	ISCSI_ERR_PARAM_NOT_FOUND	= ISCSI_ERR_BASE + 16,
	ISCSI_ERR_NO_SCSI_CMD		= ISCSI_ERR_BASE + 17,
	ISCSI_ERR_INVALID_HOST		= ISCSI_ERR_BASE + 18,
	ISCSI_ERR_XMIT_FAILED		= ISCSI_ERR_BASE + 19,
	ISCSI_ERR_TCP_CONN_CLOSE	= ISCSI_ERR_BASE + 20,
	ISCSI_ERR_SCSI_EH_SESSION_RST	= ISCSI_ERR_BASE + 21,
};

/*
 * iSCSI Parameters (RFC3720)
 */
enum iscsi_param {
	/* passed in using netlink set param */
	ISCSI_PARAM_MAX_RECV_DLENGTH,
	ISCSI_PARAM_MAX_XMIT_DLENGTH,
	ISCSI_PARAM_HDRDGST_EN,
	ISCSI_PARAM_DATADGST_EN,
	ISCSI_PARAM_INITIAL_R2T_EN,
	ISCSI_PARAM_MAX_R2T,
	ISCSI_PARAM_IMM_DATA_EN,
	ISCSI_PARAM_FIRST_BURST,
	ISCSI_PARAM_MAX_BURST,
	ISCSI_PARAM_PDU_INORDER_EN,
	ISCSI_PARAM_DATASEQ_INORDER_EN,
	ISCSI_PARAM_ERL,
	ISCSI_PARAM_IFMARKER_EN,
	ISCSI_PARAM_OFMARKER_EN,
	ISCSI_PARAM_EXP_STATSN,
	ISCSI_PARAM_TARGET_NAME,
	ISCSI_PARAM_TPGT,
	ISCSI_PARAM_PERSISTENT_ADDRESS,
	ISCSI_PARAM_PERSISTENT_PORT,
	ISCSI_PARAM_SESS_RECOVERY_TMO,

	/* passed in through bind conn using transport_fd */
	ISCSI_PARAM_CONN_PORT,
	ISCSI_PARAM_CONN_ADDRESS,

	ISCSI_PARAM_USERNAME,
	ISCSI_PARAM_USERNAME_IN,
	ISCSI_PARAM_PASSWORD,
	ISCSI_PARAM_PASSWORD_IN,

	ISCSI_PARAM_FAST_ABORT,
	ISCSI_PARAM_ABORT_TMO,
	ISCSI_PARAM_LU_RESET_TMO,
	ISCSI_PARAM_HOST_RESET_TMO,

	ISCSI_PARAM_PING_TMO,
	ISCSI_PARAM_RECV_TMO,

	ISCSI_PARAM_IFACE_NAME,
	ISCSI_PARAM_ISID,
	ISCSI_PARAM_INITIATOR_NAME,

	ISCSI_PARAM_TGT_RESET_TMO,
	ISCSI_PARAM_TARGET_ALIAS,
	/* must always be last */
	ISCSI_PARAM_MAX,
};

/* iSCSI HBA params */
enum iscsi_host_param {
	ISCSI_HOST_PARAM_HWADDRESS,
	ISCSI_HOST_PARAM_INITIATOR_NAME,
	ISCSI_HOST_PARAM_NETDEV_NAME,
	ISCSI_HOST_PARAM_IPADDRESS,
	ISCSI_HOST_PARAM_MAX,
};

#define iscsi_ptr(_handle) ((void*)(unsigned long)_handle)
#define iscsi_handle(_ptr) ((uint64_t)(unsigned long)_ptr)

/*
 * These flags presents iSCSI Data-Path capabilities.
 */
#define CAP_RECOVERY_L0		0x1
#define CAP_RECOVERY_L1		0x2
#define CAP_RECOVERY_L2		0x4
#define CAP_MULTI_R2T		0x8
#define CAP_HDRDGST		0x10
#define CAP_DATADGST		0x20
#define CAP_MULTI_CONN		0x40
#define CAP_TEXT_NEGO		0x80
#define CAP_MARKERS		0x100
#define CAP_FW_DB		0x200
#define CAP_SENDTARGETS_OFFLOAD	0x400	/* offload discovery process */
#define CAP_DATA_PATH_OFFLOAD	0x800	/* offload entire IO path */
#define CAP_DIGEST_OFFLOAD	0x1000	/* offload hdr and data digests */
#define CAP_PADDING_OFFLOAD	0x2000	/* offload padding insertion, removal,
					 and verification */
#define CAP_LOGIN_OFFLOAD	0x4000  /* offload session login */

/*
 * These flags describes reason of stop_conn() call
 */
#define STOP_CONN_TERM		0x1
#define STOP_CONN_SUSPEND	0x2
#define STOP_CONN_RECOVER	0x3

#define ISCSI_STATS_CUSTOM_MAX		32
#define ISCSI_STATS_CUSTOM_DESC_MAX	64
struct iscsi_stats_custom {
	char desc[ISCSI_STATS_CUSTOM_DESC_MAX];
	uint64_t value;
};

/*
 * struct iscsi_stats - iSCSI Statistics (iSCSI MIB)
 *
 * Note: this structure contains counters collected on per-connection basis.
 */
struct iscsi_stats {
	/* octets */
	uint64_t txdata_octets;
	uint64_t rxdata_octets;

	/* xmit pdus */
	uint32_t noptx_pdus;
	uint32_t scsicmd_pdus;
	uint32_t tmfcmd_pdus;
	uint32_t login_pdus;
	uint32_t text_pdus;
	uint32_t dataout_pdus;
	uint32_t logout_pdus;
	uint32_t snack_pdus;

	/* recv pdus */
	uint32_t noprx_pdus;
	uint32_t scsirsp_pdus;
	uint32_t tmfrsp_pdus;
	uint32_t textrsp_pdus;
	uint32_t datain_pdus;
	uint32_t logoutrsp_pdus;
	uint32_t r2t_pdus;
	uint32_t async_pdus;
	uint32_t rjt_pdus;

	/* errors */
	uint32_t digest_err;
	uint32_t timeout_err;

	/*
	 * iSCSI Custom Statistics support, i.e. Transport could
	 * extend existing MIB statistics with its own specific statistics
	 * up to ISCSI_STATS_CUSTOM_MAX
	 */
	uint32_t custom_length;
	struct iscsi_stats_custom custom[0]
		__attribute__ ((aligned (sizeof(uint64_t))));
};

#endif
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,
10eb0f01 MC	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,
43514774	63
39e84790 AA	64	/* up events */
	65	ISCSI_KEVENT_RECV_PDU = KEVENT_BASE + 1,
	66	ISCSI_KEVENT_CONN_ERROR = KEVENT_BASE + 2,
	67	ISCSI_KEVENT_IF_ERROR = KEVENT_BASE + 3,
53cb8a1f	68	ISCSI_KEVENT_DESTROY_SESSION = KEVENT_BASE + 4,
26974789 MC	69	ISCSI_KEVENT_UNBIND_SESSION = KEVENT_BASE + 5,
26974789 MC	70	ISCSI_KEVENT_CREATE_SESSION = KEVENT_BASE + 6,
43514774 MC	71
	72	ISCSI_KEVENT_PATH_REQ = KEVENT_BASE + 7,
	73	ISCSI_KEVENT_IF_DOWN = KEVENT_BASE + 8,
17fa575e	74	ISCSI_KEVENT_CONN_LOGIN_STATE = KEVENT_BASE + 9,
39e84790 AA	75	};
39e84790 AA	76
01cb225d MC	77	enum iscsi_tgt_dscvr {
	78	ISCSI_TGT_DSCVR_SEND_TARGETS = 1,
	79	ISCSI_TGT_DSCVR_ISNS = 2,
	80	ISCSI_TGT_DSCVR_SLP = 3,
	81	};
	82
39e84790 AA	83	struct iscsi_uevent {
	84	uint32_t type; /* k/u events type */
	85	uint32_t iferror; /* carries interface or resource errors */
	86	uint64_t transport_handle;
	87
	88	union {
	89	/* messages u -> k */
	90	struct msg_create_session {
	91	uint32_t initial_cmdsn;
1548271e MC	92	uint16_t cmds_max;
1548271e MC	93	uint16_t queue_depth;
39e84790	94	} c_session;
40753caa	95	struct msg_create_bound_session {
d82ff9be	96	uint64_t ep_handle;
40753caa MC	97	uint32_t initial_cmdsn;
	98	uint16_t cmds_max;
	99	uint16_t queue_depth;
	100	} c_bound_session;
39e84790	101	struct msg_destroy_session {
39e84790 AA	102	uint32_t sid;
	103	} d_session;
	104	struct msg_create_conn {
39e84790	105	uint32_t sid;
b5c7a12d	106	uint32_t cid;
39e84790 AA	107	} c_conn;
39e84790 AA	108	struct msg_bind_conn {
b5c7a12d MC	109	uint32_t sid;
b5c7a12d MC	110	uint32_t cid;
264faaaa	111	uint64_t transport_eph;
39e84790 AA	112	uint32_t is_leading;
	113	} b_conn;
	114	struct msg_destroy_conn {
b5c7a12d	115	uint32_t sid;
39e84790 AA	116	uint32_t cid;
	117	} d_conn;
	118	struct msg_send_pdu {
b5c7a12d MC	119	uint32_t sid;
b5c7a12d MC	120	uint32_t cid;
39e84790 AA	121	uint32_t hdr_size;
39e84790 AA	122	uint32_t data_size;
39e84790 AA	123	} send_pdu;
39e84790 AA	124	struct msg_set_param {
b5c7a12d MC	125	uint32_t sid;
b5c7a12d MC	126	uint32_t cid;
39e84790	127	uint32_t param; /* enum iscsi_param */
fd7255f5	128	uint32_t len;
39e84790 AA	129	} set_param;
39e84790 AA	130	struct msg_start_conn {
b5c7a12d MC	131	uint32_t sid;
b5c7a12d MC	132	uint32_t cid;
39e84790 AA	133	} start_conn;
39e84790 AA	134	struct msg_stop_conn {
b5c7a12d MC	135	uint32_t sid;
b5c7a12d MC	136	uint32_t cid;
39e84790 AA	137	uint64_t conn_handle;
	138	uint32_t flag;
	139	} stop_conn;
	140	struct msg_get_stats {
b5c7a12d MC	141	uint32_t sid;
b5c7a12d MC	142	uint32_t cid;
39e84790	143	} get_stats;
264faaaa OG	144	struct msg_transport_connect {
	145	uint32_t non_blocking;
	146	} ep_connect;
10eb0f01 MC	147	struct msg_transport_connect_through_host {
	148	uint32_t host_no;
	149	uint32_t non_blocking;
	150	} ep_connect_through_host;
264faaaa OG	151	struct msg_transport_poll {
	152	uint64_t ep_handle;
	153	uint32_t timeout_ms;
	154	} ep_poll;
	155	struct msg_transport_disconnect {
	156	uint64_t ep_handle;
	157	} ep_disconnect;
01cb225d MC	158	struct msg_tgt_dscvr {
	159	enum iscsi_tgt_dscvr type;
	160	uint32_t host_no;
	161	/*
	162	* enable = 1 to establish a new connection
	163	* with the server. enable = 0 to disconnect
	164	* from the server. Used primarily to switch
	165	* from one iSNS server to another.
	166	*/
	167	uint32_t enable;
	168	} tgt_dscvr;
1d9bf13a MC	169	struct msg_set_host_param {
	170	uint32_t host_no;
	171	uint32_t param; /* enum iscsi_host_param */
	172	uint32_t len;
	173	} set_host_param;
43514774 MC	174	struct msg_set_path {
	175	uint32_t host_no;
	176	} set_path;
56c155b5 MC	177	struct msg_set_iface_params {
	178	uint32_t host_no;
	179	uint32_t count;
	180	} set_iface_params;
39e84790 AA	181	} u;
	182	union {
	183	/* messages k -> u */
39e84790 AA	184	int retcode;
39e84790 AA	185	struct msg_create_session_ret {
39e84790	186	uint32_t sid;
b5c7a12d	187	uint32_t host_no;
39e84790	188	} c_session_ret;
b5c7a12d MC	189	struct msg_create_conn_ret {
	190	uint32_t sid;
	191	uint32_t cid;
	192	} c_conn_ret;
26974789 MC	193	struct msg_unbind_session {
	194	uint32_t sid;
	195	uint32_t host_no;
	196	} unbind_session;
39e84790	197	struct msg_recv_req {
b5c7a12d MC	198	uint32_t sid;
b5c7a12d MC	199	uint32_t cid;
39e84790	200	uint64_t recv_handle;
39e84790	201	} recv_req;
17fa575e MR	202	struct msg_conn_login {
	203	uint32_t sid;
	204	uint32_t cid;
	205	uint32_t state; /* enum iscsi_conn_state */
	206	} conn_login;
39e84790	207	struct msg_conn_error {
b5c7a12d MC	208	uint32_t sid;
b5c7a12d MC	209	uint32_t cid;
39e84790 AA	210	uint32_t error; /* enum iscsi_err */
39e84790 AA	211	} connerror;
53cb8a1f MC	212	struct msg_session_destroyed {
	213	uint32_t host_no;
	214	uint32_t sid;
	215	} d_session;
264faaaa OG	216	struct msg_transport_connect_ret {
	217	uint64_t handle;
	218	} ep_connect_ret;
43514774 MC	219	struct msg_req_path {
	220	uint32_t host_no;
	221	} req_path;
	222	struct msg_notify_if_down {
	223	uint32_t host_no;
	224	} notify_if_down;
39e84790 AA	225	} r;
	226	} __attribute__ ((aligned (sizeof(uint64_t))));
	227
56c155b5 MC	228	enum iscsi_param_type {
	229	ISCSI_PARAM, /* iscsi_param (session, conn, target, LU) */
	230	ISCSI_HOST_PARAM, /* iscsi_host_param */
	231	ISCSI_NET_PARAM, /* iscsi_net_param */
	232	};
	233
	234	struct iscsi_iface_param_info {
	235	uint32_t iface_num; /* iface number, 0 - n */
	236	uint32_t len; /* Actual length of the param */
	237	uint16_t param; /* iscsi param value */
	238	uint8_t iface_type; /* IPv4 or IPv6 */
	239	uint8_t param_type; /* iscsi_param_type */
	240	uint8_t value[0]; /* length sized value follows */
	241	} __packed;
	242
43514774 MC	243	/*
	244	* To keep the struct iscsi_uevent size the same for userspace code
	245	* compatibility, the main structure for ISCSI_UEVENT_PATH_UPDATE and
	246	* ISCSI_KEVENT_PATH_REQ is defined separately and comes after the
	247	* struct iscsi_uevent in the NETLINK_ISCSI message.
	248	*/
	249	struct iscsi_path {
	250	uint64_t handle;
	251	uint8_t mac_addr[6];
	252	uint8_t mac_addr_old[6];
	253	uint32_t ip_addr_len; /* 4 or 16 */
	254	union {
	255	struct in_addr v4_addr;
	256	struct in6_addr v6_addr;
	257	} src;
	258	union {
	259	struct in_addr v4_addr;
	260	struct in6_addr v6_addr;
	261	} dst;
	262	uint16_t vlan_id;
	263	uint16_t pmtu;
	264	} __attribute__ ((aligned (sizeof(uint64_t))));
	265
56c155b5 MC	266	/* iscsi iface enabled/disabled setting */
	267	#define ISCSI_IFACE_DISABLE 0x01
	268	#define ISCSI_IFACE_ENABLE 0x02
	269
	270	/* ipv4 bootproto */
	271	#define ISCSI_BOOTPROTO_STATIC 0x01
	272	#define ISCSI_BOOTPROTO_DHCP 0x02
	273
	274	/* ipv6 addr autoconfig type */
	275	#define ISCSI_IPV6_AUTOCFG_DISABLE 0x01
	276	#define ISCSI_IPV6_AUTOCFG_ND_ENABLE 0x02
	277	#define ISCSI_IPV6_AUTOCFG_DHCPV6_ENABLE 0x03
	278
	279	/* ipv6 link local addr type */
	280	#define ISCSI_IPV6_LINKLOCAL_AUTOCFG_ENABLE 0x01
	281	#define ISCSI_IPV6_LINKLOCAL_AUTOCFG_DISABLE 0x02
	282
	283	/* ipv6 router addr type */
	284	#define ISCSI_IPV6_ROUTER_AUTOCFG_ENABLE 0x01
	285	#define ISCSI_IPV6_ROUTER_AUTOCFG_DISABLE 0x02
	286
	287	#define ISCSI_IFACE_TYPE_IPV4 0x01
	288	#define ISCSI_IFACE_TYPE_IPV6 0x02
	289
4223b9e9 MC	290	#define ISCSI_MAX_VLAN_ID 4095
	291	#define ISCSI_MAX_VLAN_PRIORITY 7
	292
	293	/* iscsi vlan enable/disabled setting */
	294	#define ISCSI_VLAN_DISABLE 0x01
	295	#define ISCSI_VLAN_ENABLE 0x02
	296
56c155b5 MC	297	/* iSCSI network params */
	298	enum iscsi_net_param {
	299	ISCSI_NET_PARAM_IPV4_ADDR = 1,
	300	ISCSI_NET_PARAM_IPV4_SUBNET = 2,
	301	ISCSI_NET_PARAM_IPV4_GW = 3,
	302	ISCSI_NET_PARAM_IPV4_BOOTPROTO = 4,
	303	ISCSI_NET_PARAM_MAC = 5,
	304	ISCSI_NET_PARAM_IPV6_LINKLOCAL = 6,
	305	ISCSI_NET_PARAM_IPV6_ADDR = 7,
	306	ISCSI_NET_PARAM_IPV6_ROUTER = 8,
	307	ISCSI_NET_PARAM_IPV6_ADDR_AUTOCFG = 9,
	308	ISCSI_NET_PARAM_IPV6_LINKLOCAL_AUTOCFG = 10,
	309	ISCSI_NET_PARAM_IPV6_ROUTER_AUTOCFG = 11,
	310	ISCSI_NET_PARAM_IFACE_ENABLE = 12,
	311	ISCSI_NET_PARAM_VLAN_ID = 13,
4223b9e9 MC	312	ISCSI_NET_PARAM_VLAN_PRIORITY = 14,
	313	ISCSI_NET_PARAM_VLAN_ENABLED = 15,
	314	ISCSI_NET_PARAM_IFACE_TYPE = 16,
	315	ISCSI_NET_PARAM_IFACE_NAME = 17,
8c7d40fb	316	ISCSI_NET_PARAM_MTU = 18,
fcb5124e	317	ISCSI_NET_PARAM_PORT = 19,
56c155b5 MC	318	};
56c155b5 MC	319
17fa575e MR	320	enum iscsi_conn_state {
	321	ISCSI_CONN_STATE_FREE,
	322	ISCSI_CONN_STATE_XPT_WAIT,
	323	ISCSI_CONN_STATE_IN_LOGIN,
	324	ISCSI_CONN_STATE_LOGGED_IN,
	325	ISCSI_CONN_STATE_IN_LOGOUT,
	326	ISCSI_CONN_STATE_LOGOUT_REQUESTED,
	327	ISCSI_CONN_STATE_CLEANUP_WAIT,
	328	};
	329
39e84790 AA	330	/*
	331	* Common error codes
	332	*/
	333	enum iscsi_err {
	334	ISCSI_OK = 0,
	335
	336	ISCSI_ERR_DATASN = ISCSI_ERR_BASE + 1,
	337	ISCSI_ERR_DATA_OFFSET = ISCSI_ERR_BASE + 2,
	338	ISCSI_ERR_MAX_CMDSN = ISCSI_ERR_BASE + 3,
	339	ISCSI_ERR_EXP_CMDSN = ISCSI_ERR_BASE + 4,
	340	ISCSI_ERR_BAD_OPCODE = ISCSI_ERR_BASE + 5,
	341	ISCSI_ERR_DATALEN = ISCSI_ERR_BASE + 6,
	342	ISCSI_ERR_AHSLEN = ISCSI_ERR_BASE + 7,
	343	ISCSI_ERR_PROTO = ISCSI_ERR_BASE + 8,
	344	ISCSI_ERR_LUN = ISCSI_ERR_BASE + 9,
	345	ISCSI_ERR_BAD_ITT = ISCSI_ERR_BASE + 10,
	346	ISCSI_ERR_CONN_FAILED = ISCSI_ERR_BASE + 11,
	347	ISCSI_ERR_R2TSN = ISCSI_ERR_BASE + 12,
	348	ISCSI_ERR_SESSION_FAILED = ISCSI_ERR_BASE + 13,
	349	ISCSI_ERR_HDR_DGST = ISCSI_ERR_BASE + 14,
	350	ISCSI_ERR_DATA_DGST = ISCSI_ERR_BASE + 15,
7996a778 MC	351	ISCSI_ERR_PARAM_NOT_FOUND = ISCSI_ERR_BASE + 16,
7996a778 MC	352	ISCSI_ERR_NO_SCSI_CMD = ISCSI_ERR_BASE + 17,
e5bd7b54	353	ISCSI_ERR_INVALID_HOST = ISCSI_ERR_BASE + 18,
6f481e3c	354	ISCSI_ERR_XMIT_FAILED = ISCSI_ERR_BASE + 19,
d1af8a32	355	ISCSI_ERR_TCP_CONN_CLOSE = ISCSI_ERR_BASE + 20,
df4da5cd	356	ISCSI_ERR_SCSI_EH_SESSION_RST = ISCSI_ERR_BASE + 21,
39e84790 AA	357	};
	358
	359	/*
	360	* iSCSI Parameters (RFC3720)
	361	*/
	362	enum iscsi_param {
fd7255f5 MC	363	/* passed in using netlink set param */
	364	ISCSI_PARAM_MAX_RECV_DLENGTH,
	365	ISCSI_PARAM_MAX_XMIT_DLENGTH,
	366	ISCSI_PARAM_HDRDGST_EN,
	367	ISCSI_PARAM_DATADGST_EN,
	368	ISCSI_PARAM_INITIAL_R2T_EN,
	369	ISCSI_PARAM_MAX_R2T,
	370	ISCSI_PARAM_IMM_DATA_EN,
	371	ISCSI_PARAM_FIRST_BURST,
	372	ISCSI_PARAM_MAX_BURST,
	373	ISCSI_PARAM_PDU_INORDER_EN,
	374	ISCSI_PARAM_DATASEQ_INORDER_EN,
	375	ISCSI_PARAM_ERL,
	376	ISCSI_PARAM_IFMARKER_EN,
	377	ISCSI_PARAM_OFMARKER_EN,
8d2860b3	378	ISCSI_PARAM_EXP_STATSN,
fd7255f5 MC	379	ISCSI_PARAM_TARGET_NAME,
	380	ISCSI_PARAM_TPGT,
	381	ISCSI_PARAM_PERSISTENT_ADDRESS,
	382	ISCSI_PARAM_PERSISTENT_PORT,
30a6c652	383	ISCSI_PARAM_SESS_RECOVERY_TMO,
fd7255f5	384
25985edc	385	/* passed in through bind conn using transport_fd */
fd7255f5 MC	386	ISCSI_PARAM_CONN_PORT,
	387	ISCSI_PARAM_CONN_ADDRESS,
	388
b2c64167 MC	389	ISCSI_PARAM_USERNAME,
	390	ISCSI_PARAM_USERNAME_IN,
	391	ISCSI_PARAM_PASSWORD,
	392	ISCSI_PARAM_PASSWORD_IN,
	393
843c0a8a	394	ISCSI_PARAM_FAST_ABORT,
f6d5180c MC	395	ISCSI_PARAM_ABORT_TMO,
	396	ISCSI_PARAM_LU_RESET_TMO,
	397	ISCSI_PARAM_HOST_RESET_TMO,
	398
	399	ISCSI_PARAM_PING_TMO,
	400	ISCSI_PARAM_RECV_TMO,
88dfd340 MC	401
	402	ISCSI_PARAM_IFACE_NAME,
	403	ISCSI_PARAM_ISID,
	404	ISCSI_PARAM_INITIATOR_NAME,
3fe5ae8b MC	405
3fe5ae8b MC	406	ISCSI_PARAM_TGT_RESET_TMO,
3b2bef1f	407	ISCSI_PARAM_TARGET_ALIAS,
fd7255f5 MC	408	/* must always be last */
fd7255f5 MC	409	ISCSI_PARAM_MAX,
39e84790	410	};
fd7255f5	411
1819dc81 MC	412	/* iSCSI HBA params */
	413	enum iscsi_host_param {
	414	ISCSI_HOST_PARAM_HWADDRESS,
8ad5781a	415	ISCSI_HOST_PARAM_INITIATOR_NAME,
d8196ed2	416	ISCSI_HOST_PARAM_NETDEV_NAME,
22236961	417	ISCSI_HOST_PARAM_IPADDRESS,
1819dc81 MC	418	ISCSI_HOST_PARAM_MAX,
	419	};
	420
39e84790 AA	421	#define iscsi_ptr(_handle) ((void*)(unsigned long)_handle)
39e84790 AA	422	#define iscsi_handle(_ptr) ((uint64_t)(unsigned long)_ptr)
39e84790 AA	423
	424	/*
	425	* These flags presents iSCSI Data-Path capabilities.
	426	*/
	427	#define CAP_RECOVERY_L0 0x1
	428	#define CAP_RECOVERY_L1 0x2
	429	#define CAP_RECOVERY_L2 0x4
	430	#define CAP_MULTI_R2T 0x8
	431	#define CAP_HDRDGST 0x10
	432	#define CAP_DATADGST 0x20
	433	#define CAP_MULTI_CONN 0x40
	434	#define CAP_TEXT_NEGO 0x80
	435	#define CAP_MARKERS 0x100
0ab823db	436	#define CAP_FW_DB 0x200
63c62f1c MC	437	#define CAP_SENDTARGETS_OFFLOAD 0x400 /* offload discovery process */
	438	#define CAP_DATA_PATH_OFFLOAD 0x800 /* offload entire IO path */
	439	#define CAP_DIGEST_OFFLOAD 0x1000 /* offload hdr and data digests */
6df19a79 MC	440	#define CAP_PADDING_OFFLOAD 0x2000 /* offload padding insertion, removal,
6df19a79 MC	441	and verification */
17fa575e	442	#define CAP_LOGIN_OFFLOAD 0x4000 /* offload session login */
39e84790 AA	443
	444	/*
	445	* These flags describes reason of stop_conn() call
	446	*/
	447	#define STOP_CONN_TERM 0x1
	448	#define STOP_CONN_SUSPEND 0x2
	449	#define STOP_CONN_RECOVER 0x3
	450
	451	#define ISCSI_STATS_CUSTOM_MAX 32
	452	#define ISCSI_STATS_CUSTOM_DESC_MAX 64
	453	struct iscsi_stats_custom {
	454	char desc[ISCSI_STATS_CUSTOM_DESC_MAX];
	455	uint64_t value;
	456	};
	457
	458	/*
	459	* struct iscsi_stats - iSCSI Statistics (iSCSI MIB)
	460	*
	461	* Note: this structure contains counters collected on per-connection basis.
	462	*/
	463	struct iscsi_stats {
	464	/* octets */
	465	uint64_t txdata_octets;
	466	uint64_t rxdata_octets;
	467
	468	/* xmit pdus */
	469	uint32_t noptx_pdus;
	470	uint32_t scsicmd_pdus;
	471	uint32_t tmfcmd_pdus;
	472	uint32_t login_pdus;
	473	uint32_t text_pdus;
	474	uint32_t dataout_pdus;
	475	uint32_t logout_pdus;
	476	uint32_t snack_pdus;
	477
	478	/* recv pdus */
	479	uint32_t noprx_pdus;
	480	uint32_t scsirsp_pdus;
	481	uint32_t tmfrsp_pdus;
	482	uint32_t textrsp_pdus;
	483	uint32_t datain_pdus;
	484	uint32_t logoutrsp_pdus;
	485	uint32_t r2t_pdus;
	486	uint32_t async_pdus;
	487	uint32_t rjt_pdus;
	488
	489	/* errors */
	490	uint32_t digest_err;
	491	uint32_t timeout_err;
	492
	493	/*
	494	* iSCSI Custom Statistics support, i.e. Transport could
	495	* extend existing MIB statistics with its own specific statistics
	496	* up to ISCSI_STATS_CUSTOM_MAX
	497	*/
	498	uint32_t custom_length;
	499	struct iscsi_stats_custom custom[0]
	500	__attribute__ ((aligned (sizeof(uint64_t))));
	501	};
	502
	503	#endif