IScsiInitiatorName.c File Reference

#include "IScsiImpl.h"

Go to the source code of this file.

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.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file IScsiInitiatorName.c.

Function Documentation

IScsiGetInitiatorName()

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.

Definition at line 43 of file IScsiInitiatorName.c.

IScsiSetInitiatorName()

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

Definition at line 95 of file IScsiInitiatorName.c.

Variable Documentation

gIScsiInitiatorName

EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName

Initial value:

= {
  IScsiGetInitiatorName,
  IScsiSetInitiatorName
}

Definition at line 11 of file IScsiInitiatorName.c.