241 lines
6.9 KiB
C
241 lines
6.9 KiB
C
/** @file
|
|
|
|
;******************************************************************************
|
|
;* Copyright (c) 2012 - 2019, Insyde Software Corp. All Rights Reserved.
|
|
;*
|
|
;* You may not reproduce, distribute, publish, display, perform, modify, adapt,
|
|
;* transmit, broadcast, present, recite, release, license or otherwise exploit
|
|
;* any part of this publication in any form, by any means, without the prior
|
|
;* written permission of Insyde Software Corporation.
|
|
;*
|
|
;******************************************************************************
|
|
*/
|
|
|
|
/**
|
|
The variable data structures are related to EDKII-specific
|
|
implementation of UEFI authenticated variables.
|
|
AuthenticatedVariableFormat.h defines variable data headers
|
|
and variable storage region headers.
|
|
|
|
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
|
|
This program and the accompanying materials
|
|
are licensed and made available under the terms and conditions of the BSD License
|
|
which accompanies this distribution. The full text of the license may be found at
|
|
http://opensource.org/licenses/bsd-license.php
|
|
|
|
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
|
|
**/
|
|
|
|
#ifndef __AUTHENTICATED_VARIABLE_FORMAT_H__
|
|
#define __AUTHENTICATED_VARIABLE_FORMAT_H__
|
|
#include <H2OBoardId.h>
|
|
|
|
#define EFI_AUTHENTICATED_VARIABLE_GUID \
|
|
{ 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }
|
|
|
|
#define EFI_VARIABLE_GUID \
|
|
{ 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d } }
|
|
|
|
#define EFI_SECURE_BOOT_ENABLE_DISABLE \
|
|
{ 0xf0a30bc7, 0xaf08, 0x4556, { 0x99, 0xc4, 0x0, 0x10, 0x9, 0xc9, 0x3a, 0x44 } }
|
|
|
|
|
|
extern EFI_GUID gEfiAuthenticatedVariableGuid;
|
|
extern EFI_GUID gEfiVariableGuid;
|
|
extern EFI_GUID gEfiSecureBootEnableDisableGuid;
|
|
|
|
///
|
|
/// "SecureBootEnable" variable for the Secure boot feature enable/disable.
|
|
///
|
|
#define EFI_SECURE_BOOT_ENABLE_NAME L"SecureBootEnable"
|
|
#define SECURE_BOOT_ENABLE 1
|
|
#define SECURE_BOOT_DISABLE 0
|
|
|
|
///
|
|
/// Alignment of variable name and data, according to the architecture:
|
|
/// * For IA-32 and Intel(R) 64 architectures: 1.
|
|
/// * For IA-64 architecture: 8.
|
|
///
|
|
#define ALIGNMENT 1
|
|
|
|
|
|
//
|
|
// GET_PAD_SIZE calculates the miminal pad bytes needed to make the current pad size satisfy the alignment requirement.
|
|
//
|
|
#if (ALIGNMENT == 1)
|
|
#define GET_PAD_SIZE(a) (0)
|
|
#else
|
|
#define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))
|
|
#endif
|
|
|
|
///
|
|
/// Alignment of Variable Data Header in Variable Store region.
|
|
///
|
|
#define HEADER_ALIGNMENT 1
|
|
#define HEADER_ALIGN(Header) (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))
|
|
|
|
///
|
|
/// Status of Variable Store Region.
|
|
///
|
|
typedef enum {
|
|
EfiRaw,
|
|
EfiValid,
|
|
EfiInvalid,
|
|
EfiUnknown
|
|
} VARIABLE_STORE_STATUS;
|
|
|
|
#pragma pack(1)
|
|
|
|
#define VARIABLE_STORE_SIGNATURE EFI_AUTHENTICATED_VARIABLE_GUID
|
|
|
|
|
|
///
|
|
/// Variable Store Header Format and State.
|
|
///
|
|
#define VARIABLE_STORE_FORMATTED 0x5a
|
|
#define VARIABLE_STORE_HEALTHY 0xfe
|
|
#define VARIABLE_STORE_ACTIVE 0x00
|
|
#define VARIABLE_STORE_ACTIVE_MASK 0x80
|
|
|
|
#define EFI_VARIABLE_DEFAULT_READY_ONLY 0x02000000
|
|
#define EFI_VARIABLE_INSYDE_AUTHENTICATED_WRITE_ACCESS 0x01000000
|
|
///
|
|
/// Variable Store region header.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// Variable store region signature.
|
|
///
|
|
EFI_GUID Signature;
|
|
///
|
|
/// Size of entire variable store,
|
|
/// including size of variable store header but not including the size of FvHeader.
|
|
///
|
|
UINT32 Size;
|
|
///
|
|
/// Variable region format state.
|
|
///
|
|
UINT8 Format;
|
|
///
|
|
/// Variable region healthy state.
|
|
///
|
|
UINT8 State;
|
|
UINT16 DefaultId;
|
|
UINT8 BoardId;
|
|
UINT8 Flags;
|
|
UINT16 ExtHeaderSize;
|
|
} VARIABLE_STORE_HEADER;
|
|
|
|
|
|
//
|
|
// ECP realtive definitions for backward compatible
|
|
//
|
|
typedef struct {
|
|
UINT32 Signature;
|
|
UINT32 Size;
|
|
UINT8 Format;
|
|
UINT8 State;
|
|
UINT16 DefaultId;
|
|
UINT8 BoardId;
|
|
UINT8 Flags;
|
|
UINT16 ExtHeaderSize;
|
|
} ECP_VARIABLE_STORE_HEADER;
|
|
|
|
typedef struct {
|
|
UINT32 Signature;
|
|
UINT16 Size;
|
|
H2O_BOARD_ID BoardId;
|
|
} EXT_VARIABLE_STORE_HEADER;
|
|
|
|
#define ECP_VARIABLE_STORE_SIGNATURE SIGNATURE_32 ('$', 'V', 'S', 'S')
|
|
//
|
|
// According to Logo requirement, the maximum variable size is 64K. But it doesn't include
|
|
// variable header size. Therefore, we keep maximum variable size to 68K.
|
|
//
|
|
#define MAX_VARIABLE_SIZE 0x11000
|
|
|
|
#define MAX_VARIABLE_NAME_SIZE 0x100
|
|
|
|
#define VARIABLE_DATA 0x55AA
|
|
|
|
///
|
|
/// Variable data start flag.
|
|
///
|
|
#define VARIABLE_DATA 0x55AA
|
|
|
|
///
|
|
/// Variable State flags.
|
|
///
|
|
#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.
|
|
|
|
///
|
|
/// Single Variable Data Header Structure.
|
|
///
|
|
typedef struct {
|
|
///
|
|
/// Variable Data Start Flag.
|
|
///
|
|
UINT16 StartId;
|
|
///
|
|
/// Variable State defined above.
|
|
///
|
|
UINT8 State;
|
|
UINT8 Reserved;
|
|
///
|
|
/// Attributes of variable defined in UEFI specification.
|
|
///
|
|
UINT32 Attributes;
|
|
///
|
|
/// Associated monotonic count value against replay attack.
|
|
///
|
|
UINT64 MonotonicCount;
|
|
///
|
|
/// Associated TimeStamp value against replay attack.
|
|
///
|
|
EFI_TIME TimeStamp;
|
|
///
|
|
/// Index of associated public key in database.
|
|
///
|
|
UINT32 PubKeyIndex;
|
|
///
|
|
/// Size of variable null-terminated Unicode string name.
|
|
///
|
|
UINT32 NameSize;
|
|
///
|
|
/// Size of the variable data without this header.
|
|
///
|
|
UINT32 DataSize;
|
|
///
|
|
/// A unique identifier for the vendor that produces and consumes this varaible.
|
|
///
|
|
EFI_GUID VendorGuid;
|
|
} VARIABLE_HEADER;
|
|
|
|
#pragma pack()
|
|
|
|
typedef struct _VARIABLE_INFO_ENTRY VARIABLE_INFO_ENTRY;
|
|
|
|
///
|
|
/// This structure contains the variable list that is put in EFI system table.
|
|
/// The variable driver collects all variables that were used at boot service time and produces this list.
|
|
/// This is an optional feature to dump all used variables in shell environment.
|
|
///
|
|
struct _VARIABLE_INFO_ENTRY {
|
|
VARIABLE_INFO_ENTRY *Next; ///< Pointer to next entry.
|
|
EFI_GUID VendorGuid; ///< Guid of Variable.
|
|
CHAR16 *Name; ///< Name of Variable.
|
|
UINT32 Attributes; ///< Attributes of variable defined in UEFI spec.
|
|
UINT32 ReadCount; ///< Number of times to read this variable.
|
|
UINT32 WriteCount; ///< Number of times to write this variable.
|
|
UINT32 DeleteCount; ///< Number of times to delete this variable.
|
|
UINT32 CacheCount; ///< Number of times that cache hits this variable.
|
|
BOOLEAN Volatile; ///< TRUE if volatile, FALSE if non-volatile.
|
|
};
|
|
|
|
#endif // __AUTHENTICATED_VARIABLE_FORMAT_H__
|