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

/*
 * RFC 3720 (iSCSI) protocol data types
 *
 * 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_PROTO_H
#define ISCSI_PROTO_H

#include <linux/types.h>
#include <scsi/scsi.h>

#define ISCSI_DRAFT20_VERSION	0x00

/* default iSCSI listen port for incoming connections */
#define ISCSI_LISTEN_PORT	3260

/* iSCSI header length */
#define ISCSI_HDR_LEN		48

/* iSCSI CRC32C length */
#define ISCSI_CRC_LEN		4

/* Padding word length */
#define ISCSI_PAD_LEN		4

/*
 * Serial Number Arithmetic, 32 bits, RFC1982
 */

static inline int iscsi_sna_lt(u32 n1, u32 n2)
{
	return (s32)(n1 - n2) < 0;
}

static inline int iscsi_sna_lte(u32 n1, u32 n2)
{
	return (s32)(n1 - n2) <= 0;
}

static inline int iscsi_sna_gt(u32 n1, u32 n2)
{
	return (s32)(n1 - n2) > 0;
}

static inline int iscsi_sna_gte(u32 n1, u32 n2)
{
	return (s32)(n1 - n2) >= 0;
}

/*
 * useful common(control and data pathes) macro
 */
#define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
#define hton24(p, v) { \
        p[0] = (((v) >> 16) & 0xFF); \
        p[1] = (((v) >> 8) & 0xFF); \
        p[2] = ((v) & 0xFF); \
}
#define zero_data(p) {p[0]=0;p[1]=0;p[2]=0;}

/* initiator tags; opaque for target */
typedef uint32_t __bitwise itt_t;
/* below makes sense only for initiator that created this tag */
#define build_itt(itt, age) ((__force itt_t)\
	((itt) | ((age) << ISCSI_AGE_SHIFT)))
#define get_itt(itt) ((__force uint32_t)(itt_t)(itt) & ISCSI_ITT_MASK)
#define RESERVED_ITT ((__force itt_t)0xffffffff)

/*
 * iSCSI Template Message Header
 */
struct iscsi_hdr {
	uint8_t		opcode;
	uint8_t		flags;		/* Final bit */
	uint8_t		rsvd2[2];
	uint8_t		hlength;	/* AHSs total length */
	uint8_t		dlength[3];	/* Data length */
	struct scsi_lun	lun;
	itt_t		itt;		/* Initiator Task Tag, opaque for target */
	__be32		ttt;		/* Target Task Tag */
	__be32		statsn;
	__be32		exp_statsn;
	__be32		max_statsn;
	uint8_t		other[12];
};

/************************* RFC 3720 Begin *****************************/

#define ISCSI_RESERVED_TAG		0xffffffff

/* Opcode encoding bits */
#define ISCSI_OP_RETRY			0x80
#define ISCSI_OP_IMMEDIATE		0x40
#define ISCSI_OPCODE_MASK		0x3F

/* Initiator Opcode values */
#define ISCSI_OP_NOOP_OUT		0x00
#define ISCSI_OP_SCSI_CMD		0x01
#define ISCSI_OP_SCSI_TMFUNC		0x02
#define ISCSI_OP_LOGIN			0x03
#define ISCSI_OP_TEXT			0x04
#define ISCSI_OP_SCSI_DATA_OUT		0x05
#define ISCSI_OP_LOGOUT			0x06
#define ISCSI_OP_SNACK			0x10

#define ISCSI_OP_VENDOR1_CMD		0x1c
#define ISCSI_OP_VENDOR2_CMD		0x1d
#define ISCSI_OP_VENDOR3_CMD		0x1e
#define ISCSI_OP_VENDOR4_CMD		0x1f

/* Target Opcode values */
#define ISCSI_OP_NOOP_IN		0x20
#define ISCSI_OP_SCSI_CMD_RSP		0x21
#define ISCSI_OP_SCSI_TMFUNC_RSP	0x22
#define ISCSI_OP_LOGIN_RSP		0x23
#define ISCSI_OP_TEXT_RSP		0x24
#define ISCSI_OP_SCSI_DATA_IN		0x25
#define ISCSI_OP_LOGOUT_RSP		0x26
#define ISCSI_OP_R2T			0x31
#define ISCSI_OP_ASYNC_EVENT		0x32
#define ISCSI_OP_REJECT			0x3f

struct iscsi_ahs_hdr {
	__be16 ahslength;
	uint8_t ahstype;
	uint8_t ahspec[5];
};

#define ISCSI_AHSTYPE_CDB		1
#define ISCSI_AHSTYPE_RLENGTH		2
#define ISCSI_CDB_SIZE			16

/* iSCSI PDU Header */
struct iscsi_scsi_req {
	uint8_t opcode;
	uint8_t flags;
	__be16 rsvd2;
	uint8_t hlength;
	uint8_t dlength[3];
	struct scsi_lun lun;
	itt_t	 itt;	/* Initiator Task Tag */
	__be32 data_length;
	__be32 cmdsn;
	__be32 exp_statsn;
	uint8_t cdb[ISCSI_CDB_SIZE];	/* SCSI Command Block */
	/* Additional Data (Command Dependent) */
};

/* Command PDU flags */
#define ISCSI_FLAG_CMD_FINAL		0x80
#define ISCSI_FLAG_CMD_READ		0x40
#define ISCSI_FLAG_CMD_WRITE		0x20
#define ISCSI_FLAG_CMD_ATTR_MASK	0x07	/* 3 bits */

/* SCSI Command Attribute values */
#define ISCSI_ATTR_UNTAGGED		0
#define ISCSI_ATTR_SIMPLE		1
#define ISCSI_ATTR_ORDERED		2
#define ISCSI_ATTR_HEAD_OF_QUEUE	3
#define ISCSI_ATTR_ACA			4

struct iscsi_rlength_ahdr {
	__be16 ahslength;
	uint8_t ahstype;
	uint8_t reserved;
	__be32 read_length;
};

/* Extended CDB AHS */
struct iscsi_ecdb_ahdr {
	__be16 ahslength;	/* CDB length - 15, including reserved byte */
	uint8_t ahstype;
	uint8_t reserved;
	/* 4-byte aligned extended CDB spillover */
	uint8_t ecdb[SCSI_MAX_VARLEN_CDB_SIZE - ISCSI_CDB_SIZE];
};

/* SCSI Response Header */
struct iscsi_scsi_rsp {
	uint8_t opcode;
	uint8_t flags;
	uint8_t response;
	uint8_t cmd_status;
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t rsvd[8];
	itt_t	 itt;	/* Initiator Task Tag */
	__be32	rsvd1;
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	__be32	exp_datasn;
	__be32	bi_residual_count;
	__be32	residual_count;
	/* Response or Sense Data (optional) */
};

/* Command Response PDU flags */
#define ISCSI_FLAG_CMD_BIDI_OVERFLOW	0x10
#define ISCSI_FLAG_CMD_BIDI_UNDERFLOW	0x08
#define ISCSI_FLAG_CMD_OVERFLOW		0x04
#define ISCSI_FLAG_CMD_UNDERFLOW	0x02

/* iSCSI Status values. Valid if Rsp Selector bit is not set */
#define ISCSI_STATUS_CMD_COMPLETED	0
#define ISCSI_STATUS_TARGET_FAILURE	1
#define ISCSI_STATUS_SUBSYS_FAILURE	2

/* Asynchronous Event Header */
struct iscsi_async {
	uint8_t opcode;
	uint8_t flags;
	uint8_t rsvd2[2];
	uint8_t rsvd3;
	uint8_t dlength[3];
	struct scsi_lun	lun;
	uint8_t rsvd4[8];
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	uint8_t async_event;
	uint8_t async_vcode;
	__be16	param1;
	__be16	param2;
	__be16	param3;
	uint8_t rsvd5[4];
};

/* iSCSI Event Codes */
#define ISCSI_ASYNC_MSG_SCSI_EVENT			0
#define ISCSI_ASYNC_MSG_REQUEST_LOGOUT			1
#define ISCSI_ASYNC_MSG_DROPPING_CONNECTION		2
#define ISCSI_ASYNC_MSG_DROPPING_ALL_CONNECTIONS	3
#define ISCSI_ASYNC_MSG_PARAM_NEGOTIATION		4
#define ISCSI_ASYNC_MSG_VENDOR_SPECIFIC			255

/* NOP-Out Message */
struct iscsi_nopout {
	uint8_t opcode;
	uint8_t flags;
	__be16	rsvd2;
	uint8_t rsvd3;
	uint8_t dlength[3];
	struct scsi_lun	lun;
	itt_t	 itt;	/* Initiator Task Tag */
	__be32	ttt;	/* Target Transfer Tag */
	__be32	cmdsn;
	__be32	exp_statsn;
	uint8_t rsvd4[16];
};

/* NOP-In Message */
struct iscsi_nopin {
	uint8_t opcode;
	uint8_t flags;
	__be16	rsvd2;
	uint8_t rsvd3;
	uint8_t dlength[3];
	struct scsi_lun	lun;
	itt_t	 itt;	/* Initiator Task Tag */
	__be32	ttt;	/* Target Transfer Tag */
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	uint8_t rsvd4[12];
};

/* SCSI Task Management Message Header */
struct iscsi_tm {
	uint8_t opcode;
	uint8_t flags;
	uint8_t rsvd1[2];
	uint8_t hlength;
	uint8_t dlength[3];
	struct scsi_lun lun;
	itt_t	 itt;	/* Initiator Task Tag */
	itt_t	 rtt;	/* Reference Task Tag */
	__be32	cmdsn;
	__be32	exp_statsn;
	__be32	refcmdsn;
	__be32	exp_datasn;
	uint8_t rsvd2[8];
};

#define ISCSI_FLAG_TM_FUNC_MASK			0x7F

/* Function values */
#define ISCSI_TM_FUNC_ABORT_TASK		1
#define ISCSI_TM_FUNC_ABORT_TASK_SET		2
#define ISCSI_TM_FUNC_CLEAR_ACA			3
#define ISCSI_TM_FUNC_CLEAR_TASK_SET		4
#define ISCSI_TM_FUNC_LOGICAL_UNIT_RESET	5
#define ISCSI_TM_FUNC_TARGET_WARM_RESET		6
#define ISCSI_TM_FUNC_TARGET_COLD_RESET		7
#define ISCSI_TM_FUNC_TASK_REASSIGN		8

#define ISCSI_TM_FUNC_VALUE(hdr) ((hdr)->flags & ISCSI_FLAG_TM_FUNC_MASK)

/* SCSI Task Management Response Header */
struct iscsi_tm_rsp {
	uint8_t opcode;
	uint8_t flags;
	uint8_t response;	/* see Response values below */
	uint8_t qualifier;
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t rsvd2[8];
	itt_t	 itt;	/* Initiator Task Tag */
	itt_t	 rtt;	/* Reference Task Tag */
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	uint8_t rsvd3[12];
};

/* Response values */
#define ISCSI_TMF_RSP_COMPLETE		0x00
#define ISCSI_TMF_RSP_NO_TASK		0x01
#define ISCSI_TMF_RSP_NO_LUN		0x02
#define ISCSI_TMF_RSP_TASK_ALLEGIANT	0x03
#define ISCSI_TMF_RSP_NO_FAILOVER	0x04
#define ISCSI_TMF_RSP_NOT_SUPPORTED	0x05
#define ISCSI_TMF_RSP_AUTH_FAILED	0x06
#define ISCSI_TMF_RSP_REJECTED		0xff

/* Ready To Transfer Header */
struct iscsi_r2t_rsp {
	uint8_t opcode;
	uint8_t flags;
	uint8_t rsvd2[2];
	uint8_t	hlength;
	uint8_t	dlength[3];
	struct scsi_lun	lun;
	itt_t	 itt;	/* Initiator Task Tag */
	__be32	ttt;	/* Target Transfer Tag */
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	__be32	r2tsn;
	__be32	data_offset;
	__be32	data_length;
};

/* SCSI Data Hdr */
struct iscsi_data {
	uint8_t opcode;
	uint8_t flags;
	uint8_t rsvd2[2];
	uint8_t rsvd3;
	uint8_t dlength[3];
	struct scsi_lun lun;
	itt_t	 itt;
	__be32	ttt;
	__be32	rsvd4;
	__be32	exp_statsn;
	__be32	rsvd5;
	__be32	datasn;
	__be32	offset;
	__be32	rsvd6;
	/* Payload */
};

/* SCSI Data Response Hdr */
struct iscsi_data_rsp {
	uint8_t opcode;
	uint8_t flags;
	uint8_t rsvd2;
	uint8_t cmd_status;
	uint8_t hlength;
	uint8_t dlength[3];
	struct scsi_lun	lun;
	itt_t	 itt;
	__be32	ttt;
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	__be32	datasn;
	__be32	offset;
	__be32	residual_count;
};

/* Data Response PDU flags */
#define ISCSI_FLAG_DATA_ACK		0x40
#define ISCSI_FLAG_DATA_OVERFLOW	0x04
#define ISCSI_FLAG_DATA_UNDERFLOW	0x02
#define ISCSI_FLAG_DATA_STATUS		0x01

/* Text Header */
struct iscsi_text {
	uint8_t opcode;
	uint8_t flags;
	uint8_t rsvd2[2];
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t rsvd4[8];
	itt_t	 itt;
	__be32	ttt;
	__be32	cmdsn;
	__be32	exp_statsn;
	uint8_t rsvd5[16];
	/* Text - key=value pairs */
};

#define ISCSI_FLAG_TEXT_CONTINUE	0x40

/* Text Response Header */
struct iscsi_text_rsp {
	uint8_t opcode;
	uint8_t flags;
	uint8_t rsvd2[2];
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t rsvd4[8];
	itt_t	 itt;
	__be32	ttt;
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	uint8_t rsvd5[12];
	/* Text Response - key:value pairs */
};

/* Login Header */
struct iscsi_login_req {
	uint8_t opcode;
	uint8_t flags;
	uint8_t max_version;	/* Max. version supported */
	uint8_t min_version;	/* Min. version supported */
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t isid[6];	/* Initiator Session ID */
	__be16	tsih;	/* Target Session Handle */
	itt_t	 itt;	/* Initiator Task Tag */
	__be16	cid;
	__be16	rsvd3;
	__be32	cmdsn;
	__be32	exp_statsn;
	uint8_t rsvd5[16];
};

/* Login PDU flags */
#define ISCSI_FLAG_LOGIN_TRANSIT		0x80
#define ISCSI_FLAG_LOGIN_CONTINUE		0x40
#define ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK	0x0C	/* 2 bits */
#define ISCSI_FLAG_LOGIN_CURRENT_STAGE1		0x04
#define ISCSI_FLAG_LOGIN_CURRENT_STAGE2		0x08
#define ISCSI_FLAG_LOGIN_CURRENT_STAGE3		0x0C
#define ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK	0x03	/* 2 bits */
#define ISCSI_FLAG_LOGIN_NEXT_STAGE1		0x01
#define ISCSI_FLAG_LOGIN_NEXT_STAGE2		0x02
#define ISCSI_FLAG_LOGIN_NEXT_STAGE3		0x03

#define ISCSI_LOGIN_CURRENT_STAGE(flags) \
	((flags & ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK) >> 2)
#define ISCSI_LOGIN_NEXT_STAGE(flags) \
	(flags & ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK)

/* Login Response Header */
struct iscsi_login_rsp {
	uint8_t opcode;
	uint8_t flags;
	uint8_t max_version;	/* Max. version supported */
	uint8_t active_version;	/* Active version */
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t isid[6];	/* Initiator Session ID */
	__be16	tsih;	/* Target Session Handle */
	itt_t	 itt;	/* Initiator Task Tag */
	__be32	rsvd3;
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	uint8_t status_class;	/* see Login RSP ststus classes below */
	uint8_t status_detail;	/* see Login RSP Status details below */
	uint8_t rsvd4[10];
};

/* Login stage (phase) codes for CSG, NSG */
#define ISCSI_INITIAL_LOGIN_STAGE		-1
#define ISCSI_SECURITY_NEGOTIATION_STAGE	0
#define ISCSI_OP_PARMS_NEGOTIATION_STAGE	1
#define ISCSI_FULL_FEATURE_PHASE		3

/* Login Status response classes */
#define ISCSI_STATUS_CLS_SUCCESS		0x00
#define ISCSI_STATUS_CLS_REDIRECT		0x01
#define ISCSI_STATUS_CLS_INITIATOR_ERR		0x02
#define ISCSI_STATUS_CLS_TARGET_ERR		0x03

/* Login Status response detail codes */
/* Class-0 (Success) */
#define ISCSI_LOGIN_STATUS_ACCEPT		0x00

/* Class-1 (Redirection) */
#define ISCSI_LOGIN_STATUS_TGT_MOVED_TEMP	0x01
#define ISCSI_LOGIN_STATUS_TGT_MOVED_PERM	0x02

/* Class-2 (Initiator Error) */
#define ISCSI_LOGIN_STATUS_INIT_ERR		0x00
#define ISCSI_LOGIN_STATUS_AUTH_FAILED		0x01
#define ISCSI_LOGIN_STATUS_TGT_FORBIDDEN	0x02
#define ISCSI_LOGIN_STATUS_TGT_NOT_FOUND	0x03
#define ISCSI_LOGIN_STATUS_TGT_REMOVED		0x04
#define ISCSI_LOGIN_STATUS_NO_VERSION		0x05
#define ISCSI_LOGIN_STATUS_ISID_ERROR		0x06
#define ISCSI_LOGIN_STATUS_MISSING_FIELDS	0x07
#define ISCSI_LOGIN_STATUS_CONN_ADD_FAILED	0x08
#define ISCSI_LOGIN_STATUS_NO_SESSION_TYPE	0x09
#define ISCSI_LOGIN_STATUS_NO_SESSION		0x0a
#define ISCSI_LOGIN_STATUS_INVALID_REQUEST	0x0b

/* Class-3 (Target Error) */
#define ISCSI_LOGIN_STATUS_TARGET_ERROR		0x00
#define ISCSI_LOGIN_STATUS_SVC_UNAVAILABLE	0x01
#define ISCSI_LOGIN_STATUS_NO_RESOURCES		0x02

/* Logout Header */
struct iscsi_logout {
	uint8_t opcode;
	uint8_t flags;
	uint8_t rsvd1[2];
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t rsvd2[8];
	itt_t	 itt;	/* Initiator Task Tag */
	__be16	cid;
	uint8_t rsvd3[2];
	__be32	cmdsn;
	__be32	exp_statsn;
	uint8_t rsvd4[16];
};

/* Logout PDU flags */
#define ISCSI_FLAG_LOGOUT_REASON_MASK	0x7F

/* logout reason_code values */

#define ISCSI_LOGOUT_REASON_CLOSE_SESSION	0
#define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION	1
#define ISCSI_LOGOUT_REASON_RECOVERY		2
#define ISCSI_LOGOUT_REASON_AEN_REQUEST		3

/* Logout Response Header */
struct iscsi_logout_rsp {
	uint8_t opcode;
	uint8_t flags;
	uint8_t response;	/* see Logout response values below */
	uint8_t rsvd2;
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t rsvd3[8];
	itt_t	 itt;	/* Initiator Task Tag */
	__be32	rsvd4;
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	__be32	rsvd5;
	__be16	t2wait;
	__be16	t2retain;
	__be32	rsvd6;
};

/* logout response status values */

#define ISCSI_LOGOUT_SUCCESS			0
#define ISCSI_LOGOUT_CID_NOT_FOUND		1
#define ISCSI_LOGOUT_RECOVERY_UNSUPPORTED	2
#define ISCSI_LOGOUT_CLEANUP_FAILED		3

/* SNACK Header */
struct iscsi_snack {
	uint8_t opcode;
	uint8_t flags;
	uint8_t rsvd2[2];
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t lun[8];
	itt_t	 itt;
	__be32  ttt;
	uint8_t rsvd3[4];
	__be32  exp_statsn;
	uint8_t rsvd4[8];
	__be32	begrun;
	__be32	runlength;
};

/* SNACK PDU flags */
#define ISCSI_FLAG_SNACK_TYPE_DATA		0
#define ISCSI_FLAG_SNACK_TYPE_R2T		0
#define ISCSI_FLAG_SNACK_TYPE_STATUS		1
#define ISCSI_FLAG_SNACK_TYPE_DATA_ACK		2
#define ISCSI_FLAG_SNACK_TYPE_RDATA		3
#define ISCSI_FLAG_SNACK_TYPE_MASK	0x0F	/* 4 bits */

/* Reject Message Header */
struct iscsi_reject {
	uint8_t opcode;
	uint8_t flags;
	uint8_t reason;
	uint8_t rsvd2;
	uint8_t hlength;
	uint8_t dlength[3];
	uint8_t rsvd3[8];
	__be32  ffffffff;
	uint8_t rsvd4[4];
	__be32	statsn;
	__be32	exp_cmdsn;
	__be32	max_cmdsn;
	__be32	datasn;
	uint8_t rsvd5[8];
	/* Text - Rejected hdr */
};

/* Reason for Reject */
#define ISCSI_REASON_CMD_BEFORE_LOGIN	1
#define ISCSI_REASON_DATA_DIGEST_ERROR	2
#define ISCSI_REASON_DATA_SNACK_REJECT	3
#define ISCSI_REASON_PROTOCOL_ERROR	4
#define ISCSI_REASON_CMD_NOT_SUPPORTED	5
#define ISCSI_REASON_IMM_CMD_REJECT		6
#define ISCSI_REASON_TASK_IN_PROGRESS	7
#define ISCSI_REASON_INVALID_SNACK		8
#define ISCSI_REASON_BOOKMARK_INVALID	9
#define ISCSI_REASON_BOOKMARK_NO_RESOURCES	10
#define ISCSI_REASON_NEGOTIATION_RESET	11

/* Max. number of Key=Value pairs in a text message */
#define MAX_KEY_VALUE_PAIRS	8192

/* maximum length for text keys/values */
#define KEY_MAXLEN		64
#define VALUE_MAXLEN		255
#define TARGET_NAME_MAXLEN	VALUE_MAXLEN

#define ISCSI_DEF_MAX_RECV_SEG_LEN		8192
#define ISCSI_MIN_MAX_RECV_SEG_LEN		512
#define ISCSI_MAX_MAX_RECV_SEG_LEN		16777215

#define ISCSI_DEF_FIRST_BURST_LEN		65536
#define ISCSI_MIN_FIRST_BURST_LEN		512
#define ISCSI_MAX_FIRST_BURST_LEN		16777215

#define ISCSI_DEF_MAX_BURST_LEN			262144
#define ISCSI_MIN_MAX_BURST_LEN			512
#define ISCSI_MAX_MAX_BURST_LEN			16777215

#define ISCSI_DEF_TIME2WAIT			2

#define ISCSI_NAME_LEN				224

/************************* RFC 3720 End *****************************/

#endif /* ISCSI_PROTO_H */
Commit	Line	Data
39e84790 AA	1	/*
	2	* RFC 3720 (iSCSI) protocol data types
	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_PROTO_H
	22	#define ISCSI_PROTO_H
	23
26974789	24	#include <linux/types.h>
30e9ba9f	25	#include <scsi/scsi.h>
26974789	26
39e84790 AA	27	#define ISCSI_DRAFT20_VERSION 0x00
	28
	29	/* default iSCSI listen port for incoming connections */
	30	#define ISCSI_LISTEN_PORT 3260
	31
8304bbce NB	32	/* iSCSI header length */
	33	#define ISCSI_HDR_LEN 48
	34
	35	/* iSCSI CRC32C length */
	36	#define ISCSI_CRC_LEN 4
	37
39e84790	38	/* Padding word length */
004d6530	39	#define ISCSI_PAD_LEN 4
39e84790	40
8304bbce NB	41	/*
	42	* Serial Number Arithmetic, 32 bits, RFC1982
	43	*/
	44
	45	static inline int iscsi_sna_lt(u32 n1, u32 n2)
	46	{
	47	return (s32)(n1 - n2) < 0;
	48	}
	49
	50	static inline int iscsi_sna_lte(u32 n1, u32 n2)
	51	{
	52	return (s32)(n1 - n2) <= 0;
	53	}
	54
	55	static inline int iscsi_sna_gt(u32 n1, u32 n2)
	56	{
	57	return (s32)(n1 - n2) > 0;
	58	}
	59
	60	static inline int iscsi_sna_gte(u32 n1, u32 n2)
	61	{
	62	return (s32)(n1 - n2) >= 0;
	63	}
	64
39e84790 AA	65	/*
	66	* useful common(control and data pathes) macro
	67	*/
	68	#define ntoh24(p) (((p)[0] << 16) \| ((p)[1] << 8) \| ((p)[2]))
	69	#define hton24(p, v) { \
	70	p[0] = (((v) >> 16) & 0xFF); \
	71	p[1] = (((v) >> 8) & 0xFF); \
	72	p[2] = ((v) & 0xFF); \
	73	}
	74	#define zero_data(p) {p[0]=0;p[1]=0;p[2]=0;}
	75
b4377356	76	/* initiator tags; opaque for target */
9efeccac	77	typedef uint32_t __bitwise itt_t;
b4377356	78	/* below makes sense only for initiator that created this tag */
8b1d0343 MC	79	#define build_itt(itt, age) ((__force itt_t)\
8b1d0343 MC	80	((itt) \| ((age) << ISCSI_AGE_SHIFT)))
b4377356 AV	81	#define get_itt(itt) ((__force uint32_t)(itt_t)(itt) & ISCSI_ITT_MASK)
	82	#define RESERVED_ITT ((__force itt_t)0xffffffff)
	83
39e84790 AA	84	/*
	85	* iSCSI Template Message Header
	86	*/
	87	struct iscsi_hdr {
	88	uint8_t opcode;
	89	uint8_t flags; /* Final bit */
	90	uint8_t rsvd2[2];
	91	uint8_t hlength; /* AHSs total length */
	92	uint8_t dlength[3]; /* Data length */
55bdabdf	93	struct scsi_lun lun;
b4377356	94	itt_t itt; /* Initiator Task Tag, opaque for target */
39e84790 AA	95	__be32 ttt; /* Target Task Tag */
	96	__be32 statsn;
	97	__be32 exp_statsn;
baebc497 MC	98	__be32 max_statsn;
baebc497 MC	99	uint8_t other[12];
39e84790 AA	100	};
	101
	102	/*********************** RFC 3720 Begin ***************************/
	103
	104	#define ISCSI_RESERVED_TAG 0xffffffff
	105
	106	/* Opcode encoding bits */
	107	#define ISCSI_OP_RETRY 0x80
	108	#define ISCSI_OP_IMMEDIATE 0x40
	109	#define ISCSI_OPCODE_MASK 0x3F
	110
	111	/* Initiator Opcode values */
	112	#define ISCSI_OP_NOOP_OUT 0x00
	113	#define ISCSI_OP_SCSI_CMD 0x01
	114	#define ISCSI_OP_SCSI_TMFUNC 0x02
	115	#define ISCSI_OP_LOGIN 0x03
	116	#define ISCSI_OP_TEXT 0x04
	117	#define ISCSI_OP_SCSI_DATA_OUT 0x05
	118	#define ISCSI_OP_LOGOUT 0x06
	119	#define ISCSI_OP_SNACK 0x10
	120
baebc497 MC	121	#define ISCSI_OP_VENDOR1_CMD 0x1c
	122	#define ISCSI_OP_VENDOR2_CMD 0x1d
	123	#define ISCSI_OP_VENDOR3_CMD 0x1e
	124	#define ISCSI_OP_VENDOR4_CMD 0x1f
	125
39e84790 AA	126	/* Target Opcode values */
	127	#define ISCSI_OP_NOOP_IN 0x20
	128	#define ISCSI_OP_SCSI_CMD_RSP 0x21
	129	#define ISCSI_OP_SCSI_TMFUNC_RSP 0x22
	130	#define ISCSI_OP_LOGIN_RSP 0x23
	131	#define ISCSI_OP_TEXT_RSP 0x24
	132	#define ISCSI_OP_SCSI_DATA_IN 0x25
	133	#define ISCSI_OP_LOGOUT_RSP 0x26
	134	#define ISCSI_OP_R2T 0x31
	135	#define ISCSI_OP_ASYNC_EVENT 0x32
	136	#define ISCSI_OP_REJECT 0x3f
	137
baebc497 MC	138	struct iscsi_ahs_hdr {
	139	__be16 ahslength;
	140	uint8_t ahstype;
	141	uint8_t ahspec[5];
	142	};
	143
	144	#define ISCSI_AHSTYPE_CDB 1
	145	#define ISCSI_AHSTYPE_RLENGTH 2
38d1c069	146	#define ISCSI_CDB_SIZE 16
baebc497	147
39e84790	148	/* iSCSI PDU Header */
12352183	149	struct iscsi_scsi_req {
39e84790 AA	150	uint8_t opcode;
39e84790 AA	151	uint8_t flags;
baebc497	152	__be16 rsvd2;
39e84790 AA	153	uint8_t hlength;
39e84790 AA	154	uint8_t dlength[3];
55bdabdf	155	struct scsi_lun lun;
b4377356	156	itt_t itt; /* Initiator Task Tag */
39e84790 AA	157	__be32 data_length;
	158	__be32 cmdsn;
	159	__be32 exp_statsn;
38d1c069	160	uint8_t cdb[ISCSI_CDB_SIZE]; /* SCSI Command Block */
39e84790 AA	161	/* Additional Data (Command Dependent) */
	162	};
	163
	164	/* Command PDU flags */
	165	#define ISCSI_FLAG_CMD_FINAL 0x80
	166	#define ISCSI_FLAG_CMD_READ 0x40
	167	#define ISCSI_FLAG_CMD_WRITE 0x20
	168	#define ISCSI_FLAG_CMD_ATTR_MASK 0x07 /* 3 bits */
	169
	170	/* SCSI Command Attribute values */
	171	#define ISCSI_ATTR_UNTAGGED 0
	172	#define ISCSI_ATTR_SIMPLE 1
	173	#define ISCSI_ATTR_ORDERED 2
	174	#define ISCSI_ATTR_HEAD_OF_QUEUE 3
	175	#define ISCSI_ATTR_ACA 4
	176
baebc497 MC	177	struct iscsi_rlength_ahdr {
	178	__be16 ahslength;
	179	uint8_t ahstype;
	180	uint8_t reserved;
	181	__be32 read_length;
	182	};
	183
004d6530 BH	184	/* Extended CDB AHS */
	185	struct iscsi_ecdb_ahdr {
	186	__be16 ahslength; /* CDB length - 15, including reserved byte */
	187	uint8_t ahstype;
	188	uint8_t reserved;
38d1c069	189	/* 4-byte aligned extended CDB spillover */
30e9ba9f	190	uint8_t ecdb[SCSI_MAX_VARLEN_CDB_SIZE - ISCSI_CDB_SIZE];
004d6530 BH	191	};
004d6530 BH	192
39e84790	193	/* SCSI Response Header */
12352183	194	struct iscsi_scsi_rsp {
39e84790 AA	195	uint8_t opcode;
	196	uint8_t flags;
	197	uint8_t response;
	198	uint8_t cmd_status;
	199	uint8_t hlength;
	200	uint8_t dlength[3];
	201	uint8_t rsvd[8];
b4377356	202	itt_t itt; /* Initiator Task Tag */
39e84790 AA	203	__be32 rsvd1;
	204	__be32 statsn;
	205	__be32 exp_cmdsn;
	206	__be32 max_cmdsn;
	207	__be32 exp_datasn;
	208	__be32 bi_residual_count;
	209	__be32 residual_count;
	210	/* Response or Sense Data (optional) */
	211	};
	212
	213	/* Command Response PDU flags */
	214	#define ISCSI_FLAG_CMD_BIDI_OVERFLOW 0x10
	215	#define ISCSI_FLAG_CMD_BIDI_UNDERFLOW 0x08
	216	#define ISCSI_FLAG_CMD_OVERFLOW 0x04
	217	#define ISCSI_FLAG_CMD_UNDERFLOW 0x02
	218
	219	/* iSCSI Status values. Valid if Rsp Selector bit is not set */
	220	#define ISCSI_STATUS_CMD_COMPLETED 0
	221	#define ISCSI_STATUS_TARGET_FAILURE 1
	222	#define ISCSI_STATUS_SUBSYS_FAILURE 2
	223
	224	/* Asynchronous Event Header */
	225	struct iscsi_async {
	226	uint8_t opcode;
	227	uint8_t flags;
	228	uint8_t rsvd2[2];
	229	uint8_t rsvd3;
	230	uint8_t dlength[3];
55bdabdf	231	struct scsi_lun lun;
39e84790 AA	232	uint8_t rsvd4[8];
	233	__be32 statsn;
	234	__be32 exp_cmdsn;
	235	__be32 max_cmdsn;
	236	uint8_t async_event;
	237	uint8_t async_vcode;
	238	__be16 param1;
	239	__be16 param2;
	240	__be16 param3;
	241	uint8_t rsvd5[4];
	242	};
	243
	244	/* iSCSI Event Codes */
	245	#define ISCSI_ASYNC_MSG_SCSI_EVENT 0
	246	#define ISCSI_ASYNC_MSG_REQUEST_LOGOUT 1
	247	#define ISCSI_ASYNC_MSG_DROPPING_CONNECTION 2
	248	#define ISCSI_ASYNC_MSG_DROPPING_ALL_CONNECTIONS 3
	249	#define ISCSI_ASYNC_MSG_PARAM_NEGOTIATION 4
	250	#define ISCSI_ASYNC_MSG_VENDOR_SPECIFIC 255
	251
	252	/* NOP-Out Message */
	253	struct iscsi_nopout {
	254	uint8_t opcode;
	255	uint8_t flags;
	256	__be16 rsvd2;
	257	uint8_t rsvd3;
	258	uint8_t dlength[3];
55bdabdf	259	struct scsi_lun lun;
b4377356	260	itt_t itt; /* Initiator Task Tag */
39e84790 AA	261	__be32 ttt; /* Target Transfer Tag */
	262	__be32 cmdsn;
	263	__be32 exp_statsn;
	264	uint8_t rsvd4[16];
	265	};
	266
	267	/* NOP-In Message */
	268	struct iscsi_nopin {
	269	uint8_t opcode;
	270	uint8_t flags;
	271	__be16 rsvd2;
	272	uint8_t rsvd3;
	273	uint8_t dlength[3];
55bdabdf	274	struct scsi_lun lun;
b4377356	275	itt_t itt; /* Initiator Task Tag */
39e84790 AA	276	__be32 ttt; /* Target Transfer Tag */
	277	__be32 statsn;
	278	__be32 exp_cmdsn;
	279	__be32 max_cmdsn;
	280	uint8_t rsvd4[12];
	281	};
	282
	283	/* SCSI Task Management Message Header */
	284	struct iscsi_tm {
	285	uint8_t opcode;
	286	uint8_t flags;
	287	uint8_t rsvd1[2];
	288	uint8_t hlength;
	289	uint8_t dlength[3];
55bdabdf	290	struct scsi_lun lun;
b4377356 AV	291	itt_t itt; /* Initiator Task Tag */
b4377356 AV	292	itt_t rtt; /* Reference Task Tag */
39e84790 AA	293	__be32 cmdsn;
	294	__be32 exp_statsn;
	295	__be32 refcmdsn;
	296	__be32 exp_datasn;
	297	uint8_t rsvd2[8];
	298	};
	299
baebc497	300	#define ISCSI_FLAG_TM_FUNC_MASK 0x7F
39e84790 AA	301
	302	/* Function values */
	303	#define ISCSI_TM_FUNC_ABORT_TASK 1
	304	#define ISCSI_TM_FUNC_ABORT_TASK_SET 2
	305	#define ISCSI_TM_FUNC_CLEAR_ACA 3
	306	#define ISCSI_TM_FUNC_CLEAR_TASK_SET 4
	307	#define ISCSI_TM_FUNC_LOGICAL_UNIT_RESET 5
	308	#define ISCSI_TM_FUNC_TARGET_WARM_RESET 6
	309	#define ISCSI_TM_FUNC_TARGET_COLD_RESET 7
	310	#define ISCSI_TM_FUNC_TASK_REASSIGN 8
	311
5d12c05e MC	312	#define ISCSI_TM_FUNC_VALUE(hdr) ((hdr)->flags & ISCSI_FLAG_TM_FUNC_MASK)
5d12c05e MC	313
39e84790 AA	314	/* SCSI Task Management Response Header */
	315	struct iscsi_tm_rsp {
	316	uint8_t opcode;
	317	uint8_t flags;
	318	uint8_t response; /* see Response values below */
	319	uint8_t qualifier;
	320	uint8_t hlength;
	321	uint8_t dlength[3];
	322	uint8_t rsvd2[8];
b4377356 AV	323	itt_t itt; /* Initiator Task Tag */
b4377356 AV	324	itt_t rtt; /* Reference Task Tag */
39e84790 AA	325	__be32 statsn;
	326	__be32 exp_cmdsn;
	327	__be32 max_cmdsn;
	328	uint8_t rsvd3[12];
	329	};
	330
	331	/* Response values */
baebc497 MC	332	#define ISCSI_TMF_RSP_COMPLETE 0x00
	333	#define ISCSI_TMF_RSP_NO_TASK 0x01
	334	#define ISCSI_TMF_RSP_NO_LUN 0x02
	335	#define ISCSI_TMF_RSP_TASK_ALLEGIANT 0x03
	336	#define ISCSI_TMF_RSP_NO_FAILOVER 0x04
	337	#define ISCSI_TMF_RSP_NOT_SUPPORTED 0x05
	338	#define ISCSI_TMF_RSP_AUTH_FAILED 0x06
	339	#define ISCSI_TMF_RSP_REJECTED 0xff
39e84790 AA	340
	341	/* Ready To Transfer Header */
	342	struct iscsi_r2t_rsp {
	343	uint8_t opcode;
	344	uint8_t flags;
	345	uint8_t rsvd2[2];
	346	uint8_t hlength;
	347	uint8_t dlength[3];
55bdabdf	348	struct scsi_lun lun;
b4377356	349	itt_t itt; /* Initiator Task Tag */
39e84790 AA	350	__be32 ttt; /* Target Transfer Tag */
	351	__be32 statsn;
	352	__be32 exp_cmdsn;
	353	__be32 max_cmdsn;
	354	__be32 r2tsn;
	355	__be32 data_offset;
	356	__be32 data_length;
	357	};
	358
	359	/* SCSI Data Hdr */
	360	struct iscsi_data {
	361	uint8_t opcode;
	362	uint8_t flags;
	363	uint8_t rsvd2[2];
	364	uint8_t rsvd3;
	365	uint8_t dlength[3];
55bdabdf	366	struct scsi_lun lun;
b4377356	367	itt_t itt;
39e84790 AA	368	__be32 ttt;
	369	__be32 rsvd4;
	370	__be32 exp_statsn;
	371	__be32 rsvd5;
	372	__be32 datasn;
	373	__be32 offset;
	374	__be32 rsvd6;
	375	/* Payload */
	376	};
	377
	378	/* SCSI Data Response Hdr */
	379	struct iscsi_data_rsp {
	380	uint8_t opcode;
	381	uint8_t flags;
	382	uint8_t rsvd2;
	383	uint8_t cmd_status;
	384	uint8_t hlength;
	385	uint8_t dlength[3];
55bdabdf	386	struct scsi_lun lun;
b4377356	387	itt_t itt;
39e84790 AA	388	__be32 ttt;
	389	__be32 statsn;
	390	__be32 exp_cmdsn;
	391	__be32 max_cmdsn;
	392	__be32 datasn;
	393	__be32 offset;
	394	__be32 residual_count;
	395	};
	396
	397	/* Data Response PDU flags */
	398	#define ISCSI_FLAG_DATA_ACK 0x40
	399	#define ISCSI_FLAG_DATA_OVERFLOW 0x04
	400	#define ISCSI_FLAG_DATA_UNDERFLOW 0x02
	401	#define ISCSI_FLAG_DATA_STATUS 0x01
	402
	403	/* Text Header */
	404	struct iscsi_text {
	405	uint8_t opcode;
	406	uint8_t flags;
	407	uint8_t rsvd2[2];
	408	uint8_t hlength;
	409	uint8_t dlength[3];
	410	uint8_t rsvd4[8];
b4377356	411	itt_t itt;
39e84790 AA	412	__be32 ttt;
	413	__be32 cmdsn;
	414	__be32 exp_statsn;
	415	uint8_t rsvd5[16];
	416	/* Text - key=value pairs */
	417	};
	418
	419	#define ISCSI_FLAG_TEXT_CONTINUE 0x40
	420
	421	/* Text Response Header */
	422	struct iscsi_text_rsp {
	423	uint8_t opcode;
	424	uint8_t flags;
	425	uint8_t rsvd2[2];
	426	uint8_t hlength;
	427	uint8_t dlength[3];
	428	uint8_t rsvd4[8];
b4377356	429	itt_t itt;
39e84790 AA	430	__be32 ttt;
	431	__be32 statsn;
	432	__be32 exp_cmdsn;
	433	__be32 max_cmdsn;
	434	uint8_t rsvd5[12];
	435	/* Text Response - key:value pairs */
	436	};
	437
	438	/* Login Header */
12352183	439	struct iscsi_login_req {
39e84790 AA	440	uint8_t opcode;
	441	uint8_t flags;
	442	uint8_t max_version; /* Max. version supported */
	443	uint8_t min_version; /* Min. version supported */
	444	uint8_t hlength;
	445	uint8_t dlength[3];
	446	uint8_t isid[6]; /* Initiator Session ID */
	447	__be16 tsih; /* Target Session Handle */
b4377356	448	itt_t itt; /* Initiator Task Tag */
39e84790 AA	449	__be16 cid;
	450	__be16 rsvd3;
	451	__be32 cmdsn;
	452	__be32 exp_statsn;
	453	uint8_t rsvd5[16];
	454	};
	455
	456	/* Login PDU flags */
	457	#define ISCSI_FLAG_LOGIN_TRANSIT 0x80
	458	#define ISCSI_FLAG_LOGIN_CONTINUE 0x40
	459	#define ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK 0x0C /* 2 bits */
12352183 NB	460	#define ISCSI_FLAG_LOGIN_CURRENT_STAGE1 0x04
	461	#define ISCSI_FLAG_LOGIN_CURRENT_STAGE2 0x08
	462	#define ISCSI_FLAG_LOGIN_CURRENT_STAGE3 0x0C
39e84790	463	#define ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK 0x03 /* 2 bits */
12352183 NB	464	#define ISCSI_FLAG_LOGIN_NEXT_STAGE1 0x01
	465	#define ISCSI_FLAG_LOGIN_NEXT_STAGE2 0x02
	466	#define ISCSI_FLAG_LOGIN_NEXT_STAGE3 0x03
39e84790 AA	467
	468	#define ISCSI_LOGIN_CURRENT_STAGE(flags) \
	469	((flags & ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK) >> 2)
	470	#define ISCSI_LOGIN_NEXT_STAGE(flags) \
	471	(flags & ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK)
	472
	473	/* Login Response Header */
	474	struct iscsi_login_rsp {
	475	uint8_t opcode;
	476	uint8_t flags;
	477	uint8_t max_version; /* Max. version supported */
	478	uint8_t active_version; /* Active version */
	479	uint8_t hlength;
	480	uint8_t dlength[3];
	481	uint8_t isid[6]; /* Initiator Session ID */
	482	__be16 tsih; /* Target Session Handle */
b4377356	483	itt_t itt; /* Initiator Task Tag */
39e84790 AA	484	__be32 rsvd3;
	485	__be32 statsn;
	486	__be32 exp_cmdsn;
	487	__be32 max_cmdsn;
	488	uint8_t status_class; /* see Login RSP ststus classes below */
	489	uint8_t status_detail; /* see Login RSP Status details below */
	490	uint8_t rsvd4[10];
	491	};
	492
	493	/* Login stage (phase) codes for CSG, NSG */
	494	#define ISCSI_INITIAL_LOGIN_STAGE -1
	495	#define ISCSI_SECURITY_NEGOTIATION_STAGE 0
	496	#define ISCSI_OP_PARMS_NEGOTIATION_STAGE 1
	497	#define ISCSI_FULL_FEATURE_PHASE 3
	498
	499	/* Login Status response classes */
	500	#define ISCSI_STATUS_CLS_SUCCESS 0x00
	501	#define ISCSI_STATUS_CLS_REDIRECT 0x01
	502	#define ISCSI_STATUS_CLS_INITIATOR_ERR 0x02
	503	#define ISCSI_STATUS_CLS_TARGET_ERR 0x03
	504
	505	/* Login Status response detail codes */
	506	/* Class-0 (Success) */
	507	#define ISCSI_LOGIN_STATUS_ACCEPT 0x00
	508
	509	/* Class-1 (Redirection) */
	510	#define ISCSI_LOGIN_STATUS_TGT_MOVED_TEMP 0x01
	511	#define ISCSI_LOGIN_STATUS_TGT_MOVED_PERM 0x02
	512
	513	/* Class-2 (Initiator Error) */
	514	#define ISCSI_LOGIN_STATUS_INIT_ERR 0x00
	515	#define ISCSI_LOGIN_STATUS_AUTH_FAILED 0x01
	516	#define ISCSI_LOGIN_STATUS_TGT_FORBIDDEN 0x02
	517	#define ISCSI_LOGIN_STATUS_TGT_NOT_FOUND 0x03
	518	#define ISCSI_LOGIN_STATUS_TGT_REMOVED 0x04
	519	#define ISCSI_LOGIN_STATUS_NO_VERSION 0x05
	520	#define ISCSI_LOGIN_STATUS_ISID_ERROR 0x06
	521	#define ISCSI_LOGIN_STATUS_MISSING_FIELDS 0x07
	522	#define ISCSI_LOGIN_STATUS_CONN_ADD_FAILED 0x08
	523	#define ISCSI_LOGIN_STATUS_NO_SESSION_TYPE 0x09
	524	#define ISCSI_LOGIN_STATUS_NO_SESSION 0x0a
	525	#define ISCSI_LOGIN_STATUS_INVALID_REQUEST 0x0b
	526
	527	/* Class-3 (Target Error) */
	528	#define ISCSI_LOGIN_STATUS_TARGET_ERROR 0x00
	529	#define ISCSI_LOGIN_STATUS_SVC_UNAVAILABLE 0x01
	530	#define ISCSI_LOGIN_STATUS_NO_RESOURCES 0x02
	531
	532	/* Logout Header */
	533	struct iscsi_logout {
	534	uint8_t opcode;
	535	uint8_t flags;
	536	uint8_t rsvd1[2];
	537	uint8_t hlength;
	538	uint8_t dlength[3];
	539	uint8_t rsvd2[8];
b4377356	540	itt_t itt; /* Initiator Task Tag */
39e84790 AA	541	__be16 cid;
	542	uint8_t rsvd3[2];
	543	__be32 cmdsn;
	544	__be32 exp_statsn;
	545	uint8_t rsvd4[16];
	546	};
	547
	548	/* Logout PDU flags */
	549	#define ISCSI_FLAG_LOGOUT_REASON_MASK 0x7F
	550
	551	/* logout reason_code values */
	552
	553	#define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
	554	#define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
	555	#define ISCSI_LOGOUT_REASON_RECOVERY 2
	556	#define ISCSI_LOGOUT_REASON_AEN_REQUEST 3
	557
	558	/* Logout Response Header */
	559	struct iscsi_logout_rsp {
	560	uint8_t opcode;
	561	uint8_t flags;
	562	uint8_t response; /* see Logout response values below */
	563	uint8_t rsvd2;
	564	uint8_t hlength;
	565	uint8_t dlength[3];
	566	uint8_t rsvd3[8];
b4377356	567	itt_t itt; /* Initiator Task Tag */
39e84790 AA	568	__be32 rsvd4;
	569	__be32 statsn;
	570	__be32 exp_cmdsn;
	571	__be32 max_cmdsn;
	572	__be32 rsvd5;
	573	__be16 t2wait;
	574	__be16 t2retain;
	575	__be32 rsvd6;
	576	};
	577
	578	/* logout response status values */
	579
	580	#define ISCSI_LOGOUT_SUCCESS 0
	581	#define ISCSI_LOGOUT_CID_NOT_FOUND 1
	582	#define ISCSI_LOGOUT_RECOVERY_UNSUPPORTED 2
	583	#define ISCSI_LOGOUT_CLEANUP_FAILED 3
	584
	585	/* SNACK Header */
	586	struct iscsi_snack {
	587	uint8_t opcode;
	588	uint8_t flags;
12352183 NB	589	uint8_t rsvd2[2];
	590	uint8_t hlength;
	591	uint8_t dlength[3];
	592	uint8_t lun[8];
b4377356	593	itt_t itt;
12352183 NB	594	__be32 ttt;
	595	uint8_t rsvd3[4];
	596	__be32 exp_statsn;
	597	uint8_t rsvd4[8];
39e84790 AA	598	__be32 begrun;
39e84790 AA	599	__be32 runlength;
39e84790 AA	600	};
	601
	602	/* SNACK PDU flags */
12352183 NB	603	#define ISCSI_FLAG_SNACK_TYPE_DATA 0
	604	#define ISCSI_FLAG_SNACK_TYPE_R2T 0
	605	#define ISCSI_FLAG_SNACK_TYPE_STATUS 1
	606	#define ISCSI_FLAG_SNACK_TYPE_DATA_ACK 2
	607	#define ISCSI_FLAG_SNACK_TYPE_RDATA 3
39e84790 AA	608	#define ISCSI_FLAG_SNACK_TYPE_MASK 0x0F /* 4 bits */
	609
	610	/* Reject Message Header */
	611	struct iscsi_reject {
	612	uint8_t opcode;
	613	uint8_t flags;
	614	uint8_t reason;
	615	uint8_t rsvd2;
fa0a6957	616	uint8_t hlength;
39e84790	617	uint8_t dlength[3];
fa0a6957 MC	618	uint8_t rsvd3[8];
	619	__be32 ffffffff;
	620	uint8_t rsvd4[4];
39e84790 AA	621	__be32 statsn;
	622	__be32 exp_cmdsn;
	623	__be32 max_cmdsn;
	624	__be32 datasn;
	625	uint8_t rsvd5[8];
	626	/* Text - Rejected hdr */
	627	};
	628
	629	/* Reason for Reject */
fa0a6957 MC	630	#define ISCSI_REASON_CMD_BEFORE_LOGIN 1
	631	#define ISCSI_REASON_DATA_DIGEST_ERROR 2
	632	#define ISCSI_REASON_DATA_SNACK_REJECT 3
	633	#define ISCSI_REASON_PROTOCOL_ERROR 4
	634	#define ISCSI_REASON_CMD_NOT_SUPPORTED 5
	635	#define ISCSI_REASON_IMM_CMD_REJECT 6
	636	#define ISCSI_REASON_TASK_IN_PROGRESS 7
	637	#define ISCSI_REASON_INVALID_SNACK 8
	638	#define ISCSI_REASON_BOOKMARK_INVALID 9
	639	#define ISCSI_REASON_BOOKMARK_NO_RESOURCES 10
	640	#define ISCSI_REASON_NEGOTIATION_RESET 11
39e84790 AA	641
	642	/* Max. number of Key=Value pairs in a text message */
	643	#define MAX_KEY_VALUE_PAIRS 8192
	644
	645	/* maximum length for text keys/values */
	646	#define KEY_MAXLEN 64
	647	#define VALUE_MAXLEN 255
	648	#define TARGET_NAME_MAXLEN VALUE_MAXLEN
	649
bf32ed33 MC	650	#define ISCSI_DEF_MAX_RECV_SEG_LEN 8192
	651	#define ISCSI_MIN_MAX_RECV_SEG_LEN 512
	652	#define ISCSI_MAX_MAX_RECV_SEG_LEN 16777215
	653
	654	#define ISCSI_DEF_FIRST_BURST_LEN 65536
	655	#define ISCSI_MIN_FIRST_BURST_LEN 512
	656	#define ISCSI_MAX_FIRST_BURST_LEN 16777215
	657
	658	#define ISCSI_DEF_MAX_BURST_LEN 262144
	659	#define ISCSI_MIN_MAX_BURST_LEN 512
	660	#define ISCSI_MAX_MAX_BURST_LEN 16777215
39e84790	661
843c0a8a MC	662	#define ISCSI_DEF_TIME2WAIT 2
843c0a8a MC	663
2177199d JSJ	664	#define ISCSI_NAME_LEN 224
2177199d JSJ	665
39e84790 AA	666	/*********************** RFC 3720 End ***************************/
	667
	668	#endif /* ISCSI_PROTO_H */