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         text   = STRING_TOKEN (STR_SAVE_AND_EXIT),
  92       flags  = INTERACTIVE,
  93       key    = KEY_SAVE_ORDER_CHANGES;
  94
  95     text
  96       help   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
  97       text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
  98         text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
  99       flags  = INTERACTIVE,
 100       key    = KEY_IGNORE_ORDER_CHANGES;
 101   endform;
 102
 103   form formid = FORMID_DELETE_FORM,
 104     title  = STRING_TOKEN(STR_DEL_ATTEMPT_ENTRY);
 105
 106     label DELETE_ENTRY_LABEL;
 107     label LABEL_END;
 108
 109     text
 110       help   = STRING_TOKEN (STR_SAVE_AND_EXIT),
 111       text   = STRING_TOKEN (STR_SAVE_AND_EXIT),
 112         text   = STRING_TOKEN (STR_SAVE_AND_EXIT),
 113       flags  = INTERACTIVE,
 114       key    = KEY_SAVE_DELETE_ATTEMPT;
 115
 116     text
 117       help   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
 118       text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
 119         text   = STRING_TOKEN (STR_NO_SAVE_AND_EXIT),
 120       flags  = INTERACTIVE,
 121       key    = KEY_IGNORE_DELETE_ATTEMPT;
 122   endform;
 123
 124   form formid = FORMID_ATTEMPT_FORM,
 125     title  = STRING_TOKEN(STR_ISCSI_ATTEMPT_FORM_TITLE);
 126
 127     string  varid   = ISCSI_CONFIG_IFR_NVDATA.AttemptName,
 128             prompt  = STRING_TOKEN(STR_ISCSI_ATTEMPT_NAME),
 129             help    = STRING_TOKEN(STR_ISCSI_ATTEMPT_NAME_HELP),
 130             flags   = INTERACTIVE,
 131             key     = KEY_ATTEMPT_NAME,
 132             minsize = 0,
 133             maxsize = ATTEMPT_NAME_MAX_SIZE,
 134     endstring;
 135
 136     subtitle text = STRING_TOKEN(STR_NULL);
 137
 138     oneof varid  = ISCSI_CONFIG_IFR_NVDATA.Enabled,
 139           prompt = STRING_TOKEN(STR_ISCSI_MODE_PROMPT),
 140           help   = STRING_TOKEN(STR_ISCSI_MODE_HELP),
 141           option text = STRING_TOKEN(STR_ISCSI_MODE_DISABLED),         value = ISCSI_DISABLED,         flags = DEFAULT;
 142           option text = STRING_TOKEN(STR_ISCSI_MODE_ENABLED),          value = ISCSI_ENABLED,          flags = 0;
 143           option text = STRING_TOKEN(STR_ISCSI_MODE_ENABLED_FOR_MPIO), value = ISCSI_ENABLED_FOR_MPIO, flags = 0;
 144     endoneof;
 145
 146     subtitle text = STRING_TOKEN(STR_NULL);
 147
 148     oneof varid  = ISCSI_CONFIG_IFR_NVDATA.IpMode,
 149           questionid = KEY_IP_MODE,
 150           prompt = STRING_TOKEN(STR_IP_MODE_PROMPT),
 151           help   = STRING_TOKEN(STR_IP_MODE_HELP),
 152           option text = STRING_TOKEN(STR_IP_MODE_IP4),        value = IP_MODE_IP4,        flags = INTERACTIVE;
 153           option text = STRING_TOKEN(STR_IP_MODE_IP6),        value = IP_MODE_IP6,        flags = INTERACTIVE;
 154           option text = STRING_TOKEN(STR_IP_MODE_AUTOCONFIG), value = IP_MODE_AUTOCONFIG, flags = INTERACTIVE;
 155     endoneof;
 156
 157     subtitle text = STRING_TOKEN(STR_NULL);
 158
 159     numeric varid   = ISCSI_CONFIG_IFR_NVDATA.ConnectRetryCount,
 160             prompt  = STRING_TOKEN(STR_ISCSI_CONFIG_RETRY),
 161             help    = STRING_TOKEN(STR_ISCSI_CONFIG_RETRY_HELP),
 162             flags   = 0,
 163             minimum = CONNECT_MIN_RETRY,
 164             maximum = CONNECT_MAX_RETRY,
 165             step    = 0,
 166     endnumeric;
 167
 168     numeric varid   = ISCSI_CONFIG_IFR_NVDATA.ConnectTimeout,
 169             prompt  = STRING_TOKEN(STR_ISCSI_CONFIG_TIMEOUT),
 170             help    = STRING_TOKEN(STR_ISCSI_CONFIG_TIMEOUT_HELP),
 171             flags   = 0,
 172             minimum = CONNECT_MIN_TIMEOUT,
 173             maximum = CONNECT_MAX_TIMEOUT,
 174             step    = 0,
 175             default = CONNECT_DEFAULT_TIMEOUT,
 176     endnumeric;
 177
 178     subtitle text = STRING_TOKEN(STR_NULL);
 179
 180     string  varid   = ISCSI_CONFIG_IFR_NVDATA.IsId,
 181             prompt  = STRING_TOKEN(STR_ISCSI_CONFIG_ISID),
 182             help    = STRING_TOKEN(STR_ISCSI_CONFIG_ISID_HELP),
 183             flags   = INTERACTIVE,
 184             key     = KEY_CONFIG_ISID,
 185             minsize = ISID_CONFIGURABLE_MIN_LEN,
 186             maxsize = ISID_CONFIGURABLE_MAX_LEN,
 187     endstring;
 188
 189     subtitle text = STRING_TOKEN(STR_NULL);
 190
 191     suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;
 192     checkbox varid = ISCSI_CONFIG_IFR_NVDATA.InitiatorInfoFromDhcp,
 193             prompt = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP),
 194             help   = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP),
 195             flags  = INTERACTIVE,
 196             key    = KEY_DHCP_ENABLE,
 197     endcheckbox;
 198     endif;
 199
 200     suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.InitiatorInfoFromDhcp == 0x01 OR
 201                ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_IP6 OR
 202                ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;
 203     string  varid   = ISCSI_CONFIG_IFR_NVDATA.LocalIp,
 204             prompt  = STRING_TOKEN(STR_ISCSI_LOCAL_IP_ADDRESS),
 205             help    = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),
 206             flags   = INTERACTIVE,
 207             key     = KEY_LOCAL_IP,
 208             minsize = IP4_MIN_SIZE,
 209             maxsize = IP4_MAX_SIZE,
 210     endstring;
 211
 212     string  varid   = ISCSI_CONFIG_IFR_NVDATA.SubnetMask,
 213             prompt  = STRING_TOKEN(STR_ISCSI_LOCAL_MASK),
 214             help    = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),
 215             flags   = INTERACTIVE,
 216             key     = KEY_SUBNET_MASK,
 217             minsize = IP4_MIN_SIZE,
 218             maxsize = IP4_MAX_SIZE,
 219     endstring;
 220
 221     string  varid   = ISCSI_CONFIG_IFR_NVDATA.Gateway,
 222             prompt  = STRING_TOKEN(STR_ISCSI_LOCAL_GATEWAY),
 223             help    = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),
 224             flags   = INTERACTIVE,
 225             key     = KEY_GATE_WAY,
 226             minsize = IP4_MIN_SIZE,
 227             maxsize = IP4_MAX_SIZE,
 228     endstring;
 229
 230     endif;
 231
 232     suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;
 233     subtitle text = STRING_TOKEN(STR_NULL);
 234     endif;
 235
 236     suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG OR
 237                ideqval ISCSI_CONFIG_IFR_NVDATA.InitiatorInfoFromDhcp == 0x00;
 238     checkbox varid  = ISCSI_CONFIG_IFR_NVDATA.TargetInfoFromDhcp,
 239              prompt = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP_ON_TARGET),
 240              help   = STRING_TOKEN(STR_ISCSI_ENABLE_DHCP_ON_TARGET),
 241              flags  = 0,
 242     endcheckbox;
 243     endif;
 244
 245     suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG OR
 246                ideqval ISCSI_CONFIG_IFR_NVDATA.TargetInfoFromDhcp == 0x01;
 247
 248     string  varid   = ISCSI_CONFIG_IFR_NVDATA.TargetName,
 249             prompt  = STRING_TOKEN(STR_ISCSI_TARGET_NAME),
 250             help    = STRING_TOKEN(STR_ISCSI_TARGET_NAME_HELP),
 251             flags   = INTERACTIVE,
 252             key     = KEY_TARGET_NAME,
 253             minsize = ISCSI_NAME_IFR_MIN_SIZE,
 254             maxsize = ISCSI_NAME_IFR_MAX_SIZE,
 255     endstring;
 256
 257     string  varid   = ISCSI_CONFIG_IFR_NVDATA.TargetIp,
 258             prompt  = STRING_TOKEN(STR_ISCSI_TARGET_IP_ADDRESS),
 259             help    = STRING_TOKEN(STR_ISCSI_IP_ADDRESS_HELP),
 260             flags   = INTERACTIVE,
 261             key     = KEY_TARGET_IP,
 262             minsize = IP_MIN_SIZE,
 263             maxsize = IP_MAX_SIZE,
 264     endstring;
 265
 266     numeric varid   = ISCSI_CONFIG_IFR_NVDATA.TargetPort,
 267             prompt  = STRING_TOKEN(STR_ISCSI_TARGET_PORT),
 268             help    = STRING_TOKEN(STR_ISCSI_TARGET_PORT),
 269             flags   = 0,
 270             minimum = TARGET_PORT_MIN_NUM,
 271             maximum = TARGET_PORT_MAX_NUM,
 272             step    = 0,
 273     endnumeric;
 274
 275     string varid    = ISCSI_CONFIG_IFR_NVDATA.BootLun,
 276             prompt  = STRING_TOKEN(STR_ISCSI_BOOT_LUN),
 277             help    = STRING_TOKEN(STR_ISCSI_BOOT_LUN_HELP),
 278             flags   = INTERACTIVE,
 279             key     = KEY_BOOT_LUN,
 280             minsize = LUN_MIN_SIZE,
 281             maxsize = LUN_MAX_SIZE,
 282     endstring;
 283
 284     endif;
 285
 286     suppressif ideqval ISCSI_CONFIG_IFR_NVDATA.IpMode == IP_MODE_AUTOCONFIG;
 287     subtitle text = STRING_TOKEN(STR_NULL);
 288     endif;
 289
 290     oneof varid  = ISCSI_CONFIG_IFR_NVDATA.AuthenticationType,
 291           questionid = KEY_AUTH_TYPE,
 292           prompt = STRING_TOKEN(STR_AUTHEN_TYPE_PROMPT),
 293           help   = STRING_TOKEN(STR_AUTHEN_TYPE_HELP),
 294           option text = STRING_TOKEN(STR_AUTHEN_TYPE_CHAP),     value = ISCSI_AUTH_TYPE_CHAP, flags = 0;
 295           option text = STRING_TOKEN(STR_AUTHEN_TYPE_NONE),     value = ISCSI_AUTH_TYPE_NONE, flags = DEFAULT;
 296     endoneof;
 297
 298     suppressif NOT ideqval ISCSI_CONFIG_IFR_NVDATA.AuthenticationType == ISCSI_AUTH_TYPE_CHAP;
 299     oneof varid  = ISCSI_CONFIG_IFR_NVDATA.CHAPType,
 300           prompt = STRING_TOKEN(STR_CHAP_TYPE_PROMPT),
 301           help   = STRING_TOKEN(STR_CHAP_TYPE_HELP),
 302           option text = STRING_TOKEN(STR_CHAP_TYPE_UNI),    value = ISCSI_CHAP_UNI,    flags = 0;
 303           option text = STRING_TOKEN(STR_CHAP_TYPE_MUTUAL), value = ISCSI_CHAP_MUTUAL, flags = DEFAULT;
 304     endoneof;
 305     endif;
 306
 307     suppressif NOT ideqval ISCSI_CONFIG_IFR_NVDATA.AuthenticationType == ISCSI_AUTH_TYPE_CHAP;
 308     string  varid   = ISCSI_CONFIG_IFR_NVDATA.CHAPName,
 309             prompt  = STRING_TOKEN(STR_ISCSI_CHAP_NAME),
 310             help    = STRING_TOKEN(STR_ISCSI_CHAP_NAME),
 311             flags   = INTERACTIVE,
 312             key     = KEY_CHAP_NAME,
 313             minsize = 0,
 314             maxsize = ISCSI_CHAP_NAME_MAX_LEN,
 315     endstring;
 316
 317     string  varid    = ISCSI_CONFIG_IFR_NVDATA.CHAPSecret,
 318             prompt   = STRING_TOKEN(STR_ISCSI_CHAP_SECRET),
 319             help     = STRING_TOKEN(STR_ISCSI_CHAP_SECRET_HELP),
 320             flags    = INTERACTIVE,
 321             key      = KEY_CHAP_SECRET,
 322             minsize  = ISCSI_CHAP_SECRET_MIN_LEN,
 323             maxsize  = ISCSI_CHAP_SECRET_MAX_LEN,
 324     endstring;
 325
 326     endif;
 327
 328     suppressif NOT ideqval ISCSI_CONFIG_IFR_NVDATA.AuthenticationType == ISCSI_AUTH_TYPE_CHAP OR
 329                NOT ideqval ISCSI_CONFIG_IFR_NVDATA.CHAPType == ISCSI_CHAP_MUTUAL;
 330
 331     string  varid   = ISCSI_CONFIG_IFR_NVDATA.ReverseCHAPName,
 332             prompt  = STRING_TOKEN(STR_ISCSI_REVERSE_CHAP_NAME),
 333             help    = STRING_TOKEN(STR_ISCSI_REVERSE_CHAP_NAME),
 334             flags   = INTERACTIVE,
 335             key     = KEY_REVERSE_CHAP_NAME,
 336             minsize = 0,
 337             maxsize = ISCSI_CHAP_NAME_MAX_LEN,
 338     endstring;
 339
 340     string  varid    = ISCSI_CONFIG_IFR_NVDATA.ReverseCHAPSecret,
 341             prompt   = STRING_TOKEN(STR_ISCSI_REVERSE_CHAP_SECRET),
 342             help     = STRING_TOKEN(STR_ISCSI_CHAP_SECRET_HELP),
 343             flags    = INTERACTIVE,
 344             key      = KEY_REVERSE_CHAP_SECRET,
 345             minsize  = ISCSI_CHAP_SECRET_MIN_LEN,
 346             maxsize  = ISCSI_CHAP_SECRET_MAX_LEN,
 347     endstring;
 348
 349     endif;
 350
 351     subtitle text = STRING_TOKEN(STR_NULL);
 352
 353     text
 354       help   = STRING_TOKEN (STR_SAVE_CHANGES_HELP),
 355       text   = STRING_TOKEN (STR_SAVE_CHANGES),
 356         text   = STRING_TOKEN (STR_SAVE_CHANGES),
 357       flags  = INTERACTIVE,
 358       key    = KEY_SAVE_ATTEMPT_CONFIG;
 359
 360     goto FORMID_MAIN_FORM,
 361     prompt = STRING_TOKEN (STR_RETURN_MAIN_FORM),
 362     help   = STRING_TOKEN (STR_RETURN_MAIN_FORM),
 363     flags  = 0;
 364
 365   endform;
 366
 367 endformset;
 368