VirtualBox

source: vbox/trunk/src/VBox/Devices/EFI/DevEFI.h@ 103131

Last change on this file since 103131 was 98131, checked in by vboxsync, 21 months ago

Devices/EFI: Make EFI produce a VMBootFail event if no guest could be booted, disables the EFI Shell as a default boot option (can still be selected from the boot manager), bugref:7249

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.8 KB
Line 
1/* $Id: DevEFI.h 98131 2023-01-19 09:20:54Z vboxsync $ */
2/** @file
3 * EFI for VirtualBox Common Definitions.
4 *
5 * WARNING: This header is used by both firmware and VBox device,
6 * thus don't put anything here but numeric constants or helper
7 * inline functions.
8 */
9
10/*
11 * Copyright (C) 2009-2023 Oracle and/or its affiliates.
12 *
13 * This file is part of VirtualBox base platform packages, as
14 * available from https://www.virtualbox.org.
15 *
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License
18 * as published by the Free Software Foundation, in version 3 of the
19 * License.
20 *
21 * This program is distributed in the hope that it will be useful, but
22 * WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 * General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, see <https://www.gnu.org/licenses>.
28 *
29 * The contents of this file may alternatively be used under the terms
30 * of the Common Development and Distribution License Version 1.0
31 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
32 * in the VirtualBox distribution, in which case the provisions of the
33 * CDDL are applicable instead of those of the GPL.
34 *
35 * You may elect to license modified versions of this file under the
36 * terms and conditions of either the GPL or the CDDL or both.
37 *
38 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
39 */
40
41#ifndef VBOX_INCLUDED_SRC_EFI_DevEFI_h
42#define VBOX_INCLUDED_SRC_EFI_DevEFI_h
43#ifndef RT_WITHOUT_PRAGMA_ONCE
44# pragma once
45#endif
46
47/** @defgroup grp_devefi DevEFI <-> Firmware Interfaces
48 * @{
49 */
50
51/** The base of the I/O ports used for interaction between the EFI firmware and DevEFI. */
52#define EFI_PORT_BASE 0xEF10 /**< @todo r=klaus stupid choice which causes trouble with PCI resource allocation in complex bridge setups, change to 0x0400 with appropriate saved state and reset handling */
53/** The number of ports. */
54#define EFI_PORT_COUNT 0x0008
55
56
57/** Information querying.
58 * 32-bit write sets the info index and resets the reading, see EfiInfoIndex.
59 * 32-bit read returns the size of the info (in bytes).
60 * 8-bit reads returns the info as a byte sequence. */
61#define EFI_INFO_PORT (EFI_PORT_BASE+0x0)
62/**
63 * Information requests.
64 */
65typedef enum
66{
67 EFI_INFO_INDEX_INVALID = 0,
68 EFI_INFO_INDEX_VOLUME_BASE,
69 EFI_INFO_INDEX_VOLUME_SIZE,
70 EFI_INFO_INDEX_TEMPMEM_BASE,
71 EFI_INFO_INDEX_TEMPMEM_SIZE,
72 EFI_INFO_INDEX_STACK_BASE,
73 EFI_INFO_INDEX_STACK_SIZE,
74 EFI_INFO_INDEX_BOOT_ARGS,
75 EFI_INFO_INDEX_DEVICE_PROPS,
76 EFI_INFO_INDEX_FSB_FREQUENCY,
77 EFI_INFO_INDEX_CPU_FREQUENCY,
78 EFI_INFO_INDEX_TSC_FREQUENCY,
79 EFI_INFO_INDEX_GRAPHICS_MODE,
80 EFI_INFO_INDEX_HORIZONTAL_RESOLUTION,
81 EFI_INFO_INDEX_VERTICAL_RESOLUTION,
82 EFI_INFO_INDEX_MCFG_BASE,
83 EFI_INFO_INDEX_MCFG_SIZE,
84 EFI_INFO_INDEX_APIC_MODE,
85 EFI_INFO_INDEX_CPU_COUNT_CURRENT,
86 EFI_INFO_INDEX_CPU_COUNT_MAX,
87 EFI_INFO_INDEX_END
88} EfiInfoIndex;
89
90/** @name APIC mode defines as returned by EFI_INFO_INDEX_APIC_MODE
91 * @{ */
92#define EFI_APIC_MODE_DISABLED 0
93#define EFI_APIC_MODE_APIC 1
94#define EFI_APIC_MODE_X2APIC 2
95/** @} */
96
97/** Panic port.
98 * Write causes action to be taken according to the value written,
99 * see the EFI_PANIC_CMD_* defines below.
100 * Reading from the port has no effect. */
101#define EFI_PANIC_PORT (EFI_PORT_BASE+0x1)
102
103/** @defgroup grp_devefi_panic_cmd Panic Commands for EFI_PANIC_PORT
104 * @{ */
105/** Used by the EfiThunk.asm to signal ORG inconsistency. */
106#define EFI_PANIC_CMD_BAD_ORG 1
107/** Used by the EfiThunk.asm to signal unexpected trap or interrupt. */
108#define EFI_PANIC_CMD_THUNK_TRAP 2
109/** Starts a panic message.
110 * Makes sure the panic message buffer is empty. */
111#define EFI_PANIC_CMD_START_MSG 3
112/** Ends a panic message and enters guru meditation state. */
113#define EFI_PANIC_CMD_END_MSG 4
114/** The first panic message command.
115 * The low byte of the command is the char to be added to the panic message. */
116#define EFI_PANIC_CMD_MSG_FIRST 0x4201
117/** The last panic message command. */
118#define EFI_PANIC_CMD_MSG_LAST 0x427f
119/** Makes a panic message command from a char. */
120#define EFI_PANIC_CMD_MSG_FROM_CHAR(ch) (0x4200 | ((ch) & 0x7f) )
121/** Extracts the char from a panic message command. */
122#define EFI_PANIC_CMD_MSG_GET_CHAR(u32) ((u32) & 0x7f)
123/** @} */
124
125/** EFI event signalling.
126 * A 16-bit event identifier is written first.
127 * It might follow a number of writes to convey additional data,
128 * the size depends on the event identifier.
129 */
130#define EFI_PORT_EVENT (EFI_PORT_BASE+0x2)
131
132/**
133 * Events.
134 */
135typedef enum EFI_EVENT_TYPE
136{
137 /** Invalid event id. */
138 EFI_EVENT_TYPE_INVALID = 0,
139 /** Booting any guest OS failed. */
140 EFI_EVENT_TYPE_BOOT_FAILED,
141 /** 32bit blow up hack. */
142 EFI_EVENT_TYPE_16_BIT_HACK = 0x7fff
143} EFI_EVENT_TYPE;
144
145
146/** Debug logging.
147 * The chars written goes to the log.
148 * Reading has no effect.
149 * @remarks The port number is the same as on of those used by the PC BIOS. */
150#define EFI_DEBUG_PORT (EFI_PORT_BASE+0x3)
151
152#define VBOX_EFI_DEBUG_BUFFER 512
153/** The top of the EFI stack.
154 * The firmware expects a 128KB stack.
155 * @todo Move this to 1MB + 128KB and drop the stack relocation the firmware
156 * does. It expects the stack to be within the temporary memory that
157 * SEC hands to PEI and the VBoxAutoScan PEIM reports. */
158#define VBOX_EFI_TOP_OF_STACK 0x300000
159
160#define EFI_PORT_VARIABLE_OP (EFI_PORT_BASE+0x4)
161#define EFI_PORT_VARIABLE_PARAM (EFI_PORT_BASE+0x5)
162
163#define EFI_VARIABLE_OP_QUERY 0xdead0001
164#define EFI_VARIABLE_OP_QUERY_NEXT 0xdead0002
165#define EFI_VARIABLE_OP_QUERY_REWIND 0xdead0003
166#define EFI_VARIABLE_OP_ADD 0xdead0010
167
168#define EFI_VARIABLE_OP_STATUS_OK 0xcafe0000
169#define EFI_VARIABLE_OP_STATUS_ERROR 0xcafe0001
170#define EFI_VARIABLE_OP_STATUS_NOT_FOUND 0xcafe0002
171#define EFI_VARIABLE_OP_STATUS_WP 0xcafe0003
172#define EFI_VARIABLE_OP_STATUS_BSY 0xcafe0010
173
174/** The max number of variables allowed. */
175#define EFI_VARIABLE_MAX 128
176/** The max variable name length (in bytes, including the zero terminator). */
177#define EFI_VARIABLE_NAME_MAX 1024
178/** The max value length (in bytes). */
179#define EFI_VARIABLE_VALUE_MAX 1024
180
181typedef enum
182{
183 EFI_VM_VARIABLE_OP_START = 0,
184 EFI_VM_VARIABLE_OP_RESERVED_USED_TO_BE_END,
185 EFI_VM_VARIABLE_OP_RESERVED_USED_TO_BE_INDEX,
186 EFI_VM_VARIABLE_OP_GUID,
187 EFI_VM_VARIABLE_OP_ATTRIBUTE,
188 EFI_VM_VARIABLE_OP_NAME,
189 EFI_VM_VARIABLE_OP_NAME_LENGTH,
190 EFI_VM_VARIABLE_OP_VALUE,
191 EFI_VM_VARIABLE_OP_VALUE_LENGTH,
192 EFI_VM_VARIABLE_OP_ERROR,
193 EFI_VM_VARIABLE_OP_NAME_UTF16,
194 EFI_VM_VARIABLE_OP_NAME_LENGTH_UTF16,
195 EFI_VM_VARIABLE_OP_MAX,
196 EFI_VM_VARIABLE_OP_32BIT_HACK = 0x7fffffff
197} EFIVAROP;
198
199
200/** Debug point. */
201#define EFI_PORT_DEBUG_POINT (EFI_PORT_BASE + 0x6)
202
203/**
204 * EFI debug points.
205 */
206typedef enum EFIDBGPOINT
207{
208 /** Invalid. */
209 EFIDBGPOINT_INVALID = 0,
210 /** DEBUG_AGENT_INIT_PREMEM_SEC. */
211 EFIDBGPOINT_SEC_PREMEM = 1,
212 /** DEBUG_AGENT_INIT_POST_SEC. */
213 EFIDBGPOINT_SEC_POSTMEM,
214 /** DEBUG_AGENT_INIT_DXE_CORE. */
215 EFIDBGPOINT_DXE_CORE,
216 /** DEBUG_AGENT_INIT_. */
217 EFIDBGPOINT_SMM,
218 /** DEBUG_AGENT_INIT_ENTER_SMI. */
219 EFIDBGPOINT_SMI_ENTER,
220 /** DEBUG_AGENT_INIT_EXIT_SMI. */
221 EFIDBGPOINT_SMI_EXIT,
222 /** DEBUG_AGENT_INIT_S3. */
223 EFIDBGPOINT_GRAPHICS,
224 /** DEBUG_AGENT_INIT_DXE_AP. */
225 EFIDBGPOINT_DXE_AP,
226 /** End of valid points. */
227 EFIDBGPOINT_END,
228 /** Blow up the type to 32-bits. */
229 EFIDBGPOINT_32BIT_HACK = 0x7fffffff
230} EFIDBGPOINT;
231
232
233/** EFI image load or unload event. All writes are 32-bit writes. */
234#define EFI_PORT_IMAGE_EVENT (EFI_PORT_BASE + 0x7)
235
236/** @defgroup grp_devefi_image_evt EFI Image Events (EFI_PORT_IMAGE_EVENT).
237 *
238 * The lower 8-bit of the values written to EFI_PORT_IMAGE_EVENT can be seen as
239 * the command. The start and complete commands does not have any additional
240 * payload. The other commands uses bit 8 thru 23 or 8 thru 15 to pass a value.
241 *
242 * @{ */
243
244/** The command mask. */
245#define EFI_IMAGE_EVT_CMD_MASK UINT32_C(0x000000ff)
246/** Get the payload value. */
247#define EFI_IMAGE_EVT_GET_PAYLOAD(a_u32) ((a_u32) >> 8)
248/** Get the payload value as unsigned 16-bit. */
249#define EFI_IMAGE_EVT_GET_PAYLOAD_U16(a_u32) ( EFI_IMAGE_EVT_GET_PAYLOAD(a_u32) & UINT16_MAX )
250/** Get the payload value as unsigned 8-bit. */
251#define EFI_IMAGE_EVT_GET_PAYLOAD_U8(a_u32) ( EFI_IMAGE_EVT_GET_PAYLOAD(a_u32) & UINT8_MAX )
252/** Combines a command and a payload value. */
253#define EFI_IMAGE_EVT_MAKE(a_uCmd, a_uPayload) ( ((a_uCmd) & UINT32_C(0xff)) | (uint32_t)((a_uPayload) << 8) )
254
255/** Invalid. */
256#define EFI_IMAGE_EVT_CMD_INVALID UINT32_C(0x00000000)
257/** The event is complete. */
258#define EFI_IMAGE_EVT_CMD_COMPLETE UINT32_C(0x00000001)
259/** Starts a 32-bit load event. Requires name and address, size is optional. */
260#define EFI_IMAGE_EVT_CMD_START_LOAD32 UINT32_C(0x00000002)
261/** Starts a 64-bit load event. Requires name and address, size is optional. */
262#define EFI_IMAGE_EVT_CMD_START_LOAD64 UINT32_C(0x00000003)
263/** Starts a 32-bit unload event. Requires name and address. */
264#define EFI_IMAGE_EVT_CMD_START_UNLOAD32 UINT32_C(0x00000004)
265/** Starts a 64-bit unload event. Requires name and address. */
266#define EFI_IMAGE_EVT_CMD_START_UNLOAD64 UINT32_C(0x00000005)
267/** Starts a 32-bit relocation event. RRequires new and old base address. */
268#define EFI_IMAGE_EVT_CMD_START_RELOC32 UINT32_C(0x0000000A)
269/** Starts a 64-bit relocation event. Requires new and old base address. */
270#define EFI_IMAGE_EVT_CMD_START_RELOC64 UINT32_C(0x0000000B)
271
272/** The command for writing to the second address register (64-bit).
273 * Takes a 16-bit payload value. The register value is shifted 16-bits
274 * to the left and then the payload is ORed in. */
275#define EFI_IMAGE_EVT_CMD_ADDR0 UINT32_C(0x00000006)
276/** The command for writing to the second address register (64-bit).
277 * Takes a 16-bit payload value. The register value is shifted 16-bits
278 * to the left and then the payload is ORed in. */
279#define EFI_IMAGE_EVT_CMD_ADDR1 UINT32_C(0x00000007)
280/** The command for writing to the first size register (64-bit).
281 * Takes a 16-bit payload value. The register value is shifted 16-bits
282 * to the left and then the payload is ORed in. */
283#define EFI_IMAGE_EVT_CMD_SIZE0 UINT32_C(0x00000008)
284/** The command for appending a character to the module name.
285 * Takes a 7-bit payload value that. The value is appended to the field if
286 * there is room. */
287#define EFI_IMAGE_EVT_CMD_NAME UINT32_C(0x00000009)
288
289/** @} */
290
291
292/** @} */
293
294#endif /* !VBOX_INCLUDED_SRC_EFI_DevEFI_h */
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