-/** @file
- Instance of file explorer Library based on gEfiFileExplorerProtocolGuid.
-
- Implement the file explorer library instance by wrap the interface
- provided in the file explorer protocol. This protocol is defined as the internal
- protocol related to this implementation, not in the public spec. So, this
- library instance is only for this code base.
-
-Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
-This program and the accompanying materials
-are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution. The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#include <Uefi.h>
-#include <Base.h>
-#include <Protocol/FileExplorer.h>
-
-#include <Library/FileExplorerLib.h>
-
-#include <Library/BaseLib.h>
-#include <Library/DebugLib.h>
-
-EFI_FILE_EXPLORER_PROTOCOL *mProtocol = NULL;
-
-/**
- The constructor function caches the pointer to file explorer protocol.
-
- The constructor function locates Print2 protocol from protocol database.
- It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.
-
- @param ImageHandle The firmware allocated handle for the EFI image.
- @param SystemTable A pointer to the EFI System Table.
-
- @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.
-
-**/
-EFI_STATUS
-EFIAPI
-FileExplorerConstructor (
- IN EFI_HANDLE ImageHandle,
- IN EFI_SYSTEM_TABLE *SystemTable
- )
-{
- EFI_STATUS Status;
-
- Status = SystemTable->BootServices->LocateProtocol (
- &gEfiFileExplorerProtocolGuid,
- NULL,
- (VOID**) &mProtocol
- );
- ASSERT_EFI_ERROR (Status);
- ASSERT (mProtocol != NULL);
-
- return Status;
-}
-
-/**
- Choose a file in the specified directory.
-
- If user input NULL for the RootDirectory, will choose file in the system.
-
- If user input *File != NULL, function will return the allocate device path
- info for the choosed file, caller has to free the memory after use it.
-
- @param RootDirectory Pointer to the root directory.
- @param FileType The file type need to choose.
- @param ChooseHandler Function pointer to the extra task need to do
- after choose one file.
- @param File Return the device path for the last time chosed file.
-
- @retval EFI_SUCESS Choose file success.
- @retval EFI_INVALID_PARAMETER Both ChooseHandler and return device path are NULL
- One of them must not NULL.
- @retval Other errors Choose file failed.
-**/
-EFI_STATUS
-EFIAPI
-ChooseFile (
- IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory,
- IN CHAR16 *FileType, OPTIONAL
- IN CHOOSE_HANDLER ChooseHandler, OPTIONAL
- OUT EFI_DEVICE_PATH_PROTOCOL **File OPTIONAL
- )
-{
- return mProtocol->ChooseFile (RootDirectory, FileType, ChooseHandler, File);
-}
-
+/** @file\r
+ Instance of file explorer Library based on gEfiFileExplorerProtocolGuid.\r
+\r
+ Implement the file explorer library instance by wrap the interface\r
+ provided in the file explorer protocol. This protocol is defined as the internal\r
+ protocol related to this implementation, not in the public spec. So, this\r
+ library instance is only for this code base.\r
+\r
+Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#include <Uefi.h>\r
+#include <Base.h>\r
+#include <Protocol/FileExplorer.h>\r
+\r
+#include <Library/FileExplorerLib.h>\r
+\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
+\r
+EFI_FILE_EXPLORER_PROTOCOL *mProtocol = NULL;\r
+\r
+/**\r
+ The constructor function caches the pointer to file explorer protocol.\r
+\r
+ The constructor function locates Print2 protocol from protocol database.\r
+ It will ASSERT() if that operation fails and it will always return EFI_SUCCESS.\r
+\r
+ @param ImageHandle The firmware allocated handle for the EFI image.\r
+ @param SystemTable A pointer to the EFI System Table.\r
+\r
+ @retval EFI_SUCCESS The constructor always returns EFI_SUCCESS.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+FileExplorerConstructor (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ Status = SystemTable->BootServices->LocateProtocol (\r
+ &gEfiFileExplorerProtocolGuid,\r
+ NULL,\r
+ (VOID**) &mProtocol\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+ ASSERT (mProtocol != NULL);\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+ Choose a file in the specified directory.\r
+\r
+ If user input NULL for the RootDirectory, will choose file in the system.\r
+\r
+ If user input *File != NULL, function will return the allocate device path\r
+ info for the choosed file, caller has to free the memory after use it.\r
+\r
+ @param RootDirectory Pointer to the root directory.\r
+ @param FileType The file type need to choose.\r
+ @param ChooseHandler Function pointer to the extra task need to do\r
+ after choose one file.\r
+ @param File Return the device path for the last time chosed file.\r
+\r
+ @retval EFI_SUCESS Choose file success.\r
+ @retval EFI_INVALID_PARAMETER Both ChooseHandler and return device path are NULL\r
+ One of them must not NULL.\r
+ @retval Other errors Choose file failed.\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ChooseFile (\r
+ IN EFI_DEVICE_PATH_PROTOCOL *RootDirectory,\r
+ IN CHAR16 *FileType, OPTIONAL\r
+ IN CHOOSE_HANDLER ChooseHandler, OPTIONAL\r
+ OUT EFI_DEVICE_PATH_PROTOCOL **File OPTIONAL\r
+ )\r
+{\r
+ return mProtocol->ChooseFile (RootDirectory, FileType, ChooseHandler, File);\r
+}\r
+\r
projects / mirror_edk2.git / blobdiff