]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Library/FileExplorerLib/FileExplorer.c
MdeModulePkg/FileExplorer: Remove the codes of searching load file protocol
[mirror_edk2.git] / MdeModulePkg / Library / FileExplorerLib / FileExplorer.c
CommitLineData
4c8274a0
ED
1/** @file\r
2File explorer related functions.\r
3\r
d9b64abb 4Copyright (c) 2004 - 2017, Intel Corporation. All rights reserved.<BR>\r
4c8274a0
ED
5This program and the accompanying materials are licensed and made available under\r
6the terms and conditions of the BSD License that accompanies this distribution.\r
7The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php.\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15\r
16#include "FileExplorer.h"\r
17\r
18EFI_GUID FileExplorerGuid = EFI_FILE_EXPLORE_FORMSET_GUID;\r
19\r
20///\r
21/// File system selection menu\r
22///\r
23MENU_OPTION mFsOptionMenu = {\r
24 MENU_OPTION_SIGNATURE,\r
25 {NULL},\r
26 0,\r
27 FALSE\r
28};\r
29\r
30FILE_EXPLORER_CALLBACK_DATA gFileExplorerPrivate = {\r
31 FILE_EXPLORER_CALLBACK_DATA_SIGNATURE,\r
32 NULL,\r
33 NULL,\r
34 {\r
35 LibExtractConfig,\r
36 LibRouteConfig,\r
37 LibCallback\r
38 },\r
39 NULL,\r
40 &mFsOptionMenu,\r
41 0\r
42};\r
43\r
44HII_VENDOR_DEVICE_PATH *gHiiVendorDevicePath;\r
45\r
46HII_VENDOR_DEVICE_PATH FeHiiVendorDevicePath = {\r
47 {\r
48 {\r
49 HARDWARE_DEVICE_PATH,\r
50 HW_VENDOR_DP,\r
51 {\r
52 (UINT8) (sizeof (VENDOR_DEVICE_PATH)),\r
53 (UINT8) ((sizeof (VENDOR_DEVICE_PATH)) >> 8)\r
54 }\r
55 },\r
56 //\r
57 // Will be replace with gEfiCallerIdGuid in code.\r
58 //\r
59 { 0x0, 0x0, 0x0, { 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } }\r
60 },\r
61 {\r
62 END_DEVICE_PATH_TYPE,\r
63 END_ENTIRE_DEVICE_PATH_SUBTYPE,\r
64 { \r
65 (UINT8) (END_DEVICE_PATH_LENGTH),\r
66 (UINT8) ((END_DEVICE_PATH_LENGTH) >> 8)\r
67 }\r
68 }\r
69};\r
70\r
71VOID *mLibStartOpCodeHandle = NULL;\r
72VOID *mLibEndOpCodeHandle = NULL;\r
73EFI_IFR_GUID_LABEL *mLibStartLabel = NULL;\r
74EFI_IFR_GUID_LABEL *mLibEndLabel = NULL;\r
75\r
76/**\r
77 This function allows a caller to extract the current configuration for one\r
78 or more named elements from the target driver.\r
79\r
80\r
81 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
82 @param Request A null-terminated Unicode string in <ConfigRequest> format.\r
83 @param Progress On return, points to a character in the Request string.\r
84 Points to the string's null terminator if request was successful.\r
85 Points to the most recent '&' before the first failing name/value\r
86 pair (or the beginning of the string if the failure is in the\r
87 first name/value pair) if the request was not successful.\r
88 @param Results A null-terminated Unicode string in <ConfigAltResp> format which\r
89 has all values filled in for the names in the Request string.\r
90 String to be allocated by the called function.\r
91\r
92 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.\r
93 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
94\r
95**/\r
96EFI_STATUS\r
97EFIAPI\r
98LibExtractConfig (\r
99 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
100 IN CONST EFI_STRING Request,\r
101 OUT EFI_STRING *Progress,\r
102 OUT EFI_STRING *Results\r
103 )\r
104{\r
105 if (Progress == NULL || Results == NULL) {\r
106 return EFI_INVALID_PARAMETER;\r
107 }\r
108\r
109 *Progress = Request;\r
110 return EFI_NOT_FOUND;\r
111}\r
112\r
113/**\r
114 This function processes the results of changes in configuration.\r
115\r
116\r
117 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
118 @param Configuration A null-terminated Unicode string in <ConfigResp> format.\r
119 @param Progress A pointer to a string filled in with the offset of the most\r
120 recent '&' before the first failing name/value pair (or the\r
121 beginning of the string if the failure is in the first\r
122 name/value pair) or the terminating NULL if all was successful.\r
123\r
124 @retval EFI_INVALID_PARAMETER Configuration is NULL.\r
125 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.\r
126\r
127**/\r
128EFI_STATUS\r
129EFIAPI\r
130LibRouteConfig (\r
131 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
132 IN CONST EFI_STRING Configuration,\r
133 OUT EFI_STRING *Progress\r
134 )\r
135{\r
136 if (Configuration == NULL || Progress == NULL) {\r
137 return EFI_INVALID_PARAMETER;\r
138 }\r
139\r
140 *Progress = Configuration;\r
141 return EFI_NOT_FOUND;\r
142}\r
143\r
144/**\r
145 This function processes the results of changes in configuration.\r
146 When user select a interactive opcode, this callback will be triggered.\r
147 Based on the Question(QuestionId) that triggers the callback, the corresponding\r
148 actions is performed. It handles:\r
149\r
150 1) Process the axtra action or exit file explorer when user select one file .\r
151 2) update of file content if a dir is selected.\r
152\r
153 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.\r
154 @param Action Specifies the type of action taken by the browser.\r
155 @param QuestionId A unique value which is sent to the original exporting driver\r
156 so that it can identify the type of data to expect.\r
157 @param Type The type of value for the question.\r
158 @param Value A pointer to the data being sent to the original exporting driver.\r
159 @param ActionRequest On return, points to the action requested by the callback function.\r
160\r
161 @retval EFI_SUCCESS The callback successfully handled the action.\r
162 @retval other error Error occur when parse one directory.\r
163**/\r
164EFI_STATUS\r
165EFIAPI\r
166LibCallback (\r
167 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL *This,\r
168 IN EFI_BROWSER_ACTION Action,\r
169 IN EFI_QUESTION_ID QuestionId,\r
170 IN UINT8 Type,\r
171 IN EFI_IFR_TYPE_VALUE *Value,\r
172 OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest\r
173 )\r
174{\r
175 EFI_STATUS Status;\r
176 BOOLEAN NeedExit;\r
177\r
178 NeedExit = TRUE;\r
179 \r
180 if (Action != EFI_BROWSER_ACTION_CHANGING && Action != EFI_BROWSER_ACTION_CHANGED) {\r
181 //\r
182 // Do nothing for other UEFI Action. Only do call back when data is changed.\r
183 //\r
184 return EFI_UNSUPPORTED;\r
185 }\r
186\r
4c8274a0
ED
187 if (Action == EFI_BROWSER_ACTION_CHANGED) {\r
188 if ((Value == NULL) || (ActionRequest == NULL)) {\r
189 return EFI_INVALID_PARAMETER;\r
190 }\r
191 \r
192 if (QuestionId >= FILE_OPTION_OFFSET) {\r
193 LibGetDevicePath(QuestionId);\r
194\r
195 //\r
196 // Process the extra action.\r
197 //\r
198 if (gFileExplorerPrivate.ChooseHandler != NULL) {\r
199 NeedExit = gFileExplorerPrivate.ChooseHandler (gFileExplorerPrivate.RetDevicePath);\r
200 }\r
201\r
202 if (NeedExit) {\r
203 *ActionRequest = EFI_BROWSER_ACTION_REQUEST_EXIT;\r
204 }\r
205 }\r
206 } else if (Action == EFI_BROWSER_ACTION_CHANGING) {\r
207 if (Value == NULL) {\r
208 return EFI_INVALID_PARAMETER;\r
209 }\r
210 \r
211 if (QuestionId >= FILE_OPTION_OFFSET) {\r
212 Status = LibUpdateFileExplorer (QuestionId);\r
213 if (EFI_ERROR (Status)) {\r
214 return Status;\r
215 }\r
216 }\r
217 }\r
218\r
219 return EFI_SUCCESS;\r
220}\r
221\r
222/**\r
223 Create a menu entry by given menu type.\r
224\r
225 @retval NULL If failed to create the menu.\r
226 @return the new menu entry.\r
227\r
228**/\r
229MENU_ENTRY *\r
230LibCreateMenuEntry (\r
231 VOID\r
232 )\r
233{\r
234 MENU_ENTRY *MenuEntry;\r
235\r
236 //\r
237 // Create new menu entry\r
238 //\r
239 MenuEntry = AllocateZeroPool (sizeof (MENU_ENTRY));\r
240 if (MenuEntry == NULL) {\r
241 return NULL;\r
242 }\r
243\r
244 MenuEntry->VariableContext = AllocateZeroPool (sizeof (FILE_CONTEXT));\r
245 if (MenuEntry->VariableContext == NULL) {\r
246 FreePool (MenuEntry);\r
247 return NULL;\r
248 }\r
249\r
250 MenuEntry->Signature = MENU_ENTRY_SIGNATURE;\r
251 return MenuEntry;\r
252}\r
253\r
254\r
255/**\r
256 Get the Menu Entry from the list in Menu Entry List.\r
257\r
258 If MenuNumber is great or equal to the number of Menu\r
259 Entry in the list, then ASSERT.\r
260\r
261 @param MenuOption The Menu Entry List to read the menu entry.\r
262 @param MenuNumber The index of Menu Entry.\r
263\r
264 @return The Menu Entry.\r
265\r
266**/\r
267MENU_ENTRY *\r
268LibGetMenuEntry (\r
269 MENU_OPTION *MenuOption,\r
270 UINTN MenuNumber\r
271 )\r
272{\r
273 MENU_ENTRY *NewMenuEntry;\r
274 UINTN Index;\r
275 LIST_ENTRY *List;\r
276\r
277 ASSERT (MenuNumber < MenuOption->MenuNumber);\r
278\r
279 List = MenuOption->Head.ForwardLink;\r
280 for (Index = 0; Index < MenuNumber; Index++) {\r
281 List = List->ForwardLink;\r
282 }\r
283\r
284 NewMenuEntry = CR (List, MENU_ENTRY, Link, MENU_ENTRY_SIGNATURE);\r
285\r
286 return NewMenuEntry;\r
287}\r
288\r
289/**\r
290 Free up all resource allocated for a BM_MENU_ENTRY.\r
291\r
292 @param MenuEntry A pointer to BM_MENU_ENTRY.\r
293\r
294**/\r
295VOID\r
296LibDestroyMenuEntry (\r
297 MENU_ENTRY *MenuEntry\r
298 )\r
299{\r
300 FILE_CONTEXT *FileContext;\r
301\r
302 FileContext = (FILE_CONTEXT *) MenuEntry->VariableContext;\r
303\r
304 if (!FileContext->IsRoot) {\r
bbd6b010
DB
305 if (FileContext->DevicePath != NULL) {\r
306 FreePool (FileContext->DevicePath);\r
307 }\r
4c8274a0
ED
308 } else {\r
309 if (FileContext->FileHandle != NULL) {\r
310 FileContext->FileHandle->Close (FileContext->FileHandle);\r
311 }\r
312 }\r
313\r
314 if (FileContext->FileName != NULL) {\r
315 FreePool (FileContext->FileName);\r
316 }\r
317\r
318 FreePool (FileContext);\r
319\r
bbd6b010
DB
320 if (MenuEntry->DisplayString != NULL) {\r
321 FreePool (MenuEntry->DisplayString);\r
322 }\r
4c8274a0
ED
323 if (MenuEntry->HelpString != NULL) {\r
324 FreePool (MenuEntry->HelpString);\r
325 }\r
326\r
327 FreePool (MenuEntry);\r
328}\r
329\r
330\r
331/**\r
332 Free resources allocated in Allocate Rountine.\r
333\r
334 @param FreeMenu Menu to be freed\r
335**/\r
336VOID\r
337LibFreeMenu (\r
338 MENU_OPTION *FreeMenu\r
339 )\r
340{\r
341 MENU_ENTRY *MenuEntry;\r
342 while (!IsListEmpty (&FreeMenu->Head)) {\r
343 MenuEntry = CR (\r
344 FreeMenu->Head.ForwardLink,\r
345 MENU_ENTRY,\r
346 Link,\r
347 MENU_ENTRY_SIGNATURE\r
348 );\r
349 RemoveEntryList (&MenuEntry->Link);\r
350 LibDestroyMenuEntry (MenuEntry);\r
351 }\r
352 FreeMenu->MenuNumber = 0;\r
353}\r
354\r
355/**\r
356\r
357 Function opens and returns a file handle to the root directory of a volume.\r
358\r
359 @param DeviceHandle A handle for a device\r
360\r
361 @return A valid file handle or NULL is returned\r
362\r
363**/\r
364EFI_FILE_HANDLE\r
365LibOpenRoot (\r
366 IN EFI_HANDLE DeviceHandle\r
367 )\r
368{\r
369 EFI_STATUS Status;\r
370 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Volume;\r
371 EFI_FILE_HANDLE File;\r
372\r
373 File = NULL;\r
374\r
375 //\r
376 // File the file system interface to the device\r
377 //\r
378 Status = gBS->HandleProtocol (\r
379 DeviceHandle,\r
380 &gEfiSimpleFileSystemProtocolGuid,\r
381 (VOID *) &Volume\r
382 );\r
383\r
384 //\r
385 // Open the root directory of the volume\r
386 //\r
387 if (!EFI_ERROR (Status)) {\r
388 Status = Volume->OpenVolume (\r
389 Volume,\r
390 &File\r
391 );\r
392 }\r
393 //\r
394 // Done\r
395 //\r
396 return EFI_ERROR (Status) ? NULL : File;\r
397}\r
398\r
399/**\r
400 This function converts an input device structure to a Unicode string.\r
401\r
402 @param DevPath A pointer to the device path structure.\r
403\r
404 @return A new allocated Unicode string that represents the device path.\r
405\r
406**/\r
407CHAR16 *\r
408LibDevicePathToStr (\r
409 IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
410 )\r
411{\r
412 EFI_STATUS Status;\r
413 CHAR16 *ToText;\r
414 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL *DevPathToText;\r
415\r
416 if (DevPath == NULL) {\r
417 return NULL;\r
418 }\r
419\r
420 Status = gBS->LocateProtocol (\r
421 &gEfiDevicePathToTextProtocolGuid,\r
422 NULL,\r
423 (VOID **) &DevPathToText\r
424 );\r
425 ASSERT_EFI_ERROR (Status);\r
426 ToText = DevPathToText->ConvertDevicePathToText (\r
427 DevPath,\r
428 FALSE,\r
429 TRUE\r
430 );\r
431 ASSERT (ToText != NULL);\r
432\r
433 return ToText;\r
434}\r
435\r
436/**\r
437 Duplicate a string.\r
438\r
439 @param Src The source.\r
440\r
441 @return A new string which is duplicated copy of the source.\r
442 @retval NULL If there is not enough memory.\r
443\r
444**/\r
445CHAR16 *\r
446LibStrDuplicate (\r
447 IN CHAR16 *Src\r
448 )\r
449{\r
450 CHAR16 *Dest;\r
451 UINTN Size;\r
452\r
453 Size = StrSize (Src);\r
454 Dest = AllocateZeroPool (Size);\r
455 ASSERT (Dest != NULL);\r
456 if (Dest != NULL) {\r
457 CopyMem (Dest, Src, Size);\r
458 }\r
459\r
460 return Dest;\r
461}\r
462\r
463/**\r
464\r
465 Function gets the file information from an open file descriptor, and stores it\r
466 in a buffer allocated from pool.\r
467\r
468 @param FHand File Handle.\r
469 @param InfoType Info type need to get.\r
470\r
471 @retval A pointer to a buffer with file information or NULL is returned\r
472\r
473**/\r
474VOID *\r
475LibFileInfo (\r
476 IN EFI_FILE_HANDLE FHand,\r
477 IN EFI_GUID *InfoType\r
478 )\r
479{\r
480 EFI_STATUS Status;\r
481 EFI_FILE_INFO *Buffer;\r
482 UINTN BufferSize;\r
483\r
484 Buffer = NULL;\r
485 BufferSize = 0;\r
486 \r
487 Status = FHand->GetInfo (\r
488 FHand,\r
489 InfoType,\r
490 &BufferSize,\r
491 Buffer\r
492 );\r
493 if (Status == EFI_BUFFER_TOO_SMALL) {\r
494 Buffer = AllocatePool (BufferSize);\r
495 ASSERT (Buffer != NULL);\r
496 }\r
497\r
498 Status = FHand->GetInfo (\r
499 FHand,\r
500 InfoType,\r
501 &BufferSize,\r
502 Buffer\r
503 );\r
504\r
505 return Buffer;\r
506}\r
507\r
508/**\r
509\r
510 Get file type base on the file name.\r
511 Just cut the file name, from the ".". eg ".efi"\r
512\r
513 @param FileName File need to be checked.\r
514\r
515 @retval the file type string.\r
516\r
517**/\r
518CHAR16*\r
519LibGetTypeFromName (\r
520 IN CHAR16 *FileName\r
521 )\r
522{\r
523 UINTN Index;\r
524\r
525 Index = StrLen (FileName) - 1;\r
526 while ((FileName[Index] != L'.') && (Index != 0)) {\r
527 Index--;\r
528 }\r
529\r
530 return Index == 0 ? NULL : &FileName[Index];\r
531}\r
532\r
533/**\r
534 Converts the unicode character of the string from uppercase to lowercase.\r
535 This is a internal function.\r
536\r
537 @param ConfigString String to be converted\r
538\r
539**/\r
540VOID\r
541LibToLowerString (\r
542 IN CHAR16 *String\r
543 )\r
544{\r
545 CHAR16 *TmpStr;\r
546\r
547 for (TmpStr = String; *TmpStr != L'\0'; TmpStr++) {\r
548 if (*TmpStr >= L'A' && *TmpStr <= L'Z') {\r
549 *TmpStr = (CHAR16) (*TmpStr - L'A' + L'a');\r
550 }\r
551 }\r
552}\r
553\r
554/**\r
555\r
556 Check whether current FileName point to a valid\r
557 Efi Image File.\r
558\r
559 @param FileName File need to be checked.\r
560\r
561 @retval TRUE Is Efi Image\r
562 @retval FALSE Not a valid Efi Image\r
563\r
564**/\r
565BOOLEAN\r
566LibIsSupportedFileType (\r
567 IN UINT16 *FileName\r
568 )\r
569{\r
570 CHAR16 *InputFileType;\r
571 CHAR16 *TmpStr;\r
572 BOOLEAN IsSupported;\r
573\r
574 if (gFileExplorerPrivate.FileType == NULL) {\r
575 return TRUE;\r
576 }\r
577\r
578 InputFileType = LibGetTypeFromName (FileName);\r
579 //\r
580 // If the file not has *.* style, always return TRUE.\r
581 //\r
582 if (InputFileType == NULL) {\r
583 return TRUE;\r
584 }\r
585\r
586 TmpStr = AllocateCopyPool (StrSize (InputFileType), InputFileType);\r
d0d34cdf 587 ASSERT(TmpStr != NULL);\r
4c8274a0
ED
588 LibToLowerString(TmpStr);\r
589\r
590 IsSupported = (StrStr (gFileExplorerPrivate.FileType, TmpStr) == NULL ? FALSE : TRUE);\r
591\r
592 FreePool (TmpStr);\r
593 return IsSupported;\r
594}\r
595\r
596/**\r
597\r
598 Append file name to existing file name.\r
599\r
600 @param Str1 The existing file name\r
601 @param Str2 The file name to be appended\r
602\r
603 @return Allocate a new string to hold the appended result.\r
604 Caller is responsible to free the returned string.\r
605\r
606**/\r
607CHAR16 *\r
608LibAppendFileName (\r
609 IN CHAR16 *Str1,\r
610 IN CHAR16 *Str2\r
611 )\r
612{\r
613 UINTN Size1;\r
614 UINTN Size2;\r
615 UINTN MaxLen;\r
616 CHAR16 *Str;\r
617 CHAR16 *TmpStr;\r
618 CHAR16 *Ptr;\r
619 CHAR16 *LastSlash;\r
620\r
621 Size1 = StrSize (Str1);\r
622 Size2 = StrSize (Str2);\r
aaba2a44
LG
623 \r
624 //\r
625 // Check overflow\r
626 //\r
627 if (((MAX_UINTN - Size1) < Size2) || ((MAX_UINTN - Size1 - Size2) < sizeof(CHAR16))) {\r
628 return NULL;\r
629 }\r
630 \r
4c8274a0
ED
631 MaxLen = (Size1 + Size2 + sizeof (CHAR16))/ sizeof (CHAR16);\r
632 Str = AllocateZeroPool (Size1 + Size2 + sizeof (CHAR16));\r
633 ASSERT (Str != NULL);\r
634\r
635 TmpStr = AllocateZeroPool (Size1 + Size2 + sizeof (CHAR16)); \r
636 ASSERT (TmpStr != NULL);\r
637\r
638 StrCpyS (Str, MaxLen, Str1);\r
639 if (!((*Str == '\\') && (*(Str + 1) == 0))) {\r
640 StrCatS (Str, MaxLen, L"\\");\r
641 }\r
642\r
643 StrCatS (Str, MaxLen, Str2);\r
644\r
645 Ptr = Str;\r
646 LastSlash = Str;\r
647 while (*Ptr != 0) {\r
648 if (*Ptr == '\\' && *(Ptr + 1) == '.' && *(Ptr + 2) == '.' && *(Ptr + 3) == L'\\') {\r
649 //\r
650 // Convert "\Name\..\" to "\"\r
651 // DO NOT convert the .. if it is at the end of the string. This will\r
652 // break the .. behavior in changing directories.\r
653 //\r
654\r
655 //\r
656 // Use TmpStr as a backup, as StrCpyS in BaseLib does not handle copy of two strings \r
657 // that overlap.\r
658 //\r
659 StrCpyS (TmpStr, MaxLen, Ptr + 3);\r
660 StrCpyS (LastSlash, MaxLen - (UINTN) (LastSlash - Str), TmpStr);\r
661 Ptr = LastSlash;\r
662 } else if (*Ptr == '\\' && *(Ptr + 1) == '.' && *(Ptr + 2) == '\\') {\r
663 //\r
664 // Convert a "\.\" to a "\"\r
665 //\r
666\r
667 //\r
668 // Use TmpStr as a backup, as StrCpyS in BaseLib does not handle copy of two strings \r
669 // that overlap.\r
670 //\r
671 StrCpyS (TmpStr, MaxLen, Ptr + 2);\r
672 StrCpyS (Ptr, MaxLen - (UINTN) (Ptr - Str), TmpStr);\r
673 Ptr = LastSlash;\r
674 } else if (*Ptr == '\\') {\r
675 LastSlash = Ptr;\r
676 }\r
677\r
678 Ptr++;\r
679 }\r
680\r
681 FreePool (TmpStr);\r
682 \r
683 return Str;\r
684}\r
685\r
686/**\r
687 This function build the FsOptionMenu list which records all\r
688 available file system in the system. They includes all instances\r
689 of EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, all instances of EFI_LOAD_FILE_SYSTEM.\r
690\r
691\r
692 @retval EFI_SUCCESS Success find the file system\r
693 @retval EFI_OUT_OF_RESOURCES Can not create menu entry\r
694\r
695**/\r
696EFI_STATUS\r
697LibFindFileSystem (\r
698 VOID\r
699 )\r
700{\r
701 UINTN NoSimpleFsHandles;\r
4c8274a0 702 EFI_HANDLE *SimpleFsHandle;\r
4c8274a0
ED
703 UINT16 *VolumeLabel;\r
704 UINTN Index;\r
705 EFI_STATUS Status;\r
706 MENU_ENTRY *MenuEntry;\r
707 FILE_CONTEXT *FileContext;\r
708 UINTN OptionNumber;\r
709 EFI_FILE_SYSTEM_VOLUME_LABEL *Info;\r
710\r
711 NoSimpleFsHandles = 0;\r
4c8274a0
ED
712 OptionNumber = 0;\r
713\r
714 //\r
715 // Locate Handles that support Simple File System protocol\r
716 //\r
717 Status = gBS->LocateHandleBuffer (\r
718 ByProtocol,\r
719 &gEfiSimpleFileSystemProtocolGuid,\r
720 NULL,\r
721 &NoSimpleFsHandles,\r
722 &SimpleFsHandle\r
723 );\r
724 if (!EFI_ERROR (Status)) {\r
725 //\r
726 // Find all the instances of the File System prototocol\r
727 //\r
728 for (Index = 0; Index < NoSimpleFsHandles; Index++) {\r
729 //\r
730 // Allocate pool for this load option\r
731 //\r
732 MenuEntry = LibCreateMenuEntry ();\r
733 if (NULL == MenuEntry) {\r
734 FreePool (SimpleFsHandle);\r
735 return EFI_OUT_OF_RESOURCES;\r
736 }\r
737\r
738 FileContext = (FILE_CONTEXT *) MenuEntry->VariableContext;\r
739 FileContext->DeviceHandle = SimpleFsHandle[Index];\r
740 FileContext->FileHandle = LibOpenRoot (FileContext->DeviceHandle);\r
741 if (FileContext->FileHandle == NULL) {\r
742 LibDestroyMenuEntry (MenuEntry);\r
743 continue;\r
744 }\r
745\r
746 MenuEntry->HelpString = LibDevicePathToStr (DevicePathFromHandle (FileContext->DeviceHandle));\r
747 FileContext->FileName = LibStrDuplicate (L"\\");\r
748 FileContext->DevicePath = FileDevicePath (FileContext->DeviceHandle, FileContext->FileName);\r
749 FileContext->IsDir = TRUE;\r
750 FileContext->IsRoot = TRUE;\r
751\r
752 //\r
753 // Get current file system's Volume Label\r
754 //\r
755 Info = (EFI_FILE_SYSTEM_VOLUME_LABEL *) LibFileInfo (FileContext->FileHandle, &gEfiFileSystemVolumeLabelInfoIdGuid);\r
756 if (Info == NULL) {\r
757 VolumeLabel = L"NO FILE SYSTEM INFO";\r
758 } else {\r
759 if (Info->VolumeLabel == NULL) {\r
760 VolumeLabel = L"NULL VOLUME LABEL";\r
761 } else {\r
762 VolumeLabel = Info->VolumeLabel;\r
763 if (*VolumeLabel == 0x0000) {\r
764 VolumeLabel = L"NO VOLUME LABEL";\r
765 }\r
766 }\r
767 }\r
768 MenuEntry->DisplayString = AllocateZeroPool (MAX_CHAR);\r
769 ASSERT (MenuEntry->DisplayString != NULL);\r
770 UnicodeSPrint (\r
771 MenuEntry->DisplayString,\r
772 MAX_CHAR,\r
773 L"%s, [%s]",\r
774 VolumeLabel,\r
775 MenuEntry->HelpString\r
776 );\r
777 MenuEntry->DisplayStringToken = HiiSetString (\r
778 gFileExplorerPrivate.FeHiiHandle,\r
779 0,\r
780 MenuEntry->DisplayString,\r
781 NULL\r
782 );\r
140cc800
MZ
783\r
784 if (Info != NULL)\r
785 FreePool (Info);\r
4c8274a0
ED
786\r
787 OptionNumber++;\r
788 InsertTailList (&gFileExplorerPrivate.FsOptionMenu->Head, &MenuEntry->Link);\r
789 }\r
790 }\r
791\r
792 if (NoSimpleFsHandles != 0) {\r
793 FreePool (SimpleFsHandle);\r
794 }\r
795\r
4c8274a0
ED
796 gFileExplorerPrivate.FsOptionMenu->MenuNumber = OptionNumber;\r
797\r
798 return EFI_SUCCESS;\r
799}\r
800\r
801/**\r
802 Find the file handle from the input menu info.\r
803 \r
804 @param MenuEntry Input Menu info.\r
805 @param RetFileHandle Return the file handle for the input device path.\r
806 \r
807 @retval EFI_SUCESS Find the file handle success.\r
808 @retval Other Find the file handle failure.\r
809**/\r
810EFI_STATUS\r
811LibGetFileHandleFromMenu (\r
812 IN MENU_ENTRY *MenuEntry, \r
813 OUT EFI_FILE_HANDLE *RetFileHandle\r
814 )\r
815{\r
816 EFI_FILE_HANDLE Dir;\r
817 EFI_FILE_HANDLE NewDir;\r
818 FILE_CONTEXT *FileContext;\r
819 EFI_STATUS Status;\r
820\r
821 FileContext = (FILE_CONTEXT *) MenuEntry->VariableContext;\r
822 Dir = FileContext->FileHandle;\r
823\r
824 //\r
825 // Open current directory to get files from it\r
826 //\r
827 Status = Dir->Open (\r
828 Dir,\r
829 &NewDir,\r
830 FileContext->FileName,\r
831 EFI_FILE_READ_ONLY,\r
832 0\r
833 );\r
834 if (EFI_ERROR (Status)) {\r
835 return Status;\r
836 }\r
837\r
838 if (!FileContext->IsRoot) {\r
839 Dir->Close (Dir);\r
840 }\r
841\r
842 *RetFileHandle = NewDir;\r
843\r
844 return EFI_SUCCESS;\r
845}\r
846\r
847/**\r
848 Find the file handle from the input device path info.\r
849 \r
850 @param RootDirectory Device path info.\r
851 @param RetFileHandle Return the file handle for the input device path.\r
852 @param ParentFileName Parent file name.\r
853 @param DeviceHandle Driver handle for this partition.\r
854 \r
855 @retval EFI_SUCESS Find the file handle success.\r
856 @retval Other Find the file handle failure.\r
857**/\r
858EFI_STATUS\r
859LibGetFileHandleFromDevicePath (\r
860 IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory, \r
861 OUT EFI_FILE_HANDLE *RetFileHandle,\r
862 OUT UINT16 **ParentFileName,\r
863 OUT EFI_HANDLE *DeviceHandle\r
864 )\r
865{\r
866 EFI_DEVICE_PATH_PROTOCOL *DevicePathNode;\r
867 EFI_DEVICE_PATH_PROTOCOL *TempDevicePathNode;\r
868 EFI_STATUS Status;\r
869 EFI_HANDLE Handle;\r
870 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Volume;\r
871 EFI_FILE_HANDLE FileHandle;\r
872 EFI_FILE_HANDLE LastHandle;\r
873 CHAR16 *TempPath;\r
874\r
875 *ParentFileName = NULL;\r
876\r
877 //\r
878 // Attempt to access the file via a file system interface\r
879 //\r
880 DevicePathNode = RootDirectory;\r
881 Status = gBS->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid, &DevicePathNode, &Handle);\r
882 if (EFI_ERROR (Status)) {\r
883 return Status;\r
884 }\r
885 \r
886 Status = gBS->HandleProtocol (Handle, &gEfiSimpleFileSystemProtocolGuid, (VOID**)&Volume);\r
887 if (EFI_ERROR (Status)) {\r
888 return Status;\r
889 }\r
890 \r
891 //\r
892 // Open the Volume to get the File System handle\r
893 //\r
894 Status = Volume->OpenVolume (Volume, &FileHandle);\r
895 if (EFI_ERROR (Status)) {\r
896 return Status;\r
897 }\r
898\r
899 *DeviceHandle = Handle;\r
900\r
901 if (IsDevicePathEnd(DevicePathNode)) {\r
902 *ParentFileName = AllocateCopyPool (StrSize (L"\\"), L"\\");\r
903 *RetFileHandle = FileHandle;\r
904 return EFI_SUCCESS;\r
905 }\r
906 \r
907 //\r
908 // Duplicate the device path to avoid the access to unaligned device path node.\r
909 // Because the device path consists of one or more FILE PATH MEDIA DEVICE PATH\r
910 // nodes, It assures the fields in device path nodes are 2 byte aligned.\r
911 //\r
912 TempDevicePathNode = DuplicateDevicePath (DevicePathNode);\r
913 if (TempDevicePathNode == NULL) {\r
914\r
915 //\r
916 // Setting Status to an EFI_ERROR value will cause the rest of\r
917 // the file system support below to be skipped.\r
918 //\r
919 Status = EFI_OUT_OF_RESOURCES;\r
aaba2a44 920 goto Done;\r
4c8274a0
ED
921 }\r
922 \r
923 //\r
924 // Parse each MEDIA_FILEPATH_DP node. There may be more than one, since the\r
925 // directory information and filename can be seperate. The goal is to inch\r
926 // our way down each device path node and close the previous node\r
927 //\r
928 DevicePathNode = TempDevicePathNode;\r
929 while (!EFI_ERROR (Status) && !IsDevicePathEnd (DevicePathNode)) {\r
930 if (DevicePathType (DevicePathNode) != MEDIA_DEVICE_PATH ||\r
931 DevicePathSubType (DevicePathNode) != MEDIA_FILEPATH_DP) {\r
932 Status = EFI_UNSUPPORTED;\r
933 goto Done;\r
934 }\r
935\r
936 LastHandle = FileHandle;\r
937 FileHandle = NULL;\r
938\r
939 Status = LastHandle->Open (\r
940 LastHandle,\r
941 &FileHandle,\r
942 ((FILEPATH_DEVICE_PATH *) DevicePathNode)->PathName,\r
943 EFI_FILE_MODE_READ,\r
944 0\r
945 );\r
946 if (*ParentFileName == NULL) {\r
947 *ParentFileName = AllocateCopyPool (StrSize (((FILEPATH_DEVICE_PATH *) DevicePathNode)->PathName), ((FILEPATH_DEVICE_PATH *) DevicePathNode)->PathName);\r
948 } else {\r
949 TempPath = LibAppendFileName (*ParentFileName, ((FILEPATH_DEVICE_PATH *) DevicePathNode)->PathName);\r
aaba2a44
LG
950 if (TempPath == NULL) {\r
951 LastHandle->Close (LastHandle);\r
952 Status = EFI_OUT_OF_RESOURCES;\r
953 goto Done;\r
954 }\r
4c8274a0
ED
955 FreePool (*ParentFileName);\r
956 *ParentFileName = TempPath;\r
957 }\r
958\r
959 //\r
960 // Close the previous node\r
961 //\r
962 LastHandle->Close (LastHandle);\r
963\r
964 DevicePathNode = NextDevicePathNode (DevicePathNode);\r
965 }\r
966\r
967 if (EFI_ERROR (Status)) {\r
968 goto Done;\r
969 }\r
970\r
971 *RetFileHandle = FileHandle;\r
972\r
973 Status = EFI_SUCCESS;\r
974\r
975Done:\r
976 if (TempDevicePathNode != NULL) {\r
977 FreePool (TempDevicePathNode);\r
978 }\r
979\r
980 if ((FileHandle != NULL) && (EFI_ERROR (Status))) {\r
981 FileHandle->Close (FileHandle);\r
982 }\r
983\r
984 return Status;\r
985}\r
986\r
987/**\r
988 Find files under current directory.\r
989 \r
990 All files and sub-directories in current directory\r
991 will be stored in DirectoryMenu for future use.\r
992\r
993 @param FileHandle Parent file handle. \r
994 @param FileName Parent file name.\r
995 @param DeviceHandle Driver handle for this partition.\r
996\r
997 @retval EFI_SUCCESS Get files from current dir successfully.\r
998 @return Other value if can't get files from current dir.\r
999\r
1000**/\r
1001EFI_STATUS\r
1002LibFindFiles (\r
1003 IN EFI_FILE_HANDLE FileHandle,\r
1004 IN UINT16 *FileName,\r
1005 IN EFI_HANDLE DeviceHandle\r
1006 )\r
1007{\r
1008 EFI_FILE_INFO *DirInfo;\r
1009 UINTN BufferSize;\r
1010 UINTN DirBufferSize;\r
1011 MENU_ENTRY *NewMenuEntry;\r
1012 FILE_CONTEXT *NewFileContext;\r
1013 UINTN Pass;\r
1014 EFI_STATUS Status;\r
1015 UINTN OptionNumber;\r
1016\r
1017 OptionNumber = 0;\r
1018\r
1019 DirBufferSize = sizeof (EFI_FILE_INFO) + 1024;\r
1020 DirInfo = AllocateZeroPool (DirBufferSize);\r
1021 if (DirInfo == NULL) {\r
1022 return EFI_OUT_OF_RESOURCES;\r
1023 }\r
1024\r
1025 //\r
1026 // Get all files in current directory\r
1027 // Pass 1 to get Directories\r
1028 // Pass 2 to get files that are EFI images\r
1029 //\r
aaba2a44 1030 Status = EFI_SUCCESS;\r
4c8274a0
ED
1031 for (Pass = 1; Pass <= 2; Pass++) {\r
1032 FileHandle->SetPosition (FileHandle, 0);\r
1033 for (;;) {\r
1034 BufferSize = DirBufferSize;\r
1035 Status = FileHandle->Read (FileHandle, &BufferSize, DirInfo);\r
1036 if (EFI_ERROR (Status) || BufferSize == 0) {\r
aaba2a44 1037 Status = EFI_SUCCESS;\r
4c8274a0
ED
1038 break;\r
1039 }\r
1040\r
1041 if (((DirInfo->Attribute & EFI_FILE_DIRECTORY) != 0 && Pass == 2) ||\r
1042 ((DirInfo->Attribute & EFI_FILE_DIRECTORY) == 0 && Pass == 1)\r
1043 ) {\r
1044 //\r
1045 // Pass 1 is for Directories\r
1046 // Pass 2 is for file names\r
1047 //\r
1048 continue;\r
1049 }\r
1050\r
1051 if (!((DirInfo->Attribute & EFI_FILE_DIRECTORY) != 0 || LibIsSupportedFileType (DirInfo->FileName))) {\r
1052 //\r
1053 // Slip file unless it is a directory entry or a .EFI file\r
1054 //\r
1055 continue;\r
1056 }\r
1057\r
1058 NewMenuEntry = LibCreateMenuEntry ();\r
1059 if (NULL == NewMenuEntry) {\r
aaba2a44
LG
1060 Status = EFI_OUT_OF_RESOURCES;\r
1061 goto Done;\r
4c8274a0
ED
1062 }\r
1063\r
1064 NewFileContext = (FILE_CONTEXT *) NewMenuEntry->VariableContext;\r
1065 NewFileContext->DeviceHandle = DeviceHandle;\r
1066 NewFileContext->FileName = LibAppendFileName (FileName, DirInfo->FileName);\r
aaba2a44
LG
1067 if (NewFileContext->FileName == NULL) {\r
1068 LibDestroyMenuEntry (NewMenuEntry);\r
1069 Status = EFI_OUT_OF_RESOURCES;\r
1070 goto Done;\r
1071 }\r
4c8274a0
ED
1072 NewFileContext->FileHandle = FileHandle;\r
1073 NewFileContext->DevicePath = FileDevicePath (NewFileContext->DeviceHandle, NewFileContext->FileName);\r
1074 NewMenuEntry->HelpString = NULL;\r
1075 NewFileContext->IsDir = (BOOLEAN) ((DirInfo->Attribute & EFI_FILE_DIRECTORY) == EFI_FILE_DIRECTORY);\r
1076\r
1077 if (NewFileContext->IsDir) {\r
1078 BufferSize = StrLen (DirInfo->FileName) * 2 + 6;\r
1079 NewMenuEntry->DisplayString = AllocateZeroPool (BufferSize);\r
1080 UnicodeSPrint (\r
1081 NewMenuEntry->DisplayString,\r
1082 BufferSize,\r
1083 L"<%s>",\r
1084 DirInfo->FileName\r
1085 );\r
1086 } else {\r
1087 NewMenuEntry->DisplayString = LibStrDuplicate (DirInfo->FileName);\r
1088 }\r
1089 \r
1090 NewMenuEntry->DisplayStringToken = HiiSetString (\r
1091 gFileExplorerPrivate.FeHiiHandle,\r
1092 0,\r
1093 NewMenuEntry->DisplayString,\r
1094 NULL\r
1095 );\r
1096\r
1097 NewFileContext->IsRoot = FALSE;\r
1098\r
1099 OptionNumber++;\r
1100 InsertTailList (&gFileExplorerPrivate.FsOptionMenu->Head, &NewMenuEntry->Link);\r
1101 }\r
1102 }\r
1103\r
1104 gFileExplorerPrivate.FsOptionMenu->MenuNumber = OptionNumber;\r
1105\r
aaba2a44
LG
1106Done:\r
1107\r
4c8274a0
ED
1108 FreePool (DirInfo);\r
1109\r
aaba2a44 1110 return Status;\r
4c8274a0
ED
1111}\r
1112\r
1113/**\r
1114 Refresh the global UpdateData structure.\r
1115\r
1116**/\r
1117VOID\r
1118LibRefreshUpdateData (\r
1119 VOID\r
1120 )\r
1121{\r
1122 //\r
1123 // Free current updated date\r
1124 //\r
1125 if (mLibStartOpCodeHandle != NULL) {\r
1126 HiiFreeOpCodeHandle (mLibStartOpCodeHandle);\r
1127 }\r
1128 if (mLibEndOpCodeHandle != NULL) {\r
1129 HiiFreeOpCodeHandle (mLibEndOpCodeHandle);\r
1130 }\r
1131\r
1132 //\r
1133 // Create new OpCode Handle\r
1134 //\r
1135 mLibStartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
1136 mLibEndOpCodeHandle = HiiAllocateOpCodeHandle ();\r
1137\r
1138 //\r
1139 // Create Hii Extend Label OpCode as the start opcode\r
1140 //\r
1141 mLibStartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (\r
1142 mLibStartOpCodeHandle,\r
1143 &gEfiIfrTianoGuid,\r
1144 NULL,\r
1145 sizeof (EFI_IFR_GUID_LABEL)\r
1146 );\r
1147 mLibStartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
1148\r
1149 mLibStartLabel->Number = FORM_FILE_EXPLORER_ID;\r
1150\r
1151 //\r
1152 // Create Hii Extend Label OpCode as the start opcode\r
1153 //\r
1154 mLibEndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (\r
1155 mLibEndOpCodeHandle,\r
1156 &gEfiIfrTianoGuid,\r
1157 NULL,\r
1158 sizeof (EFI_IFR_GUID_LABEL)\r
1159 );\r
1160 mLibEndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
1161\r
1162 mLibEndLabel->Number = LABEL_END;\r
1163}\r
1164\r
1165/**\r
1166\r
1167 Update the File Explore page.\r
1168\r
1169**/\r
1170VOID\r
1171LibUpdateFileExplorePage (\r
1172 VOID\r
1173 )\r
1174{\r
1175 UINTN Index;\r
1176 MENU_ENTRY *NewMenuEntry;\r
1177 FILE_CONTEXT *NewFileContext;\r
1178 MENU_OPTION *MenuOption;\r
1179\r
1180 NewMenuEntry = NULL;\r
1181 NewFileContext = NULL;\r
1182\r
1183 LibRefreshUpdateData ();\r
1184 MenuOption = gFileExplorerPrivate.FsOptionMenu;\r
1185\r
1186 for (Index = 0; Index < MenuOption->MenuNumber; Index++) {\r
1187 NewMenuEntry = LibGetMenuEntry (MenuOption, Index);\r
1188 NewFileContext = (FILE_CONTEXT *) NewMenuEntry->VariableContext;\r
1189\r
1190 if (!NewFileContext->IsDir) {\r
1191 //\r
1192 // Create Text opcode for directory, also create Text opcode for file in FileExplorerStateBootFromFile.\r
1193 //\r
1194 HiiCreateActionOpCode (\r
1195 mLibStartOpCodeHandle,\r
1196 (UINT16) (FILE_OPTION_OFFSET + Index),\r
1197 NewMenuEntry->DisplayStringToken,\r
1198 STRING_TOKEN (STR_NULL_STRING),\r
1199 EFI_IFR_FLAG_CALLBACK,\r
1200 0\r
1201 );\r
1202 } else {\r
1203 //\r
1204 // Create Goto opcode for file in FileExplorerStateAddBootOption or FileExplorerStateAddDriverOptionState.\r
1205 //\r
1206 HiiCreateGotoOpCode (\r
1207 mLibStartOpCodeHandle,\r
1208 FORM_FILE_EXPLORER_ID,\r
1209 NewMenuEntry->DisplayStringToken,\r
1210 STRING_TOKEN (STR_NULL_STRING),\r
1211 EFI_IFR_FLAG_CALLBACK,\r
1212 (UINT16) (FILE_OPTION_OFFSET + Index)\r
1213 );\r
1214 }\r
1215 }\r
1216\r
1217 HiiUpdateForm (\r
1218 gFileExplorerPrivate.FeHiiHandle,\r
1219 &FileExplorerGuid,\r
1220 FORM_FILE_EXPLORER_ID,\r
1221 mLibStartOpCodeHandle, // Label FORM_FILE_EXPLORER_ID\r
1222 mLibEndOpCodeHandle // LABEL_END\r
1223 );\r
1224}\r
1225\r
1226/**\r
1227 Update the file explower page with the refershed file system.\r
1228\r
1229 @param KeyValue Key value to identify the type of data to expect.\r
1230\r
1231 @retval EFI_SUCCESS Update the file explorer form success.\r
1232 @retval other errors Error occur when parse one directory.\r
1233\r
1234**/\r
1235EFI_STATUS\r
1236LibUpdateFileExplorer (\r
1237 IN UINT16 KeyValue\r
1238 )\r
1239{\r
1240 UINT16 FileOptionMask;\r
1241 MENU_ENTRY *NewMenuEntry;\r
1242 FILE_CONTEXT *NewFileContext;\r
1243 EFI_STATUS Status;\r
1244 EFI_FILE_HANDLE FileHandle;\r
1245\r
1246 Status = EFI_SUCCESS;\r
1247 FileOptionMask = (UINT16) (FILE_OPTION_MASK & KeyValue);\r
1248 NewMenuEntry = LibGetMenuEntry (gFileExplorerPrivate.FsOptionMenu, FileOptionMask);\r
1249 NewFileContext = (FILE_CONTEXT *) NewMenuEntry->VariableContext;\r
1250\r
1251 if (NewFileContext->IsDir) {\r
1252 RemoveEntryList (&NewMenuEntry->Link);\r
1253 LibFreeMenu (gFileExplorerPrivate.FsOptionMenu);\r
1254 LibGetFileHandleFromMenu (NewMenuEntry, &FileHandle);\r
1255 Status = LibFindFiles (FileHandle, NewFileContext->FileName, NewFileContext->DeviceHandle);\r
1256 if (!EFI_ERROR (Status)) {\r
1257 LibUpdateFileExplorePage ();\r
1258 } else {\r
1259 LibFreeMenu (gFileExplorerPrivate.FsOptionMenu);\r
1260 }\r
1261 LibDestroyMenuEntry (NewMenuEntry);\r
1262 }\r
1263\r
1264 return Status;\r
1265}\r
1266\r
1267/**\r
1268 Get the device path info saved in the menu structure.\r
1269\r
1270 @param KeyValue Key value to identify the type of data to expect.\r
1271\r
1272**/\r
1273VOID\r
1274LibGetDevicePath (\r
1275 IN UINT16 KeyValue\r
1276 )\r
1277{\r
1278 UINT16 FileOptionMask;\r
1279 MENU_ENTRY *NewMenuEntry;\r
1280 FILE_CONTEXT *NewFileContext;\r
1281\r
1282 FileOptionMask = (UINT16) (FILE_OPTION_MASK & KeyValue);\r
1283\r
1284 NewMenuEntry = LibGetMenuEntry (gFileExplorerPrivate.FsOptionMenu, FileOptionMask);\r
1285\r
1286 NewFileContext = (FILE_CONTEXT *) NewMenuEntry->VariableContext;\r
1287\r
1288 if (gFileExplorerPrivate.RetDevicePath != NULL) {\r
1289 FreePool (gFileExplorerPrivate.RetDevicePath);\r
1290 }\r
1291 gFileExplorerPrivate.RetDevicePath = DuplicateDevicePath (NewFileContext->DevicePath);\r
1292}\r
1293\r
1294/**\r
1295 Choose a file in the specified directory. \r
1296\r
1297 If user input NULL for the RootDirectory, will choose file in the system.\r
1298\r
1299 If user input *File != NULL, function will return the allocate device path\r
1300 info for the choosed file, caller has to free the memory after use it.\r
1301\r
1302 @param RootDirectory Pointer to the root directory.\r
1303 @param FileType The file type need to choose.\r
1304 @param ChooseHandler Function pointer to the extra task need to do\r
1305 after choose one file.\r
1306 @param File Return the device path for the last time chosed file.\r
1307\r
1308 @retval EFI_SUCESS Choose file success.\r
1309 @retval EFI_INVALID_PARAMETER Both ChooseHandler and return device path are NULL\r
1310 One of them must not NULL.\r
1311 @retval Other errors Choose file failed.\r
1312**/\r
1313EFI_STATUS\r
1314EFIAPI\r
1315ChooseFile (\r
1316 IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory,\r
1317 IN CHAR16 *FileType, OPTIONAL\r
1318 IN CHOOSE_HANDLER ChooseHandler, OPTIONAL\r
1319 OUT EFI_DEVICE_PATH_PROTOCOL **File OPTIONAL\r
1320 )\r
1321{\r
1322 EFI_FILE_HANDLE FileHandle;\r
1323 EFI_STATUS Status;\r
1324 UINT16 *FileName;\r
1325 EFI_HANDLE DeviceHandle;\r
1326\r
1327 if ((ChooseHandler == NULL) && (File == NULL)) {\r
1328 return EFI_INVALID_PARAMETER;\r
1329 }\r
1330\r
1331 FileName = NULL;\r
1332\r
1333 gFileExplorerPrivate.RetDevicePath = NULL;\r
1334 gFileExplorerPrivate.ChooseHandler = ChooseHandler;\r
1335 if (FileType != NULL) {\r
1336 gFileExplorerPrivate.FileType = AllocateCopyPool (StrSize (FileType), FileType);\r
d0d34cdf 1337 ASSERT(gFileExplorerPrivate.FileType != NULL);\r
4c8274a0
ED
1338 LibToLowerString(gFileExplorerPrivate.FileType);\r
1339 } else {\r
1340 gFileExplorerPrivate.FileType = NULL;\r
1341 }\r
1342\r
1343 if (RootDirectory == NULL) {\r
1344 Status = LibFindFileSystem();\r
1345 } else {\r
1346 Status = LibGetFileHandleFromDevicePath(RootDirectory, &FileHandle, &FileName, &DeviceHandle);\r
1347 if (EFI_ERROR (Status)) {\r
1348 goto Done;\r
1349 }\r
1350\r
1351 Status = LibFindFiles (FileHandle, FileName, DeviceHandle);\r
1352 }\r
1353 if (EFI_ERROR (Status)) {\r
1354 goto Done;\r
1355 }\r
1356\r
1357 LibUpdateFileExplorePage();\r
1358\r
1359 gFileExplorerPrivate.FormBrowser2->SendForm (\r
1360 gFileExplorerPrivate.FormBrowser2,\r
1361 &gFileExplorerPrivate.FeHiiHandle,\r
1362 1,\r
1363 &FileExplorerGuid,\r
1364 0,\r
1365 NULL,\r
1366 NULL\r
1367 );\r
1368\r
1369Done:\r
1370 if ((Status == EFI_SUCCESS) && (File != NULL)) {\r
1371 *File = gFileExplorerPrivate.RetDevicePath;\r
1372 } else if (gFileExplorerPrivate.RetDevicePath != NULL) {\r
1373 FreePool (gFileExplorerPrivate.RetDevicePath);\r
1374 }\r
1375\r
1376 if (gFileExplorerPrivate.FileType != NULL) {\r
1377 FreePool (gFileExplorerPrivate.FileType);\r
1378 }\r
1379\r
1380 LibFreeMenu (gFileExplorerPrivate.FsOptionMenu);\r
1381\r
1382 if (FileName != NULL) {\r
1383 FreePool (FileName);\r
1384 }\r
1385\r
1386 return Status;\r
1387}\r
1388\r
1389/**\r
1390\r
1391 Install Boot Manager Menu driver.\r
1392\r
1393 @param ImageHandle The image handle.\r
1394 @param SystemTable The system table.\r
1395\r
1396 @retval EFI_SUCEESS Install File explorer library success.\r
1397\r
1398**/\r
1399EFI_STATUS\r
1400EFIAPI\r
1401FileExplorerLibConstructor (\r
1402 IN EFI_HANDLE ImageHandle,\r
1403 IN EFI_SYSTEM_TABLE *SystemTable\r
1404 )\r
1405{\r
1406 EFI_STATUS Status;\r
1407\r
1408 gHiiVendorDevicePath = (HII_VENDOR_DEVICE_PATH*) DuplicateDevicePath ((EFI_DEVICE_PATH_PROTOCOL*)&FeHiiVendorDevicePath);\r
1409 ASSERT (gHiiVendorDevicePath != NULL);\r
1410 CopyGuid (&gHiiVendorDevicePath->VendorDevicePath.Guid, &gEfiCallerIdGuid);\r
1411\r
1412 //\r
1413 // Install Device Path Protocol and Config Access protocol to driver handle\r
1414 //\r
1415 Status = gBS->InstallMultipleProtocolInterfaces (\r
1416 &gFileExplorerPrivate.FeDriverHandle,\r
1417 &gEfiDevicePathProtocolGuid,\r
1418 gHiiVendorDevicePath,\r
1419 &gEfiHiiConfigAccessProtocolGuid,\r
1420 &gFileExplorerPrivate.FeConfigAccess,\r
1421 NULL\r
1422 );\r
20fe1625
ED
1423 if (Status == EFI_ALREADY_STARTED) {\r
1424 return EFI_SUCCESS;\r
1425 }\r
1426 if (EFI_ERROR (Status)) {\r
1427 return Status;\r
1428 }\r
4c8274a0
ED
1429\r
1430 //\r
1431 // Post our File Explorer VFR binary to the HII database.\r
1432 //\r
1433 gFileExplorerPrivate.FeHiiHandle = HiiAddPackages (\r
1434 &FileExplorerGuid,\r
1435 gFileExplorerPrivate.FeDriverHandle,\r
1436 FileExplorerVfrBin,\r
1437 FileExplorerLibStrings,\r
1438 NULL\r
1439 );\r
1440 ASSERT (gFileExplorerPrivate.FeHiiHandle != NULL);\r
1441\r
1442 //\r
1443 // Locate Formbrowser2 protocol\r
1444 //\r
1445 Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &gFileExplorerPrivate.FormBrowser2);\r
1446 ASSERT_EFI_ERROR (Status);\r
1447 \r
1448 InitializeListHead (&gFileExplorerPrivate.FsOptionMenu->Head);\r
1449\r
1450 return EFI_SUCCESS;\r
1451}\r
1452\r
1453/**\r
1454 Unloads the application and its installed protocol.\r
1455\r
1456 @param[in] ImageHandle Handle that identifies the image to be unloaded.\r
1457 @param[in] SystemTable The system table.\r
1458\r
1459 @retval EFI_SUCCESS The image has been unloaded.\r
1460**/\r
1461EFI_STATUS\r
1462EFIAPI\r
1463FileExplorerLibDestructor (\r
1464 IN EFI_HANDLE ImageHandle,\r
1465 IN EFI_SYSTEM_TABLE *SystemTable\r
1466 )\r
1467{\r
1468 EFI_STATUS Status;\r
1469\r
1470 ASSERT (gHiiVendorDevicePath != NULL);\r
1471\r
20fe1625
ED
1472 if (gFileExplorerPrivate.FeDriverHandle != NULL) {\r
1473 Status = gBS->UninstallMultipleProtocolInterfaces (\r
1474 gFileExplorerPrivate.FeDriverHandle,\r
1475 &gEfiDevicePathProtocolGuid,\r
1476 gHiiVendorDevicePath,\r
1477 &gEfiHiiConfigAccessProtocolGuid,\r
1478 &gFileExplorerPrivate.FeConfigAccess,\r
1479 NULL\r
1480 );\r
1481 ASSERT_EFI_ERROR (Status);\r
1482 \r
1483 HiiRemovePackages (gFileExplorerPrivate.FeHiiHandle);\r
1484 }\r
4c8274a0
ED
1485\r
1486 FreePool (gHiiVendorDevicePath);\r
1487\r
1488 return EFI_SUCCESS;\r
1489}\r
1490\r