MdeModulePkg CapsuleApp: Add directory support

Current CapsuleApp only supports input/output file from rootdirectory.
If the CapsuleApp and related file are put into subdirectory,
below message will be shown when running the CapsuleApp in shell.

"CapsuleApp: capsule image (Capsule image file name) is not found."

This patch is to add directory support for CapsuleApp
by using shell protocol.

Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Feng Tian <feng.tian@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
This commit is contained in:
Star Zeng 2017-04-11 09:55:51 +08:00
parent 9c0e4db3db
commit 8b17683a27
3 changed files with 119 additions and 327 deletions

View File

@ -18,22 +18,14 @@
#include <Library/BaseMemoryLib.h> #include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h> #include <Library/MemoryAllocationLib.h>
#include <Library/UefiBootServicesTableLib.h> #include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/PrintLib.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/SimpleFileSystem.h> #include <Protocol/SimpleFileSystem.h>
#include <Protocol/ShellParameters.h> #include <Protocol/ShellParameters.h>
#include <Protocol/Shell.h>
#include <Guid/FileInfo.h> #include <Guid/FileInfo.h>
#include <Guid/Gpt.h>
#define IS_HYPHEN(a) ((a) == L'-')
#define IS_NULL(a) ((a) == L'\0')
#define MAX_ARG_NUM 11
UINTN Argc; UINTN Argc;
CHAR16 **Argv; CHAR16 **Argv;
EFI_SHELL_PROTOCOL *mShellProtocol = NULL;
/** /**
@ -64,273 +56,29 @@ GetArg (
} }
/** /**
Return File System Volume containing this shell application. Get shell protocol.
@return File System Volume containing this shell application. @return Pointer to shell protocol.
**/ **/
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL * EFI_SHELL_PROTOCOL *
GetMyVol ( GetShellProtocol (
VOID VOID
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
EFI_LOADED_IMAGE_PROTOCOL *LoadedImage;
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Vol;
Status = gBS->HandleProtocol ( if (mShellProtocol == NULL) {
gImageHandle, Status = gBS->LocateProtocol (
&gEfiLoadedImageProtocolGuid, &gEfiShellProtocolGuid,
(VOID **)&LoadedImage NULL,
); (VOID **) &mShellProtocol
ASSERT_EFI_ERROR (Status);
Status = gBS->HandleProtocol (
LoadedImage->DeviceHandle,
&gEfiSimpleFileSystemProtocolGuid,
(VOID **)&Vol
);
if (!EFI_ERROR (Status)) {
return Vol;
}
return NULL;
}
/**
Read a file from this volume.
@param[in] Vol File System Volume
@param[in] FileName The file to be read.
@param[out] BufferSize The file buffer size
@param[out] Buffer The file buffer
@retval EFI_SUCCESS Read file successfully
@retval EFI_NOT_FOUND File not found
**/
EFI_STATUS
ReadFileFromVol (
IN EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Vol,
IN CHAR16 *FileName,
OUT UINTN *BufferSize,
OUT VOID **Buffer
)
{
EFI_STATUS Status;
EFI_FILE_HANDLE RootDir;
EFI_FILE_HANDLE Handle;
UINTN FileInfoSize;
EFI_FILE_INFO *FileInfo;
UINTN TempBufferSize;
VOID *TempBuffer;
//
// Open the root directory
//
Status = Vol->OpenVolume (Vol, &RootDir);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Open the file
//
Status = RootDir->Open (
RootDir,
&Handle,
FileName,
EFI_FILE_MODE_READ,
0
);
if (EFI_ERROR (Status)) {
RootDir->Close (RootDir);
return Status;
}
RootDir->Close (RootDir);
//
// Get the file information
//
FileInfoSize = sizeof(EFI_FILE_INFO) + 1024;
FileInfo = AllocateZeroPool (FileInfoSize);
if (FileInfo == NULL) {
Handle->Close (Handle);
return Status;
}
Status = Handle->GetInfo (
Handle,
&gEfiFileInfoGuid,
&FileInfoSize,
FileInfo
);
if (EFI_ERROR (Status)) {
Handle->Close (Handle);
gBS->FreePool (FileInfo);
return Status;
}
//
// Allocate buffer for the file data. The last CHAR16 is for L'\0'
//
TempBufferSize = (UINTN) FileInfo->FileSize + sizeof(CHAR16);
TempBuffer = AllocateZeroPool (TempBufferSize);
if (TempBuffer == NULL) {
Handle->Close (Handle);
gBS->FreePool (FileInfo);
return Status;
}
gBS->FreePool (FileInfo);
//
// Read the file data to the buffer
//
Status = Handle->Read (
Handle,
&TempBufferSize,
TempBuffer
);
if (EFI_ERROR (Status)) {
Handle->Close (Handle);
gBS->FreePool (TempBuffer);
return Status;
}
Handle->Close (Handle);
*BufferSize = TempBufferSize;
*Buffer = TempBuffer;
return EFI_SUCCESS;
}
/**
Read a file.
If ScanFs is FLASE, it will use this Vol as default Fs.
If ScanFs is TRUE, it will scan all FS and check the file.
If there is only one file match the name, it will be read.
If there is more than one file match the name, it will return Error.
@param[in,out] ThisVol File System Volume
@param[in] FileName The file to be read.
@param[out] BufferSize The file buffer size
@param[out] Buffer The file buffer
@param[in] ScanFs Need Scan all FS
@retval EFI_SUCCESS Read file successfully
@retval EFI_NOT_FOUND File not found
@retval EFI_NO_MAPPING There is duplicated files found
**/
EFI_STATUS
ReadFileToBufferEx (
IN OUT EFI_SIMPLE_FILE_SYSTEM_PROTOCOL **ThisVol,
IN CHAR16 *FileName,
OUT UINTN *BufferSize,
OUT VOID **Buffer,
IN BOOLEAN ScanFs
)
{
EFI_STATUS Status;
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Vol;
UINTN TempBufferSize;
VOID *TempBuffer;
UINTN NoHandles;
EFI_HANDLE *HandleBuffer;
UINTN Index;
//
// Check parameters
//
if ((FileName == NULL) || (Buffer == NULL) || (ThisVol == NULL)) {
return EFI_INVALID_PARAMETER;
}
//
// not scan fs
//
if (!ScanFs) {
if (*ThisVol == NULL) {
*ThisVol = GetMyVol ();
if (*ThisVol == NULL) {
return EFI_INVALID_PARAMETER;
}
}
//
// Read file directly from Vol
//
return ReadFileFromVol (*ThisVol, FileName, BufferSize, Buffer);
}
//
// need scan fs
//
//
// Get all Vol handle
//
Status = gBS->LocateHandleBuffer (
ByProtocol,
&gEfiSimpleFileSystemProtocolGuid,
NULL,
&NoHandles,
&HandleBuffer
);
if (EFI_ERROR (Status) && (NoHandles == 0)) {
return EFI_NOT_FOUND;
}
//
// Walk through each Vol
//
*ThisVol = NULL;
*BufferSize = 0;
*Buffer = NULL;
for (Index = 0; Index < NoHandles; Index++) {
Status = gBS->HandleProtocol (
HandleBuffer[Index],
&gEfiSimpleFileSystemProtocolGuid,
(VOID **)&Vol
); );
if (EFI_ERROR(Status)) { if (EFI_ERROR (Status)) {
continue; mShellProtocol = NULL;
}
Status = ReadFileFromVol (Vol, FileName, &TempBufferSize, &TempBuffer);
if (!EFI_ERROR (Status)) {
//
// Read file OK, check duplication
//
if (*ThisVol != NULL) {
//
// Find the duplicated file
//
gBS->FreePool (TempBuffer);
gBS->FreePool (*Buffer);
Print (L"Duplicated FileName found!\n");
return EFI_NO_MAPPING;
} else {
//
// Record value
//
*ThisVol = Vol;
*BufferSize = TempBufferSize;
*Buffer = TempBuffer;
}
} }
} }
// return mShellProtocol;
// Scan Fs done
//
if (*ThisVol == NULL) {
return EFI_NOT_FOUND;
}
//
// Done
//
return EFI_SUCCESS;
} }
/** /**
@ -341,7 +89,8 @@ ReadFileToBufferEx (
@param[out] Buffer The file buffer @param[out] Buffer The file buffer
@retval EFI_SUCCESS Read file successfully @retval EFI_SUCCESS Read file successfully
@retval EFI_NOT_FOUND File not found @retval EFI_NOT_FOUND Shell protocol or file not found
@retval others Read file failed
**/ **/
EFI_STATUS EFI_STATUS
ReadFileToBuffer ( ReadFileToBuffer (
@ -350,9 +99,64 @@ ReadFileToBuffer (
OUT VOID **Buffer OUT VOID **Buffer
) )
{ {
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Vol; EFI_STATUS Status;
Vol = NULL; EFI_SHELL_PROTOCOL *ShellProtocol;
return ReadFileToBufferEx(&Vol, FileName, BufferSize, Buffer, FALSE); SHELL_FILE_HANDLE Handle;
UINT64 FileSize;
UINTN TempBufferSize;
VOID *TempBuffer;
ShellProtocol = GetShellProtocol();
if (ShellProtocol == NULL) {
return EFI_NOT_FOUND;
}
//
// Open file by FileName.
//
Status = ShellProtocol->OpenFileByName (
FileName,
&Handle,
EFI_FILE_MODE_READ
);
if (EFI_ERROR (Status)) {
return Status;
}
//
// Get the file size.
//
Status = ShellProtocol->GetFileSize (Handle, &FileSize);
if (EFI_ERROR (Status)) {
ShellProtocol->CloseFile (Handle);
return Status;
}
TempBufferSize = (UINTN) FileSize;
TempBuffer = AllocateZeroPool (TempBufferSize);
if (TempBuffer == NULL) {
ShellProtocol->CloseFile (Handle);
return EFI_OUT_OF_RESOURCES;
}
//
// Read the file data to the buffer
//
Status = ShellProtocol->ReadFile (
Handle,
&TempBufferSize,
TempBuffer
);
if (EFI_ERROR (Status)) {
ShellProtocol->CloseFile (Handle);
return Status;
}
ShellProtocol->CloseFile (Handle);
*BufferSize = TempBufferSize;
*Buffer = TempBuffer;
return EFI_SUCCESS;
} }
/** /**
@ -363,6 +167,8 @@ ReadFileToBuffer (
@param[in] Buffer The file buffer @param[in] Buffer The file buffer
@retval EFI_SUCCESS Write file successfully @retval EFI_SUCCESS Write file successfully
@retval EFI_NOT_FOUND Shell protocol not found
@retval others Write file failed
**/ **/
EFI_STATUS EFI_STATUS
WriteFileFromBuffer ( WriteFileFromBuffer (
@ -372,79 +178,69 @@ WriteFileFromBuffer (
) )
{ {
EFI_STATUS Status; EFI_STATUS Status;
EFI_FILE_HANDLE RootDir; EFI_SHELL_PROTOCOL *ShellProtocol;
EFI_FILE_HANDLE Handle; SHELL_FILE_HANDLE Handle;
EFI_FILE_INFO *FileInfo;
UINTN TempBufferSize; UINTN TempBufferSize;
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Vol;
Vol = GetMyVol(); ShellProtocol = GetShellProtocol();
if (Vol == NULL) { if (ShellProtocol == NULL) {
return EFI_NOT_FOUND; return EFI_NOT_FOUND;
} }
// //
// Open the root directory // Open file by FileName.
// //
Status = Vol->OpenVolume (Vol, &RootDir); Status = ShellProtocol->OpenFileByName (
FileName,
&Handle,
EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE | EFI_FILE_MODE_CREATE
);
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
return Status; return Status;
} }
// //
// Open the file // Empty the file contents.
// //
Status = RootDir->Open ( FileInfo = ShellProtocol->GetFileInfo (Handle);
RootDir, if (FileInfo == NULL) {
&Handle, ShellProtocol->CloseFile (Handle);
FileName, return EFI_DEVICE_ERROR;
EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE| EFI_FILE_MODE_CREATE,
0
);
if (EFI_ERROR (Status)) {
RootDir->Close (RootDir);
return Status;
} }
// //
// Delete file // If the file size is already 0, then it has been empty.
// //
Status = Handle->Delete(Handle); if (FileInfo->FileSize != 0) {
if (EFI_ERROR(Status)) { //
return Status; // Set the file size to 0.
//
FileInfo->FileSize = 0;
Status = ShellProtocol->SetFileInfo (Handle, FileInfo);
if (EFI_ERROR (Status)) {
FreePool (FileInfo);
ShellProtocol->CloseFile (Handle);
return Status;
}
} }
FreePool (FileInfo);
//
// Open the file again
//
Status = RootDir->Open (
RootDir,
&Handle,
FileName,
EFI_FILE_MODE_READ | EFI_FILE_MODE_WRITE| EFI_FILE_MODE_CREATE,
0
);
if (EFI_ERROR (Status)) {
RootDir->Close (RootDir);
return Status;
}
RootDir->Close (RootDir);
// //
// Write the file data from the buffer // Write the file data from the buffer
// //
TempBufferSize = BufferSize; TempBufferSize = BufferSize;
Status = Handle->Write ( Status = ShellProtocol->WriteFile (
Handle, Handle,
&TempBufferSize, &TempBufferSize,
Buffer Buffer
); );
if (EFI_ERROR (Status)) { if (EFI_ERROR (Status)) {
Handle->Close (Handle); ShellProtocol->CloseFile (Handle);
return Status; return Status;
} }
Handle->Close (Handle); ShellProtocol->CloseFile (Handle);
return EFI_SUCCESS; return EFI_SUCCESS;
} }

View File

@ -21,11 +21,7 @@
#include <Library/UefiRuntimeServicesTableLib.h> #include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/UefiLib.h> #include <Library/UefiLib.h>
#include <Library/PrintLib.h> #include <Library/PrintLib.h>
#include <Protocol/LoadedImage.h>
#include <Protocol/SimpleFileSystem.h>
#include <Protocol/GraphicsOutput.h> #include <Protocol/GraphicsOutput.h>
#include <Guid/FileInfo.h>
#include <Guid/Gpt.h>
#include <Guid/GlobalVariable.h> #include <Guid/GlobalVariable.h>
#include <Guid/CapsuleReport.h> #include <Guid/CapsuleReport.h>
#include <Guid/SystemResourceTable.h> #include <Guid/SystemResourceTable.h>
@ -117,7 +113,8 @@ DumpEsrtData (
@param[out] Buffer The file buffer @param[out] Buffer The file buffer
@retval EFI_SUCCESS Read file successfully @retval EFI_SUCCESS Read file successfully
@retval EFI_NOT_FOUND File not found @retval EFI_NOT_FOUND Shell protocol or file not found
@retval others Read file failed
**/ **/
EFI_STATUS EFI_STATUS
ReadFileToBuffer ( ReadFileToBuffer (
@ -134,6 +131,8 @@ ReadFileToBuffer (
@param[in] Buffer The file buffer @param[in] Buffer The file buffer
@retval EFI_SUCCESS Write file successfully @retval EFI_SUCCESS Write file successfully
@retval EFI_NOT_FOUND Shell protocol not found
@retval others Write file failed
**/ **/
EFI_STATUS EFI_STATUS
WriteFileFromBuffer ( WriteFileFromBuffer (

View File

@ -4,7 +4,7 @@
# This application can trigger capsule update process. It can also # This application can trigger capsule update process. It can also
# generate capsule image, or dump capsule variable information. # generate capsule image, or dump capsule variable information.
# #
# Copyright (c) 2016, Intel Corporation. All rights reserved.<BR> # Copyright (c) 2016 - 2017, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials # This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License # 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 # which accompanies this distribution. The full text of the license may be found at
@ -40,8 +40,6 @@
MdeModulePkg/MdeModulePkg.dec MdeModulePkg/MdeModulePkg.dec
[Guids] [Guids]
gEfiFileInfoGuid ## CONSUMES ## GUID
gEfiPartTypeSystemPartGuid ## CONSUMES ## GUID
gEfiGlobalVariableGuid ## CONSUMES ## GUID gEfiGlobalVariableGuid ## CONSUMES ## GUID
gEfiCapsuleReportGuid ## CONSUMES ## GUID gEfiCapsuleReportGuid ## CONSUMES ## GUID
gEfiFmpCapsuleGuid ## CONSUMES ## GUID gEfiFmpCapsuleGuid ## CONSUMES ## GUID
@ -51,11 +49,10 @@
gEfiSystemResourceTableGuid ## CONSUMES ## GUID gEfiSystemResourceTableGuid ## CONSUMES ## GUID
[Protocols] [Protocols]
gEfiLoadedImageProtocolGuid ## CONSUMES
gEfiSimpleFileSystemProtocolGuid ## CONSUMES
gEfiGraphicsOutputProtocolGuid ## CONSUMES gEfiGraphicsOutputProtocolGuid ## CONSUMES
gEfiFirmwareManagementProtocolGuid ## CONSUMES gEfiFirmwareManagementProtocolGuid ## CONSUMES
gEfiShellParametersProtocolGuid ## CONSUMES gEfiShellParametersProtocolGuid ## CONSUMES
gEfiShellProtocolGuid ## CONSUMES
[LibraryClasses] [LibraryClasses]
BaseLib BaseLib