Classes
struct	_EFI_ISCSI_INITIATOR_NAME_PROTOCOL

Macros
#define	EFI_ISCSI_INITIATOR_NAME_PROTOCOL_GUID

Typedefs
typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL	EFI_ISCSI_INITIATOR_NAME_PROTOCOL

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

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

Variables
EFI_GUID	gEfiIScsiInitiatorNameProtocolGuid

Detailed Description

EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0. It provides the ability to get and set the iSCSI Initiator Name.

Copyright (c) 2006 - 2018, 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.

Macro Definition Documentation

◆ EFI_ISCSI_INITIATOR_NAME_PROTOCOL_GUID

#define EFI_ISCSI_INITIATOR_NAME_PROTOCOL_GUID

Value:

{ \
  0x59324945, 0xec44, 0x4c0d, {0xb1, 0xcd, 0x9d, 0xb1, 0x39, 0xdf, 0x7, 0xc } \
}

Typedef Documentation

◆ EFI_ISCSI_INITIATOR_NAME_GET

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

Retrieves the current set value of iSCSI Initiator Name.

Parameters

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. 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.
EFI_INVALID_PARAMETER	BufferSize or Buffer is NULL.
EFI_DEVICE_ERROR	The iSCSI initiator name could not be retrieved due to a hardware error.

◆ EFI_ISCSI_INITIATOR_NAME_PROTOCOL

typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTOCOL

◆ EFI_ISCSI_INITIATOR_NAME_SET

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

Sets the iSCSI Initiator Name.

Parameters

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. 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 or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.
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 (and other related protocols)

Variable Documentation

◆ gEfiIScsiInitiatorNameProtocolGuid

EFI_GUID gEfiIScsiInitiatorNameProtocolGuid

extern

Classes

Macros

Typedefs

Variables