mirror of https://github.com/acidanthera/audk.git
update file header
correct one parameter IN Out mistake in IScsiSetInitiatorName () git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6959 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
fa6fb82a0b
commit
9fd6fde8b2
|
@ -1,7 +1,7 @@
|
|||
/** @file
|
||||
Implementation for EFI iSCSI Initiator Name Protocol.
|
||||
|
||||
Copyright (c) 2004 - 2008, Intel Corporation
|
||||
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
||||
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
|
||||
|
@ -10,14 +10,6 @@ http://opensource.org/licenses/bsd-license.php
|
|||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
Module Name:
|
||||
|
||||
IScsiInitiatorName.c
|
||||
|
||||
Abstract:
|
||||
|
||||
Implementation for EFI iSCSI Initiator Name Protocol.
|
||||
|
||||
**/
|
||||
|
||||
#include "IScsiImpl.h"
|
||||
|
@ -28,31 +20,19 @@ EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName = {
|
|||
};
|
||||
|
||||
/**
|
||||
Retrieves the current set value of iSCSI Initiator Name.
|
||||
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.
|
||||
@param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
|
||||
@param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the
|
||||
variable data buffer.
|
||||
@param[out] Buffer 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.
|
||||
@retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
|
||||
@retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.
|
||||
@retval Others Some unexpected error happened.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
@ -80,40 +60,28 @@ IScsiGetInitiatorName (
|
|||
}
|
||||
|
||||
/**
|
||||
Sets the iSCSI Initiator Name.
|
||||
Sets the iSCSI Initiator Name.
|
||||
|
||||
@param This[in] Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
|
||||
@param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
|
||||
@param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer.
|
||||
@param[in] Buffer Pointer to the buffer for data to be written.
|
||||
|
||||
@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.
|
||||
|
||||
Currently not implemented.
|
||||
@retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.
|
||||
@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.
|
||||
|
||||
@retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720
|
||||
(and other related protocols)
|
||||
@retval Others Some unexpected error happened.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
IScsiSetInitiatorName (
|
||||
IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This,
|
||||
IN OUT UINTN *BufferSize,
|
||||
OUT VOID *Buffer
|
||||
IN VOID *Buffer
|
||||
)
|
||||
{
|
||||
EFI_STATUS Status;
|
||||
|
|
Loading…
Reference in New Issue