sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Description]

Browse Source 
change the old code style to comply with Doxgen format
[Impaction]
add comments for every function
[Reference Info]
add comments to achieve the highest standard of code quality matrix

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5079 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
eric_tian
2008-04-17 08:28:51 +00:00
parent d16fc3dbb3
commit 12618416ec
25 changed files with 2489 additions and 2153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

119
MdeModulePkg/Universal/Network/IScsiDxe/IScsiInitiatorName.c
View File

@@ -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,6 +79,35 @@ Returns:
return Status;
}
/**
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.
@retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.
@retval EFI_INVALID_PARAMETER BufferSize exceeds the maximum allowed limit.
BufferSize will be updated with the maximum size
required to complete the request.
@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 data could not be stored due to a hardware error.
@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 (
@@ -87,33 +115,6 @@ IScsiSetInitiatorName (
IN OUT UINTN *BufferSize,
OUT VOID *Buffer
)
/*++
Routine Description:
Sets the iSSI Initiator Name.
Arguments:
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.
Returns:
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
--*/
{
EFI_STATUS Status;