-/*++\r
+/** @file\r
+ Implementation for EFI iSCSI Initiator Name Protocol.\r
\r
-Copyright (c) 2004 - 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2004 - 2008, 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
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
\r
-Module Name:\r
-\r
- IScsiInitiatorName.c\r
-\r
-Abstract:\r
-\r
- Implementation for EFI iSCSI Initiator Name Protocol.\r
-\r
---*/\r
+**/\r
\r
#include "IScsiImpl.h"\r
\r
IScsiSetInitiatorName\r
};\r
\r
+/**\r
+ Retrieves the current set value of iSCSI Initiator Name.\r
+\r
+ @param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
+ @param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the\r
+ variable data buffer.\r
+ @param[out] Buffer Pointer to the buffer for data to be read.\r
+\r
+ @retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the\r
+ BufferSize was sufficient to handle the iSCSI initiator name.\r
+ @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.\r
+ @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.\r
+ @retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.\r
+ @retval Others Other errors as indicated.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IScsiGetInitiatorName (\r
IN OUT UINTN *BufferSize,\r
OUT VOID *Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Retrieves the current set value of iSCSI Initiator Name. \r
-\r
-Arguments:\r
-\r
- This - Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
- BufferSize - Size of the buffer in bytes pointed to by Buffer / Actual size of\r
- the variable data buffer.\r
- Buffer - Pointer to the buffer for data to be read.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Data was successfully retrieved into the provided \r
- buffer and the BufferSize was sufficient to handle the\r
- iSCSI initiator name.\r
- EFI_BUFFER_TOO_SMALL - BufferSize is too small for the result. BufferSize will\r
- be updated with the size required to complete the request.\r
- Buffer will not be affected.\r
- EFI_INVALID_PARAMETER - BufferSize is NULL. BufferSize and Buffer will not be\r
- affected.\r
- EFI_INVALID_PARAMETER - Buffer is NULL. BufferSize and Buffer will not be\r
- affected.\r
- EFI_DEVICE_ERROR - The iSCSI initiator name could not be retrieved due to\r
- a hardware error.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return Status;\r
}\r
\r
+/**\r
+ Sets the iSCSI Initiator Name.\r
+\r
+ @param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
+ @param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer.\r
+ @param[in] Buffer Pointer to the buffer for data to be written.\r
+\r
+ @retval EFI_SUCCESS Data was successfully stored by the protocol.\r
+ @retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.\r
+ Currently not implemented.\r
+ @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.\r
+ @retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.\r
+ @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.\r
+ @retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720\r
+ (and other related protocols).\r
+ @retval Others Other errors as indicated.\r
+**/\r
EFI_STATUS\r
EFIAPI\r
IScsiSetInitiatorName (\r
IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,\r
IN OUT UINTN *BufferSize,\r
- OUT VOID *Buffer\r
+ IN VOID *Buffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Sets the iSSI Initiator Name. \r
-\r
-Arguments:\r
-\r
- This - Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.\r
- BufferSize - Size of the buffer in bytes pointed to by Buffer.\r
- Buffer - Pointer to the buffer for data to be written.\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Data was successfully stored by the protocol.\r
- EFI_UNSUPPORTED - Platform policies do not allow for data to be written.\r
- EFI_INVALID_PARAMETER - BufferSize exceeds the maximum allowed limit.\r
- BufferSize will be updated with the maximum size\r
- required to complete the request.\r
- EFI_INVALID_PARAMETER - Buffersize is NULL. BufferSize and Buffer will not be\r
- affected.\r
- EFI_INVALID_PARAMETER - Buffer is NULL. BufferSize and Buffer will not be affected.\r
- EFI_DEVICE_ERROR - The data could not be stored due to a hardware error.\r
- EFI_OUT_OF_RESOURCES - Not enough storage is available to hold the data\r
- EFI_PROTOCOL_ERROR - Input iSCSI initiator name does not adhere to RFC 3720\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
projects / mirror_edk2.git / blobdiff