[mirror_ubuntu-artful-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,
	ISCSI_UEVENT_PING		= UEVENT_BASE + 22,
	ISCSI_UEVENT_GET_CHAP		= UEVENT_BASE + 23,
	ISCSI_UEVENT_DELETE_CHAP	= UEVENT_BASE + 24,

	/* 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,
	ISCSI_KEVENT_HOST_EVENT		= KEVENT_BASE + 10,
	ISCSI_KEVENT_PING_COMP		= KEVENT_BASE + 11,
};

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

enum iscsi_host_event_code {
	ISCSI_EVENT_LINKUP		= 1,
	ISCSI_EVENT_LINKDOWN,
	/* must always be last */
	ISCSI_EVENT_MAX,
};

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;
		struct msg_iscsi_ping {
			uint32_t        host_no;
			uint32_t        iface_num;
			uint32_t        iface_type;
			uint32_t        payload_size;
			uint32_t	pid;	/* unique ping id associated
						   with each ping request */
		} iscsi_ping;
		struct msg_get_chap {
			uint32_t	host_no;
			uint32_t	num_entries; /* number of CHAP entries
						      * on request, number of
						      * valid CHAP entries on
						      * response */
			uint16_t	chap_tbl_idx;
		} get_chap;
		struct msg_delete_chap {
		       uint32_t        host_no;
		       uint16_t        chap_tbl_idx;
		} delete_chap;
	} 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;
		struct msg_host_event {
			uint32_t	host_no;
			uint32_t	data_size;
			enum iscsi_host_event_code code;
		} host_event;
		struct msg_ping_comp {
			uint32_t        host_no;
			uint32_t        status;
			uint32_t	pid;	/* unique ping id associated
						   with each ping request */
			uint32_t        data_size;
		} ping_comp;
	} 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_VLAN_TAG		= 16,
	ISCSI_NET_PARAM_IFACE_TYPE		= 17,
	ISCSI_NET_PARAM_IFACE_NAME		= 18,
	ISCSI_NET_PARAM_MTU			= 19,
	ISCSI_NET_PARAM_PORT			= 20,
};

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,

	ISCSI_PARAM_CHAP_IN_IDX,
	ISCSI_PARAM_CHAP_OUT_IDX,
	/* 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_PORT_STATE,
	ISCSI_HOST_PARAM_PORT_SPEED,
	ISCSI_HOST_PARAM_MAX,
};

/* iSCSI port Speed */
enum iscsi_port_speed {
	ISCSI_PORT_SPEED_UNKNOWN	= 0x1,
	ISCSI_PORT_SPEED_10MBPS		= 0x2,
	ISCSI_PORT_SPEED_100MBPS	= 0x4,
	ISCSI_PORT_SPEED_1GBPS		= 0x8,
	ISCSI_PORT_SPEED_10GBPS		= 0x10,
};

/* iSCSI port state */
enum iscsi_port_state {
	ISCSI_PORT_STATE_DOWN		= 0x1,
	ISCSI_PORT_STATE_UP		= 0x2,
};

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

enum chap_type_e {
	CHAP_TYPE_OUT,
	CHAP_TYPE_IN,
};

#define ISCSI_CHAP_AUTH_NAME_MAX_LEN	256
#define ISCSI_CHAP_AUTH_SECRET_MAX_LEN	256
struct iscsi_chap_rec {
	uint16_t chap_tbl_idx;
	enum chap_type_e chap_type;
	char username[ISCSI_CHAP_AUTH_NAME_MAX_LEN];
	uint8_t password[ISCSI_CHAP_AUTH_SECRET_MAX_LEN];
	uint8_t password_length;
} __packed;

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