]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Library/FileExplorerLib/FileExplorer.c
MdeModulePkg: Add ASSERT to make sure pointers are not NULL
[mirror_edk2.git] / MdeModulePkg / Library / FileExplorerLib / FileExplorer.c
CommitLineData
4c8274a0
ED
1/** @file\r
2File explorer related functions.\r
3\r
20fe1625 4Copyright (c) 2004 - 2016, 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
623 MaxLen = (Size1 + Size2 + sizeof (CHAR16))/ sizeof (CHAR16);\r
624 Str = AllocateZeroPool (Size1 + Size2 + sizeof (CHAR16));\r
625 ASSERT (Str != NULL);\r
626\r
627 TmpStr = AllocateZeroPool (Size1 + Size2 + sizeof (CHAR16)); \r
628 ASSERT (TmpStr != NULL);\r
629\r
630 StrCpyS (Str, MaxLen, Str1);\r
631 if (!((*Str == '\\') && (*(Str + 1) == 0))) {\r
632 StrCatS (Str, MaxLen, L"\\");\r
633 }\r
634\r
635 StrCatS (Str, MaxLen, Str2);\r
636\r
637 Ptr = Str;\r
638 LastSlash = Str;\r
639 while (*Ptr != 0) {\r
640 if (*Ptr == '\\' && *(Ptr + 1) == '.' && *(Ptr + 2) == '.' && *(Ptr + 3) == L'\\') {\r
641 //\r
642 // Convert "\Name\..\" to "\"\r
643 // DO NOT convert the .. if it is at the end of the string. This will\r
644 // break the .. behavior in changing directories.\r
645 //\r
646\r
647 //\r
648 // Use TmpStr as a backup, as StrCpyS in BaseLib does not handle copy of two strings \r
649 // that overlap.\r
650 //\r
651 StrCpyS (TmpStr, MaxLen, Ptr + 3);\r
652 StrCpyS (LastSlash, MaxLen - (UINTN) (LastSlash - Str), TmpStr);\r
653 Ptr = LastSlash;\r
654 } else if (*Ptr == '\\' && *(Ptr + 1) == '.' && *(Ptr + 2) == '\\') {\r
655 //\r
656 // Convert a "\.\" to a "\"\r
657 //\r
658\r
659 //\r
660 // Use TmpStr as a backup, as StrCpyS in BaseLib does not handle copy of two strings \r
661 // that overlap.\r
662 //\r
663 StrCpyS (TmpStr, MaxLen, Ptr + 2);\r
664 StrCpyS (Ptr, MaxLen - (UINTN) (Ptr - Str), TmpStr);\r
665 Ptr = LastSlash;\r
666 } else if (*Ptr == '\\') {\r
667 LastSlash = Ptr;\r
668 }\r
669\r
670 Ptr++;\r
671 }\r
672\r
673 FreePool (TmpStr);\r
674 \r
675 return Str;\r
676}\r
677\r
678/**\r
679 This function build the FsOptionMenu list which records all\r
680 available file system in the system. They includes all instances\r
681 of EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, all instances of EFI_LOAD_FILE_SYSTEM.\r
682\r
683\r
684 @retval EFI_SUCCESS Success find the file system\r
685 @retval EFI_OUT_OF_RESOURCES Can not create menu entry\r
686\r
687**/\r
688EFI_STATUS\r
689LibFindFileSystem (\r
690 VOID\r
691 )\r
692{\r
693 UINTN NoSimpleFsHandles;\r
694 UINTN NoLoadFileHandles;\r
695 EFI_HANDLE *SimpleFsHandle;\r
696 EFI_HANDLE *LoadFileHandle;\r
697 UINT16 *VolumeLabel;\r
698 UINTN Index;\r
699 EFI_STATUS Status;\r
700 MENU_ENTRY *MenuEntry;\r
701 FILE_CONTEXT *FileContext;\r
702 UINTN OptionNumber;\r
703 EFI_FILE_SYSTEM_VOLUME_LABEL *Info;\r
704\r
705 NoSimpleFsHandles = 0;\r
706 NoLoadFileHandles = 0;\r
707 OptionNumber = 0;\r
708\r
709 //\r
710 // Locate Handles that support Simple File System protocol\r
711 //\r
712 Status = gBS->LocateHandleBuffer (\r
713 ByProtocol,\r
714 &gEfiSimpleFileSystemProtocolGuid,\r
715 NULL,\r
716 &NoSimpleFsHandles,\r
717 &SimpleFsHandle\r
718 );\r
719 if (!EFI_ERROR (Status)) {\r
720 //\r
721 // Find all the instances of the File System prototocol\r
722 //\r
723 for (Index = 0; Index < NoSimpleFsHandles; Index++) {\r
724 //\r
725 // Allocate pool for this load option\r
726 //\r
727 MenuEntry = LibCreateMenuEntry ();\r
728 if (NULL == MenuEntry) {\r
729 FreePool (SimpleFsHandle);\r
730 return EFI_OUT_OF_RESOURCES;\r
731 }\r
732\r
733 FileContext = (FILE_CONTEXT *) MenuEntry->VariableContext;\r
734 FileContext->DeviceHandle = SimpleFsHandle[Index];\r
735 FileContext->FileHandle = LibOpenRoot (FileContext->DeviceHandle);\r
736 if (FileContext->FileHandle == NULL) {\r
737 LibDestroyMenuEntry (MenuEntry);\r
738 continue;\r
739 }\r
740\r
741 MenuEntry->HelpString = LibDevicePathToStr (DevicePathFromHandle (FileContext->DeviceHandle));\r
742 FileContext->FileName = LibStrDuplicate (L"\\");\r
743 FileContext->DevicePath = FileDevicePath (FileContext->DeviceHandle, FileContext->FileName);\r
744 FileContext->IsDir = TRUE;\r
745 FileContext->IsRoot = TRUE;\r
746\r
747 //\r
748 // Get current file system's Volume Label\r
749 //\r
750 Info = (EFI_FILE_SYSTEM_VOLUME_LABEL *) LibFileInfo (FileContext->FileHandle, &gEfiFileSystemVolumeLabelInfoIdGuid);\r
751 if (Info == NULL) {\r
752 VolumeLabel = L"NO FILE SYSTEM INFO";\r
753 } else {\r
754 if (Info->VolumeLabel == NULL) {\r
755 VolumeLabel = L"NULL VOLUME LABEL";\r
756 } else {\r
757 VolumeLabel = Info->VolumeLabel;\r
758 if (*VolumeLabel == 0x0000) {\r
759 VolumeLabel = L"NO VOLUME LABEL";\r
760 }\r
761 }\r
762 }\r
763 MenuEntry->DisplayString = AllocateZeroPool (MAX_CHAR);\r
764 ASSERT (MenuEntry->DisplayString != NULL);\r
765 UnicodeSPrint (\r
766 MenuEntry->DisplayString,\r
767 MAX_CHAR,\r
768 L"%s, [%s]",\r
769 VolumeLabel,\r
770 MenuEntry->HelpString\r
771 );\r
772 MenuEntry->DisplayStringToken = HiiSetString (\r
773 gFileExplorerPrivate.FeHiiHandle,\r
774 0,\r
775 MenuEntry->DisplayString,\r
776 NULL\r
777 );\r
778 FreePool (Info);\r
779\r
780 OptionNumber++;\r
781 InsertTailList (&gFileExplorerPrivate.FsOptionMenu->Head, &MenuEntry->Link);\r
782 }\r
783 }\r
784\r
785 if (NoSimpleFsHandles != 0) {\r
786 FreePool (SimpleFsHandle);\r
787 }\r
788\r
789 //\r
790 // Searching for handles that support Load File protocol\r
791 //\r
792 Status = gBS->LocateHandleBuffer (\r
793 ByProtocol,\r
794 &gEfiLoadFileProtocolGuid,\r
795 NULL,\r
796 &NoLoadFileHandles,\r
797 &LoadFileHandle\r
798 );\r
799\r
800 if (!EFI_ERROR (Status)) {\r
801 for (Index = 0; Index < NoLoadFileHandles; Index++) {\r
802 MenuEntry = LibCreateMenuEntry ();\r
803 if (NULL == MenuEntry) {\r
804 FreePool (LoadFileHandle);\r
805 return EFI_OUT_OF_RESOURCES;\r
806 }\r
807\r
808 FileContext = (FILE_CONTEXT *) MenuEntry->VariableContext;\r
809 FileContext->DeviceHandle = LoadFileHandle[Index];\r
810 FileContext->IsRoot = TRUE;\r
811\r
812 FileContext->DevicePath = DevicePathFromHandle (FileContext->DeviceHandle);\r
813 FileContext->FileName = LibDevicePathToStr (FileContext->DevicePath);\r
814\r
815 MenuEntry->HelpString = LibDevicePathToStr (FileContext->DevicePath);\r
816 MenuEntry->DisplayString = AllocateZeroPool (MAX_CHAR);\r
817 ASSERT (MenuEntry->DisplayString != NULL);\r
818 UnicodeSPrint (\r
819 MenuEntry->DisplayString,\r
820 MAX_CHAR,\r
821 L"Load File [%s]",\r
822 MenuEntry->HelpString\r
823 );\r
824 MenuEntry->DisplayStringToken = HiiSetString (\r
825 gFileExplorerPrivate.FeHiiHandle,\r
826 0,\r
827 MenuEntry->DisplayString,\r
828 NULL\r
829 );\r
830\r
831 OptionNumber++;\r
832 InsertTailList (&gFileExplorerPrivate.FsOptionMenu->Head, &MenuEntry->Link);\r
833 }\r
834 }\r
835\r
836 if (NoLoadFileHandles != 0) {\r
837 FreePool (LoadFileHandle);\r
838 }\r
839\r
840 gFileExplorerPrivate.FsOptionMenu->MenuNumber = OptionNumber;\r
841\r
842 return EFI_SUCCESS;\r
843}\r
844\r
845/**\r
846 Find the file handle from the input menu info.\r
847 \r
848 @param MenuEntry Input Menu info.\r
849 @param RetFileHandle Return the file handle for the input device path.\r
850 \r
851 @retval EFI_SUCESS Find the file handle success.\r
852 @retval Other Find the file handle failure.\r
853**/\r
854EFI_STATUS\r
855LibGetFileHandleFromMenu (\r
856 IN MENU_ENTRY *MenuEntry, \r
857 OUT EFI_FILE_HANDLE *RetFileHandle\r
858 )\r
859{\r
860 EFI_FILE_HANDLE Dir;\r
861 EFI_FILE_HANDLE NewDir;\r
862 FILE_CONTEXT *FileContext;\r
863 EFI_STATUS Status;\r
864\r
865 FileContext = (FILE_CONTEXT *) MenuEntry->VariableContext;\r
866 Dir = FileContext->FileHandle;\r
867\r
868 //\r
869 // Open current directory to get files from it\r
870 //\r
871 Status = Dir->Open (\r
872 Dir,\r
873 &NewDir,\r
874 FileContext->FileName,\r
875 EFI_FILE_READ_ONLY,\r
876 0\r
877 );\r
878 if (EFI_ERROR (Status)) {\r
879 return Status;\r
880 }\r
881\r
882 if (!FileContext->IsRoot) {\r
883 Dir->Close (Dir);\r
884 }\r
885\r
886 *RetFileHandle = NewDir;\r
887\r
888 return EFI_SUCCESS;\r
889}\r
890\r
891/**\r
892 Find the file handle from the input device path info.\r
893 \r
894 @param RootDirectory Device path info.\r
895 @param RetFileHandle Return the file handle for the input device path.\r
896 @param ParentFileName Parent file name.\r
897 @param DeviceHandle Driver handle for this partition.\r
898 \r
899 @retval EFI_SUCESS Find the file handle success.\r
900 @retval Other Find the file handle failure.\r
901**/\r
902EFI_STATUS\r
903LibGetFileHandleFromDevicePath (\r
904 IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory, \r
905 OUT EFI_FILE_HANDLE *RetFileHandle,\r
906 OUT UINT16 **ParentFileName,\r
907 OUT EFI_HANDLE *DeviceHandle\r
908 )\r
909{\r
910 EFI_DEVICE_PATH_PROTOCOL *DevicePathNode;\r
911 EFI_DEVICE_PATH_PROTOCOL *TempDevicePathNode;\r
912 EFI_STATUS Status;\r
913 EFI_HANDLE Handle;\r
914 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Volume;\r
915 EFI_FILE_HANDLE FileHandle;\r
916 EFI_FILE_HANDLE LastHandle;\r
917 CHAR16 *TempPath;\r
918\r
919 *ParentFileName = NULL;\r
920\r
921 //\r
922 // Attempt to access the file via a file system interface\r
923 //\r
924 DevicePathNode = RootDirectory;\r
925 Status = gBS->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid, &DevicePathNode, &Handle);\r
926 if (EFI_ERROR (Status)) {\r
927 return Status;\r
928 }\r
929 \r
930 Status = gBS->HandleProtocol (Handle, &gEfiSimpleFileSystemProtocolGuid, (VOID**)&Volume);\r
931 if (EFI_ERROR (Status)) {\r
932 return Status;\r
933 }\r
934 \r
935 //\r
936 // Open the Volume to get the File System handle\r
937 //\r
938 Status = Volume->OpenVolume (Volume, &FileHandle);\r
939 if (EFI_ERROR (Status)) {\r
940 return Status;\r
941 }\r
942\r
943 *DeviceHandle = Handle;\r
944\r
945 if (IsDevicePathEnd(DevicePathNode)) {\r
946 *ParentFileName = AllocateCopyPool (StrSize (L"\\"), L"\\");\r
947 *RetFileHandle = FileHandle;\r
948 return EFI_SUCCESS;\r
949 }\r
950 \r
951 //\r
952 // Duplicate the device path to avoid the access to unaligned device path node.\r
953 // Because the device path consists of one or more FILE PATH MEDIA DEVICE PATH\r
954 // nodes, It assures the fields in device path nodes are 2 byte aligned.\r
955 //\r
956 TempDevicePathNode = DuplicateDevicePath (DevicePathNode);\r
957 if (TempDevicePathNode == NULL) {\r
958\r
959 //\r
960 // Setting Status to an EFI_ERROR value will cause the rest of\r
961 // the file system support below to be skipped.\r
962 //\r
963 Status = EFI_OUT_OF_RESOURCES;\r
964 }\r
965 \r
966 //\r
967 // Parse each MEDIA_FILEPATH_DP node. There may be more than one, since the\r
968 // directory information and filename can be seperate. The goal is to inch\r
969 // our way down each device path node and close the previous node\r
970 //\r
971 DevicePathNode = TempDevicePathNode;\r
972 while (!EFI_ERROR (Status) && !IsDevicePathEnd (DevicePathNode)) {\r
973 if (DevicePathType (DevicePathNode) != MEDIA_DEVICE_PATH ||\r
974 DevicePathSubType (DevicePathNode) != MEDIA_FILEPATH_DP) {\r
975 Status = EFI_UNSUPPORTED;\r
976 goto Done;\r
977 }\r
978\r
979 LastHandle = FileHandle;\r
980 FileHandle = NULL;\r
981\r
982 Status = LastHandle->Open (\r
983 LastHandle,\r
984 &FileHandle,\r
985 ((FILEPATH_DEVICE_PATH *) DevicePathNode)->PathName,\r
986 EFI_FILE_MODE_READ,\r
987 0\r
988 );\r
989 if (*ParentFileName == NULL) {\r
990 *ParentFileName = AllocateCopyPool (StrSize (((FILEPATH_DEVICE_PATH *) DevicePathNode)->PathName), ((FILEPATH_DEVICE_PATH *) DevicePathNode)->PathName);\r
991 } else {\r
992 TempPath = LibAppendFileName (*ParentFileName, ((FILEPATH_DEVICE_PATH *) DevicePathNode)->PathName);\r
993 FreePool (*ParentFileName);\r
994 *ParentFileName = TempPath;\r
995 }\r
996\r
997 //\r
998 // Close the previous node\r
999 //\r
1000 LastHandle->Close (LastHandle);\r
1001\r
1002 DevicePathNode = NextDevicePathNode (DevicePathNode);\r
1003 }\r
1004\r
1005 if (EFI_ERROR (Status)) {\r
1006 goto Done;\r
1007 }\r
1008\r
1009 *RetFileHandle = FileHandle;\r
1010\r
1011 Status = EFI_SUCCESS;\r
1012\r
1013Done:\r
1014 if (TempDevicePathNode != NULL) {\r
1015 FreePool (TempDevicePathNode);\r
1016 }\r
1017\r
1018 if ((FileHandle != NULL) && (EFI_ERROR (Status))) {\r
1019 FileHandle->Close (FileHandle);\r
1020 }\r
1021\r
1022 return Status;\r
1023}\r
1024\r
1025/**\r
1026 Find files under current directory.\r
1027 \r
1028 All files and sub-directories in current directory\r
1029 will be stored in DirectoryMenu for future use.\r
1030\r
1031 @param FileHandle Parent file handle. \r
1032 @param FileName Parent file name.\r
1033 @param DeviceHandle Driver handle for this partition.\r
1034\r
1035 @retval EFI_SUCCESS Get files from current dir successfully.\r
1036 @return Other value if can't get files from current dir.\r
1037\r
1038**/\r
1039EFI_STATUS\r
1040LibFindFiles (\r
1041 IN EFI_FILE_HANDLE FileHandle,\r
1042 IN UINT16 *FileName,\r
1043 IN EFI_HANDLE DeviceHandle\r
1044 )\r
1045{\r
1046 EFI_FILE_INFO *DirInfo;\r
1047 UINTN BufferSize;\r
1048 UINTN DirBufferSize;\r
1049 MENU_ENTRY *NewMenuEntry;\r
1050 FILE_CONTEXT *NewFileContext;\r
1051 UINTN Pass;\r
1052 EFI_STATUS Status;\r
1053 UINTN OptionNumber;\r
1054\r
1055 OptionNumber = 0;\r
1056\r
1057 DirBufferSize = sizeof (EFI_FILE_INFO) + 1024;\r
1058 DirInfo = AllocateZeroPool (DirBufferSize);\r
1059 if (DirInfo == NULL) {\r
1060 return EFI_OUT_OF_RESOURCES;\r
1061 }\r
1062\r
1063 //\r
1064 // Get all files in current directory\r
1065 // Pass 1 to get Directories\r
1066 // Pass 2 to get files that are EFI images\r
1067 //\r
1068 for (Pass = 1; Pass <= 2; Pass++) {\r
1069 FileHandle->SetPosition (FileHandle, 0);\r
1070 for (;;) {\r
1071 BufferSize = DirBufferSize;\r
1072 Status = FileHandle->Read (FileHandle, &BufferSize, DirInfo);\r
1073 if (EFI_ERROR (Status) || BufferSize == 0) {\r
1074 break;\r
1075 }\r
1076\r
1077 if (((DirInfo->Attribute & EFI_FILE_DIRECTORY) != 0 && Pass == 2) ||\r
1078 ((DirInfo->Attribute & EFI_FILE_DIRECTORY) == 0 && Pass == 1)\r
1079 ) {\r
1080 //\r
1081 // Pass 1 is for Directories\r
1082 // Pass 2 is for file names\r
1083 //\r
1084 continue;\r
1085 }\r
1086\r
1087 if (!((DirInfo->Attribute & EFI_FILE_DIRECTORY) != 0 || LibIsSupportedFileType (DirInfo->FileName))) {\r
1088 //\r
1089 // Slip file unless it is a directory entry or a .EFI file\r
1090 //\r
1091 continue;\r
1092 }\r
1093\r
1094 NewMenuEntry = LibCreateMenuEntry ();\r
1095 if (NULL == NewMenuEntry) {\r
1096 return EFI_OUT_OF_RESOURCES;\r
1097 }\r
1098\r
1099 NewFileContext = (FILE_CONTEXT *) NewMenuEntry->VariableContext;\r
1100 NewFileContext->DeviceHandle = DeviceHandle;\r
1101 NewFileContext->FileName = LibAppendFileName (FileName, DirInfo->FileName);\r
1102 NewFileContext->FileHandle = FileHandle;\r
1103 NewFileContext->DevicePath = FileDevicePath (NewFileContext->DeviceHandle, NewFileContext->FileName);\r
1104 NewMenuEntry->HelpString = NULL;\r
1105 NewFileContext->IsDir = (BOOLEAN) ((DirInfo->Attribute & EFI_FILE_DIRECTORY) == EFI_FILE_DIRECTORY);\r
1106\r
1107 if (NewFileContext->IsDir) {\r
1108 BufferSize = StrLen (DirInfo->FileName) * 2 + 6;\r
1109 NewMenuEntry->DisplayString = AllocateZeroPool (BufferSize);\r
1110 UnicodeSPrint (\r
1111 NewMenuEntry->DisplayString,\r
1112 BufferSize,\r
1113 L"<%s>",\r
1114 DirInfo->FileName\r
1115 );\r
1116 } else {\r
1117 NewMenuEntry->DisplayString = LibStrDuplicate (DirInfo->FileName);\r
1118 }\r
1119 \r
1120 NewMenuEntry->DisplayStringToken = HiiSetString (\r
1121 gFileExplorerPrivate.FeHiiHandle,\r
1122 0,\r
1123 NewMenuEntry->DisplayString,\r
1124 NULL\r
1125 );\r
1126\r
1127 NewFileContext->IsRoot = FALSE;\r
1128\r
1129 OptionNumber++;\r
1130 InsertTailList (&gFileExplorerPrivate.FsOptionMenu->Head, &NewMenuEntry->Link);\r
1131 }\r
1132 }\r
1133\r
1134 gFileExplorerPrivate.FsOptionMenu->MenuNumber = OptionNumber;\r
1135\r
1136 FreePool (DirInfo);\r
1137\r
1138 return EFI_SUCCESS;\r
1139}\r
1140\r
1141/**\r
1142 Refresh the global UpdateData structure.\r
1143\r
1144**/\r
1145VOID\r
1146LibRefreshUpdateData (\r
1147 VOID\r
1148 )\r
1149{\r
1150 //\r
1151 // Free current updated date\r
1152 //\r
1153 if (mLibStartOpCodeHandle != NULL) {\r
1154 HiiFreeOpCodeHandle (mLibStartOpCodeHandle);\r
1155 }\r
1156 if (mLibEndOpCodeHandle != NULL) {\r
1157 HiiFreeOpCodeHandle (mLibEndOpCodeHandle);\r
1158 }\r
1159\r
1160 //\r
1161 // Create new OpCode Handle\r
1162 //\r
1163 mLibStartOpCodeHandle = HiiAllocateOpCodeHandle ();\r
1164 mLibEndOpCodeHandle = HiiAllocateOpCodeHandle ();\r
1165\r
1166 //\r
1167 // Create Hii Extend Label OpCode as the start opcode\r
1168 //\r
1169 mLibStartLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (\r
1170 mLibStartOpCodeHandle,\r
1171 &gEfiIfrTianoGuid,\r
1172 NULL,\r
1173 sizeof (EFI_IFR_GUID_LABEL)\r
1174 );\r
1175 mLibStartLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
1176\r
1177 mLibStartLabel->Number = FORM_FILE_EXPLORER_ID;\r
1178\r
1179 //\r
1180 // Create Hii Extend Label OpCode as the start opcode\r
1181 //\r
1182 mLibEndLabel = (EFI_IFR_GUID_LABEL *) HiiCreateGuidOpCode (\r
1183 mLibEndOpCodeHandle,\r
1184 &gEfiIfrTianoGuid,\r
1185 NULL,\r
1186 sizeof (EFI_IFR_GUID_LABEL)\r
1187 );\r
1188 mLibEndLabel->ExtendOpCode = EFI_IFR_EXTEND_OP_LABEL;\r
1189\r
1190 mLibEndLabel->Number = LABEL_END;\r
1191}\r
1192\r
1193/**\r
1194\r
1195 Update the File Explore page.\r
1196\r
1197**/\r
1198VOID\r
1199LibUpdateFileExplorePage (\r
1200 VOID\r
1201 )\r
1202{\r
1203 UINTN Index;\r
1204 MENU_ENTRY *NewMenuEntry;\r
1205 FILE_CONTEXT *NewFileContext;\r
1206 MENU_OPTION *MenuOption;\r
1207\r
1208 NewMenuEntry = NULL;\r
1209 NewFileContext = NULL;\r
1210\r
1211 LibRefreshUpdateData ();\r
1212 MenuOption = gFileExplorerPrivate.FsOptionMenu;\r
1213\r
1214 for (Index = 0; Index < MenuOption->MenuNumber; Index++) {\r
1215 NewMenuEntry = LibGetMenuEntry (MenuOption, Index);\r
1216 NewFileContext = (FILE_CONTEXT *) NewMenuEntry->VariableContext;\r
1217\r
1218 if (!NewFileContext->IsDir) {\r
1219 //\r
1220 // Create Text opcode for directory, also create Text opcode for file in FileExplorerStateBootFromFile.\r
1221 //\r
1222 HiiCreateActionOpCode (\r
1223 mLibStartOpCodeHandle,\r
1224 (UINT16) (FILE_OPTION_OFFSET + Index),\r
1225 NewMenuEntry->DisplayStringToken,\r
1226 STRING_TOKEN (STR_NULL_STRING),\r
1227 EFI_IFR_FLAG_CALLBACK,\r
1228 0\r
1229 );\r
1230 } else {\r
1231 //\r
1232 // Create Goto opcode for file in FileExplorerStateAddBootOption or FileExplorerStateAddDriverOptionState.\r
1233 //\r
1234 HiiCreateGotoOpCode (\r
1235 mLibStartOpCodeHandle,\r
1236 FORM_FILE_EXPLORER_ID,\r
1237 NewMenuEntry->DisplayStringToken,\r
1238 STRING_TOKEN (STR_NULL_STRING),\r
1239 EFI_IFR_FLAG_CALLBACK,\r
1240 (UINT16) (FILE_OPTION_OFFSET + Index)\r
1241 );\r
1242 }\r
1243 }\r
1244\r
1245 HiiUpdateForm (\r
1246 gFileExplorerPrivate.FeHiiHandle,\r
1247 &FileExplorerGuid,\r
1248 FORM_FILE_EXPLORER_ID,\r
1249 mLibStartOpCodeHandle, // Label FORM_FILE_EXPLORER_ID\r
1250 mLibEndOpCodeHandle // LABEL_END\r
1251 );\r
1252}\r
1253\r
1254/**\r
1255 Update the file explower page with the refershed file system.\r
1256\r
1257 @param KeyValue Key value to identify the type of data to expect.\r
1258\r
1259 @retval EFI_SUCCESS Update the file explorer form success.\r
1260 @retval other errors Error occur when parse one directory.\r
1261\r
1262**/\r
1263EFI_STATUS\r
1264LibUpdateFileExplorer (\r
1265 IN UINT16 KeyValue\r
1266 )\r
1267{\r
1268 UINT16 FileOptionMask;\r
1269 MENU_ENTRY *NewMenuEntry;\r
1270 FILE_CONTEXT *NewFileContext;\r
1271 EFI_STATUS Status;\r
1272 EFI_FILE_HANDLE FileHandle;\r
1273\r
1274 Status = EFI_SUCCESS;\r
1275 FileOptionMask = (UINT16) (FILE_OPTION_MASK & KeyValue);\r
1276 NewMenuEntry = LibGetMenuEntry (gFileExplorerPrivate.FsOptionMenu, FileOptionMask);\r
1277 NewFileContext = (FILE_CONTEXT *) NewMenuEntry->VariableContext;\r
1278\r
1279 if (NewFileContext->IsDir) {\r
1280 RemoveEntryList (&NewMenuEntry->Link);\r
1281 LibFreeMenu (gFileExplorerPrivate.FsOptionMenu);\r
1282 LibGetFileHandleFromMenu (NewMenuEntry, &FileHandle);\r
1283 Status = LibFindFiles (FileHandle, NewFileContext->FileName, NewFileContext->DeviceHandle);\r
1284 if (!EFI_ERROR (Status)) {\r
1285 LibUpdateFileExplorePage ();\r
1286 } else {\r
1287 LibFreeMenu (gFileExplorerPrivate.FsOptionMenu);\r
1288 }\r
1289 LibDestroyMenuEntry (NewMenuEntry);\r
1290 }\r
1291\r
1292 return Status;\r
1293}\r
1294\r
1295/**\r
1296 Get the device path info saved in the menu structure.\r
1297\r
1298 @param KeyValue Key value to identify the type of data to expect.\r
1299\r
1300**/\r
1301VOID\r
1302LibGetDevicePath (\r
1303 IN UINT16 KeyValue\r
1304 )\r
1305{\r
1306 UINT16 FileOptionMask;\r
1307 MENU_ENTRY *NewMenuEntry;\r
1308 FILE_CONTEXT *NewFileContext;\r
1309\r
1310 FileOptionMask = (UINT16) (FILE_OPTION_MASK & KeyValue);\r
1311\r
1312 NewMenuEntry = LibGetMenuEntry (gFileExplorerPrivate.FsOptionMenu, FileOptionMask);\r
1313\r
1314 NewFileContext = (FILE_CONTEXT *) NewMenuEntry->VariableContext;\r
1315\r
1316 if (gFileExplorerPrivate.RetDevicePath != NULL) {\r
1317 FreePool (gFileExplorerPrivate.RetDevicePath);\r
1318 }\r
1319 gFileExplorerPrivate.RetDevicePath = DuplicateDevicePath (NewFileContext->DevicePath);\r
1320}\r
1321\r
1322/**\r
1323 Choose a file in the specified directory. \r
1324\r
1325 If user input NULL for the RootDirectory, will choose file in the system.\r
1326\r
1327 If user input *File != NULL, function will return the allocate device path\r
1328 info for the choosed file, caller has to free the memory after use it.\r
1329\r
1330 @param RootDirectory Pointer to the root directory.\r
1331 @param FileType The file type need to choose.\r
1332 @param ChooseHandler Function pointer to the extra task need to do\r
1333 after choose one file.\r
1334 @param File Return the device path for the last time chosed file.\r
1335\r
1336 @retval EFI_SUCESS Choose file success.\r
1337 @retval EFI_INVALID_PARAMETER Both ChooseHandler and return device path are NULL\r
1338 One of them must not NULL.\r
1339 @retval Other errors Choose file failed.\r
1340**/\r
1341EFI_STATUS\r
1342EFIAPI\r
1343ChooseFile (\r
1344 IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory,\r
1345 IN CHAR16 *FileType, OPTIONAL\r
1346 IN CHOOSE_HANDLER ChooseHandler, OPTIONAL\r
1347 OUT EFI_DEVICE_PATH_PROTOCOL **File OPTIONAL\r
1348 )\r
1349{\r
1350 EFI_FILE_HANDLE FileHandle;\r
1351 EFI_STATUS Status;\r
1352 UINT16 *FileName;\r
1353 EFI_HANDLE DeviceHandle;\r
1354\r
1355 if ((ChooseHandler == NULL) && (File == NULL)) {\r
1356 return EFI_INVALID_PARAMETER;\r
1357 }\r
1358\r
1359 FileName = NULL;\r
1360\r
1361 gFileExplorerPrivate.RetDevicePath = NULL;\r
1362 gFileExplorerPrivate.ChooseHandler = ChooseHandler;\r
1363 if (FileType != NULL) {\r
1364 gFileExplorerPrivate.FileType = AllocateCopyPool (StrSize (FileType), FileType);\r
d0d34cdf 1365 ASSERT(gFileExplorerPrivate.FileType != NULL);\r
4c8274a0
ED
1366 LibToLowerString(gFileExplorerPrivate.FileType);\r
1367 } else {\r
1368 gFileExplorerPrivate.FileType = NULL;\r
1369 }\r
1370\r
1371 if (RootDirectory == NULL) {\r
1372 Status = LibFindFileSystem();\r
1373 } else {\r
1374 Status = LibGetFileHandleFromDevicePath(RootDirectory, &FileHandle, &FileName, &DeviceHandle);\r
1375 if (EFI_ERROR (Status)) {\r
1376 goto Done;\r
1377 }\r
1378\r
1379 Status = LibFindFiles (FileHandle, FileName, DeviceHandle);\r
1380 }\r
1381 if (EFI_ERROR (Status)) {\r
1382 goto Done;\r
1383 }\r
1384\r
1385 LibUpdateFileExplorePage();\r
1386\r
1387 gFileExplorerPrivate.FormBrowser2->SendForm (\r
1388 gFileExplorerPrivate.FormBrowser2,\r
1389 &gFileExplorerPrivate.FeHiiHandle,\r
1390 1,\r
1391 &FileExplorerGuid,\r
1392 0,\r
1393 NULL,\r
1394 NULL\r
1395 );\r
1396\r
1397Done:\r
1398 if ((Status == EFI_SUCCESS) && (File != NULL)) {\r
1399 *File = gFileExplorerPrivate.RetDevicePath;\r
1400 } else if (gFileExplorerPrivate.RetDevicePath != NULL) {\r
1401 FreePool (gFileExplorerPrivate.RetDevicePath);\r
1402 }\r
1403\r
1404 if (gFileExplorerPrivate.FileType != NULL) {\r
1405 FreePool (gFileExplorerPrivate.FileType);\r
1406 }\r
1407\r
1408 LibFreeMenu (gFileExplorerPrivate.FsOptionMenu);\r
1409\r
1410 if (FileName != NULL) {\r
1411 FreePool (FileName);\r
1412 }\r
1413\r
1414 return Status;\r
1415}\r
1416\r
1417/**\r
1418\r
1419 Install Boot Manager Menu driver.\r
1420\r
1421 @param ImageHandle The image handle.\r
1422 @param SystemTable The system table.\r
1423\r
1424 @retval EFI_SUCEESS Install File explorer library success.\r
1425\r
1426**/\r
1427EFI_STATUS\r
1428EFIAPI\r
1429FileExplorerLibConstructor (\r
1430 IN EFI_HANDLE ImageHandle,\r
1431 IN EFI_SYSTEM_TABLE *SystemTable\r
1432 )\r
1433{\r
1434 EFI_STATUS Status;\r
1435\r
1436 gHiiVendorDevicePath = (HII_VENDOR_DEVICE_PATH*) DuplicateDevicePath ((EFI_DEVICE_PATH_PROTOCOL*)&FeHiiVendorDevicePath);\r
1437 ASSERT (gHiiVendorDevicePath != NULL);\r
1438 CopyGuid (&gHiiVendorDevicePath->VendorDevicePath.Guid, &gEfiCallerIdGuid);\r
1439\r
1440 //\r
1441 // Install Device Path Protocol and Config Access protocol to driver handle\r
1442 //\r
1443 Status = gBS->InstallMultipleProtocolInterfaces (\r
1444 &gFileExplorerPrivate.FeDriverHandle,\r
1445 &gEfiDevicePathProtocolGuid,\r
1446 gHiiVendorDevicePath,\r
1447 &gEfiHiiConfigAccessProtocolGuid,\r
1448 &gFileExplorerPrivate.FeConfigAccess,\r
1449 NULL\r
1450 );\r
20fe1625
ED
1451 if (Status == EFI_ALREADY_STARTED) {\r
1452 return EFI_SUCCESS;\r
1453 }\r
1454 if (EFI_ERROR (Status)) {\r
1455 return Status;\r
1456 }\r
4c8274a0
ED
1457\r
1458 //\r
1459 // Post our File Explorer VFR binary to the HII database.\r
1460 //\r
1461 gFileExplorerPrivate.FeHiiHandle = HiiAddPackages (\r
1462 &FileExplorerGuid,\r
1463 gFileExplorerPrivate.FeDriverHandle,\r
1464 FileExplorerVfrBin,\r
1465 FileExplorerLibStrings,\r
1466 NULL\r
1467 );\r
1468 ASSERT (gFileExplorerPrivate.FeHiiHandle != NULL);\r
1469\r
1470 //\r
1471 // Locate Formbrowser2 protocol\r
1472 //\r
1473 Status = gBS->LocateProtocol (&gEfiFormBrowser2ProtocolGuid, NULL, (VOID **) &gFileExplorerPrivate.FormBrowser2);\r
1474 ASSERT_EFI_ERROR (Status);\r
1475 \r
1476 InitializeListHead (&gFileExplorerPrivate.FsOptionMenu->Head);\r
1477\r
1478 return EFI_SUCCESS;\r
1479}\r
1480\r
1481/**\r
1482 Unloads the application and its installed protocol.\r
1483\r
1484 @param[in] ImageHandle Handle that identifies the image to be unloaded.\r
1485 @param[in] SystemTable The system table.\r
1486\r
1487 @retval EFI_SUCCESS The image has been unloaded.\r
1488**/\r
1489EFI_STATUS\r
1490EFIAPI\r
1491FileExplorerLibDestructor (\r
1492 IN EFI_HANDLE ImageHandle,\r
1493 IN EFI_SYSTEM_TABLE *SystemTable\r
1494 )\r
1495{\r
1496 EFI_STATUS Status;\r
1497\r
1498 ASSERT (gHiiVendorDevicePath != NULL);\r
1499\r
20fe1625
ED
1500 if (gFileExplorerPrivate.FeDriverHandle != NULL) {\r
1501 Status = gBS->UninstallMultipleProtocolInterfaces (\r
1502 gFileExplorerPrivate.FeDriverHandle,\r
1503 &gEfiDevicePathProtocolGuid,\r
1504 gHiiVendorDevicePath,\r
1505 &gEfiHiiConfigAccessProtocolGuid,\r
1506 &gFileExplorerPrivate.FeConfigAccess,\r
1507 NULL\r
1508 );\r
1509 ASSERT_EFI_ERROR (Status);\r
1510 \r
1511 HiiRemovePackages (gFileExplorerPrivate.FeHiiHandle);\r
1512 }\r
4c8274a0
ED
1513\r
1514 FreePool (gHiiVendorDevicePath);\r
1515\r
1516 return EFI_SUCCESS;\r
1517}\r
1518\r