MdeModulePkg: Add Capsule PEIM

[mirror_edk2.git] / MdeModulePkg / Universal / CapsulePei / Capsule.h

/** @file\r
\r
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions\r
of the BSD License which accompanies this distribution.  The\r
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_PEIM_H_\r
#define _CAPSULE_PEIM_H_\r
\r
#include <PiPei.h>\r
#include <Uefi/UefiSpec.h>\r
\r
#include <Ppi/Capsule.h>\r
\r
#include <Ppi/ReadOnlyVariable2.h>\r
#include <Guid/CapsuleVendor.h>\r
\r
#include <Library/DebugLib.h>\r
#include <Library/PeimEntryPoint.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/HobLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Library/PrintLib.h>\r
\r
//\r
// We want to avoid using memory at 0 for coalescing, so set a\r
// min address.\r
//\r
#define MIN_COALESCE_ADDR 0x100000\r
#define MAX_SUPPORT_CAPSULE_NUM 50\r
\r
//\r
// This capsule PEIM puts its private data at the start of the\r
// coalesced capsule. Here's the structure definition.\r
//\r
#define EFI_CAPSULE_PEIM_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('C', 'a', 'p', 'D')\r
\r
typedef struct {\r
  UINT32  Signature;\r
  UINTN   CapsuleSize;\r
} EFI_CAPSULE_PEIM_PRIVATE_DATA;\r
\r
#define CAPSULE_TEST_SIGNATURE SIGNATURE_32('T', 'E', 'S', 'T')\r
\r
#endif\r