2 File explorer related functions.
4 Copyright (c) 2004 - 2012, 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 #include "BootMaint.h"
18 Update the File Explore page.
20 @param CallbackData The BMM context data.
21 @param MenuOption Pointer to menu options to display.
25 UpdateFileExplorePage (
26 IN BMM_CALLBACK_DATA
*CallbackData
,
27 BM_MENU_OPTION
*MenuOption
31 BM_MENU_ENTRY
*NewMenuEntry
;
32 BM_FILE_CONTEXT
*NewFileContext
;
36 NewFileContext
= NULL
;
40 mStartLabel
->Number
= FORM_FILE_EXPLORER_ID
;
42 for (Index
= 0; Index
< MenuOption
->MenuNumber
; Index
++) {
43 NewMenuEntry
= BOpt_GetMenuEntry (MenuOption
, Index
);
44 NewFileContext
= (BM_FILE_CONTEXT
*) NewMenuEntry
->VariableContext
;
46 if (NewFileContext
->IsBootLegacy
) {
50 if ((NewFileContext
->IsDir
) || (FileExplorerStateBootFromFile
== CallbackData
->FeCurrentState
)) {
52 // Create Text opcode for directory, also create Text opcode for file in FileExplorerStateBootFromFile.
54 HiiCreateActionOpCode (
56 (UINT16
) (FILE_OPTION_OFFSET
+ Index
),
57 NewMenuEntry
->DisplayStringToken
,
58 STRING_TOKEN (STR_NULL_STRING
),
59 EFI_IFR_FLAG_CALLBACK
,
64 // Create Goto opcode for file in FileExplorerStateAddBootOption or FileExplorerStateAddDriverOptionState.
66 if (FileExplorerStateAddBootOption
== CallbackData
->FeCurrentState
) {
67 FormId
= FORM_BOOT_ADD_DESCRIPTION_ID
;
68 } else if (FileExplorerStateAddDriverOptionState
== CallbackData
->FeCurrentState
) {
69 FormId
= FORM_DRIVER_ADD_FILE_DESCRIPTION_ID
;
75 NewMenuEntry
->DisplayStringToken
,
76 STRING_TOKEN (STR_NULL_STRING
),
77 EFI_IFR_FLAG_CALLBACK
,
78 (UINT16
) (FILE_OPTION_OFFSET
+ Index
)
84 CallbackData
->FeHiiHandle
,
85 &gFileExploreFormSetGuid
,
86 FORM_FILE_EXPLORER_ID
,
87 mStartOpCodeHandle
, // Label FORM_FILE_EXPLORER_ID
88 mEndOpCodeHandle
// LABEL_END
93 Update the file explower page with the refershed file system.
96 @param CallbackData BMM context data
97 @param KeyValue Key value to identify the type of data to expect.
99 @retval TRUE Inform the caller to create a callback packet to exit file explorer.
100 @retval FALSE Indicate that there is no need to exit file explorer.
105 IN BMM_CALLBACK_DATA
*CallbackData
,
109 UINT16 FileOptionMask
;
110 BM_MENU_ENTRY
*NewMenuEntry
;
111 BM_FILE_CONTEXT
*NewFileContext
;
113 BOOLEAN ExitFileExplorer
;
117 NewFileContext
= NULL
;
118 ExitFileExplorer
= FALSE
;
120 FileOptionMask
= (UINT16
) (FILE_OPTION_MASK
& KeyValue
);
122 if (FileExplorerDisplayUnknown
== CallbackData
->FeDisplayContext
) {
124 // First in, display file system.
126 BOpt_FreeMenu (&FsOptionMenu
);
127 BOpt_FindFileSystem (CallbackData
);
128 CreateMenuStringToken (CallbackData
, CallbackData
->FeHiiHandle
, &FsOptionMenu
);
130 UpdateFileExplorePage (CallbackData
, &FsOptionMenu
);
132 CallbackData
->FeDisplayContext
= FileExplorerDisplayFileSystem
;
134 if (FileExplorerDisplayFileSystem
== CallbackData
->FeDisplayContext
) {
135 NewMenuEntry
= BOpt_GetMenuEntry (&FsOptionMenu
, FileOptionMask
);
136 } else if (FileExplorerDisplayDirectory
== CallbackData
->FeDisplayContext
) {
137 NewMenuEntry
= BOpt_GetMenuEntry (&DirectoryMenu
, FileOptionMask
);
140 NewFileContext
= (BM_FILE_CONTEXT
*) NewMenuEntry
->VariableContext
;
142 if (NewFileContext
->IsDir
) {
143 CallbackData
->FeDisplayContext
= FileExplorerDisplayDirectory
;
145 RemoveEntryList (&NewMenuEntry
->Link
);
146 BOpt_FreeMenu (&DirectoryMenu
);
147 Status
= BOpt_FindFiles (CallbackData
, NewMenuEntry
);
148 if (EFI_ERROR (Status
)) {
149 ExitFileExplorer
= TRUE
;
152 CreateMenuStringToken (CallbackData
, CallbackData
->FeHiiHandle
, &DirectoryMenu
);
153 BOpt_DestroyMenuEntry (NewMenuEntry
);
155 UpdateFileExplorePage (CallbackData
, &DirectoryMenu
);
158 switch (CallbackData
->FeCurrentState
) {
159 case FileExplorerStateBootFromFile
:
161 // Restore to original mode before launching boot option.
163 BdsSetConsoleMode (FALSE
);
166 // Here boot from file
168 BootThisFile (NewFileContext
);
170 // Set proper video resolution and text mode for setup.
172 BdsSetConsoleMode (TRUE
);
173 ExitFileExplorer
= TRUE
;
176 case FileExplorerStateAddBootOption
:
177 case FileExplorerStateAddDriverOptionState
:
178 if (FileExplorerStateAddBootOption
== CallbackData
->FeCurrentState
) {
179 FormId
= FORM_BOOT_ADD_DESCRIPTION_ID
;
181 FormId
= FORM_DRIVER_ADD_FILE_DESCRIPTION_ID
;
184 CallbackData
->MenuEntry
= NewMenuEntry
;
185 CallbackData
->LoadContext
->FilePathList
= ((BM_FILE_CONTEXT
*) (CallbackData
->MenuEntry
->VariableContext
))->DevicePath
;
188 // Create Subtitle op-code for the display string of the option.
190 RefreshUpdateData ();
191 mStartLabel
->Number
= FormId
;
193 HiiCreateSubTitleOpCode (
195 NewMenuEntry
->DisplayStringToken
,
202 CallbackData
->FeHiiHandle
,
203 &gFileExploreFormSetGuid
,
205 mStartOpCodeHandle
, // Label FormId
206 mEndOpCodeHandle
// LABEL_END
216 return ExitFileExplorer
;
220 This function processes the results of changes in configuration.
221 When user select a interactive opcode, this callback will be triggered.
222 Based on the Question(QuestionId) that triggers the callback, the corresponding
223 actions is performed. It handles:
225 1) the addition of boot option.
226 2) the addition of driver option.
227 3) exit from file browser
228 4) update of file content if a dir is selected.
229 5) boot the file if a file is selected in "boot from file"
232 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
233 @param Action Specifies the type of action taken by the browser.
234 @param QuestionId A unique value which is sent to the original exporting driver
235 so that it can identify the type of data to expect.
236 @param Type The type of value for the question.
237 @param Value A pointer to the data being sent to the original exporting driver.
238 @param ActionRequest On return, points to the action requested by the callback function.
240 @retval EFI_SUCCESS The callback successfully handled the action.
241 @retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.
242 @retval EFI_DEVICE_ERROR The variable could not be saved.
243 @retval EFI_UNSUPPORTED The specified Action is not supported by the callback.
244 @retval EFI_INVALID_PARAMETER If paramter Value or ActionRequest is NULL.
248 FileExplorerCallback (
249 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
250 IN EFI_BROWSER_ACTION Action
,
251 IN EFI_QUESTION_ID QuestionId
,
253 IN EFI_IFR_TYPE_VALUE
*Value
,
254 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
257 BMM_CALLBACK_DATA
*Private
;
258 FILE_EXPLORER_NV_DATA
*NvRamMap
;
261 if (Action
!= EFI_BROWSER_ACTION_CHANGING
&& Action
!= EFI_BROWSER_ACTION_CHANGED
) {
263 // All other action return unsupported.
265 return EFI_UNSUPPORTED
;
268 Status
= EFI_SUCCESS
;
269 Private
= FE_CALLBACK_DATA_FROM_THIS (This
);
272 // Retrieve uncommitted data from Form Browser
274 NvRamMap
= &Private
->FeFakeNvData
;
275 HiiGetBrowserData (&gFileExploreFormSetGuid
, mFileExplorerStorageName
, sizeof (FILE_EXPLORER_NV_DATA
), (UINT8
*) NvRamMap
);
277 if (Action
== EFI_BROWSER_ACTION_CHANGED
) {
278 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
279 return EFI_INVALID_PARAMETER
;
282 if (QuestionId
== KEY_VALUE_SAVE_AND_EXIT_BOOT
|| QuestionId
== KEY_VALUE_SAVE_AND_EXIT_DRIVER
) {
284 // Apply changes and exit formset
286 if (FileExplorerStateAddBootOption
== Private
->FeCurrentState
) {
287 Status
= Var_UpdateBootOption (Private
, NvRamMap
);
288 if (EFI_ERROR (Status
)) {
292 BOpt_GetBootOptions (Private
);
293 CreateMenuStringToken (Private
, Private
->FeHiiHandle
, &BootOptionMenu
);
294 } else if (FileExplorerStateAddDriverOptionState
== Private
->FeCurrentState
) {
295 Status
= Var_UpdateDriverOption (
297 Private
->FeHiiHandle
,
298 NvRamMap
->DescriptionData
,
299 NvRamMap
->OptionalData
,
300 NvRamMap
->ForceReconnect
302 if (EFI_ERROR (Status
)) {
306 BOpt_GetDriverOptions (Private
);
307 CreateMenuStringToken (Private
, Private
->FeHiiHandle
, &DriverOptionMenu
);
310 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
311 } else if (QuestionId
== KEY_VALUE_NO_SAVE_AND_EXIT_BOOT
|| QuestionId
== KEY_VALUE_NO_SAVE_AND_EXIT_DRIVER
) {
313 // Discard changes and exit formset
315 NvRamMap
->OptionalData
[0] = 0x0000;
316 NvRamMap
->DescriptionData
[0] = 0x0000;
317 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
318 } else if (QuestionId
< FILE_OPTION_OFFSET
) {
320 // Exit File Explorer formset
322 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
324 } else if (Action
== EFI_BROWSER_ACTION_CHANGING
) {
326 return EFI_INVALID_PARAMETER
;
329 if (QuestionId
>= FILE_OPTION_OFFSET
) {
330 UpdateFileExplorer (Private
, QuestionId
);