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