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 328304bbceSNicholas Bellinger /* iSCSI header length */ 338304bbceSNicholas Bellinger #define ISCSI_HDR_LEN 48 348304bbceSNicholas Bellinger 358304bbceSNicholas Bellinger /* iSCSI CRC32C length */ 368304bbceSNicholas Bellinger #define ISCSI_CRC_LEN 4 378304bbceSNicholas Bellinger 3839e84790SAlex Aizman /* Padding word length */ 39004d6530SBoaz Harrosh #define ISCSI_PAD_LEN 4 4039e84790SAlex Aizman 4139e84790SAlex Aizman /* 428304bbceSNicholas Bellinger * Serial Number Arithmetic, 32 bits, RFC1982 438304bbceSNicholas Bellinger */ 448304bbceSNicholas Bellinger 458304bbceSNicholas Bellinger static inline int iscsi_sna_lt(u32 n1, u32 n2) 468304bbceSNicholas Bellinger { 478304bbceSNicholas Bellinger return (s32)(n1 - n2) < 0; 488304bbceSNicholas Bellinger } 498304bbceSNicholas Bellinger 508304bbceSNicholas Bellinger static inline int iscsi_sna_lte(u32 n1, u32 n2) 518304bbceSNicholas Bellinger { 528304bbceSNicholas Bellinger return (s32)(n1 - n2) <= 0; 538304bbceSNicholas Bellinger } 548304bbceSNicholas Bellinger 558304bbceSNicholas Bellinger static inline int iscsi_sna_gt(u32 n1, u32 n2) 568304bbceSNicholas Bellinger { 578304bbceSNicholas Bellinger return (s32)(n1 - n2) > 0; 588304bbceSNicholas Bellinger } 598304bbceSNicholas Bellinger 608304bbceSNicholas Bellinger static inline int iscsi_sna_gte(u32 n1, u32 n2) 618304bbceSNicholas Bellinger { 628304bbceSNicholas Bellinger return (s32)(n1 - n2) >= 0; 638304bbceSNicholas Bellinger } 648304bbceSNicholas Bellinger 658304bbceSNicholas Bellinger /* 6639e84790SAlex Aizman * useful common(control and data pathes) macro 6739e84790SAlex Aizman */ 6839e84790SAlex Aizman #define ntoh24(p) (((p)[0] << 16) | ((p)[1] << 8) | ((p)[2])) 6939e84790SAlex Aizman #define hton24(p, v) { \ 7039e84790SAlex Aizman p[0] = (((v) >> 16) & 0xFF); \ 7139e84790SAlex Aizman p[1] = (((v) >> 8) & 0xFF); \ 7239e84790SAlex Aizman p[2] = ((v) & 0xFF); \ 7339e84790SAlex Aizman } 7439e84790SAlex Aizman #define zero_data(p) {p[0]=0;p[1]=0;p[2]=0;} 7539e84790SAlex Aizman 76b4377356SAl Viro /* initiator tags; opaque for target */ 77b4377356SAl Viro typedef uint32_t __bitwise__ itt_t; 78b4377356SAl Viro /* below makes sense only for initiator that created this tag */ 798b1d0343SMike Christie #define build_itt(itt, age) ((__force itt_t)\ 808b1d0343SMike Christie ((itt) | ((age) << ISCSI_AGE_SHIFT))) 81b4377356SAl Viro #define get_itt(itt) ((__force uint32_t)(itt_t)(itt) & ISCSI_ITT_MASK) 82b4377356SAl Viro #define RESERVED_ITT ((__force itt_t)0xffffffff) 83b4377356SAl Viro 8439e84790SAlex Aizman /* 8539e84790SAlex Aizman * iSCSI Template Message Header 8639e84790SAlex Aizman */ 8739e84790SAlex Aizman struct iscsi_hdr { 8839e84790SAlex Aizman uint8_t opcode; 8939e84790SAlex Aizman uint8_t flags; /* Final bit */ 9039e84790SAlex Aizman uint8_t rsvd2[2]; 9139e84790SAlex Aizman uint8_t hlength; /* AHSs total length */ 9239e84790SAlex Aizman uint8_t dlength[3]; /* Data length */ 9355bdabdfSAndy Grover struct scsi_lun lun; 94b4377356SAl Viro itt_t itt; /* Initiator Task Tag, opaque for target */ 9539e84790SAlex Aizman __be32 ttt; /* Target Task Tag */ 9639e84790SAlex Aizman __be32 statsn; 9739e84790SAlex Aizman __be32 exp_statsn; 98baebc497SMike Christie __be32 max_statsn; 99baebc497SMike Christie uint8_t other[12]; 10039e84790SAlex Aizman }; 10139e84790SAlex Aizman 10239e84790SAlex Aizman /************************* RFC 3720 Begin *****************************/ 10339e84790SAlex Aizman 10439e84790SAlex Aizman #define ISCSI_RESERVED_TAG 0xffffffff 10539e84790SAlex Aizman 10639e84790SAlex Aizman /* Opcode encoding bits */ 10739e84790SAlex Aizman #define ISCSI_OP_RETRY 0x80 10839e84790SAlex Aizman #define ISCSI_OP_IMMEDIATE 0x40 10939e84790SAlex Aizman #define ISCSI_OPCODE_MASK 0x3F 11039e84790SAlex Aizman 11139e84790SAlex Aizman /* Initiator Opcode values */ 11239e84790SAlex Aizman #define ISCSI_OP_NOOP_OUT 0x00 11339e84790SAlex Aizman #define ISCSI_OP_SCSI_CMD 0x01 11439e84790SAlex Aizman #define ISCSI_OP_SCSI_TMFUNC 0x02 11539e84790SAlex Aizman #define ISCSI_OP_LOGIN 0x03 11639e84790SAlex Aizman #define ISCSI_OP_TEXT 0x04 11739e84790SAlex Aizman #define ISCSI_OP_SCSI_DATA_OUT 0x05 11839e84790SAlex Aizman #define ISCSI_OP_LOGOUT 0x06 11939e84790SAlex Aizman #define ISCSI_OP_SNACK 0x10 12039e84790SAlex Aizman 121baebc497SMike Christie #define ISCSI_OP_VENDOR1_CMD 0x1c 122baebc497SMike Christie #define ISCSI_OP_VENDOR2_CMD 0x1d 123baebc497SMike Christie #define ISCSI_OP_VENDOR3_CMD 0x1e 124baebc497SMike Christie #define ISCSI_OP_VENDOR4_CMD 0x1f 125baebc497SMike Christie 12639e84790SAlex Aizman /* Target Opcode values */ 12739e84790SAlex Aizman #define ISCSI_OP_NOOP_IN 0x20 12839e84790SAlex Aizman #define ISCSI_OP_SCSI_CMD_RSP 0x21 12939e84790SAlex Aizman #define ISCSI_OP_SCSI_TMFUNC_RSP 0x22 13039e84790SAlex Aizman #define ISCSI_OP_LOGIN_RSP 0x23 13139e84790SAlex Aizman #define ISCSI_OP_TEXT_RSP 0x24 13239e84790SAlex Aizman #define ISCSI_OP_SCSI_DATA_IN 0x25 13339e84790SAlex Aizman #define ISCSI_OP_LOGOUT_RSP 0x26 13439e84790SAlex Aizman #define ISCSI_OP_R2T 0x31 13539e84790SAlex Aizman #define ISCSI_OP_ASYNC_EVENT 0x32 13639e84790SAlex Aizman #define ISCSI_OP_REJECT 0x3f 13739e84790SAlex Aizman 138baebc497SMike Christie struct iscsi_ahs_hdr { 139baebc497SMike Christie __be16 ahslength; 140baebc497SMike Christie uint8_t ahstype; 141baebc497SMike Christie uint8_t ahspec[5]; 142baebc497SMike Christie }; 143baebc497SMike Christie 144baebc497SMike Christie #define ISCSI_AHSTYPE_CDB 1 145baebc497SMike Christie #define ISCSI_AHSTYPE_RLENGTH 2 14638d1c069SBoaz Harrosh #define ISCSI_CDB_SIZE 16 147baebc497SMike Christie 14839e84790SAlex Aizman /* iSCSI PDU Header */ 14912352183SNicholas Bellinger struct iscsi_scsi_req { 15039e84790SAlex Aizman uint8_t opcode; 15139e84790SAlex Aizman uint8_t flags; 152baebc497SMike Christie __be16 rsvd2; 15339e84790SAlex Aizman uint8_t hlength; 15439e84790SAlex Aizman uint8_t dlength[3]; 15555bdabdfSAndy Grover struct scsi_lun lun; 156b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 15739e84790SAlex Aizman __be32 data_length; 15839e84790SAlex Aizman __be32 cmdsn; 15939e84790SAlex Aizman __be32 exp_statsn; 16038d1c069SBoaz Harrosh uint8_t cdb[ISCSI_CDB_SIZE]; /* SCSI Command Block */ 16139e84790SAlex Aizman /* Additional Data (Command Dependent) */ 16239e84790SAlex Aizman }; 16339e84790SAlex Aizman 16439e84790SAlex Aizman /* Command PDU flags */ 16539e84790SAlex Aizman #define ISCSI_FLAG_CMD_FINAL 0x80 16639e84790SAlex Aizman #define ISCSI_FLAG_CMD_READ 0x40 16739e84790SAlex Aizman #define ISCSI_FLAG_CMD_WRITE 0x20 16839e84790SAlex Aizman #define ISCSI_FLAG_CMD_ATTR_MASK 0x07 /* 3 bits */ 16939e84790SAlex Aizman 17039e84790SAlex Aizman /* SCSI Command Attribute values */ 17139e84790SAlex Aizman #define ISCSI_ATTR_UNTAGGED 0 17239e84790SAlex Aizman #define ISCSI_ATTR_SIMPLE 1 17339e84790SAlex Aizman #define ISCSI_ATTR_ORDERED 2 17439e84790SAlex Aizman #define ISCSI_ATTR_HEAD_OF_QUEUE 3 17539e84790SAlex Aizman #define ISCSI_ATTR_ACA 4 17639e84790SAlex Aizman 177baebc497SMike Christie struct iscsi_rlength_ahdr { 178baebc497SMike Christie __be16 ahslength; 179baebc497SMike Christie uint8_t ahstype; 180baebc497SMike Christie uint8_t reserved; 181baebc497SMike Christie __be32 read_length; 182baebc497SMike Christie }; 183baebc497SMike Christie 184004d6530SBoaz Harrosh /* Extended CDB AHS */ 185004d6530SBoaz Harrosh struct iscsi_ecdb_ahdr { 186004d6530SBoaz Harrosh __be16 ahslength; /* CDB length - 15, including reserved byte */ 187004d6530SBoaz Harrosh uint8_t ahstype; 188004d6530SBoaz Harrosh uint8_t reserved; 18938d1c069SBoaz Harrosh /* 4-byte aligned extended CDB spillover */ 19030e9ba9fSBoaz Harrosh uint8_t ecdb[SCSI_MAX_VARLEN_CDB_SIZE - ISCSI_CDB_SIZE]; 191004d6530SBoaz Harrosh }; 192004d6530SBoaz Harrosh 19339e84790SAlex Aizman /* SCSI Response Header */ 19412352183SNicholas Bellinger struct iscsi_scsi_rsp { 19539e84790SAlex Aizman uint8_t opcode; 19639e84790SAlex Aizman uint8_t flags; 19739e84790SAlex Aizman uint8_t response; 19839e84790SAlex Aizman uint8_t cmd_status; 19939e84790SAlex Aizman uint8_t hlength; 20039e84790SAlex Aizman uint8_t dlength[3]; 20139e84790SAlex Aizman uint8_t rsvd[8]; 202b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 20339e84790SAlex Aizman __be32 rsvd1; 20439e84790SAlex Aizman __be32 statsn; 20539e84790SAlex Aizman __be32 exp_cmdsn; 20639e84790SAlex Aizman __be32 max_cmdsn; 20739e84790SAlex Aizman __be32 exp_datasn; 20839e84790SAlex Aizman __be32 bi_residual_count; 20939e84790SAlex Aizman __be32 residual_count; 21039e84790SAlex Aizman /* Response or Sense Data (optional) */ 21139e84790SAlex Aizman }; 21239e84790SAlex Aizman 21339e84790SAlex Aizman /* Command Response PDU flags */ 21439e84790SAlex Aizman #define ISCSI_FLAG_CMD_BIDI_OVERFLOW 0x10 21539e84790SAlex Aizman #define ISCSI_FLAG_CMD_BIDI_UNDERFLOW 0x08 21639e84790SAlex Aizman #define ISCSI_FLAG_CMD_OVERFLOW 0x04 21739e84790SAlex Aizman #define ISCSI_FLAG_CMD_UNDERFLOW 0x02 21839e84790SAlex Aizman 21939e84790SAlex Aizman /* iSCSI Status values. Valid if Rsp Selector bit is not set */ 22039e84790SAlex Aizman #define ISCSI_STATUS_CMD_COMPLETED 0 22139e84790SAlex Aizman #define ISCSI_STATUS_TARGET_FAILURE 1 22239e84790SAlex Aizman #define ISCSI_STATUS_SUBSYS_FAILURE 2 22339e84790SAlex Aizman 22439e84790SAlex Aizman /* Asynchronous Event Header */ 22539e84790SAlex Aizman struct iscsi_async { 22639e84790SAlex Aizman uint8_t opcode; 22739e84790SAlex Aizman uint8_t flags; 22839e84790SAlex Aizman uint8_t rsvd2[2]; 22939e84790SAlex Aizman uint8_t rsvd3; 23039e84790SAlex Aizman uint8_t dlength[3]; 23155bdabdfSAndy Grover struct scsi_lun lun; 23239e84790SAlex Aizman uint8_t rsvd4[8]; 23339e84790SAlex Aizman __be32 statsn; 23439e84790SAlex Aizman __be32 exp_cmdsn; 23539e84790SAlex Aizman __be32 max_cmdsn; 23639e84790SAlex Aizman uint8_t async_event; 23739e84790SAlex Aizman uint8_t async_vcode; 23839e84790SAlex Aizman __be16 param1; 23939e84790SAlex Aizman __be16 param2; 24039e84790SAlex Aizman __be16 param3; 24139e84790SAlex Aizman uint8_t rsvd5[4]; 24239e84790SAlex Aizman }; 24339e84790SAlex Aizman 24439e84790SAlex Aizman /* iSCSI Event Codes */ 24539e84790SAlex Aizman #define ISCSI_ASYNC_MSG_SCSI_EVENT 0 24639e84790SAlex Aizman #define ISCSI_ASYNC_MSG_REQUEST_LOGOUT 1 24739e84790SAlex Aizman #define ISCSI_ASYNC_MSG_DROPPING_CONNECTION 2 24839e84790SAlex Aizman #define ISCSI_ASYNC_MSG_DROPPING_ALL_CONNECTIONS 3 24939e84790SAlex Aizman #define ISCSI_ASYNC_MSG_PARAM_NEGOTIATION 4 25039e84790SAlex Aizman #define ISCSI_ASYNC_MSG_VENDOR_SPECIFIC 255 25139e84790SAlex Aizman 25239e84790SAlex Aizman /* NOP-Out Message */ 25339e84790SAlex Aizman struct iscsi_nopout { 25439e84790SAlex Aizman uint8_t opcode; 25539e84790SAlex Aizman uint8_t flags; 25639e84790SAlex Aizman __be16 rsvd2; 25739e84790SAlex Aizman uint8_t rsvd3; 25839e84790SAlex Aizman uint8_t dlength[3]; 25955bdabdfSAndy Grover struct scsi_lun lun; 260b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 26139e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */ 26239e84790SAlex Aizman __be32 cmdsn; 26339e84790SAlex Aizman __be32 exp_statsn; 26439e84790SAlex Aizman uint8_t rsvd4[16]; 26539e84790SAlex Aizman }; 26639e84790SAlex Aizman 26739e84790SAlex Aizman /* NOP-In Message */ 26839e84790SAlex Aizman struct iscsi_nopin { 26939e84790SAlex Aizman uint8_t opcode; 27039e84790SAlex Aizman uint8_t flags; 27139e84790SAlex Aizman __be16 rsvd2; 27239e84790SAlex Aizman uint8_t rsvd3; 27339e84790SAlex Aizman uint8_t dlength[3]; 27455bdabdfSAndy Grover struct scsi_lun lun; 275b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 27639e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */ 27739e84790SAlex Aizman __be32 statsn; 27839e84790SAlex Aizman __be32 exp_cmdsn; 27939e84790SAlex Aizman __be32 max_cmdsn; 28039e84790SAlex Aizman uint8_t rsvd4[12]; 28139e84790SAlex Aizman }; 28239e84790SAlex Aizman 28339e84790SAlex Aizman /* SCSI Task Management Message Header */ 28439e84790SAlex Aizman struct iscsi_tm { 28539e84790SAlex Aizman uint8_t opcode; 28639e84790SAlex Aizman uint8_t flags; 28739e84790SAlex Aizman uint8_t rsvd1[2]; 28839e84790SAlex Aizman uint8_t hlength; 28939e84790SAlex Aizman uint8_t dlength[3]; 29055bdabdfSAndy Grover struct scsi_lun lun; 291b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 292b4377356SAl Viro itt_t rtt; /* Reference Task Tag */ 29339e84790SAlex Aizman __be32 cmdsn; 29439e84790SAlex Aizman __be32 exp_statsn; 29539e84790SAlex Aizman __be32 refcmdsn; 29639e84790SAlex Aizman __be32 exp_datasn; 29739e84790SAlex Aizman uint8_t rsvd2[8]; 29839e84790SAlex Aizman }; 29939e84790SAlex Aizman 300baebc497SMike Christie #define ISCSI_FLAG_TM_FUNC_MASK 0x7F 30139e84790SAlex Aizman 30239e84790SAlex Aizman /* Function values */ 30339e84790SAlex Aizman #define ISCSI_TM_FUNC_ABORT_TASK 1 30439e84790SAlex Aizman #define ISCSI_TM_FUNC_ABORT_TASK_SET 2 30539e84790SAlex Aizman #define ISCSI_TM_FUNC_CLEAR_ACA 3 30639e84790SAlex Aizman #define ISCSI_TM_FUNC_CLEAR_TASK_SET 4 30739e84790SAlex Aizman #define ISCSI_TM_FUNC_LOGICAL_UNIT_RESET 5 30839e84790SAlex Aizman #define ISCSI_TM_FUNC_TARGET_WARM_RESET 6 30939e84790SAlex Aizman #define ISCSI_TM_FUNC_TARGET_COLD_RESET 7 31039e84790SAlex Aizman #define ISCSI_TM_FUNC_TASK_REASSIGN 8 31139e84790SAlex Aizman 3125d12c05eSMike Christie #define ISCSI_TM_FUNC_VALUE(hdr) ((hdr)->flags & ISCSI_FLAG_TM_FUNC_MASK) 3135d12c05eSMike Christie 31439e84790SAlex Aizman /* SCSI Task Management Response Header */ 31539e84790SAlex Aizman struct iscsi_tm_rsp { 31639e84790SAlex Aizman uint8_t opcode; 31739e84790SAlex Aizman uint8_t flags; 31839e84790SAlex Aizman uint8_t response; /* see Response values below */ 31939e84790SAlex Aizman uint8_t qualifier; 32039e84790SAlex Aizman uint8_t hlength; 32139e84790SAlex Aizman uint8_t dlength[3]; 32239e84790SAlex Aizman uint8_t rsvd2[8]; 323b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 324b4377356SAl Viro itt_t rtt; /* Reference Task Tag */ 32539e84790SAlex Aizman __be32 statsn; 32639e84790SAlex Aizman __be32 exp_cmdsn; 32739e84790SAlex Aizman __be32 max_cmdsn; 32839e84790SAlex Aizman uint8_t rsvd3[12]; 32939e84790SAlex Aizman }; 33039e84790SAlex Aizman 33139e84790SAlex Aizman /* Response values */ 332baebc497SMike Christie #define ISCSI_TMF_RSP_COMPLETE 0x00 333baebc497SMike Christie #define ISCSI_TMF_RSP_NO_TASK 0x01 334baebc497SMike Christie #define ISCSI_TMF_RSP_NO_LUN 0x02 335baebc497SMike Christie #define ISCSI_TMF_RSP_TASK_ALLEGIANT 0x03 336baebc497SMike Christie #define ISCSI_TMF_RSP_NO_FAILOVER 0x04 337baebc497SMike Christie #define ISCSI_TMF_RSP_NOT_SUPPORTED 0x05 338baebc497SMike Christie #define ISCSI_TMF_RSP_AUTH_FAILED 0x06 339baebc497SMike Christie #define ISCSI_TMF_RSP_REJECTED 0xff 34039e84790SAlex Aizman 34139e84790SAlex Aizman /* Ready To Transfer Header */ 34239e84790SAlex Aizman struct iscsi_r2t_rsp { 34339e84790SAlex Aizman uint8_t opcode; 34439e84790SAlex Aizman uint8_t flags; 34539e84790SAlex Aizman uint8_t rsvd2[2]; 34639e84790SAlex Aizman uint8_t hlength; 34739e84790SAlex Aizman uint8_t dlength[3]; 34855bdabdfSAndy Grover struct scsi_lun lun; 349b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 35039e84790SAlex Aizman __be32 ttt; /* Target Transfer Tag */ 35139e84790SAlex Aizman __be32 statsn; 35239e84790SAlex Aizman __be32 exp_cmdsn; 35339e84790SAlex Aizman __be32 max_cmdsn; 35439e84790SAlex Aizman __be32 r2tsn; 35539e84790SAlex Aizman __be32 data_offset; 35639e84790SAlex Aizman __be32 data_length; 35739e84790SAlex Aizman }; 35839e84790SAlex Aizman 35939e84790SAlex Aizman /* SCSI Data Hdr */ 36039e84790SAlex Aizman struct iscsi_data { 36139e84790SAlex Aizman uint8_t opcode; 36239e84790SAlex Aizman uint8_t flags; 36339e84790SAlex Aizman uint8_t rsvd2[2]; 36439e84790SAlex Aizman uint8_t rsvd3; 36539e84790SAlex Aizman uint8_t dlength[3]; 36655bdabdfSAndy Grover struct scsi_lun lun; 367b4377356SAl Viro itt_t itt; 36839e84790SAlex Aizman __be32 ttt; 36939e84790SAlex Aizman __be32 rsvd4; 37039e84790SAlex Aizman __be32 exp_statsn; 37139e84790SAlex Aizman __be32 rsvd5; 37239e84790SAlex Aizman __be32 datasn; 37339e84790SAlex Aizman __be32 offset; 37439e84790SAlex Aizman __be32 rsvd6; 37539e84790SAlex Aizman /* Payload */ 37639e84790SAlex Aizman }; 37739e84790SAlex Aizman 37839e84790SAlex Aizman /* SCSI Data Response Hdr */ 37939e84790SAlex Aizman struct iscsi_data_rsp { 38039e84790SAlex Aizman uint8_t opcode; 38139e84790SAlex Aizman uint8_t flags; 38239e84790SAlex Aizman uint8_t rsvd2; 38339e84790SAlex Aizman uint8_t cmd_status; 38439e84790SAlex Aizman uint8_t hlength; 38539e84790SAlex Aizman uint8_t dlength[3]; 38655bdabdfSAndy Grover struct scsi_lun lun; 387b4377356SAl Viro itt_t itt; 38839e84790SAlex Aizman __be32 ttt; 38939e84790SAlex Aizman __be32 statsn; 39039e84790SAlex Aizman __be32 exp_cmdsn; 39139e84790SAlex Aizman __be32 max_cmdsn; 39239e84790SAlex Aizman __be32 datasn; 39339e84790SAlex Aizman __be32 offset; 39439e84790SAlex Aizman __be32 residual_count; 39539e84790SAlex Aizman }; 39639e84790SAlex Aizman 39739e84790SAlex Aizman /* Data Response PDU flags */ 39839e84790SAlex Aizman #define ISCSI_FLAG_DATA_ACK 0x40 39939e84790SAlex Aizman #define ISCSI_FLAG_DATA_OVERFLOW 0x04 40039e84790SAlex Aizman #define ISCSI_FLAG_DATA_UNDERFLOW 0x02 40139e84790SAlex Aizman #define ISCSI_FLAG_DATA_STATUS 0x01 40239e84790SAlex Aizman 40339e84790SAlex Aizman /* Text Header */ 40439e84790SAlex Aizman struct iscsi_text { 40539e84790SAlex Aizman uint8_t opcode; 40639e84790SAlex Aizman uint8_t flags; 40739e84790SAlex Aizman uint8_t rsvd2[2]; 40839e84790SAlex Aizman uint8_t hlength; 40939e84790SAlex Aizman uint8_t dlength[3]; 41039e84790SAlex Aizman uint8_t rsvd4[8]; 411b4377356SAl Viro itt_t itt; 41239e84790SAlex Aizman __be32 ttt; 41339e84790SAlex Aizman __be32 cmdsn; 41439e84790SAlex Aizman __be32 exp_statsn; 41539e84790SAlex Aizman uint8_t rsvd5[16]; 41639e84790SAlex Aizman /* Text - key=value pairs */ 41739e84790SAlex Aizman }; 41839e84790SAlex Aizman 41939e84790SAlex Aizman #define ISCSI_FLAG_TEXT_CONTINUE 0x40 42039e84790SAlex Aizman 42139e84790SAlex Aizman /* Text Response Header */ 42239e84790SAlex Aizman struct iscsi_text_rsp { 42339e84790SAlex Aizman uint8_t opcode; 42439e84790SAlex Aizman uint8_t flags; 42539e84790SAlex Aizman uint8_t rsvd2[2]; 42639e84790SAlex Aizman uint8_t hlength; 42739e84790SAlex Aizman uint8_t dlength[3]; 42839e84790SAlex Aizman uint8_t rsvd4[8]; 429b4377356SAl Viro itt_t itt; 43039e84790SAlex Aizman __be32 ttt; 43139e84790SAlex Aizman __be32 statsn; 43239e84790SAlex Aizman __be32 exp_cmdsn; 43339e84790SAlex Aizman __be32 max_cmdsn; 43439e84790SAlex Aizman uint8_t rsvd5[12]; 43539e84790SAlex Aizman /* Text Response - key:value pairs */ 43639e84790SAlex Aizman }; 43739e84790SAlex Aizman 43839e84790SAlex Aizman /* Login Header */ 43912352183SNicholas Bellinger struct iscsi_login_req { 44039e84790SAlex Aizman uint8_t opcode; 44139e84790SAlex Aizman uint8_t flags; 44239e84790SAlex Aizman uint8_t max_version; /* Max. version supported */ 44339e84790SAlex Aizman uint8_t min_version; /* Min. version supported */ 44439e84790SAlex Aizman uint8_t hlength; 44539e84790SAlex Aizman uint8_t dlength[3]; 44639e84790SAlex Aizman uint8_t isid[6]; /* Initiator Session ID */ 44739e84790SAlex Aizman __be16 tsih; /* Target Session Handle */ 448b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 44939e84790SAlex Aizman __be16 cid; 45039e84790SAlex Aizman __be16 rsvd3; 45139e84790SAlex Aizman __be32 cmdsn; 45239e84790SAlex Aizman __be32 exp_statsn; 45339e84790SAlex Aizman uint8_t rsvd5[16]; 45439e84790SAlex Aizman }; 45539e84790SAlex Aizman 45639e84790SAlex Aizman /* Login PDU flags */ 45739e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_TRANSIT 0x80 45839e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_CONTINUE 0x40 45939e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK 0x0C /* 2 bits */ 46012352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_CURRENT_STAGE1 0x04 46112352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_CURRENT_STAGE2 0x08 46212352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_CURRENT_STAGE3 0x0C 46339e84790SAlex Aizman #define ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK 0x03 /* 2 bits */ 46412352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_NEXT_STAGE1 0x01 46512352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_NEXT_STAGE2 0x02 46612352183SNicholas Bellinger #define ISCSI_FLAG_LOGIN_NEXT_STAGE3 0x03 46739e84790SAlex Aizman 46839e84790SAlex Aizman #define ISCSI_LOGIN_CURRENT_STAGE(flags) \ 46939e84790SAlex Aizman ((flags & ISCSI_FLAG_LOGIN_CURRENT_STAGE_MASK) >> 2) 47039e84790SAlex Aizman #define ISCSI_LOGIN_NEXT_STAGE(flags) \ 47139e84790SAlex Aizman (flags & ISCSI_FLAG_LOGIN_NEXT_STAGE_MASK) 47239e84790SAlex Aizman 47339e84790SAlex Aizman /* Login Response Header */ 47439e84790SAlex Aizman struct iscsi_login_rsp { 47539e84790SAlex Aizman uint8_t opcode; 47639e84790SAlex Aizman uint8_t flags; 47739e84790SAlex Aizman uint8_t max_version; /* Max. version supported */ 47839e84790SAlex Aizman uint8_t active_version; /* Active version */ 47939e84790SAlex Aizman uint8_t hlength; 48039e84790SAlex Aizman uint8_t dlength[3]; 48139e84790SAlex Aizman uint8_t isid[6]; /* Initiator Session ID */ 48239e84790SAlex Aizman __be16 tsih; /* Target Session Handle */ 483b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 48439e84790SAlex Aizman __be32 rsvd3; 48539e84790SAlex Aizman __be32 statsn; 48639e84790SAlex Aizman __be32 exp_cmdsn; 48739e84790SAlex Aizman __be32 max_cmdsn; 48839e84790SAlex Aizman uint8_t status_class; /* see Login RSP ststus classes below */ 48939e84790SAlex Aizman uint8_t status_detail; /* see Login RSP Status details below */ 49039e84790SAlex Aizman uint8_t rsvd4[10]; 49139e84790SAlex Aizman }; 49239e84790SAlex Aizman 49339e84790SAlex Aizman /* Login stage (phase) codes for CSG, NSG */ 49439e84790SAlex Aizman #define ISCSI_INITIAL_LOGIN_STAGE -1 49539e84790SAlex Aizman #define ISCSI_SECURITY_NEGOTIATION_STAGE 0 49639e84790SAlex Aizman #define ISCSI_OP_PARMS_NEGOTIATION_STAGE 1 49739e84790SAlex Aizman #define ISCSI_FULL_FEATURE_PHASE 3 49839e84790SAlex Aizman 49939e84790SAlex Aizman /* Login Status response classes */ 50039e84790SAlex Aizman #define ISCSI_STATUS_CLS_SUCCESS 0x00 50139e84790SAlex Aizman #define ISCSI_STATUS_CLS_REDIRECT 0x01 50239e84790SAlex Aizman #define ISCSI_STATUS_CLS_INITIATOR_ERR 0x02 50339e84790SAlex Aizman #define ISCSI_STATUS_CLS_TARGET_ERR 0x03 50439e84790SAlex Aizman 50539e84790SAlex Aizman /* Login Status response detail codes */ 50639e84790SAlex Aizman /* Class-0 (Success) */ 50739e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_ACCEPT 0x00 50839e84790SAlex Aizman 50939e84790SAlex Aizman /* Class-1 (Redirection) */ 51039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_MOVED_TEMP 0x01 51139e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_MOVED_PERM 0x02 51239e84790SAlex Aizman 51339e84790SAlex Aizman /* Class-2 (Initiator Error) */ 51439e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_INIT_ERR 0x00 51539e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_AUTH_FAILED 0x01 51639e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_FORBIDDEN 0x02 51739e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_NOT_FOUND 0x03 51839e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TGT_REMOVED 0x04 51939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_VERSION 0x05 52039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_ISID_ERROR 0x06 52139e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_MISSING_FIELDS 0x07 52239e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_CONN_ADD_FAILED 0x08 52339e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_SESSION_TYPE 0x09 52439e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_SESSION 0x0a 52539e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_INVALID_REQUEST 0x0b 52639e84790SAlex Aizman 52739e84790SAlex Aizman /* Class-3 (Target Error) */ 52839e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_TARGET_ERROR 0x00 52939e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_SVC_UNAVAILABLE 0x01 53039e84790SAlex Aizman #define ISCSI_LOGIN_STATUS_NO_RESOURCES 0x02 53139e84790SAlex Aizman 53239e84790SAlex Aizman /* Logout Header */ 53339e84790SAlex Aizman struct iscsi_logout { 53439e84790SAlex Aizman uint8_t opcode; 53539e84790SAlex Aizman uint8_t flags; 53639e84790SAlex Aizman uint8_t rsvd1[2]; 53739e84790SAlex Aizman uint8_t hlength; 53839e84790SAlex Aizman uint8_t dlength[3]; 53939e84790SAlex Aizman uint8_t rsvd2[8]; 540b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 54139e84790SAlex Aizman __be16 cid; 54239e84790SAlex Aizman uint8_t rsvd3[2]; 54339e84790SAlex Aizman __be32 cmdsn; 54439e84790SAlex Aizman __be32 exp_statsn; 54539e84790SAlex Aizman uint8_t rsvd4[16]; 54639e84790SAlex Aizman }; 54739e84790SAlex Aizman 54839e84790SAlex Aizman /* Logout PDU flags */ 54939e84790SAlex Aizman #define ISCSI_FLAG_LOGOUT_REASON_MASK 0x7F 55039e84790SAlex Aizman 55139e84790SAlex Aizman /* logout reason_code values */ 55239e84790SAlex Aizman 55339e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_CLOSE_SESSION 0 55439e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION 1 55539e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_RECOVERY 2 55639e84790SAlex Aizman #define ISCSI_LOGOUT_REASON_AEN_REQUEST 3 55739e84790SAlex Aizman 55839e84790SAlex Aizman /* Logout Response Header */ 55939e84790SAlex Aizman struct iscsi_logout_rsp { 56039e84790SAlex Aizman uint8_t opcode; 56139e84790SAlex Aizman uint8_t flags; 56239e84790SAlex Aizman uint8_t response; /* see Logout response values below */ 56339e84790SAlex Aizman uint8_t rsvd2; 56439e84790SAlex Aizman uint8_t hlength; 56539e84790SAlex Aizman uint8_t dlength[3]; 56639e84790SAlex Aizman uint8_t rsvd3[8]; 567b4377356SAl Viro itt_t itt; /* Initiator Task Tag */ 56839e84790SAlex Aizman __be32 rsvd4; 56939e84790SAlex Aizman __be32 statsn; 57039e84790SAlex Aizman __be32 exp_cmdsn; 57139e84790SAlex Aizman __be32 max_cmdsn; 57239e84790SAlex Aizman __be32 rsvd5; 57339e84790SAlex Aizman __be16 t2wait; 57439e84790SAlex Aizman __be16 t2retain; 57539e84790SAlex Aizman __be32 rsvd6; 57639e84790SAlex Aizman }; 57739e84790SAlex Aizman 57839e84790SAlex Aizman /* logout response status values */ 57939e84790SAlex Aizman 58039e84790SAlex Aizman #define ISCSI_LOGOUT_SUCCESS 0 58139e84790SAlex Aizman #define ISCSI_LOGOUT_CID_NOT_FOUND 1 58239e84790SAlex Aizman #define ISCSI_LOGOUT_RECOVERY_UNSUPPORTED 2 58339e84790SAlex Aizman #define ISCSI_LOGOUT_CLEANUP_FAILED 3 58439e84790SAlex Aizman 58539e84790SAlex Aizman /* SNACK Header */ 58639e84790SAlex Aizman struct iscsi_snack { 58739e84790SAlex Aizman uint8_t opcode; 58839e84790SAlex Aizman uint8_t flags; 58912352183SNicholas Bellinger uint8_t rsvd2[2]; 59012352183SNicholas Bellinger uint8_t hlength; 59112352183SNicholas Bellinger uint8_t dlength[3]; 59212352183SNicholas Bellinger uint8_t lun[8]; 593b4377356SAl Viro itt_t itt; 59412352183SNicholas Bellinger __be32 ttt; 59512352183SNicholas Bellinger uint8_t rsvd3[4]; 59612352183SNicholas Bellinger __be32 exp_statsn; 59712352183SNicholas Bellinger uint8_t rsvd4[8]; 59839e84790SAlex Aizman __be32 begrun; 59939e84790SAlex Aizman __be32 runlength; 60039e84790SAlex Aizman }; 60139e84790SAlex Aizman 60239e84790SAlex Aizman /* SNACK PDU flags */ 60312352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_DATA 0 60412352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_R2T 0 60512352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_STATUS 1 60612352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_DATA_ACK 2 60712352183SNicholas Bellinger #define ISCSI_FLAG_SNACK_TYPE_RDATA 3 60839e84790SAlex Aizman #define ISCSI_FLAG_SNACK_TYPE_MASK 0x0F /* 4 bits */ 60939e84790SAlex Aizman 61039e84790SAlex Aizman /* Reject Message Header */ 61139e84790SAlex Aizman struct iscsi_reject { 61239e84790SAlex Aizman uint8_t opcode; 61339e84790SAlex Aizman uint8_t flags; 61439e84790SAlex Aizman uint8_t reason; 61539e84790SAlex Aizman uint8_t rsvd2; 616fa0a6957SMike Christie uint8_t hlength; 61739e84790SAlex Aizman uint8_t dlength[3]; 618fa0a6957SMike Christie uint8_t rsvd3[8]; 619fa0a6957SMike Christie __be32 ffffffff; 620fa0a6957SMike Christie uint8_t rsvd4[4]; 62139e84790SAlex Aizman __be32 statsn; 62239e84790SAlex Aizman __be32 exp_cmdsn; 62339e84790SAlex Aizman __be32 max_cmdsn; 62439e84790SAlex Aizman __be32 datasn; 62539e84790SAlex Aizman uint8_t rsvd5[8]; 62639e84790SAlex Aizman /* Text - Rejected hdr */ 62739e84790SAlex Aizman }; 62839e84790SAlex Aizman 62939e84790SAlex Aizman /* Reason for Reject */ 630fa0a6957SMike Christie #define ISCSI_REASON_CMD_BEFORE_LOGIN 1 631fa0a6957SMike Christie #define ISCSI_REASON_DATA_DIGEST_ERROR 2 632fa0a6957SMike Christie #define ISCSI_REASON_DATA_SNACK_REJECT 3 633fa0a6957SMike Christie #define ISCSI_REASON_PROTOCOL_ERROR 4 634fa0a6957SMike Christie #define ISCSI_REASON_CMD_NOT_SUPPORTED 5 635fa0a6957SMike Christie #define ISCSI_REASON_IMM_CMD_REJECT 6 636fa0a6957SMike Christie #define ISCSI_REASON_TASK_IN_PROGRESS 7 637fa0a6957SMike Christie #define ISCSI_REASON_INVALID_SNACK 8 638fa0a6957SMike Christie #define ISCSI_REASON_BOOKMARK_INVALID 9 639fa0a6957SMike Christie #define ISCSI_REASON_BOOKMARK_NO_RESOURCES 10 640fa0a6957SMike Christie #define ISCSI_REASON_NEGOTIATION_RESET 11 64139e84790SAlex Aizman 64239e84790SAlex Aizman /* Max. number of Key=Value pairs in a text message */ 64339e84790SAlex Aizman #define MAX_KEY_VALUE_PAIRS 8192 64439e84790SAlex Aizman 64539e84790SAlex Aizman /* maximum length for text keys/values */ 64639e84790SAlex Aizman #define KEY_MAXLEN 64 64739e84790SAlex Aizman #define VALUE_MAXLEN 255 64839e84790SAlex Aizman #define TARGET_NAME_MAXLEN VALUE_MAXLEN 64939e84790SAlex Aizman 650bf32ed33SMike Christie #define ISCSI_DEF_MAX_RECV_SEG_LEN 8192 651bf32ed33SMike Christie #define ISCSI_MIN_MAX_RECV_SEG_LEN 512 652bf32ed33SMike Christie #define ISCSI_MAX_MAX_RECV_SEG_LEN 16777215 653bf32ed33SMike Christie 654bf32ed33SMike Christie #define ISCSI_DEF_FIRST_BURST_LEN 65536 655bf32ed33SMike Christie #define ISCSI_MIN_FIRST_BURST_LEN 512 656bf32ed33SMike Christie #define ISCSI_MAX_FIRST_BURST_LEN 16777215 657bf32ed33SMike Christie 658bf32ed33SMike Christie #define ISCSI_DEF_MAX_BURST_LEN 262144 659bf32ed33SMike Christie #define ISCSI_MIN_MAX_BURST_LEN 512 660bf32ed33SMike Christie #define ISCSI_MAX_MAX_BURST_LEN 16777215 66139e84790SAlex Aizman 662843c0a8aSMike Christie #define ISCSI_DEF_TIME2WAIT 2 663843c0a8aSMike Christie 6642177199dSJohn Soni Jose #define ISCSI_NAME_LEN 224 6652177199dSJohn Soni Jose 66639e84790SAlex Aizman /************************* RFC 3720 End *****************************/ 66739e84790SAlex Aizman 66839e84790SAlex Aizman #endif /* ISCSI_PROTO_H */ 669