2 The header file for EFI iSCSI Initiator Name Protocol.
4 Copyright (c) 2004 - 2008, Intel Corporation.<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _ISCSI_INITIATOR_NAME_H_
16 #define _ISCSI_INITIATOR_NAME_H_
18 #include <Protocol/IScsiInitiatorName.h>
20 extern EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName
;
23 // EFI iSCSI Initiator Name Protocol for IScsi driver.
27 Retrieves the current set value of iSCSI Initiator Name.
29 @param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
30 @param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the
32 @param[out] Buffer Pointer to the buffer for data to be read.
34 @retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the
35 BufferSize was sufficient to handle the iSCSI initiator name.
36 @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.
37 @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
38 @retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.
39 @retval Others Other errors as indicated.
43 IScsiGetInitiatorName (
44 IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL
*This
,
45 IN OUT UINTN
*BufferSize
,
50 Sets the iSCSI Initiator Name.
52 @param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
53 @param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer.
54 @param[in] Buffer Pointer to the buffer for data to be written.
56 @retval EFI_SUCCESS Data was successfully stored by the protocol.
57 @retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.
58 Currently not implemented.
59 @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.
60 @retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.
61 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
62 @retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720
63 (and other related protocols).
64 @retval Others Other errors as indicated.
68 IScsiSetInitiatorName (
69 IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL
*This
,
70 IN OUT UINTN
*BufferSize
,