[mirror_edk2.git] / MdeModulePkg / Library / BootMaintenanceManagerUiLib / FormGuid.h

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