NetworkPkg/IScsiDxe/IScsiConfigVfr.vfr

   1 /** @file
   2   VFR file used by the iSCSI configuration component.
   3
   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
   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   class    = EFI_NETWORK_DEVICE_CLASS,
  24   subclass = 0x03,
  25
  26   varstore ISCSI_CONFIG_IFR_NVDATA,
  27     varid = CONFIGURATION_VARSTORE_ID,
  28     name = ISCSI_CONFIG_IFR_NVDATA,
  29     guid = ISCSI_CONFIG_GUID;
  30
  31   form formid = FORMID_MAIN_FORM,
  32     title  = STRING_TOKEN(STR_ISCSI_MAIN_FORM_TITLE);
  33
  34     string  varid   = ISCSI_CONFIG_IFR_NVDATA.InitiatorName,
  35             prompt  = STRING_TOKEN(STR_ISCSI_CONFIG_INIT_NAME),
  36             help    = STRING_TOKEN(STR_ISCSI_CONFIG_INIT_NAME_HELP),
  37             flags   = INTERACTIVE,
  38             key     = KEY_INITIATOR_NAME,
  39             minsize = ISCSI_NAME_IFR_MIN_SIZE,
  40             maxsize = ISCSI_NAME_IFR_MAX_SIZE,
  41     endstring;
  42
  43     subtitle text = STRING_TOKEN(STR_NULL);
  44
  45     goto FORMID_MAC_FORM,
  46          prompt = STRING_TOKEN(STR_ADD_ATTEMPT_ENTRY),
  47          help   = STRING_TOKEN(STR_ADD_ATTEMPT_ENTRY),
  48          flags  = INTERACTIVE,
  49          key    = KEY_ADD_ATTEMPT;
  50
  51     label ATTEMPT_ENTRY_LABEL;
  52     label LABEL_END;
  53
  54     subtitle text = STRING_TOKEN(STR_NULL);
  55
  56     goto FORMID_DELETE_FORM,
  57       prompt = STRING_TOKEN (STR_DEL_ATTEMPT_ENTRY),
  58       help   = STRING_TOKEN (STR_DEL_ATTEMPT_ENTRY_HELP),
  59       flags  = INTERACTIVE,
  60       key    = KEY_DELETE_ATTEMPT;
  61
  62     subtitle text = STRING_TOKEN(STR_NULL);
  63
  64     goto FORMID_ORDER_FORM,
  65       prompt = STRING_TOKEN (STR_ORDER_ATTEMPT_ENTRY),
  66       help   = STRING_TOKEN (STR_ORDER_ATTEMPT_ENTRY),
  67       flags  = INTERACTIVE,
  68       key    = KEY_ORDER_ATTEMPT_CONFIG;
  69
  70     subtitle text = STRING_TOKEN(STR_NULL);
  71
  72   endform;
  73
  74   form formid = FORMID_MAC_FORM,
  75     title  = STRING_TOKEN(STR_ISCSI_MAC_FORM_TITLE);
  76
  77     label MAC_ENTRY_LABEL;
  78     label LABEL_END;
  79
  80   endform;
  81
  82   form formid = FORMID_ORDER_FORM,
  83     title  = STRING_TOKEN(STR_ORDER_ATTEMPT_ENTRY);
  84
  85     label ORDER_ENTRY_LABEL;
  86     label LABEL_END;
  87
  88     text
  89       help   = STRING_TOKEN (STR_SAVE_AND_EXIT),
  90       text   = STRING_TOKEN (STR_SAVE_AND_EXIT),
  91       flags  = INTERACTIVE,
  92       key    = KEY_SAVE_ORDER_CHANGES;
  93
  94     text
  95       help   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
  96       text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
  97       flags  = INTERACTIVE,
  98       key    = KEY_IGNORE_ORDER_CHANGES;
  99   endform;
 100
 101   form formid = FORMID_DELETE_FORM,
 102     title  = STRING_TOKEN(STR_DEL_ATTEMPT_ENTRY);
 103
 104     label DELETE_ENTRY_LABEL;
 105     label LABEL_END;
 106
 107     text
 108       help   = STRING_TOKEN (STR_SAVE_AND_EXIT),
 109       text   = STRING_TOKEN (STR_SAVE_AND_EXIT),
 110       flags  = INTERACTIVE,
 111       key    = KEY_SAVE_DELETE_ATTEMPT;
 112
 113     text
 114       help   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
 115       text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
 116       flags  = INTERACTIVE,
 117       key    = KEY_IGNORE_DELETE_ATTEMPT;
 118   endform;
 119
 120   form formid = FORMID_ATTEMPT_FORM,
 121     title  = STRING_TOKEN(STR_ISCSI_ATTEMPT_FORM_TITLE);
 122
 123     string  varid   = ISCSI_CONFIG_IFR_NVDATA.AttemptName,
 124             prompt  = STRING_TOKEN(STR_ISCSI_ATTEMPT_NAME),
 125             help    = STRING_TOKEN(STR_ISCSI_ATTEMPT_NAME_HELP),
 126             flags   = INTERACTIVE,
 127             key     = KEY_ATTEMPT_NAME,
 128             minsize = 0,
 129             maxsize = ATTEMPT_NAME_MAX_SIZE,
 130     endstring;
 131
 132     subtitle text = STRING_TOKEN(STR_NULL);
 133
 134     oneof varid  = ISCSI_CONFIG_IFR_NVDATA.Enabled,
 135           prompt = STRING_TOKEN(STR_ISCSI_MODE_PROMPT),
 136           help   = STRING_TOKEN(STR_ISCSI_MODE_HELP),
 137           option text = STRING_TOKEN(STR_ISCSI_MODE_DISABLED),         value = ISCSI_DISABLED,         flags = DEFAULT;
 138           option text = STRING_TOKEN(STR_ISCSI_MODE_ENABLED),          value = ISCSI_ENABLED,          flags = 0;
 139           option text = STRING_TOKEN(STR_ISCSI_MODE_ENABLED_FOR_MPIO), value = ISCSI_ENABLED_FOR_MPIO, flags = 0;
 140     endoneof;
 141
 142     subtitle text = STRING_TOKEN(STR_NULL);
 143
 144     oneof varid  = ISCSI_CONFIG_IFR_NVDATA.IpMode,
 145           questionid = KEY_IP_MODE,
 146           prompt = STRING_TOKEN(STR_IP_MODE_PROMPT),
 147           help   = STRING_TOKEN(STR_IP_MODE_HELP),
 148           option text = STRING_TOKEN(STR_IP_MODE_IP4),        value = IP_MODE_IP4,        flags = INTERACTIVE;
 149           option text = STRING_TOKEN(STR_IP_MODE_IP6),        value = IP_MODE_IP6,        flags = INTERACTIVE;
 150           option text = STRING_TOKEN(STR_IP_MODE_AUTOCONFIG), value = IP_MODE_AUTOCONFIG, flags = INTERACTIVE;
 151     endoneof;
 152
 153     subtitle text = STRING_TOKEN(STR_NULL);
 154
 155     numeric varid   = ISCSI_CONFIG_IFR_NVDATA.ConnectRetryCount,
 156             prompt  = STRING_TOKEN(STR_ISCSI_CONFIG_RETRY),
 157             help    = STRING_TOKEN(STR_ISCSI_CONFIG_RETRY_HELP),
 158             flags   = 0,
 159             minimum = CONNECT_MIN_RETRY,
 160             maximum = CONNECT_MAX_RETRY,
 161             step    = 0,
 162     endnumeric;
 163
 164     numeric varid   = ISCSI_CONFIG_IFR_NVDATA.ConnectTimeout,
 165             prompt  = STRING_TOKEN(STR_ISCSI_CONFIG_TIMEOUT),
 166             help    = STRING_TOKEN(STR_ISCSI_CONFIG_TIMEOUT_HELP),
 167             flags   = 0,
 168             minimum = CONNECT_MIN_TIMEOUT,
 169             maximum = CONNECT_MAX_TIMEOUT,
 170             step    = 0,
 171             default = CONNECT_DEFAULT_TIMEOUT,
 172     endnumeric;
 173
 174     subtitle text = STRING_TOKEN(STR_NULL);
 175
 176     string  varid   = ISCSI_CONFIG_IFR_NVDATA.IsId,
 177             prompt  = STRING_TOKEN(STR_ISCSI_CONFIG_ISID),
 178             help    = STRING_TOKEN(STR_ISCSI_CONFIG_ISID_HELP),
 179             flags   = INTERACTIVE,
 180             key     = KEY_CONFIG_ISID,
 181             minsize = ISID_CONFIGURABLE_MIN_LEN,
 182             maxsize = ISID_CONFIGURABLE_MAX_LEN,
 183     endstring;
 184
 185     subtitle text = STRING_TOKEN(STR_NULL);
 186
 187     suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;
 188     checkbox varid = ISCSI_CONFIG_IFR_NVDATA.InitiatorInfoFromDhcp,
 189             prompt = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP),
 190             help   = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP),
 191             flags  = INTERACTIVE,
 192             key    = KEY_DHCP_ENABLE,
 193     endcheckbox;
 194     endif;
 195
 196     suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.InitiatorInfoFromDhcp == 0x01 OR
 197                ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_IP6 OR
 198                ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;
 199     string  varid   = ISCSI_CONFIG_IFR_NVDATA.LocalIp,
 200             prompt  = STRING_TOKEN(STR_ISCSI_LOCAL_IP_ADDRESS),
 201             help    = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),
 202             flags   = INTERACTIVE,
 203             key     = KEY_LOCAL_IP,
 204             minsize = IP4_MIN_SIZE,
 205             maxsize = IP4_MAX_SIZE,
 206     endstring;
 207
 208     string  varid   = ISCSI_CONFIG_IFR_NVDATA.SubnetMask,
 209             prompt  = STRING_TOKEN(STR_ISCSI_LOCAL_MASK),
 210             help    = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),
 211             flags   = INTERACTIVE,
 212             key     = KEY_SUBNET_MASK,
 213             minsize = IP4_MIN_SIZE,
 214             maxsize = IP4_MAX_SIZE,
 215     endstring;
 216
 217     string  varid   = ISCSI_CONFIG_IFR_NVDATA.Gateway,
 218             prompt  = STRING_TOKEN(STR_ISCSI_LOCAL_GATEWAY),
 219             help    = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),
 220             flags   = INTERACTIVE,
 221             key     = KEY_GATE_WAY,
 222             minsize = IP4_MIN_SIZE,
 223             maxsize = IP4_MAX_SIZE,
 224     endstring;
 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_IP_ADDRESS),
 255             help    = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),
 256             flags   = INTERACTIVE,
 257             key     = KEY_TARGET_IP,
 258             minsize = IP_MIN_SIZE,
 259             maxsize = IP_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     subtitle text = STRING_TOKEN(STR_NULL);
 348
 349     text
 350       help   = STRING_TOKEN (STR_SAVE_CHANGES_HELP),
 351       text   = STRING_TOKEN (STR_SAVE_CHANGES),
 352       flags  = INTERACTIVE,
 353       key    = KEY_SAVE_ATTEMPT_CONFIG;
 354
 355     goto FORMID_MAIN_FORM,
 356     prompt = STRING_TOKEN (STR_RETURN_MAIN_FORM),
 357     help   = STRING_TOKEN (STR_RETURN_MAIN_FORM),
 358     flags  = 0;
 359
 360   endform;
 361
 362 endformset;
 363