/** @file\r
- The header file of IScsi Protocol that defines many specific data structures.\r
+ The header file of iSCSI Protocol that defines many specific data structures.\r
\r
-Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r
+Copyright (c) 2004 - 2010, Intel Corporation.<BR>\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
///\r
/// connection state for initiator\r
///\r
-typedef enum {\r
- CONN_STATE_FREE,\r
- CONN_STATE_XPT_WAIT,\r
- CONN_STATE_IN_LOGIN,\r
- CONN_STATE_LOGGED_IN,\r
- CONN_STATE_IN_LOGOUT,\r
- CONN_STATE_LOGOUT_REQUESTED,\r
- CONN_STATE_CLEANUP_WAIT,\r
- CONN_STATE_IN_CLEANUP\r
-} CONNECTION_STATE;\r
+\r
+#define CONN_STATE_FREE 0\r
+#define CONN_STATE_XPT_WAIT 1\r
+#define CONN_STATE_IN_LOGIN 2\r
+#define CONN_STATE_LOGGED_IN 3\r
+#define CONN_STATE_IN_LOGOUT 4\r
+#define CONN_STATE_LOGOUT_REQUESTED 5\r
+#define CONN_STATE_CLEANUP_WAIT 6\r
+#define CONN_STATE_IN_CLEANUP 7\r
\r
///\r
/// session state for initiator\r
///\r
-typedef enum {\r
- SESSION_STATE_FREE,\r
- SESSION_STATE_LOGGED_IN,\r
- SESSION_STATE_FAILED\r
-} SESSION_STATE;\r
+#define SESSION_STATE_FREE 0\r
+#define SESSION_STATE_LOGGED_IN 1\r
+#define SESSION_STATE_FAILED 2\r
\r
typedef enum {\r
DataIn = 0,\r
UINT32 ExpDataXferLength;\r
UINT32 CmdSN;\r
UINT32 ExpStatSN;\r
- UINT8 CDB[16];\r
+ UINT8 Cdb[16];\r
} SCSI_COMMAND;\r
\r
//\r
UINT32 StatSN;\r
UINT32 ExpCmdSN;\r
UINT32 MaxCmdSN;\r
- UINT32 R2TSN;\r
+ UINT32 R2TSeqNum;\r
UINT32 BufferOffset;\r
UINT32 DesiredDataTransferLength;\r
} ISCSI_READY_TO_TRANSFER;\r
UINT8 VersionMin;\r
UINT8 TotalAHSLength;\r
UINT8 DataSegmentLength[3];\r
- UINT8 ISID[6];\r
- UINT16 TSIH;\r
+ UINT8 Isid[6];\r
+ UINT16 Tsih;\r
UINT32 InitiatorTaskTag;\r
- UINT16 CID;\r
+ UINT16 Cid;\r
UINT16 Reserved1;\r
UINT32 CmdSN;\r
UINT32 ExpStatSN;\r
UINT8 VersionActive;\r
UINT8 TotalAHSLength;\r
UINT8 DataSegmentLength[3];\r
- UINT8 ISID[6];\r
- UINT16 TSIH;\r
+ UINT8 Isid[6];\r
+ UINT16 Tsih;\r
UINT32 InitiatorTaskTag;\r
UINT32 Reserved1;\r
UINT32 StatSN;\r
UINT8 DataSegmentLength[3];\r
UINT32 Reserved2[2];\r
UINT32 InitiatorTaskTag;\r
- UINT16 CID;\r
+ UINT16 Cid;\r
UINT16 Reserved3;\r
UINT32 CmdSN;\r
UINT32 ExpStatSN;\r
#define ISCSI_FULL_FEATURE_PHASE 3\r
\r
typedef enum {\r
- ISCSI_DIGEST_NONE,\r
- ISCSI_DIGEST_CRC32\r
+ IScsiDigestNone,\r
+ IScsiDigestCRC32\r
} ISCSI_DIGEST_TYPE;\r
\r
typedef struct _ISCSI_XFER_CONTEXT {\r
/**\r
Attach the iSCSI connection to the iSCSI session. \r
\r
- @param[in] Session The iSCSI session.\r
- @param[in] Conn The iSCSI connection.\r
+ @param[in, out] Session The iSCSI session.\r
+ @param[in, out] Conn The iSCSI connection.\r
**/\r
VOID\r
IScsiAttatchConnection (\r
- IN ISCSI_SESSION *Session,\r
- IN ISCSI_CONNECTION *Conn\r
+ IN OUT ISCSI_SESSION *Session,\r
+ IN OUT ISCSI_CONNECTION *Conn\r
);\r
\r
/**\r
Detach the iSCSI connection from the session it belongs to. \r
\r
- @param[in] Conn The iSCSI connection.\r
+ @param[in, out] Conn The iSCSI connection.\r
**/\r
VOID\r
IScsiDetatchConnection (\r
- IN ISCSI_CONNECTION *Conn\r
+ IN OUT ISCSI_CONNECTION *Conn\r
);\r
\r
/**\r
This function does the iSCSI connection login.\r
\r
- @param[in] Conn The iSCSI connection to login.\r
+ @param[in, out] Conn The iSCSI connection to login.\r
\r
@retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.\r
@retval EFI_TIMEOUT Timeout happened during the login procedure.\r
**/\r
EFI_STATUS\r
IScsiConnLogin (\r
- IN ISCSI_CONNECTION *Conn\r
+ IN OUT ISCSI_CONNECTION *Conn\r
);\r
\r
/**\r
\r
@retval EFI_SUCCESS The iSCSI session login procedure finished.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+ @retval EFI_NO_MEDIA There was a media error.\r
@retval Others Other errors as indicated.\r
+\r
**/\r
EFI_STATUS\r
IScsiSessionLogin (\r
The DataSegmentLength and the actual size of the net buffer containing this PDU will be\r
updated.\r
\r
- @param[in] Pdu The iSCSI PDU whose data segment the key-value pair will\r
+ @param[in, out] Pdu The iSCSI PDU whose data segment the key-value pair will\r
be added to.\r
- @param[in] Key The key name string.\r
- @param[in] Value The value string.\r
+ @param[in] Key The key name string.\r
+ @param[in] Value The value string.\r
\r
@retval EFI_SUCCESS The key-valu pair is added to the PDU's datasegment and\r
the correspondence length fields are updated.\r
**/\r
EFI_STATUS\r
IScsiAddKeyValuePair (\r
- IN NET_BUF *Pdu,\r
+ IN OUT NET_BUF *Pdu,\r
IN CHAR8 *Key,\r
IN CHAR8 *Value\r
);\r
/**\r
Prepare the iSCSI login request to be sent according to the current login status.\r
\r
- @param[in] Conn The connection in the iSCSI login phase.\r
+ @param[in, out] Conn The connection in the iSCSI login phase.\r
\r
@return The pointer to the net buffer containing the iSCSI login request built.\r
@retval Others Other errors as indicated.\r
**/\r
NET_BUF *\r
IScsiPrepareLoginReq (\r
- IN ISCSI_CONNECTION *Conn\r
+ IN OUT ISCSI_CONNECTION *Conn\r
);\r
\r
/**\r
Process the iSCSI Login Response.\r
\r
- @param[in] Conn The connection on which the iSCSI login response is received.\r
- @param[in] Pdu The iSCSI login response PDU.\r
+ @param[in, out] Conn The connection on which the iSCSI login response is received.\r
+ @param[in, out] Pdu The iSCSI login response PDU.\r
\r
@retval EFI_SUCCESS The iSCSI login response PDU is processed and all check are passed.\r
@retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
**/\r
EFI_STATUS\r
IScsiProcessLoginRsp (\r
- IN ISCSI_CONNECTION *Conn,\r
- IN NET_BUF *Pdu\r
+ IN OUT ISCSI_CONNECTION *Conn,\r
+ IN OUT NET_BUF *Pdu\r
);\r
\r
/**\r
Updated the target information according the data received in the iSCSI\r
login response with an target redirection status.\r
\r
- @param[in] Session The iSCSI session.\r
- @param[in] Data The data segment which should contain the\r
- TargetAddress key-value list.\r
- @param[in] Len Length of the data.\r
+ @param[in, out] Session The iSCSI session.\r
+ @param[in] Data The data segment which should contain the\r
+ TargetAddress key-value list.\r
+ @param[in] Len Length of the data.\r
\r
@retval EFI_SUCCESS The target address is updated.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
**/\r
EFI_STATUS\r
IScsiUpdateTargetAddress (\r
- IN ISCSI_SESSION *Session,\r
- IN CHAR8 *Data,\r
- IN UINT32 Len\r
+ IN OUT ISCSI_SESSION *Session,\r
+ IN CHAR8 *Data,\r
+ IN UINT32 Len\r
);\r
\r
/**\r
/**\r
Check and get the result of the prameter negotiation.\r
\r
- @param[in] Conn The connection in iSCSI login.\r
- @param[in] Transit Whether need transit.\r
+ @param[in, out] Conn The connection in iSCSI login.\r
\r
@retval EFI_SUCCESS The parmeter check is passed and negotiation is finished.\r
@retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error happened.\r
**/\r
EFI_STATUS\r
IScsiCheckOpParams (\r
- IN ISCSI_CONNECTION *Conn,\r
- IN BOOLEAN Transit\r
+ IN OUT ISCSI_CONNECTION *Conn\r
);\r
\r
/**\r
Fill the oprational prameters.\r
\r
- @param[in] Conn The connection in iSCSI login.\r
- @param[in] Pdu The iSCSI login request PDU to fill the parameters.\r
+ @param[in] Conn The connection in iSCSI login.\r
+ @param[in, out] Pdu The iSCSI login request PDU to fill the parameters.\r
\r
@retval EFI_SUCCESS The parmeters are filled into the iSCSI login request PDU.\r
**/\r
EFI_STATUS\r
IScsiFillOpParams (\r
IN ISCSI_CONNECTION *Conn,\r
- IN NET_BUF *Pdu\r
+ IN OUT NET_BUF *Pdu\r
);\r
\r
/**\r
Pad the iSCSI AHS or data segment to an integer number of 4 byte words.\r
\r
- @param[in] Pdu The iSCSI pdu which contains segments to pad.\r
- @param[in] Len The length of the last semgnet in the PDU.\r
+ @param[in, out] Pdu The iSCSI pdu which contains segments to pad.\r
+ @param[in] Len The length of the last semgnet in the PDU.\r
\r
@retval EFI_SUCCESS The segment is padded or no need to pad it.\r
@retval EFI_OUT_OF_RESOURCES There is not enough remaining free space to add the\r
**/\r
EFI_STATUS\r
IScsiPadSegment (\r
- IN NET_BUF *Pdu,\r
- IN UINT32 Len\r
+ IN OUT NET_BUF *Pdu,\r
+ IN UINT32 Len\r
);\r
\r
/**\r
Get the value string by the key name from the key-value list. If found,\r
the key-value entry will be removed from the list.\r
\r
- @param[in] KeyValueList The key-value list.\r
- @param[in] Key The key name to find.\r
+ @param[in, out] KeyValueList The key-value list.\r
+ @param[in] Key The key name to find.\r
\r
@return The value string.\r
**/\r
CHAR8 *\r
IScsiGetValueByKeyFromList (\r
- IN LIST_ENTRY *KeyValueList,\r
+ IN OUT LIST_ENTRY *KeyValueList,\r
IN CHAR8 *Key\r
);\r
\r
/**\r
Normalize the iSCSI name according to RFC.\r
\r
- @param[in] Name The iSCSI name.\r
- @param[in] Len length of the iSCSI name.\r
+ @param[in, out] Name The iSCSI name.\r
+ @param[in] Len length of the iSCSI name.\r
\r
@retval EFI_SUCCESS The iSCSI name is valid and normalized.\r
@retval EFI_PROTOCOL_ERROR The iSCSI name is mal-formatted or not in the IQN format.\r
**/\r
EFI_STATUS\r
IScsiNormalizeName (\r
- IN CHAR8 *Name,\r
- IN UINTN Len\r
+ IN OUT CHAR8 *Name,\r
+ IN UINTN Len\r
);\r
\r
/**\r
\r
@retval EFI_SUCCES The SCSI command is executed and the result is updated to \r
the Packet.\r
- @retval EFI_DEVICE_ERROR Other errors as indicated.\r
+ @retval EFI_DEVICE_ERROR Session state was not as required.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
@retval Others Other errors as indicated.\r
**/\r
/**\r
Reinstate the session on some error.\r
\r
- @param[in] Private The iSCSI driver data.\r
+ @param[in, out] Private The iSCSI driver data.\r
\r
@retval EFI_SUCCES The session is reinstated from some error.\r
@retval Other Reinstatement failed.\r
**/\r
EFI_STATUS\r
IScsiSessionReinstatement (\r
- IN ISCSI_DRIVER_DATA *Private\r
+ IN OUT ISCSI_DRIVER_DATA *Private\r
);\r
\r
/**\r
Abort the iSCSI session, that is, reset all the connection and free the\r
resources.\r
\r
- @param[in] Session The iSCSI session.\r
+ @param[in, out] Session The iSCSI session.\r
\r
@retval EFI_SUCCES The session is aborted.\r
**/\r
EFI_STATUS\r
IScsiSessionAbort (\r
- IN ISCSI_SESSION *Session\r
+ IN OUT ISCSI_SESSION *Session\r
);\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff