2 File explorer related functions.
4 Copyright (c) 2004 - 2016, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available under
6 the terms and conditions of the BSD License that accompanies this distribution.
7 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.
16 #include "FileExplorer.h"
18 EFI_GUID FileExplorerGuid
= EFI_FILE_EXPLORE_FORMSET_GUID
;
21 /// File system selection menu
23 MENU_OPTION mFsOptionMenu
= {
24 MENU_OPTION_SIGNATURE
,
30 FILE_EXPLORER_CALLBACK_DATA gFileExplorerPrivate
= {
31 FILE_EXPLORER_CALLBACK_DATA_SIGNATURE
,
44 HII_VENDOR_DEVICE_PATH
*gHiiVendorDevicePath
;
46 HII_VENDOR_DEVICE_PATH FeHiiVendorDevicePath
= {
52 (UINT8
) (sizeof (VENDOR_DEVICE_PATH
)),
53 (UINT8
) ((sizeof (VENDOR_DEVICE_PATH
)) >> 8)
57 // Will be replace with gEfiCallerIdGuid in code.
59 { 0x0, 0x0, 0x0, { 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } }
63 END_ENTIRE_DEVICE_PATH_SUBTYPE
,
65 (UINT8
) (END_DEVICE_PATH_LENGTH
),
66 (UINT8
) ((END_DEVICE_PATH_LENGTH
) >> 8)
71 VOID
*mLibStartOpCodeHandle
= NULL
;
72 VOID
*mLibEndOpCodeHandle
= NULL
;
73 EFI_IFR_GUID_LABEL
*mLibStartLabel
= NULL
;
74 EFI_IFR_GUID_LABEL
*mLibEndLabel
= NULL
;
77 This function allows a caller to extract the current configuration for one
78 or more named elements from the target driver.
81 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
82 @param Request A null-terminated Unicode string in <ConfigRequest> format.
83 @param Progress On return, points to a character in the Request string.
84 Points to the string's null terminator if request was successful.
85 Points to the most recent '&' before the first failing name/value
86 pair (or the beginning of the string if the failure is in the
87 first name/value pair) if the request was not successful.
88 @param Results A null-terminated Unicode string in <ConfigAltResp> format which
89 has all values filled in for the names in the Request string.
90 String to be allocated by the called function.
92 @retval EFI_INVALID_PARAMETER Request is illegal syntax, or unknown name.
93 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
99 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
100 IN CONST EFI_STRING Request
,
101 OUT EFI_STRING
*Progress
,
102 OUT EFI_STRING
*Results
105 if (Progress
== NULL
|| Results
== NULL
) {
106 return EFI_INVALID_PARAMETER
;
110 return EFI_NOT_FOUND
;
114 This function processes the results of changes in configuration.
117 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
118 @param Configuration A null-terminated Unicode string in <ConfigResp> format.
119 @param Progress A pointer to a string filled in with the offset of the most
120 recent '&' before the first failing name/value pair (or the
121 beginning of the string if the failure is in the first
122 name/value pair) or the terminating NULL if all was successful.
124 @retval EFI_INVALID_PARAMETER Configuration is NULL.
125 @retval EFI_NOT_FOUND Routing data doesn't match any storage in this driver.
131 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
132 IN CONST EFI_STRING Configuration
,
133 OUT EFI_STRING
*Progress
136 if (Configuration
== NULL
|| Progress
== NULL
) {
137 return EFI_INVALID_PARAMETER
;
140 *Progress
= Configuration
;
141 return EFI_NOT_FOUND
;
145 This function processes the results of changes in configuration.
146 When user select a interactive opcode, this callback will be triggered.
147 Based on the Question(QuestionId) that triggers the callback, the corresponding
148 actions is performed. It handles:
150 1) Process the axtra action or exit file explorer when user select one file .
151 2) update of file content if a dir is selected.
153 @param This Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
154 @param Action Specifies the type of action taken by the browser.
155 @param QuestionId A unique value which is sent to the original exporting driver
156 so that it can identify the type of data to expect.
157 @param Type The type of value for the question.
158 @param Value A pointer to the data being sent to the original exporting driver.
159 @param ActionRequest On return, points to the action requested by the callback function.
161 @retval EFI_SUCCESS The callback successfully handled the action.
162 @retval other error Error occur when parse one directory.
167 IN CONST EFI_HII_CONFIG_ACCESS_PROTOCOL
*This
,
168 IN EFI_BROWSER_ACTION Action
,
169 IN EFI_QUESTION_ID QuestionId
,
171 IN EFI_IFR_TYPE_VALUE
*Value
,
172 OUT EFI_BROWSER_ACTION_REQUEST
*ActionRequest
180 if (Action
!= EFI_BROWSER_ACTION_CHANGING
&& Action
!= EFI_BROWSER_ACTION_CHANGED
) {
182 // Do nothing for other UEFI Action. Only do call back when data is changed.
184 return EFI_UNSUPPORTED
;
187 if (Action
== EFI_BROWSER_ACTION_CHANGED
) {
188 if ((Value
== NULL
) || (ActionRequest
== NULL
)) {
189 return EFI_INVALID_PARAMETER
;
192 if (QuestionId
>= FILE_OPTION_OFFSET
) {
193 LibGetDevicePath(QuestionId
);
196 // Process the extra action.
198 if (gFileExplorerPrivate
.ChooseHandler
!= NULL
) {
199 NeedExit
= gFileExplorerPrivate
.ChooseHandler (gFileExplorerPrivate
.RetDevicePath
);
203 *ActionRequest
= EFI_BROWSER_ACTION_REQUEST_EXIT
;
206 } else if (Action
== EFI_BROWSER_ACTION_CHANGING
) {
208 return EFI_INVALID_PARAMETER
;
211 if (QuestionId
>= FILE_OPTION_OFFSET
) {
212 Status
= LibUpdateFileExplorer (QuestionId
);
213 if (EFI_ERROR (Status
)) {
223 Create a menu entry by given menu type.
225 @retval NULL If failed to create the menu.
226 @return the new menu entry.
234 MENU_ENTRY
*MenuEntry
;
237 // Create new menu entry
239 MenuEntry
= AllocateZeroPool (sizeof (MENU_ENTRY
));
240 if (MenuEntry
== NULL
) {
244 MenuEntry
->VariableContext
= AllocateZeroPool (sizeof (FILE_CONTEXT
));
245 if (MenuEntry
->VariableContext
== NULL
) {
246 FreePool (MenuEntry
);
250 MenuEntry
->Signature
= MENU_ENTRY_SIGNATURE
;
256 Get the Menu Entry from the list in Menu Entry List.
258 If MenuNumber is great or equal to the number of Menu
259 Entry in the list, then ASSERT.
261 @param MenuOption The Menu Entry List to read the menu entry.
262 @param MenuNumber The index of Menu Entry.
264 @return The Menu Entry.
269 MENU_OPTION
*MenuOption
,
273 MENU_ENTRY
*NewMenuEntry
;
277 ASSERT (MenuNumber
< MenuOption
->MenuNumber
);
279 List
= MenuOption
->Head
.ForwardLink
;
280 for (Index
= 0; Index
< MenuNumber
; Index
++) {
281 List
= List
->ForwardLink
;
284 NewMenuEntry
= CR (List
, MENU_ENTRY
, Link
, MENU_ENTRY_SIGNATURE
);
290 Free up all resource allocated for a BM_MENU_ENTRY.
292 @param MenuEntry A pointer to BM_MENU_ENTRY.
296 LibDestroyMenuEntry (
297 MENU_ENTRY
*MenuEntry
300 FILE_CONTEXT
*FileContext
;
302 FileContext
= (FILE_CONTEXT
*) MenuEntry
->VariableContext
;
304 if (!FileContext
->IsRoot
) {
305 if (FileContext
->DevicePath
!= NULL
) {
306 FreePool (FileContext
->DevicePath
);
309 if (FileContext
->FileHandle
!= NULL
) {
310 FileContext
->FileHandle
->Close (FileContext
->FileHandle
);
314 if (FileContext
->FileName
!= NULL
) {
315 FreePool (FileContext
->FileName
);
318 FreePool (FileContext
);
320 if (MenuEntry
->DisplayString
!= NULL
) {
321 FreePool (MenuEntry
->DisplayString
);
323 if (MenuEntry
->HelpString
!= NULL
) {
324 FreePool (MenuEntry
->HelpString
);
327 FreePool (MenuEntry
);
332 Free resources allocated in Allocate Rountine.
334 @param FreeMenu Menu to be freed
338 MENU_OPTION
*FreeMenu
341 MENU_ENTRY
*MenuEntry
;
342 while (!IsListEmpty (&FreeMenu
->Head
)) {
344 FreeMenu
->Head
.ForwardLink
,
349 RemoveEntryList (&MenuEntry
->Link
);
350 LibDestroyMenuEntry (MenuEntry
);
352 FreeMenu
->MenuNumber
= 0;
357 Function opens and returns a file handle to the root directory of a volume.
359 @param DeviceHandle A handle for a device
361 @return A valid file handle or NULL is returned
366 IN EFI_HANDLE DeviceHandle
370 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*Volume
;
371 EFI_FILE_HANDLE File
;
376 // File the file system interface to the device
378 Status
= gBS
->HandleProtocol (
380 &gEfiSimpleFileSystemProtocolGuid
,
385 // Open the root directory of the volume
387 if (!EFI_ERROR (Status
)) {
388 Status
= Volume
->OpenVolume (
396 return EFI_ERROR (Status
) ? NULL
: File
;
400 This function converts an input device structure to a Unicode string.
402 @param DevPath A pointer to the device path structure.
404 @return A new allocated Unicode string that represents the device path.
409 IN EFI_DEVICE_PATH_PROTOCOL
*DevPath
414 EFI_DEVICE_PATH_TO_TEXT_PROTOCOL
*DevPathToText
;
416 if (DevPath
== NULL
) {
420 Status
= gBS
->LocateProtocol (
421 &gEfiDevicePathToTextProtocolGuid
,
423 (VOID
**) &DevPathToText
425 ASSERT_EFI_ERROR (Status
);
426 ToText
= DevPathToText
->ConvertDevicePathToText (
431 ASSERT (ToText
!= NULL
);
439 @param Src The source.
441 @return A new string which is duplicated copy of the source.
442 @retval NULL If there is not enough memory.
453 Size
= StrSize (Src
);
454 Dest
= AllocateZeroPool (Size
);
455 ASSERT (Dest
!= NULL
);
457 CopyMem (Dest
, Src
, Size
);
465 Function gets the file information from an open file descriptor, and stores it
466 in a buffer allocated from pool.
468 @param FHand File Handle.
469 @param InfoType Info type need to get.
471 @retval A pointer to a buffer with file information or NULL is returned
476 IN EFI_FILE_HANDLE FHand
,
477 IN EFI_GUID
*InfoType
481 EFI_FILE_INFO
*Buffer
;
487 Status
= FHand
->GetInfo (
493 if (Status
== EFI_BUFFER_TOO_SMALL
) {
494 Buffer
= AllocatePool (BufferSize
);
495 ASSERT (Buffer
!= NULL
);
498 Status
= FHand
->GetInfo (
510 Get file type base on the file name.
511 Just cut the file name, from the ".". eg ".efi"
513 @param FileName File need to be checked.
515 @retval the file type string.
525 Index
= StrLen (FileName
) - 1;
526 while ((FileName
[Index
] != L
'.') && (Index
!= 0)) {
530 return Index
== 0 ? NULL
: &FileName
[Index
];
534 Converts the unicode character of the string from uppercase to lowercase.
535 This is a internal function.
537 @param ConfigString String to be converted
547 for (TmpStr
= String
; *TmpStr
!= L
'\0'; TmpStr
++) {
548 if (*TmpStr
>= L
'A' && *TmpStr
<= L
'Z') {
549 *TmpStr
= (CHAR16
) (*TmpStr
- L
'A' + L
'a');
556 Check whether current FileName point to a valid
559 @param FileName File need to be checked.
561 @retval TRUE Is Efi Image
562 @retval FALSE Not a valid Efi Image
566 LibIsSupportedFileType (
570 CHAR16
*InputFileType
;
574 if (gFileExplorerPrivate
.FileType
== NULL
) {
578 InputFileType
= LibGetTypeFromName (FileName
);
580 // If the file not has *.* style, always return TRUE.
582 if (InputFileType
== NULL
) {
586 TmpStr
= AllocateCopyPool (StrSize (InputFileType
), InputFileType
);
587 LibToLowerString(TmpStr
);
589 IsSupported
= (StrStr (gFileExplorerPrivate
.FileType
, TmpStr
) == NULL
? FALSE
: TRUE
);
597 Append file name to existing file name.
599 @param Str1 The existing file name
600 @param Str2 The file name to be appended
602 @return Allocate a new string to hold the appended result.
603 Caller is responsible to free the returned string.
620 Size1
= StrSize (Str1
);
621 Size2
= StrSize (Str2
);
622 MaxLen
= (Size1
+ Size2
+ sizeof (CHAR16
))/ sizeof (CHAR16
);
623 Str
= AllocateZeroPool (Size1
+ Size2
+ sizeof (CHAR16
));
624 ASSERT (Str
!= NULL
);
626 TmpStr
= AllocateZeroPool (Size1
+ Size2
+ sizeof (CHAR16
));
627 ASSERT (TmpStr
!= NULL
);
629 StrCpyS (Str
, MaxLen
, Str1
);
630 if (!((*Str
== '\\') && (*(Str
+ 1) == 0))) {
631 StrCatS (Str
, MaxLen
, L
"\\");
634 StrCatS (Str
, MaxLen
, Str2
);
639 if (*Ptr
== '\\' && *(Ptr
+ 1) == '.' && *(Ptr
+ 2) == '.' && *(Ptr
+ 3) == L
'\\') {
641 // Convert "\Name\..\" to "\"
642 // DO NOT convert the .. if it is at the end of the string. This will
643 // break the .. behavior in changing directories.
647 // Use TmpStr as a backup, as StrCpyS in BaseLib does not handle copy of two strings
650 StrCpyS (TmpStr
, MaxLen
, Ptr
+ 3);
651 StrCpyS (LastSlash
, MaxLen
- (UINTN
) (LastSlash
- Str
), TmpStr
);
653 } else if (*Ptr
== '\\' && *(Ptr
+ 1) == '.' && *(Ptr
+ 2) == '\\') {
655 // Convert a "\.\" to a "\"
659 // Use TmpStr as a backup, as StrCpyS in BaseLib does not handle copy of two strings
662 StrCpyS (TmpStr
, MaxLen
, Ptr
+ 2);
663 StrCpyS (Ptr
, MaxLen
- (UINTN
) (Ptr
- Str
), TmpStr
);
665 } else if (*Ptr
== '\\') {
678 This function build the FsOptionMenu list which records all
679 available file system in the system. They includes all instances
680 of EFI_SIMPLE_FILE_SYSTEM_PROTOCOL, all instances of EFI_LOAD_FILE_SYSTEM.
683 @retval EFI_SUCCESS Success find the file system
684 @retval EFI_OUT_OF_RESOURCES Can not create menu entry
692 UINTN NoSimpleFsHandles
;
693 UINTN NoLoadFileHandles
;
694 EFI_HANDLE
*SimpleFsHandle
;
695 EFI_HANDLE
*LoadFileHandle
;
699 MENU_ENTRY
*MenuEntry
;
700 FILE_CONTEXT
*FileContext
;
702 EFI_FILE_SYSTEM_VOLUME_LABEL
*Info
;
704 NoSimpleFsHandles
= 0;
705 NoLoadFileHandles
= 0;
709 // Locate Handles that support Simple File System protocol
711 Status
= gBS
->LocateHandleBuffer (
713 &gEfiSimpleFileSystemProtocolGuid
,
718 if (!EFI_ERROR (Status
)) {
720 // Find all the instances of the File System prototocol
722 for (Index
= 0; Index
< NoSimpleFsHandles
; Index
++) {
724 // Allocate pool for this load option
726 MenuEntry
= LibCreateMenuEntry ();
727 if (NULL
== MenuEntry
) {
728 FreePool (SimpleFsHandle
);
729 return EFI_OUT_OF_RESOURCES
;
732 FileContext
= (FILE_CONTEXT
*) MenuEntry
->VariableContext
;
733 FileContext
->DeviceHandle
= SimpleFsHandle
[Index
];
734 FileContext
->FileHandle
= LibOpenRoot (FileContext
->DeviceHandle
);
735 if (FileContext
->FileHandle
== NULL
) {
736 LibDestroyMenuEntry (MenuEntry
);
740 MenuEntry
->HelpString
= LibDevicePathToStr (DevicePathFromHandle (FileContext
->DeviceHandle
));
741 FileContext
->FileName
= LibStrDuplicate (L
"\\");
742 FileContext
->DevicePath
= FileDevicePath (FileContext
->DeviceHandle
, FileContext
->FileName
);
743 FileContext
->IsDir
= TRUE
;
744 FileContext
->IsRoot
= TRUE
;
747 // Get current file system's Volume Label
749 Info
= (EFI_FILE_SYSTEM_VOLUME_LABEL
*) LibFileInfo (FileContext
->FileHandle
, &gEfiFileSystemVolumeLabelInfoIdGuid
);
751 VolumeLabel
= L
"NO FILE SYSTEM INFO";
753 if (Info
->VolumeLabel
== NULL
) {
754 VolumeLabel
= L
"NULL VOLUME LABEL";
756 VolumeLabel
= Info
->VolumeLabel
;
757 if (*VolumeLabel
== 0x0000) {
758 VolumeLabel
= L
"NO VOLUME LABEL";
762 MenuEntry
->DisplayString
= AllocateZeroPool (MAX_CHAR
);
763 ASSERT (MenuEntry
->DisplayString
!= NULL
);
765 MenuEntry
->DisplayString
,
769 MenuEntry
->HelpString
771 MenuEntry
->DisplayStringToken
= HiiSetString (
772 gFileExplorerPrivate
.FeHiiHandle
,
774 MenuEntry
->DisplayString
,
780 InsertTailList (&gFileExplorerPrivate
.FsOptionMenu
->Head
, &MenuEntry
->Link
);
784 if (NoSimpleFsHandles
!= 0) {
785 FreePool (SimpleFsHandle
);
789 // Searching for handles that support Load File protocol
791 Status
= gBS
->LocateHandleBuffer (
793 &gEfiLoadFileProtocolGuid
,
799 if (!EFI_ERROR (Status
)) {
800 for (Index
= 0; Index
< NoLoadFileHandles
; Index
++) {
801 MenuEntry
= LibCreateMenuEntry ();
802 if (NULL
== MenuEntry
) {
803 FreePool (LoadFileHandle
);
804 return EFI_OUT_OF_RESOURCES
;
807 FileContext
= (FILE_CONTEXT
*) MenuEntry
->VariableContext
;
808 FileContext
->DeviceHandle
= LoadFileHandle
[Index
];
809 FileContext
->IsRoot
= TRUE
;
811 FileContext
->DevicePath
= DevicePathFromHandle (FileContext
->DeviceHandle
);
812 FileContext
->FileName
= LibDevicePathToStr (FileContext
->DevicePath
);
814 MenuEntry
->HelpString
= LibDevicePathToStr (FileContext
->DevicePath
);
815 MenuEntry
->DisplayString
= AllocateZeroPool (MAX_CHAR
);
816 ASSERT (MenuEntry
->DisplayString
!= NULL
);
818 MenuEntry
->DisplayString
,
821 MenuEntry
->HelpString
823 MenuEntry
->DisplayStringToken
= HiiSetString (
824 gFileExplorerPrivate
.FeHiiHandle
,
826 MenuEntry
->DisplayString
,
831 InsertTailList (&gFileExplorerPrivate
.FsOptionMenu
->Head
, &MenuEntry
->Link
);
835 if (NoLoadFileHandles
!= 0) {
836 FreePool (LoadFileHandle
);
839 gFileExplorerPrivate
.FsOptionMenu
->MenuNumber
= OptionNumber
;
845 Find the file handle from the input menu info.
847 @param MenuEntry Input Menu info.
848 @param RetFileHandle Return the file handle for the input device path.
850 @retval EFI_SUCESS Find the file handle success.
851 @retval Other Find the file handle failure.
854 LibGetFileHandleFromMenu (
855 IN MENU_ENTRY
*MenuEntry
,
856 OUT EFI_FILE_HANDLE
*RetFileHandle
860 EFI_FILE_HANDLE NewDir
;
861 FILE_CONTEXT
*FileContext
;
864 FileContext
= (FILE_CONTEXT
*) MenuEntry
->VariableContext
;
865 Dir
= FileContext
->FileHandle
;
868 // Open current directory to get files from it
873 FileContext
->FileName
,
877 if (EFI_ERROR (Status
)) {
881 if (!FileContext
->IsRoot
) {
885 *RetFileHandle
= NewDir
;
891 Find the file handle from the input device path info.
893 @param RootDirectory Device path info.
894 @param RetFileHandle Return the file handle for the input device path.
895 @param ParentFileName Parent file name.
896 @param DeviceHandle Driver handle for this partition.
898 @retval EFI_SUCESS Find the file handle success.
899 @retval Other Find the file handle failure.
902 LibGetFileHandleFromDevicePath (
903 IN EFI_DEVICE_PATH_PROTOCOL
*RootDirectory
,
904 OUT EFI_FILE_HANDLE
*RetFileHandle
,
905 OUT UINT16
**ParentFileName
,
906 OUT EFI_HANDLE
*DeviceHandle
909 EFI_DEVICE_PATH_PROTOCOL
*DevicePathNode
;
910 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePathNode
;
913 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*Volume
;
914 EFI_FILE_HANDLE FileHandle
;
915 EFI_FILE_HANDLE LastHandle
;
918 *ParentFileName
= NULL
;
921 // Attempt to access the file via a file system interface
923 DevicePathNode
= RootDirectory
;
924 Status
= gBS
->LocateDevicePath (&gEfiSimpleFileSystemProtocolGuid
, &DevicePathNode
, &Handle
);
925 if (EFI_ERROR (Status
)) {
929 Status
= gBS
->HandleProtocol (Handle
, &gEfiSimpleFileSystemProtocolGuid
, (VOID
**)&Volume
);
930 if (EFI_ERROR (Status
)) {
935 // Open the Volume to get the File System handle
937 Status
= Volume
->OpenVolume (Volume
, &FileHandle
);
938 if (EFI_ERROR (Status
)) {
942 *DeviceHandle
= Handle
;
944 if (IsDevicePathEnd(DevicePathNode
)) {
945 *ParentFileName
= AllocateCopyPool (StrSize (L
"\\"), L
"\\");
946 *RetFileHandle
= FileHandle
;
951 // Duplicate the device path to avoid the access to unaligned device path node.
952 // Because the device path consists of one or more FILE PATH MEDIA DEVICE PATH
953 // nodes, It assures the fields in device path nodes are 2 byte aligned.
955 TempDevicePathNode
= DuplicateDevicePath (DevicePathNode
);
956 if (TempDevicePathNode
== NULL
) {
959 // Setting Status to an EFI_ERROR value will cause the rest of
960 // the file system support below to be skipped.
962 Status
= EFI_OUT_OF_RESOURCES
;
966 // Parse each MEDIA_FILEPATH_DP node. There may be more than one, since the
967 // directory information and filename can be seperate. The goal is to inch
968 // our way down each device path node and close the previous node
970 DevicePathNode
= TempDevicePathNode
;
971 while (!EFI_ERROR (Status
) && !IsDevicePathEnd (DevicePathNode
)) {
972 if (DevicePathType (DevicePathNode
) != MEDIA_DEVICE_PATH
||
973 DevicePathSubType (DevicePathNode
) != MEDIA_FILEPATH_DP
) {
974 Status
= EFI_UNSUPPORTED
;
978 LastHandle
= FileHandle
;
981 Status
= LastHandle
->Open (
984 ((FILEPATH_DEVICE_PATH
*) DevicePathNode
)->PathName
,
988 if (*ParentFileName
== NULL
) {
989 *ParentFileName
= AllocateCopyPool (StrSize (((FILEPATH_DEVICE_PATH
*) DevicePathNode
)->PathName
), ((FILEPATH_DEVICE_PATH
*) DevicePathNode
)->PathName
);
991 TempPath
= LibAppendFileName (*ParentFileName
, ((FILEPATH_DEVICE_PATH
*) DevicePathNode
)->PathName
);
992 FreePool (*ParentFileName
);
993 *ParentFileName
= TempPath
;
997 // Close the previous node
999 LastHandle
->Close (LastHandle
);
1001 DevicePathNode
= NextDevicePathNode (DevicePathNode
);
1004 if (EFI_ERROR (Status
)) {
1008 *RetFileHandle
= FileHandle
;
1010 Status
= EFI_SUCCESS
;
1013 if (TempDevicePathNode
!= NULL
) {
1014 FreePool (TempDevicePathNode
);
1017 if ((FileHandle
!= NULL
) && (EFI_ERROR (Status
))) {
1018 FileHandle
->Close (FileHandle
);
1025 Find files under current directory.
1027 All files and sub-directories in current directory
1028 will be stored in DirectoryMenu for future use.
1030 @param FileHandle Parent file handle.
1031 @param FileName Parent file name.
1032 @param DeviceHandle Driver handle for this partition.
1034 @retval EFI_SUCCESS Get files from current dir successfully.
1035 @return Other value if can't get files from current dir.
1040 IN EFI_FILE_HANDLE FileHandle
,
1041 IN UINT16
*FileName
,
1042 IN EFI_HANDLE DeviceHandle
1045 EFI_FILE_INFO
*DirInfo
;
1047 UINTN DirBufferSize
;
1048 MENU_ENTRY
*NewMenuEntry
;
1049 FILE_CONTEXT
*NewFileContext
;
1056 DirBufferSize
= sizeof (EFI_FILE_INFO
) + 1024;
1057 DirInfo
= AllocateZeroPool (DirBufferSize
);
1058 if (DirInfo
== NULL
) {
1059 return EFI_OUT_OF_RESOURCES
;
1063 // Get all files in current directory
1064 // Pass 1 to get Directories
1065 // Pass 2 to get files that are EFI images
1067 for (Pass
= 1; Pass
<= 2; Pass
++) {
1068 FileHandle
->SetPosition (FileHandle
, 0);
1070 BufferSize
= DirBufferSize
;
1071 Status
= FileHandle
->Read (FileHandle
, &BufferSize
, DirInfo
);
1072 if (EFI_ERROR (Status
) || BufferSize
== 0) {
1076 if (((DirInfo
->Attribute
& EFI_FILE_DIRECTORY
) != 0 && Pass
== 2) ||
1077 ((DirInfo
->Attribute
& EFI_FILE_DIRECTORY
) == 0 && Pass
== 1)
1080 // Pass 1 is for Directories
1081 // Pass 2 is for file names
1086 if (!((DirInfo
->Attribute
& EFI_FILE_DIRECTORY
) != 0 || LibIsSupportedFileType (DirInfo
->FileName
))) {
1088 // Slip file unless it is a directory entry or a .EFI file
1093 NewMenuEntry
= LibCreateMenuEntry ();
1094 if (NULL
== NewMenuEntry
) {
1095 return EFI_OUT_OF_RESOURCES
;
1098 NewFileContext
= (FILE_CONTEXT
*) NewMenuEntry
->VariableContext
;
1099 NewFileContext
->DeviceHandle
= DeviceHandle
;
1100 NewFileContext
->FileName
= LibAppendFileName (FileName
, DirInfo
->FileName
);
1101 NewFileContext
->FileHandle
= FileHandle
;
1102 NewFileContext
->DevicePath
= FileDevicePath (NewFileContext
->DeviceHandle
, NewFileContext
->FileName
);
1103 NewMenuEntry
->HelpString
= NULL
;
1104 NewFileContext
->IsDir
= (BOOLEAN
) ((DirInfo
->Attribute
& EFI_FILE_DIRECTORY
) == EFI_FILE_DIRECTORY
);
1106 if (NewFileContext
->IsDir
) {
1107 BufferSize
= StrLen (DirInfo
->FileName
) * 2 + 6;
1108 NewMenuEntry
->DisplayString
= AllocateZeroPool (BufferSize
);
1110 NewMenuEntry
->DisplayString
,
1116 NewMenuEntry
->DisplayString
= LibStrDuplicate (DirInfo
->FileName
);
1119 NewMenuEntry
->DisplayStringToken
= HiiSetString (
1120 gFileExplorerPrivate
.FeHiiHandle
,
1122 NewMenuEntry
->DisplayString
,
1126 NewFileContext
->IsRoot
= FALSE
;
1129 InsertTailList (&gFileExplorerPrivate
.FsOptionMenu
->Head
, &NewMenuEntry
->Link
);
1133 gFileExplorerPrivate
.FsOptionMenu
->MenuNumber
= OptionNumber
;
1141 Refresh the global UpdateData structure.
1145 LibRefreshUpdateData (
1150 // Free current updated date
1152 if (mLibStartOpCodeHandle
!= NULL
) {
1153 HiiFreeOpCodeHandle (mLibStartOpCodeHandle
);
1155 if (mLibEndOpCodeHandle
!= NULL
) {
1156 HiiFreeOpCodeHandle (mLibEndOpCodeHandle
);
1160 // Create new OpCode Handle
1162 mLibStartOpCodeHandle
= HiiAllocateOpCodeHandle ();
1163 mLibEndOpCodeHandle
= HiiAllocateOpCodeHandle ();
1166 // Create Hii Extend Label OpCode as the start opcode
1168 mLibStartLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
1169 mLibStartOpCodeHandle
,
1172 sizeof (EFI_IFR_GUID_LABEL
)
1174 mLibStartLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1176 mLibStartLabel
->Number
= FORM_FILE_EXPLORER_ID
;
1179 // Create Hii Extend Label OpCode as the start opcode
1181 mLibEndLabel
= (EFI_IFR_GUID_LABEL
*) HiiCreateGuidOpCode (
1182 mLibEndOpCodeHandle
,
1185 sizeof (EFI_IFR_GUID_LABEL
)
1187 mLibEndLabel
->ExtendOpCode
= EFI_IFR_EXTEND_OP_LABEL
;
1189 mLibEndLabel
->Number
= LABEL_END
;
1194 Update the File Explore page.
1198 LibUpdateFileExplorePage (
1203 MENU_ENTRY
*NewMenuEntry
;
1204 FILE_CONTEXT
*NewFileContext
;
1205 MENU_OPTION
*MenuOption
;
1207 NewMenuEntry
= NULL
;
1208 NewFileContext
= NULL
;
1210 LibRefreshUpdateData ();
1211 MenuOption
= gFileExplorerPrivate
.FsOptionMenu
;
1213 for (Index
= 0; Index
< MenuOption
->MenuNumber
; Index
++) {
1214 NewMenuEntry
= LibGetMenuEntry (MenuOption
, Index
);
1215 NewFileContext
= (FILE_CONTEXT
*) NewMenuEntry
->VariableContext
;
1217 if (!NewFileContext
->IsDir
) {
1219 // Create Text opcode for directory, also create Text opcode for file in FileExplorerStateBootFromFile.
1221 HiiCreateActionOpCode (
1222 mLibStartOpCodeHandle
,
1223 (UINT16
) (FILE_OPTION_OFFSET
+ Index
),
1224 NewMenuEntry
->DisplayStringToken
,
1225 STRING_TOKEN (STR_NULL_STRING
),
1226 EFI_IFR_FLAG_CALLBACK
,
1231 // Create Goto opcode for file in FileExplorerStateAddBootOption or FileExplorerStateAddDriverOptionState.
1233 HiiCreateGotoOpCode (
1234 mLibStartOpCodeHandle
,
1235 FORM_FILE_EXPLORER_ID
,
1236 NewMenuEntry
->DisplayStringToken
,
1237 STRING_TOKEN (STR_NULL_STRING
),
1238 EFI_IFR_FLAG_CALLBACK
,
1239 (UINT16
) (FILE_OPTION_OFFSET
+ Index
)
1245 gFileExplorerPrivate
.FeHiiHandle
,
1247 FORM_FILE_EXPLORER_ID
,
1248 mLibStartOpCodeHandle
, // Label FORM_FILE_EXPLORER_ID
1249 mLibEndOpCodeHandle
// LABEL_END
1254 Update the file explower page with the refershed file system.
1256 @param KeyValue Key value to identify the type of data to expect.
1258 @retval EFI_SUCCESS Update the file explorer form success.
1259 @retval other errors Error occur when parse one directory.
1263 LibUpdateFileExplorer (
1267 UINT16 FileOptionMask
;
1268 MENU_ENTRY
*NewMenuEntry
;
1269 FILE_CONTEXT
*NewFileContext
;
1271 EFI_FILE_HANDLE FileHandle
;
1273 Status
= EFI_SUCCESS
;
1274 FileOptionMask
= (UINT16
) (FILE_OPTION_MASK
& KeyValue
);
1275 NewMenuEntry
= LibGetMenuEntry (gFileExplorerPrivate
.FsOptionMenu
, FileOptionMask
);
1276 NewFileContext
= (FILE_CONTEXT
*) NewMenuEntry
->VariableContext
;
1278 if (NewFileContext
->IsDir
) {
1279 RemoveEntryList (&NewMenuEntry
->Link
);
1280 LibFreeMenu (gFileExplorerPrivate
.FsOptionMenu
);
1281 LibGetFileHandleFromMenu (NewMenuEntry
, &FileHandle
);
1282 Status
= LibFindFiles (FileHandle
, NewFileContext
->FileName
, NewFileContext
->DeviceHandle
);
1283 if (!EFI_ERROR (Status
)) {
1284 LibUpdateFileExplorePage ();
1286 LibFreeMenu (gFileExplorerPrivate
.FsOptionMenu
);
1288 LibDestroyMenuEntry (NewMenuEntry
);
1295 Get the device path info saved in the menu structure.
1297 @param KeyValue Key value to identify the type of data to expect.
1305 UINT16 FileOptionMask
;
1306 MENU_ENTRY
*NewMenuEntry
;
1307 FILE_CONTEXT
*NewFileContext
;
1309 FileOptionMask
= (UINT16
) (FILE_OPTION_MASK
& KeyValue
);
1311 NewMenuEntry
= LibGetMenuEntry (gFileExplorerPrivate
.FsOptionMenu
, FileOptionMask
);
1313 NewFileContext
= (FILE_CONTEXT
*) NewMenuEntry
->VariableContext
;
1315 if (gFileExplorerPrivate
.RetDevicePath
!= NULL
) {
1316 FreePool (gFileExplorerPrivate
.RetDevicePath
);
1318 gFileExplorerPrivate
.RetDevicePath
= DuplicateDevicePath (NewFileContext
->DevicePath
);
1322 Choose a file in the specified directory.
1324 If user input NULL for the RootDirectory, will choose file in the system.
1326 If user input *File != NULL, function will return the allocate device path
1327 info for the choosed file, caller has to free the memory after use it.
1329 @param RootDirectory Pointer to the root directory.
1330 @param FileType The file type need to choose.
1331 @param ChooseHandler Function pointer to the extra task need to do
1332 after choose one file.
1333 @param File Return the device path for the last time chosed file.
1335 @retval EFI_SUCESS Choose file success.
1336 @retval EFI_INVALID_PARAMETER Both ChooseHandler and return device path are NULL
1337 One of them must not NULL.
1338 @retval Other errors Choose file failed.
1343 IN EFI_DEVICE_PATH_PROTOCOL
*RootDirectory
,
1344 IN CHAR16
*FileType
, OPTIONAL
1345 IN CHOOSE_HANDLER ChooseHandler
, OPTIONAL
1346 OUT EFI_DEVICE_PATH_PROTOCOL
**File OPTIONAL
1349 EFI_FILE_HANDLE FileHandle
;
1352 EFI_HANDLE DeviceHandle
;
1354 if ((ChooseHandler
== NULL
) && (File
== NULL
)) {
1355 return EFI_INVALID_PARAMETER
;
1360 gFileExplorerPrivate
.RetDevicePath
= NULL
;
1361 gFileExplorerPrivate
.ChooseHandler
= ChooseHandler
;
1362 if (FileType
!= NULL
) {
1363 gFileExplorerPrivate
.FileType
= AllocateCopyPool (StrSize (FileType
), FileType
);
1364 LibToLowerString(gFileExplorerPrivate
.FileType
);
1366 gFileExplorerPrivate
.FileType
= NULL
;
1369 if (RootDirectory
== NULL
) {
1370 Status
= LibFindFileSystem();
1372 Status
= LibGetFileHandleFromDevicePath(RootDirectory
, &FileHandle
, &FileName
, &DeviceHandle
);
1373 if (EFI_ERROR (Status
)) {
1377 Status
= LibFindFiles (FileHandle
, FileName
, DeviceHandle
);
1379 if (EFI_ERROR (Status
)) {
1383 LibUpdateFileExplorePage();
1385 gFileExplorerPrivate
.FormBrowser2
->SendForm (
1386 gFileExplorerPrivate
.FormBrowser2
,
1387 &gFileExplorerPrivate
.FeHiiHandle
,
1396 if ((Status
== EFI_SUCCESS
) && (File
!= NULL
)) {
1397 *File
= gFileExplorerPrivate
.RetDevicePath
;
1398 } else if (gFileExplorerPrivate
.RetDevicePath
!= NULL
) {
1399 FreePool (gFileExplorerPrivate
.RetDevicePath
);
1402 if (gFileExplorerPrivate
.FileType
!= NULL
) {
1403 FreePool (gFileExplorerPrivate
.FileType
);
1406 LibFreeMenu (gFileExplorerPrivate
.FsOptionMenu
);
1408 if (FileName
!= NULL
) {
1409 FreePool (FileName
);
1417 Install Boot Manager Menu driver.
1419 @param ImageHandle The image handle.
1420 @param SystemTable The system table.
1422 @retval EFI_SUCEESS Install File explorer library success.
1427 FileExplorerLibConstructor (
1428 IN EFI_HANDLE ImageHandle
,
1429 IN EFI_SYSTEM_TABLE
*SystemTable
1434 gHiiVendorDevicePath
= (HII_VENDOR_DEVICE_PATH
*) DuplicateDevicePath ((EFI_DEVICE_PATH_PROTOCOL
*)&FeHiiVendorDevicePath
);
1435 ASSERT (gHiiVendorDevicePath
!= NULL
);
1436 CopyGuid (&gHiiVendorDevicePath
->VendorDevicePath
.Guid
, &gEfiCallerIdGuid
);
1439 // Install Device Path Protocol and Config Access protocol to driver handle
1441 Status
= gBS
->InstallMultipleProtocolInterfaces (
1442 &gFileExplorerPrivate
.FeDriverHandle
,
1443 &gEfiDevicePathProtocolGuid
,
1444 gHiiVendorDevicePath
,
1445 &gEfiHiiConfigAccessProtocolGuid
,
1446 &gFileExplorerPrivate
.FeConfigAccess
,
1449 if (Status
== EFI_ALREADY_STARTED
) {
1452 if (EFI_ERROR (Status
)) {
1457 // Post our File Explorer VFR binary to the HII database.
1459 gFileExplorerPrivate
.FeHiiHandle
= HiiAddPackages (
1461 gFileExplorerPrivate
.FeDriverHandle
,
1463 FileExplorerLibStrings
,
1466 ASSERT (gFileExplorerPrivate
.FeHiiHandle
!= NULL
);
1469 // Locate Formbrowser2 protocol
1471 Status
= gBS
->LocateProtocol (&gEfiFormBrowser2ProtocolGuid
, NULL
, (VOID
**) &gFileExplorerPrivate
.FormBrowser2
);
1472 ASSERT_EFI_ERROR (Status
);
1474 InitializeListHead (&gFileExplorerPrivate
.FsOptionMenu
->Head
);
1480 Unloads the application and its installed protocol.
1482 @param[in] ImageHandle Handle that identifies the image to be unloaded.
1483 @param[in] SystemTable The system table.
1485 @retval EFI_SUCCESS The image has been unloaded.
1489 FileExplorerLibDestructor (
1490 IN EFI_HANDLE ImageHandle
,
1491 IN EFI_SYSTEM_TABLE
*SystemTable
1496 ASSERT (gHiiVendorDevicePath
!= NULL
);
1498 if (gFileExplorerPrivate
.FeDriverHandle
!= NULL
) {
1499 Status
= gBS
->UninstallMultipleProtocolInterfaces (
1500 gFileExplorerPrivate
.FeDriverHandle
,
1501 &gEfiDevicePathProtocolGuid
,
1502 gHiiVendorDevicePath
,
1503 &gEfiHiiConfigAccessProtocolGuid
,
1504 &gFileExplorerPrivate
.FeConfigAccess
,
1507 ASSERT_EFI_ERROR (Status
);
1509 HiiRemovePackages (gFileExplorerPrivate
.FeHiiHandle
);
1512 FreePool (gHiiVendorDevicePath
);