2 The header file of functions for configuring or getting the parameters
5 Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef _ISCSI_CONFIG_H_
11 #define _ISCSI_CONFIG_H_
13 #include "IScsiConfigNVDataStruc.h"
15 typedef struct _ISCSI_FORM_CALLBACK_INFO ISCSI_FORM_CALLBACK_INFO
;
17 extern UINT8 IScsiConfigVfrBin
[];
18 extern UINT8 IScsiDxeStrings
[];
19 extern ISCSI_FORM_CALLBACK_INFO
*mCallbackInfo
;
21 #define VAR_OFFSET(Field) \
22 ((UINT16) ((UINTN) &(((ISCSI_CONFIG_IFR_NVDATA *) 0)->Field)))
24 #define QUESTION_ID(Field) \
25 ((UINT16) (VAR_OFFSET (Field) + CONFIG_OPTION_OFFSET))
27 #define DYNAMIC_ONE_OF_VAR_OFFSET VAR_OFFSET (Enabled)
28 #define DYNAMIC_ORDERED_LIST_QUESTION_ID QUESTION_ID (DynamicOrderedList)
29 #define DYNAMIC_ORDERED_LIST_VAR_OFFSET VAR_OFFSET (DynamicOrderedList)
30 #define ATTEMPT_DEL_QUESTION_ID QUESTION_ID (DeleteAttemptList)
31 #define ATTEMPT_DEL_VAR_OFFSET VAR_OFFSET (DeleteAttemptList)
32 #define ATTEMPT_ADD_QUESTION_ID QUESTION_ID (AddAttemptList)
33 #define ATTEMPT_ADD_VAR_OFFSET VAR_OFFSET (AddAttemptList)
36 // Define QuestionId and OffSet for Keywords.
38 #define ATTEMPT_MAC_ADDR_VAR_OFFSET VAR_OFFSET (ISCSIMacAddr)
39 #define ATTEMPT_ATTEMPT_NAME_QUESTION_ID QUESTION_ID (ISCSIAttemptName)
40 #define ATTEMPT_ATTEMPT_NAME_VAR_OFFSET VAR_OFFSET (ISCSIAttemptName)
41 #define ATTEMPT_BOOTENABLE_QUESTION_ID QUESTION_ID (ISCSIBootEnableList)
42 #define ATTEMPT_BOOTENABLE_VAR_OFFSET VAR_OFFSET (ISCSIBootEnableList)
43 #define ATTEMPT_ADDRESS_TYPE_QUESTION_ID QUESTION_ID (ISCSIIpAddressTypeList)
44 #define ATTEMPT_ADDRESS_TYPE_VAR_OFFSET VAR_OFFSET (ISCSIIpAddressTypeList)
45 #define ATTEMPT_CONNECT_RETRY_QUESTION_ID QUESTION_ID (ISCSIConnectRetry)
46 #define ATTEMPT_CONNECT_RETRY_VAR_OFFSET VAR_OFFSET (ISCSIConnectRetry)
47 #define ATTEMPT_CONNECT_TIMEOUT_QUESTION_ID QUESTION_ID (ISCSIConnectTimeout)
48 #define ATTEMPT_CONNECT_TIMEOUT_VAR_OFFSET VAR_OFFSET (ISCSIConnectTimeout)
49 #define ATTEMPT_ISID_QUESTION_ID QUESTION_ID (Keyword->ISCSIIsId)
50 #define ATTEMPT_ISID_VAR_OFFSET VAR_OFFSET (Keyword->ISCSIIsId)
51 #define ATTEMPT_INITIATOR_VIA_DHCP_QUESTION_ID QUESTION_ID (ISCSIInitiatorInfoViaDHCP)
52 #define ATTEMPT_INITIATOR_VIA_DHCP_VAR_OFFSET VAR_OFFSET (ISCSIInitiatorInfoViaDHCP)
53 #define ATTEMPT_INITIATOR_IP_ADDRESS_QUESTION_ID QUESTION_ID (Keyword->ISCSIInitiatorIpAddress)
54 #define ATTEMPT_INITIATOR_IP_ADDRESS_VAR_OFFSET VAR_OFFSET (Keyword->ISCSIInitiatorIpAddress)
55 #define ATTEMPT_INITIATOR_NET_MASK_QUESTION_ID QUESTION_ID (Keyword->ISCSIInitiatorNetmask)
56 #define ATTEMPT_INITIATOR_NET_MASK_VAR_OFFSET VAR_OFFSET (Keyword->ISCSIInitiatorNetmask)
57 #define ATTEMPT_INITIATOR_GATE_WAY_QUESTION_ID QUESTION_ID (Keyword->ISCSIInitiatorGateway)
58 #define ATTEMPT_INITIATOR_GATE_WAY_VAR_OFFSET VAR_OFFSET (Keyword->ISCSIInitiatorGateway)
59 #define ATTEMPT_TARGET_VIA_DHCP_QUESTION_ID QUESTION_ID (ISCSITargetInfoViaDHCP)
60 #define ATTEMPT_TARGET_VIA_DHCP_VAR_OFFSET VAR_OFFSET (ISCSITargetInfoViaDHCP)
61 #define ATTEMPT_TARGET_NAME_QUESTION_ID QUESTION_ID (Keyword->ISCSITargetName)
62 #define ATTEMPT_TARGET_NAME_VAR_OFFSET VAR_OFFSET (Keyword->ISCSITargetName)
63 #define ATTEMPT_TARGET_IP_ADDRESS_QUESTION_ID QUESTION_ID (Keyword->ISCSITargetIpAddress)
64 #define ATTEMPT_TARGET_IP_ADDRESS_VAR_OFFSET VAR_OFFSET (Keyword->ISCSITargetIpAddress)
65 #define ATTEMPT_TARGET_TCP_PORT_QUESTION_ID QUESTION_ID (ISCSITargetTcpPort)
66 #define ATTEMPT_TARGET_TCP_PORT_VAR_OFFSET VAR_OFFSET (ISCSITargetTcpPort)
67 #define ATTEMPT_LUN_QUESTION_ID QUESTION_ID (Keyword->ISCSILun)
68 #define ATTEMPT_LUN_VAR_OFFSET VAR_OFFSET (Keyword->ISCSILun)
69 #define ATTEMPT_AUTHENTICATION_METHOD_QUESTION_ID QUESTION_ID (ISCSIAuthenticationMethod)
70 #define ATTEMPT_AUTHENTICATION_METHOD_VAR_OFFSET VAR_OFFSET (ISCSIAuthenticationMethod)
71 #define ATTEMPT_CHARTYPE_QUESTION_ID QUESTION_ID (ISCSIChapType)
72 #define ATTEMPT_CHARTYPE_VAR_OFFSET VAR_OFFSET (ISCSIChapType)
73 #define ATTEMPT_CHAR_USER_NAME_QUESTION_ID QUESTION_ID (Keyword->ISCSIChapUsername)
74 #define ATTEMPT_CHAR_USER_NAME_VAR_OFFSET VAR_OFFSET (Keyword->ISCSIChapUsername)
75 #define ATTEMPT_CHAR_SECRET_QUESTION_ID QUESTION_ID (Keyword->ISCSIChapSecret)
76 #define ATTEMPT_CHAR_SECRET_VAR_OFFSET VAR_OFFSET (Keyword->ISCSIChapSecret)
77 #define ATTEMPT_CHAR_REVERSE_USER_NAME_QUESTION_ID QUESTION_ID (Keyword->ISCSIReverseChapUsername)
78 #define ATTEMPT_CHAR_REVERSE_USER_NAME_VAR_OFFSET VAR_OFFSET (Keyword->ISCSIReverseChapUsername)
79 #define ATTEMPT_CHAR_REVERSE_SECRET_QUESTION_ID QUESTION_ID (Keyword->ISCSIReverseChapSecret)
80 #define ATTEMPT_CHAR_REVERSE_SECRET_VAR_OFFSET VAR_OFFSET (Keyword->ISCSIReverseChapSecret)
82 #define ISCSI_INITATOR_NAME_VAR_NAME L"I_NAME"
84 #define ISCSI_CONFIG_VAR_ATTR (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE)
86 #define ISCSI_FORM_CALLBACK_INFO_SIGNATURE SIGNATURE_32 ('I', 'f', 'c', 'i')
88 #define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \
91 ISCSI_FORM_CALLBACK_INFO, \
93 ISCSI_FORM_CALLBACK_INFO_SIGNATURE \
97 struct _ISCSI_ATTEMPT_CONFIG_NVDATA
{
100 UINT8 AttemptConfigIndex
;
102 BOOLEAN ValidiBFTPath
;
104 UINT8 AutoConfigureMode
;
105 EFI_STRING_ID AttemptTitleToken
;
106 EFI_STRING_ID AttemptTitleHelpToken
;
107 CHAR8 AttemptName
[ATTEMPT_NAME_SIZE
];
108 CHAR8 MacString
[ISCSI_MAX_MAC_STRING_LEN
];
109 EFI_IP_ADDRESS PrimaryDns
;
110 EFI_IP_ADDRESS SecondaryDns
;
111 EFI_IP_ADDRESS DhcpServer
;
112 ISCSI_SESSION_CONFIG_NVDATA SessionConfigData
;
113 UINT8 AuthenticationType
;
115 ISCSI_CHAP_AUTH_CONFIG_NVDATA CHAP
;
117 BOOLEAN AutoConfigureSuccess
;
122 /// HII specific Vendor Device Path definition.
125 VENDOR_DEVICE_PATH VendorDevicePath
;
126 EFI_DEVICE_PATH_PROTOCOL End
;
127 } HII_VENDOR_DEVICE_PATH
;
131 struct _ISCSI_FORM_CALLBACK_INFO
{
133 EFI_HANDLE DriverHandle
;
134 EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess
;
137 EFI_HII_HANDLE RegisteredHandle
;
138 ISCSI_ATTEMPT_CONFIG_NVDATA
*Current
;
142 Create Hii Extend Label OpCode as the start opcode and end opcode. It is
145 @param[in] StartLabelNumber The number of start label.
146 @param[out] StartOpCodeHandle Points to the start opcode handle.
147 @param[out] StartLabel Points to the created start opcode.
148 @param[out] EndOpCodeHandle Points to the end opcode handle.
149 @param[out] EndLabel Points to the created end opcode.
151 @retval EFI_OUT_OF_RESOURCES Do not have sufficient resource to finish this
153 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
154 @retval EFI_SUCCESS The operation is completed successfully.
159 IN UINT16 StartLabelNumber
,
160 OUT VOID
**StartOpCodeHandle
,
161 OUT EFI_IFR_GUID_LABEL
**StartLabel
,
162 OUT VOID
**EndOpCodeHandle
,
163 OUT EFI_IFR_GUID_LABEL
**EndLabel
167 Initialize the iSCSI configuration form.
169 @param[in] DriverBindingHandle The iSCSI driverbinding handle.
171 @retval EFI_SUCCESS The iSCSI configuration form is initialized.
172 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
176 IScsiConfigFormInit (
177 IN EFI_HANDLE DriverBindingHandle
181 Unload the iSCSI configuration form, this includes: delete all the iSCSI
182 configuration entries, uninstall the form callback protocol, and
183 free the resources used.
185 @param[in] DriverBindingHandle The iSCSI driverbinding handle.
187 @retval EFI_SUCCESS The iSCSI configuration form is unloaded.
188 @retval Others Failed to unload the form.
192 IScsiConfigFormUnload (
193 IN EFI_HANDLE DriverBindingHandle
197 Update the MAIN form to display the configured attempts.
201 IScsiConfigUpdateAttempt (
206 Get the attempt config data from global structure by the ConfigIndex.
208 @param[in] AttemptConfigIndex The unique index indicates the attempt.
210 @return Pointer to the attempt config data.
211 @retval NULL The attempt configuration data can not be found.
214 ISCSI_ATTEMPT_CONFIG_NVDATA
*
215 IScsiConfigGetAttemptByConfigIndex (
216 IN UINT8 AttemptConfigIndex