2 EFI_ISCSI_INITIATOR_NAME_PROTOCOL as defined in UEFI 2.0.
3 It rovides the ability to get and set the iSCSI Initiator Name.
5 Copyright (c) 2006, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
14 Module Name: IScsiInitatorName.h
18 #ifndef __ISCSI_INITIATOR_NAME_H__
19 #define __ISCSI_INITIATOR_NAME_H__
21 #define EFI_ISCSI_INITIATOR_NAME_PROTOCOL_GUID \
23 0xa6a72875, 0x2962, 0x4c18, {0x9f, 0x46, 0x8d, 0xa6, 0x44, 0xcc, 0xfe } \
26 typedef struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL EFI_ISCSI_INITIATOR_NAME_PROTOCOL
;
29 Retrieves the current set value of iSCSI Initiator Name.
31 @param This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
32 @param BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the
34 @param Buffer Pointer to the buffer for data to be read.
36 @retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the
37 BufferSize was sufficient to handle the iSCSI initiator name
38 @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.
39 @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
40 @retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.
45 (EFIAPI
*EFI_ISCSI_INITIATOR_NAME_GET
) (
46 IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL
*This
,
47 IN OUT UINTN
*BufferSize
,
55 Sets the iSCSI Initiator Name.
57 @param This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
58 @param BufferSize Size of the buffer in bytes pointed to by Buffer.
59 @param Buffer Pointer to the buffer for data to be written.
61 @retval EFI_SUCCESS Data was successfully stored by the protocol.
62 @retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.
63 @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.
64 @retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.
65 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
66 @retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720
67 (and other related protocols)
71 (EFIAPI
*EFI_ISCSI_INITIATOR_NAME_SET
) (
72 IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL
*This
,
73 IN OUT UINTN
*BufferSize
,
78 struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL
{
79 EFI_ISCSI_INITIATOR_NAME_GET Get
;
80 EFI_ISCSI_INITIATOR_NAME_SET Set
;
83 extern EFI_GUID gEfiIScsiInitiatorNameProtocolGuid
;