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