Data Structures
struct	VARIABLE_STORE_HEADER

struct	VARIABLE_HEADER

struct	AUTHENTICATED_VARIABLE_HEADER

struct	VARIABLE_ENTRY_CONSISTENCY

struct	_VARIABLE_INFO_ENTRY

Macros
#define	EFI_VARIABLE_GUID { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d } }

#define	EFI_AUTHENTICATED_VARIABLE_GUID { 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }

#define	ALIGNMENT 1

#define	GET_PAD_SIZE(a) (0)

#define	HEADER_ALIGNMENT 4

#define	HEADER_ALIGN(Header) (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))

#define	VARIABLE_STORE_SIGNATURE EFI_VARIABLE_GUID

#define	AUTHENTICATED_VARIABLE_STORE_SIGNATURE EFI_AUTHENTICATED_VARIABLE_GUID

#define	VARIABLE_STORE_FORMATTED 0x5a

#define	VARIABLE_STORE_HEALTHY 0xfe

#define	VARIABLE_DATA 0x55AA

#define	VAR_IN_DELETED_TRANSITION 0xfe
	Variable is in obsolete transition.

#define	VAR_DELETED 0xfd
	Variable is obsolete.

#define	VAR_HEADER_VALID_ONLY 0x7f
	Variable header has been valid.

#define	VAR_ADDED 0x3f
	Variable has been completely added.

#define	VARIABLE_ATTRIBUTE_NV_BS (EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS)

#define	VARIABLE_ATTRIBUTE_BS_RT (EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS)

#define	VARIABLE_ATTRIBUTE_BS_RT_AT (VARIABLE_ATTRIBUTE_BS_RT \| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)

#define	VARIABLE_ATTRIBUTE_NV_BS_RT (VARIABLE_ATTRIBUTE_BS_RT \| EFI_VARIABLE_NON_VOLATILE)

#define	VARIABLE_ATTRIBUTE_NV_BS_RT_HR (VARIABLE_ATTRIBUTE_NV_BS_RT \| EFI_VARIABLE_HARDWARE_ERROR_RECORD)

#define	VARIABLE_ATTRIBUTE_NV_BS_RT_AT (VARIABLE_ATTRIBUTE_NV_BS_RT \| EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)

#define	VARIABLE_ATTRIBUTE_AT EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS

#define	VARIABLE_ATTRIBUTE_NV_BS_RT_HR_AT (VARIABLE_ATTRIBUTE_NV_BS_RT_HR \| VARIABLE_ATTRIBUTE_AT)

#define	VARIABLE_ATTRIBUTE_AT_AW (EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS \| EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)

#define	VARIABLE_ATTRIBUTE_NV_BS_RT_AW (VARIABLE_ATTRIBUTE_NV_BS_RT \| EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)

#define	VARIABLE_ATTRIBUTE_NV_BS_RT_HR_AT_AW (VARIABLE_ATTRIBUTE_NV_BS_RT_HR \| VARIABLE_ATTRIBUTE_AT_AW)

Typedefs
typedef struct _VARIABLE_INFO_ENTRY	VARIABLE_INFO_ENTRY

Enumerations
enum	VARIABLE_STORE_STATUS { EfiRaw , EfiValid , EfiInvalid , EfiUnknown }

Variables
EFI_GUID	gEfiVariableGuid

EFI_GUID	gEfiAuthenticatedVariableGuid

Detailed Description

The variable data structures are related to EDK II-specific implementation of UEFI variables. VariableFormat.h defines variable data headers and variable storage region headers.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file VariableFormat.h.

Macro Definition Documentation

◆ ALIGNMENT

#define ALIGNMENT 1

Alignment of variable name and data, according to the architecture:

For IA-32 and Intel(R) 64 architectures: 1.

Definition at line 26 of file VariableFormat.h.

◆ AUTHENTICATED_VARIABLE_STORE_SIGNATURE

#define AUTHENTICATED_VARIABLE_STORE_SIGNATURE EFI_AUTHENTICATED_VARIABLE_GUID

Definition at line 56 of file VariableFormat.h.

◆ EFI_AUTHENTICATED_VARIABLE_GUID

#define EFI_AUTHENTICATED_VARIABLE_GUID { 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }

Definition at line 16 of file VariableFormat.h.

◆ EFI_VARIABLE_GUID

#define EFI_VARIABLE_GUID { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d } }

Definition at line 13 of file VariableFormat.h.

◆ GET_PAD_SIZE

#define GET_PAD_SIZE ( a ) (0)

Definition at line 32 of file VariableFormat.h.

◆ HEADER_ALIGN

#define HEADER_ALIGN ( Header ) (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))

Definition at line 41 of file VariableFormat.h.

◆ HEADER_ALIGNMENT

#define HEADER_ALIGNMENT 4

Alignment of Variable Data Header in Variable Store region.

Definition at line 40 of file VariableFormat.h.

◆ VAR_ADDED

#define VAR_ADDED 0x3f

Variable has been completely added.

Definition at line 100 of file VariableFormat.h.

◆ VAR_DELETED

#define VAR_DELETED 0xfd

Variable is obsolete.

Definition at line 98 of file VariableFormat.h.

◆ VAR_HEADER_VALID_ONLY

#define VAR_HEADER_VALID_ONLY 0x7f

Variable header has been valid.

Definition at line 99 of file VariableFormat.h.

◆ VAR_IN_DELETED_TRANSITION

#define VAR_IN_DELETED_TRANSITION 0xfe

Variable is in obsolete transition.

Variable State flags.

Definition at line 97 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_AT

#define VARIABLE_ATTRIBUTE_AT EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS

Definition at line 111 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_AT_AW

#define VARIABLE_ATTRIBUTE_AT_AW (EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)

EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS is deprecated and should be considered as reserved

Definition at line 116 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_BS_RT

#define VARIABLE_ATTRIBUTE_BS_RT (EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS)

Definition at line 106 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_BS_RT_AT

#define VARIABLE_ATTRIBUTE_BS_RT_AT (VARIABLE_ATTRIBUTE_BS_RT | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)

Definition at line 107 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_NV_BS

#define VARIABLE_ATTRIBUTE_NV_BS (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS)

Variable Attribute combinations.

Definition at line 105 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_NV_BS_RT

#define VARIABLE_ATTRIBUTE_NV_BS_RT (VARIABLE_ATTRIBUTE_BS_RT | EFI_VARIABLE_NON_VOLATILE)

Definition at line 108 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_NV_BS_RT_AT

#define VARIABLE_ATTRIBUTE_NV_BS_RT_AT (VARIABLE_ATTRIBUTE_NV_BS_RT | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)

Definition at line 110 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_NV_BS_RT_AW

#define VARIABLE_ATTRIBUTE_NV_BS_RT_AW (VARIABLE_ATTRIBUTE_NV_BS_RT | EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS)

Definition at line 117 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_NV_BS_RT_HR

#define VARIABLE_ATTRIBUTE_NV_BS_RT_HR (VARIABLE_ATTRIBUTE_NV_BS_RT | EFI_VARIABLE_HARDWARE_ERROR_RECORD)

Definition at line 109 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_NV_BS_RT_HR_AT

#define VARIABLE_ATTRIBUTE_NV_BS_RT_HR_AT (VARIABLE_ATTRIBUTE_NV_BS_RT_HR | VARIABLE_ATTRIBUTE_AT)

Definition at line 112 of file VariableFormat.h.

◆ VARIABLE_ATTRIBUTE_NV_BS_RT_HR_AT_AW

#define VARIABLE_ATTRIBUTE_NV_BS_RT_HR_AT_AW (VARIABLE_ATTRIBUTE_NV_BS_RT_HR | VARIABLE_ATTRIBUTE_AT_AW)

Definition at line 118 of file VariableFormat.h.

◆ VARIABLE_DATA

#define VARIABLE_DATA 0x55AA

Variable data start flag.

Definition at line 92 of file VariableFormat.h.

◆ VARIABLE_STORE_FORMATTED

#define VARIABLE_STORE_FORMATTED 0x5a

Variable Store Header Format and State.

Definition at line 61 of file VariableFormat.h.

◆ VARIABLE_STORE_HEALTHY

#define VARIABLE_STORE_HEALTHY 0xfe

Definition at line 62 of file VariableFormat.h.

◆ VARIABLE_STORE_SIGNATURE

#define VARIABLE_STORE_SIGNATURE EFI_VARIABLE_GUID

Definition at line 55 of file VariableFormat.h.

Typedef Documentation

◆ VARIABLE_INFO_ENTRY

typedef struct _VARIABLE_INFO_ENTRY VARIABLE_INFO_ENTRY

Definition at line 202 of file VariableFormat.h.

Enumeration Type Documentation

◆ VARIABLE_STORE_STATUS

enum VARIABLE_STORE_STATUS

Status of Variable Store Region.

Definition at line 46 of file VariableFormat.h.

Data Structures

Macros

Typedefs

Enumerations

Variables