diff options
Diffstat (limited to 'MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c')
| -rw-r--r-- | MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c | 119 |
1 files changed, 60 insertions, 59 deletions
diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c index f93594fdcd..3a8bd3a2ff 100644 --- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c +++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c @@ -1,6 +1,7 @@ -/*++
+/** @file
+ Implementation for EFI iSCSI Initiator Name Protocol.
-Copyright (c) 2004 - 2007, Intel Corporation
+Copyright (c) 2004 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
@@ -17,7 +18,7 @@ Abstract: Implementation for EFI iSCSI Initiator Name Protocol.
---*/
+**/
#include "IScsiImpl.h"
@@ -26,6 +27,33 @@ EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName = { IScsiSetInitiatorName
};
+/**
+ Retrieves the current set value of iSCSI Initiator Name.
+
+ @param This[in] Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
+
+ @param BufferSize[in][out] Size of the buffer in bytes pointed to by Buffer / Actual
+ size of the variable data buffer.
+
+ @param Buffer[out] Pointer to the buffer for data to be read.
+
+ @retval EFI_SUCCESS Data was successfully retrieved into the provided
+ buffer and the BufferSize was sufficient to handle the
+ iSCSI initiator name.
+ @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result. BufferSize will
+ be updated with the size required to complete the request.
+ Buffer will not be affected.
+
+ @retval EFI_INVALID_PARAMETER BufferSize is NULL. BufferSize and Buffer will not be
+ affected.
+
+ @retval EFI_INVALID_PARAMETER Buffer is NULL. BufferSize and Buffer will not be
+ affected.
+
+ @retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to
+ a hardware error.
+
+**/
EFI_STATUS
EFIAPI
IScsiGetInitiatorName (
@@ -33,35 +61,6 @@ IScsiGetInitiatorName ( IN OUT UINTN *BufferSize,
OUT VOID *Buffer
)
-/*++
-
-Routine Description:
-
- Retrieves the current set value of iSCSI Initiator Name.
-
-Arguments:
-
- This - Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
- BufferSize - Size of the buffer in bytes pointed to by Buffer / Actual size of
- the variable data buffer.
- Buffer - Pointer to the buffer for data to be read.
-
-Returns:
-
- EFI_SUCCESS - Data was successfully retrieved into the provided
- buffer and the BufferSize was sufficient to handle the
- iSCSI initiator name.
- EFI_BUFFER_TOO_SMALL - BufferSize is too small for the result. BufferSize will
- be updated with the size required to complete the request.
- Buffer will not be affected.
- EFI_INVALID_PARAMETER - BufferSize is NULL. BufferSize and Buffer will not be
- affected.
- EFI_INVALID_PARAMETER - Buffer is NULL. BufferSize and Buffer will not be
- affected.
- EFI_DEVICE_ERROR - The iSCSI initiator name could not be retrieved due to
- a hardware error.
-
---*/
{
EFI_STATUS Status;
@@ -80,40 +79,42 @@ Returns: return Status;
}
-EFI_STATUS
-EFIAPI
-IScsiSetInitiatorName (
- IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,
- IN OUT UINTN *BufferSize,
- OUT VOID *Buffer
- )
-/*++
+/**
+ Sets the iSCSI Initiator Name.
+
+ @param This[in] Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
+
+ @param BufferSize[in][out] Size of the buffer in bytes pointed to by Buffer.
+
+ @param Buffer[out] Pointer to the buffer for data to be written.
+
+ @retval EFI_SUCCESS Data was successfully stored by the protocol.
-Routine Description:
+ @retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.
- Sets the iSSI Initiator Name.
+ @retval EFI_INVALID_PARAMETER BufferSize exceeds the maximum allowed limit.
+ BufferSize will be updated with the maximum size
+ required to complete the request.
-Arguments:
+ @retval EFI_INVALID_PARAMETER Buffersize is NULL. BufferSize and Buffer will not be
+ affected.
- This - Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
- BufferSize - Size of the buffer in bytes pointed to by Buffer.
- Buffer - Pointer to the buffer for data to be written.
+ @retval EFI_INVALID_PARAMETER Buffer is NULL. BufferSize and Buffer will not be affected.
-Returns:
+ @retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.
- EFI_SUCCESS - Data was successfully stored by the protocol.
- EFI_UNSUPPORTED - Platform policies do not allow for data to be written.
- EFI_INVALID_PARAMETER - BufferSize exceeds the maximum allowed limit.
- BufferSize will be updated with the maximum size
- required to complete the request.
- EFI_INVALID_PARAMETER - Buffersize is NULL. BufferSize and Buffer will not be
- affected.
- EFI_INVALID_PARAMETER - Buffer is NULL. BufferSize and Buffer will not be affected.
- EFI_DEVICE_ERROR - The data could not be stored due to a hardware error.
- EFI_OUT_OF_RESOURCES - Not enough storage is available to hold the data
- EFI_PROTOCOL_ERROR - Input iSCSI initiator name does not adhere to RFC 3720
+ @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
---*/
+ @retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720.
+
+**/
+EFI_STATUS
+EFIAPI
+IScsiSetInitiatorName (
+ IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,
+ IN OUT UINTN *BufferSize,
+ OUT VOID *Buffer
+ )
{
EFI_STATUS Status;
|