-/** @file\r
- Include the required header files for Capsule Runtime Service drivers.\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>\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
-**/\r
-\r
-#ifndef _CAPSULE_RUNTIME_H_\r
-#define _CAPSULE_RUNTIME_H_\r
-\r
-\r
-#include <Uefi.h>\r
-\r
-#include <Protocol/Capsule.h>\r
-#include <Guid/CapsuleVendor.h>\r
-\r
-#include <Library/UefiDriverEntryPoint.h>\r
-#include <Library/UefiRuntimeLib.h>\r
-#include <Library/DebugLib.h>\r
-#include <Library/PcdLib.h>\r
-#include <Library/UefiBootServicesTableLib.h>\r
-#include <Library/CapsuleLib.h>\r
-\r
-/**\r
- Passes capsules to the firmware with both virtual and physical mapping. Depending on the intended\r
- consumption, the firmware may process the capsule immediately. If the payload should persist\r
- across a system reset, the reset value returned from EFI_QueryCapsuleCapabilities must\r
- be passed into ResetSystem() and will cause the capsule to be processed by the firmware as\r
- part of the reset process.\r
-\r
- @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r
- being passed into update capsule.\r
- @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r
- CaspuleHeaderArray.\r
- @param ScatterGatherList Physical pointer to a set of\r
- EFI_CAPSULE_BLOCK_DESCRIPTOR that describes the\r
- location in physical memory of a set of capsules.\r
-\r
- @retval EFI_SUCCESS Valid capsule was passed. If\r
- CAPSULE_FLAGS_PERSIT_ACROSS_RESET is not set, the\r
- capsule has been successfully processed by the firmware.\r
- @retval EFI_DEVICE_ERROR The capsule update was started, but failed due to a device error.\r
- @retval EFI_INVALID_PARAMETER CapsuleCount is Zero, or CapsuleImage is not valid.\r
- For across reset capsule image, ScatterGatherList is NULL.\r
- @retval EFI_UNSUPPORTED CapsuleImage is not recognized by the firmware.\r
-\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
- Returns if the capsule can be supported via UpdateCapsule().\r
-\r
- @param CapsuleHeaderArray Virtual pointer to an array of virtual pointers to the capsules\r
- being passed into update capsule.\r
- @param CapsuleCount Number of pointers to EFI_CAPSULE_HEADER in\r
- CaspuleHeaderArray.\r
- @param MaxiumCapsuleSize On output the maximum size that UpdateCapsule() can\r
- support as an argument to UpdateCapsule() via\r
- CapsuleHeaderArray and ScatterGatherList.\r
- @param ResetType Returns the type of reset required for the capsule update.\r
-\r
- @retval EFI_SUCCESS Valid answer returned.\r
- @retval EFI_UNSUPPORTED The capsule image is not supported on this platform, and\r
- MaximumCapsuleSize and ResetType are undefined.\r
- @retval EFI_INVALID_PARAMETER MaximumCapsuleSize is NULL, or ResetTyep is NULL,\r
- Or CapsuleCount is Zero, or CapsuleImage is not valid.\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