[GitHub/mt8127/android_kernel_alcatel_ttab.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,

	/* 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,
};

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;
	} 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_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))));

/*
 * 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))));

/*
 * 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,
};

#define ISCSI_MAX_RECV_DLENGTH		(1ULL << ISCSI_PARAM_MAX_RECV_DLENGTH)
#define ISCSI_MAX_XMIT_DLENGTH		(1ULL << ISCSI_PARAM_MAX_XMIT_DLENGTH)
#define ISCSI_HDRDGST_EN		(1ULL << ISCSI_PARAM_HDRDGST_EN)
#define ISCSI_DATADGST_EN		(1ULL << ISCSI_PARAM_DATADGST_EN)
#define ISCSI_INITIAL_R2T_EN		(1ULL << ISCSI_PARAM_INITIAL_R2T_EN)
#define ISCSI_MAX_R2T			(1ULL << ISCSI_PARAM_MAX_R2T)
#define ISCSI_IMM_DATA_EN		(1ULL << ISCSI_PARAM_IMM_DATA_EN)
#define ISCSI_FIRST_BURST		(1ULL << ISCSI_PARAM_FIRST_BURST)
#define ISCSI_MAX_BURST			(1ULL << ISCSI_PARAM_MAX_BURST)
#define ISCSI_PDU_INORDER_EN		(1ULL << ISCSI_PARAM_PDU_INORDER_EN)
#define ISCSI_DATASEQ_INORDER_EN	(1ULL << ISCSI_PARAM_DATASEQ_INORDER_EN)
#define ISCSI_ERL			(1ULL << ISCSI_PARAM_ERL)
#define ISCSI_IFMARKER_EN		(1ULL << ISCSI_PARAM_IFMARKER_EN)
#define ISCSI_OFMARKER_EN		(1ULL << ISCSI_PARAM_OFMARKER_EN)
#define ISCSI_EXP_STATSN		(1ULL << ISCSI_PARAM_EXP_STATSN)
#define ISCSI_TARGET_NAME		(1ULL << ISCSI_PARAM_TARGET_NAME)
#define ISCSI_TPGT			(1ULL << ISCSI_PARAM_TPGT)
#define ISCSI_PERSISTENT_ADDRESS	(1ULL << ISCSI_PARAM_PERSISTENT_ADDRESS)
#define ISCSI_PERSISTENT_PORT		(1ULL << ISCSI_PARAM_PERSISTENT_PORT)
#define ISCSI_SESS_RECOVERY_TMO		(1ULL << ISCSI_PARAM_SESS_RECOVERY_TMO)
#define ISCSI_CONN_PORT			(1ULL << ISCSI_PARAM_CONN_PORT)
#define ISCSI_CONN_ADDRESS		(1ULL << ISCSI_PARAM_CONN_ADDRESS)
#define ISCSI_USERNAME			(1ULL << ISCSI_PARAM_USERNAME)
#define ISCSI_USERNAME_IN		(1ULL << ISCSI_PARAM_USERNAME_IN)
#define ISCSI_PASSWORD			(1ULL << ISCSI_PARAM_PASSWORD)
#define ISCSI_PASSWORD_IN		(1ULL << ISCSI_PARAM_PASSWORD_IN)
#define ISCSI_FAST_ABORT		(1ULL << ISCSI_PARAM_FAST_ABORT)
#define ISCSI_ABORT_TMO			(1ULL << ISCSI_PARAM_ABORT_TMO)
#define ISCSI_LU_RESET_TMO		(1ULL << ISCSI_PARAM_LU_RESET_TMO)
#define ISCSI_HOST_RESET_TMO		(1ULL << ISCSI_PARAM_HOST_RESET_TMO)
#define ISCSI_PING_TMO			(1ULL << ISCSI_PARAM_PING_TMO)
#define ISCSI_RECV_TMO			(1ULL << ISCSI_PARAM_RECV_TMO)
#define ISCSI_IFACE_NAME		(1ULL << ISCSI_PARAM_IFACE_NAME)
#define ISCSI_ISID			(1ULL << ISCSI_PARAM_ISID)
#define ISCSI_INITIATOR_NAME		(1ULL << ISCSI_PARAM_INITIATOR_NAME)
#define ISCSI_TGT_RESET_TMO		(1ULL << ISCSI_PARAM_TGT_RESET_TMO)
#define ISCSI_TARGET_ALIAS		(1ULL << ISCSI_PARAM_TARGET_ALIAS)

/* 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_HOST_HWADDRESS		(1ULL << ISCSI_HOST_PARAM_HWADDRESS)
#define ISCSI_HOST_INITIATOR_NAME	(1ULL << ISCSI_HOST_PARAM_INITIATOR_NAME)
#define ISCSI_HOST_NETDEV_NAME		(1ULL << ISCSI_HOST_PARAM_NETDEV_NAME)
#define ISCSI_HOST_IPADDRESS		(1ULL << ISCSI_HOST_PARAM_IPADDRESS)

#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 */

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