2 Implementation for EFI iSCSI Initiator Name Protocol.
4 Copyright (c) 2004 - 2011, Intel Corporation. All rights reserved.<BR>
5 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 #include "IScsiImpl.h"
17 EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName
= {
18 IScsiGetInitiatorName
,
23 Retrieves the current set value of iSCSI Initiator Name.
25 @param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
26 @param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the
28 @param[out] Buffer Pointer to the buffer for data to be read. The data is a null-terminated UTF-8 encoded string.
29 The maximum length is 223 characters, including the null-terminator.
31 @retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the
32 BufferSize was sufficient to handle the iSCSI initiator name.
33 @retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.
34 @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
35 @retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.
36 @retval Others Other errors as indicated.
40 IScsiGetInitiatorName (
41 IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL
*This
,
42 IN OUT UINTN
*BufferSize
,
48 if ((BufferSize
== NULL
) || (Buffer
== NULL
)) {
49 return EFI_INVALID_PARAMETER
;
52 Status
= gRT
->GetVariable (
53 ISCSI_INITIATOR_NAME_VAR_NAME
,
54 &gEfiIScsiInitiatorNameProtocolGuid
,
64 Sets the iSCSI Initiator Name.
66 @param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
67 @param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer.
68 @param[in] Buffer Pointer to the buffer for data to be written. The data is a null-terminated UTF-8 encoded string.
69 The maximum length is 223 characters, including the null-terminator.
71 @retval EFI_SUCCESS Data was successfully stored by the protocol.
72 @retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.
73 Currently not implemented.
74 @retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.
75 @retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.
76 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
77 @retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720
78 (and other related protocols).
79 @retval Others Other errors as indicated.
83 IScsiSetInitiatorName (
84 IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL
*This
,
85 IN OUT UINTN
*BufferSize
,
91 if ((BufferSize
== NULL
) || (Buffer
== NULL
)) {
92 return EFI_INVALID_PARAMETER
;
95 if (*BufferSize
> ISCSI_NAME_MAX_SIZE
) {
96 *BufferSize
= ISCSI_NAME_MAX_SIZE
;
97 return EFI_INVALID_PARAMETER
;
100 // only support iqn iSCSI names.
102 Status
= IScsiNormalizeName ((CHAR8
*) Buffer
, *BufferSize
- 1);
103 if (EFI_ERROR (Status
)) {
107 Status
= gRT
->SetVariable (
108 ISCSI_INITIATOR_NAME_VAR_NAME
,
109 &gEfiIScsiInitiatorNameProtocolGuid
,
110 EFI_VARIABLE_NON_VOLATILE
| EFI_VARIABLE_BOOTSERVICE_ACCESS
,