[mirror_edk2.git] / MdeModulePkg / Application / UiApp / FrontPage.h

/** @file\r
  FrontPage routines to handle the callbacks and browser calls\r
\r
Copyright (c) 2004 - 2015, 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
\r
#ifndef _FRONT_PAGE_H_\r
#define _FRONT_PAGE_H_\r
\r
#include "DeviceMngr/DeviceManager.h"\r
#include "BootMaint/BootMaint.h"\r
#include "BootMngr/BootManager.h"\r
#include "String.h"\r
\r
#include <Protocol/BootLogo.h>\r
//\r
// These are the VFR compiler generated data representing our VFR data.\r
//\r
extern UINT8  FrontPageVfrBin[];\r
\r
extern EFI_FORM_BROWSER2_PROTOCOL      *gFormBrowser2;\r
\r
extern BOOLEAN  gConnectAllHappened;\r
\r
#define SMBIOS_TYPE4_CPU_SOCKET_POPULATED BIT6\r
\r
///\r
/// The size of a 3 character ISO639 language code.\r
///\r
#define ISO_639_2_ENTRY_SIZE   3\r
\r
//\r
// This is the VFR compiler generated header file which defines the\r
// string identifiers.\r
//\r
#define PRINTABLE_LANGUAGE_NAME_STRING_ID     0x0001\r
\r
//\r
// These are defined as the same with vfr file\r
//\r
#define FRONT_PAGE_FORM_ID             0x1000\r
#define INVALID_FORM_ID                0x0FFF\r
\r
#define FRONT_PAGE_KEY_SECTION         0x1000\r
#define FRONT_PAGE_KEY_OFFSET          0x4000\r
#define FRONT_PAGE_KEY_CONTINUE        0x1000\r
#define FRONT_PAGE_KEY_LANGUAGE        0x1234\r
#define FRONT_PAGE_KEY_BOOT_MANAGER    0x1064\r
#define FRONT_PAGE_KEY_DEVICE_MANAGER  0x8567\r
#define FRONT_PAGE_KEY_BOOT_MAINTAIN   0x9876\r
\r
#define LABEL_SELECT_LANGUAGE          0x1000\r
#define LABEL_PLATFORM_INFORMATION     0x1001\r
#define LABEL_END                      0xffff\r
\r
#define FRONT_PAGE_FORMSET_GUID \\r
  { \\r
    0x9e0c30bc, 0x3f06, 0x4ba6, {0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe} \\r
  }\r
\r
#define FRONT_PAGE_CALLBACK_DATA_SIGNATURE  SIGNATURE_32 ('F', 'P', 'C', 'B')\r
\r
typedef struct {\r
  UINTN                           Signature;\r
\r
  //\r
  // HII relative handles\r
  //\r
  EFI_HII_HANDLE                  HiiHandle;\r
  EFI_HANDLE                      DriverHandle;\r
  EFI_STRING_ID                   *LanguageToken;\r
\r
  //\r
  // Produced protocols\r
  //\r
  EFI_HII_CONFIG_ACCESS_PROTOCOL  ConfigAccess;\r
} FRONT_PAGE_CALLBACK_DATA;\r
\r
\r
#define EFI_FP_CALLBACK_DATA_FROM_THIS(a) \\r
  CR (a, \\r
      FRONT_PAGE_CALLBACK_DATA, \\r
      ConfigAccess, \\r
      FRONT_PAGE_CALLBACK_DATA_SIGNATURE \\r
      )\r
\r
/**\r
  This function allows a caller to extract the current configuration for one\r
  or more named elements from the target driver.\r
\r
\r
  @param This            - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Request         - A null-terminated Unicode string in <ConfigRequest> format.\r
  @param Progress        - On return, points to a character in the Request string.\r
                         Points to the string's null terminator if request was successful.\r
                         Points to the most recent '&' before the first failing name/value\r
                         pair (or the beginning of the string if the failure is in the\r
                         first name/value pair) if the request was not successful.\r
  @param Results         - A null-terminated Unicode string in <ConfigAltResp> format which\r
                         has all values filled in for the names in the Request string.\r
                         String to be allocated by the called function.\r
\r
  @retval  EFI_SUCCESS            The Results is filled with the requested values.\r
  @retval  EFI_OUT_OF_RESOURCES   Not enough memory to store the results.\r
  @retval  EFI_INVALID_PARAMETER  Request is NULL, illegal syntax, or unknown name.\r
  @retval  EFI_NOT_FOUND          Routing data doesn't match any storage in this driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FakeExtractConfig (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,\r
  IN  CONST EFI_STRING                       Request,\r
  OUT EFI_STRING                             *Progress,\r
  OUT EFI_STRING                             *Results\r
  );\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
\r
  @param This            - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Configuration   - A null-terminated Unicode string in <ConfigResp> format.\r
  @param Progress        - A pointer to a string filled in with the offset of the most\r
                         recent '&' before the first failing name/value pair (or the\r
                         beginning of the string if the failure is in the first\r
                         name/value pair) or the terminating NULL if all was successful.\r
\r
  @retval  EFI_SUCCESS            The Results is processed successfully.\r
  @retval  EFI_INVALID_PARAMETER  Configuration is NULL.\r
  @retval  EFI_NOT_FOUND          Routing data doesn't match any storage in this driver.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FakeRouteConfig (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,\r
  IN  CONST EFI_STRING                       Configuration,\r
  OUT EFI_STRING                             *Progress\r
  );\r
\r
/**\r
  This function processes the results of changes in configuration.\r
\r
\r
  @param This            - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
  @param Action          - Specifies the type of action taken by the browser.\r
  @param QuestionId      - A unique value which is sent to the original exporting driver\r
                         so that it can identify the type of data to expect.\r
  @param Type            - The type of value for the question.\r
  @param Value           - A pointer to the data being sent to the original exporting driver.\r
  @param ActionRequest   - On return, points to the action requested by the callback function.\r
\r
  @retval  EFI_SUCCESS           The callback successfully handled the action.\r
  @retval  EFI_OUT_OF_RESOURCES  Not enough storage is available to hold the variable and its data.\r
  @retval  EFI_DEVICE_ERROR      The variable could not be saved.\r
  @retval  EFI_UNSUPPORTED       The specified Action is not supported by the callback.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
FrontPageCallback (\r
  IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,\r
  IN  EFI_BROWSER_ACTION                     Action,\r
  IN  EFI_QUESTION_ID                        QuestionId,\r
  IN  UINT8                                  Type,\r
  IN  EFI_IFR_TYPE_VALUE                     *Value,\r
  OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest\r
  );\r
\r
/**\r
  Initialize HII information for the FrontPage\r
\r
  @retval  EFI_SUCCESS        The operation is successful.\r
  @retval  EFI_DEVICE_ERROR   If the dynamic opcode creation failed.\r
\r
**/\r
EFI_STATUS\r
InitializeFrontPage (\r
  VOID\r
  );\r
\r
/**\r
  Acquire the string associated with the ProducerGuid and return it.\r
\r
\r
  @param ProducerGuid    - The Guid to search the HII database for\r
  @param Token           - The token value of the string to extract\r
  @param String          - The string that is extracted\r
\r
  @retval  EFI_SUCCESS  The function returns EFI_SUCCESS always.\r
\r
**/\r
EFI_STATUS\r
GetProducerString (\r
  IN      EFI_GUID                  *ProducerGuid,\r
  IN      EFI_STRING_ID             Token,\r
  OUT     CHAR16                    **String\r
  );\r
\r
/**\r
  This function is the main entry of the UI entry.\r
  The function will present the main menu of the system UI.\r
\r
  @param ConnectAllHappened Caller passes the value to UI to avoid unnecessary connect-all.\r
\r
**/\r
VOID\r
EFIAPI\r
UiEntry (\r
  IN BOOLEAN                      ConnectAllHappened\r
  );\r
\r
/**\r
  Extract the displayed formset for given HII handle and class guid.\r
\r
  @param Handle          The HII handle.\r
  @param SetupClassGuid  The class guid specifies which form set will be displayed.\r
  @param SkipCount       Skip some formsets which has processed before.\r
  @param FormSetTitle    Formset title string.\r
  @param FormSetHelp     Formset help string.\r
  @param FormSetGuid     Formset Guid.\r
\r
  @retval  TRUE          The formset for given HII handle will be displayed.\r
  @return  FALSE         The formset for given HII handle will not be displayed.\r
\r
**/\r
BOOLEAN\r
ExtractDisplayedHiiFormFromHiiHandle (\r
  IN      EFI_HII_HANDLE      Handle,\r
  IN      EFI_GUID            *SetupClassGuid,\r
  IN      UINTN               SkipCount,\r
  OUT     EFI_STRING_ID       *FormSetTitle,\r
  OUT     EFI_STRING_ID       *FormSetHelp,\r
  OUT     EFI_GUID            *FormSetGuid\r
  );\r
\r
/**\r
  Extract device path for given HII handle and class guid.\r
\r
  @param Handle          The HII handle.\r
\r
  @retval  NULL          Fail to get the device path string.\r
  @return  PathString    Get the device path string.\r
\r
**/\r
CHAR16 *\r
ExtractDevicePathFromHiiHandle (\r
  IN      EFI_HII_HANDLE      Handle\r
  );\r
\r
/**\r
  This function will change video resolution and text mode\r
  according to defined setup mode or defined boot mode  \r
\r
  @param  IsSetupMode   Indicate mode is changed to setup mode or boot mode. \r
\r
  @retval  EFI_SUCCESS  Mode is changed successfully.\r
  @retval  Others             Mode failed to be changed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
BdsSetConsoleMode (\r
  BOOLEAN  IsSetupMode\r
  );\r
\r
#endif // _FRONT_PAGE_H_\r
\r
Commit	Line	Data
143f0b1d ED	1	/** @file\r
	2	FrontPage routines to handle the callbacks and browser calls\r
	3	\r
afc244a5	4	Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.<BR>\r
143f0b1d ED	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	\r
	15	#ifndef _FRONT_PAGE_H_\r
	16	#define _FRONT_PAGE_H_\r
	17	\r
	18	#include "DeviceMngr/DeviceManager.h"\r
	19	#include "BootMaint/BootMaint.h"\r
	20	#include "BootMngr/BootManager.h"\r
	21	#include "String.h"\r
	22	\r
	23	#include <Protocol/BootLogo.h>\r
	24	//\r
	25	// These are the VFR compiler generated data representing our VFR data.\r
	26	//\r
	27	extern UINT8 FrontPageVfrBin[];\r
	28	\r
	29	extern EFI_FORM_BROWSER2_PROTOCOL *gFormBrowser2;\r
	30	\r
	31	extern BOOLEAN gConnectAllHappened;\r
	32	\r
	33	#define SMBIOS_TYPE4_CPU_SOCKET_POPULATED BIT6\r
	34	\r
	35	///\r
	36	/// The size of a 3 character ISO639 language code.\r
	37	///\r
	38	#define ISO_639_2_ENTRY_SIZE 3\r
	39	\r
	40	//\r
	41	// This is the VFR compiler generated header file which defines the\r
	42	// string identifiers.\r
	43	//\r
	44	#define PRINTABLE_LANGUAGE_NAME_STRING_ID 0x0001\r
	45	\r
	46	//\r
	47	// These are defined as the same with vfr file\r
	48	//\r
	49	#define FRONT_PAGE_FORM_ID 0x1000\r
	50	#define INVALID_FORM_ID 0x0FFF\r
	51	\r
	52	#define FRONT_PAGE_KEY_SECTION 0x1000\r
	53	#define FRONT_PAGE_KEY_OFFSET 0x4000\r
	54	#define FRONT_PAGE_KEY_CONTINUE 0x1000\r
	55	#define FRONT_PAGE_KEY_LANGUAGE 0x1234\r
	56	#define FRONT_PAGE_KEY_BOOT_MANAGER 0x1064\r
	57	#define FRONT_PAGE_KEY_DEVICE_MANAGER 0x8567\r
	58	#define FRONT_PAGE_KEY_BOOT_MAINTAIN 0x9876\r
143f0b1d ED	59	\r
	60	#define LABEL_SELECT_LANGUAGE 0x1000\r
	61	#define LABEL_PLATFORM_INFORMATION 0x1001\r
	62	#define LABEL_END 0xffff\r
	63	\r
	64	#define FRONT_PAGE_FORMSET_GUID \\r
	65	{ \\r
	66	0x9e0c30bc, 0x3f06, 0x4ba6, {0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe} \\r
	67	}\r
	68	\r
	69	#define FRONT_PAGE_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('F', 'P', 'C', 'B')\r
	70	\r
	71	typedef struct {\r
	72	UINTN Signature;\r
	73	\r
	74	//\r
	75	// HII relative handles\r
	76	//\r
	77	EFI_HII_HANDLE HiiHandle;\r
	78	EFI_HANDLE DriverHandle;\r
	79	EFI_STRING_ID *LanguageToken;\r
	80	\r
	81	//\r
	82	// Produced protocols\r
	83	//\r
	84	EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess;\r
	85	} FRONT_PAGE_CALLBACK_DATA;\r
	86	\r
	87	\r
	88	#define EFI_FP_CALLBACK_DATA_FROM_THIS(a) \\r
	89	CR (a, \\r
	90	FRONT_PAGE_CALLBACK_DATA, \\r
	91	ConfigAccess, \\r
	92	FRONT_PAGE_CALLBACK_DATA_SIGNATURE \\r
	93	)\r
	94	\r
	95	/**\r
	96	This function allows a caller to extract the current configuration for one\r
	97	or more named elements from the target driver.\r
	98	\r
	99	\r
	100	@param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
	101	@param Request - A null-terminated Unicode string in <ConfigRequest> format.\r
	102	@param Progress - On return, points to a character in the Request string.\r
	103	Points to the string's null terminator if request was successful.\r
	104	Points to the most recent '&' before the first failing name/value\r
	105	pair (or the beginning of the string if the failure is in the\r
	106	first name/value pair) if the request was not successful.\r
	107	@param Results - A null-terminated Unicode string in <ConfigAltResp> format which\r
	108	has all values filled in for the names in the Request string.\r
	109	String to be allocated by the called function.\r
	110	\r
	111	@retval EFI_SUCCESS The Results is filled with the requested values.\r
	112	@retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.\r
	113	@retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.\r
	114	@retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
	115	\r
	116	**/\r
	117	EFI_STATUS\r
	118	EFIAPI\r
	119	FakeExtractConfig (\r
	120	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
	121	IN CONST EFI_STRING Request,\r
	122	OUT EFI_STRING *Progress,\r
123	OUT EFI_STRING *Results\r
124	);\r
125	\r
126	/**\r
127	This function processes the results of changes in configuration.\r
128	\r
129	\r
130	@param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
131	@param Configuration - A null-terminated Unicode string in <ConfigResp> format.\r
132	@param Progress - A pointer to a string filled in with the offset of the most\r
133	recent '&' before the first failing name/value pair (or the\r
134	beginning of the string if the failure is in the first\r
135	name/value pair) or the terminating NULL if all was successful.\r
136	\r
137	@retval EFI_SUCCESS The Results is processed successfully.\r
138	@retval EFI_INVALID_PARAMETER Configuration is NULL.\r
139	@retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
140	\r
141	**/\r
142	EFI_STATUS\r
143	EFIAPI\r
144	FakeRouteConfig (\r
145	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
146	IN CONST EFI_STRING Configuration,\r
147	OUT EFI_STRING *Progress\r
148	);\r
149	\r
150	/**\r
151	This function processes the results of changes in configuration.\r
152	\r
153	\r
154	@param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
155	@param Action - Specifies the type of action taken by the browser.\r
156	@param QuestionId - A unique value which is sent to the original exporting driver\r
157	so that it can identify the type of data to expect.\r
158	@param Type - The type of value for the question.\r
159	@param Value - A pointer to the data being sent to the original exporting driver.\r
160	@param ActionRequest - On return, points to the action requested by the callback function.\r
161	\r
162	@retval EFI_SUCCESS The callback successfully handled the action.\r
163	@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r
164	@retval EFI_DEVICE_ERROR The variable could not be saved.\r
165	@retval EFI_UNSUPPORTED The specified Action is not supported by the callback.\r
166	\r
167	**/\r
168	EFI_STATUS\r
169	EFIAPI\r
170	FrontPageCallback (\r
171	IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
172	IN EFI_BROWSER_ACTION Action,\r
173	IN EFI_QUESTION_ID QuestionId,\r
174	IN UINT8 Type,\r
175	IN EFI_IFR_TYPE_VALUE *Value,\r
176	OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
177	);\r
178	\r
179	/**\r
180	Initialize HII information for the FrontPage\r
181	\r
182	@retval EFI_SUCCESS The operation is successful.\r
183	@retval EFI_DEVICE_ERROR If the dynamic opcode creation failed.\r
184	\r
185	**/\r
186	EFI_STATUS\r
187	InitializeFrontPage (\r
188	VOID\r
189	);\r
190	\r
191	/**\r
192	Acquire the string associated with the ProducerGuid and return it.\r
193	\r
194	\r
195	@param ProducerGuid - The Guid to search the HII database for\r
196	@param Token - The token value of the string to extract\r
197	@param String - The string that is extracted\r
198	\r
199	@retval EFI_SUCCESS The function returns EFI_SUCCESS always.\r
200	\r
201	**/\r
202	EFI_STATUS\r
203	GetProducerString (\r
204	IN EFI_GUID *ProducerGuid,\r
205	IN EFI_STRING_ID Token,\r
206	OUT CHAR16 **String\r
207	);\r
208	\r
209	/**\r
210	This function is the main entry of the UI entry.\r
211	The function will present the main menu of the system UI.\r
212	\r
213	@param ConnectAllHappened Caller passes the value to UI to avoid unnecessary connect-all.\r
214	\r
215	**/\r
216	VOID\r
217	EFIAPI\r
218	UiEntry (\r
219	IN BOOLEAN ConnectAllHappened\r
220	);\r
221	\r
222	/**\r
223	Extract the displayed formset for given HII handle and class guid.\r
224	\r
225	@param Handle The HII handle.\r
226	@param SetupClassGuid The class guid specifies which form set will be displayed.\r
227	@param SkipCount Skip some formsets which has processed before.\r
228	@param FormSetTitle Formset title string.\r
229	@param FormSetHelp Formset help string.\r
230	@param FormSetGuid Formset Guid.\r
231	\r
232	@retval TRUE The formset for given HII handle will be displayed.\r
233	@return FALSE The formset for given HII handle will not be displayed.\r
234	\r
235	**/\r
236	BOOLEAN\r
237	ExtractDisplayedHiiFormFromHiiHandle (\r
238	IN EFI_HII_HANDLE Handle,\r
239	IN EFI_GUID *SetupClassGuid,\r
240	IN UINTN SkipCount,\r
241	OUT EFI_STRING_ID *FormSetTitle,\r
242	OUT EFI_STRING_ID *FormSetHelp,\r
243	OUT EFI_GUID *FormSetGuid\r
244	);\r
245	\r
246	/**\r
247	Extract device path for given HII handle and class guid.\r
248	\r
249	@param Handle The HII handle.\r
250	\r
251	@retval NULL Fail to get the device path string.\r
252	@return PathString Get the device path string.\r
253	\r
254	**/\r
255	CHAR16 *\r
256	ExtractDevicePathFromHiiHandle (\r
257	IN EFI_HII_HANDLE Handle\r
258	);\r
259	\r
260	/**\r
261	This function will change video resolution and text mode\r
262	according to defined setup mode or defined boot mode \r
263	\r
264	@param IsSetupMode Indicate mode is changed to setup mode or boot mode. \r
265	\r
266	@retval EFI_SUCCESS Mode is changed successfully.\r
267	@retval Others Mode failed to be changed.\r
268	\r
269	**/\r
270	EFI_STATUS\r
271	EFIAPI\r
272	BdsSetConsoleMode (\r
273	BOOLEAN IsSetupMode\r
274	);\r
275	\r
276	#endif // _FRONT_PAGE_H_\r
277	\r