NetworkPkg/IScsiDxe/IScsiConfigVfr.vfr

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