--- /dev/null
+#/** @file\r
+# Component description file for Capsule module.\r
+#\r
+# CapsuleRuntime module provides capsule runtime services\r
+# Copyright (c) 2006 - 2007, Intel Corporation\r
+#\r
+# All rights reserved. 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
+# 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
+\r
+################################################################################\r
+#\r
+# Defines Section - statements that will be processed to create a Makefile.\r
+#\r
+################################################################################\r
+[Defines]\r
+ INF_VERSION = 0x00010005\r
+ BASE_NAME = CapsuleRuntimeDxe\r
+ FILE_GUID = 42857F0A-13F2-4B21-8A23-53D3F714B840\r
+ MODULE_TYPE = DXE_RUNTIME_DRIVER\r
+ VERSION_STRING = 1.0\r
+ EDK_RELEASE_VERSION = 0x00020000\r
+ EFI_SPECIFICATION_VERSION = 0x00020000\r
+\r
+ ENTRY_POINT = CapsuleServiceInitialize\r
+\r
+#\r
+# The following information is for reference only and not required by the build tools.\r
+#\r
+# VALID_ARCHITECTURES = IA32 X64 IPF EBC\r
+#\r
+\r
+################################################################################\r
+#\r
+# Sources Section - list of files that are required for the build to succeed.\r
+#\r
+################################################################################\r
+\r
+[Sources.common]\r
+ CapsuleService.h\r
+ CapsuleService.c\r
+\r
+[Packages]\r
+ MdePkg/MdePkg.dec\r
+\r
+[LibraryClasses]\r
+ UefiBootServicesTableLib\r
+ MemoryAllocationLib\r
+ BaseMemoryLib\r
+ PcdLib\r
+ DebugLib\r
+ UefiRuntimeLib\r
+ DxeServicesTableLib\r
+ UefiDriverEntryPoint\r
+\r
+[Guids]\r
+ gEfiCapsuleVendorGuid # SOMETIMES_CONSUMED\r
+\r
+[Protocols]\r
+ gEfiCapsuleArchProtocolGuid # PROTOCOL ALWAYS_CONSUMED\r
+\r
+[PcdsFeatureFlag.common]\r
+ PcdSupportUpdateCapsuleRest|gEfiMdeModulePkgTokenSpaceGuid\r
+\r
+[PcdsFixedAtBuild.common]\r
+ PcdMaxSizeNonPopulateCapsule|gEfiMdeModulePkgTokenSpaceGuid\r
+ PcdMaxSizePopulateCapsule|gEfiMdeModulePkgTokenSpaceGuid\r
+\r
+[Depex]\r
+ gEfiVariableArchProtocolGuid\r
--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>\r
+<ModuleSurfaceArea xmlns="http://www.TianoCore.org/2006/Edk2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">\r
+ <MsaHeader>\r
+ <ModuleName>CapsuleRuntime</ModuleName>\r
+ <ModuleType>DXE_RUNTIME_DRIVER</ModuleType>\r
+ <GuidValue>42857F0A-13F2-4B21-8A23-53D3F714B840</GuidValue>\r
+ <Version>1.0</Version>\r
+ <Abstract>Component description file for Capsule module.</Abstract>\r
+ <Description>CapsuleRuntime module provides capsule runtime services</Description>\r
+ <Copyright>Copyright (c) 2006 - 2007, Intel Corporation</Copyright>\r
+ <License>All rights reserved. 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
+ 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.</License>\r
+ <Specification>FRAMEWORK_BUILD_PACKAGING_SPECIFICATION 0x00000052</Specification>\r
+ </MsaHeader>\r
+ <ModuleDefinitions>\r
+ <SupportedArchitectures>IA32 X64 IPF EBC</SupportedArchitectures>\r
+ <BinaryModule>false</BinaryModule>\r
+ <OutputFileBasename>CapsuleRuntime</OutputFileBasename>\r
+ </ModuleDefinitions>\r
+ <LibraryClassDefinitions>\r
+ <LibraryClass Usage="ALWAYS_CONSUMED">\r
+ <Keyword>UefiDriverEntryPoint</Keyword>\r
+ </LibraryClass>\r
+ <LibraryClass Usage="ALWAYS_CONSUMED">\r
+ <Keyword>DxeServicesTableLib</Keyword>\r
+ </LibraryClass>\r
+ <LibraryClass Usage="ALWAYS_CONSUMED">\r
+ <Keyword>UefiRuntimeLib</Keyword>\r
+ </LibraryClass>\r
+ <LibraryClass Usage="ALWAYS_CONSUMED">\r
+ <Keyword>DebugLib</Keyword>\r
+ </LibraryClass>\r
+ <LibraryClass Usage="ALWAYS_CONSUMED">\r
+ <Keyword>PcdLib</Keyword>\r
+ </LibraryClass>\r
+ <LibraryClass Usage="ALWAYS_CONSUMED">\r
+ <Keyword>BaseMemoryLib</Keyword>\r
+ </LibraryClass>\r
+ <LibraryClass Usage="ALWAYS_CONSUMED">\r
+ <Keyword>MemoryAllocationLib</Keyword>\r
+ </LibraryClass>\r
+ <LibraryClass Usage="ALWAYS_CONSUMED">\r
+ <Keyword>UefiBootServicesTableLib</Keyword>\r
+ </LibraryClass>\r
+ </LibraryClassDefinitions>\r
+ <SourceFiles>\r
+ <Filename>Capsule.c</Filename>\r
+ <Filename>CapsuleService.c</Filename>\r
+ <Filename>CapsuleService.h</Filename>\r
+ <Filename>Capsule.dxs</Filename>\r
+ </SourceFiles>\r
+ <PackageDependencies>\r
+ <Package PackageGuid="1E73767F-8F52-4603-AEB4-F29B510B6766"/>\r
+ <Package PackageGuid="2759ded5-bb57-4b06-af4f-c398fa552719"/>\r
+ <Package PackageGuid="BA0D78D6-2CAF-414b-BD4D-B6762A894288"/>\r
+ </PackageDependencies>\r
+ <Protocols>\r
+ <Protocol Usage="ALWAYS_CONSUMED">\r
+ <ProtocolCName>gEfiCapsuleArchProtocolGuid</ProtocolCName>\r
+ </Protocol>\r
+ </Protocols>\r
+ <Guids>\r
+ <GuidCNames Usage="SOMETIMES_CONSUMED">\r
+ <GuidCName>gEfiCapsuleVendorGuid</GuidCName>\r
+ </GuidCNames>\r
+ </Guids>\r
+ <Externs>\r
+ <Specification>EFI_SPECIFICATION_VERSION 0x00020000</Specification>\r
+ <Specification>EDK_RELEASE_VERSION 0x00020000</Specification>\r
+ <Extern>\r
+ <ModuleEntryPoint>CapsuleServiceInitialize</ModuleEntryPoint>\r
+ </Extern>\r
+ </Externs>\r
+ <PcdCoded>\r
+ <PcdEntry PcdItemType="FEATURE_FLAG">\r
+ <C_Name>PcdSupportUpdateCapsuleRest</C_Name>\r
+ <TokenSpaceGuidCName>gEfiEdkModulePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
+ <HelpText>Indicate whether platform can support update capsule across a system reset</HelpText>\r
+ </PcdEntry>\r
+ <PcdEntry PcdItemType="FIXED_AT_BUILD">\r
+ <C_Name>PcdMaxSizePopulateCapsule</C_Name>\r
+ <TokenSpaceGuidCName>gEfiEdkModulePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
+ <HelpText>Indicate the max size the platform can support in case of populated capsules</HelpText>\r
+ </PcdEntry>\r
+ <PcdEntry PcdItemType="FIXED_AT_BUILD">\r
+ <C_Name>PcdMaxSizeNonPopulateCapsule</C_Name>\r
+ <TokenSpaceGuidCName>gEfiEdkModulePkgTokenSpaceGuid</TokenSpaceGuidCName>\r
+ <HelpText>Indicate the max size the platform can support in case of non-populated capsules</HelpText>\r
+ </PcdEntry>\r
+ </PcdCoded>\r
+</ModuleSurfaceArea>\r
--- /dev/null
+/*++\r
+\r
+Copyright (c) 2006 - 2007, Intel Corporation\r
+All rights reserved. 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
+Module Name:\r
+\r
+ CapsuleService.c\r
+\r
+Abstract:\r
+\r
+ Capsule Runtime Service.\r
+\r
+--*/\r
+\r
+#include "CapsuleService.h"\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+UpdateCapsule (\r
+ IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
+ IN UINTN CapsuleCount,\r
+ IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL\r
+ )\r
+/*++\r
+\r
+Routine Description:\r
+\r
+ This code finds whether the capsules need reset to update, if not, update immediately.\r
+\r
+Arguments:\r
+\r
+ CapsuleHeaderArray A array of pointers to capsule headers passed in\r
+ CapsuleCount The number of capsule\r
+ ScatterGatherList Physical address of datablock list points to capsule\r
+\r
+Returns:\r
+\r
+ EFI STATUS\r
+ EFI_SUCCESS Valid capsule was passed.If CAPSULE_FLAG_PERSIT_ACROSS_RESET is\r
+ not set, the capsule has been successfully processed by the firmware.\r
+ If it set, the ScattlerGatherList is successfully to be set.\r
+ EFI_INVALID_PARAMETER CapsuleCount is less than 1,CapsuleGuid is not supported.\r
+ EFI_DEVICE_ERROR Failed to SetVariable or AllocatePool or ProcessFirmwareVolume.\r
+\r
+--*/\r
+{\r
+ UINTN CapsuleSize;\r
+ UINTN ArrayNumber;\r
+ VOID *BufferPtr;\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE FvHandle;\r
+ EFI_CAPSULE_HEADER *CapsuleHeader;\r
+\r
+ if (CapsuleCount < 1) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ BufferPtr = NULL;\r
+ CapsuleHeader = NULL;\r
+\r
+ for (ArrayNumber = 0; ArrayNumber < CapsuleCount; ArrayNumber++) {\r
+ CapsuleHeader = CapsuleHeaderArray[ArrayNumber];\r
+ if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE)) == CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ if ((CapsuleHeader->Flags & CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) == 0) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ }\r
+\r
+ //\r
+ //Assume that capsules have the same flags on reseting or not.\r
+ //\r
+ CapsuleHeader = CapsuleHeaderArray[0];\r
+\r
+ if ((CapsuleHeader->Flags & CAPSULE_FLAGS_PERSIST_ACROSS_RESET) != 0) {\r
+ //\r
+ //Check if the platform supports update capsule across a system reset\r
+ //\r
+ if (!FeaturePcdGet(PcdSupportUpdateCapsuleRest)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+\r
+ if (ScatterGatherList == 0) {\r
+ return EFI_INVALID_PARAMETER;\r
+ } else {\r
+ Status = EfiSetVariable (\r
+ EFI_CAPSULE_VARIABLE_NAME,\r
+ &gEfiCapsuleVendorGuid,\r
+ EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS,\r
+ sizeof (UINTN),\r
+ (VOID *) &ScatterGatherList\r
+ );\r
+ if (Status != EFI_SUCCESS) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+ }\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ //\r
+ //The rest occurs in the condition of non-reset mode\r
+ //\r
+ if (EfiAtRuntime ()) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ //\r
+ //Here should be in the boot-time\r
+ //\r
+ for (ArrayNumber = 0; ArrayNumber < CapsuleCount ; ArrayNumber++) {\r
+ CapsuleHeader = CapsuleHeaderArray[ArrayNumber];\r
+ CapsuleSize = CapsuleHeader->CapsuleImageSize - CapsuleHeader->HeaderSize;\r
+\r
+ BufferPtr = AllocatePool (CapsuleSize);\r
+ if (BufferPtr == NULL) {\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+\r
+ CopyMem (BufferPtr, (UINT8*)CapsuleHeader+ CapsuleHeader->HeaderSize, CapsuleSize);\r
+\r
+ //\r
+ //Call DXE service ProcessFirmwareVolume to process immediatelly\r
+ //\r
+ Status = gDS->ProcessFirmwareVolume (BufferPtr, CapsuleSize, &FvHandle);\r
+ if (Status != EFI_SUCCESS) {\r
+ FreePool (BufferPtr);\r
+ return EFI_DEVICE_ERROR;\r
+ }\r
+ gDS->Dispatch ();\r
+ FreePool (BufferPtr);\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+QueryCapsuleCapabilities (\r
+ IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
+ IN UINTN CapsuleCount,\r
+ OUT UINT64 *MaxiumCapsuleSize,\r
+ OUT EFI_RESET_TYPE *ResetType\r
+ )\r
+/*++\r
+\r
+Routine Description:\r
+\r
+ This code is to query about capsule capability.\r
+\r
+Arguments:\r
+\r
+ CapsuleHeaderArray A array of pointers to capsule headers passed in\r
+ CapsuleCount The number of capsule\r
+ MaxiumCapsuleSize Max capsule size is supported\r
+ ResetType Reset type the capsule indicates, if reset is not needed,return EfiResetCold.\r
+ If reset is needed, return EfiResetWarm.\r
+\r
+Returns:\r
+\r
+ EFI STATUS\r
+ EFI_SUCCESS Valid answer returned\r
+ EFI_INVALID_PARAMETER MaxiumCapsuleSize is NULL,ResetType is NULL.CapsuleCount is less than 1,CapsuleGuid is not supported.\r
+ EFI_UNSUPPORTED The capsule type is not supported.\r
+\r
+--*/\r
+{\r
+ UINTN ArrayNumber;\r
+ EFI_CAPSULE_HEADER *CapsuleHeader;\r
+\r
+ if (CapsuleCount < 1) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ if ((MaxiumCapsuleSize == NULL) ||(ResetType == NULL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ CapsuleHeader = NULL;\r
+\r
+ for (ArrayNumber = 0; ArrayNumber < CapsuleCount; ArrayNumber++) {\r
+ CapsuleHeader = CapsuleHeaderArray[ArrayNumber];\r
+ if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE)) == CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ if ((CapsuleHeader->Flags & CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) == 0) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ }\r
+\r
+ //\r
+ //Assume that capsules have the same flags on reseting or not.\r
+ //\r
+ CapsuleHeader = CapsuleHeaderArray[0];\r
+ if ((CapsuleHeader->Flags & CAPSULE_FLAGS_PERSIST_ACROSS_RESET) != 0) {\r
+ //\r
+ //Check if the platform supports update capsule across a system reset\r
+ //\r
+ if (!FeaturePcdGet(PcdSupportUpdateCapsuleRest)) {\r
+ return EFI_UNSUPPORTED;\r
+ }\r
+ *ResetType = EfiResetWarm;\r
+ *MaxiumCapsuleSize = FixedPcdGet32(PcdMaxSizePopulateCapsule);\r
+ } else {\r
+ *ResetType = EfiResetCold;\r
+ *MaxiumCapsuleSize = FixedPcdGet32(PcdMaxSizeNonPopulateCapsule);\r
+ }\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+CapsuleServiceInitialize (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+/*++\r
+\r
+Routine Description:\r
+\r
+ This code is capsule runtime service initialization.\r
+\r
+Arguments:\r
+\r
+ ImageHandle The image handle\r
+ SystemTable The system table.\r
+\r
+Returns:\r
+\r
+ EFI STATUS\r
+\r
+--*/\r
+{\r
+ EFI_STATUS Status;\r
+ EFI_HANDLE NewHandle;\r
+\r
+ SystemTable->RuntimeServices->UpdateCapsule = UpdateCapsule;\r
+ SystemTable->RuntimeServices->QueryCapsuleCapabilities = QueryCapsuleCapabilities;\r
+\r
+ //\r
+ // Now install the Capsule Architectural Protocol on a new handle\r
+ //\r
+ NewHandle = NULL;\r
+\r
+ Status = gBS->InstallMultipleProtocolInterfaces (\r
+ &NewHandle,\r
+ &gEfiCapsuleArchProtocolGuid,\r
+ NULL,\r
+ NULL\r
+ );\r
+ ASSERT_EFI_ERROR (Status);\r
+\r
+ return EFI_SUCCESS;\r
+}\r
--- /dev/null
+/*++\r
+\r
+Copyright (c) 2006, Intel Corporation\r
+All rights reserved. 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
+Module Name:\r
+\r
+ CapsuleService.h\r
+\r
+Abstract:\r
+\r
+ Capsule Runtime Service\r
+\r
+--*/\r
+\r
+#ifndef _CAPSULE_RUNTIME_H_\r
+#define _CAPSULE_RUNTIME_H_\r
+\r
+//\r
+// The package level header files this module uses\r
+//\r
+#include <PiDxe.h>\r
+//\r
+// The protocols, PPI and GUID defintions for this module\r
+//\r
+#include <Protocol/Capsule.h>\r
+#include <Guid/CapsuleVendor.h>\r
+//\r
+// The Library classes this module consumes\r
+//\r
+#include <Library/UefiDriverEntryPoint.h>\r
+#include <Library/DxeServicesTableLib.h>\r
+#include <Library/UefiRuntimeLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/MemoryAllocationLib.h>\r
+#include <Library/UefiBootServicesTableLib.h>\r
+\r
+#include <Common/CapsuleName.h>\r
+\r
+extern EFI_GUID gEfiCapsuleGuid;\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+UpdateCapsule(\r
+ IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
+ IN UINTN CapsuleCount,\r
+ IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL\r
+ );\r
+\r
+EFI_STATUS\r
+EFIAPI\r
+QueryCapsuleCapabilities(\r
+ IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,\r
+ IN UINTN CapsuleCount,\r
+ OUT UINT64 *MaxiumCapsuleSize,\r
+ OUT EFI_RESET_TYPE *ResetType\r
+ );\r
+\r
+#endif\r
+\r
projects / mirror_edk2.git / commitdiff