MdeModulePkg/Include/Guid/CapsuleVendor.h

   1 /** @file
   2   This file defines:
   3   * the capsule vendor GUID for capsule variables and the HOB.
   4   * the capsule variable name.
   5   * the capsule GUID HOB data structure.
   6   The capsule HOB and variable can be used to store the capsule image start address and length.
   7   They are used by EDKII implementation of capsule update across a system reset.
   8
   9   @par Note: EDKII implementation of capsule updating has discarded this capsule GUID HOB data
  10              structure and used one UEFI Capsule HOB (defined in PI Specification 1.2) instead.
  11
  12 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
  13 SPDX-License-Identifier: BSD-2-Clause-Patent
  14
  15 **/
  16
  17 #ifndef __EFI_CAPSULE_VENDOR_GUID_H__
  18 #define __EFI_CAPSULE_VENDOR_GUID_H__
  19
  20 ///
  21 /// This guid is used as a variable GUID for the capsule variable
  22 /// if the capsule pointer is passed through reset via a variable.
  23 ///
  24 /// This guid is also used as a hob GUID for the capsule data
  25 /// when the capsule pointer is passed from PEI phase to DXE phase.
  26 ///
  27 #define EFI_CAPSULE_VENDOR_GUID  \
  28   { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }
  29
  30 ///
  31 /// Name of capsule variable.
  32 ///
  33 #define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"
  34
  35 ///
  36 /// The data structure of the capsule guid hob entry.
  37 /// Note: EDKII implementation has discarded this structure and used
  38 ///       UEFI_CAPSULE_HOB instead.
  39 ///
  40 typedef struct {
  41   EFI_PHYSICAL_ADDRESS BaseAddress;  ///< Capsule data start address.
  42   UINT32 Length;                     ///< Length of capsule data.
  43 } CAPSULE_HOB_INFO;
  44
  45 //
  46 // The variable describes the long mode buffer used by IA32 Capsule PEIM
  47 // to call X64 CapsuleCoalesce code to handle >4GB capsule blocks.
  48 //
  49 #define EFI_CAPSULE_LONG_MODE_BUFFER_NAME L"CapsuleLongModeBuffer"
  50
  51 typedef struct {
  52   EFI_PHYSICAL_ADDRESS   PageTableAddress;
  53   EFI_PHYSICAL_ADDRESS   StackBaseAddress;
  54   UINT64                 StackSize;
  55 } EFI_CAPSULE_LONG_MODE_BUFFER;
  56
  57 extern EFI_GUID gEfiCapsuleVendorGuid;
  58
  59 #endif // #ifndef _EFI_CAPSULE_VENDOR_GUID_H_