2 Head file for front page.
4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef _FRONT_PAGE_H_
16 #define _FRONT_PAGE_H_
21 #include <Protocol/BootLogo.h>
23 // These is the VFR compiler generated data representing our VFR data.
25 extern UINT8 FrontPageVfrBin
[];
27 extern EFI_FORM_BROWSER2_PROTOCOL
*gFormBrowser2
;
30 #define SMBIOS_TYPE4_CPU_SOCKET_POPULATED BIT6
33 // This is the VFR compiler generated header file which defines the
34 // string identifiers.
36 #define PRINTABLE_LANGUAGE_NAME_STRING_ID 0x0001
39 // These are defined as the same with vfr file
41 #define FRONT_PAGE_FORM_ID 0x1000
43 #define LABEL_FRANTPAGE_INFORMATION 0x1000
44 #define LABEL_END 0xffff
46 #define FRONT_PAGE_FORMSET_GUID \
48 0x9e0c30bc, 0x3f06, 0x4ba6, {0x82, 0x88, 0x9, 0x17, 0x9b, 0x85, 0x5d, 0xbe} \
51 #define FRONT_PAGE_CALLBACK_DATA_SIGNATURE SIGNATURE_32 ('F', 'P', 'C', 'B')
57 // HII relative handles
59 EFI_HII_HANDLE HiiHandle
;
60 EFI_HANDLE DriverHandle
;
61 EFI_STRING_ID
*LanguageToken
;
66 EFI_HII_CONFIG_ACCESS_PROTOCOL ConfigAccess
;
67 } FRONT_PAGE_CALLBACK_DATA
;
70 #define EFI_FP_CALLBACK_DATA_FROM_THIS(a) \
72 FRONT_PAGE_CALLBACK_DATA, \
74 FRONT_PAGE_CALLBACK_DATA_SIGNATURE \
78 This function allows a caller to extract the current configuration for one
79 or more named elements from the target driver.
82 @param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
83 @param Request - A null-terminated Unicode string in <ConfigRequest> format.
84 @param Progress - On return, points to a character in the Request string.
85 Points to the string's null terminator if request was successful.
86 Points to the most recent '&' before the first failing name/value
87 pair (or the beginning of the string if the failure is in the
88 first name/value pair) if the request was not successful.
89 @param Results - A null-terminated Unicode string in <ConfigAltResp> format which
90 has all values filled in for the names in the Request string.
91 String to be allocated by the called function.
93 @retval EFI_SUCCESS The Results is filled with the requested values.
94 @retval EFI_OUT_OF_RESOURCES Not enough memory to store the results.
95 @retval EFI_INVALID_PARAMETER Request is NULL, illegal syntax, or unknown name.
96 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
102 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
103 IN CONST EFI_STRING Request
,
104 OUT EFI_STRING
*Progress
,
105 OUT EFI_STRING
*Results
109 This function processes the results of changes in configuration.
112 @param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
113 @param Configuration - A null-terminated Unicode string in <ConfigResp> format.
114 @param Progress - A pointer to a string filled in with the offset of the most
115 recent '&' before the first failing name/value pair (or the
116 beginning of the string if the failure is in the first
117 name/value pair) or the terminating NULL if all was successful.
119 @retval EFI_SUCCESS The Results is processed successfully.
120 @retval EFI_INVALID_PARAMETER Configuration is NULL.
121 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
127 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
128 IN CONST EFI_STRING Configuration
,
129 OUT EFI_STRING
*Progress
133 This function processes the results of changes in configuration.
136 @param This - Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
137 @param Action - Specifies the type of action taken by the browser.
138 @param QuestionId - A unique value which is sent to the original exporting driver
139 so that it can identify the type of data to expect.
140 @param Type - The type of value for the question.
141 @param Value - A pointer to the data being sent to the original exporting driver.
142 @param ActionRequest - On return, points to the action requested by the callback function.
144 @retval EFI_SUCCESS The callback successfully handled the action.
145 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
146 @retval EFI_DEVICE_ERROR The variable could not be saved.
147 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
153 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
154 IN EFI_BROWSER_ACTION Action
,
155 IN EFI_QUESTION_ID QuestionId
,
157 IN EFI_IFR_TYPE_VALUE
*Value
,
158 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
162 Initialize HII information for the FrontPage
164 @retval EFI_SUCCESS The operation is successful.
165 @retval EFI_DEVICE_ERROR If the dynamic opcode creation failed.
169 InitializeFrontPage (
174 Acquire the string associated with the ProducerGuid and return it.
177 @param ProducerGuid - The Guid to search the HII database for
178 @param Token - The token value of the string to extract
179 @param String - The string that is extracted
181 @retval EFI_SUCCESS The function returns EFI_SUCCESS always.
186 IN EFI_GUID
*ProducerGuid
,
187 IN EFI_STRING_ID Token
,
192 This function is the main entry of the UI entry.
193 The function will present the main menu of the system UI.
195 @param ConnectAllHappened Caller passes the value to UI to avoid unnecessary connect-all.
201 IN BOOLEAN ConnectAllHappened
205 Extract device path for given HII handle and class guid.
207 @param Handle The HII handle.
209 @retval NULL Fail to get the device path string.
210 @return PathString Get the device path string.
214 ExtractDevicePathFromHiiHandle (
215 IN EFI_HII_HANDLE Handle
218 #endif // _FRONT_PAGE_H_