/** @file\r
A shell application that triggers capsule update process.\r
\r
- Copyright (c) 2016 - 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
+ Copyright (c) 2016 - 2019, Intel Corporation. All rights reserved.<BR>\r
+ SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
-#include <Uefi.h>\r
-#include <Library/BaseLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
-#include <Library/MemoryAllocationLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-#include <Library/UefiRuntimeServicesTableLib.h>\r
-#include <Library/UefiLib.h>\r
-#include <Library/PrintLib.h>\r
-#include <Library/BmpSupportLib.h>\r
-#include <Protocol/GraphicsOutput.h>\r
-#include <Guid/GlobalVariable.h>\r
-#include <Guid/CapsuleReport.h>\r
-#include <Guid/SystemResourceTable.h>\r
-#include <Guid/FmpCapsule.h>\r
-#include <IndustryStandard/WindowsUxCapsule.h>\r
-\r
-#define CAPSULE_HEADER_SIZE 0x20\r
-\r
-#define NESTED_CAPSULE_HEADER_SIZE SIZE_4KB\r
-#define SYSTEM_FIRMWARE_FLAG 0x50000\r
-#define DEVICE_FIRMWARE_FLAG 0x78010\r
-\r
-#define MAJOR_VERSION 1\r
-#define MINOR_VERSION 0\r
-\r
-#define MAX_CAPSULE_NUM 10\r
-\r
-extern UINTN Argc;\r
-extern CHAR16 **Argv;\r
+#include "CapsuleApp.h"\r
\r
//\r
// Define how many block descriptors we want to test with.\r
UINTN CapsuleFirstIndex;\r
UINTN CapsuleLastIndex;\r
\r
-/**\r
- Dump capsule information\r
-\r
- @param[in] CapsuleName The name of the capsule image.\r
-\r
- @retval EFI_SUCCESS The capsule information is dumped.\r
- @retval EFI_UNSUPPORTED Input parameter is not valid.\r
-**/\r
-EFI_STATUS\r
-DumpCapsule (\r
- IN CHAR16 *CapsuleName\r
- );\r
-\r
-/**\r
- Dump capsule status variable.\r
-\r
- @retval EFI_SUCCESS The capsule status variable is dumped.\r
- @retval EFI_UNSUPPORTED Input parameter is not valid.\r
-**/\r
-EFI_STATUS\r
-DmpCapsuleStatusVariable (\r
- VOID\r
- );\r
-\r
-/**\r
- Dump FMP protocol info.\r
-**/\r
-VOID\r
-DumpFmpData (\r
- VOID\r
- );\r
-\r
-/**\r
- Dump FMP image data.\r
-\r
- @param[in] ImageTypeId The ImageTypeId of the FMP image.\r
- It is used to identify the FMP protocol.\r
- @param[in] ImageIndex The ImageIndex of the FMP image.\r
- It is the input parameter for FMP->GetImage().\r
- @param[in] ImageName The file name to hold the output FMP image.\r
-**/\r
-VOID\r
-DumpFmpImage (\r
- IN EFI_GUID *ImageTypeId,\r
- IN UINTN ImageIndex,\r
- IN CHAR16 *ImageName\r
- );\r
-\r
-/**\r
- Dump ESRT info.\r
-**/\r
-VOID\r
-DumpEsrtData (\r
- VOID\r
- );\r
-\r
-/**\r
- Read a file.\r
-\r
- @param[in] FileName The file to be read.\r
- @param[out] BufferSize The file buffer size\r
- @param[out] Buffer The file buffer\r
-\r
- @retval EFI_SUCCESS Read file successfully\r
- @retval EFI_NOT_FOUND Shell protocol or file not found\r
- @retval others Read file failed\r
-**/\r
-EFI_STATUS\r
-ReadFileToBuffer (\r
- IN CHAR16 *FileName,\r
- OUT UINTN *BufferSize,\r
- OUT VOID **Buffer\r
- );\r
-\r
-/**\r
- Write a file.\r
-\r
- @param[in] FileName The file to be written.\r
- @param[in] BufferSize The file buffer size\r
- @param[in] Buffer The file buffer\r
-\r
- @retval EFI_SUCCESS Write file successfully\r
- @retval EFI_NOT_FOUND Shell protocol not found\r
- @retval others Write file failed\r
-**/\r
-EFI_STATUS\r
-WriteFileFromBuffer (\r
- IN CHAR16 *FileName,\r
- IN UINTN BufferSize,\r
- IN VOID *Buffer\r
- );\r
-\r
-/**\r
-\r
- This function parse application ARG.\r
-\r
- @return Status\r
-**/\r
-EFI_STATUS\r
-GetArg (\r
- VOID\r
- );\r
-\r
/**\r
Create UX capsule.\r
\r
return ESRT_FW_TYPE_UNKNOWN;\r
}\r
\r
+/**\r
+ Validate if it is valid capsule header\r
+\r
+ This function assumes the caller provided correct CapsuleHeader pointer\r
+ and CapsuleSize.\r
+\r
+ This function validates the fields in EFI_CAPSULE_HEADER.\r
+\r
+ @param[in] CapsuleHeader Points to a capsule header.\r
+ @param[in] CapsuleSize Size of the whole capsule image.\r
+\r
+**/\r
+BOOLEAN\r
+IsValidCapsuleHeader (\r
+ IN EFI_CAPSULE_HEADER *CapsuleHeader,\r
+ IN UINT64 CapsuleSize\r
+ )\r
+{\r
+ if (CapsuleSize < sizeof (EFI_CAPSULE_HEADER)) {\r
+ return FALSE;\r
+ }\r
+ if (CapsuleHeader->CapsuleImageSize != CapsuleSize) {\r
+ return FALSE;\r
+ }\r
+ if (CapsuleHeader->HeaderSize > CapsuleHeader->CapsuleImageSize) {\r
+ return FALSE;\r
+ }\r
+ if (CapsuleHeader->HeaderSize < sizeof (EFI_CAPSULE_HEADER)) {\r
+ return FALSE;\r
+ }\r
+\r
+ return TRUE;\r
+}\r
+\r
+/**\r
+ Return if this CapsuleGuid is a FMP capsule GUID or not.\r
+\r
+ @param[in] CapsuleGuid A pointer to EFI_GUID\r
+\r
+ @retval TRUE It is a FMP capsule GUID.\r
+ @retval FALSE It is not a FMP capsule GUID.\r
+**/\r
+BOOLEAN\r
+IsFmpCapsuleGuid (\r
+ IN EFI_GUID *CapsuleGuid\r
+ )\r
+{\r
+ if (CompareGuid(&gEfiFmpCapsuleGuid, CapsuleGuid)) {\r
+ return TRUE;\r
+ }\r
+\r
+ return FALSE;\r
+}\r
+\r
/**\r
Append a capsule header on top of current image.\r
This function follows Windows UEFI Firmware Update Platform document.\r
Print(L"CapsuleApp: Capsule image (%s) is not found.\n", CapsuleName);\r
goto Done;\r
}\r
+ if (!IsValidCapsuleHeader (CapsuleBuffer, FileSize)) {\r
+ Print(L"CapsuleApp: Capsule image (%s) is not a valid capsule.\n", CapsuleName);\r
+ Status = EFI_INVALID_PARAMETER;\r
+ goto Done;\r
+ }\r
+\r
+ if (!IsFmpCapsuleGuid (&((EFI_CAPSULE_HEADER *) CapsuleBuffer)->CapsuleGuid)) {\r
+ Print(L"CapsuleApp: Capsule image (%s) is not a FMP capsule.\n", CapsuleName);\r
+ Status = EFI_INVALID_PARAMETER;\r
+ goto Done;\r
+ }\r
\r
ImageTypeId = GetCapsuleImageTypeId(CapsuleBuffer);\r
if (ImageTypeId == NULL) {\r
Print(L"CapsuleApp: Capsule ImageTypeId is not found.\n");\r
+ Status = EFI_INVALID_PARAMETER;\r
goto Done;\r
}\r
FwType = GetEsrtFwType(ImageTypeId);\r
if ((FwType != ESRT_FW_TYPE_SYSTEMFIRMWARE) && (FwType != ESRT_FW_TYPE_DEVICEFIRMWARE)) {\r
Print(L"CapsuleApp: Capsule FwType is invalid.\n");\r
+ Status = EFI_INVALID_PARAMETER;\r
goto Done;\r
}\r
\r
UINT32 Index;\r
CHAR16 CapsuleVarName[20];\r
CHAR16 *TempVarName;\r
+ BOOLEAN Found;\r
\r
StrCpyS (CapsuleVarName, sizeof(CapsuleVarName)/sizeof(CapsuleVarName[0]), L"Capsule");\r
TempVarName = CapsuleVarName + StrLen (CapsuleVarName);\r
Index = 0;\r
\r
+ Found = FALSE;\r
while (TRUE) {\r
UnicodeSPrint (TempVarName, 5 * sizeof(CHAR16), L"%04x", Index);\r
\r
0,\r
(VOID *)NULL\r
);\r
- if (EFI_ERROR(Status)) {\r
+ if (Status == EFI_NOT_FOUND) {\r
//\r
- // There is no capsule variables, quit\r
+ // There is no more capsule variables, quit\r
//\r
break;\r
}\r
+ Found = TRUE;\r
+\r
+ Print (L"Clear %s %r\n", CapsuleVarName, Status);\r
\r
Index++;\r
if (Index > 0xFFFF) {\r
}\r
}\r
\r
+ if (!Found) {\r
+ Print (L"No any Capsule#### variable found\n");\r
+ }\r
+\r
return EFI_SUCCESS;\r
}\r
\r
}\r
\r
//\r
- // Record descirptor header\r
+ // Record descriptor header\r
//\r
if (Index == 0) {\r
BlockDescriptorsHeader = BlockDescriptors1;\r
}\r
}\r
\r
-/**\r
- Validate if it is valid capsule header\r
-\r
- This function assumes the caller provided correct CapsuleHeader pointer\r
- and CapsuleSize.\r
-\r
- This function validates the fields in EFI_CAPSULE_HEADER.\r
-\r
- @param[in] CapsuleHeader Points to a capsule header.\r
- @param[in] CapsuleSize Size of the whole capsule image.\r
-\r
-**/\r
-BOOLEAN\r
-IsValidCapsuleHeader (\r
- IN EFI_CAPSULE_HEADER *CapsuleHeader,\r
- IN UINT64 CapsuleSize\r
- )\r
-{\r
- if (CapsuleSize < sizeof (EFI_CAPSULE_HEADER)) {\r
- return FALSE;\r
- }\r
- if (CapsuleHeader->CapsuleImageSize != CapsuleSize) {\r
- return FALSE;\r
- }\r
- if (CapsuleHeader->HeaderSize > CapsuleHeader->CapsuleImageSize) {\r
- return FALSE;\r
- }\r
- if (CapsuleHeader->HeaderSize < sizeof (EFI_CAPSULE_HEADER)) {\r
- return FALSE;\r
- }\r
-\r
- return TRUE;\r
-}\r
-\r
/**\r
Print APP usage.\r
**/\r
)\r
{\r
Print(L"CapsuleApp: usage\n");\r
- Print(L" CapsuleApp <Capsule...> [-NR]\n");\r
+ Print(L" CapsuleApp <Capsule...> [-NR] [-OD [FSx]]\n");\r
Print(L" CapsuleApp -S\n");\r
Print(L" CapsuleApp -C\n");\r
Print(L" CapsuleApp -P\n");\r
Print(L" CapsuleApp -E\n");\r
+ Print(L" CapsuleApp -L\n");\r
+ Print(L" CapsuleApp -L INFO\n");\r
+ Print(L" CapsuleApp -F\n");\r
Print(L" CapsuleApp -G <BMP> -O <Capsule>\n");\r
Print(L" CapsuleApp -N <Capsule> -O <NestedCapsule>\n");\r
Print(L" CapsuleApp -D <Capsule>\n");\r
Print(L" CapsuleApp -P GET <ImageTypeId> <Index> -O <FileName>\n");\r
Print(L"Parameter:\n");\r
- Print(L" -NR: No reset will be triggered for the capsule with\n");\r
- Print(L" CAPSULE_FLAGS_PERSIST_ACROSS_RESET and without\n");\r
- Print(L" CAPSULE_FLAGS_INITIATE_RESET.\n");\r
+ Print(L" -NR: No reset will be triggered for the capsule\n");\r
+ Print(L" with CAPSULE_FLAGS_PERSIST_ACROSS_RESET and without CAPSULE_FLAGS_INITIATE_RESET.\n");\r
+ Print(L" -OD: Delivery of Capsules via file on Mass Storage device.\n");\r
Print(L" -S: Dump capsule report variable (EFI_CAPSULE_REPORT_GUID),\n");\r
Print(L" which is defined in UEFI specification.\n");\r
Print(L" -C: Clear capsule report variable (EFI_CAPSULE_REPORT_GUID),\n");\r
Print(L" ImageTypeId and Index (decimal format) to a file if 'GET'\n");\r
Print(L" option is used.\n");\r
Print(L" -E: Dump UEFI ESRT table info.\n");\r
+ Print(L" -L: Dump provisioned capsule image information.\n");\r
+ Print(L" -F: Dump all EFI System Partition.\n");\r
Print(L" -G: Convert a BMP file to be an UX capsule,\n");\r
Print(L" according to Windows Firmware Update document\n");\r
Print(L" -N: Append a Capsule Header to an existing FMP capsule image\n");\r
{\r
EFI_STATUS Status;\r
RETURN_STATUS RStatus;\r
- UINTN FileSize[MAX_CAPSULE_NUM];\r
+ UINTN CapsuleBufferSize[MAX_CAPSULE_NUM];\r
VOID *CapsuleBuffer[MAX_CAPSULE_NUM];\r
EFI_CAPSULE_BLOCK_DESCRIPTOR *BlockDescriptors;\r
EFI_CAPSULE_HEADER *CapsuleHeaderArray[MAX_CAPSULE_NUM + 1];\r
EFI_RESET_TYPE ResetType;\r
BOOLEAN NeedReset;\r
BOOLEAN NoReset;\r
+ BOOLEAN CapsuleOnDisk;\r
CHAR16 *CapsuleName;\r
+ CHAR16 *CapsuleNames[MAX_CAPSULE_NUM];\r
+ CHAR16 *MapFsStr;\r
UINTN CapsuleNum;\r
UINTN Index;\r
+ UINTN ParaOdIndex;\r
+ UINTN ParaNrIndex;\r
EFI_GUID ImageTypeId;\r
UINTN ImageIndex;\r
\r
+ BlockDescriptors = NULL;\r
+ MapFsStr = NULL;\r
+ CapsuleNum = 0;\r
+\r
Status = GetArg();\r
if (EFI_ERROR(Status)) {\r
Print(L"Please use UEFI SHELL to run this application!\n", Status);\r
return Status;\r
}\r
if (StrCmp(Argv[1], L"-S") == 0) {\r
- Status = DmpCapsuleStatusVariable();\r
+ Status = DumpCapsuleStatusVariable();\r
return EFI_SUCCESS;\r
}\r
if (StrCmp(Argv[1], L"-C") == 0) {\r
return EFI_SUCCESS;\r
}\r
\r
+ if (StrCmp(Argv[1], L"-L") == 0) {\r
+ if (Argc >= 3 && StrCmp(Argv[2], L"INFO") == 0) {\r
+ DumpProvisionedCapsule(TRUE);\r
+ } else {\r
+ DumpProvisionedCapsule(FALSE);\r
+ }\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ if (StrCmp(Argv[1], L"-F") == 0) {\r
+ DumpAllEfiSysPartition();\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
if (Argv[1][0] == L'-') {\r
Print(L"CapsuleApp: Unrecognized option(%s).\n", Argv[1]);\r
return EFI_UNSUPPORTED;\r
\r
CapsuleFirstIndex = 1;\r
NoReset = FALSE;\r
- if ((Argc > 1) && (StrCmp(Argv[Argc - 1], L"-NR") == 0)) {\r
- NoReset = TRUE;\r
- CapsuleLastIndex = Argc - 2;\r
+ CapsuleOnDisk = FALSE;\r
+ ParaOdIndex = 0;\r
+ ParaNrIndex = 0;\r
+\r
+ for (Index = 1; Index < Argc; Index++) {\r
+ if (StrCmp(Argv[Index], L"-OD") == 0) {\r
+ ParaOdIndex = Index;\r
+ CapsuleOnDisk = TRUE;\r
+ } else if (StrCmp(Argv[Index], L"-NR") == 0) {\r
+ ParaNrIndex = Index;\r
+ NoReset = TRUE;\r
+ }\r
+ }\r
+\r
+ if (ParaOdIndex > ParaNrIndex) {\r
+ if (ParaNrIndex != 0) {\r
+ CapsuleLastIndex = ParaNrIndex - 1;\r
+ } else {\r
+ CapsuleLastIndex = ParaOdIndex - 1;\r
+ }\r
+\r
+ if (ParaOdIndex == Argc -1) {\r
+ MapFsStr = NULL;\r
+ } else if (ParaOdIndex == Argc - 2) {\r
+ MapFsStr = Argv[Argc-1];\r
+ } else {\r
+ Print (L"CapsuleApp: Cannot specify more than one FS mapping!\n");\r
+ Status = EFI_INVALID_PARAMETER;\r
+ goto Done;\r
+ }\r
+ } else if (ParaOdIndex < ParaNrIndex) {\r
+ if (ParaOdIndex != 0) {\r
+ CapsuleLastIndex = ParaOdIndex - 1;\r
+ if (ParaOdIndex == ParaNrIndex - 1) {\r
+ MapFsStr = NULL;\r
+ } else if (ParaOdIndex == ParaNrIndex - 2) {\r
+ MapFsStr = Argv[ParaOdIndex + 1];\r
+ } else {\r
+ Print (L"CapsuleApp: Cannot specify more than one FS mapping!\n");\r
+ Status = EFI_INVALID_PARAMETER;\r
+ goto Done;\r
+ }\r
+ } else {\r
+ CapsuleLastIndex = ParaNrIndex - 1;\r
+ }\r
} else {\r
CapsuleLastIndex = Argc - 1;\r
}\r
+\r
CapsuleNum = CapsuleLastIndex - CapsuleFirstIndex + 1;\r
\r
if (CapsuleFirstIndex > CapsuleLastIndex) {\r
}\r
\r
ZeroMem(&CapsuleBuffer, sizeof(CapsuleBuffer));\r
- ZeroMem(&FileSize, sizeof(FileSize));\r
+ ZeroMem(&CapsuleBufferSize, sizeof(CapsuleBufferSize));\r
BlockDescriptors = NULL;\r
\r
for (Index = 0; Index < CapsuleNum; Index++) {\r
CapsuleName = Argv[CapsuleFirstIndex + Index];\r
- Status = ReadFileToBuffer(CapsuleName, &FileSize[Index], &CapsuleBuffer[Index]);\r
+ Status = ReadFileToBuffer(CapsuleName, &CapsuleBufferSize[Index], &CapsuleBuffer[Index]);\r
if (EFI_ERROR(Status)) {\r
Print(L"CapsuleApp: capsule image (%s) is not found.\n", CapsuleName);\r
goto Done;\r
}\r
- if (!IsValidCapsuleHeader (CapsuleBuffer[Index], FileSize[Index])) {\r
+ if (!IsValidCapsuleHeader (CapsuleBuffer[Index], CapsuleBufferSize[Index])) {\r
Print(L"CapsuleApp: Capsule image (%s) is not a valid capsule.\n", CapsuleName);\r
return EFI_INVALID_PARAMETER;\r
}\r
+ CapsuleNames[Index] = CapsuleName;\r
}\r
\r
//\r
// Every capsule use 2 descriptor 1 for data 1 for end\r
//\r
- Status = BuildGatherList(CapsuleBuffer, FileSize, CapsuleNum, &BlockDescriptors);\r
+ Status = BuildGatherList(CapsuleBuffer, CapsuleBufferSize, CapsuleNum, &BlockDescriptors);\r
if (EFI_ERROR(Status)) {\r
goto Done;\r
}\r
}\r
\r
for (Index = 0; Index < CapsuleNum; Index++) {\r
- if (FileSize[Index] > MaxCapsuleSize) {\r
+ if (CapsuleBufferSize[Index] > MaxCapsuleSize) {\r
Print (L"CapsuleApp: capsule is too large to update, %ld is allowed\n", MaxCapsuleSize);\r
Status = EFI_UNSUPPORTED;\r
goto Done;\r
}\r
}\r
\r
+ //\r
+ // Check whether is capsule on disk.\r
+ //\r
+ if (CapsuleOnDisk) {\r
+ Status = ProcessCapsuleOnDisk (CapsuleBuffer, CapsuleBufferSize, CapsuleNames, MapFsStr, CapsuleNum);\r
+ if (Status != EFI_SUCCESS) {\r
+ Print (L"CapsuleApp: failed to update capsule - %r\n", Status);\r
+ goto Done;\r
+ } else {\r
+ if (!NoReset) {\r
+ gRT->ResetSystem (ResetType, EFI_SUCCESS, 0, NULL);\r
+ } else {\r
+ goto Done;\r
+ }\r
+ }\r
+ }\r
+\r
//\r
// Check whether the input capsule image has the flag of persist across system reset.\r
//\r
projects / mirror_edk2.git / blobdiff