1c942fddfSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-or-later */
239e84790SAlex Aizman /*
339e84790SAlex Aizman * RFC 3720 (iSCSI) protocol data types
439e84790SAlex Aizman *
539e84790SAlex Aizman * Copyright (C) 2005 Dmitry Yusupov
639e84790SAlex Aizman * Copyright (C) 2005 Alex Aizman
739e84790SAlex Aizman * maintained by open-iscsi@googlegroups.com
839e84790SAlex Aizman */
939e84790SAlex Aizman
1039e84790SAlex Aizman #ifndef ISCSI_PROTO_H
1139e84790SAlex Aizman #define ISCSI_PROTO_H
1239e84790SAlex Aizman
1326974789SMike Christie #include <linux/types.h>
1430e9ba9fSBoaz Harrosh #include <scsi/scsi.h>
1526974789SMike Christie
1639e84790SAlex Aizman #define ISCSI_DRAFT20_VERSION 0x00
1739e84790SAlex Aizman
1839e84790SAlex Aizman /* default iSCSI listen port for incoming connections */
1939e84790SAlex Aizman #define ISCSI_LISTEN_PORT 3260
2039e84790SAlex Aizman
218304bbceSNicholas Bellinger /* iSCSI header length */
228304bbceSNicholas Bellinger #define ISCSI_HDR_LEN 48
238304bbceSNicholas Bellinger
248304bbceSNicholas Bellinger /* iSCSI CRC32C length */
258304bbceSNicholas Bellinger #define ISCSI_CRC_LEN 4
268304bbceSNicholas Bellinger
2739e84790SAlex Aizman /* Padding word length */
28004d6530SBoaz Harrosh #define ISCSI_PAD_LEN 4
2939e84790SAlex Aizman
3039e84790SAlex Aizman /*
318304bbceSNicholas Bellinger * Serial Number Arithmetic, 32 bits, RFC1982
328304bbceSNicholas Bellinger */
338304bbceSNicholas Bellinger
iscsi_sna_lt(u32 n1,u32 n2)348304bbceSNicholas Bellinger static inline int iscsi_sna_lt(u32 n1, u32 n2)
358304bbceSNicholas Bellinger {
368304bbceSNicholas Bellinger return (s32)(n1 - n2) < 0;
378304bbceSNicholas Bellinger }
388304bbceSNicholas Bellinger
iscsi_sna_lte(u32 n1,u32 n2)398304bbceSNicholas Bellinger static inline int iscsi_sna_lte(u32 n1, u32 n2)
408304bbceSNicholas Bellinger {
418304bbceSNicholas Bellinger return (s32)(n1 - n2) <= 0;
428304bbceSNicholas Bellinger }
438304bbceSNicholas Bellinger
iscsi_sna_gt(u32 n1,u32 n2)448304bbceSNicholas Bellinger static inline int iscsi_sna_gt(u32 n1, u32 n2)
458304bbceSNicholas Bellinger {
468304bbceSNicholas Bellinger return (s32)(n1 - n2) > 0;
478304bbceSNicholas Bellinger }
488304bbceSNicholas Bellinger
iscsi_sna_gte(u32 n1,u32 n2)498304bbceSNicholas Bellinger static inline int iscsi_sna_gte(u32 n1, u32 n2)
508304bbceSNicholas Bellinger {
518304bbceSNicholas Bellinger return (s32)(n1 - n2) >= 0;
528304bbceSNicholas Bellinger }
538304bbceSNicholas Bellinger
548304bbceSNicholas Bellinger /*
55*40d6b939SZhen Lei * useful common(control and data paths) macro
5639e84790SAlex Aizman */
5739e84790SAlex Aizman #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2]))
5839e84790SAlex Aizman #define hton24(p, v) { \
5939e84790SAlex Aizman p[0] = (((v) >> 16) & 0xFF); \
6039e84790SAlex Aizman p[1] = (((v) >> 8) & 0xFF); \
6139e84790SAlex Aizman p[2] = ((v) & 0xFF); \
6239e84790SAlex Aizman }
6339e84790SAlex Aizman #define zero_data(p) {p[0]=0;p[1]=0;p[2]=0;}
6439e84790SAlex Aizman
65b4377356SAl Viro /* initiator tags; opaque for target */
669efeccacSMichael S. Tsirkin typedef uint32_t __bitwise itt_t;
67b4377356SAl Viro /* below makes sense only for initiator that created this tag */
688b1d0343SMike Christie #define build_itt(itt, age) ((__force itt_t)\
698b1d0343SMike Christie ((itt) | ((age) << ISCSI_AGE_SHIFT)))
70b4377356SAl Viro #define get_itt(itt) ((__force uint32_t)(itt_t)(itt) & ISCSI_ITT_MASK)
71b4377356SAl Viro #define RESERVED_ITT ((__force itt_t)0xffffffff)
72b4377356SAl Viro
7339e84790SAlex Aizman /*
7439e84790SAlex Aizman * iSCSI Template Message Header
7539e84790SAlex Aizman */
7639e84790SAlex Aizman struct iscsi_hdr {
7739e84790SAlex Aizman uint8_t opcode;
7839e84790SAlex Aizman uint8_t flags; /* Final bit */
7939e84790SAlex Aizman uint8_t rsvd2[2];
8039e84790SAlex Aizman uint8_t hlength; /* AHSs total length */
8139e84790SAlex Aizman uint8_t dlength[3]; /* Data length */
8255bdabdfSAndy Grover struct scsi_lun lun;
83b4377356SAl Viro itt_t itt; /* Initiator Task Tag, opaque for target */
8439e84790SAlex Aizman __be32 ttt; /* Target Task Tag */
8539e84790SAlex Aizman __be32 statsn;
8639e84790SAlex Aizman __be32 exp_statsn;
87baebc497SMike Christie __be32 max_statsn;
88baebc497SMike Christie uint8_t other[12];
8939e84790SAlex Aizman };
9039e84790SAlex Aizman
9139e84790SAlex Aizman /************************* RFC 3720 Begin *****************************/
9239e84790SAlex Aizman
9339e84790SAlex Aizman #define ISCSI_RESERVED_TAG 0xffffffff
9439e84790SAlex Aizman
9539e84790SAlex Aizman /* Opcode encoding bits */
9639e84790SAlex Aizman #define ISCSI_OP_RETRY 0x80
9739e84790SAlex Aizman #define ISCSI_OP_IMMEDIATE 0x40
9839e84790SAlex Aizman #define ISCSI_OPCODE_MASK 0x3F
9939e84790SAlex Aizman
10039e84790SAlex Aizman /* Initiator Opcode values */
10139e84790SAlex Aizman #define ISCSI_OP_NOOP_OUT 0x00
10239e84790SAlex Aizman #define ISCSI_OP_SCSI_CMD 0x01
10339e84790SAlex Aizman #define ISCSI_OP_SCSI_TMFUNC 0x02
10439e84790SAlex Aizman #define ISCSI_OP_LOGIN 0x03
10539e84790SAlex Aizman #define ISCSI_OP_TEXT 0x04
10639e84790SAlex Aizman #define ISCSI_OP_SCSI_DATA_OUT 0x05
10739e84790SAlex Aizman #define ISCSI_OP_LOGOUT 0x06
10839e84790SAlex Aizman #define ISCSI_OP_SNACK 0x10
10939e84790SAlex Aizman
110baebc497SMike Christie #define ISCSI_OP_VENDOR1_CMD 0x1c
111baebc497SMike Christie #define ISCSI_OP_VENDOR2_CMD 0x1d
112baebc497SMike Christie #define ISCSI_OP_VENDOR3_CMD 0x1e
113baebc497SMike Christie #define ISCSI_OP_VENDOR4_CMD 0x1f
114baebc497SMike Christie
11539e84790SAlex Aizman /* Target Opcode values */
11639e84790SAlex Aizman #define ISCSI_OP_NOOP_IN 0x20
11739e84790SAlex Aizman #define ISCSI_OP_SCSI_CMD_RSP 0x21
11839e84790SAlex Aizman #define ISCSI_OP_SCSI_TMFUNC_RSP 0x22
11939e84790SAlex Aizman #define ISCSI_OP_LOGIN_RSP 0x23
12039e84790SAlex Aizman #define ISCSI_OP_TEXT_RSP 0x24
12139e84790SAlex Aizman #define ISCSI_OP_SCSI_DATA_IN 0x25
12239e84790SAlex Aizman #define ISCSI_OP_LOGOUT_RSP 0x26
12339e84790SAlex Aizman #define ISCSI_OP_R2T 0x31
12439e84790SAlex Aizman #define ISCSI_OP_ASYNC_EVENT 0x32
12539e84790SAlex Aizman #define ISCSI_OP_REJECT 0x3f
12639e84790SAlex Aizman
127baebc497SMike Christie struct iscsi_ahs_hdr {
128baebc497SMike Christie __be16 ahslength;
129baebc497SMike Christie uint8_t ahstype;
130baebc497SMike Christie uint8_t ahspec[5];
131baebc497SMike Christie };
132baebc497SMike Christie
133baebc497SMike Christie #define ISCSI_AHSTYPE_CDB 1
134baebc497SMike Christie #define ISCSI_AHSTYPE_RLENGTH 2
13538d1c069SBoaz Harrosh #define ISCSI_CDB_SIZE 16
136baebc497SMike Christie
13739e84790SAlex Aizman /* iSCSI PDU Header */
13812352183SNicholas Bellinger struct iscsi_scsi_req {
13939e84790SAlex Aizman uint8_t opcode;
14039e84790SAlex Aizman uint8_t flags;
141baebc497SMike Christie __be16 rsvd2;
14239e84790SAlex Aizman uint8_t hlength;
14339e84790SAlex Aizman uint8_t dlength[3];
14455bdabdfSAndy Grover struct scsi_lun lun;
145b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
14639e84790SAlex Aizman __be32 data_length;
14739e84790SAlex Aizman __be32 cmdsn;
14839e84790SAlex Aizman __be32 exp_statsn;
14938d1c069SBoaz Harrosh uint8_t cdb[ISCSI_CDB_SIZE]; /* SCSI Command Block */
15039e84790SAlex Aizman /* Additional Data (Command Dependent) */
15139e84790SAlex Aizman };
15239e84790SAlex Aizman
15339e84790SAlex Aizman /* Command PDU flags */
15439e84790SAlex Aizman #define ISCSI_FLAG_CMD_FINAL 0x80
15539e84790SAlex Aizman #define ISCSI_FLAG_CMD_READ 0x40
15639e84790SAlex Aizman #define ISCSI_FLAG_CMD_WRITE 0x20
15739e84790SAlex Aizman #define ISCSI_FLAG_CMD_ATTR_MASK 0x07 /* 3 bits */
15839e84790SAlex Aizman
15939e84790SAlex Aizman /* SCSI Command Attribute values */
16039e84790SAlex Aizman #define ISCSI_ATTR_UNTAGGED 0
16139e84790SAlex Aizman #define ISCSI_ATTR_SIMPLE 1
16239e84790SAlex Aizman #define ISCSI_ATTR_ORDERED 2
16339e84790SAlex Aizman #define ISCSI_ATTR_HEAD_OF_QUEUE 3
16439e84790SAlex Aizman #define ISCSI_ATTR_ACA 4
16539e84790SAlex Aizman
166baebc497SMike Christie struct iscsi_rlength_ahdr {
167baebc497SMike Christie __be16 ahslength;
168baebc497SMike Christie uint8_t ahstype;
169baebc497SMike Christie uint8_t reserved;
170baebc497SMike Christie __be32 read_length;
171baebc497SMike Christie };
172baebc497SMike Christie
173004d6530SBoaz Harrosh /* Extended CDB AHS */
174004d6530SBoaz Harrosh struct iscsi_ecdb_ahdr {
175004d6530SBoaz Harrosh __be16 ahslength; /* CDB length - 15, including reserved byte */
176004d6530SBoaz Harrosh uint8_t ahstype;
177004d6530SBoaz Harrosh uint8_t reserved;
17838d1c069SBoaz Harrosh /* 4-byte aligned extended CDB spillover */
17930e9ba9fSBoaz Harrosh uint8_t ecdb[SCSI_MAX_VARLEN_CDB_SIZE - ISCSI_CDB_SIZE];
180004d6530SBoaz Harrosh };
181004d6530SBoaz Harrosh
18239e84790SAlex Aizman /* SCSI Response Header */
18312352183SNicholas Bellinger struct iscsi_scsi_rsp {
18439e84790SAlex Aizman uint8_t opcode;
18539e84790SAlex Aizman uint8_t flags;
18639e84790SAlex Aizman uint8_t response;
18739e84790SAlex Aizman uint8_t cmd_status;
18839e84790SAlex Aizman uint8_t hlength;
18939e84790SAlex Aizman uint8_t dlength[3];
19039e84790SAlex Aizman uint8_t rsvd[8];
191b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
19239e84790SAlex Aizman __be32 rsvd1;
19339e84790SAlex Aizman __be32 statsn;
19439e84790SAlex Aizman __be32 exp_cmdsn;
19539e84790SAlex Aizman __be32 max_cmdsn;
19639e84790SAlex Aizman __be32 exp_datasn;
19739e84790SAlex Aizman __be32 bi_residual_count;
19839e84790SAlex Aizman __be32 residual_count;
19939e84790SAlex Aizman /* Response or Sense Data (optional) */
20039e84790SAlex Aizman };
20139e84790SAlex Aizman
20239e84790SAlex Aizman /* Command Response PDU flags */
20339e84790SAlex Aizman #define ISCSI_FLAG_CMD_BIDI_OVERFLOW 0x10
20439e84790SAlex Aizman #define ISCSI_FLAG_CMD_BIDI_UNDERFLOW 0x08
20539e84790SAlex Aizman #define ISCSI_FLAG_CMD_OVERFLOW 0x04
20639e84790SAlex Aizman #define ISCSI_FLAG_CMD_UNDERFLOW 0x02
20739e84790SAlex Aizman
20839e84790SAlex Aizman /* iSCSI Status values. Valid if Rsp Selector bit is not set */
20939e84790SAlex Aizman #define ISCSI_STATUS_CMD_COMPLETED 0
21039e84790SAlex Aizman #define ISCSI_STATUS_TARGET_FAILURE 1
21139e84790SAlex Aizman #define ISCSI_STATUS_SUBSYS_FAILURE 2
21239e84790SAlex Aizman
21339e84790SAlex Aizman /* Asynchronous Event Header */
21439e84790SAlex Aizman struct iscsi_async {
21539e84790SAlex Aizman uint8_t opcode;
21639e84790SAlex Aizman uint8_t flags;
21739e84790SAlex Aizman uint8_t rsvd2[2];
21839e84790SAlex Aizman uint8_t rsvd3;
21939e84790SAlex Aizman uint8_t dlength[3];
22055bdabdfSAndy Grover struct scsi_lun lun;
22139e84790SAlex Aizman uint8_t rsvd4[8];
22239e84790SAlex Aizman __be32 statsn;
22339e84790SAlex Aizman __be32 exp_cmdsn;
22439e84790SAlex Aizman __be32 max_cmdsn;
22539e84790SAlex Aizman uint8_t async_event;
22639e84790SAlex Aizman uint8_t async_vcode;
22739e84790SAlex Aizman __be16 param1;
22839e84790SAlex Aizman __be16 param2;
22939e84790SAlex Aizman __be16 param3;
23039e84790SAlex Aizman uint8_t rsvd5[4];
23139e84790SAlex Aizman };
23239e84790SAlex Aizman
23339e84790SAlex Aizman /* iSCSI Event Codes */
23439e84790SAlex Aizman #define ISCSI_ASYNC_MSG_SCSI_EVENT 0
23539e84790SAlex Aizman #define ISCSI_ASYNC_MSG_REQUEST_LOGOUT 1
23639e84790SAlex Aizman #define ISCSI_ASYNC_MSG_DROPPING_CONNECTION 2
23739e84790SAlex Aizman #define ISCSI_ASYNC_MSG_DROPPING_ALL_CONNECTIONS 3
23839e84790SAlex Aizman #define ISCSI_ASYNC_MSG_PARAM_NEGOTIATION 4
23939e84790SAlex Aizman #define ISCSI_ASYNC_MSG_VENDOR_SPECIFIC 255
24039e84790SAlex Aizman
24139e84790SAlex Aizman /* NOP-Out Message */
24239e84790SAlex Aizman struct iscsi_nopout {
24339e84790SAlex Aizman uint8_t opcode;
24439e84790SAlex Aizman uint8_t flags;
24539e84790SAlex Aizman __be16 rsvd2;
24639e84790SAlex Aizman uint8_t rsvd3;
24739e84790SAlex Aizman uint8_t dlength[3];
24855bdabdfSAndy Grover struct scsi_lun lun;
249b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
25039e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */
25139e84790SAlex Aizman __be32 cmdsn;
25239e84790SAlex Aizman __be32 exp_statsn;
25339e84790SAlex Aizman uint8_t rsvd4[16];
25439e84790SAlex Aizman };
25539e84790SAlex Aizman
25639e84790SAlex Aizman /* NOP-In Message */
25739e84790SAlex Aizman struct iscsi_nopin {
25839e84790SAlex Aizman uint8_t opcode;
25939e84790SAlex Aizman uint8_t flags;
26039e84790SAlex Aizman __be16 rsvd2;
26139e84790SAlex Aizman uint8_t rsvd3;
26239e84790SAlex Aizman uint8_t dlength[3];
26355bdabdfSAndy Grover struct scsi_lun lun;
264b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
26539e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */
26639e84790SAlex Aizman __be32 statsn;
26739e84790SAlex Aizman __be32 exp_cmdsn;
26839e84790SAlex Aizman __be32 max_cmdsn;
26939e84790SAlex Aizman uint8_t rsvd4[12];
27039e84790SAlex Aizman };
27139e84790SAlex Aizman
27239e84790SAlex Aizman /* SCSI Task Management Message Header */
27339e84790SAlex Aizman struct iscsi_tm {
27439e84790SAlex Aizman uint8_t opcode;
27539e84790SAlex Aizman uint8_t flags;
27639e84790SAlex Aizman uint8_t rsvd1[2];
27739e84790SAlex Aizman uint8_t hlength;
27839e84790SAlex Aizman uint8_t dlength[3];
27955bdabdfSAndy Grover struct scsi_lun lun;
280b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
281b4377356SAl Viro itt_t rtt; /* Reference Task Tag */
28239e84790SAlex Aizman __be32 cmdsn;
28339e84790SAlex Aizman __be32 exp_statsn;
28439e84790SAlex Aizman __be32 refcmdsn;
28539e84790SAlex Aizman __be32 exp_datasn;
28639e84790SAlex Aizman uint8_t rsvd2[8];
28739e84790SAlex Aizman };
28839e84790SAlex Aizman
289baebc497SMike Christie #define ISCSI_FLAG_TM_FUNC_MASK 0x7F
29039e84790SAlex Aizman
29139e84790SAlex Aizman /* Function values */
29239e84790SAlex Aizman #define ISCSI_TM_FUNC_ABORT_TASK 1
29339e84790SAlex Aizman #define ISCSI_TM_FUNC_ABORT_TASK_SET 2
29439e84790SAlex Aizman #define ISCSI_TM_FUNC_CLEAR_ACA 3
29539e84790SAlex Aizman #define ISCSI_TM_FUNC_CLEAR_TASK_SET 4
29639e84790SAlex Aizman #define ISCSI_TM_FUNC_LOGICAL_UNIT_RESET 5
29739e84790SAlex Aizman #define ISCSI_TM_FUNC_TARGET_WARM_RESET 6
29839e84790SAlex Aizman #define ISCSI_TM_FUNC_TARGET_COLD_RESET 7
29939e84790SAlex Aizman #define ISCSI_TM_FUNC_TASK_REASSIGN 8
30039e84790SAlex Aizman
3015d12c05eSMike Christie #define ISCSI_TM_FUNC_VALUE(hdr) ((hdr)->flags & ISCSI_FLAG_TM_FUNC_MASK)
3025d12c05eSMike Christie
30339e84790SAlex Aizman /* SCSI Task Management Response Header */
30439e84790SAlex Aizman struct iscsi_tm_rsp {
30539e84790SAlex Aizman uint8_t opcode;
30639e84790SAlex Aizman uint8_t flags;
30739e84790SAlex Aizman uint8_t response; /* see Response values below */
30839e84790SAlex Aizman uint8_t qualifier;
30939e84790SAlex Aizman uint8_t hlength;
31039e84790SAlex Aizman uint8_t dlength[3];
31139e84790SAlex Aizman uint8_t rsvd2[8];
312b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
313b4377356SAl Viro itt_t rtt; /* Reference Task Tag */
31439e84790SAlex Aizman __be32 statsn;
31539e84790SAlex Aizman __be32 exp_cmdsn;
31639e84790SAlex Aizman __be32 max_cmdsn;
31739e84790SAlex Aizman uint8_t rsvd3[12];
31839e84790SAlex Aizman };
31939e84790SAlex Aizman
32039e84790SAlex Aizman /* Response values */
321baebc497SMike Christie #define ISCSI_TMF_RSP_COMPLETE 0x00
322baebc497SMike Christie #define ISCSI_TMF_RSP_NO_TASK 0x01
323baebc497SMike Christie #define ISCSI_TMF_RSP_NO_LUN 0x02
324baebc497SMike Christie #define ISCSI_TMF_RSP_TASK_ALLEGIANT 0x03
325baebc497SMike Christie #define ISCSI_TMF_RSP_NO_FAILOVER 0x04
326baebc497SMike Christie #define ISCSI_TMF_RSP_NOT_SUPPORTED 0x05
327baebc497SMike Christie #define ISCSI_TMF_RSP_AUTH_FAILED 0x06
328baebc497SMike Christie #define ISCSI_TMF_RSP_REJECTED 0xff
32939e84790SAlex Aizman
33039e84790SAlex Aizman /* Ready To Transfer Header */
33139e84790SAlex Aizman struct iscsi_r2t_rsp {
33239e84790SAlex Aizman uint8_t opcode;
33339e84790SAlex Aizman uint8_t flags;
33439e84790SAlex Aizman uint8_t rsvd2[2];
33539e84790SAlex Aizman uint8_t hlength;
33639e84790SAlex Aizman uint8_t dlength[3];
33755bdabdfSAndy Grover struct scsi_lun lun;
338b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
33939e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */
34039e84790SAlex Aizman __be32 statsn;
34139e84790SAlex Aizman __be32 exp_cmdsn;
34239e84790SAlex Aizman __be32 max_cmdsn;
34339e84790SAlex Aizman __be32 r2tsn;
34439e84790SAlex Aizman __be32 data_offset;
34539e84790SAlex Aizman __be32 data_length;
34639e84790SAlex Aizman };
34739e84790SAlex Aizman
34839e84790SAlex Aizman /* SCSI Data Hdr */
34939e84790SAlex Aizman struct iscsi_data {
35039e84790SAlex Aizman uint8_t opcode;
35139e84790SAlex Aizman uint8_t flags;
35239e84790SAlex Aizman uint8_t rsvd2[2];
35339e84790SAlex Aizman uint8_t rsvd3;
35439e84790SAlex Aizman uint8_t dlength[3];
35555bdabdfSAndy Grover struct scsi_lun lun;
356b4377356SAl Viro itt_t itt;
35739e84790SAlex Aizman __be32 ttt;
35839e84790SAlex Aizman __be32 rsvd4;
35939e84790SAlex Aizman __be32 exp_statsn;
36039e84790SAlex Aizman __be32 rsvd5;
36139e84790SAlex Aizman __be32 datasn;
36239e84790SAlex Aizman __be32 offset;
36339e84790SAlex Aizman __be32 rsvd6;
36439e84790SAlex Aizman /* Payload */
36539e84790SAlex Aizman };
36639e84790SAlex Aizman
36739e84790SAlex Aizman /* SCSI Data Response Hdr */
36839e84790SAlex Aizman struct iscsi_data_rsp {
36939e84790SAlex Aizman uint8_t opcode;
37039e84790SAlex Aizman uint8_t flags;
37139e84790SAlex Aizman uint8_t rsvd2;
37239e84790SAlex Aizman uint8_t cmd_status;
37339e84790SAlex Aizman uint8_t hlength;
37439e84790SAlex Aizman uint8_t dlength[3];
37555bdabdfSAndy Grover struct scsi_lun lun;
376b4377356SAl Viro itt_t itt;
37739e84790SAlex Aizman __be32 ttt;
37839e84790SAlex Aizman __be32 statsn;
37939e84790SAlex Aizman __be32 exp_cmdsn;
38039e84790SAlex Aizman __be32 max_cmdsn;
38139e84790SAlex Aizman __be32 datasn;
38239e84790SAlex Aizman __be32 offset;
38339e84790SAlex Aizman __be32 residual_count;
38439e84790SAlex Aizman };
38539e84790SAlex Aizman
38639e84790SAlex Aizman /* Data Response PDU flags */
38739e84790SAlex Aizman #define ISCSI_FLAG_DATA_ACK 0x40
38839e84790SAlex Aizman #define ISCSI_FLAG_DATA_OVERFLOW 0x04
38939e84790SAlex Aizman #define ISCSI_FLAG_DATA_UNDERFLOW 0x02
39039e84790SAlex Aizman #define ISCSI_FLAG_DATA_STATUS 0x01
39139e84790SAlex Aizman
39239e84790SAlex Aizman /* Text Header */
39339e84790SAlex Aizman struct iscsi_text {
39439e84790SAlex Aizman uint8_t opcode;
39539e84790SAlex Aizman uint8_t flags;
39639e84790SAlex Aizman uint8_t rsvd2[2];
39739e84790SAlex Aizman uint8_t hlength;
39839e84790SAlex Aizman uint8_t dlength[3];
39939e84790SAlex Aizman uint8_t rsvd4[8];
400b4377356SAl Viro itt_t itt;
40139e84790SAlex Aizman __be32 ttt;
40239e84790SAlex Aizman __be32 cmdsn;
40339e84790SAlex Aizman __be32 exp_statsn;
40439e84790SAlex Aizman uint8_t rsvd5[16];
40539e84790SAlex Aizman /* Text - key=value pairs */
40639e84790SAlex Aizman };
40739e84790SAlex Aizman
40839e84790SAlex Aizman #define ISCSI_FLAG_TEXT_CONTINUE 0x40
40939e84790SAlex Aizman
41039e84790SAlex Aizman /* Text Response Header */
41139e84790SAlex Aizman struct iscsi_text_rsp {
41239e84790SAlex Aizman uint8_t opcode;
41339e84790SAlex Aizman uint8_t flags;
41439e84790SAlex Aizman uint8_t rsvd2[2];
41539e84790SAlex Aizman uint8_t hlength;
41639e84790SAlex Aizman uint8_t dlength[3];
41739e84790SAlex Aizman uint8_t rsvd4[8];
418b4377356SAl Viro itt_t itt;
41939e84790SAlex Aizman __be32 ttt;
42039e84790SAlex Aizman __be32 statsn;
42139e84790SAlex Aizman __be32 exp_cmdsn;
42239e84790SAlex Aizman __be32 max_cmdsn;
42339e84790SAlex Aizman uint8_t rsvd5[12];
42439e84790SAlex Aizman /* Text Response - key:value pairs */
42539e84790SAlex Aizman };
42639e84790SAlex Aizman
42739e84790SAlex Aizman /* Login Header */
42812352183SNicholas Bellinger struct iscsi_login_req {
42939e84790SAlex Aizman uint8_t opcode;
43039e84790SAlex Aizman uint8_t flags;
43139e84790SAlex Aizman uint8_t max_version; /* Max. version supported */
43239e84790SAlex Aizman uint8_t min_version; /* Min. version supported */
43339e84790SAlex Aizman uint8_t hlength;
43439e84790SAlex Aizman uint8_t dlength[3];
43539e84790SAlex Aizman uint8_t isid[6]; /* Initiator Session ID */
43639e84790SAlex Aizman __be16 tsih; /* Target Session Handle */
437b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
43839e84790SAlex Aizman __be16 cid;
43939e84790SAlex Aizman __be16 rsvd3;
44039e84790SAlex Aizman __be32 cmdsn;
44139e84790SAlex Aizman __be32 exp_statsn;
44239e84790SAlex Aizman uint8_t rsvd5[16];
44339e84790SAlex Aizman };
44439e84790SAlex Aizman
44539e84790SAlex Aizman /* Login PDU flags */
44639e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_TRANSIT 0x80
44739e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_CONTINUE 0x40
44839e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK 0x0C /* 2 bits */
44912352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_CURRENT_STAGE1 0x04
45012352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_CURRENT_STAGE2 0x08
45112352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_CURRENT_STAGE3 0x0C
45239e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK 0x03 /* 2 bits */
45312352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_NEXT_STAGE1 0x01
45412352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_NEXT_STAGE2 0x02
45512352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_NEXT_STAGE3 0x03
45639e84790SAlex Aizman
45739e84790SAlex Aizman #define ISCSI_LOGIN_CURRENT_STAGE(flags) \
45839e84790SAlex Aizman ((flags & ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK) >> 2)
45939e84790SAlex Aizman #define ISCSI_LOGIN_NEXT_STAGE(flags) \
46039e84790SAlex Aizman (flags & ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK)
46139e84790SAlex Aizman
46239e84790SAlex Aizman /* Login Response Header */
46339e84790SAlex Aizman struct iscsi_login_rsp {
46439e84790SAlex Aizman uint8_t opcode;
46539e84790SAlex Aizman uint8_t flags;
46639e84790SAlex Aizman uint8_t max_version; /* Max. version supported */
46739e84790SAlex Aizman uint8_t active_version; /* Active version */
46839e84790SAlex Aizman uint8_t hlength;
46939e84790SAlex Aizman uint8_t dlength[3];
47039e84790SAlex Aizman uint8_t isid[6]; /* Initiator Session ID */
47139e84790SAlex Aizman __be16 tsih; /* Target Session Handle */
472b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
47339e84790SAlex Aizman __be32 rsvd3;
47439e84790SAlex Aizman __be32 statsn;
47539e84790SAlex Aizman __be32 exp_cmdsn;
47639e84790SAlex Aizman __be32 max_cmdsn;
47739e84790SAlex Aizman uint8_t status_class; /* see Login RSP ststus classes below */
47839e84790SAlex Aizman uint8_t status_detail; /* see Login RSP Status details below */
47939e84790SAlex Aizman uint8_t rsvd4[10];
48039e84790SAlex Aizman };
48139e84790SAlex Aizman
48239e84790SAlex Aizman /* Login stage (phase) codes for CSG, NSG */
48339e84790SAlex Aizman #define ISCSI_INITIAL_LOGIN_STAGE -1
48439e84790SAlex Aizman #define ISCSI_SECURITY_NEGOTIATION_STAGE 0
48539e84790SAlex Aizman #define ISCSI_OP_PARMS_NEGOTIATION_STAGE 1
48639e84790SAlex Aizman #define ISCSI_FULL_FEATURE_PHASE 3
48739e84790SAlex Aizman
48839e84790SAlex Aizman /* Login Status response classes */
48939e84790SAlex Aizman #define ISCSI_STATUS_CLS_SUCCESS 0x00
49039e84790SAlex Aizman #define ISCSI_STATUS_CLS_REDIRECT 0x01
49139e84790SAlex Aizman #define ISCSI_STATUS_CLS_INITIATOR_ERR 0x02
49239e84790SAlex Aizman #define ISCSI_STATUS_CLS_TARGET_ERR 0x03
49339e84790SAlex Aizman
49439e84790SAlex Aizman /* Login Status response detail codes */
49539e84790SAlex Aizman /* Class-0 (Success) */
49639e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_ACCEPT 0x00
49739e84790SAlex Aizman
49839e84790SAlex Aizman /* Class-1 (Redirection) */
49939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_MOVED_TEMP 0x01
50039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_MOVED_PERM 0x02
50139e84790SAlex Aizman
50239e84790SAlex Aizman /* Class-2 (Initiator Error) */
50339e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_INIT_ERR 0x00
50439e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_AUTH_FAILED 0x01
50539e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_FORBIDDEN 0x02
50639e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_NOT_FOUND 0x03
50739e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_REMOVED 0x04
50839e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_VERSION 0x05
50939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_ISID_ERROR 0x06
51039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_MISSING_FIELDS 0x07
51139e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_CONN_ADD_FAILED 0x08
51239e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_SESSION_TYPE 0x09
51339e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_SESSION 0x0a
51439e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_INVALID_REQUEST 0x0b
51539e84790SAlex Aizman
51639e84790SAlex Aizman /* Class-3 (Target Error) */
51739e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TARGET_ERROR 0x00
51839e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_SVC_UNAVAILABLE 0x01
51939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_RESOURCES 0x02
52039e84790SAlex Aizman
52139e84790SAlex Aizman /* Logout Header */
52239e84790SAlex Aizman struct iscsi_logout {
52339e84790SAlex Aizman uint8_t opcode;
52439e84790SAlex Aizman uint8_t flags;
52539e84790SAlex Aizman uint8_t rsvd1[2];
52639e84790SAlex Aizman uint8_t hlength;
52739e84790SAlex Aizman uint8_t dlength[3];
52839e84790SAlex Aizman uint8_t rsvd2[8];
529b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
53039e84790SAlex Aizman __be16 cid;
53139e84790SAlex Aizman uint8_t rsvd3[2];
53239e84790SAlex Aizman __be32 cmdsn;
53339e84790SAlex Aizman __be32 exp_statsn;
53439e84790SAlex Aizman uint8_t rsvd4[16];
53539e84790SAlex Aizman };
53639e84790SAlex Aizman
53739e84790SAlex Aizman /* Logout PDU flags */
53839e84790SAlex Aizman #define ISCSI_FLAG_LOGOUT_REASON_MASK 0x7F
53939e84790SAlex Aizman
54039e84790SAlex Aizman /* logout reason_code values */
54139e84790SAlex Aizman
54239e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0
54339e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1
54439e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_RECOVERY 2
54539e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_AEN_REQUEST 3
54639e84790SAlex Aizman
54739e84790SAlex Aizman /* Logout Response Header */
54839e84790SAlex Aizman struct iscsi_logout_rsp {
54939e84790SAlex Aizman uint8_t opcode;
55039e84790SAlex Aizman uint8_t flags;
55139e84790SAlex Aizman uint8_t response; /* see Logout response values below */
55239e84790SAlex Aizman uint8_t rsvd2;
55339e84790SAlex Aizman uint8_t hlength;
55439e84790SAlex Aizman uint8_t dlength[3];
55539e84790SAlex Aizman uint8_t rsvd3[8];
556b4377356SAl Viro itt_t itt; /* Initiator Task Tag */
55739e84790SAlex Aizman __be32 rsvd4;
55839e84790SAlex Aizman __be32 statsn;
55939e84790SAlex Aizman __be32 exp_cmdsn;
56039e84790SAlex Aizman __be32 max_cmdsn;
56139e84790SAlex Aizman __be32 rsvd5;
56239e84790SAlex Aizman __be16 t2wait;
56339e84790SAlex Aizman __be16 t2retain;
56439e84790SAlex Aizman __be32 rsvd6;
56539e84790SAlex Aizman };
56639e84790SAlex Aizman
56739e84790SAlex Aizman /* logout response status values */
56839e84790SAlex Aizman
56939e84790SAlex Aizman #define ISCSI_LOGOUT_SUCCESS 0
57039e84790SAlex Aizman #define ISCSI_LOGOUT_CID_NOT_FOUND 1
57139e84790SAlex Aizman #define ISCSI_LOGOUT_RECOVERY_UNSUPPORTED 2
57239e84790SAlex Aizman #define ISCSI_LOGOUT_CLEANUP_FAILED 3
57339e84790SAlex Aizman
57439e84790SAlex Aizman /* SNACK Header */
57539e84790SAlex Aizman struct iscsi_snack {
57639e84790SAlex Aizman uint8_t opcode;
57739e84790SAlex Aizman uint8_t flags;
57812352183SNicholas Bellinger uint8_t rsvd2[2];
57912352183SNicholas Bellinger uint8_t hlength;
58012352183SNicholas Bellinger uint8_t dlength[3];
58112352183SNicholas Bellinger uint8_t lun[8];
582b4377356SAl Viro itt_t itt;
58312352183SNicholas Bellinger __be32 ttt;
58412352183SNicholas Bellinger uint8_t rsvd3[4];
58512352183SNicholas Bellinger __be32 exp_statsn;
58612352183SNicholas Bellinger uint8_t rsvd4[8];
58739e84790SAlex Aizman __be32 begrun;
58839e84790SAlex Aizman __be32 runlength;
58939e84790SAlex Aizman };
59039e84790SAlex Aizman
59139e84790SAlex Aizman /* SNACK PDU flags */
59212352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_DATA 0
59312352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_R2T 0
59412352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_STATUS 1
59512352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_DATA_ACK 2
59612352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_RDATA 3
59739e84790SAlex Aizman #define ISCSI_FLAG_SNACK_TYPE_MASK 0x0F /* 4 bits */
59839e84790SAlex Aizman
59939e84790SAlex Aizman /* Reject Message Header */
60039e84790SAlex Aizman struct iscsi_reject {
60139e84790SAlex Aizman uint8_t opcode;
60239e84790SAlex Aizman uint8_t flags;
60339e84790SAlex Aizman uint8_t reason;
60439e84790SAlex Aizman uint8_t rsvd2;
605fa0a6957SMike Christie uint8_t hlength;
60639e84790SAlex Aizman uint8_t dlength[3];
607fa0a6957SMike Christie uint8_t rsvd3[8];
608fa0a6957SMike Christie __be32 ffffffff;
609fa0a6957SMike Christie uint8_t rsvd4[4];
61039e84790SAlex Aizman __be32 statsn;
61139e84790SAlex Aizman __be32 exp_cmdsn;
61239e84790SAlex Aizman __be32 max_cmdsn;
61339e84790SAlex Aizman __be32 datasn;
61439e84790SAlex Aizman uint8_t rsvd5[8];
61539e84790SAlex Aizman /* Text - Rejected hdr */
61639e84790SAlex Aizman };
61739e84790SAlex Aizman
61839e84790SAlex Aizman /* Reason for Reject */
619fa0a6957SMike Christie #define ISCSI_REASON_CMD_BEFORE_LOGIN 1
620fa0a6957SMike Christie #define ISCSI_REASON_DATA_DIGEST_ERROR 2
621fa0a6957SMike Christie #define ISCSI_REASON_DATA_SNACK_REJECT 3
622fa0a6957SMike Christie #define ISCSI_REASON_PROTOCOL_ERROR 4
623fa0a6957SMike Christie #define ISCSI_REASON_CMD_NOT_SUPPORTED 5
624fa0a6957SMike Christie #define ISCSI_REASON_IMM_CMD_REJECT 6
625fa0a6957SMike Christie #define ISCSI_REASON_TASK_IN_PROGRESS 7
626fa0a6957SMike Christie #define ISCSI_REASON_INVALID_SNACK 8
627fa0a6957SMike Christie #define ISCSI_REASON_BOOKMARK_INVALID 9
628fa0a6957SMike Christie #define ISCSI_REASON_BOOKMARK_NO_RESOURCES 10
629fa0a6957SMike Christie #define ISCSI_REASON_NEGOTIATION_RESET 11
63039e84790SAlex Aizman
63139e84790SAlex Aizman /* Max. number of Key=Value pairs in a text message */
63239e84790SAlex Aizman #define MAX_KEY_VALUE_PAIRS 8192
63339e84790SAlex Aizman
63439e84790SAlex Aizman /* maximum length for text keys/values */
63539e84790SAlex Aizman #define KEY_MAXLEN 64
63639e84790SAlex Aizman #define VALUE_MAXLEN 255
63739e84790SAlex Aizman #define TARGET_NAME_MAXLEN VALUE_MAXLEN
63839e84790SAlex Aizman
639bf32ed33SMike Christie #define ISCSI_DEF_MAX_RECV_SEG_LEN 8192
640bf32ed33SMike Christie #define ISCSI_MIN_MAX_RECV_SEG_LEN 512
641bf32ed33SMike Christie #define ISCSI_MAX_MAX_RECV_SEG_LEN 16777215
642bf32ed33SMike Christie
643bf32ed33SMike Christie #define ISCSI_DEF_FIRST_BURST_LEN 65536
644bf32ed33SMike Christie #define ISCSI_MIN_FIRST_BURST_LEN 512
645bf32ed33SMike Christie #define ISCSI_MAX_FIRST_BURST_LEN 16777215
646bf32ed33SMike Christie
647bf32ed33SMike Christie #define ISCSI_DEF_MAX_BURST_LEN 262144
648bf32ed33SMike Christie #define ISCSI_MIN_MAX_BURST_LEN 512
649bf32ed33SMike Christie #define ISCSI_MAX_MAX_BURST_LEN 16777215
65039e84790SAlex Aizman
651843c0a8aSMike Christie #define ISCSI_DEF_TIME2WAIT 2
652843c0a8aSMike Christie
6532177199dSJohn Soni Jose #define ISCSI_NAME_LEN 224
6542177199dSJohn Soni Jose
65539e84790SAlex Aizman /************************* RFC 3720 End *****************************/
65639e84790SAlex Aizman
65739e84790SAlex Aizman #endif /* ISCSI_PROTO_H */
658