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              structur and used one UEFI Capsule HOB (defined in PI Specification 1.2) instead.
  11
  12 Copyright (c) 2006 - 2010, Intel Corporation
  13 All rights reserved. This program and the accompanying materials
  14 are licensed and made available under the terms and conditions of the BSD License
  15 which accompanies this distribution.  The full text of the license may be found at
  16 http://opensource.org/licenses/bsd-license.php
  17
  18 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  19 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  20
  21 **/
  22
  23 #ifndef __EFI_CAPSULE_VENDOR_GUID_H__
  24 #define __EFI_CAPSULE_VENDOR_GUID_H__
  25
  26 ///
  27 /// This guid is used as a variable GUID for the capsule variable
  28 /// if the capsule pointer is passed through reset via a variable.
  29 ///
  30 /// This guid is also used as a hob GUID for the capsule data
  31 /// when the capsule pointer is passed from PEI phase to DXE phase.
  32 ///
  33 #define EFI_CAPSULE_VENDOR_GUID  \
  34   { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }
  35
  36 ///
  37 /// Name of capsule variable
  38 ///
  39 #define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"
  40
  41 ///
  42 /// Data structure of capsule guid hob entry
  43 /// Note: EDKII implementation has discarded this structure and used
  44 ///       UEFI_CAPSULE_HOB instead.
  45 ///
  46 typedef struct {
  47   EFI_PHYSICAL_ADDRESS BaseAddress;  ///< Capsule data start address
  48   UINT32 Length;                     ///< Length of capsule data.
  49 } CAPSULE_HOB_INFO;
  50
  51 ///
  52 /// The variable describes the long mode buffer used by 32-bit Capsule PEIM
  53 /// to handle capsule above 4G.
  54 ///
  55 #define EFI_CAPSULE_LONG_MODE_BUFFER_NAME L"CapsuleLongModeBuffer"
  56
  57 ///
  58 /// Data structure for base address and length of the long mode buffer used by 32-bit Capsule PEIM
  59 /// to handle capsule above 4G
  60 ///
  61 typedef struct {
  62   UINT64   Base;    ///< Base address of the long mode buffer.
  63   UINT64   Length;  ///< Length of the long mode buffer.
  64 } EFI_CAPSULE_LONG_MODE_BUFFER;
  65
  66 extern EFI_GUID gEfiCapsuleVendorGuid;
  67
  68 #endif // #ifndef _EFI_CAPSULE_VENDOR_GUID_H_