[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / BootMaint / FormGuid.h

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