MdeModulePkg/Library/BootMaintenanceManagerUiLib/FormGuid.h

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