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 2426974789SMike Christie #include <linux/types.h> 2530e9ba9fSBoaz Harrosh #include <scsi/scsi.h> 2626974789SMike Christie 2739e84790SAlex Aizman #define ISCSI_DRAFT20_VERSION 0x00 2839e84790SAlex Aizman 2939e84790SAlex Aizman /* default iSCSI listen port for incoming connections */ 3039e84790SAlex Aizman #define ISCSI_LISTEN_PORT 3260 3139e84790SAlex Aizman 3239e84790SAlex Aizman /* Padding word length */ 33004d6530SBoaz Harrosh #define ISCSI_PAD_LEN 4 3439e84790SAlex Aizman 3539e84790SAlex Aizman /* 3639e84790SAlex Aizman * useful common(control and data pathes) macro 3739e84790SAlex Aizman */ 3839e84790SAlex Aizman #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) 3939e84790SAlex Aizman #define hton24(p, v) { \ 4039e84790SAlex Aizman p[0] = (((v) >> 16) & 0xFF); \ 4139e84790SAlex Aizman p[1] = (((v) >> 8) & 0xFF); \ 4239e84790SAlex Aizman p[2] = ((v) & 0xFF); \ 4339e84790SAlex Aizman } 4439e84790SAlex Aizman #define zero_data(p) {p[0]=0;p[1]=0;p[2]=0;} 4539e84790SAlex Aizman 46b4377356SAl Viro /* initiator tags; opaque for target */ 47b4377356SAl Viro typedef uint32_t __bitwise__ itt_t; 48b4377356SAl Viro /* below makes sense only for initiator that created this tag */ 498b1d0343SMike Christie #define build_itt(itt, age) ((__force itt_t)\ 508b1d0343SMike Christie ((itt) | ((age) << ISCSI_AGE_SHIFT))) 51b4377356SAl Viro #define get_itt(itt) ((__force uint32_t)(itt_t)(itt) & ISCSI_ITT_MASK) 52b4377356SAl Viro #define RESERVED_ITT ((__force itt_t)0xffffffff) 53b4377356SAl Viro 5439e84790SAlex Aizman /* 5539e84790SAlex Aizman * iSCSI Template Message Header 5639e84790SAlex Aizman */ 5739e84790SAlex Aizman struct iscsi_hdr { 5839e84790SAlex Aizman uint8_t opcode; 5939e84790SAlex Aizman uint8_t flags; /* Final bit */ 6039e84790SAlex Aizman uint8_t rsvd2[2]; 6139e84790SAlex Aizman uint8_t hlength; /* AHSs total length */ 6239e84790SAlex Aizman uint8_t dlength[3]; /* Data length */ 6339e84790SAlex Aizman uint8_t lun[8]; 64b4377356SAl Viro itt_t itt; /* Initiator Task Tag, opaque for target */ 6539e84790SAlex Aizman __be32 ttt; /* Target Task Tag */ 6639e84790SAlex Aizman __be32 statsn; 6739e84790SAlex Aizman __be32 exp_statsn; 68baebc497SMike Christie __be32 max_statsn; 69baebc497SMike Christie uint8_t other[12]; 7039e84790SAlex Aizman }; 7139e84790SAlex Aizman 7239e84790SAlex Aizman /************************* RFC 3720 Begin *****************************/ 7339e84790SAlex Aizman 7439e84790SAlex Aizman #define ISCSI_RESERVED_TAG 0xffffffff 7539e84790SAlex Aizman 7639e84790SAlex Aizman /* Opcode encoding bits */ 7739e84790SAlex Aizman #define ISCSI_OP_RETRY 0x80 7839e84790SAlex Aizman #define ISCSI_OP_IMMEDIATE 0x40 7939e84790SAlex Aizman #define ISCSI_OPCODE_MASK 0x3F 8039e84790SAlex Aizman 8139e84790SAlex Aizman /* Initiator Opcode values */ 8239e84790SAlex Aizman #define ISCSI_OP_NOOP_OUT 0x00 8339e84790SAlex Aizman #define ISCSI_OP_SCSI_CMD 0x01 8439e84790SAlex Aizman #define ISCSI_OP_SCSI_TMFUNC 0x02 8539e84790SAlex Aizman #define ISCSI_OP_LOGIN 0x03 8639e84790SAlex Aizman #define ISCSI_OP_TEXT 0x04 8739e84790SAlex Aizman #define ISCSI_OP_SCSI_DATA_OUT 0x05 8839e84790SAlex Aizman #define ISCSI_OP_LOGOUT 0x06 8939e84790SAlex Aizman #define ISCSI_OP_SNACK 0x10 9039e84790SAlex Aizman 91baebc497SMike Christie #define ISCSI_OP_VENDOR1_CMD 0x1c 92baebc497SMike Christie #define ISCSI_OP_VENDOR2_CMD 0x1d 93baebc497SMike Christie #define ISCSI_OP_VENDOR3_CMD 0x1e 94baebc497SMike Christie #define ISCSI_OP_VENDOR4_CMD 0x1f 95baebc497SMike Christie 9639e84790SAlex Aizman /* Target Opcode values */ 9739e84790SAlex Aizman #define ISCSI_OP_NOOP_IN 0x20 9839e84790SAlex Aizman #define ISCSI_OP_SCSI_CMD_RSP 0x21 9939e84790SAlex Aizman #define ISCSI_OP_SCSI_TMFUNC_RSP 0x22 10039e84790SAlex Aizman #define ISCSI_OP_LOGIN_RSP 0x23 10139e84790SAlex Aizman #define ISCSI_OP_TEXT_RSP 0x24 10239e84790SAlex Aizman #define ISCSI_OP_SCSI_DATA_IN 0x25 10339e84790SAlex Aizman #define ISCSI_OP_LOGOUT_RSP 0x26 10439e84790SAlex Aizman #define ISCSI_OP_R2T 0x31 10539e84790SAlex Aizman #define ISCSI_OP_ASYNC_EVENT 0x32 10639e84790SAlex Aizman #define ISCSI_OP_REJECT 0x3f 10739e84790SAlex Aizman 108baebc497SMike Christie struct iscsi_ahs_hdr { 109baebc497SMike Christie __be16 ahslength; 110baebc497SMike Christie uint8_t ahstype; 111baebc497SMike Christie uint8_t ahspec[5]; 112baebc497SMike Christie }; 113baebc497SMike Christie 114baebc497SMike Christie #define ISCSI_AHSTYPE_CDB 1 115baebc497SMike Christie #define ISCSI_AHSTYPE_RLENGTH 2 11638d1c069SBoaz Harrosh #define ISCSI_CDB_SIZE 16 117baebc497SMike Christie 11839e84790SAlex Aizman /* iSCSI PDU Header */ 11912352183SNicholas Bellinger struct iscsi_scsi_req { 12039e84790SAlex Aizman uint8_t opcode; 12139e84790SAlex Aizman uint8_t flags; 122baebc497SMike Christie __be16 rsvd2; 12339e84790SAlex Aizman uint8_t hlength; 12439e84790SAlex Aizman uint8_t dlength[3]; 12539e84790SAlex Aizman uint8_t lun[8]; 126b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 12739e84790SAlex Aizman __be32 data_length; 12839e84790SAlex Aizman __be32 cmdsn; 12939e84790SAlex Aizman __be32 exp_statsn; 13038d1c069SBoaz Harrosh uint8_t cdb[ISCSI_CDB_SIZE]; /* SCSI Command Block */ 13139e84790SAlex Aizman /* Additional Data (Command Dependent) */ 13239e84790SAlex Aizman }; 13339e84790SAlex Aizman 13439e84790SAlex Aizman /* Command PDU flags */ 13539e84790SAlex Aizman #define ISCSI_FLAG_CMD_FINAL 0x80 13639e84790SAlex Aizman #define ISCSI_FLAG_CMD_READ 0x40 13739e84790SAlex Aizman #define ISCSI_FLAG_CMD_WRITE 0x20 13839e84790SAlex Aizman #define ISCSI_FLAG_CMD_ATTR_MASK 0x07 /* 3 bits */ 13939e84790SAlex Aizman 14039e84790SAlex Aizman /* SCSI Command Attribute values */ 14139e84790SAlex Aizman #define ISCSI_ATTR_UNTAGGED 0 14239e84790SAlex Aizman #define ISCSI_ATTR_SIMPLE 1 14339e84790SAlex Aizman #define ISCSI_ATTR_ORDERED 2 14439e84790SAlex Aizman #define ISCSI_ATTR_HEAD_OF_QUEUE 3 14539e84790SAlex Aizman #define ISCSI_ATTR_ACA 4 14639e84790SAlex Aizman 147baebc497SMike Christie struct iscsi_rlength_ahdr { 148baebc497SMike Christie __be16 ahslength; 149baebc497SMike Christie uint8_t ahstype; 150baebc497SMike Christie uint8_t reserved; 151baebc497SMike Christie __be32 read_length; 152baebc497SMike Christie }; 153baebc497SMike Christie 154004d6530SBoaz Harrosh /* Extended CDB AHS */ 155004d6530SBoaz Harrosh struct iscsi_ecdb_ahdr { 156004d6530SBoaz Harrosh __be16 ahslength; /* CDB length - 15, including reserved byte */ 157004d6530SBoaz Harrosh uint8_t ahstype; 158004d6530SBoaz Harrosh uint8_t reserved; 15938d1c069SBoaz Harrosh /* 4-byte aligned extended CDB spillover */ 16030e9ba9fSBoaz Harrosh uint8_t ecdb[SCSI_MAX_VARLEN_CDB_SIZE - ISCSI_CDB_SIZE]; 161004d6530SBoaz Harrosh }; 162004d6530SBoaz Harrosh 16339e84790SAlex Aizman /* SCSI Response Header */ 16412352183SNicholas Bellinger struct iscsi_scsi_rsp { 16539e84790SAlex Aizman uint8_t opcode; 16639e84790SAlex Aizman uint8_t flags; 16739e84790SAlex Aizman uint8_t response; 16839e84790SAlex Aizman uint8_t cmd_status; 16939e84790SAlex Aizman uint8_t hlength; 17039e84790SAlex Aizman uint8_t dlength[3]; 17139e84790SAlex Aizman uint8_t rsvd[8]; 172b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 17339e84790SAlex Aizman __be32 rsvd1; 17439e84790SAlex Aizman __be32 statsn; 17539e84790SAlex Aizman __be32 exp_cmdsn; 17639e84790SAlex Aizman __be32 max_cmdsn; 17739e84790SAlex Aizman __be32 exp_datasn; 17839e84790SAlex Aizman __be32 bi_residual_count; 17939e84790SAlex Aizman __be32 residual_count; 18039e84790SAlex Aizman /* Response or Sense Data (optional) */ 18139e84790SAlex Aizman }; 18239e84790SAlex Aizman 18339e84790SAlex Aizman /* Command Response PDU flags */ 18439e84790SAlex Aizman #define ISCSI_FLAG_CMD_BIDI_OVERFLOW 0x10 18539e84790SAlex Aizman #define ISCSI_FLAG_CMD_BIDI_UNDERFLOW 0x08 18639e84790SAlex Aizman #define ISCSI_FLAG_CMD_OVERFLOW 0x04 18739e84790SAlex Aizman #define ISCSI_FLAG_CMD_UNDERFLOW 0x02 18839e84790SAlex Aizman 18939e84790SAlex Aizman /* iSCSI Status values. Valid if Rsp Selector bit is not set */ 19039e84790SAlex Aizman #define ISCSI_STATUS_CMD_COMPLETED 0 19139e84790SAlex Aizman #define ISCSI_STATUS_TARGET_FAILURE 1 19239e84790SAlex Aizman #define ISCSI_STATUS_SUBSYS_FAILURE 2 19339e84790SAlex Aizman 19439e84790SAlex Aizman /* Asynchronous Event Header */ 19539e84790SAlex Aizman struct iscsi_async { 19639e84790SAlex Aizman uint8_t opcode; 19739e84790SAlex Aizman uint8_t flags; 19839e84790SAlex Aizman uint8_t rsvd2[2]; 19939e84790SAlex Aizman uint8_t rsvd3; 20039e84790SAlex Aizman uint8_t dlength[3]; 20139e84790SAlex Aizman uint8_t lun[8]; 20239e84790SAlex Aizman uint8_t rsvd4[8]; 20339e84790SAlex Aizman __be32 statsn; 20439e84790SAlex Aizman __be32 exp_cmdsn; 20539e84790SAlex Aizman __be32 max_cmdsn; 20639e84790SAlex Aizman uint8_t async_event; 20739e84790SAlex Aizman uint8_t async_vcode; 20839e84790SAlex Aizman __be16 param1; 20939e84790SAlex Aizman __be16 param2; 21039e84790SAlex Aizman __be16 param3; 21139e84790SAlex Aizman uint8_t rsvd5[4]; 21239e84790SAlex Aizman }; 21339e84790SAlex Aizman 21439e84790SAlex Aizman /* iSCSI Event Codes */ 21539e84790SAlex Aizman #define ISCSI_ASYNC_MSG_SCSI_EVENT 0 21639e84790SAlex Aizman #define ISCSI_ASYNC_MSG_REQUEST_LOGOUT 1 21739e84790SAlex Aizman #define ISCSI_ASYNC_MSG_DROPPING_CONNECTION 2 21839e84790SAlex Aizman #define ISCSI_ASYNC_MSG_DROPPING_ALL_CONNECTIONS 3 21939e84790SAlex Aizman #define ISCSI_ASYNC_MSG_PARAM_NEGOTIATION 4 22039e84790SAlex Aizman #define ISCSI_ASYNC_MSG_VENDOR_SPECIFIC 255 22139e84790SAlex Aizman 22239e84790SAlex Aizman /* NOP-Out Message */ 22339e84790SAlex Aizman struct iscsi_nopout { 22439e84790SAlex Aizman uint8_t opcode; 22539e84790SAlex Aizman uint8_t flags; 22639e84790SAlex Aizman __be16 rsvd2; 22739e84790SAlex Aizman uint8_t rsvd3; 22839e84790SAlex Aizman uint8_t dlength[3]; 22939e84790SAlex Aizman uint8_t lun[8]; 230b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 23139e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */ 23239e84790SAlex Aizman __be32 cmdsn; 23339e84790SAlex Aizman __be32 exp_statsn; 23439e84790SAlex Aizman uint8_t rsvd4[16]; 23539e84790SAlex Aizman }; 23639e84790SAlex Aizman 23739e84790SAlex Aizman /* NOP-In Message */ 23839e84790SAlex Aizman struct iscsi_nopin { 23939e84790SAlex Aizman uint8_t opcode; 24039e84790SAlex Aizman uint8_t flags; 24139e84790SAlex Aizman __be16 rsvd2; 24239e84790SAlex Aizman uint8_t rsvd3; 24339e84790SAlex Aizman uint8_t dlength[3]; 24439e84790SAlex Aizman uint8_t lun[8]; 245b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 24639e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */ 24739e84790SAlex Aizman __be32 statsn; 24839e84790SAlex Aizman __be32 exp_cmdsn; 24939e84790SAlex Aizman __be32 max_cmdsn; 25039e84790SAlex Aizman uint8_t rsvd4[12]; 25139e84790SAlex Aizman }; 25239e84790SAlex Aizman 25339e84790SAlex Aizman /* SCSI Task Management Message Header */ 25439e84790SAlex Aizman struct iscsi_tm { 25539e84790SAlex Aizman uint8_t opcode; 25639e84790SAlex Aizman uint8_t flags; 25739e84790SAlex Aizman uint8_t rsvd1[2]; 25839e84790SAlex Aizman uint8_t hlength; 25939e84790SAlex Aizman uint8_t dlength[3]; 26039e84790SAlex Aizman uint8_t lun[8]; 261b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 262b4377356SAl Viro itt_t rtt; /* Reference Task Tag */ 26339e84790SAlex Aizman __be32 cmdsn; 26439e84790SAlex Aizman __be32 exp_statsn; 26539e84790SAlex Aizman __be32 refcmdsn; 26639e84790SAlex Aizman __be32 exp_datasn; 26739e84790SAlex Aizman uint8_t rsvd2[8]; 26839e84790SAlex Aizman }; 26939e84790SAlex Aizman 270baebc497SMike Christie #define ISCSI_FLAG_TM_FUNC_MASK 0x7F 27139e84790SAlex Aizman 27239e84790SAlex Aizman /* Function values */ 27339e84790SAlex Aizman #define ISCSI_TM_FUNC_ABORT_TASK 1 27439e84790SAlex Aizman #define ISCSI_TM_FUNC_ABORT_TASK_SET 2 27539e84790SAlex Aizman #define ISCSI_TM_FUNC_CLEAR_ACA 3 27639e84790SAlex Aizman #define ISCSI_TM_FUNC_CLEAR_TASK_SET 4 27739e84790SAlex Aizman #define ISCSI_TM_FUNC_LOGICAL_UNIT_RESET 5 27839e84790SAlex Aizman #define ISCSI_TM_FUNC_TARGET_WARM_RESET 6 27939e84790SAlex Aizman #define ISCSI_TM_FUNC_TARGET_COLD_RESET 7 28039e84790SAlex Aizman #define ISCSI_TM_FUNC_TASK_REASSIGN 8 28139e84790SAlex Aizman 2825d12c05eSMike Christie #define ISCSI_TM_FUNC_VALUE(hdr) ((hdr)->flags & ISCSI_FLAG_TM_FUNC_MASK) 2835d12c05eSMike Christie 28439e84790SAlex Aizman /* SCSI Task Management Response Header */ 28539e84790SAlex Aizman struct iscsi_tm_rsp { 28639e84790SAlex Aizman uint8_t opcode; 28739e84790SAlex Aizman uint8_t flags; 28839e84790SAlex Aizman uint8_t response; /* see Response values below */ 28939e84790SAlex Aizman uint8_t qualifier; 29039e84790SAlex Aizman uint8_t hlength; 29139e84790SAlex Aizman uint8_t dlength[3]; 29239e84790SAlex Aizman uint8_t rsvd2[8]; 293b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 294b4377356SAl Viro itt_t rtt; /* Reference Task Tag */ 29539e84790SAlex Aizman __be32 statsn; 29639e84790SAlex Aizman __be32 exp_cmdsn; 29739e84790SAlex Aizman __be32 max_cmdsn; 29839e84790SAlex Aizman uint8_t rsvd3[12]; 29939e84790SAlex Aizman }; 30039e84790SAlex Aizman 30139e84790SAlex Aizman /* Response values */ 302baebc497SMike Christie #define ISCSI_TMF_RSP_COMPLETE 0x00 303baebc497SMike Christie #define ISCSI_TMF_RSP_NO_TASK 0x01 304baebc497SMike Christie #define ISCSI_TMF_RSP_NO_LUN 0x02 305baebc497SMike Christie #define ISCSI_TMF_RSP_TASK_ALLEGIANT 0x03 306baebc497SMike Christie #define ISCSI_TMF_RSP_NO_FAILOVER 0x04 307baebc497SMike Christie #define ISCSI_TMF_RSP_NOT_SUPPORTED 0x05 308baebc497SMike Christie #define ISCSI_TMF_RSP_AUTH_FAILED 0x06 309baebc497SMike Christie #define ISCSI_TMF_RSP_REJECTED 0xff 31039e84790SAlex Aizman 31139e84790SAlex Aizman /* Ready To Transfer Header */ 31239e84790SAlex Aizman struct iscsi_r2t_rsp { 31339e84790SAlex Aizman uint8_t opcode; 31439e84790SAlex Aizman uint8_t flags; 31539e84790SAlex Aizman uint8_t rsvd2[2]; 31639e84790SAlex Aizman uint8_t hlength; 31739e84790SAlex Aizman uint8_t dlength[3]; 31839e84790SAlex Aizman uint8_t lun[8]; 319b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 32039e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */ 32139e84790SAlex Aizman __be32 statsn; 32239e84790SAlex Aizman __be32 exp_cmdsn; 32339e84790SAlex Aizman __be32 max_cmdsn; 32439e84790SAlex Aizman __be32 r2tsn; 32539e84790SAlex Aizman __be32 data_offset; 32639e84790SAlex Aizman __be32 data_length; 32739e84790SAlex Aizman }; 32839e84790SAlex Aizman 32939e84790SAlex Aizman /* SCSI Data Hdr */ 33039e84790SAlex Aizman struct iscsi_data { 33139e84790SAlex Aizman uint8_t opcode; 33239e84790SAlex Aizman uint8_t flags; 33339e84790SAlex Aizman uint8_t rsvd2[2]; 33439e84790SAlex Aizman uint8_t rsvd3; 33539e84790SAlex Aizman uint8_t dlength[3]; 33639e84790SAlex Aizman uint8_t lun[8]; 337b4377356SAl Viro itt_t itt; 33839e84790SAlex Aizman __be32 ttt; 33939e84790SAlex Aizman __be32 rsvd4; 34039e84790SAlex Aizman __be32 exp_statsn; 34139e84790SAlex Aizman __be32 rsvd5; 34239e84790SAlex Aizman __be32 datasn; 34339e84790SAlex Aizman __be32 offset; 34439e84790SAlex Aizman __be32 rsvd6; 34539e84790SAlex Aizman /* Payload */ 34639e84790SAlex Aizman }; 34739e84790SAlex Aizman 34839e84790SAlex Aizman /* SCSI Data Response Hdr */ 34939e84790SAlex Aizman struct iscsi_data_rsp { 35039e84790SAlex Aizman uint8_t opcode; 35139e84790SAlex Aizman uint8_t flags; 35239e84790SAlex Aizman uint8_t rsvd2; 35339e84790SAlex Aizman uint8_t cmd_status; 35439e84790SAlex Aizman uint8_t hlength; 35539e84790SAlex Aizman uint8_t dlength[3]; 35639e84790SAlex Aizman uint8_t lun[8]; 357b4377356SAl Viro itt_t itt; 35839e84790SAlex Aizman __be32 ttt; 35939e84790SAlex Aizman __be32 statsn; 36039e84790SAlex Aizman __be32 exp_cmdsn; 36139e84790SAlex Aizman __be32 max_cmdsn; 36239e84790SAlex Aizman __be32 datasn; 36339e84790SAlex Aizman __be32 offset; 36439e84790SAlex Aizman __be32 residual_count; 36539e84790SAlex Aizman }; 36639e84790SAlex Aizman 36739e84790SAlex Aizman /* Data Response PDU flags */ 36839e84790SAlex Aizman #define ISCSI_FLAG_DATA_ACK 0x40 36939e84790SAlex Aizman #define ISCSI_FLAG_DATA_OVERFLOW 0x04 37039e84790SAlex Aizman #define ISCSI_FLAG_DATA_UNDERFLOW 0x02 37139e84790SAlex Aizman #define ISCSI_FLAG_DATA_STATUS 0x01 37239e84790SAlex Aizman 37339e84790SAlex Aizman /* Text Header */ 37439e84790SAlex Aizman struct iscsi_text { 37539e84790SAlex Aizman uint8_t opcode; 37639e84790SAlex Aizman uint8_t flags; 37739e84790SAlex Aizman uint8_t rsvd2[2]; 37839e84790SAlex Aizman uint8_t hlength; 37939e84790SAlex Aizman uint8_t dlength[3]; 38039e84790SAlex Aizman uint8_t rsvd4[8]; 381b4377356SAl Viro itt_t itt; 38239e84790SAlex Aizman __be32 ttt; 38339e84790SAlex Aizman __be32 cmdsn; 38439e84790SAlex Aizman __be32 exp_statsn; 38539e84790SAlex Aizman uint8_t rsvd5[16]; 38639e84790SAlex Aizman /* Text - key=value pairs */ 38739e84790SAlex Aizman }; 38839e84790SAlex Aizman 38939e84790SAlex Aizman #define ISCSI_FLAG_TEXT_CONTINUE 0x40 39039e84790SAlex Aizman 39139e84790SAlex Aizman /* Text Response Header */ 39239e84790SAlex Aizman struct iscsi_text_rsp { 39339e84790SAlex Aizman uint8_t opcode; 39439e84790SAlex Aizman uint8_t flags; 39539e84790SAlex Aizman uint8_t rsvd2[2]; 39639e84790SAlex Aizman uint8_t hlength; 39739e84790SAlex Aizman uint8_t dlength[3]; 39839e84790SAlex Aizman uint8_t rsvd4[8]; 399b4377356SAl Viro itt_t itt; 40039e84790SAlex Aizman __be32 ttt; 40139e84790SAlex Aizman __be32 statsn; 40239e84790SAlex Aizman __be32 exp_cmdsn; 40339e84790SAlex Aizman __be32 max_cmdsn; 40439e84790SAlex Aizman uint8_t rsvd5[12]; 40539e84790SAlex Aizman /* Text Response - key:value pairs */ 40639e84790SAlex Aizman }; 40739e84790SAlex Aizman 40839e84790SAlex Aizman /* Login Header */ 40912352183SNicholas Bellinger struct iscsi_login_req { 41039e84790SAlex Aizman uint8_t opcode; 41139e84790SAlex Aizman uint8_t flags; 41239e84790SAlex Aizman uint8_t max_version; /* Max. version supported */ 41339e84790SAlex Aizman uint8_t min_version; /* Min. version supported */ 41439e84790SAlex Aizman uint8_t hlength; 41539e84790SAlex Aizman uint8_t dlength[3]; 41639e84790SAlex Aizman uint8_t isid[6]; /* Initiator Session ID */ 41739e84790SAlex Aizman __be16 tsih; /* Target Session Handle */ 418b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 41939e84790SAlex Aizman __be16 cid; 42039e84790SAlex Aizman __be16 rsvd3; 42139e84790SAlex Aizman __be32 cmdsn; 42239e84790SAlex Aizman __be32 exp_statsn; 42339e84790SAlex Aizman uint8_t rsvd5[16]; 42439e84790SAlex Aizman }; 42539e84790SAlex Aizman 42639e84790SAlex Aizman /* Login PDU flags */ 42739e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_TRANSIT 0x80 42839e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_CONTINUE 0x40 42939e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK 0x0C /* 2 bits */ 43012352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_CURRENT_STAGE1 0x04 43112352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_CURRENT_STAGE2 0x08 43212352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_CURRENT_STAGE3 0x0C 43339e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK 0x03 /* 2 bits */ 43412352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_NEXT_STAGE1 0x01 43512352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_NEXT_STAGE2 0x02 43612352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_NEXT_STAGE3 0x03 43739e84790SAlex Aizman 43839e84790SAlex Aizman #define ISCSI_LOGIN_CURRENT_STAGE(flags) \ 43939e84790SAlex Aizman ((flags & ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK) >> 2) 44039e84790SAlex Aizman #define ISCSI_LOGIN_NEXT_STAGE(flags) \ 44139e84790SAlex Aizman (flags & ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK) 44239e84790SAlex Aizman 44339e84790SAlex Aizman /* Login Response Header */ 44439e84790SAlex Aizman struct iscsi_login_rsp { 44539e84790SAlex Aizman uint8_t opcode; 44639e84790SAlex Aizman uint8_t flags; 44739e84790SAlex Aizman uint8_t max_version; /* Max. version supported */ 44839e84790SAlex Aizman uint8_t active_version; /* Active version */ 44939e84790SAlex Aizman uint8_t hlength; 45039e84790SAlex Aizman uint8_t dlength[3]; 45139e84790SAlex Aizman uint8_t isid[6]; /* Initiator Session ID */ 45239e84790SAlex Aizman __be16 tsih; /* Target Session Handle */ 453b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 45439e84790SAlex Aizman __be32 rsvd3; 45539e84790SAlex Aizman __be32 statsn; 45639e84790SAlex Aizman __be32 exp_cmdsn; 45739e84790SAlex Aizman __be32 max_cmdsn; 45839e84790SAlex Aizman uint8_t status_class; /* see Login RSP ststus classes below */ 45939e84790SAlex Aizman uint8_t status_detail; /* see Login RSP Status details below */ 46039e84790SAlex Aizman uint8_t rsvd4[10]; 46139e84790SAlex Aizman }; 46239e84790SAlex Aizman 46339e84790SAlex Aizman /* Login stage (phase) codes for CSG, NSG */ 46439e84790SAlex Aizman #define ISCSI_INITIAL_LOGIN_STAGE -1 46539e84790SAlex Aizman #define ISCSI_SECURITY_NEGOTIATION_STAGE 0 46639e84790SAlex Aizman #define ISCSI_OP_PARMS_NEGOTIATION_STAGE 1 46739e84790SAlex Aizman #define ISCSI_FULL_FEATURE_PHASE 3 46839e84790SAlex Aizman 46939e84790SAlex Aizman /* Login Status response classes */ 47039e84790SAlex Aizman #define ISCSI_STATUS_CLS_SUCCESS 0x00 47139e84790SAlex Aizman #define ISCSI_STATUS_CLS_REDIRECT 0x01 47239e84790SAlex Aizman #define ISCSI_STATUS_CLS_INITIATOR_ERR 0x02 47339e84790SAlex Aizman #define ISCSI_STATUS_CLS_TARGET_ERR 0x03 47439e84790SAlex Aizman 47539e84790SAlex Aizman /* Login Status response detail codes */ 47639e84790SAlex Aizman /* Class-0 (Success) */ 47739e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_ACCEPT 0x00 47839e84790SAlex Aizman 47939e84790SAlex Aizman /* Class-1 (Redirection) */ 48039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_MOVED_TEMP 0x01 48139e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_MOVED_PERM 0x02 48239e84790SAlex Aizman 48339e84790SAlex Aizman /* Class-2 (Initiator Error) */ 48439e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_INIT_ERR 0x00 48539e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_AUTH_FAILED 0x01 48639e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_FORBIDDEN 0x02 48739e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_NOT_FOUND 0x03 48839e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_REMOVED 0x04 48939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_VERSION 0x05 49039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_ISID_ERROR 0x06 49139e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_MISSING_FIELDS 0x07 49239e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_CONN_ADD_FAILED 0x08 49339e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_SESSION_TYPE 0x09 49439e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_SESSION 0x0a 49539e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_INVALID_REQUEST 0x0b 49639e84790SAlex Aizman 49739e84790SAlex Aizman /* Class-3 (Target Error) */ 49839e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TARGET_ERROR 0x00 49939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_SVC_UNAVAILABLE 0x01 50039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_RESOURCES 0x02 50139e84790SAlex Aizman 50239e84790SAlex Aizman /* Logout Header */ 50339e84790SAlex Aizman struct iscsi_logout { 50439e84790SAlex Aizman uint8_t opcode; 50539e84790SAlex Aizman uint8_t flags; 50639e84790SAlex Aizman uint8_t rsvd1[2]; 50739e84790SAlex Aizman uint8_t hlength; 50839e84790SAlex Aizman uint8_t dlength[3]; 50939e84790SAlex Aizman uint8_t rsvd2[8]; 510b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 51139e84790SAlex Aizman __be16 cid; 51239e84790SAlex Aizman uint8_t rsvd3[2]; 51339e84790SAlex Aizman __be32 cmdsn; 51439e84790SAlex Aizman __be32 exp_statsn; 51539e84790SAlex Aizman uint8_t rsvd4[16]; 51639e84790SAlex Aizman }; 51739e84790SAlex Aizman 51839e84790SAlex Aizman /* Logout PDU flags */ 51939e84790SAlex Aizman #define ISCSI_FLAG_LOGOUT_REASON_MASK 0x7F 52039e84790SAlex Aizman 52139e84790SAlex Aizman /* logout reason_code values */ 52239e84790SAlex Aizman 52339e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0 52439e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1 52539e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_RECOVERY 2 52639e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_AEN_REQUEST 3 52739e84790SAlex Aizman 52839e84790SAlex Aizman /* Logout Response Header */ 52939e84790SAlex Aizman struct iscsi_logout_rsp { 53039e84790SAlex Aizman uint8_t opcode; 53139e84790SAlex Aizman uint8_t flags; 53239e84790SAlex Aizman uint8_t response; /* see Logout response values below */ 53339e84790SAlex Aizman uint8_t rsvd2; 53439e84790SAlex Aizman uint8_t hlength; 53539e84790SAlex Aizman uint8_t dlength[3]; 53639e84790SAlex Aizman uint8_t rsvd3[8]; 537b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 53839e84790SAlex Aizman __be32 rsvd4; 53939e84790SAlex Aizman __be32 statsn; 54039e84790SAlex Aizman __be32 exp_cmdsn; 54139e84790SAlex Aizman __be32 max_cmdsn; 54239e84790SAlex Aizman __be32 rsvd5; 54339e84790SAlex Aizman __be16 t2wait; 54439e84790SAlex Aizman __be16 t2retain; 54539e84790SAlex Aizman __be32 rsvd6; 54639e84790SAlex Aizman }; 54739e84790SAlex Aizman 54839e84790SAlex Aizman /* logout response status values */ 54939e84790SAlex Aizman 55039e84790SAlex Aizman #define ISCSI_LOGOUT_SUCCESS 0 55139e84790SAlex Aizman #define ISCSI_LOGOUT_CID_NOT_FOUND 1 55239e84790SAlex Aizman #define ISCSI_LOGOUT_RECOVERY_UNSUPPORTED 2 55339e84790SAlex Aizman #define ISCSI_LOGOUT_CLEANUP_FAILED 3 55439e84790SAlex Aizman 55539e84790SAlex Aizman /* SNACK Header */ 55639e84790SAlex Aizman struct iscsi_snack { 55739e84790SAlex Aizman uint8_t opcode; 55839e84790SAlex Aizman uint8_t flags; 55912352183SNicholas Bellinger uint8_t rsvd2[2]; 56012352183SNicholas Bellinger uint8_t hlength; 56112352183SNicholas Bellinger uint8_t dlength[3]; 56212352183SNicholas Bellinger uint8_t lun[8]; 563b4377356SAl Viro itt_t itt; 56412352183SNicholas Bellinger __be32 ttt; 56512352183SNicholas Bellinger uint8_t rsvd3[4]; 56612352183SNicholas Bellinger __be32 exp_statsn; 56712352183SNicholas Bellinger uint8_t rsvd4[8]; 56839e84790SAlex Aizman __be32 begrun; 56939e84790SAlex Aizman __be32 runlength; 57039e84790SAlex Aizman }; 57139e84790SAlex Aizman 57239e84790SAlex Aizman /* SNACK PDU flags */ 57312352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_DATA 0 57412352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_R2T 0 57512352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_STATUS 1 57612352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_DATA_ACK 2 57712352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_RDATA 3 57839e84790SAlex Aizman #define ISCSI_FLAG_SNACK_TYPE_MASK 0x0F /* 4 bits */ 57939e84790SAlex Aizman 58039e84790SAlex Aizman /* Reject Message Header */ 58139e84790SAlex Aizman struct iscsi_reject { 58239e84790SAlex Aizman uint8_t opcode; 58339e84790SAlex Aizman uint8_t flags; 58439e84790SAlex Aizman uint8_t reason; 58539e84790SAlex Aizman uint8_t rsvd2; 586fa0a6957SMike Christie uint8_t hlength; 58739e84790SAlex Aizman uint8_t dlength[3]; 588fa0a6957SMike Christie uint8_t rsvd3[8]; 589fa0a6957SMike Christie __be32 ffffffff; 590fa0a6957SMike Christie uint8_t rsvd4[4]; 59139e84790SAlex Aizman __be32 statsn; 59239e84790SAlex Aizman __be32 exp_cmdsn; 59339e84790SAlex Aizman __be32 max_cmdsn; 59439e84790SAlex Aizman __be32 datasn; 59539e84790SAlex Aizman uint8_t rsvd5[8]; 59639e84790SAlex Aizman /* Text - Rejected hdr */ 59739e84790SAlex Aizman }; 59839e84790SAlex Aizman 59939e84790SAlex Aizman /* Reason for Reject */ 600fa0a6957SMike Christie #define ISCSI_REASON_CMD_BEFORE_LOGIN 1 601fa0a6957SMike Christie #define ISCSI_REASON_DATA_DIGEST_ERROR 2 602fa0a6957SMike Christie #define ISCSI_REASON_DATA_SNACK_REJECT 3 603fa0a6957SMike Christie #define ISCSI_REASON_PROTOCOL_ERROR 4 604fa0a6957SMike Christie #define ISCSI_REASON_CMD_NOT_SUPPORTED 5 605fa0a6957SMike Christie #define ISCSI_REASON_IMM_CMD_REJECT 6 606fa0a6957SMike Christie #define ISCSI_REASON_TASK_IN_PROGRESS 7 607fa0a6957SMike Christie #define ISCSI_REASON_INVALID_SNACK 8 608fa0a6957SMike Christie #define ISCSI_REASON_BOOKMARK_INVALID 9 609fa0a6957SMike Christie #define ISCSI_REASON_BOOKMARK_NO_RESOURCES 10 610fa0a6957SMike Christie #define ISCSI_REASON_NEGOTIATION_RESET 11 61139e84790SAlex Aizman 61239e84790SAlex Aizman /* Max. number of Key=Value pairs in a text message */ 61339e84790SAlex Aizman #define MAX_KEY_VALUE_PAIRS 8192 61439e84790SAlex Aizman 61539e84790SAlex Aizman /* maximum length for text keys/values */ 61639e84790SAlex Aizman #define KEY_MAXLEN 64 61739e84790SAlex Aizman #define VALUE_MAXLEN 255 61839e84790SAlex Aizman #define TARGET_NAME_MAXLEN VALUE_MAXLEN 61939e84790SAlex Aizman 620bf32ed33SMike Christie #define ISCSI_DEF_MAX_RECV_SEG_LEN 8192 621bf32ed33SMike Christie #define ISCSI_MIN_MAX_RECV_SEG_LEN 512 622bf32ed33SMike Christie #define ISCSI_MAX_MAX_RECV_SEG_LEN 16777215 623bf32ed33SMike Christie 624bf32ed33SMike Christie #define ISCSI_DEF_FIRST_BURST_LEN 65536 625bf32ed33SMike Christie #define ISCSI_MIN_FIRST_BURST_LEN 512 626bf32ed33SMike Christie #define ISCSI_MAX_FIRST_BURST_LEN 16777215 627bf32ed33SMike Christie 628bf32ed33SMike Christie #define ISCSI_DEF_MAX_BURST_LEN 262144 629bf32ed33SMike Christie #define ISCSI_MIN_MAX_BURST_LEN 512 630bf32ed33SMike Christie #define ISCSI_MAX_MAX_BURST_LEN 16777215 63139e84790SAlex Aizman 632843c0a8aSMike Christie #define ISCSI_DEF_TIME2WAIT 2 633843c0a8aSMike Christie 63439e84790SAlex Aizman /************************* RFC 3720 End *****************************/ 63539e84790SAlex Aizman 63639e84790SAlex Aizman #endif /* ISCSI_PROTO_H */ 637