4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Capsule Runtime Driver produces two UEFI capsule runtime services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (UpdateCapsule, QueryCapsuleCapabilities)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync It installs the Capsule Architectural Protocol defined in PI1.0a to signify
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the capsule runtime services are ready.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncare licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncwhich accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Uefi.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Protocol/Capsule.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Guid/CapsuleVendor.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/DebugLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/PcdLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/CapsuleLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/UefiDriverEntryPoint.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/UefiBootServicesTableLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/UefiRuntimeServicesTableLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/UefiRuntimeLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/BaseLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#include <Library/PrintLib.h>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// Handle for the installation of Capsule Architecture Protocol.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_HANDLE mNewHandle = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// The times of calling UpdateCapsule ()
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync//
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUINTN mTimes = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Create the variable to save the base address of page table and stack
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for transferring into long mode in IA32 PEI.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncVOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncSaveLongModeContext (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync consumption, the firmware may process the capsule immediately. If the payload should persist
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync be passed into ResetSystem() and will cause the capsule to be processed by the firmware as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync part of the reset process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being passed into update capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CaspuleHeaderArray.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ScatterGatherList Physical pointer to a set of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync location in physical memory of a set of capsules.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Valid capsule was passed. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync capsule has been successfully processed by the firmware.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER CapsuleSize is NULL, or an incompatible set of flags were
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync set in the capsule header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER CapsuleCount is Zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER For across reset capsule image, ScatterGatherList is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED CapsuleImage is not recognized by the firmware.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncUpdateCapsule (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINTN CapsuleCount,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_PHYSICAL_ADDRESS ScatterGatherList OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN ArrayNumber;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_CAPSULE_HEADER *CapsuleHeader;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN NeedReset;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN InitiateReset;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR16 CapsuleVarName[30];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CHAR16 *TempVarName;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Capsule Count can't be less than one.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CapsuleCount < 1) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NeedReset = FALSE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InitiateReset = FALSE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeader = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleVarName[0] = 0;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (ArrayNumber = 0; ArrayNumber < CapsuleCount; ArrayNumber++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // A capsule which has the CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag must have
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // CAPSULE_FLAGS_PERSIST_ACROSS_RESET set in its header as well.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeader = CapsuleHeaderArray[ArrayNumber];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE)) == CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // A capsule which has the CAPSULE_FLAGS_INITIATE_RESET flag must have
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // CAPSULE_FLAGS_PERSIST_ACROSS_RESET set in its header as well.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_INITIATE_RESET)) == CAPSULE_FLAGS_INITIATE_RESET) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check Capsule image without populate flag by firmware support capsule function
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((CapsuleHeader->Flags & CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) == 0) &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (SupportCapsuleImage (CapsuleHeader) != EFI_SUCCESS)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_UNSUPPORTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Walk through all capsules, record whether there is a capsule needs reset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // or initiate reset. And then process capsules which has no reset flag directly.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (ArrayNumber = 0; ArrayNumber < CapsuleCount ; ArrayNumber++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeader = CapsuleHeaderArray[ArrayNumber];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Here should be in the boot-time for non-reset capsule image
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Platform specific update for the non-reset capsule image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CapsuleHeader->Flags & CAPSULE_FLAGS_PERSIST_ACROSS_RESET) == 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EfiAtRuntime ()) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = EFI_UNSUPPORTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = ProcessCapsuleImage(CapsuleHeader);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (EFI_ERROR(Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NeedReset = TRUE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CapsuleHeader->Flags & CAPSULE_FLAGS_INITIATE_RESET) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync InitiateReset = TRUE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // After launching all capsules who has no reset flag, if no more capsules claims
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // for a system reset just return.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!NeedReset) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // ScatterGatherList is only referenced if the capsules are defined to persist across
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // system reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (ScatterGatherList == (EFI_PHYSICAL_ADDRESS) (UINTN) NULL) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check if the platform supports update capsule across a system reset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!FeaturePcdGet(PcdSupportUpdateCapsuleReset)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_UNSUPPORTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Construct variable name CapsuleUpdateData, CapsuleUpdateData1, CapsuleUpdateData2...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // if user calls UpdateCapsule multiple times.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync StrCpy (CapsuleVarName, EFI_CAPSULE_VARIABLE_NAME);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync TempVarName = CapsuleVarName + StrLen (CapsuleVarName);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (mTimes > 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UnicodeValueToString (TempVarName, 0, mTimes, 0);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // ScatterGatherList is only referenced if the capsules are defined to persist across
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // system reset. Set its value into NV storage to let pre-boot driver to pick it up
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // after coming through a system reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = EfiSetVariable (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleVarName,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync &gEfiCapsuleVendorGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_RUNTIME_ACCESS | EFI_VARIABLE_BOOTSERVICE_ACCESS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync sizeof (UINTN),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (VOID *) &ScatterGatherList
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!EFI_ERROR (Status)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Variable has been set successfully, increase variable index.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mTimes++;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if(InitiateReset) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Firmware that encounters a capsule which has the CAPSULE_FLAGS_INITIATE_RESET Flag set in its header
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // will initiate a reset of the platform which is compatible with the passed-in capsule request and will
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // not return back to the caller.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiResetSystem (EfiResetWarm, EFI_SUCCESS, 0, NULL);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Returns if the capsule can be supported via UpdateCapsule().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync being passed into update capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CaspuleHeaderArray.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync support as an argument to UpdateCapsule() via
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeaderArray and ScatterGatherList.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ResetType Returns the type of reset required for the capsule update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS Valid answer returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The capsule image is not supported on this platform, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync MaximumCapsuleSize and ResetType are undefined.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL, or ResetTyep is NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Or CapsuleCount is Zero, or CapsuleImage is not valid.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncQueryCapsuleCapabilities (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_CAPSULE_HEADER **CapsuleHeaderArray,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN UINTN CapsuleCount,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT UINT64 *MaxiumCapsuleSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT EFI_RESET_TYPE *ResetType
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN ArrayNumber;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_CAPSULE_HEADER *CapsuleHeader;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN NeedReset;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Capsule Count can't be less than one.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (CapsuleCount < 1) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check whether input parameter is valid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((MaxiumCapsuleSize == NULL) ||(ResetType == NULL)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeader = NULL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NeedReset = FALSE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (ArrayNumber = 0; ArrayNumber < CapsuleCount; ArrayNumber++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeader = CapsuleHeaderArray[ArrayNumber];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // A capsule which has the CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE flag must have
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // CAPSULE_FLAGS_PERSIST_ACROSS_RESET set in its header as well.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE)) == CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // A capsule which has the CAPSULE_FLAGS_INITIATE_RESET flag must have
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // CAPSULE_FLAGS_PERSIST_ACROSS_RESET set in its header as well.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CapsuleHeader->Flags & (CAPSULE_FLAGS_PERSIST_ACROSS_RESET | CAPSULE_FLAGS_INITIATE_RESET)) == CAPSULE_FLAGS_INITIATE_RESET) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_INVALID_PARAMETER;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Check Capsule image without populate flag is supported by firmware
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (((CapsuleHeader->Flags & CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE) == 0) &&
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (SupportCapsuleImage (CapsuleHeader) != EFI_SUCCESS)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_UNSUPPORTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Find out whether there is any capsule defined to persist across system reset.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for (ArrayNumber = 0; ArrayNumber < CapsuleCount ; ArrayNumber++) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync CapsuleHeader = CapsuleHeaderArray[ArrayNumber];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if ((CapsuleHeader->Flags & CAPSULE_FLAGS_PERSIST_ACROSS_RESET) != 0) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NeedReset = TRUE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync break;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (NeedReset) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //Check if the platform supports update capsule across a system reset
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync if (!FeaturePcdGet(PcdSupportUpdateCapsuleReset)) {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_UNSUPPORTED;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *ResetType = EfiResetWarm;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *MaxiumCapsuleSize = FixedPcdGet32(PcdMaxSizePopulateCapsule);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } else {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // For non-reset capsule image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *ResetType = EfiResetCold;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync *MaxiumCapsuleSize = FixedPcdGet32(PcdMaxSizeNonPopulateCapsule);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return EFI_SUCCESS;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This code installs UEFI capsule runtime service.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param ImageHandle The firmware allocated handle for the EFI image.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param SystemTable A pointer to the EFI System Table.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS UEFI Capsule Runtime Services are installed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFIAPI
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCapsuleServiceInitialize (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_HANDLE ImageHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_SYSTEM_TABLE *SystemTable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync )
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync{
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_STATUS Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // When PEI phase is IA32, DXE phase is X64, it is possible that capsule data are
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // put above 4GB, so capsule PEI will transfer to long mode to get capsule data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // The page table and stack is used to transfer processor mode from IA32 to long mode.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Create the base address of page table and stack, and save them into variable.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // This is not needed when capsule with reset type is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync SaveLongModeContext ();
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Install capsule runtime services into UEFI runtime service tables.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gRT->UpdateCapsule = UpdateCapsule;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync gRT->QueryCapsuleCapabilities = QueryCapsuleCapabilities;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // Install the Capsule Architectural Protocol on a new handle
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // to signify the capsule runtime services are ready.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync //
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Status = gBS->InstallMultipleProtocolInterfaces (
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync &mNewHandle,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync &gEfiCapsuleArchProtocolGuid,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync NULL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ASSERT_EFI_ERROR (Status);
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync return Status;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync}