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