139e84790SAlex Aizman /* 239e84790SAlex Aizman * RFC 3720 (iSCSI) protocol data types 339e84790SAlex Aizman * 439e84790SAlex Aizman * Copyright (C) 2005 Dmitry Yusupov 539e84790SAlex Aizman * Copyright (C) 2005 Alex Aizman 639e84790SAlex Aizman * maintained by open-iscsi@googlegroups.com 739e84790SAlex Aizman * 839e84790SAlex Aizman * This program is free software; you can redistribute it and/or modify 939e84790SAlex Aizman * it under the terms of the GNU General Public License as published 1039e84790SAlex Aizman * by the Free Software Foundation; either version 2 of the License, or 1139e84790SAlex Aizman * (at your option) any later version. 1239e84790SAlex Aizman * 1339e84790SAlex Aizman * This program is distributed in the hope that it will be useful, but 1439e84790SAlex Aizman * WITHOUT ANY WARRANTY; without even the implied warranty of 1539e84790SAlex Aizman * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 1639e84790SAlex Aizman * General Public License for more details. 1739e84790SAlex Aizman * 1839e84790SAlex Aizman * See the file COPYING included with this distribution for more details. 1939e84790SAlex Aizman */ 2039e84790SAlex Aizman 2139e84790SAlex Aizman #ifndef ISCSI_PROTO_H 2239e84790SAlex Aizman #define ISCSI_PROTO_H 2339e84790SAlex Aizman 2439e84790SAlex Aizman #define ISCSI_DRAFT20_VERSION 0x00 2539e84790SAlex Aizman 2639e84790SAlex Aizman /* default iSCSI listen port for incoming connections */ 2739e84790SAlex Aizman #define ISCSI_LISTEN_PORT 3260 2839e84790SAlex Aizman 2939e84790SAlex Aizman /* Padding word length */ 3039e84790SAlex Aizman #define PAD_WORD_LEN 4 3139e84790SAlex Aizman 3239e84790SAlex Aizman /* 3339e84790SAlex Aizman * useful common(control and data pathes) macro 3439e84790SAlex Aizman */ 3539e84790SAlex Aizman #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) 3639e84790SAlex Aizman #define hton24(p, v) { \ 3739e84790SAlex Aizman p[0] = (((v) >> 16) & 0xFF); \ 3839e84790SAlex Aizman p[1] = (((v) >> 8) & 0xFF); \ 3939e84790SAlex Aizman p[2] = ((v) & 0xFF); \ 4039e84790SAlex Aizman } 4139e84790SAlex Aizman #define zero_data(p) {p[0]=0;p[1]=0;p[2]=0;} 4239e84790SAlex Aizman 43b4377356SAl Viro /* initiator tags; opaque for target */ 44b4377356SAl Viro typedef uint32_t __bitwise__ itt_t; 45b4377356SAl Viro /* below makes sense only for initiator that created this tag */ 46b4377356SAl Viro #define build_itt(itt, id, age) ((__force itt_t)\ 47b4377356SAl Viro ((itt) | ((id) << ISCSI_CID_SHIFT) | ((age) << ISCSI_AGE_SHIFT))) 48b4377356SAl Viro #define get_itt(itt) ((__force uint32_t)(itt_t)(itt) & ISCSI_ITT_MASK) 49b4377356SAl Viro #define RESERVED_ITT ((__force itt_t)0xffffffff) 50b4377356SAl Viro 5139e84790SAlex Aizman /* 5239e84790SAlex Aizman * iSCSI Template Message Header 5339e84790SAlex Aizman */ 5439e84790SAlex Aizman struct iscsi_hdr { 5539e84790SAlex Aizman uint8_t opcode; 5639e84790SAlex Aizman uint8_t flags; /* Final bit */ 5739e84790SAlex Aizman uint8_t rsvd2[2]; 5839e84790SAlex Aizman uint8_t hlength; /* AHSs total length */ 5939e84790SAlex Aizman uint8_t dlength[3]; /* Data length */ 6039e84790SAlex Aizman uint8_t lun[8]; 61b4377356SAl Viro itt_t itt; /* Initiator Task Tag, opaque for target */ 6239e84790SAlex Aizman __be32 ttt; /* Target Task Tag */ 6339e84790SAlex Aizman __be32 statsn; 6439e84790SAlex Aizman __be32 exp_statsn; 65baebc497SMike Christie __be32 max_statsn; 66baebc497SMike Christie uint8_t other[12]; 6739e84790SAlex Aizman }; 6839e84790SAlex Aizman 6939e84790SAlex Aizman /************************* RFC 3720 Begin *****************************/ 7039e84790SAlex Aizman 7139e84790SAlex Aizman #define ISCSI_RESERVED_TAG 0xffffffff 7239e84790SAlex Aizman 7339e84790SAlex Aizman /* Opcode encoding bits */ 7439e84790SAlex Aizman #define ISCSI_OP_RETRY 0x80 7539e84790SAlex Aizman #define ISCSI_OP_IMMEDIATE 0x40 7639e84790SAlex Aizman #define ISCSI_OPCODE_MASK 0x3F 7739e84790SAlex Aizman 7839e84790SAlex Aizman /* Initiator Opcode values */ 7939e84790SAlex Aizman #define ISCSI_OP_NOOP_OUT 0x00 8039e84790SAlex Aizman #define ISCSI_OP_SCSI_CMD 0x01 8139e84790SAlex Aizman #define ISCSI_OP_SCSI_TMFUNC 0x02 8239e84790SAlex Aizman #define ISCSI_OP_LOGIN 0x03 8339e84790SAlex Aizman #define ISCSI_OP_TEXT 0x04 8439e84790SAlex Aizman #define ISCSI_OP_SCSI_DATA_OUT 0x05 8539e84790SAlex Aizman #define ISCSI_OP_LOGOUT 0x06 8639e84790SAlex Aizman #define ISCSI_OP_SNACK 0x10 8739e84790SAlex Aizman 88baebc497SMike Christie #define ISCSI_OP_VENDOR1_CMD 0x1c 89baebc497SMike Christie #define ISCSI_OP_VENDOR2_CMD 0x1d 90baebc497SMike Christie #define ISCSI_OP_VENDOR3_CMD 0x1e 91baebc497SMike Christie #define ISCSI_OP_VENDOR4_CMD 0x1f 92baebc497SMike Christie 9339e84790SAlex Aizman /* Target Opcode values */ 9439e84790SAlex Aizman #define ISCSI_OP_NOOP_IN 0x20 9539e84790SAlex Aizman #define ISCSI_OP_SCSI_CMD_RSP 0x21 9639e84790SAlex Aizman #define ISCSI_OP_SCSI_TMFUNC_RSP 0x22 9739e84790SAlex Aizman #define ISCSI_OP_LOGIN_RSP 0x23 9839e84790SAlex Aizman #define ISCSI_OP_TEXT_RSP 0x24 9939e84790SAlex Aizman #define ISCSI_OP_SCSI_DATA_IN 0x25 10039e84790SAlex Aizman #define ISCSI_OP_LOGOUT_RSP 0x26 10139e84790SAlex Aizman #define ISCSI_OP_R2T 0x31 10239e84790SAlex Aizman #define ISCSI_OP_ASYNC_EVENT 0x32 10339e84790SAlex Aizman #define ISCSI_OP_REJECT 0x3f 10439e84790SAlex Aizman 105baebc497SMike Christie struct iscsi_ahs_hdr { 106baebc497SMike Christie __be16 ahslength; 107baebc497SMike Christie uint8_t ahstype; 108baebc497SMike Christie uint8_t ahspec[5]; 109baebc497SMike Christie }; 110baebc497SMike Christie 111baebc497SMike Christie #define ISCSI_AHSTYPE_CDB 1 112baebc497SMike Christie #define ISCSI_AHSTYPE_RLENGTH 2 113baebc497SMike Christie 11439e84790SAlex Aizman /* iSCSI PDU Header */ 11539e84790SAlex Aizman struct iscsi_cmd { 11639e84790SAlex Aizman uint8_t opcode; 11739e84790SAlex Aizman uint8_t flags; 118baebc497SMike Christie __be16 rsvd2; 11939e84790SAlex Aizman uint8_t hlength; 12039e84790SAlex Aizman uint8_t dlength[3]; 12139e84790SAlex Aizman uint8_t lun[8]; 122b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 12339e84790SAlex Aizman __be32 data_length; 12439e84790SAlex Aizman __be32 cmdsn; 12539e84790SAlex Aizman __be32 exp_statsn; 12639e84790SAlex Aizman uint8_t cdb[16]; /* SCSI Command Block */ 12739e84790SAlex Aizman /* Additional Data (Command Dependent) */ 12839e84790SAlex Aizman }; 12939e84790SAlex Aizman 13039e84790SAlex Aizman /* Command PDU flags */ 13139e84790SAlex Aizman #define ISCSI_FLAG_CMD_FINAL 0x80 13239e84790SAlex Aizman #define ISCSI_FLAG_CMD_READ 0x40 13339e84790SAlex Aizman #define ISCSI_FLAG_CMD_WRITE 0x20 13439e84790SAlex Aizman #define ISCSI_FLAG_CMD_ATTR_MASK 0x07 /* 3 bits */ 13539e84790SAlex Aizman 13639e84790SAlex Aizman /* SCSI Command Attribute values */ 13739e84790SAlex Aizman #define ISCSI_ATTR_UNTAGGED 0 13839e84790SAlex Aizman #define ISCSI_ATTR_SIMPLE 1 13939e84790SAlex Aizman #define ISCSI_ATTR_ORDERED 2 14039e84790SAlex Aizman #define ISCSI_ATTR_HEAD_OF_QUEUE 3 14139e84790SAlex Aizman #define ISCSI_ATTR_ACA 4 14239e84790SAlex Aizman 143baebc497SMike Christie struct iscsi_rlength_ahdr { 144baebc497SMike Christie __be16 ahslength; 145baebc497SMike Christie uint8_t ahstype; 146baebc497SMike Christie uint8_t reserved; 147baebc497SMike Christie __be32 read_length; 148baebc497SMike Christie }; 149baebc497SMike Christie 15039e84790SAlex Aizman /* SCSI Response Header */ 15139e84790SAlex Aizman struct iscsi_cmd_rsp { 15239e84790SAlex Aizman uint8_t opcode; 15339e84790SAlex Aizman uint8_t flags; 15439e84790SAlex Aizman uint8_t response; 15539e84790SAlex Aizman uint8_t cmd_status; 15639e84790SAlex Aizman uint8_t hlength; 15739e84790SAlex Aizman uint8_t dlength[3]; 15839e84790SAlex Aizman uint8_t rsvd[8]; 159b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 16039e84790SAlex Aizman __be32 rsvd1; 16139e84790SAlex Aizman __be32 statsn; 16239e84790SAlex Aizman __be32 exp_cmdsn; 16339e84790SAlex Aizman __be32 max_cmdsn; 16439e84790SAlex Aizman __be32 exp_datasn; 16539e84790SAlex Aizman __be32 bi_residual_count; 16639e84790SAlex Aizman __be32 residual_count; 16739e84790SAlex Aizman /* Response or Sense Data (optional) */ 16839e84790SAlex Aizman }; 16939e84790SAlex Aizman 17039e84790SAlex Aizman /* Command Response PDU flags */ 17139e84790SAlex Aizman #define ISCSI_FLAG_CMD_BIDI_OVERFLOW 0x10 17239e84790SAlex Aizman #define ISCSI_FLAG_CMD_BIDI_UNDERFLOW 0x08 17339e84790SAlex Aizman #define ISCSI_FLAG_CMD_OVERFLOW 0x04 17439e84790SAlex Aizman #define ISCSI_FLAG_CMD_UNDERFLOW 0x02 17539e84790SAlex Aizman 17639e84790SAlex Aizman /* iSCSI Status values. Valid if Rsp Selector bit is not set */ 17739e84790SAlex Aizman #define ISCSI_STATUS_CMD_COMPLETED 0 17839e84790SAlex Aizman #define ISCSI_STATUS_TARGET_FAILURE 1 17939e84790SAlex Aizman #define ISCSI_STATUS_SUBSYS_FAILURE 2 18039e84790SAlex Aizman 18139e84790SAlex Aizman /* Asynchronous Event Header */ 18239e84790SAlex Aizman struct iscsi_async { 18339e84790SAlex Aizman uint8_t opcode; 18439e84790SAlex Aizman uint8_t flags; 18539e84790SAlex Aizman uint8_t rsvd2[2]; 18639e84790SAlex Aizman uint8_t rsvd3; 18739e84790SAlex Aizman uint8_t dlength[3]; 18839e84790SAlex Aizman uint8_t lun[8]; 18939e84790SAlex Aizman uint8_t rsvd4[8]; 19039e84790SAlex Aizman __be32 statsn; 19139e84790SAlex Aizman __be32 exp_cmdsn; 19239e84790SAlex Aizman __be32 max_cmdsn; 19339e84790SAlex Aizman uint8_t async_event; 19439e84790SAlex Aizman uint8_t async_vcode; 19539e84790SAlex Aizman __be16 param1; 19639e84790SAlex Aizman __be16 param2; 19739e84790SAlex Aizman __be16 param3; 19839e84790SAlex Aizman uint8_t rsvd5[4]; 19939e84790SAlex Aizman }; 20039e84790SAlex Aizman 20139e84790SAlex Aizman /* iSCSI Event Codes */ 20239e84790SAlex Aizman #define ISCSI_ASYNC_MSG_SCSI_EVENT 0 20339e84790SAlex Aizman #define ISCSI_ASYNC_MSG_REQUEST_LOGOUT 1 20439e84790SAlex Aizman #define ISCSI_ASYNC_MSG_DROPPING_CONNECTION 2 20539e84790SAlex Aizman #define ISCSI_ASYNC_MSG_DROPPING_ALL_CONNECTIONS 3 20639e84790SAlex Aizman #define ISCSI_ASYNC_MSG_PARAM_NEGOTIATION 4 20739e84790SAlex Aizman #define ISCSI_ASYNC_MSG_VENDOR_SPECIFIC 255 20839e84790SAlex Aizman 20939e84790SAlex Aizman /* NOP-Out Message */ 21039e84790SAlex Aizman struct iscsi_nopout { 21139e84790SAlex Aizman uint8_t opcode; 21239e84790SAlex Aizman uint8_t flags; 21339e84790SAlex Aizman __be16 rsvd2; 21439e84790SAlex Aizman uint8_t rsvd3; 21539e84790SAlex Aizman uint8_t dlength[3]; 21639e84790SAlex Aizman uint8_t lun[8]; 217b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 21839e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */ 21939e84790SAlex Aizman __be32 cmdsn; 22039e84790SAlex Aizman __be32 exp_statsn; 22139e84790SAlex Aizman uint8_t rsvd4[16]; 22239e84790SAlex Aizman }; 22339e84790SAlex Aizman 22439e84790SAlex Aizman /* NOP-In Message */ 22539e84790SAlex Aizman struct iscsi_nopin { 22639e84790SAlex Aizman uint8_t opcode; 22739e84790SAlex Aizman uint8_t flags; 22839e84790SAlex Aizman __be16 rsvd2; 22939e84790SAlex Aizman uint8_t rsvd3; 23039e84790SAlex Aizman uint8_t dlength[3]; 23139e84790SAlex Aizman uint8_t lun[8]; 232b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 23339e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */ 23439e84790SAlex Aizman __be32 statsn; 23539e84790SAlex Aizman __be32 exp_cmdsn; 23639e84790SAlex Aizman __be32 max_cmdsn; 23739e84790SAlex Aizman uint8_t rsvd4[12]; 23839e84790SAlex Aizman }; 23939e84790SAlex Aizman 24039e84790SAlex Aizman /* SCSI Task Management Message Header */ 24139e84790SAlex Aizman struct iscsi_tm { 24239e84790SAlex Aizman uint8_t opcode; 24339e84790SAlex Aizman uint8_t flags; 24439e84790SAlex Aizman uint8_t rsvd1[2]; 24539e84790SAlex Aizman uint8_t hlength; 24639e84790SAlex Aizman uint8_t dlength[3]; 24739e84790SAlex Aizman uint8_t lun[8]; 248b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 249b4377356SAl Viro itt_t rtt; /* Reference Task Tag */ 25039e84790SAlex Aizman __be32 cmdsn; 25139e84790SAlex Aizman __be32 exp_statsn; 25239e84790SAlex Aizman __be32 refcmdsn; 25339e84790SAlex Aizman __be32 exp_datasn; 25439e84790SAlex Aizman uint8_t rsvd2[8]; 25539e84790SAlex Aizman }; 25639e84790SAlex Aizman 257baebc497SMike Christie #define ISCSI_FLAG_TM_FUNC_MASK 0x7F 25839e84790SAlex Aizman 25939e84790SAlex Aizman /* Function values */ 26039e84790SAlex Aizman #define ISCSI_TM_FUNC_ABORT_TASK 1 26139e84790SAlex Aizman #define ISCSI_TM_FUNC_ABORT_TASK_SET 2 26239e84790SAlex Aizman #define ISCSI_TM_FUNC_CLEAR_ACA 3 26339e84790SAlex Aizman #define ISCSI_TM_FUNC_CLEAR_TASK_SET 4 26439e84790SAlex Aizman #define ISCSI_TM_FUNC_LOGICAL_UNIT_RESET 5 26539e84790SAlex Aizman #define ISCSI_TM_FUNC_TARGET_WARM_RESET 6 26639e84790SAlex Aizman #define ISCSI_TM_FUNC_TARGET_COLD_RESET 7 26739e84790SAlex Aizman #define ISCSI_TM_FUNC_TASK_REASSIGN 8 26839e84790SAlex Aizman 26939e84790SAlex Aizman /* SCSI Task Management Response Header */ 27039e84790SAlex Aizman struct iscsi_tm_rsp { 27139e84790SAlex Aizman uint8_t opcode; 27239e84790SAlex Aizman uint8_t flags; 27339e84790SAlex Aizman uint8_t response; /* see Response values below */ 27439e84790SAlex Aizman uint8_t qualifier; 27539e84790SAlex Aizman uint8_t hlength; 27639e84790SAlex Aizman uint8_t dlength[3]; 27739e84790SAlex Aizman uint8_t rsvd2[8]; 278b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 279b4377356SAl Viro itt_t rtt; /* Reference Task Tag */ 28039e84790SAlex Aizman __be32 statsn; 28139e84790SAlex Aizman __be32 exp_cmdsn; 28239e84790SAlex Aizman __be32 max_cmdsn; 28339e84790SAlex Aizman uint8_t rsvd3[12]; 28439e84790SAlex Aizman }; 28539e84790SAlex Aizman 28639e84790SAlex Aizman /* Response values */ 287baebc497SMike Christie #define ISCSI_TMF_RSP_COMPLETE 0x00 288baebc497SMike Christie #define ISCSI_TMF_RSP_NO_TASK 0x01 289baebc497SMike Christie #define ISCSI_TMF_RSP_NO_LUN 0x02 290baebc497SMike Christie #define ISCSI_TMF_RSP_TASK_ALLEGIANT 0x03 291baebc497SMike Christie #define ISCSI_TMF_RSP_NO_FAILOVER 0x04 292baebc497SMike Christie #define ISCSI_TMF_RSP_NOT_SUPPORTED 0x05 293baebc497SMike Christie #define ISCSI_TMF_RSP_AUTH_FAILED 0x06 294baebc497SMike Christie #define ISCSI_TMF_RSP_REJECTED 0xff 29539e84790SAlex Aizman 29639e84790SAlex Aizman /* Ready To Transfer Header */ 29739e84790SAlex Aizman struct iscsi_r2t_rsp { 29839e84790SAlex Aizman uint8_t opcode; 29939e84790SAlex Aizman uint8_t flags; 30039e84790SAlex Aizman uint8_t rsvd2[2]; 30139e84790SAlex Aizman uint8_t hlength; 30239e84790SAlex Aizman uint8_t dlength[3]; 30339e84790SAlex Aizman uint8_t lun[8]; 304b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 30539e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */ 30639e84790SAlex Aizman __be32 statsn; 30739e84790SAlex Aizman __be32 exp_cmdsn; 30839e84790SAlex Aizman __be32 max_cmdsn; 30939e84790SAlex Aizman __be32 r2tsn; 31039e84790SAlex Aizman __be32 data_offset; 31139e84790SAlex Aizman __be32 data_length; 31239e84790SAlex Aizman }; 31339e84790SAlex Aizman 31439e84790SAlex Aizman /* SCSI Data Hdr */ 31539e84790SAlex Aizman struct iscsi_data { 31639e84790SAlex Aizman uint8_t opcode; 31739e84790SAlex Aizman uint8_t flags; 31839e84790SAlex Aizman uint8_t rsvd2[2]; 31939e84790SAlex Aizman uint8_t rsvd3; 32039e84790SAlex Aizman uint8_t dlength[3]; 32139e84790SAlex Aizman uint8_t lun[8]; 322b4377356SAl Viro itt_t itt; 32339e84790SAlex Aizman __be32 ttt; 32439e84790SAlex Aizman __be32 rsvd4; 32539e84790SAlex Aizman __be32 exp_statsn; 32639e84790SAlex Aizman __be32 rsvd5; 32739e84790SAlex Aizman __be32 datasn; 32839e84790SAlex Aizman __be32 offset; 32939e84790SAlex Aizman __be32 rsvd6; 33039e84790SAlex Aizman /* Payload */ 33139e84790SAlex Aizman }; 33239e84790SAlex Aizman 33339e84790SAlex Aizman /* SCSI Data Response Hdr */ 33439e84790SAlex Aizman struct iscsi_data_rsp { 33539e84790SAlex Aizman uint8_t opcode; 33639e84790SAlex Aizman uint8_t flags; 33739e84790SAlex Aizman uint8_t rsvd2; 33839e84790SAlex Aizman uint8_t cmd_status; 33939e84790SAlex Aizman uint8_t hlength; 34039e84790SAlex Aizman uint8_t dlength[3]; 34139e84790SAlex Aizman uint8_t lun[8]; 342b4377356SAl Viro itt_t itt; 34339e84790SAlex Aizman __be32 ttt; 34439e84790SAlex Aizman __be32 statsn; 34539e84790SAlex Aizman __be32 exp_cmdsn; 34639e84790SAlex Aizman __be32 max_cmdsn; 34739e84790SAlex Aizman __be32 datasn; 34839e84790SAlex Aizman __be32 offset; 34939e84790SAlex Aizman __be32 residual_count; 35039e84790SAlex Aizman }; 35139e84790SAlex Aizman 35239e84790SAlex Aizman /* Data Response PDU flags */ 35339e84790SAlex Aizman #define ISCSI_FLAG_DATA_ACK 0x40 35439e84790SAlex Aizman #define ISCSI_FLAG_DATA_OVERFLOW 0x04 35539e84790SAlex Aizman #define ISCSI_FLAG_DATA_UNDERFLOW 0x02 35639e84790SAlex Aizman #define ISCSI_FLAG_DATA_STATUS 0x01 35739e84790SAlex Aizman 35839e84790SAlex Aizman /* Text Header */ 35939e84790SAlex Aizman struct iscsi_text { 36039e84790SAlex Aizman uint8_t opcode; 36139e84790SAlex Aizman uint8_t flags; 36239e84790SAlex Aizman uint8_t rsvd2[2]; 36339e84790SAlex Aizman uint8_t hlength; 36439e84790SAlex Aizman uint8_t dlength[3]; 36539e84790SAlex Aizman uint8_t rsvd4[8]; 366b4377356SAl Viro itt_t itt; 36739e84790SAlex Aizman __be32 ttt; 36839e84790SAlex Aizman __be32 cmdsn; 36939e84790SAlex Aizman __be32 exp_statsn; 37039e84790SAlex Aizman uint8_t rsvd5[16]; 37139e84790SAlex Aizman /* Text - key=value pairs */ 37239e84790SAlex Aizman }; 37339e84790SAlex Aizman 37439e84790SAlex Aizman #define ISCSI_FLAG_TEXT_CONTINUE 0x40 37539e84790SAlex Aizman 37639e84790SAlex Aizman /* Text Response Header */ 37739e84790SAlex Aizman struct iscsi_text_rsp { 37839e84790SAlex Aizman uint8_t opcode; 37939e84790SAlex Aizman uint8_t flags; 38039e84790SAlex Aizman uint8_t rsvd2[2]; 38139e84790SAlex Aizman uint8_t hlength; 38239e84790SAlex Aizman uint8_t dlength[3]; 38339e84790SAlex Aizman uint8_t rsvd4[8]; 384b4377356SAl Viro itt_t itt; 38539e84790SAlex Aizman __be32 ttt; 38639e84790SAlex Aizman __be32 statsn; 38739e84790SAlex Aizman __be32 exp_cmdsn; 38839e84790SAlex Aizman __be32 max_cmdsn; 38939e84790SAlex Aizman uint8_t rsvd5[12]; 39039e84790SAlex Aizman /* Text Response - key:value pairs */ 39139e84790SAlex Aizman }; 39239e84790SAlex Aizman 39339e84790SAlex Aizman /* Login Header */ 39439e84790SAlex Aizman struct iscsi_login { 39539e84790SAlex Aizman uint8_t opcode; 39639e84790SAlex Aizman uint8_t flags; 39739e84790SAlex Aizman uint8_t max_version; /* Max. version supported */ 39839e84790SAlex Aizman uint8_t min_version; /* Min. version supported */ 39939e84790SAlex Aizman uint8_t hlength; 40039e84790SAlex Aizman uint8_t dlength[3]; 40139e84790SAlex Aizman uint8_t isid[6]; /* Initiator Session ID */ 40239e84790SAlex Aizman __be16 tsih; /* Target Session Handle */ 403b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 40439e84790SAlex Aizman __be16 cid; 40539e84790SAlex Aizman __be16 rsvd3; 40639e84790SAlex Aizman __be32 cmdsn; 40739e84790SAlex Aizman __be32 exp_statsn; 40839e84790SAlex Aizman uint8_t rsvd5[16]; 40939e84790SAlex Aizman }; 41039e84790SAlex Aizman 41139e84790SAlex Aizman /* Login PDU flags */ 41239e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_TRANSIT 0x80 41339e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_CONTINUE 0x40 41439e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK 0x0C /* 2 bits */ 41539e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK 0x03 /* 2 bits */ 41639e84790SAlex Aizman 41739e84790SAlex Aizman #define ISCSI_LOGIN_CURRENT_STAGE(flags) \ 41839e84790SAlex Aizman ((flags & ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK) >> 2) 41939e84790SAlex Aizman #define ISCSI_LOGIN_NEXT_STAGE(flags) \ 42039e84790SAlex Aizman (flags & ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK) 42139e84790SAlex Aizman 42239e84790SAlex Aizman /* Login Response Header */ 42339e84790SAlex Aizman struct iscsi_login_rsp { 42439e84790SAlex Aizman uint8_t opcode; 42539e84790SAlex Aizman uint8_t flags; 42639e84790SAlex Aizman uint8_t max_version; /* Max. version supported */ 42739e84790SAlex Aizman uint8_t active_version; /* Active version */ 42839e84790SAlex Aizman uint8_t hlength; 42939e84790SAlex Aizman uint8_t dlength[3]; 43039e84790SAlex Aizman uint8_t isid[6]; /* Initiator Session ID */ 43139e84790SAlex Aizman __be16 tsih; /* Target Session Handle */ 432b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 43339e84790SAlex Aizman __be32 rsvd3; 43439e84790SAlex Aizman __be32 statsn; 43539e84790SAlex Aizman __be32 exp_cmdsn; 43639e84790SAlex Aizman __be32 max_cmdsn; 43739e84790SAlex Aizman uint8_t status_class; /* see Login RSP ststus classes below */ 43839e84790SAlex Aizman uint8_t status_detail; /* see Login RSP Status details below */ 43939e84790SAlex Aizman uint8_t rsvd4[10]; 44039e84790SAlex Aizman }; 44139e84790SAlex Aizman 44239e84790SAlex Aizman /* Login stage (phase) codes for CSG, NSG */ 44339e84790SAlex Aizman #define ISCSI_INITIAL_LOGIN_STAGE -1 44439e84790SAlex Aizman #define ISCSI_SECURITY_NEGOTIATION_STAGE 0 44539e84790SAlex Aizman #define ISCSI_OP_PARMS_NEGOTIATION_STAGE 1 44639e84790SAlex Aizman #define ISCSI_FULL_FEATURE_PHASE 3 44739e84790SAlex Aizman 44839e84790SAlex Aizman /* Login Status response classes */ 44939e84790SAlex Aizman #define ISCSI_STATUS_CLS_SUCCESS 0x00 45039e84790SAlex Aizman #define ISCSI_STATUS_CLS_REDIRECT 0x01 45139e84790SAlex Aizman #define ISCSI_STATUS_CLS_INITIATOR_ERR 0x02 45239e84790SAlex Aizman #define ISCSI_STATUS_CLS_TARGET_ERR 0x03 45339e84790SAlex Aizman 45439e84790SAlex Aizman /* Login Status response detail codes */ 45539e84790SAlex Aizman /* Class-0 (Success) */ 45639e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_ACCEPT 0x00 45739e84790SAlex Aizman 45839e84790SAlex Aizman /* Class-1 (Redirection) */ 45939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_MOVED_TEMP 0x01 46039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_MOVED_PERM 0x02 46139e84790SAlex Aizman 46239e84790SAlex Aizman /* Class-2 (Initiator Error) */ 46339e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_INIT_ERR 0x00 46439e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_AUTH_FAILED 0x01 46539e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_FORBIDDEN 0x02 46639e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_NOT_FOUND 0x03 46739e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_REMOVED 0x04 46839e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_VERSION 0x05 46939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_ISID_ERROR 0x06 47039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_MISSING_FIELDS 0x07 47139e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_CONN_ADD_FAILED 0x08 47239e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_SESSION_TYPE 0x09 47339e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_SESSION 0x0a 47439e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_INVALID_REQUEST 0x0b 47539e84790SAlex Aizman 47639e84790SAlex Aizman /* Class-3 (Target Error) */ 47739e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TARGET_ERROR 0x00 47839e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_SVC_UNAVAILABLE 0x01 47939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_RESOURCES 0x02 48039e84790SAlex Aizman 48139e84790SAlex Aizman /* Logout Header */ 48239e84790SAlex Aizman struct iscsi_logout { 48339e84790SAlex Aizman uint8_t opcode; 48439e84790SAlex Aizman uint8_t flags; 48539e84790SAlex Aizman uint8_t rsvd1[2]; 48639e84790SAlex Aizman uint8_t hlength; 48739e84790SAlex Aizman uint8_t dlength[3]; 48839e84790SAlex Aizman uint8_t rsvd2[8]; 489b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 49039e84790SAlex Aizman __be16 cid; 49139e84790SAlex Aizman uint8_t rsvd3[2]; 49239e84790SAlex Aizman __be32 cmdsn; 49339e84790SAlex Aizman __be32 exp_statsn; 49439e84790SAlex Aizman uint8_t rsvd4[16]; 49539e84790SAlex Aizman }; 49639e84790SAlex Aizman 49739e84790SAlex Aizman /* Logout PDU flags */ 49839e84790SAlex Aizman #define ISCSI_FLAG_LOGOUT_REASON_MASK 0x7F 49939e84790SAlex Aizman 50039e84790SAlex Aizman /* logout reason_code values */ 50139e84790SAlex Aizman 50239e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0 50339e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1 50439e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_RECOVERY 2 50539e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_AEN_REQUEST 3 50639e84790SAlex Aizman 50739e84790SAlex Aizman /* Logout Response Header */ 50839e84790SAlex Aizman struct iscsi_logout_rsp { 50939e84790SAlex Aizman uint8_t opcode; 51039e84790SAlex Aizman uint8_t flags; 51139e84790SAlex Aizman uint8_t response; /* see Logout response values below */ 51239e84790SAlex Aizman uint8_t rsvd2; 51339e84790SAlex Aizman uint8_t hlength; 51439e84790SAlex Aizman uint8_t dlength[3]; 51539e84790SAlex Aizman uint8_t rsvd3[8]; 516b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 51739e84790SAlex Aizman __be32 rsvd4; 51839e84790SAlex Aizman __be32 statsn; 51939e84790SAlex Aizman __be32 exp_cmdsn; 52039e84790SAlex Aizman __be32 max_cmdsn; 52139e84790SAlex Aizman __be32 rsvd5; 52239e84790SAlex Aizman __be16 t2wait; 52339e84790SAlex Aizman __be16 t2retain; 52439e84790SAlex Aizman __be32 rsvd6; 52539e84790SAlex Aizman }; 52639e84790SAlex Aizman 52739e84790SAlex Aizman /* logout response status values */ 52839e84790SAlex Aizman 52939e84790SAlex Aizman #define ISCSI_LOGOUT_SUCCESS 0 53039e84790SAlex Aizman #define ISCSI_LOGOUT_CID_NOT_FOUND 1 53139e84790SAlex Aizman #define ISCSI_LOGOUT_RECOVERY_UNSUPPORTED 2 53239e84790SAlex Aizman #define ISCSI_LOGOUT_CLEANUP_FAILED 3 53339e84790SAlex Aizman 53439e84790SAlex Aizman /* SNACK Header */ 53539e84790SAlex Aizman struct iscsi_snack { 53639e84790SAlex Aizman uint8_t opcode; 53739e84790SAlex Aizman uint8_t flags; 53839e84790SAlex Aizman uint8_t rsvd2[14]; 539b4377356SAl Viro itt_t itt; 54039e84790SAlex Aizman __be32 begrun; 54139e84790SAlex Aizman __be32 runlength; 54239e84790SAlex Aizman __be32 exp_statsn; 54339e84790SAlex Aizman __be32 rsvd3; 54439e84790SAlex Aizman __be32 exp_datasn; 54539e84790SAlex Aizman uint8_t rsvd6[8]; 54639e84790SAlex Aizman }; 54739e84790SAlex Aizman 54839e84790SAlex Aizman /* SNACK PDU flags */ 54939e84790SAlex Aizman #define ISCSI_FLAG_SNACK_TYPE_MASK 0x0F /* 4 bits */ 55039e84790SAlex Aizman 55139e84790SAlex Aizman /* Reject Message Header */ 55239e84790SAlex Aizman struct iscsi_reject { 55339e84790SAlex Aizman uint8_t opcode; 55439e84790SAlex Aizman uint8_t flags; 55539e84790SAlex Aizman uint8_t reason; 55639e84790SAlex Aizman uint8_t rsvd2; 557fa0a6957SMike Christie uint8_t hlength; 55839e84790SAlex Aizman uint8_t dlength[3]; 559fa0a6957SMike Christie uint8_t rsvd3[8]; 560fa0a6957SMike Christie __be32 ffffffff; 561fa0a6957SMike Christie uint8_t rsvd4[4]; 56239e84790SAlex Aizman __be32 statsn; 56339e84790SAlex Aizman __be32 exp_cmdsn; 56439e84790SAlex Aizman __be32 max_cmdsn; 56539e84790SAlex Aizman __be32 datasn; 56639e84790SAlex Aizman uint8_t rsvd5[8]; 56739e84790SAlex Aizman /* Text - Rejected hdr */ 56839e84790SAlex Aizman }; 56939e84790SAlex Aizman 57039e84790SAlex Aizman /* Reason for Reject */ 571fa0a6957SMike Christie #define ISCSI_REASON_CMD_BEFORE_LOGIN 1 572fa0a6957SMike Christie #define ISCSI_REASON_DATA_DIGEST_ERROR 2 573fa0a6957SMike Christie #define ISCSI_REASON_DATA_SNACK_REJECT 3 574fa0a6957SMike Christie #define ISCSI_REASON_PROTOCOL_ERROR 4 575fa0a6957SMike Christie #define ISCSI_REASON_CMD_NOT_SUPPORTED 5 576fa0a6957SMike Christie #define ISCSI_REASON_IMM_CMD_REJECT 6 577fa0a6957SMike Christie #define ISCSI_REASON_TASK_IN_PROGRESS 7 578fa0a6957SMike Christie #define ISCSI_REASON_INVALID_SNACK 8 579fa0a6957SMike Christie #define ISCSI_REASON_BOOKMARK_INVALID 9 580fa0a6957SMike Christie #define ISCSI_REASON_BOOKMARK_NO_RESOURCES 10 581fa0a6957SMike Christie #define ISCSI_REASON_NEGOTIATION_RESET 11 58239e84790SAlex Aizman 58339e84790SAlex Aizman /* Max. number of Key=Value pairs in a text message */ 58439e84790SAlex Aizman #define MAX_KEY_VALUE_PAIRS 8192 58539e84790SAlex Aizman 58639e84790SAlex Aizman /* maximum length for text keys/values */ 58739e84790SAlex Aizman #define KEY_MAXLEN 64 58839e84790SAlex Aizman #define VALUE_MAXLEN 255 58939e84790SAlex Aizman #define TARGET_NAME_MAXLEN VALUE_MAXLEN 59039e84790SAlex Aizman 591bf32ed33SMike Christie #define ISCSI_DEF_MAX_RECV_SEG_LEN 8192 592bf32ed33SMike Christie #define ISCSI_MIN_MAX_RECV_SEG_LEN 512 593bf32ed33SMike Christie #define ISCSI_MAX_MAX_RECV_SEG_LEN 16777215 594bf32ed33SMike Christie 595bf32ed33SMike Christie #define ISCSI_DEF_FIRST_BURST_LEN 65536 596bf32ed33SMike Christie #define ISCSI_MIN_FIRST_BURST_LEN 512 597bf32ed33SMike Christie #define ISCSI_MAX_FIRST_BURST_LEN 16777215 598bf32ed33SMike Christie 599bf32ed33SMike Christie #define ISCSI_DEF_MAX_BURST_LEN 262144 600bf32ed33SMike Christie #define ISCSI_MIN_MAX_BURST_LEN 512 601bf32ed33SMike Christie #define ISCSI_MAX_MAX_BURST_LEN 16777215 60239e84790SAlex Aizman 60339e84790SAlex Aizman /************************* RFC 3720 End *****************************/ 60439e84790SAlex Aizman 60539e84790SAlex Aizman #endif /* ISCSI_PROTO_H */ 606