VirtualBox

source: vbox/trunk/include/iprt/formats/efi-varstore.h@ 103224

Last change on this file since 103224 was 98103, checked in by vboxsync, 23 months ago

Copyright year updates by scm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 6.1 KB
Line 
1/* $Id: efi-varstore.h 98103 2023-01-17 14:15:46Z vboxsync $ */
2/** @file
3 * IPRT, EFI variable store (VarStore) definitions.
4 */
5
6/*
7 * Copyright (C) 2021-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37#ifndef IPRT_INCLUDED_formats_efi_varstore_h
38#define IPRT_INCLUDED_formats_efi_varstore_h
39#ifndef RT_WITHOUT_PRAGMA_ONCE
40# pragma once
41#endif
42
43#include <iprt/types.h>
44#include <iprt/assertcompile.h>
45#include <iprt/formats/efi-common.h>
46
47
48/*
49 * Definitions come from the EDK2 sources MdeModulePkg/Include/Guid/VariableFormat.h
50 */
51
52/** The filesystem GUID for a variable store stored in a volume header. */
53#define EFI_VARSTORE_FILESYSTEM_GUID \
54 { 0xfff12b8d, 0x7696, 0x4c8b, { 0xa9, 0x85, 0x27, 0x47, 0x07, 0x5b, 0x4f, 0x50 }}
55
56
57/**
58 * The variable store header.
59 */
60typedef struct EFI_VARSTORE_HEADER
61{
62 /** The GUID identifying a variable store. */
63 EFI_GUID GuidVarStore;
64 /** Size of the variable store including the header. */
65 uint32_t cbVarStore;
66 /** The format state. */
67 uint8_t bFmt;
68 /** The region health state. */
69 uint8_t bState;
70 /** Reserved. */
71 uint8_t abRsvd[6];
72} EFI_VARSTORE_HEADER;
73AssertCompileSize(EFI_VARSTORE_HEADER, 28);
74/** Pointer to a variable store header. */
75typedef EFI_VARSTORE_HEADER *PEFI_VARSTORE_HEADER;
76/** Pointer to a const variable store header. */
77typedef const EFI_VARSTORE_HEADER *PCEFI_VARSTORE_HEADER;
78
79/** The GUID for a variable store using the authenticated variable header format. */
80#define EFI_VARSTORE_HEADER_GUID_AUTHENTICATED_VARIABLE \
81 { 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }
82/** The GUID for a variable store using the standard variable header format. */
83#define EFI_VARSTORE_HEADER_GUID_VARIABLE \
84 { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d } }
85
86/** The EFI_VARSTORE_HEADER::bFmt value when the store region is formatted. */
87#define EFI_VARSTORE_HEADER_FMT_FORMATTED 0x5a
88/** The EFI_VARSTORE_HEADER::bState value when the store region is healthy. */
89#define EFI_VARSTORE_HEADER_STATE_HEALTHY 0xfe
90
91
92/**
93 * Authenticated variable header.
94 */
95#pragma pack(1)
96typedef struct EFI_AUTH_VAR_HEADER
97{
98 /** Contains EFI_AUTH_VAR_HEADER_START to identify the start of a new variable header. */
99 uint16_t u16StartId;
100 /** Variable state. */
101 uint8_t bState;
102 /** Reserved. */
103 uint8_t bRsvd;
104 /** Variable attributes. */
105 uint32_t fAttr;
106 /** Monotonic counter value increased with each change to protect against replay attacks. */
107 uint64_t cMonotonic;
108 /** Timestamp value to protect against replay attacks. */
109 EFI_TIME Timestamp;
110 /** Index of associated public key in database. */
111 uint32_t idPubKey;
112 /** Size of the variable zero terminated unicode name in bytes. */
113 uint32_t cbName;
114 /** Size of the variable data without this header. */
115 uint32_t cbData;
116 /** Producer/Consumer GUID for this variable. */
117 EFI_GUID GuidVendor;
118} EFI_AUTH_VAR_HEADER;
119#pragma pack()
120AssertCompileSize(EFI_AUTH_VAR_HEADER, 60);
121/** Pointer to a authenticated variable header. */
122typedef EFI_AUTH_VAR_HEADER *PEFI_AUTH_VAR_HEADER;
123/** Pointer to a const authenticated variable header. */
124typedef const EFI_AUTH_VAR_HEADER *PCEFI_AUTH_VAR_HEADER;
125
126/** Value in EFI_AUTH_VAR_HEADER::u16StartId for a valid variable header. */
127#define EFI_AUTH_VAR_HEADER_START 0x55aa
128/** @name Possible variable states.
129 * @{ */
130/** Variable is in the process of being deleted. */
131#define EFI_AUTH_VAR_HEADER_STATE_IN_DELETED_TRANSITION 0xfe
132/** Variable was deleted. */
133#define EFI_AUTH_VAR_HEADER_STATE_DELETED 0xfd
134/** Variable has only a valid header right now. */
135#define EFI_AUTH_VAR_HEADER_STATE_HDR_VALID_ONLY 0x7f
136/** Variable header, name and data are all valid. */
137#define EFI_AUTH_VAR_HEADER_STATE_ADDED 0x3f
138/** @} */
139
140
141/** @name Possible variable attributes.
142 * @{ */
143/** The variable is stored in non volatile memory. */
144#define EFI_VAR_HEADER_ATTR_NON_VOLATILE RT_BIT_32(0)
145/** The variable is accessible by the EFI bootservice stage. */
146#define EFI_VAR_HEADER_ATTR_BOOTSERVICE_ACCESS RT_BIT_32(1)
147/** The variable is accessible during runtime. */
148#define EFI_VAR_HEADER_ATTR_RUNTIME_ACCESS RT_BIT_32(2)
149/** The variable contains an hardware error record. */
150#define EFI_VAR_HEADER_ATTR_HW_ERROR_RECORD RT_BIT_32(3)
151/** The variable can be modified only by an authenticated source. */
152#define EFI_AUTH_VAR_HEADER_ATTR_AUTH_WRITE_ACCESS RT_BIT_32(4)
153/** The variable was written with a time based authentication. */
154#define EFI_AUTH_VAR_HEADER_ATTR_TIME_BASED_AUTH_WRITE_ACCESS RT_BIT_32(5)
155/** The variable can be appended. */
156#define EFI_AUTH_VAR_HEADER_ATTR_APPEND_WRITE RT_BIT_32(6)
157/** @} */
158
159#endif /* !IPRT_INCLUDED_formats_efi_varstore_h */
160
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette