MdeModulePkg/Universal/Network/IScsiDxe/IScsiProto.h

   1 /** @file
   2   The header file of iSCSI Protocol that defines many specific data structures.
   3
   4 Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
   5 This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _ISCSI_PROTO_H_
  16 #define _ISCSI_PROTO_H_
  17
  18 #include <Protocol/ScsiPassThruExt.h>
  19
  20 //
  21 // RFC 1982 Serial Number Arithmetic, SERIAL_BITS = 32
  22 //
  23 #define ISCSI_SEQ_EQ(s1, s2)  ((s1) == (s2))
  24 #define ISCSI_SEQ_LT(s1, s2) \
  25     ( \
  26       (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) < ((UINT32) 1 << 31)) || \
  27       (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) > ((UINT32) 1 << 31)) \
  28     )
  29 #define ISCSI_SEQ_GT(s1, s2) \
  30     ( \
  31       (((INT32) (s1) < (INT32) (s2)) && (s2 - s1) > ((UINT32) 1 << 31)) || \
  32       (((INT32) (s1) > (INT32) (s2)) && (s1 - s2) < ((UINT32) 1 << 31)) \
  33     )
  34
  35 #define ISCSI_WELL_KNOWN_PORT                   3260
  36 #define ISCSI_MAX_CONNS_PER_SESSION             1
  37
  38 #define DEFAULT_MAX_RECV_DATA_SEG_LEN           8192
  39 #define MAX_RECV_DATA_SEG_LEN_IN_FFP            65536
  40 #define DEFAULT_MAX_OUTSTANDING_R2T             1
  41
  42 #define ISCSI_VERSION_MAX                       0x00
  43 #define ISCSI_VERSION_MIN                       0x00
  44
  45 #define ISCSI_CHECK_MEDIA_LOGIN_WAITING_TIME          EFI_TIMER_PERIOD_SECONDS(20)
  46 #define ISCSI_CHECK_MEDIA_GET_DHCP_WAITING_TIME       EFI_TIMER_PERIOD_SECONDS(20)
  47
  48 #define ISCSI_KEY_AUTH_METHOD                   "AuthMethod"
  49 #define ISCSI_KEY_HEADER_DIGEST                 "HeaderDigest"
  50 #define ISCSI_KEY_DATA_DIGEST                   "DataDigest"
  51 #define ISCSI_KEY_MAX_CONNECTIONS               "MaxConnections"
  52 #define ISCSI_KEY_TARGET_NAME                   "TargetName"
  53 #define ISCSI_KEY_INITIATOR_NAME                "InitiatorName"
  54 #define ISCSI_KEY_TARGET_ALIAS                  "TargetAlias"
  55 #define ISCSI_KEY_INITIATOR_ALIAS               "InitiatorAlias"
  56 #define ISCSI_KEY_TARGET_ADDRESS                "TargetAddress"
  57 #define ISCSI_KEY_INITIAL_R2T                   "InitialR2T"
  58 #define ISCSI_KEY_IMMEDIATE_DATA                "ImmediateData"
  59 #define ISCSI_KEY_TARGET_PORTAL_GROUP_TAG       "TargetPortalGroupTag"
  60 #define ISCSI_KEY_MAX_BURST_LENGTH              "MaxBurstLength"
  61 #define ISCSI_KEY_FIRST_BURST_LENGTH            "FirstBurstLength"
  62 #define ISCSI_KEY_DEFAULT_TIME2WAIT             "DefaultTime2Wait"
  63 #define ISCSI_KEY_DEFAULT_TIME2RETAIN           "DefaultTime2Retain"
  64 #define ISCSI_KEY_MAX_OUTSTANDING_R2T           "MaxOutstandingR2T"
  65 #define ISCSI_KEY_DATA_PDU_IN_ORDER             "DataPDUInOrder"
  66 #define ISCSI_KEY_DATA_SEQUENCE_IN_ORDER        "DataSequenceInOrder"
  67 #define ISCSI_KEY_ERROR_RECOVERY_LEVEL          "ErrorRecoveryLevel"
  68 #define ISCSI_KEY_SESSION_TYPE                  "SessionType"
  69 #define ISCSI_KEY_MAX_RECV_DATA_SEGMENT_LENGTH  "MaxRecvDataSegmentLength"
  70
  71 #define ISCSI_KEY_VALUE_NONE                    "None"
  72
  73 ///
  74 /// connection state for initiator
  75 ///
  76
  77 #define CONN_STATE_FREE                         0
  78 #define CONN_STATE_XPT_WAIT                     1
  79 #define CONN_STATE_IN_LOGIN                     2
  80 #define CONN_STATE_LOGGED_IN                    3
  81 #define CONN_STATE_IN_LOGOUT                    4
  82 #define CONN_STATE_LOGOUT_REQUESTED             5
  83 #define CONN_STATE_CLEANUP_WAIT                 6
  84 #define CONN_STATE_IN_CLEANUP                   7
  85
  86 ///
  87 /// session state for initiator
  88 ///
  89 #define SESSION_STATE_FREE                      0
  90 #define SESSION_STATE_LOGGED_IN                 1
  91 #define SESSION_STATE_FAILED                    2
  92
  93 typedef enum {
  94   DataIn  = 0,
  95   DataOut = 1,
  96   DataBi  = 2
  97 } DATA_DIRECTION;
  98
  99 #define ISCSI_RESERVED_TAG                  0xffffffff
 100
 101 #define ISCSI_REQ_IMMEDIATE                 0x40
 102 #define ISCSI_OPCODE_MASK                   0x3F
 103
 104 #define ISCSI_SET_OPCODE(PduHdr, Op, Flgs)  ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) = ((Op) | (Flgs)))
 105 #define ISCSI_GET_OPCODE(PduHdr)            ((((ISCSI_BASIC_HEADER *) (PduHdr))->OpCode) & ISCSI_OPCODE_MASK)
 106 #define ISCSI_CHECK_OPCODE(PduHdr, Op)      ((((PduHdr)->OpCode) & ISCSI_OPCODE_MASK) == (Op))
 107 #define ISCSI_IMMEDIATE_ON(PduHdr)          ((PduHdr)->OpCode & ISCSI_REQ_IMMEDIATE)
 108 #define ISCSI_SET_FLAG(PduHdr, Flag)        (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags |= (BOOLEAN)(Flag))
 109 #define ISCSI_CLEAR_FLAG(PduHdr, Flag)      (((ISCSI_BASIC_HEADER *) (PduHdr))->Flags &= ~(Flag))
 110 #define ISCSI_FLAG_ON(PduHdr, Flag)         ((((ISCSI_BASIC_HEADER *) (PduHdr))->Flags & (Flag)) == (Flag))
 111 #define ISCSI_SET_STAGES(PduHdr, Cur, Nxt)  ((PduHdr)->Flags = (UINT8) ((PduHdr)->Flags | ((Cur) << 2 | (Nxt))))
 112 #define ISCSI_GET_CURRENT_STAGE(PduHdr)     (((PduHdr)->Flags >> 2) & 0x3)
 113 #define ISCSI_GET_NEXT_STAGE(PduHdr)        (((PduHdr)->Flags) & 0x3)
 114
 115 #define ISCSI_GET_PAD_LEN(DataLen)          ((~(DataLen) + 1) & 0x3)
 116 #define ISCSI_ROUNDUP(DataLen)              (((DataLen) + 3) &~(0x3))
 117
 118 #define HTON24(Dst, Src) \
 119   do { \
 120     (Dst)[0]  = (UINT8) (((Src) >> 16) & 0xFF); \
 121     (Dst)[1]  = (UINT8) (((Src) >> 8) & 0xFF); \
 122     (Dst)[2]  = (UINT8) ((Src) & 0xFF); \
 123   } while (0);
 124
 125 #define NTOH24(src)                         (((src)[0] << 16) | ((src)[1] << 8) | ((src)[2]))
 126
 127 #define ISCSI_GET_DATASEG_LEN(PduHdr)       NTOH24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength)
 128 #define ISCSI_SET_DATASEG_LEN(PduHdr, Len)  HTON24 (((ISCSI_BASIC_HEADER *) (PduHdr))->DataSegmentLength, (Len))
 129
 130 //
 131 // initiator opcodes
 132 //
 133 #define ISCSI_OPCODE_NOP_OUT        0x00
 134 #define ISCSI_OPCODE_SCSI_CMD       0x01
 135 #define ISCSI_OPCODE_SCSI_TMF_REQ   0x02
 136 #define ISCSI_OPCODE_LOGIN_REQ      0x03
 137 #define ISCSI_OPCODE_TEXT_REQ       0x04
 138 #define ISCSI_OPCODE_SCSI_DATA_OUT  0x05
 139 #define ISCSI_OPCODE_LOGOUT_REQ     0x06
 140 #define ISCSI_OPCODE_SNACK_REQ      0x10
 141 #define ISCSI_OPCODE_VENDOR_I0      0x1c
 142 #define ISCSI_OPCODE_VENDOR_I1      0x1d
 143 #define ISCSI_OPCODE_VENDOR_I2      0x1e
 144
 145 //
 146 // target opcodes
 147 //
 148 #define ISCSI_OPCODE_NOP_IN       0x20
 149 #define ISCSI_OPCODE_SCSI_RSP     0x21
 150 #define ISCSI_OPCODE_SCSI_TMF_RSP 0x22
 151 #define ISCSI_OPCODE_LOGIN_RSP    0x23
 152 #define ISCSI_OPCODE_TEXT_RSP     0x24
 153 #define ISCSI_OPCODE_SCSI_DATA_IN 0x25
 154 #define ISCSI_OPCODE_LOGOUT_RSP   0x26
 155 #define ISCSI_OPCODE_R2T          0x31
 156 #define ISCSI_OPCODE_ASYNC_MSG    0x32
 157 #define ISCSI_OPCODE_VENDOR_T0    0x3c
 158 #define ISCSI_OPCODE_VENDOR_T1    0x3d
 159 #define ISCSI_OPCODE_VENDOR_T2    0x3e
 160 #define ISCSI_OPCODE_REJECT       0x3f
 161
 162 #define ISCSI_BHS_FLAG_FINAL      0x80
 163
 164 ///
 165 /// iSCSI Basic Header Segment
 166 ///
 167 typedef struct _ISCSI_BASIC_HEADER {
 168   UINT8   OpCode;
 169   UINT8   Flags;
 170   UINT16  OpCodeSpecific1;
 171   UINT8   TotalAHSLength;
 172   UINT8   DataSegmentLength[3];
 173   UINT8   Lun[8];
 174   UINT32  InitiatorTaskTag;
 175   UINT32  OpCodeSpecific2[7];
 176 } ISCSI_BASIC_HEADER;
 177
 178 //
 179 // Defined AHS types, others are reserved.
 180 //
 181 #define ISCSI_AHS_TYPE_EXT_CDB              0x1
 182 #define ISCSI_AHS_TYPE_BI_EXP_READ_DATA_LEN 0x2
 183
 184 typedef struct _ISCSI_ADDTIONAL_HEADER {
 185   UINT16  Length;
 186   UINT8   Type;
 187   UINT8   TypeSpecific[1];
 188 } ISCSI_ADDITIONAL_HEADER;
 189
 190 typedef struct _ISCSI_BI_EXP_READ_DATA_LEN_AHS {
 191   UINT16  Length;
 192   UINT8   Type;
 193   UINT8   Reserved;
 194   UINT32  ExpReadDataLength;
 195 } ISCSI_BI_EXP_READ_DATA_LEN_AHS;
 196
 197 #define SCSI_CMD_PDU_FLAG_READ        0x40
 198 #define SCSI_CMD_PDU_FLAG_WRITE       0x20
 199
 200 #define ISCSI_CMD_PDU_TASK_ATTR_MASK  0x07
 201
 202 //
 203 // task attributes
 204 //
 205 #define ISCSI_TASK_ATTR_UNTAGGED  0x00
 206 #define ISCSI_TASK_ATTR_SIMPLE    0x01
 207 #define ISCSI_TASK_ATTR_ORDERD    0x02
 208 #define ISCSI_TASK_ATTR_HOQ       0x03
 209 #define ISCSI_TASK_ATTR_ACA       0x04
 210
 211 ///
 212 /// SCSI Command
 213 ///
 214 typedef struct _SCSI_COMMAND {
 215   UINT8   OpCode;
 216   UINT8   Flags;
 217   UINT16  Reserved;
 218   UINT8   TotalAHSLength;
 219   UINT8   DataSegmentLength[3];
 220   UINT8   Lun[8];
 221   UINT32  InitiatorTaskTag;
 222   UINT32  ExpDataXferLength;
 223   UINT32  CmdSN;
 224   UINT32  ExpStatSN;
 225   UINT8   Cdb[16];
 226 } SCSI_COMMAND;
 227
 228 //
 229 // flag bit definitions in SCSI response
 230 //
 231 #define SCSI_RSP_PDU_FLAG_BI_READ_OVERFLOW  0x10
 232 #define SCSI_RSP_PDU_FLAG_BI_READ_UNDERFLOW 0x08
 233 #define SCSI_RSP_PDU_FLAG_OVERFLOW          0x04
 234 #define SCSI_RSP_PDU_FLAG_UNDERFLOW         0x02
 235
 236 //
 237 // iSCSI service response codes
 238 //
 239 #define ISCSI_SERVICE_RSP_COMMAND_COMPLETE_AT_TARGET  0x00
 240 #define ISCSI_SERVICE_RSP_TARGET_FAILURE              0x01
 241
 242 ///
 243 /// SCSI Response
 244 ///
 245 typedef struct _SCSI_RESPONSE {
 246   UINT8   OpCode;
 247   UINT8   Flags;
 248   UINT8   Response;
 249   UINT8   Status;
 250   UINT8   TotalAHSLength;
 251   UINT8   DataSegmentLength[3];
 252   UINT8   Reserved[8];
 253   UINT32  InitiatorTaskTag;
 254   UINT32  SNACKTag;
 255   UINT32  StatSN;
 256   UINT32  ExpCmdSN;
 257   UINT32  MaxCmdSN;
 258   UINT32  ExpDataSN;
 259   UINT32  BiReadResidualCount;
 260   UINT32  ResidualCount;
 261 } SCSI_RESPONSE;
 262
 263 typedef struct _ISCSI_SENSE_DATA {
 264   UINT16  Length;
 265   UINT8   Data[2];
 266 } ISCSI_SENSE_DATA;
 267
 268 ///
 269 /// iSCSI Task Managment Function Request
 270 ///
 271 typedef struct _ISCSI_TMF_REQUEST {
 272   UINT8   OpCode;
 273   UINT8   Fuction;
 274   UINT16  Reserved1;
 275   UINT8   TotalAHSLength;
 276   UINT8   DataSegmentLength[3];
 277   UINT8   Lun[8];
 278   UINT32  InitiatorTaskTag;
 279   UINT32  ReferencedTaskTag;
 280   UINT32  CmdSN;
 281   UINT32  ExpStatSN;
 282   UINT32  RefCmdSN;
 283   UINT32  ExpDataSN;
 284   UINT32  Reserved2[2];
 285 } ISCSI_TMF_REQUEST;
 286
 287 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_COMPLETE           0
 288 #define ISCSI_TMF_RSP_PDU_RSP_TASK_NOT_EXIST              1
 289 #define ISCSI_TMF_RSP_PDU_RSP_LUN_NOT_EXIST               2
 290 #define ISCSI_TMF_RSP_PDU_RSP_TASK_STILL_ALLEGIANT        3
 291 #define ISCSI_TMF_RSP_PDU_RSP_TASK_REASSGIN_NOT_SUPPORTED 4
 292 #define ISCSI_TMF_RSP_PDU_RSP_NOT_SUPPORTED               5
 293 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_AHTH_FAILED        6
 294 #define ISCSI_TMF_RSP_PDU_RSP_FUNCTION_REJECTED           255
 295
 296 ///
 297 /// iSCSI Task Management Function Response
 298 ///
 299 typedef struct _ISCSI_TMF_RESPONSE {
 300   UINT8   OpCode;
 301   UINT8   Reserved1;
 302   UINT8   Response;
 303   UINT8   Reserved2;
 304   UINT8   TotalAHSLength;
 305   UINT8   DataSegmentLength[3];
 306   UINT32  Reserver3[2];
 307   UINT32  InitiatorTaskTag;
 308   UINT32  Reserved4;
 309   UINT32  StatSN;
 310   UINT32  ExpCmdSN;
 311   UINT32  MaxCmdSN;
 312   UINT32  Reserved[3];
 313 } ISCSI_TMF_RESPONSE;
 314
 315 ///
 316 /// SCSI Data-Out
 317 ///
 318 typedef struct _ISCSI_SCSI_DATA_OUT {
 319   UINT8   OpCode;
 320   UINT8   Reserved1[3];
 321   UINT8   TotalAHSLength;
 322   UINT8   DataSegmentLength[3];
 323   UINT8   Lun[8];
 324   UINT32  InitiatorTaskTag;
 325   UINT32  TargetTransferTag;
 326   UINT32  Reserved2;
 327   UINT32  ExpStatSN;
 328   UINT32  Reserved3;
 329   UINT32  DataSN;
 330   UINT32  BufferOffset;
 331   UINT32  Reserved4;
 332 } ISCSI_SCSI_DATA_OUT;
 333
 334 #define SCSI_DATA_IN_PDU_FLAG_ACKKNOWLEDGE  0x40
 335 #define SCSI_DATA_IN_PDU_FLAG_OVERFLOW      SCSI_RSP_PDU_FLAG_OVERFLOW
 336 #define SCSI_DATA_IN_PDU_FLAG_UNDERFLOW     SCSI_RSP_PDU_FLAG_UNDERFLOW
 337 #define SCSI_DATA_IN_PDU_FLAG_STATUS_VALID  0x01
 338
 339 ///
 340 /// SCSI Data-In
 341 ///
 342 typedef struct _ISCSI_SCSI_DATA_IN {
 343   UINT8   OpCode;
 344   UINT8   Flags;
 345   UINT8   Reserved1;
 346   UINT8   Status;
 347   UINT8   TotalAHSLength;
 348   UINT8   DataSegmentLength[3];
 349   UINT8   Lun[8];
 350   UINT32  InitiatorTaskTag;
 351   UINT32  TargetTransferTag;
 352   UINT32  StatSN;
 353   UINT32  ExpCmdSN;
 354   UINT32  MaxCmdSN;
 355   UINT32  DataSN;
 356   UINT32  BufferOffset;
 357   UINT32  ResidualCount;
 358 } ISCSI_SCSI_DATA_IN;
 359
 360 #define ISCSI_GET_BUFFER_OFFSET(PduHdr) NTOHL (((ISCSI_SCSI_DATA_IN *) (PduHdr))->BufferOffset)
 361
 362 ///
 363 /// Ready To Transfer
 364 ///
 365 typedef struct _ISCSI_READY_TO_TRANSFER {
 366   UINT8   OpCode;
 367   UINT8   Reserved1[3];
 368   UINT8   TotalAHSLength;
 369   UINT8   DataSegmentLength[3];
 370   UINT8   Lun[8];
 371   UINT32  InitiatorTaskTag;
 372   UINT32  TargetTransferTag;
 373   UINT32  StatSN;
 374   UINT32  ExpCmdSN;
 375   UINT32  MaxCmdSN;
 376   UINT32  R2TSeqNum;
 377   UINT32  BufferOffset;
 378   UINT32  DesiredDataTransferLength;
 379 } ISCSI_READY_TO_TRANSFER;
 380
 381 typedef struct _ISCSI_ASYNC_MESSAGE {
 382   UINT8   OpCode;
 383   UINT8   Reserved1[8];
 384   UINT8   TotalAHSLength;
 385   UINT8   DataSegmentLength[3];
 386   UINT8   Lun[8];
 387   UINT32  InitiatorTaskTag;
 388   UINT32  Reserved2;
 389   UINT32  StatSN;
 390   UINT32  ExpCmdSN;
 391   UINT32  MaxCmdSN;
 392   UINT8   AsyncEvent;
 393   UINT8   AsyncVCode;
 394   UINT16  Parameter1;
 395   UINT16  Parameter2;
 396   UINT16  Parameter3;
 397   UINT32  Reserved3;
 398 } ISCSI_ASYNC_MESSAGE;
 399
 400 #define ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT  0x80
 401 #define ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE 0x40
 402
 403 ///
 404 /// Login Request
 405 ///
 406 typedef struct _ISCSI_LOGIN_REQUEST {
 407   UINT8   OpCode;
 408   UINT8   Flags;
 409   UINT8   VersionMax;
 410   UINT8   VersionMin;
 411   UINT8   TotalAHSLength;
 412   UINT8   DataSegmentLength[3];
 413   UINT8   Isid[6];
 414   UINT16  Tsih;
 415   UINT32  InitiatorTaskTag;
 416   UINT16  Cid;
 417   UINT16  Reserved1;
 418   UINT32  CmdSN;
 419   UINT32  ExpStatSN;
 420   UINT32  Reserved2[4];
 421 } ISCSI_LOGIN_REQUEST;
 422
 423 #define ISCSI_LOGIN_RSP_PDU_FLAG_TRANSIT    ISCSI_LOGIN_REQ_PDU_FLAG_TRANSIT
 424 #define ISCSI_LOGIN_RSP_PDU_FLAG_CONTINUE   ISCSI_LOGIN_REQ_PDU_FLAG_CONTINUE
 425
 426 #define ISCSI_LOGIN_STATUS_SUCCESS          0
 427 #define ISCSI_LOGIN_STATUS_REDIRECTION      1
 428 #define ISCSI_LOGIN_STATUS_INITIATOR_ERROR  2
 429 #define ISCSI_LOGIN_STATUS_TARGET_ERROR     3
 430
 431 ///
 432 /// Login Response
 433 ///
 434 typedef struct _ISCSI_LOGIN_RESPONSE {
 435   UINT8   OpCode;
 436   UINT8   Flags;
 437   UINT8   VersionMax;
 438   UINT8   VersionActive;
 439   UINT8   TotalAHSLength;
 440   UINT8   DataSegmentLength[3];
 441   UINT8   Isid[6];
 442   UINT16  Tsih;
 443   UINT32  InitiatorTaskTag;
 444   UINT32  Reserved1;
 445   UINT32  StatSN;
 446   UINT32  ExpCmdSN;
 447   UINT32  MaxCmdSN;
 448   UINT8   StatusClass;
 449   UINT8   StatusDetail;
 450   UINT8   Reserved2[10];
 451 } ISCSI_LOGIN_RESPONSE;
 452
 453 #define ISCSI_LOGOUT_REASON_CLOSE_SESSION                   0
 454 #define ISCSI_LOGOUT_REASON_CLOSE_CONNECTION                1
 455 #define ISCSI_LOGOUT_REASON_REMOVE_CONNECTION_FOR_RECOVERY  2
 456
 457 ///
 458 /// Logout Request
 459 ///
 460 typedef struct _ISCSI_LOGOUT_REQUEST {
 461   UINT8   OpCode;
 462   UINT8   ReasonCode;
 463   UINT16  Reserved1;
 464   UINT8   TotalAHSLength;
 465   UINT8   DataSegmentLength[3];
 466   UINT32  Reserved2[2];
 467   UINT32  InitiatorTaskTag;
 468   UINT16  Cid;
 469   UINT16  Reserved3;
 470   UINT32  CmdSN;
 471   UINT32  ExpStatSN;
 472   UINT32  Reserved4[4];
 473 } ISCSI_LOGOUT_REQUEST;
 474
 475 #define ISCSI_LOGOUT_RESPONSE_SESSION_CLOSED_SUCCESS  0
 476 #define ISCSI_LOGOUT_RESPONSE_CID_NOT_FOUND           1
 477 #define ISCSI_LOGOUT_RESPONSE_RECOVERY_NOT_SUPPORTED  2
 478 #define ISCSI_LOGOUT_RESPONSE_CLEANUP_FAILED          3
 479
 480 ///
 481 /// Logout Response
 482 ///
 483 typedef struct _ISCSI_LOGOUT_RESPONSE {
 484   UINT8   OpCode;
 485   UINT8   Reserved1;
 486   UINT8   Response;
 487   UINT8   Reserved2;
 488   UINT8   TotalAHSLength;
 489   UINT8   DataSegmentLength[3];
 490   UINT32  Reserved3[2];
 491   UINT32  InitiatorTaskTag;
 492   UINT32  Reserved4;
 493   UINT32  StatSN;
 494   UINT32  ExpCmdSN;
 495   UINT32  MaxCmdSN;
 496   UINT32  Reserved5;
 497   UINT16  Time2Wait;
 498   UINT16  Time2Retain;
 499   UINT32  Reserved6;
 500 } ISCSI_LOGOUT_RESPONSE;
 501
 502 #define ISCSI_SNACK_REQUEST_TYPE_DATA_OR_R2T  0
 503 #define ISCSI_SNACK_REQUEST_TYPE_STATUS       1
 504 #define ISCSI_SNACK_REQUEST_TYPE_DATA_ACK     2
 505 #define ISCSI_SNACK_REQUEST_TYPE_RDATA        3
 506
 507 ///
 508 /// SNACK Request
 509 ///
 510 typedef struct _ISCSI_SNACK_REQUEST {
 511   UINT8   OpCode;
 512   UINT8   Type;
 513   UINT16  Reserved1;
 514   UINT8   TotalAHSLength;
 515   UINT8   DataSegmentLength[3];
 516   UINT8   Lun[8];
 517   UINT32  InitiatorTaskTag;
 518   UINT32  TargetTransferTag;
 519   UINT32  Reserved2;
 520   UINT32  ExpStatSN;
 521   UINT32  Reserved[2];
 522   UINT32  BegRun;
 523   UINT32  RunLength;
 524 } ISCSI_SNACK_REQUEST;
 525
 526 ///
 527 /// Reject
 528 ///
 529 typedef struct _ISCSI_REJECT {
 530   UINT8   OpCode;
 531   UINT8   Reserved1;
 532   UINT8   Reason;
 533   UINT8   Reserved2;
 534   UINT8   TotalAHSLength;
 535   UINT8   DataSegmentLength[3];
 536   UINT32  Reserved3[2];
 537   UINT32  InitiatorTaskTag;
 538   UINT32  Reserved4;
 539   UINT32  StatSN;
 540   UINT32  ExpCmdSN;
 541   UINT32  MaxCmdSN;
 542   UINT32  DataSN;
 543   UINT32  Reserved5[2];
 544 } ISCSI_REJECT;
 545
 546 ///
 547 /// NOP-Out
 548 ///
 549 typedef struct _ISCSI_NOP_OUT {
 550   UINT8   OpCode;
 551   UINT8   Reserved1[3];
 552   UINT8   TotalAHSLength;
 553   UINT8   DataSegmentLength[3];
 554   UINT8   Lun[8];
 555   UINT32  InitiatorTaskTag;
 556   UINT32  TargetTransferTag;
 557   UINT32  CmdSN;
 558   UINT32  ExpStatSN;
 559   UINT32  Reserved2[4];
 560 } ISCSI_NOP_OUT;
 561
 562 ///
 563 /// NOP-In
 564 ///
 565 typedef struct _ISCSI_NOP_IN {
 566   UINT8   OpCode;
 567   UINT8   Reserved1[3];
 568   UINT8   TotalAHSLength;
 569   UINT8   DataSegmentLength[3];
 570   UINT8   Lun[8];
 571   UINT32  InitiatorTaskTag;
 572   UINT32  TargetTransferTag;
 573   UINT32  StatSN;
 574   UINT32  ExpCmdSN;
 575   UINT32  MaxCmdSN;
 576   UINT32  Reserved2[3];
 577 } ISCSI_NOP_IN;
 578
 579 #define ISCSI_SECURITY_NEGOTIATION          0
 580 #define ISCSI_LOGIN_OPERATIONAL_NEGOTIATION 1
 581 #define ISCSI_FULL_FEATURE_PHASE            3
 582
 583 typedef enum {
 584   IScsiDigestNone,
 585   IScsiDigestCRC32
 586 } ISCSI_DIGEST_TYPE;
 587
 588 typedef struct _ISCSI_XFER_CONTEXT {
 589   UINT32  TargetTransferTag;
 590   UINT32  Offset;
 591   UINT32  DesiredLength;
 592   UINT32  ExpDataSN;
 593 } ISCSI_XFER_CONTEXT;
 594
 595 typedef struct _ISCSI_IN_BUFFER_CONTEXT {
 596   UINT8   *InData;
 597   UINT32  InDataLen;
 598 } ISCSI_IN_BUFFER_CONTEXT;
 599
 600 typedef struct _ISCSI_TCB {
 601   LIST_ENTRY          Link;
 602
 603   BOOLEAN             SoFarInOrder;
 604   UINT32              ExpDataSN;
 605   BOOLEAN             FbitReceived;
 606   BOOLEAN             StatusXferd;
 607   UINT32              ActiveR2Ts;
 608   UINT32              Response;
 609   CHAR8               *Reason;
 610   UINT32              InitiatorTaskTag;
 611   UINT32              CmdSN;
 612   UINT32              SNACKTag;
 613
 614   ISCSI_XFER_CONTEXT  XferContext;
 615
 616   ISCSI_CONNECTION    *Conn;
 617 } ISCSI_TCB;
 618
 619 typedef struct _ISCSI_KEY_VALUE_PAIR {
 620   LIST_ENTRY      List;
 621
 622   CHAR8           *Key;
 623   CHAR8           *Value;
 624 } ISCSI_KEY_VALUE_PAIR;
 625
 626 /**
 627   Attach the iSCSI connection to the iSCSI session.
 628
 629   @param[in, out]  Session The iSCSI session.
 630   @param[in, out]  Conn    The iSCSI connection.
 631 **/
 632 VOID
 633 IScsiAttatchConnection (
 634   IN OUT ISCSI_SESSION     *Session,
 635   IN OUT ISCSI_CONNECTION  *Conn
 636   );
 637
 638 /**
 639   Detach the iSCSI connection from the session it belongs to.
 640
 641   @param[in, out]  Conn The iSCSI connection.
 642 **/
 643 VOID
 644 IScsiDetatchConnection (
 645   IN OUT ISCSI_CONNECTION  *Conn
 646   );
 647
 648 /**
 649   This function does the iSCSI connection login.
 650
 651   @param[in, out]  Conn      The iSCSI connection to login.
 652
 653   @retval EFI_SUCCESS        The iSCSI connection is logged into the iSCSI target.
 654   @retval EFI_TIMEOUT        Timeout happened during the login procedure.
 655   @retval Others             Other errors as indicated.
 656 **/
 657 EFI_STATUS
 658 IScsiConnLogin (
 659   IN OUT ISCSI_CONNECTION  *Conn
 660   );
 661
 662 /**
 663   Create a TCP connection for the iSCSI session.
 664
 665   @param[in]  Private The iSCSI driver data.
 666   @param[in]  Session Maximum CmdSN from the target.
 667
 668   @return The newly created iSCSI connection.
 669 **/
 670 ISCSI_CONNECTION *
 671 IScsiCreateConnection (
 672   IN ISCSI_DRIVER_DATA  *Private,
 673   IN ISCSI_SESSION      *Session
 674   );
 675
 676 /**
 677   Destroy an iSCSI connection.
 678
 679   @param[in]  Conn The connection to destroy.
 680 **/
 681 VOID
 682 IScsiDestroyConnection (
 683   IN ISCSI_CONNECTION  *Conn
 684   );
 685
 686 /**
 687   Login the iSCSI session.
 688
 689   @param[in]  Private          The iSCSI driver data.
 690
 691   @retval EFI_SUCCESS          The iSCSI session login procedure finished.
 692   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
 693   @retval EFI_NO_MEDIA         There was a media error.
 694   @retval Others               Other errors as indicated.
 695
 696 **/
 697 EFI_STATUS
 698 IScsiSessionLogin (
 699   IN ISCSI_DRIVER_DATA  *Private
 700   );
 701
 702 /**
 703   Build and send the iSCSI login request to the iSCSI target according to
 704   the current login stage.
 705
 706   @param[in]  Conn             The connection in the iSCSI login phase.
 707
 708   @retval EFI_SUCCESS          The iSCSI login request PDU is built and sent on this
 709                                connection.
 710   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
 711   @retval EFI_DEVICE_ERROR     Some kind of device error happened.
 712 **/
 713 EFI_STATUS
 714 IScsiSendLoginReq (
 715   IN ISCSI_CONNECTION  *Conn
 716   );
 717
 718 /**
 719   Receive and process the iSCSI login response.
 720
 721   @param[in]  Conn             The connection in the iSCSI login phase.
 722
 723   @retval EFI_SUCCESS          The iSCSI login response PDU is received and processed.
 724   @retval Others               Other errors as indicated.
 725 **/
 726 EFI_STATUS
 727 IScsiReceiveLoginRsp (
 728   IN ISCSI_CONNECTION  *Conn
 729   );
 730
 731 /**
 732   Add an iSCSI key-value pair as a string into the data segment of the Login Request PDU.
 733   The DataSegmentLength and the actual size of the net buffer containing this PDU will be
 734   updated.
 735
 736   @param[in, out]  Pdu         The iSCSI PDU whose data segment the key-value pair will
 737                                be added to.
 738   @param[in]       Key         The key name string.
 739   @param[in]       Value       The value string.
 740
 741   @retval EFI_SUCCESS          The key-valu pair is added to the PDU's datasegment and
 742                                the correspondence length fields are updated.
 743   @retval EFI_OUT_OF_RESOURCES There is not enough space in the PDU to add the key-value
 744                                pair.
 745 **/
 746 EFI_STATUS
 747 IScsiAddKeyValuePair (
 748   IN OUT NET_BUF      *Pdu,
 749   IN CHAR8            *Key,
 750   IN CHAR8            *Value
 751   );
 752
 753 /**
 754   Prepare the iSCSI login request to be sent according to the current login status.
 755
 756   @param[in, out]  Conn The connection in the iSCSI login phase.
 757
 758   @return The pointer to the net buffer containing the iSCSI login request built.
 759   @retval Others    Other errors as indicated.
 760 **/
 761 NET_BUF *
 762 IScsiPrepareLoginReq (
 763   IN OUT ISCSI_CONNECTION  *Conn
 764   );
 765
 766 /**
 767   Process the iSCSI Login Response.
 768
 769   @param[in, out]  Conn The connection on which the iSCSI login response is received.
 770   @param[in, out]  Pdu  The iSCSI login response PDU.
 771
 772   @retval EFI_SUCCESS        The iSCSI login response PDU is processed and all check are passed.
 773   @retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.
 774   @retval EFI_MEDIA_CHANGED  Target is redirected.
 775   @retval Others             Other errors as indicated.
 776 **/
 777 EFI_STATUS
 778 IScsiProcessLoginRsp (
 779   IN OUT ISCSI_CONNECTION  *Conn,
 780   IN OUT NET_BUF           *Pdu
 781   );
 782
 783 /**
 784   Updated the target information according the data received in the iSCSI
 785   login response with an target redirection status.
 786
 787   @param[in, out] Session      The iSCSI session.
 788   @param[in]      Data         The data segment which should contain the
 789                                TargetAddress key-value list.
 790   @param[in]      Len          Length of the data.
 791
 792   @retval EFI_SUCCESS          The target address is updated.
 793   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
 794   @retval EFI_NOT_FOUND        The TargetAddress key is not found.
 795   @retval Others               Other errors as indicated.
 796 **/
 797 EFI_STATUS
 798 IScsiUpdateTargetAddress (
 799   IN OUT ISCSI_SESSION  *Session,
 800   IN CHAR8              *Data,
 801   IN UINT32             Len
 802   );
 803
 804 /**
 805   The callback function to free the net buffer list.
 806
 807   @param[in]  Arg The opaque parameter.
 808 **/
 809 VOID
 810 EFIAPI
 811 IScsiFreeNbufList (
 812   VOID *Arg
 813   );
 814
 815 /**
 816   Receive an iSCSI response PDU. An iSCSI response PDU contains an iSCSI PDU header and
 817   an optional data segment. The two parts will be put into two blocks of buffers in the
 818   net buffer. The digest check will be conducted in this function if needed and the digests
 819   will be trimmed from the PDU buffer.
 820
 821   @param[in]   Conn        The iSCSI connection to receive data from.
 822   @param[out]  Pdu         The received iSCSI pdu.
 823   @param[in]   Context     The context used to describe information on the caller provided
 824                            buffer to receive data segment of the iSCSI pdu, it's optional.
 825   @param[in]  HeaderDigest Whether there will be header digest received.
 826   @param[in]  DataDigest   Whether there will be data digest.
 827   @param[in]  TimeoutEvent The timeout event, it's optional.
 828
 829   @retval EFI_SUCCESS          An iSCSI pdu is received.
 830   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
 831   @retval EFI_PROTOCOL_ERROR   Some kind of iSCSI protocol error happened.
 832   @retval Others               Other errors as indicated.
 833 **/
 834 EFI_STATUS
 835 IScsiReceivePdu (
 836   IN ISCSI_CONNECTION                      *Conn,
 837   OUT NET_BUF                              **Pdu,
 838   IN ISCSI_IN_BUFFER_CONTEXT               *Context, OPTIONAL
 839   IN BOOLEAN                               HeaderDigest,
 840   IN BOOLEAN                               DataDigest,
 841   IN EFI_EVENT                             TimeoutEvent OPTIONAL
 842   );
 843
 844 /**
 845   Check and get the result of the prameter negotiation.
 846
 847   @param[in, out]  Conn          The connection in iSCSI login.
 848
 849   @retval EFI_SUCCESS          The parmeter check is passed and negotiation is finished.
 850   @retval EFI_PROTOCOL_ERROR   Some kind of iSCSI protocol error happened.
 851   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
 852 **/
 853 EFI_STATUS
 854 IScsiCheckOpParams (
 855   IN OUT ISCSI_CONNECTION  *Conn
 856   );
 857
 858 /**
 859   Fill the oprational prameters.
 860
 861   @param[in]       Conn        The connection in iSCSI login.
 862   @param[in, out]  Pdu         The iSCSI login request PDU to fill the parameters.
 863
 864   @retval EFI_SUCCESS          The parmeters are filled into the iSCSI login request PDU.
 865 **/
 866 EFI_STATUS
 867 IScsiFillOpParams (
 868   IN ISCSI_CONNECTION  *Conn,
 869   IN OUT NET_BUF       *Pdu
 870   );
 871
 872 /**
 873   Pad the iSCSI AHS or data segment to an integer number of 4 byte words.
 874
 875   @param[in, out]  Pdu         The iSCSI pdu which contains segments to pad.
 876   @param[in]       Len         The length of the last semgnet in the PDU.
 877
 878   @retval EFI_SUCCESS          The segment is padded or no need to pad it.
 879   @retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the
 880                                padding bytes.
 881 **/
 882 EFI_STATUS
 883 IScsiPadSegment (
 884   IN OUT NET_BUF  *Pdu,
 885   IN UINT32       Len
 886   );
 887
 888 /**
 889   Build a key-value list from the data segment.
 890
 891   @param[in]  Data The data segment containing the key-value pairs.
 892   @param[in]  Len  Length of the data segment.
 893
 894   @return The key-value list.
 895   @retval NULL Other errors as indicated.
 896 **/
 897 LIST_ENTRY *
 898 IScsiBuildKeyValueList (
 899   IN CHAR8  *Data,
 900   IN UINT32 Len
 901   );
 902
 903 /**
 904   Get the value string by the key name from the key-value list. If found,
 905   the key-value entry will be removed from the list.
 906
 907   @param[in, out]  KeyValueList  The key-value list.
 908   @param[in]       Key           The key name to find.
 909
 910   @return The value string.
 911 **/
 912 CHAR8 *
 913 IScsiGetValueByKeyFromList (
 914   IN OUT LIST_ENTRY  *KeyValueList,
 915   IN CHAR8           *Key
 916   );
 917
 918 /**
 919   Free the key-value list.
 920
 921   @param[in]  KeyValueList The key-value list.
 922 **/
 923 VOID
 924 IScsiFreeKeyValueList (
 925   IN LIST_ENTRY      *KeyValueList
 926   );
 927
 928 /**
 929   Normalize the iSCSI name according to RFC.
 930
 931   @param[in, out]  Name       The iSCSI name.
 932   @param[in]       Len        length of the iSCSI name.
 933
 934   @retval EFI_SUCCESS        The iSCSI name is valid and normalized.
 935   @retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.
 936 **/
 937 EFI_STATUS
 938 IScsiNormalizeName (
 939   IN OUT CHAR8  *Name,
 940   IN UINTN      Len
 941   );
 942
 943 /**
 944   Execute the SCSI command issued through the EXT SCSI PASS THRU protocol.
 945
 946   @param[in]       PassThru  The EXT SCSI PASS THRU protocol.
 947   @param[in]       Target    The target ID.
 948   @param[in]       Lun       The LUN.
 949   @param[in, out]  Packet    The request packet containing IO request, SCSI command
 950                              buffer and buffers to read/write.
 951
 952   @retval EFI_SUCCES           The SCSI command is executed and the result is updated to
 953                                the Packet.
 954   @retval EFI_DEVICE_ERROR     Session state was not as required.
 955   @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
 956   @retval EFI_NOT_READY        The target can not accept new commands.
 957   @retval Others               Other errors as indicated.
 958 **/
 959 EFI_STATUS
 960 IScsiExecuteScsiCommand (
 961   IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL                 *PassThru,
 962   IN UINT8                                           *Target,
 963   IN UINT64                                          Lun,
 964   IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET  *Packet
 965   );
 966
 967 /**
 968   Reinstate the session on some error.
 969
 970   @param[in, out]  Private The iSCSI driver data.
 971
 972   @retval EFI_SUCCES  The session is reinstated from some error.
 973   @retval Other       Reinstatement failed.
 974 **/
 975 EFI_STATUS
 976 IScsiSessionReinstatement (
 977   IN OUT ISCSI_DRIVER_DATA  *Private
 978   );
 979
 980 /**
 981   Initialize some session parameters before login.
 982
 983   @param[in, out]  Session  The iSCSI session.
 984   @param[in]       Recovery Whether the request is from a fresh new start or recovery.
 985 **/
 986 VOID
 987 IScsiSessionInit (
 988   IN OUT ISCSI_SESSION  *Session,
 989   IN BOOLEAN            Recovery
 990   );
 991
 992 /**
 993   Abort the iSCSI session, that is, reset all the connection and free the
 994   resources.
 995
 996   @param[in, out]  Session The iSCSI session.
 997
 998   @retval EFI_SUCCES  The session is aborted.
 999 **/
1000 EFI_STATUS
1001 IScsiSessionAbort (
1002   IN OUT ISCSI_SESSION  *Session
1003   );
1004
1005 #endif