IntelFrameworkModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h

   1 /** @file
   2   Formset guids, form id and VarStore data structure for Boot Maintenance Manager.
   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 #ifndef _FORM_GUID_H_
  15 #define _FORM_GUID_H_
  16
  17 #include <Guid/BdsHii.h>
  18
  19 #define FORM_MAIN_ID                         0x1001
  20 #define FORM_BOOT_ADD_ID                     0x1002
  21 #define FORM_BOOT_DEL_ID                     0x1003
  22 #define FORM_BOOT_CHG_ID                     0x1004
  23 #define FORM_DRV_ADD_ID                      0x1005
  24 #define FORM_DRV_DEL_ID                      0x1006
  25 #define FORM_DRV_CHG_ID                      0x1007
  26 #define FORM_CON_MAIN_ID                     0x1008
  27 #define FORM_CON_IN_ID                       0x1009
  28 #define FORM_CON_OUT_ID                      0x100A
  29 #define FORM_CON_ERR_ID                      0x100B
  30 #define FORM_FILE_SEEK_ID                    0x100C
  31 #define FORM_FILE_NEW_SEEK_ID                0x100D
  32 #define FORM_DRV_ADD_FILE_ID                 0x100E
  33 #define FORM_DRV_ADD_HANDLE_ID               0x100F
  34 #define FORM_DRV_ADD_HANDLE_DESC_ID          0x1010
  35 #define FORM_BOOT_NEXT_ID                    0x1011
  36 #define FORM_TIME_OUT_ID                     0x1012
  37 #define FORM_RESET                           0x1013
  38 #define FORM_BOOT_SETUP_ID                   0x1014
  39 #define FORM_DRIVER_SETUP_ID                 0x1015
  40 #define FORM_BOOT_LEGACY_DEVICE_ID           0x1016
  41 #define FORM_CON_COM_ID                      0x1017
  42 #define FORM_CON_COM_SETUP_ID                0x1018
  43 #define FORM_SET_FD_ORDER_ID                 0x1019
  44 #define FORM_SET_HD_ORDER_ID                 0x101A
  45 #define FORM_SET_CD_ORDER_ID                 0x101B
  46 #define FORM_SET_NET_ORDER_ID                0x101C
  47 #define FORM_SET_BEV_ORDER_ID                0x101D
  48 #define FORM_FILE_EXPLORER_ID                0x101E
  49 #define FORM_BOOT_ADD_DESCRIPTION_ID         0x101F
  50 #define FORM_DRIVER_ADD_FILE_DESCRIPTION_ID  0x1020
  51 #define FORM_CON_MODE_ID                     0x1021
  52
  53 #define MAXIMUM_FORM_ID                      0x10FF
  54
  55 #define KEY_VALUE_COM_SET_BAUD_RATE          0x1101
  56 #define KEY_VALUE_COM_SET_DATA_BITS          0x1102
  57 #define KEY_VALUE_COM_SET_STOP_BITS          0x1103
  58 #define KEY_VALUE_COM_SET_PARITY             0x1104
  59 #define KEY_VALUE_COM_SET_TERMI_TYPE         0x1105
  60 #define KEY_VALUE_MAIN_BOOT_NEXT             0x1106
  61 #define KEY_VALUE_BOOT_ADD_DESC_DATA         0x1107
  62 #define KEY_VALUE_BOOT_ADD_OPT_DATA          0x1108
  63 #define KEY_VALUE_DRIVER_ADD_DESC_DATA       0x1109
  64 #define KEY_VALUE_DRIVER_ADD_OPT_DATA        0x110A
  65 #define KEY_VALUE_SAVE_AND_EXIT              0x110B
  66 #define KEY_VALUE_NO_SAVE_AND_EXIT           0x110C
  67 #define KEY_VALUE_BOOT_FROM_FILE             0x110D
  68
  69 #define MAXIMUM_NORMAL_KEY_VALUE             0x11FF
  70
  71 //
  72 // Varstore ID defined for Buffer Storage
  73 //
  74 #define VARSTORE_ID_BOOT_MAINT               0x1000
  75 #define VARSTORE_ID_FILE_EXPLORER            0x1001
  76
  77 //
  78 // End Label
  79 //
  80 #define LABEL_END   0xffff
  81 #define MAX_MENU_NUMBER 100
  82
  83 ///
  84 /// This is the structure that will be used to store the
  85 /// question's current value. Use it at initialize time to
  86 /// set default value for each question. When using at run
  87 /// time, this map is returned by the callback function,
  88 /// so dynamically changing the question's value will be
  89 /// possible through this mechanism
  90 ///
  91 typedef struct {
  92   //
  93   // Three questions displayed at the main page
  94   // for Timeout, BootNext Variables respectively
  95   //
  96   UINT16  BootTimeOut;
  97   UINT16  BootNext;
  98
  99   //
 100   // This is the COM1 Attributes value storage
 101   //
 102   UINT8   COM1BaudRate;
 103   UINT8   COM1DataRate;
 104   UINT8   COM1StopBits;
 105   UINT8   COM1Parity;
 106   UINT8   COM1TerminalType;
 107
 108   //
 109   // This is the COM2 Attributes value storage
 110   //
 111   UINT8   COM2BaudRate;
 112   UINT8   COM2DataRate;
 113   UINT8   COM2StopBits;
 114   UINT8   COM2Parity;
 115   UINT8   COM2TerminalType;
 116
 117   //
 118   // Driver Option Add Handle page storage
 119   //
 120   UINT16  DriverAddHandleDesc[MAX_MENU_NUMBER];
 121   UINT16  DriverAddHandleOptionalData[MAX_MENU_NUMBER];
 122   UINT8   DriverAddActive;
 123   UINT8   DriverAddForceReconnect;
 124
 125   //
 126   // Console Input/Output/Errorout using COM port check storage
 127   //
 128   UINT8   ConsoleInputCOM1;
 129   UINT8   ConsoleInputCOM2;
 130   UINT8   ConsoleOutputCOM1;
 131   UINT8   ConsoleOutputCOM2;
 132   UINT8   ConsoleErrorCOM1;
 133   UINT8   ConsoleErrorCOM2;
 134
 135   //
 136   // At most 100 input/output/errorout device for console storage
 137   //
 138   UINT8   ConsoleCheck[MAX_MENU_NUMBER];
 139
 140   //
 141   // Boot or Driver Option Order storage
 142   // The value is the OptionNumber+1 because the order list value cannot be 0
 143   // Use UINT32 to hold the potential value 0xFFFF+1=0x10000
 144   //
 145   UINT32  OptionOrder[MAX_MENU_NUMBER];
 146
 147   //
 148   // Boot or Driver Option Delete storage
 149   //
 150   BOOLEAN OptionDel[MAX_MENU_NUMBER];
 151
 152   //
 153   // This is the Terminal Attributes value storage
 154   //
 155   UINT8   COMBaudRate;
 156   UINT8   COMDataRate;
 157   UINT8   COMStopBits;
 158   UINT8   COMParity;
 159   UINT8   COMTerminalType;
 160   UINT8   COMFlowControl;
 161
 162   //
 163   // Legacy Device Order Selection Storage
 164   //
 165   UINT8   LegacyFD[MAX_MENU_NUMBER];
 166   UINT8   LegacyHD[MAX_MENU_NUMBER];
 167   UINT8   LegacyCD[MAX_MENU_NUMBER];
 168   UINT8   LegacyNET[MAX_MENU_NUMBER];
 169   UINT8   LegacyBEV[MAX_MENU_NUMBER];
 170
 171   //
 172   // We use DisableMap array to record the enable/disable state of each boot device
 173   // It should be taken as a bit array, from left to right there are totally 256 bits
 174   // the most left one stands for BBS table item 0, and the most right one stands for item 256
 175   // If the bit is 1, it means the boot device has been disabled.
 176   //
 177   UINT8   DisableMap[32];
 178
 179   //
 180   // Console Output Text Mode
 181   //
 182   UINT16  ConsoleOutMode;
 183
 184   //
 185   //  UINT16                    PadArea[10];
 186   //
 187 } BMM_FAKE_NV_DATA;
 188
 189 //
 190 // Key used by File Explorer forms
 191 //
 192 #define KEY_VALUE_SAVE_AND_EXIT_BOOT           0x1000
 193 #define KEY_VALUE_NO_SAVE_AND_EXIT_BOOT        0x1001
 194 #define KEY_VALUE_SAVE_AND_EXIT_DRIVER         0x1002
 195 #define KEY_VALUE_NO_SAVE_AND_EXIT_DRIVER      0x1003
 196
 197 ///
 198 /// This is the data structure used by File Explorer formset
 199 ///
 200 typedef struct {
 201   UINT16  DescriptionData[75];
 202   UINT16  OptionalData[127];
 203   UINT8   Active;
 204   UINT8   ForceReconnect;
 205 } FILE_EXPLORER_NV_DATA;
 206
 207 #endif
 208