NetworkPkg/IScsiDxe/IScsiInitiatorName.c File Reference


Functions

EFI_STATUS EFIAPI IScsiGetInitiatorName (IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer)
EFI_STATUS EFIAPI IScsiSetInitiatorName (IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer)

Variables

EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName

Detailed Description

Implementation for EFI iSCSI Initiator Name Protocol.

Copyright (c) 2004 - 2011, 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 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.


Function Documentation

EFI_STATUS EFIAPI IScsiGetInitiatorName ( IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *  This,
IN OUT UINTN *  BufferSize,
OUT VOID *  Buffer 
)

Retrieves the current set value of iSCSI Initiator Name.

Parameters:
[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
[in,out] BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the variable data buffer.
[out] Buffer Pointer to the buffer for data to be read. The data is a null-terminated UTF-8 encoded string. The maximum length is 223 characters, including the null-terminator.
Return values:
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.

References ISCSI_INITIATOR_NAME_VAR_NAME.

EFI_STATUS EFIAPI IScsiSetInitiatorName ( IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *  This,
IN OUT UINTN *  BufferSize,
IN VOID *  Buffer 
)

Sets the iSSI Initiator Name.

Parameters:
[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
[in,out] BufferSize Size of the buffer in bytes pointed to by Buffer.
[in] Buffer Pointer to the buffer for data to be written. The data is a null-terminated UTF-8 encoded string. The maximum length is 223 characters, including the null-terminator.
Return values:
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

References ISCSI_INITIATOR_NAME_VAR_NAME, ISCSI_NAME_MAX_SIZE, and IScsiNormalizeName().


Variable Documentation

EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName


Generated on Mon Sep 28 08:49:06 2015 for NetworkPkg[ALL] by  doxygen 1.5.7.1