2 This driver uses the EFI_FIRMWARE_VOLUME2_PROTOCOL to expose files in firmware
3 volumes via the the EFI_SIMPLE_FILESYSTEM_PROTOCOL and EFI_FILE_PROTOCOL.
5 It will expose a single directory, containing one file for each file in the firmware
6 volume. If a file has a UI section, its contents will be used as a filename.
7 Otherwise, a string representation of the GUID will be used.
8 Files of an executable type (That is PEIM, DRIVER, COMBINED_PEIM_DRIVER and APPLICATION)
9 will have ".efi" added to their filename.
11 Its primary intended use is to be able to start EFI applications embedded in FVs
12 from the UEFI shell. It is entirely read-only.
14 Copyright (c) 2014, ARM Limited. All rights reserved.
15 Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
17 This program and the accompanying materials
18 are licensed and made available under the terms and conditions of the BSD License
19 which accompanies this distribution. The full text of the license may be found at
20 http://opensource.org/licenses/bsd-license.php
22 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
23 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
27 #include "FvSimpleFileSystemInternal.h"
29 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
32 // A Guid string is 32 hex characters with 4 hyphens and a NULL-terminated char: 37 characters total
34 #define GUID_STRING_SIZE (37 * sizeof (CHAR16))
36 #define FVFS_VOLUME_LABEL_PREFIX L"Firmware Volume: "
37 #define FVFS_VOLUME_LABEL_SIZE (sizeof (FVFS_VOLUME_LABEL_PREFIX) + GUID_STRING_SIZE - sizeof (CHAR16))
38 #define FVFS_FALLBACK_VOLUME_LABEL L"Firmware Volume"
41 // Template for EFI_SIMPLE_FILE_SYSTEM_PROTOCOL data structure.
43 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL mSimpleFsTemplate
= {
44 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION
,
45 FvSimpleFileSystemOpenVolume
49 // Template for EFI_DRIVER_BINDING_PROTOCOL data structure.
51 EFI_DRIVER_BINDING_PROTOCOL mDriverBinding
= {
52 FvSimpleFileSystemDriverSupported
,
53 FvSimpleFileSystemDriverStart
,
54 FvSimpleFileSystemDriverStop
,
61 Open the root directory on a volume.
63 @param This A pointer to the volume to open the root directory.
64 @param RootFile A pointer to the location to return the opened file handle for the
67 @retval EFI_SUCCESS The device was opened.
68 @retval EFI_UNSUPPORTED This volume does not support the requested file system type.
69 @retval EFI_NO_MEDIA The device has no medium.
70 @retval EFI_DEVICE_ERROR The device reported an error.
71 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
72 @retval EFI_ACCESS_DENIED The service denied access to the file.
73 @retval EFI_OUT_OF_RESOURCES The volume was not opened due to lack of resources.
74 @retval EFI_MEDIA_CHANGED The device has a different medium in it or the medium is no
75 longer supported. Any existing file handles for this volume are
76 no longer valid. To access the files on the new medium, the
77 volume must be reopened with OpenVolume().
82 FvSimpleFileSystemOpenVolume (
83 IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*This
,
84 OUT EFI_FILE_PROTOCOL
**RootFile
88 FV_FILESYSTEM_FILE
*Root
;
91 EFI_FV_FILE_ATTRIBUTES Attributes
;
92 UINT32 Authentication
;
94 EFI_FV_FILETYPE FileType
;
96 FV_FILESYSTEM_INSTANCE
*Instance
;
97 FV_FILESYSTEM_FILE_INFO
*FvFileInfo
;
98 EFI_FIRMWARE_VOLUME2_PROTOCOL
*FvProtocol
;
104 Instance
= FVFS_INSTANCE_FROM_SIMPLE_FS_THIS (This
);
105 Status
= EFI_SUCCESS
;
107 if (Instance
->Root
== NULL
) {
109 // Allocate file structure for root file
111 Root
= AllocateZeroPool (sizeof (FV_FILESYSTEM_FILE
));
113 return EFI_OUT_OF_RESOURCES
;
116 Instance
->Root
= Root
;
117 Root
->Instance
= Instance
;
118 Root
->Signature
= FVFS_FILE_SIGNATURE
;
119 CopyMem (&Root
->FileProtocol
, &mFileSystemTemplate
, sizeof (mFileSystemTemplate
));
120 Root
->FvFileInfo
= AllocateZeroPool (sizeof (FV_FILESYSTEM_FILE_INFO
));
121 if (Root
->FvFileInfo
== NULL
) {
122 return EFI_OUT_OF_RESOURCES
;
124 Root
->FvFileInfo
->FileInfo
.Size
= sizeof (EFI_FILE_INFO
);
125 Root
->FvFileInfo
->FileInfo
.Attribute
= EFI_FILE_DIRECTORY
| EFI_FILE_READ_ONLY
;
128 // Populate the instance's list of files. We consider anything a file that
129 // has a UI_SECTION, which we consider to be its filename.
131 FvProtocol
= Instance
->FvProtocol
;
138 FileType
= EFI_FV_FILETYPE_ALL
;
140 Status
= FvProtocol
->GetNextFile (
148 if (EFI_ERROR (Status
)) {
149 ASSERT (Status
== EFI_NOT_FOUND
);
154 // Get a file's name: If it has a UI section, use that, otherwise use
158 Status
= FvProtocol
->ReadSection (
161 EFI_SECTION_USER_INTERFACE
,
167 if (!EFI_ERROR (Status
)) {
170 Name
= AllocateZeroPool (GUID_STRING_SIZE
);
172 return EFI_OUT_OF_RESOURCES
;
174 NumChars
= UnicodeSPrint (Name
, GUID_STRING_SIZE
, L
"%g", &NameGuid
);
175 ASSERT ((NumChars
+ 1) * sizeof (CHAR16
) == GUID_STRING_SIZE
);
180 // Allocate a file structure and populate it.
182 NameLen
= StrSize (Name
);
183 if (FV_FILETYPE_IS_EXECUTABLE (FileType
)) {
184 NameLen
+= StrSize (L
".efi") - sizeof (CHAR16
);
187 FvFileInfo
= AllocateZeroPool (sizeof (FV_FILESYSTEM_FILE_INFO
) + NameLen
- sizeof (CHAR16
));
188 if (FvFileInfo
== NULL
) {
189 return EFI_OUT_OF_RESOURCES
;
192 FvFileInfo
->Signature
= FVFS_FILE_INFO_SIGNATURE
;
193 InitializeListHead (&FvFileInfo
->Link
);
194 CopyMem (&FvFileInfo
->NameGuid
, &NameGuid
, sizeof (EFI_GUID
));
195 FvFileInfo
->Type
= FileType
;
198 // Add ".efi" to filenames of drivers and applications.
200 DestMax
= NameLen
/ sizeof (CHAR16
);
201 Status
= StrnCpyS (&FvFileInfo
->FileInfo
.FileName
[0], DestMax
, Name
, StrLen (Name
));
202 ASSERT_EFI_ERROR (Status
);
204 if (FV_FILETYPE_IS_EXECUTABLE (FileType
)) {
205 Status
= StrnCatS (&FvFileInfo
->FileInfo
.FileName
[0], DestMax
, L
".efi", StrLen (L
".efi"));
206 ASSERT_EFI_ERROR (Status
);
209 FvFileInfo
->FileInfo
.Size
= sizeof (EFI_FILE_INFO
) + NameLen
- sizeof (CHAR16
);
210 Status
= FvFsGetFileSize (FvProtocol
, FvFileInfo
);
211 ASSERT_EFI_ERROR (Status
);
212 FvFileInfo
->FileInfo
.PhysicalSize
= FvFileInfo
->FileInfo
.FileSize
;
213 FvFileInfo
->FileInfo
.Attribute
= EFI_FILE_READ_ONLY
;
215 InsertHeadList (&Instance
->FileInfoHead
, &FvFileInfo
->Link
);
221 if (Status
== EFI_NOT_FOUND
) {
222 Status
= EFI_SUCCESS
;
226 Instance
->Root
->DirReadNext
= NULL
;
227 if (!IsListEmpty (&Instance
->FileInfoHead
)) {
228 Instance
->Root
->DirReadNext
= FVFS_GET_FIRST_FILE_INFO (Instance
);
231 *RootFile
= &Instance
->Root
->FileProtocol
;
236 Worker function to initialize Unicode Collation support.
238 It tries to locate Unicode Collation (2) protocol and matches it with current
239 platform language code.
241 @param AgentHandle The handle used to open Unicode Collation (2) protocol.
242 @param ProtocolGuid The pointer to Unicode Collation (2) protocol GUID.
243 @param VariableName The name of the RFC 4646 or ISO 639-2 language variable.
244 @param DefaultLanguage The default language in case the RFC 4646 or ISO 639-2 language is absent.
246 @retval EFI_SUCCESS The Unicode Collation (2) protocol has been successfully located.
247 @retval Others The Unicode Collation (2) protocol has not been located.
251 InitializeUnicodeCollationSupportWorker (
252 IN EFI_HANDLE AgentHandle
,
253 IN EFI_GUID
*ProtocolGuid
,
254 IN CONST CHAR16
*VariableName
,
255 IN CONST CHAR8
*DefaultLanguage
258 EFI_STATUS ReturnStatus
;
263 EFI_UNICODE_COLLATION_PROTOCOL
*Uci
;
264 BOOLEAN Iso639Language
;
268 Status
= gBS
->LocateHandleBuffer (
275 if (EFI_ERROR (Status
)) {
279 Iso639Language
= (BOOLEAN
) (ProtocolGuid
== &gEfiUnicodeCollationProtocolGuid
);
280 GetEfiGlobalVariable2 (VariableName
, (VOID
**) &Language
, NULL
);
282 ReturnStatus
= EFI_UNSUPPORTED
;
283 for (Index
= 0; Index
< NumHandles
; Index
++) {
285 // Open Unicode Collation Protocol
287 Status
= gBS
->OpenProtocol (
293 EFI_OPEN_PROTOCOL_GET_PROTOCOL
295 if (EFI_ERROR (Status
)) {
300 // Find the best matching matching language from the supported languages
301 // of Unicode Collation (2) protocol.
303 BestLanguage
= GetBestLanguage (
304 Uci
->SupportedLanguages
,
306 (Language
== NULL
) ? "" : Language
,
310 if (BestLanguage
!= NULL
) {
311 FreePool (BestLanguage
);
312 mUnicodeCollation
= Uci
;
313 ReturnStatus
= EFI_SUCCESS
;
318 if (Language
!= NULL
) {
328 Initialize Unicode Collation support.
330 It tries to locate Unicode Collation 2 protocol and matches it with current
331 platform language code. If for any reason the first attempt fails, it then tries to
332 use Unicode Collation Protocol.
334 @param AgentHandle The handle used to open Unicode Collation (2) protocol.
336 @retval EFI_SUCCESS The Unicode Collation (2) protocol has been successfully located.
337 @retval Others The Unicode Collation (2) protocol has not been located.
341 InitializeUnicodeCollationSupport (
342 IN EFI_HANDLE AgentHandle
348 Status
= EFI_UNSUPPORTED
;
351 // First try to use RFC 4646 Unicode Collation 2 Protocol.
353 Status
= InitializeUnicodeCollationSupportWorker (
355 &gEfiUnicodeCollation2ProtocolGuid
,
357 (CONST CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultPlatformLang
)
360 // If the attempt to use Unicode Collation 2 Protocol fails, then we fall back
361 // on the ISO 639-2 Unicode Collation Protocol.
363 if (EFI_ERROR (Status
)) {
364 Status
= InitializeUnicodeCollationSupportWorker (
366 &gEfiUnicodeCollationProtocolGuid
,
368 (CONST CHAR8
*) PcdGetPtr (PcdUefiVariableDefaultLang
)
376 Test to see if this driver supports ControllerHandle.
378 @param DriverBinding Protocol instance pointer.
379 @param ControllerHandle Handle of device to test
380 @param RemainingDevicePath Optional parameter use to pick a specific child
383 @retval EFI_SUCCESS This driver supports this device
384 @retval EFI_ALREADY_STARTED This driver is already running on this device
385 @retval other This driver does not support this device
390 FvSimpleFileSystemDriverSupported (
391 IN EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
,
392 IN EFI_HANDLE ControllerHandle
,
393 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
396 return gBS
->OpenProtocol (
398 &gEfiFirmwareVolume2ProtocolGuid
,
402 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
407 Start this driver on ControllerHandle by opening a FV protocol and
408 installing a SimpleFileSystem protocol on ControllerHandle.
410 @param DriverBinding Protocol instance pointer.
411 @param ControllerHandle Handle of device to bind driver to
412 @param RemainingDevicePath Optional parameter use to pick a specific child
415 @retval EFI_SUCCESS This driver is added to ControllerHandle
416 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
417 @retval other This driver does not support this device
422 FvSimpleFileSystemDriverStart (
423 IN EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
,
424 IN EFI_HANDLE ControllerHandle
,
425 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
429 EFI_FIRMWARE_VOLUME2_PROTOCOL
*FvProtocol
;
430 FV_FILESYSTEM_INSTANCE
*Instance
;
431 EFI_DEVICE_PATH_PROTOCOL
*FvDevicePath
;
435 Status
= InitializeUnicodeCollationSupport (DriverBinding
->DriverBindingHandle
);
436 if (EFI_ERROR (Status
)) {
443 Status
= gBS
->OpenProtocol (
445 &gEfiFirmwareVolume2ProtocolGuid
,
446 (VOID
**) &FvProtocol
,
449 EFI_OPEN_PROTOCOL_BY_DRIVER
451 if (EFI_ERROR (Status
)) {
456 // Create an instance
458 Instance
= AllocateZeroPool (sizeof (FV_FILESYSTEM_INSTANCE
));
459 ASSERT (Instance
!= NULL
);
461 Instance
->Root
= NULL
;
462 Instance
->FvProtocol
= FvProtocol
;
463 Instance
->Signature
= FVFS_INSTANCE_SIGNATURE
;
464 InitializeListHead (&Instance
->FileInfoHead
);
465 InitializeListHead (&Instance
->FileHead
);
466 CopyMem (&Instance
->SimpleFs
, &mSimpleFsTemplate
, sizeof (mSimpleFsTemplate
));
468 Status
= gBS
->InstallProtocolInterface(
470 &gEfiSimpleFileSystemProtocolGuid
,
471 EFI_NATIVE_INTERFACE
,
474 ASSERT_EFI_ERROR (Status
);
477 // Decide on a filesystem volume label, which will include the FV's guid.
478 // Get the device path to find the FV's GUID
480 Instance
->VolumeLabel
= NULL
;
481 Status
= gBS
->OpenProtocol (
483 &gEfiDevicePathProtocolGuid
,
484 (VOID
**) &FvDevicePath
,
487 EFI_OPEN_PROTOCOL_GET_PROTOCOL
489 if (!EFI_ERROR (Status
)) {
491 // Iterate over device path until we find a firmware volume node
493 while (!IsDevicePathEndType (FvDevicePath
)) {
494 if (DevicePathType (FvDevicePath
) == MEDIA_DEVICE_PATH
&&
495 DevicePathSubType (FvDevicePath
) == MEDIA_PIWG_FW_VOL_DP
) {
497 // Allocate the volume label
499 Instance
->VolumeLabel
= AllocateZeroPool (FVFS_VOLUME_LABEL_SIZE
);
501 // Check the allocation was successful
503 if (Instance
->VolumeLabel
!= NULL
) {
505 // Extract the FV's guid
507 FvGuid
= &((MEDIA_FW_VOL_DEVICE_PATH
*) FvDevicePath
)->FvName
;
509 // Build the volume label string
511 NumChars
= UnicodeSPrint (
512 Instance
->VolumeLabel
,
513 FVFS_VOLUME_LABEL_SIZE
,
514 FVFS_VOLUME_LABEL_PREFIX L
"%g",
517 ASSERT ((NumChars
+ 1) * sizeof (CHAR16
) == FVFS_VOLUME_LABEL_SIZE
);
521 FvDevicePath
= NextDevicePathNode (FvDevicePath
);
525 // If we didn't decide on a volume label, set a fallback one
527 if (Instance
->VolumeLabel
== NULL
) {
528 Instance
->VolumeLabel
= AllocateCopyPool (
529 sizeof (FVFS_FALLBACK_VOLUME_LABEL
),
530 FVFS_FALLBACK_VOLUME_LABEL
538 Stop this driver on ControllerHandle by removing SimpleFileSystem protocol and closing
539 the FV protocol on ControllerHandle.
541 @param DriverBinding Protocol instance pointer.
542 @param ControllerHandle Handle of device to stop driver on
543 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
544 children is zero stop the entire bus driver.
545 @param ChildHandleBuffer List of Child Handles to Stop.
547 @retval EFI_SUCCESS This driver is removed ControllerHandle
548 @retval other This driver was not removed from this device
553 FvSimpleFileSystemDriverStop (
554 IN EFI_DRIVER_BINDING_PROTOCOL
*DriverBinding
,
555 IN EFI_HANDLE ControllerHandle
,
556 IN UINTN NumberOfChildren
,
557 IN EFI_HANDLE
*ChildHandleBuffer OPTIONAL
561 FV_FILESYSTEM_INSTANCE
*Instance
;
562 FV_FILESYSTEM_FILE_INFO
*FvFileInfo
;
564 LIST_ENTRY
*DelEntry
;
565 EFI_SIMPLE_FILE_SYSTEM_PROTOCOL
*SimpleFile
;
567 Status
= gBS
->OpenProtocol (
569 &gEfiSimpleFileSystemProtocolGuid
,
570 (VOID
**) &SimpleFile
,
571 DriverBinding
->DriverBindingHandle
,
573 EFI_OPEN_PROTOCOL_GET_PROTOCOL
575 if (EFI_ERROR (Status
)) {
579 Instance
= FVFS_INSTANCE_FROM_SIMPLE_FS_THIS (SimpleFile
);
581 if (IsListEmpty (&Instance
->FileHead
) == FALSE
) {
583 // Not all opened files are closed
585 return EFI_DEVICE_ERROR
;
589 // Close and uninstall protocols.
591 Status
= gBS
->CloseProtocol (
593 &gEfiFirmwareVolume2ProtocolGuid
,
597 ASSERT_EFI_ERROR (Status
);
599 Status
= gBS
->UninstallProtocolInterface (
601 &gEfiSimpleFileSystemProtocolGuid
,
604 ASSERT_EFI_ERROR (Status
);
607 // Free file structures
609 if (!IsListEmpty (&Instance
->FileInfoHead
)) {
611 // Free the Subtask list.
613 for(Entry
= Instance
->FileInfoHead
.ForwardLink
;
614 Entry
!= (&Instance
->FileInfoHead
);
617 Entry
= Entry
->ForwardLink
;
618 FvFileInfo
= FVFS_FILE_INFO_FROM_LINK (DelEntry
);
620 RemoveEntryList (DelEntry
);
621 FreePool (FvFileInfo
);
625 if (Instance
->Root
!= NULL
) {
627 // Root->Name is statically allocated, no need to free.
629 if (Instance
->Root
->FvFileInfo
!= NULL
) {
630 FreePool (Instance
->Root
->FvFileInfo
);
632 FreePool (Instance
->Root
);
638 if (Instance
->VolumeLabel
!= NULL
) {
639 FreePool (Instance
->VolumeLabel
);
647 The user Entry Point for module FvSimpleFileSystem. The user code starts with this function.
649 @param[in] ImageHandle The firmware allocated handle for the EFI image.
650 @param[in] SystemTable A pointer to the EFI System Table.
652 @retval EFI_SUCCESS The entry point is executed successfully.
653 @retval other Some error occurs when executing this entry point.
658 FvSimpleFileSystemEntryPoint (
659 IN EFI_HANDLE ImageHandle
,
660 IN EFI_SYSTEM_TABLE
*SystemTable
666 // Install driver model protocol(s).
668 Status
= EfiLibInstallDriverBindingComponentName2 (
673 &gFvSimpleFileSystemComponentName
,
674 &gFvSimpleFileSystemComponentName2
676 ASSERT_EFI_ERROR (Status
);