/** @file\r
The header file of iSCSI Protocol that defines many specific data structures.\r
\r
-Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>\r
-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
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#define ISCSI_VERSION_MAX 0x00\r
#define ISCSI_VERSION_MIN 0x00\r
\r
+#define ISCSI_CHECK_MEDIA_LOGIN_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)\r
+#define ISCSI_CHECK_MEDIA_GET_DHCP_WAITING_TIME EFI_TIMER_PERIOD_SECONDS(20)\r
+\r
+#define ISCSI_REDIRECT_ADDR_START_DELIMITER '['\r
+#define ISCSI_REDIRECT_ADDR_END_DELIMITER ']'\r
+\r
#define ISCSI_KEY_AUTH_METHOD "AuthMethod"\r
#define ISCSI_KEY_HEADER_DIGEST "HeaderDigest"\r
#define ISCSI_KEY_DATA_DIGEST "DataDigest"\r
} ISCSI_SENSE_DATA;\r
\r
///\r
-/// iSCSI Task Managment Function Request.\r
+/// iSCSI Task Management Function Request.\r
///\r
typedef struct _ISCSI_TMF_REQUEST {\r
UINT8 OpCode;\r
} ISCSI_KEY_VALUE_PAIR;\r
\r
/**\r
- Attach the iSCSI connection to the iSCSI session. \r
+ Attach the iSCSI connection to the iSCSI session.\r
\r
@param[in, out] Session The iSCSI session.\r
@param[in, out] Conn The iSCSI connection.\r
);\r
\r
/**\r
- Detach the iSCSI connection from the session it belongs to. \r
+ Detach the iSCSI connection from the session it belongs to.\r
\r
@param[in, out] Conn The iSCSI connection.\r
\r
\r
@retval EFI_SUCCESS The iSCSI connection is logged into the iSCSI target.\r
@retval EFI_TIMEOUT Timeout occurred during the login procedure.\r
- @retval Others Other errors as indicated. \r
+ @retval Others Other errors as indicated.\r
\r
**/\r
EFI_STATUS\r
Receive and process the iSCSI login response.\r
\r
@param[in] Conn The connection in the iSCSI login phase.\r
- \r
+\r
@retval EFI_SUCCESS The iSCSI login response PDU is received and processed.\r
@retval Others Other errors as indicated.\r
\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
+\r
@retval EFI_SUCCESS The target address is updated.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
@retval EFI_NOT_FOUND The TargetAddress key is not found.\r
);\r
\r
/**\r
- Check and get the result of the prameter negotiation.\r
+ Check and get the result of the parameter negotiation.\r
\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_SUCCESS The parameter check is passed and negotiation is finished.\r
@retval EFI_PROTOCOL_ERROR Some kind of iSCSI protocol error occurred.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
\r
);\r
\r
/**\r
- Fill the oprational prameters.\r
+ Fill the operational parameters.\r
\r
@param[in] Conn The connection in iSCSI login.\r
@param[in, out] Pdu The iSCSI login request PDU to fill the parameters.\r
Pad the iSCSI AHS or data segment to an integer number of 4 byte words.\r
\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
+ @param[in] Len The length of the last segment 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
@param[in] Lun The LUN.\r
@param[in, out] Packet The request packet containing IO request, SCSI command\r
buffer and buffers to read/write.\r
- \r
- @retval EFI_SUCCES The SCSI command is executed and the result is updated to \r
+\r
+ @retval EFI_SUCCESS The SCSI command is executed and the result is updated to\r
the Packet.\r
@retval EFI_DEVICE_ERROR Session state was not as required.\r
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+ @retval EFI_NOT_READY The target can not accept new commands.\r
@retval Others Other errors as indicated.\r
\r
**/\r
\r
@param[in] Session The iSCSI session\r
\r
- @retval EFI_SUCCES The session is reinstated from some error.\r
+ @retval EFI_SUCCESS The session is reinstated from some error.\r
@retval Other Reinstatement failed.\r
\r
**/\r
IN OUT ISCSI_SESSION *Session,\r
IN BOOLEAN Recovery\r
);\r
- \r
+\r
/**\r
Abort the iSCSI session, that is, reset all the connection and free the\r
resources.\r
projects / mirror_edk2.git / blobdiff