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