MdeModulePkg/Universal/BdsDxe/BootMaint/FormGuid.h

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