]> git.proxmox.com Git - mirror_edk2.git/blame - NetworkPkg/IScsiDxe/IScsiConfigVfr.vfr
NetworkPkg:Add scriptable configuration to iSCSI driver by leveraging x-UEFI.
[mirror_edk2.git] / NetworkPkg / IScsiDxe / IScsiConfigVfr.vfr
CommitLineData
4c5a5e0c 1/** @file\r
2 VFR file used by the iSCSI configuration component.\r
3 \r
eabc6e59 4Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>\r
4c5a5e0c 5This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "IScsiConfigNVDataStruc.h"\r
16\r
17#define EFI_NETWORK_DEVICE_CLASS 0x04\r
18\r
19formset\r
20 guid = ISCSI_CONFIG_GUID,\r
21 title = STRING_TOKEN(STR_ISCSI_CONFIG_FORM_TITLE),\r
22 help = STRING_TOKEN(STR_ISCSI_CONFIG_FORM_HELP),\r
4c5a5e0c 23\r
24 varstore ISCSI_CONFIG_IFR_NVDATA,\r
25 varid = CONFIGURATION_VARSTORE_ID,\r
26 name = ISCSI_CONFIG_IFR_NVDATA,\r
27 guid = ISCSI_CONFIG_GUID;\r
28\r
29 form formid = FORMID_MAIN_FORM,\r
30 title = STRING_TOKEN(STR_ISCSI_MAIN_FORM_TITLE);\r
31\r
32 string varid = ISCSI_CONFIG_IFR_NVDATA.InitiatorName,\r
33 prompt = STRING_TOKEN(STR_ISCSI_CONFIG_INIT_NAME),\r
34 help = STRING_TOKEN(STR_ISCSI_CONFIG_INIT_NAME_HELP),\r
35 flags = INTERACTIVE,\r
36 key = KEY_INITIATOR_NAME,\r
37 minsize = ISCSI_NAME_IFR_MIN_SIZE,\r
38 maxsize = ISCSI_NAME_IFR_MAX_SIZE,\r
39 endstring;\r
40\r
41 subtitle text = STRING_TOKEN(STR_NULL);\r
42\r
43 goto FORMID_MAC_FORM,\r
44 prompt = STRING_TOKEN(STR_ADD_ATTEMPT_ENTRY),\r
45 help = STRING_TOKEN(STR_ADD_ATTEMPT_ENTRY),\r
46 flags = INTERACTIVE,\r
47 key = KEY_ADD_ATTEMPT;\r
48\r
49 label ATTEMPT_ENTRY_LABEL;\r
50 label LABEL_END;\r
51\r
52 subtitle text = STRING_TOKEN(STR_NULL);\r
53\r
54 goto FORMID_DELETE_FORM,\r
55 prompt = STRING_TOKEN (STR_DEL_ATTEMPT_ENTRY),\r
56 help = STRING_TOKEN (STR_DEL_ATTEMPT_ENTRY_HELP),\r
57 flags = INTERACTIVE,\r
58 key = KEY_DELETE_ATTEMPT;\r
59\r
60 subtitle text = STRING_TOKEN(STR_NULL);\r
61\r
62 goto FORMID_ORDER_FORM,\r
63 prompt = STRING_TOKEN (STR_ORDER_ATTEMPT_ENTRY),\r
64 help = STRING_TOKEN (STR_ORDER_ATTEMPT_ENTRY),\r
65 flags = INTERACTIVE,\r
66 key = KEY_ORDER_ATTEMPT_CONFIG;\r
67\r
68 subtitle text = STRING_TOKEN(STR_NULL);\r
69\r
70 endform;\r
71\r
72 form formid = FORMID_MAC_FORM,\r
73 title = STRING_TOKEN(STR_ISCSI_MAC_FORM_TITLE);\r
74\r
75 label MAC_ENTRY_LABEL;\r
76 label LABEL_END;\r
77\r
78 endform;\r
79\r
80 form formid = FORMID_ORDER_FORM,\r
81 title = STRING_TOKEN(STR_ORDER_ATTEMPT_ENTRY);\r
82\r
83 label ORDER_ENTRY_LABEL;\r
84 label LABEL_END;\r
85\r
639a76d1 86 text\r
4c5a5e0c 87 help = STRING_TOKEN (STR_SAVE_AND_EXIT),\r
639a76d1 88 text = STRING_TOKEN (STR_SAVE_AND_EXIT),\r
4c5a5e0c 89 flags = INTERACTIVE,\r
90 key = KEY_SAVE_ORDER_CHANGES;\r
639a76d1
ED
91\r
92 text\r
4c5a5e0c 93 help = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),\r
639a76d1 94 text = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),\r
4c5a5e0c 95 flags = INTERACTIVE,\r
96 key = KEY_IGNORE_ORDER_CHANGES;\r
4c5a5e0c 97 endform;\r
98\r
99 form formid = FORMID_DELETE_FORM,\r
100 title = STRING_TOKEN(STR_DEL_ATTEMPT_ENTRY);\r
101\r
102 label DELETE_ENTRY_LABEL;\r
103 label LABEL_END;\r
104\r
639a76d1 105 text\r
4c5a5e0c 106 help = STRING_TOKEN (STR_SAVE_AND_EXIT),\r
639a76d1 107 text = STRING_TOKEN (STR_SAVE_AND_EXIT),\r
4c5a5e0c 108 flags = INTERACTIVE,\r
109 key = KEY_SAVE_DELETE_ATTEMPT;\r
639a76d1
ED
110\r
111 text\r
4c5a5e0c 112 help = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),\r
639a76d1 113 text = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),\r
4c5a5e0c 114 flags = INTERACTIVE,\r
115 key = KEY_IGNORE_DELETE_ATTEMPT;\r
4c5a5e0c 116 endform; \r
117\r
118 form formid = FORMID_ATTEMPT_FORM,\r
119 title = STRING_TOKEN(STR_ISCSI_ATTEMPT_FORM_TITLE);\r
120\r
121 string varid = ISCSI_CONFIG_IFR_NVDATA.AttemptName,\r
122 prompt = STRING_TOKEN(STR_ISCSI_ATTEMPT_NAME),\r
123 help = STRING_TOKEN(STR_ISCSI_ATTEMPT_NAME_HELP),\r
8d1f5e04 124 flags = READ_ONLY,\r
4c5a5e0c 125 key = KEY_ATTEMPT_NAME,\r
126 minsize = 0,\r
8d1f5e04 127 maxsize = ATTEMPT_NAME_SIZE,\r
4c5a5e0c 128 endstring;\r
129\r
130 subtitle text = STRING_TOKEN(STR_NULL);\r
131\r
132 oneof varid = ISCSI_CONFIG_IFR_NVDATA.Enabled,\r
133 prompt = STRING_TOKEN(STR_ISCSI_MODE_PROMPT),\r
134 help = STRING_TOKEN(STR_ISCSI_MODE_HELP),\r
135 option text = STRING_TOKEN(STR_ISCSI_MODE_DISABLED), value = ISCSI_DISABLED, flags = DEFAULT;\r
136 option text = STRING_TOKEN(STR_ISCSI_MODE_ENABLED), value = ISCSI_ENABLED, flags = 0;\r
137 option text = STRING_TOKEN(STR_ISCSI_MODE_ENABLED_FOR_MPIO), value = ISCSI_ENABLED_FOR_MPIO, flags = 0;\r
138 endoneof;\r
139\r
140 subtitle text = STRING_TOKEN(STR_NULL);\r
141\r
142 oneof varid = ISCSI_CONFIG_IFR_NVDATA.IpMode,\r
143 questionid = KEY_IP_MODE,\r
144 prompt = STRING_TOKEN(STR_IP_MODE_PROMPT),\r
145 help = STRING_TOKEN(STR_IP_MODE_HELP),\r
146 option text = STRING_TOKEN(STR_IP_MODE_IP4), value = IP_MODE_IP4, flags = INTERACTIVE;\r
147 option text = STRING_TOKEN(STR_IP_MODE_IP6), value = IP_MODE_IP6, flags = INTERACTIVE;\r
148 option text = STRING_TOKEN(STR_IP_MODE_AUTOCONFIG), value = IP_MODE_AUTOCONFIG, flags = INTERACTIVE;\r
149 endoneof;\r
150\r
151 subtitle text = STRING_TOKEN(STR_NULL);\r
152\r
153 numeric varid = ISCSI_CONFIG_IFR_NVDATA.ConnectRetryCount,\r
154 prompt = STRING_TOKEN(STR_ISCSI_CONFIG_RETRY),\r
155 help = STRING_TOKEN(STR_ISCSI_CONFIG_RETRY_HELP),\r
156 flags = 0,\r
157 minimum = CONNECT_MIN_RETRY,\r
158 maximum = CONNECT_MAX_RETRY,\r
159 step = 0,\r
160 endnumeric; \r
161 \r
162 numeric varid = ISCSI_CONFIG_IFR_NVDATA.ConnectTimeout,\r
163 prompt = STRING_TOKEN(STR_ISCSI_CONFIG_TIMEOUT),\r
164 help = STRING_TOKEN(STR_ISCSI_CONFIG_TIMEOUT_HELP),\r
165 flags = 0,\r
166 minimum = CONNECT_MIN_TIMEOUT,\r
167 maximum = CONNECT_MAX_TIMEOUT,\r
168 step = 0,\r
169 default = CONNECT_DEFAULT_TIMEOUT,\r
170 endnumeric;\r
171\r
172 subtitle text = STRING_TOKEN(STR_NULL);\r
173\r
174 string varid = ISCSI_CONFIG_IFR_NVDATA.IsId, \r
175 prompt = STRING_TOKEN(STR_ISCSI_CONFIG_ISID),\r
176 help = STRING_TOKEN(STR_ISCSI_CONFIG_ISID_HELP),\r
177 flags = INTERACTIVE,\r
178 key = KEY_CONFIG_ISID,\r
179 minsize = ISID_CONFIGURABLE_MIN_LEN,\r
180 maxsize = ISID_CONFIGURABLE_MAX_LEN,\r
181 endstring;\r
182\r
183 subtitle text = STRING_TOKEN(STR_NULL);\r
184\r
185 suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;\r
186 checkbox varid = ISCSI_CONFIG_IFR_NVDATA.InitiatorInfoFromDhcp,\r
187 prompt = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP),\r
188 help = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP),\r
189 flags = INTERACTIVE,\r
190 key = KEY_DHCP_ENABLE,\r
191 endcheckbox;\r
192 endif;\r
193\r
194 suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.InitiatorInfoFromDhcp == 0x01 OR\r
195 ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_IP6 OR \r
196 ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;\r
197 string varid = ISCSI_CONFIG_IFR_NVDATA.LocalIp,\r
198 prompt = STRING_TOKEN(STR_ISCSI_LOCAL_IP_ADDRESS),\r
199 help = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),\r
200 flags = INTERACTIVE,\r
201 key = KEY_LOCAL_IP,\r
202 minsize = IP4_MIN_SIZE,\r
203 maxsize = IP4_MAX_SIZE,\r
204 endstring;\r
205\r
206 string varid = ISCSI_CONFIG_IFR_NVDATA.SubnetMask,\r
207 prompt = STRING_TOKEN(STR_ISCSI_LOCAL_MASK),\r
208 help = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),\r
209 flags = INTERACTIVE,\r
210 key = KEY_SUBNET_MASK,\r
211 minsize = IP4_MIN_SIZE,\r
212 maxsize = IP4_MAX_SIZE,\r
213 endstring;\r
214\r
215 string varid = ISCSI_CONFIG_IFR_NVDATA.Gateway,\r
216 prompt = STRING_TOKEN(STR_ISCSI_LOCAL_GATEWAY),\r
217 help = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),\r
218 flags = INTERACTIVE,\r
219 key = KEY_GATE_WAY,\r
220 minsize = IP4_MIN_SIZE,\r
221 maxsize = IP4_MAX_SIZE,\r
222 endstring;\r
223 \r
224 endif;\r
225\r
226 suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;\r
227 subtitle text = STRING_TOKEN(STR_NULL);\r
228 endif; \r
229\r
230 suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG OR\r
231 ideqval ISCSI_CONFIG_IFR_NVDATA.InitiatorInfoFromDhcp == 0x00;\r
232 checkbox varid = ISCSI_CONFIG_IFR_NVDATA.TargetInfoFromDhcp,\r
233 prompt = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP_ON_TARGET),\r
234 help = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP_ON_TARGET),\r
235 flags = 0,\r
236 endcheckbox;\r
237 endif;\r
238\r
239 suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG OR\r
240 ideqval ISCSI_CONFIG_IFR_NVDATA.TargetInfoFromDhcp == 0x01;\r
241\r
242 string varid = ISCSI_CONFIG_IFR_NVDATA.TargetName,\r
243 prompt = STRING_TOKEN(STR_ISCSI_TARGET_NAME),\r
244 help = STRING_TOKEN(STR_ISCSI_TARGET_NAME_HELP),\r
245 flags = INTERACTIVE,\r
246 key = KEY_TARGET_NAME,\r
247 minsize = ISCSI_NAME_IFR_MIN_SIZE,\r
248 maxsize = ISCSI_NAME_IFR_MAX_SIZE,\r
249 endstring;\r
250\r
251 string varid = ISCSI_CONFIG_IFR_NVDATA.TargetIp,\r
eabc6e59
ZL
252 prompt = STRING_TOKEN(STR_ISCSI_TARGET_ADDRESS),\r
253 help = STRING_TOKEN(STR_ISCSI_TARGET_ADDRESS_HELP),\r
4c5a5e0c 254 flags = INTERACTIVE,\r
255 key = KEY_TARGET_IP,\r
eabc6e59
ZL
256 minsize = ISCSI_TARGET_URI_MIN_SIZE,\r
257 maxsize = ISCSI_TARGET_URI_MAX_SIZE,\r
4c5a5e0c 258 endstring;\r
259\r
260 numeric varid = ISCSI_CONFIG_IFR_NVDATA.TargetPort,\r
261 prompt = STRING_TOKEN(STR_ISCSI_TARGET_PORT),\r
262 help = STRING_TOKEN(STR_ISCSI_TARGET_PORT),\r
263 flags = 0,\r
264 minimum = TARGET_PORT_MIN_NUM,\r
265 maximum = TARGET_PORT_MAX_NUM,\r
266 step = 0,\r
267 endnumeric;\r
268\r
269 string varid = ISCSI_CONFIG_IFR_NVDATA.BootLun,\r
270 prompt = STRING_TOKEN(STR_ISCSI_BOOT_LUN),\r
271 help = STRING_TOKEN(STR_ISCSI_BOOT_LUN_HELP),\r
272 flags = INTERACTIVE,\r
273 key = KEY_BOOT_LUN,\r
274 minsize = LUN_MIN_SIZE,\r
275 maxsize = LUN_MAX_SIZE,\r
276 endstring;\r
277 \r
278 endif;\r
279\r
280 suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;\r
281 subtitle text = STRING_TOKEN(STR_NULL);\r
282 endif; \r
283\r
284 oneof varid = ISCSI_CONFIG_IFR_NVDATA.AuthenticationType,\r
285 questionid = KEY_AUTH_TYPE, \r
286 prompt = STRING_TOKEN(STR_AUTHEN_TYPE_PROMPT),\r
287 help = STRING_TOKEN(STR_AUTHEN_TYPE_HELP),\r
288 option text = STRING_TOKEN(STR_AUTHEN_TYPE_CHAP), value = ISCSI_AUTH_TYPE_CHAP, flags = 0;\r
289 option text = STRING_TOKEN(STR_AUTHEN_TYPE_NONE), value = ISCSI_AUTH_TYPE_NONE, flags = DEFAULT;\r
290 endoneof;\r
291\r
292 suppressif NOT ideqval ISCSI_CONFIG_IFR_NVDATA.AuthenticationType == ISCSI_AUTH_TYPE_CHAP; \r
293 oneof varid = ISCSI_CONFIG_IFR_NVDATA.CHAPType,\r
294 prompt = STRING_TOKEN(STR_CHAP_TYPE_PROMPT),\r
295 help = STRING_TOKEN(STR_CHAP_TYPE_HELP),\r
296 option text = STRING_TOKEN(STR_CHAP_TYPE_UNI), value = ISCSI_CHAP_UNI, flags = 0;\r
297 option text = STRING_TOKEN(STR_CHAP_TYPE_MUTUAL), value = ISCSI_CHAP_MUTUAL, flags = DEFAULT;\r
298 endoneof;\r
299 endif;\r
300\r
301 suppressif NOT ideqval ISCSI_CONFIG_IFR_NVDATA.AuthenticationType == ISCSI_AUTH_TYPE_CHAP;\r
302 string varid = ISCSI_CONFIG_IFR_NVDATA.CHAPName,\r
303 prompt = STRING_TOKEN(STR_ISCSI_CHAP_NAME),\r
304 help = STRING_TOKEN(STR_ISCSI_CHAP_NAME),\r
305 flags = INTERACTIVE,\r
306 key = KEY_CHAP_NAME,\r
307 minsize = 0,\r
308 maxsize = ISCSI_CHAP_NAME_MAX_LEN,\r
309 endstring;\r
310\r
311 string varid = ISCSI_CONFIG_IFR_NVDATA.CHAPSecret,\r
312 prompt = STRING_TOKEN(STR_ISCSI_CHAP_SECRET),\r
313 help = STRING_TOKEN(STR_ISCSI_CHAP_SECRET_HELP),\r
314 flags = INTERACTIVE,\r
315 key = KEY_CHAP_SECRET,\r
316 minsize = ISCSI_CHAP_SECRET_MIN_LEN,\r
317 maxsize = ISCSI_CHAP_SECRET_MAX_LEN,\r
318 endstring;\r
319\r
320 endif;\r
321\r
322 suppressif NOT ideqval ISCSI_CONFIG_IFR_NVDATA.AuthenticationType == ISCSI_AUTH_TYPE_CHAP OR\r
323 NOT ideqval ISCSI_CONFIG_IFR_NVDATA.CHAPType == ISCSI_CHAP_MUTUAL;\r
324\r
325 string varid = ISCSI_CONFIG_IFR_NVDATA.ReverseCHAPName,\r
326 prompt = STRING_TOKEN(STR_ISCSI_REVERSE_CHAP_NAME),\r
327 help = STRING_TOKEN(STR_ISCSI_REVERSE_CHAP_NAME),\r
328 flags = INTERACTIVE,\r
329 key = KEY_REVERSE_CHAP_NAME,\r
330 minsize = 0,\r
331 maxsize = ISCSI_CHAP_NAME_MAX_LEN,\r
332 endstring;\r
333\r
334 string varid = ISCSI_CONFIG_IFR_NVDATA.ReverseCHAPSecret,\r
335 prompt = STRING_TOKEN(STR_ISCSI_REVERSE_CHAP_SECRET),\r
336 help = STRING_TOKEN(STR_ISCSI_CHAP_SECRET_HELP),\r
337 flags = INTERACTIVE,\r
338 key = KEY_REVERSE_CHAP_SECRET,\r
339 minsize = ISCSI_CHAP_SECRET_MIN_LEN,\r
340 maxsize = ISCSI_CHAP_SECRET_MAX_LEN,\r
341 endstring;\r
342\r
343 endif;\r
344\r
8d1f5e04
ZL
345 suppressif TRUE;\r
346\r
347 string varid = ISCSI_CONFIG_IFR_NVDATA.ISCSIMacAddr,\r
348 prompt = STRING_TOKEN(STR_ISCSI_MAC_PROMPT),\r
349 help = STRING_TOKEN(STR_ISCSI_MAC_PROMPT),\r
350 minsize = 0,\r
351 maxsize = ISCSI_MAX_MAC_STRING_LEN,\r
352 endstring;\r
353\r
354 string varid = ISCSI_CONFIG_IFR_NVDATA.ISCSIAttemptOrder,\r
355 prompt = STRING_TOKEN(STR_ISCSI_ATTEMPT_ORDER),\r
356 help = STRING_TOKEN(STR_ISCSI_ATTEMPT_ORDER),\r
357 minsize = 0,\r
358 maxsize = ATTEMPT_NAME_LIST_SIZE,\r
359 endstring;\r
360\r
361 string varid = ISCSI_CONFIG_IFR_NVDATA.ISCSIAddAttemptList,\r
362 prompt = STRING_TOKEN(STR_ISCSI_ADD_ATTEMPTS),\r
363 help = STRING_TOKEN(STR_ISCSI_ADD_ATTEMPTS),\r
364 minsize = 0,\r
365 maxsize = ATTEMPT_NAME_LIST_SIZE,\r
366 endstring;\r
367\r
368 string varid = ISCSI_CONFIG_IFR_NVDATA.ISCSIDeleteAttemptList,\r
369 prompt = STRING_TOKEN(STR_ISCSI_DELETE_ATTEMPTS),\r
370 help = STRING_TOKEN(STR_ISCSI_DELETE_ATTEMPTS),\r
371 minsize = 0,\r
372 maxsize = ATTEMPT_NAME_LIST_SIZE,\r
373 endstring;\r
374\r
375 string varid = ISCSI_CONFIG_IFR_NVDATA.ISCSIDisplayAttemptList,\r
376 prompt = STRING_TOKEN(STR_ISCSI_DISPLAY_ATTEMPTS),\r
377 help = STRING_TOKEN(STR_ISCSI_DISPLAY_ATTEMPTS),\r
378 flags = READ_ONLY,\r
379 minsize = 0,\r
380 maxsize = ATTEMPT_NAME_LIST_SIZE,\r
381 endstring;\r
382\r
383 label KEYWORD_ENTRY_LABEL;\r
384 label LABEL_END;\r
385 endif;\r
386\r
4c5a5e0c 387 subtitle text = STRING_TOKEN(STR_NULL);\r
388\r
639a76d1
ED
389 text\r
390 help = STRING_TOKEN (STR_SAVE_CHANGES_HELP),\r
391 text = STRING_TOKEN (STR_SAVE_CHANGES),\r
639a76d1
ED
392 flags = INTERACTIVE,\r
393 key = KEY_SAVE_ATTEMPT_CONFIG;\r
394 \r
4c5a5e0c 395 goto FORMID_MAIN_FORM,\r
396 prompt = STRING_TOKEN (STR_RETURN_MAIN_FORM),\r
397 help = STRING_TOKEN (STR_RETURN_MAIN_FORM),\r
398 flags = 0;\r
399\r
400 endform;\r
401\r
402endformset;\r
403\r