[linux.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 [email protected]
 *
 * 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>

#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,

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

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_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_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;
	} 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_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;
	} r;
} __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 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,

	/* pased 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,

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

#define ISCSI_MAX_RECV_DLENGTH		(1 << ISCSI_PARAM_MAX_RECV_DLENGTH)
#define ISCSI_MAX_XMIT_DLENGTH		(1 << ISCSI_PARAM_MAX_XMIT_DLENGTH)
#define ISCSI_HDRDGST_EN		(1 << ISCSI_PARAM_HDRDGST_EN)
#define ISCSI_DATADGST_EN		(1 << ISCSI_PARAM_DATADGST_EN)
#define ISCSI_INITIAL_R2T_EN		(1 << ISCSI_PARAM_INITIAL_R2T_EN)
#define ISCSI_MAX_R2T			(1 << ISCSI_PARAM_MAX_R2T)
#define ISCSI_IMM_DATA_EN		(1 << ISCSI_PARAM_IMM_DATA_EN)
#define ISCSI_FIRST_BURST		(1 << ISCSI_PARAM_FIRST_BURST)
#define ISCSI_MAX_BURST			(1 << ISCSI_PARAM_MAX_BURST)
#define ISCSI_PDU_INORDER_EN		(1 << ISCSI_PARAM_PDU_INORDER_EN)
#define ISCSI_DATASEQ_INORDER_EN	(1 << ISCSI_PARAM_DATASEQ_INORDER_EN)
#define ISCSI_ERL			(1 << ISCSI_PARAM_ERL)
#define ISCSI_IFMARKER_EN		(1 << ISCSI_PARAM_IFMARKER_EN)
#define ISCSI_OFMARKER_EN		(1 << ISCSI_PARAM_OFMARKER_EN)
#define ISCSI_EXP_STATSN		(1 << ISCSI_PARAM_EXP_STATSN)
#define ISCSI_TARGET_NAME		(1 << ISCSI_PARAM_TARGET_NAME)
#define ISCSI_TPGT			(1 << ISCSI_PARAM_TPGT)
#define ISCSI_PERSISTENT_ADDRESS	(1 << ISCSI_PARAM_PERSISTENT_ADDRESS)
#define ISCSI_PERSISTENT_PORT		(1 << ISCSI_PARAM_PERSISTENT_PORT)
#define ISCSI_SESS_RECOVERY_TMO		(1 << ISCSI_PARAM_SESS_RECOVERY_TMO)
#define ISCSI_CONN_PORT			(1 << ISCSI_PARAM_CONN_PORT)
#define ISCSI_CONN_ADDRESS		(1 << ISCSI_PARAM_CONN_ADDRESS)
#define ISCSI_USERNAME			(1 << ISCSI_PARAM_USERNAME)
#define ISCSI_USERNAME_IN		(1 << ISCSI_PARAM_USERNAME_IN)
#define ISCSI_PASSWORD			(1 << ISCSI_PARAM_PASSWORD)
#define ISCSI_PASSWORD_IN		(1 << ISCSI_PARAM_PASSWORD_IN)

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

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

/**
 * iscsi_hostdata - get LLD hostdata from scsi_host
 * @_hostdata: pointer to scsi host's hostdata
 **/
#define iscsi_hostdata(_hostdata) ((void*)_hostdata + sizeof(unsigned long))

/*
 * 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
#define CAP_DATA_PATH_OFFLOAD	0x800

/*
 * 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 [email protected]
	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>
	25
	26	#define UEVENT_BASE 10
	27	#define KEVENT_BASE 100
	28	#define ISCSI_ERR_BASE 1000
	29
	30	enum iscsi_uevent_e {
	31	ISCSI_UEVENT_UNKNOWN = 0,
	32
	33	/* down events */
	34	ISCSI_UEVENT_CREATE_SESSION = UEVENT_BASE + 1,
	35	ISCSI_UEVENT_DESTROY_SESSION = UEVENT_BASE + 2,
	36	ISCSI_UEVENT_CREATE_CONN = UEVENT_BASE + 3,
	37	ISCSI_UEVENT_DESTROY_CONN = UEVENT_BASE + 4,
	38	ISCSI_UEVENT_BIND_CONN = UEVENT_BASE + 5,
	39	ISCSI_UEVENT_SET_PARAM = UEVENT_BASE + 6,
	40	ISCSI_UEVENT_START_CONN = UEVENT_BASE + 7,
	41	ISCSI_UEVENT_STOP_CONN = UEVENT_BASE + 8,
	42	ISCSI_UEVENT_SEND_PDU = UEVENT_BASE + 9,
	43	ISCSI_UEVENT_GET_STATS = UEVENT_BASE + 10,
	44	ISCSI_UEVENT_GET_PARAM = UEVENT_BASE + 11,
	45
264faaaa OG	46	ISCSI_UEVENT_TRANSPORT_EP_CONNECT = UEVENT_BASE + 12,
	47	ISCSI_UEVENT_TRANSPORT_EP_POLL = UEVENT_BASE + 13,
	48	ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT = UEVENT_BASE + 14,
	49
01cb225d	50	ISCSI_UEVENT_TGT_DSCVR = UEVENT_BASE + 15,
1d9bf13a	51	ISCSI_UEVENT_SET_HOST_PARAM = UEVENT_BASE + 16,
01cb225d	52
39e84790 AA	53	/* up events */
	54	ISCSI_KEVENT_RECV_PDU = KEVENT_BASE + 1,
	55	ISCSI_KEVENT_CONN_ERROR = KEVENT_BASE + 2,
	56	ISCSI_KEVENT_IF_ERROR = KEVENT_BASE + 3,
53cb8a1f	57	ISCSI_KEVENT_DESTROY_SESSION = KEVENT_BASE + 4,
39e84790 AA	58	};
39e84790 AA	59
01cb225d MC	60	enum iscsi_tgt_dscvr {
	61	ISCSI_TGT_DSCVR_SEND_TARGETS = 1,
	62	ISCSI_TGT_DSCVR_ISNS = 2,
	63	ISCSI_TGT_DSCVR_SLP = 3,
	64	};
	65
39e84790 AA	66	struct iscsi_uevent {
	67	uint32_t type; /* k/u events type */
	68	uint32_t iferror; /* carries interface or resource errors */
	69	uint64_t transport_handle;
	70
	71	union {
	72	/* messages u -> k */
	73	struct msg_create_session {
	74	uint32_t initial_cmdsn;
1548271e MC	75	uint16_t cmds_max;
1548271e MC	76	uint16_t queue_depth;
39e84790 AA	77	} c_session;
39e84790 AA	78	struct msg_destroy_session {
39e84790 AA	79	uint32_t sid;
	80	} d_session;
	81	struct msg_create_conn {
39e84790	82	uint32_t sid;
b5c7a12d	83	uint32_t cid;
39e84790 AA	84	} c_conn;
39e84790 AA	85	struct msg_bind_conn {
b5c7a12d MC	86	uint32_t sid;
b5c7a12d MC	87	uint32_t cid;
264faaaa	88	uint64_t transport_eph;
39e84790 AA	89	uint32_t is_leading;
	90	} b_conn;
	91	struct msg_destroy_conn {
b5c7a12d	92	uint32_t sid;
39e84790 AA	93	uint32_t cid;
	94	} d_conn;
	95	struct msg_send_pdu {
b5c7a12d MC	96	uint32_t sid;
b5c7a12d MC	97	uint32_t cid;
39e84790 AA	98	uint32_t hdr_size;
39e84790 AA	99	uint32_t data_size;
39e84790 AA	100	} send_pdu;
39e84790 AA	101	struct msg_set_param {
b5c7a12d MC	102	uint32_t sid;
b5c7a12d MC	103	uint32_t cid;
39e84790	104	uint32_t param; /* enum iscsi_param */
fd7255f5	105	uint32_t len;
39e84790 AA	106	} set_param;
39e84790 AA	107	struct msg_start_conn {
b5c7a12d MC	108	uint32_t sid;
b5c7a12d MC	109	uint32_t cid;
39e84790 AA	110	} start_conn;
39e84790 AA	111	struct msg_stop_conn {
b5c7a12d MC	112	uint32_t sid;
b5c7a12d MC	113	uint32_t cid;
39e84790 AA	114	uint64_t conn_handle;
	115	uint32_t flag;
	116	} stop_conn;
	117	struct msg_get_stats {
b5c7a12d MC	118	uint32_t sid;
b5c7a12d MC	119	uint32_t cid;
39e84790	120	} get_stats;
264faaaa OG	121	struct msg_transport_connect {
	122	uint32_t non_blocking;
	123	} ep_connect;
	124	struct msg_transport_poll {
	125	uint64_t ep_handle;
	126	uint32_t timeout_ms;
	127	} ep_poll;
	128	struct msg_transport_disconnect {
	129	uint64_t ep_handle;
	130	} ep_disconnect;
01cb225d MC	131	struct msg_tgt_dscvr {
	132	enum iscsi_tgt_dscvr type;
	133	uint32_t host_no;
	134	/*
	135	* enable = 1 to establish a new connection
	136	* with the server. enable = 0 to disconnect
	137	* from the server. Used primarily to switch
	138	* from one iSNS server to another.
	139	*/
	140	uint32_t enable;
	141	} tgt_dscvr;
1d9bf13a MC	142	struct msg_set_host_param {
	143	uint32_t host_no;
	144	uint32_t param; /* enum iscsi_host_param */
	145	uint32_t len;
	146	} set_host_param;
39e84790 AA	147	} u;
	148	union {
	149	/* messages k -> u */
39e84790 AA	150	int retcode;
39e84790 AA	151	struct msg_create_session_ret {
39e84790	152	uint32_t sid;
b5c7a12d	153	uint32_t host_no;
39e84790	154	} c_session_ret;
b5c7a12d MC	155	struct msg_create_conn_ret {
	156	uint32_t sid;
	157	uint32_t cid;
	158	} c_conn_ret;
39e84790	159	struct msg_recv_req {
b5c7a12d MC	160	uint32_t sid;
b5c7a12d MC	161	uint32_t cid;
39e84790	162	uint64_t recv_handle;
39e84790 AA	163	} recv_req;
39e84790 AA	164	struct msg_conn_error {
b5c7a12d MC	165	uint32_t sid;
b5c7a12d MC	166	uint32_t cid;
39e84790 AA	167	uint32_t error; /* enum iscsi_err */
39e84790 AA	168	} connerror;
53cb8a1f MC	169	struct msg_session_destroyed {
	170	uint32_t host_no;
	171	uint32_t sid;
	172	} d_session;
264faaaa OG	173	struct msg_transport_connect_ret {
	174	uint64_t handle;
	175	} ep_connect_ret;
39e84790 AA	176	} r;
	177	} __attribute__ ((aligned (sizeof(uint64_t))));
	178
	179	/*
	180	* Common error codes
	181	*/
	182	enum iscsi_err {
	183	ISCSI_OK = 0,
	184
	185	ISCSI_ERR_DATASN = ISCSI_ERR_BASE + 1,
	186	ISCSI_ERR_DATA_OFFSET = ISCSI_ERR_BASE + 2,
	187	ISCSI_ERR_MAX_CMDSN = ISCSI_ERR_BASE + 3,
	188	ISCSI_ERR_EXP_CMDSN = ISCSI_ERR_BASE + 4,
	189	ISCSI_ERR_BAD_OPCODE = ISCSI_ERR_BASE + 5,
	190	ISCSI_ERR_DATALEN = ISCSI_ERR_BASE + 6,
	191	ISCSI_ERR_AHSLEN = ISCSI_ERR_BASE + 7,
	192	ISCSI_ERR_PROTO = ISCSI_ERR_BASE + 8,
	193	ISCSI_ERR_LUN = ISCSI_ERR_BASE + 9,
	194	ISCSI_ERR_BAD_ITT = ISCSI_ERR_BASE + 10,
	195	ISCSI_ERR_CONN_FAILED = ISCSI_ERR_BASE + 11,
	196	ISCSI_ERR_R2TSN = ISCSI_ERR_BASE + 12,
	197	ISCSI_ERR_SESSION_FAILED = ISCSI_ERR_BASE + 13,
	198	ISCSI_ERR_HDR_DGST = ISCSI_ERR_BASE + 14,
	199	ISCSI_ERR_DATA_DGST = ISCSI_ERR_BASE + 15,
7996a778 MC	200	ISCSI_ERR_PARAM_NOT_FOUND = ISCSI_ERR_BASE + 16,
7996a778 MC	201	ISCSI_ERR_NO_SCSI_CMD = ISCSI_ERR_BASE + 17,
39e84790 AA	202	};
	203
	204	/*
	205	* iSCSI Parameters (RFC3720)
	206	*/
	207	enum iscsi_param {
fd7255f5 MC	208	/* passed in using netlink set param */
	209	ISCSI_PARAM_MAX_RECV_DLENGTH,
	210	ISCSI_PARAM_MAX_XMIT_DLENGTH,
	211	ISCSI_PARAM_HDRDGST_EN,
	212	ISCSI_PARAM_DATADGST_EN,
	213	ISCSI_PARAM_INITIAL_R2T_EN,
	214	ISCSI_PARAM_MAX_R2T,
	215	ISCSI_PARAM_IMM_DATA_EN,
	216	ISCSI_PARAM_FIRST_BURST,
	217	ISCSI_PARAM_MAX_BURST,
	218	ISCSI_PARAM_PDU_INORDER_EN,
	219	ISCSI_PARAM_DATASEQ_INORDER_EN,
	220	ISCSI_PARAM_ERL,
	221	ISCSI_PARAM_IFMARKER_EN,
	222	ISCSI_PARAM_OFMARKER_EN,
8d2860b3	223	ISCSI_PARAM_EXP_STATSN,
fd7255f5 MC	224	ISCSI_PARAM_TARGET_NAME,
	225	ISCSI_PARAM_TPGT,
	226	ISCSI_PARAM_PERSISTENT_ADDRESS,
	227	ISCSI_PARAM_PERSISTENT_PORT,
30a6c652	228	ISCSI_PARAM_SESS_RECOVERY_TMO,
fd7255f5 MC	229
	230	/* pased in through bind conn using transport_fd */
	231	ISCSI_PARAM_CONN_PORT,
	232	ISCSI_PARAM_CONN_ADDRESS,
	233
b2c64167 MC	234	ISCSI_PARAM_USERNAME,
	235	ISCSI_PARAM_USERNAME_IN,
	236	ISCSI_PARAM_PASSWORD,
	237	ISCSI_PARAM_PASSWORD_IN,
	238
fd7255f5 MC	239	/* must always be last */
fd7255f5 MC	240	ISCSI_PARAM_MAX,
39e84790	241	};
fd7255f5 MC	242
	243	#define ISCSI_MAX_RECV_DLENGTH (1 << ISCSI_PARAM_MAX_RECV_DLENGTH)
	244	#define ISCSI_MAX_XMIT_DLENGTH (1 << ISCSI_PARAM_MAX_XMIT_DLENGTH)
	245	#define ISCSI_HDRDGST_EN (1 << ISCSI_PARAM_HDRDGST_EN)
	246	#define ISCSI_DATADGST_EN (1 << ISCSI_PARAM_DATADGST_EN)
	247	#define ISCSI_INITIAL_R2T_EN (1 << ISCSI_PARAM_INITIAL_R2T_EN)
	248	#define ISCSI_MAX_R2T (1 << ISCSI_PARAM_MAX_R2T)
	249	#define ISCSI_IMM_DATA_EN (1 << ISCSI_PARAM_IMM_DATA_EN)
	250	#define ISCSI_FIRST_BURST (1 << ISCSI_PARAM_FIRST_BURST)
	251	#define ISCSI_MAX_BURST (1 << ISCSI_PARAM_MAX_BURST)
	252	#define ISCSI_PDU_INORDER_EN (1 << ISCSI_PARAM_PDU_INORDER_EN)
	253	#define ISCSI_DATASEQ_INORDER_EN (1 << ISCSI_PARAM_DATASEQ_INORDER_EN)
	254	#define ISCSI_ERL (1 << ISCSI_PARAM_ERL)
	255	#define ISCSI_IFMARKER_EN (1 << ISCSI_PARAM_IFMARKER_EN)
	256	#define ISCSI_OFMARKER_EN (1 << ISCSI_PARAM_OFMARKER_EN)
8d2860b3	257	#define ISCSI_EXP_STATSN (1 << ISCSI_PARAM_EXP_STATSN)
fd7255f5 MC	258	#define ISCSI_TARGET_NAME (1 << ISCSI_PARAM_TARGET_NAME)
	259	#define ISCSI_TPGT (1 << ISCSI_PARAM_TPGT)
	260	#define ISCSI_PERSISTENT_ADDRESS (1 << ISCSI_PARAM_PERSISTENT_ADDRESS)
	261	#define ISCSI_PERSISTENT_PORT (1 << ISCSI_PARAM_PERSISTENT_PORT)
30a6c652	262	#define ISCSI_SESS_RECOVERY_TMO (1 << ISCSI_PARAM_SESS_RECOVERY_TMO)
fd7255f5 MC	263	#define ISCSI_CONN_PORT (1 << ISCSI_PARAM_CONN_PORT)
fd7255f5 MC	264	#define ISCSI_CONN_ADDRESS (1 << ISCSI_PARAM_CONN_ADDRESS)
b2c64167 MC	265	#define ISCSI_USERNAME (1 << ISCSI_PARAM_USERNAME)
	266	#define ISCSI_USERNAME_IN (1 << ISCSI_PARAM_USERNAME_IN)
	267	#define ISCSI_PASSWORD (1 << ISCSI_PARAM_PASSWORD)
	268	#define ISCSI_PASSWORD_IN (1 << ISCSI_PARAM_PASSWORD_IN)
39e84790	269
1819dc81 MC	270	/* iSCSI HBA params */
	271	enum iscsi_host_param {
	272	ISCSI_HOST_PARAM_HWADDRESS,
8ad5781a	273	ISCSI_HOST_PARAM_INITIATOR_NAME,
d8196ed2	274	ISCSI_HOST_PARAM_NETDEV_NAME,
22236961	275	ISCSI_HOST_PARAM_IPADDRESS,
1819dc81 MC	276	ISCSI_HOST_PARAM_MAX,
	277	};
	278
	279	#define ISCSI_HOST_HWADDRESS (1 << ISCSI_HOST_PARAM_HWADDRESS)
8ad5781a	280	#define ISCSI_HOST_INITIATOR_NAME (1 << ISCSI_HOST_PARAM_INITIATOR_NAME)
d8196ed2	281	#define ISCSI_HOST_NETDEV_NAME (1 << ISCSI_HOST_PARAM_NETDEV_NAME)
22236961	282	#define ISCSI_HOST_IPADDRESS (1 << ISCSI_HOST_PARAM_IPADDRESS)
1819dc81	283
39e84790 AA	284	#define iscsi_ptr(_handle) ((void*)(unsigned long)_handle)
39e84790 AA	285	#define iscsi_handle(_ptr) ((uint64_t)(unsigned long)_ptr)
7b8631b5 MC	286	#define hostdata_session(_hostdata) (iscsi_ptr((unsigned long )_hostdata))
	287
	288	/**
	289	* iscsi_hostdata - get LLD hostdata from scsi_host
	290	* @_hostdata: pointer to scsi host's hostdata
	291	**/
39e84790 AA	292	#define iscsi_hostdata(_hostdata) ((void*)_hostdata + sizeof(unsigned long))
	293
	294	/*
	295	* These flags presents iSCSI Data-Path capabilities.
	296	*/
	297	#define CAP_RECOVERY_L0 0x1
	298	#define CAP_RECOVERY_L1 0x2
	299	#define CAP_RECOVERY_L2 0x4
	300	#define CAP_MULTI_R2T 0x8
	301	#define CAP_HDRDGST 0x10
	302	#define CAP_DATADGST 0x20
	303	#define CAP_MULTI_CONN 0x40
	304	#define CAP_TEXT_NEGO 0x80
	305	#define CAP_MARKERS 0x100
0ab823db MC	306	#define CAP_FW_DB 0x200
0ab823db MC	307	#define CAP_SENDTARGETS_OFFLOAD 0x400
d8196ed2	308	#define CAP_DATA_PATH_OFFLOAD 0x800
39e84790 AA	309
	310	/*
	311	* These flags describes reason of stop_conn() call
	312	*/
	313	#define STOP_CONN_TERM 0x1
	314	#define STOP_CONN_SUSPEND 0x2
	315	#define STOP_CONN_RECOVER 0x3
	316
	317	#define ISCSI_STATS_CUSTOM_MAX 32
	318	#define ISCSI_STATS_CUSTOM_DESC_MAX 64
	319	struct iscsi_stats_custom {
	320	char desc[ISCSI_STATS_CUSTOM_DESC_MAX];
	321	uint64_t value;
	322	};
	323
	324	/*
	325	* struct iscsi_stats - iSCSI Statistics (iSCSI MIB)
	326	*
	327	* Note: this structure contains counters collected on per-connection basis.
	328	*/
	329	struct iscsi_stats {
	330	/* octets */
	331	uint64_t txdata_octets;
	332	uint64_t rxdata_octets;
	333
	334	/* xmit pdus */
	335	uint32_t noptx_pdus;
	336	uint32_t scsicmd_pdus;
	337	uint32_t tmfcmd_pdus;
	338	uint32_t login_pdus;
	339	uint32_t text_pdus;
	340	uint32_t dataout_pdus;
	341	uint32_t logout_pdus;
	342	uint32_t snack_pdus;
	343
	344	/* recv pdus */
	345	uint32_t noprx_pdus;
	346	uint32_t scsirsp_pdus;
	347	uint32_t tmfrsp_pdus;
	348	uint32_t textrsp_pdus;
	349	uint32_t datain_pdus;
	350	uint32_t logoutrsp_pdus;
	351	uint32_t r2t_pdus;
	352	uint32_t async_pdus;
	353	uint32_t rjt_pdus;
	354
	355	/* errors */
	356	uint32_t digest_err;
	357	uint32_t timeout_err;
	358
	359	/*
	360	* iSCSI Custom Statistics support, i.e. Transport could
	361	* extend existing MIB statistics with its own specific statistics
	362	* up to ISCSI_STATS_CUSTOM_MAX
	363	*/
	364	uint32_t custom_length;
	365	struct iscsi_stats_custom custom[0]
	366	__attribute__ ((aligned (sizeof(uint64_t))));
	367	};
	368
	369	#endif