EFI CAPSULE HEADER

From PhoenixWiki

Jump to: navigation, search

Prototype

typedef struct {
  EFI_GUID CapsuleGuid;
  UINT32   HeaderSize;
  UINT32   Flags;
  UINT32   CapsuleImageSize;
} EFI_CAPSULE_HEADER;

Members

Member Description
CapsuleGuid A GUID that defines the contents of a capsule.
HeaderSize The size of the capsule header. This may be larger than the size of the EFI_CAPSULE_HEADER since CapsuleGuid may imply extended header entries.
Flags Bit-mapped list describing the capsule attributes. The Flag values of 0x0000 – 0xFFFF are defined by CapsuleGuid. Flag values of 0x10000 – 0xFFFFFFFF are defined by this specification
#define CAPSULE_FLAGS_PERSIST_ACROSS_RESET 0x00010000
#define CAPSULE_FLAGS_POPULATE_SYSTEM_TABLE 0x00020000
#define CAPSULE_FLAGS_INITIATE_RESET 0x00040000

Note: A capsule which has the CAPSULE_FLAGS_INITIATE_RESET Flag must have CAPSULE_FLAGS_PERSIST_ACROSS_RESET set in its header as well. Firmware that encounters a capsule which has the CAPSULE_FLAGS_INITIATE_RESET Flag set in its header will initiate a reset of the platform which is compatible with the passed-in capsule request and will not return back to the caller.

CapsuleImageSize Size in bytes of the capsule.

Copyright (C) 2008 Phoenix Technologies Ltd. All Rights Reserved. Portions copyright (C) 2008 UEFI Forum, Inc. Used with permission.

Personal tools