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 Copyright (c) 2006 - 2008, Intel Corporation
  10 All rights reserved. This program and the accompanying materials
  11 are licensed and made available under the terms and conditions of the BSD License
  12 which accompanies this distribution.  The full text of the license may be found at
  13 http://opensource.org/licenses/bsd-license.php
  14
  15 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  16 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  17
  18 **/
  19
  20 #ifndef __EFI_CAPSULE_VENDOR_GUID_H__
  21 #define __EFI_CAPSULE_VENDOR_GUID_H__
  22
  23 ///
  24 /// This guid is used as a variable GUID for the capsule variable
  25 /// if the capsule pointer is passed through reset via a variable.
  26 ///
  27 /// This guid is also used as a hob GUID for the capsule data
  28 /// when the capsule pointer is passed from PEI phase to DXE phase.
  29 ///
  30 #define EFI_CAPSULE_VENDOR_GUID  \
  31   { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }
  32
  33 ///
  34 /// Name of capsule variable
  35 ///
  36 #define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"
  37
  38 ///
  39 /// Data structure of capsule guid hob entry
  40 ///
  41 typedef struct {
  42   EFI_PHYSICAL_ADDRESS BaseAddress;  ///< Capsule data start address
  43   UINT32 Length;                     ///< Length of capsule data.
  44 } CAPSULE_HOB_INFO;
  45
  46 extern EFI_GUID gEfiCapsuleVendorGuid;
  47
  48 #endif // #ifndef _EFI_CAPSULE_VENDOR_GUID_H_