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