| 1 | /* $Id: DevEFI.h 106061 2024-09-16 14:03:52Z 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-2024 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 | */
|
|---|
| 65 | typedef 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_TPM_PPI_BASE,
|
|---|
| 88 | EFI_INFO_INDEX_END
|
|---|
| 89 | } EfiInfoIndex;
|
|---|
| 90 |
|
|---|
| 91 | /** @name APIC mode defines as returned by EFI_INFO_INDEX_APIC_MODE
|
|---|
| 92 | * @{ */
|
|---|
| 93 | #define EFI_APIC_MODE_DISABLED 0
|
|---|
| 94 | #define EFI_APIC_MODE_APIC 1
|
|---|
| 95 | #define EFI_APIC_MODE_X2APIC 2
|
|---|
| 96 | /** @} */
|
|---|
| 97 |
|
|---|
| 98 | /** Panic port.
|
|---|
| 99 | * Write causes action to be taken according to the value written,
|
|---|
| 100 | * see the EFI_PANIC_CMD_* defines below.
|
|---|
| 101 | * Reading from the port has no effect. */
|
|---|
| 102 | #define EFI_PANIC_PORT (EFI_PORT_BASE+0x1)
|
|---|
| 103 |
|
|---|
| 104 | /** @defgroup grp_devefi_panic_cmd Panic Commands for EFI_PANIC_PORT
|
|---|
| 105 | * @{ */
|
|---|
| 106 | /** Used by the EfiThunk.asm to signal ORG inconsistency. */
|
|---|
| 107 | #define EFI_PANIC_CMD_BAD_ORG 1
|
|---|
| 108 | /** Used by the EfiThunk.asm to signal unexpected trap or interrupt. */
|
|---|
| 109 | #define EFI_PANIC_CMD_THUNK_TRAP 2
|
|---|
| 110 | /** Starts a panic message.
|
|---|
| 111 | * Makes sure the panic message buffer is empty. */
|
|---|
| 112 | #define EFI_PANIC_CMD_START_MSG 3
|
|---|
| 113 | /** Ends a panic message and enters guru meditation state. */
|
|---|
| 114 | #define EFI_PANIC_CMD_END_MSG 4
|
|---|
| 115 | /** The first panic message command.
|
|---|
| 116 | * The low byte of the command is the char to be added to the panic message. */
|
|---|
| 117 | #define EFI_PANIC_CMD_MSG_FIRST 0x4201
|
|---|
| 118 | /** The last panic message command. */
|
|---|
| 119 | #define EFI_PANIC_CMD_MSG_LAST 0x427f
|
|---|
| 120 | /** Makes a panic message command from a char. */
|
|---|
| 121 | #define EFI_PANIC_CMD_MSG_FROM_CHAR(ch) (0x4200 | ((ch) & 0x7f) )
|
|---|
| 122 | /** Extracts the char from a panic message command. */
|
|---|
| 123 | #define EFI_PANIC_CMD_MSG_GET_CHAR(u32) ((u32) & 0x7f)
|
|---|
| 124 | /** @} */
|
|---|
| 125 |
|
|---|
| 126 | /** EFI event signalling.
|
|---|
| 127 | * A 16-bit event identifier is written first.
|
|---|
| 128 | * It might follow a number of writes to convey additional data,
|
|---|
| 129 | * the size depends on the event identifier.
|
|---|
| 130 | */
|
|---|
| 131 | #define EFI_PORT_EVENT (EFI_PORT_BASE+0x2)
|
|---|
| 132 |
|
|---|
| 133 | /**
|
|---|
| 134 | * Events.
|
|---|
| 135 | */
|
|---|
| 136 | typedef enum EFI_EVENT_TYPE
|
|---|
| 137 | {
|
|---|
| 138 | /** Invalid event id. */
|
|---|
| 139 | EFI_EVENT_TYPE_INVALID = 0,
|
|---|
| 140 | /** Booting any guest OS failed. */
|
|---|
| 141 | EFI_EVENT_TYPE_BOOT_FAILED,
|
|---|
| 142 | /** 32bit blow up hack. */
|
|---|
| 143 | EFI_EVENT_TYPE_16_BIT_HACK = 0x7fff
|
|---|
| 144 | } EFI_EVENT_TYPE;
|
|---|
| 145 |
|
|---|
| 146 |
|
|---|
| 147 | /** Debug logging.
|
|---|
| 148 | * The chars written goes to the log.
|
|---|
| 149 | * Reading has no effect.
|
|---|
| 150 | * @remarks The port number is the same as on of those used by the PC BIOS. */
|
|---|
| 151 | #define EFI_DEBUG_PORT (EFI_PORT_BASE+0x3)
|
|---|
| 152 |
|
|---|
| 153 | #define VBOX_EFI_DEBUG_BUFFER 512
|
|---|
| 154 | /** The top of the EFI stack.
|
|---|
| 155 | * The firmware expects a 128KB stack.
|
|---|
| 156 | * @todo Move this to 1MB + 128KB and drop the stack relocation the firmware
|
|---|
| 157 | * does. It expects the stack to be within the temporary memory that
|
|---|
| 158 | * SEC hands to PEI and the VBoxAutoScan PEIM reports. */
|
|---|
| 159 | #define VBOX_EFI_TOP_OF_STACK 0x300000
|
|---|
| 160 |
|
|---|
| 161 | #define EFI_PORT_VARIABLE_OP (EFI_PORT_BASE+0x4)
|
|---|
| 162 | #define EFI_PORT_VARIABLE_PARAM (EFI_PORT_BASE+0x5)
|
|---|
| 163 |
|
|---|
| 164 | #define EFI_VARIABLE_OP_QUERY 0xdead0001
|
|---|
| 165 | #define EFI_VARIABLE_OP_QUERY_NEXT 0xdead0002
|
|---|
| 166 | #define EFI_VARIABLE_OP_QUERY_REWIND 0xdead0003
|
|---|
| 167 | #define EFI_VARIABLE_OP_ADD 0xdead0010
|
|---|
| 168 |
|
|---|
| 169 | #define EFI_VARIABLE_OP_STATUS_OK 0xcafe0000
|
|---|
| 170 | #define EFI_VARIABLE_OP_STATUS_ERROR 0xcafe0001
|
|---|
| 171 | #define EFI_VARIABLE_OP_STATUS_NOT_FOUND 0xcafe0002
|
|---|
| 172 | #define EFI_VARIABLE_OP_STATUS_WP 0xcafe0003
|
|---|
| 173 | #define EFI_VARIABLE_OP_STATUS_BSY 0xcafe0010
|
|---|
| 174 |
|
|---|
| 175 | /** The max number of variables allowed. */
|
|---|
| 176 | #define EFI_VARIABLE_MAX 128
|
|---|
| 177 | /** The max variable name length (in bytes, including the zero terminator). */
|
|---|
| 178 | #define EFI_VARIABLE_NAME_MAX 1024
|
|---|
| 179 | /** The max value length (in bytes). */
|
|---|
| 180 | #define EFI_VARIABLE_VALUE_MAX 1024
|
|---|
| 181 |
|
|---|
| 182 | typedef enum
|
|---|
| 183 | {
|
|---|
| 184 | EFI_VM_VARIABLE_OP_START = 0,
|
|---|
| 185 | EFI_VM_VARIABLE_OP_RESERVED_USED_TO_BE_END,
|
|---|
| 186 | EFI_VM_VARIABLE_OP_RESERVED_USED_TO_BE_INDEX,
|
|---|
| 187 | EFI_VM_VARIABLE_OP_GUID,
|
|---|
| 188 | EFI_VM_VARIABLE_OP_ATTRIBUTE,
|
|---|
| 189 | EFI_VM_VARIABLE_OP_NAME,
|
|---|
| 190 | EFI_VM_VARIABLE_OP_NAME_LENGTH,
|
|---|
| 191 | EFI_VM_VARIABLE_OP_VALUE,
|
|---|
| 192 | EFI_VM_VARIABLE_OP_VALUE_LENGTH,
|
|---|
| 193 | EFI_VM_VARIABLE_OP_ERROR,
|
|---|
| 194 | EFI_VM_VARIABLE_OP_NAME_UTF16,
|
|---|
| 195 | EFI_VM_VARIABLE_OP_NAME_LENGTH_UTF16,
|
|---|
| 196 | EFI_VM_VARIABLE_OP_MAX,
|
|---|
| 197 | EFI_VM_VARIABLE_OP_32BIT_HACK = 0x7fffffff
|
|---|
| 198 | } EFIVAROP;
|
|---|
| 199 |
|
|---|
| 200 |
|
|---|
| 201 | /** Debug point. */
|
|---|
| 202 | #define EFI_PORT_DEBUG_POINT (EFI_PORT_BASE + 0x6)
|
|---|
| 203 |
|
|---|
| 204 | /**
|
|---|
| 205 | * EFI debug points.
|
|---|
| 206 | */
|
|---|
| 207 | typedef enum EFIDBGPOINT
|
|---|
| 208 | {
|
|---|
| 209 | /** Invalid. */
|
|---|
| 210 | EFIDBGPOINT_INVALID = 0,
|
|---|
| 211 | /** DEBUG_AGENT_INIT_PREMEM_SEC. */
|
|---|
| 212 | EFIDBGPOINT_SEC_PREMEM = 1,
|
|---|
| 213 | /** DEBUG_AGENT_INIT_POST_SEC. */
|
|---|
| 214 | EFIDBGPOINT_SEC_POSTMEM,
|
|---|
| 215 | /** DEBUG_AGENT_INIT_DXE_CORE. */
|
|---|
| 216 | EFIDBGPOINT_DXE_CORE,
|
|---|
| 217 | /** DEBUG_AGENT_INIT_. */
|
|---|
| 218 | EFIDBGPOINT_SMM,
|
|---|
| 219 | /** DEBUG_AGENT_INIT_ENTER_SMI. */
|
|---|
| 220 | EFIDBGPOINT_SMI_ENTER,
|
|---|
| 221 | /** DEBUG_AGENT_INIT_EXIT_SMI. */
|
|---|
| 222 | EFIDBGPOINT_SMI_EXIT,
|
|---|
| 223 | /** DEBUG_AGENT_INIT_S3. */
|
|---|
| 224 | EFIDBGPOINT_GRAPHICS,
|
|---|
| 225 | /** DEBUG_AGENT_INIT_DXE_AP. */
|
|---|
| 226 | EFIDBGPOINT_DXE_AP,
|
|---|
| 227 | /** End of valid points. */
|
|---|
| 228 | EFIDBGPOINT_END,
|
|---|
| 229 | /** Blow up the type to 32-bits. */
|
|---|
| 230 | EFIDBGPOINT_32BIT_HACK = 0x7fffffff
|
|---|
| 231 | } EFIDBGPOINT;
|
|---|
| 232 |
|
|---|
| 233 |
|
|---|
| 234 | /** EFI image load or unload event. All writes are 32-bit writes. */
|
|---|
| 235 | #define EFI_PORT_IMAGE_EVENT (EFI_PORT_BASE + 0x7)
|
|---|
| 236 |
|
|---|
| 237 | /** @defgroup grp_devefi_image_evt EFI Image Events (EFI_PORT_IMAGE_EVENT).
|
|---|
| 238 | *
|
|---|
| 239 | * The lower 8-bit of the values written to EFI_PORT_IMAGE_EVENT can be seen as
|
|---|
| 240 | * the command. The start and complete commands does not have any additional
|
|---|
| 241 | * payload. The other commands uses bit 8 thru 23 or 8 thru 15 to pass a value.
|
|---|
| 242 | *
|
|---|
| 243 | * @{ */
|
|---|
| 244 |
|
|---|
| 245 | /** The command mask. */
|
|---|
| 246 | #define EFI_IMAGE_EVT_CMD_MASK UINT32_C(0x000000ff)
|
|---|
| 247 | /** Get the payload value. */
|
|---|
| 248 | #define EFI_IMAGE_EVT_GET_PAYLOAD(a_u32) ((a_u32) >> 8)
|
|---|
| 249 | /** Get the payload value as unsigned 16-bit. */
|
|---|
| 250 | #define EFI_IMAGE_EVT_GET_PAYLOAD_U16(a_u32) ( EFI_IMAGE_EVT_GET_PAYLOAD(a_u32) & UINT16_MAX )
|
|---|
| 251 | /** Get the payload value as unsigned 8-bit. */
|
|---|
| 252 | #define EFI_IMAGE_EVT_GET_PAYLOAD_U8(a_u32) ( EFI_IMAGE_EVT_GET_PAYLOAD(a_u32) & UINT8_MAX )
|
|---|
| 253 | /** Combines a command and a payload value. */
|
|---|
| 254 | #define EFI_IMAGE_EVT_MAKE(a_uCmd, a_uPayload) ( ((a_uCmd) & UINT32_C(0xff)) | (uint32_t)((a_uPayload) << 8) )
|
|---|
| 255 |
|
|---|
| 256 | /** Invalid. */
|
|---|
| 257 | #define EFI_IMAGE_EVT_CMD_INVALID UINT32_C(0x00000000)
|
|---|
| 258 | /** The event is complete. */
|
|---|
| 259 | #define EFI_IMAGE_EVT_CMD_COMPLETE UINT32_C(0x00000001)
|
|---|
| 260 | /** Starts a 32-bit load event. Requires name and address, size is optional. */
|
|---|
| 261 | #define EFI_IMAGE_EVT_CMD_START_LOAD32 UINT32_C(0x00000002)
|
|---|
| 262 | /** Starts a 64-bit load event. Requires name and address, size is optional. */
|
|---|
| 263 | #define EFI_IMAGE_EVT_CMD_START_LOAD64 UINT32_C(0x00000003)
|
|---|
| 264 | /** Starts a 32-bit unload event. Requires name and address. */
|
|---|
| 265 | #define EFI_IMAGE_EVT_CMD_START_UNLOAD32 UINT32_C(0x00000004)
|
|---|
| 266 | /** Starts a 64-bit unload event. Requires name and address. */
|
|---|
| 267 | #define EFI_IMAGE_EVT_CMD_START_UNLOAD64 UINT32_C(0x00000005)
|
|---|
| 268 | /** Starts a 32-bit relocation event. RRequires new and old base address. */
|
|---|
| 269 | #define EFI_IMAGE_EVT_CMD_START_RELOC32 UINT32_C(0x0000000A)
|
|---|
| 270 | /** Starts a 64-bit relocation event. Requires new and old base address. */
|
|---|
| 271 | #define EFI_IMAGE_EVT_CMD_START_RELOC64 UINT32_C(0x0000000B)
|
|---|
| 272 |
|
|---|
| 273 | /** The command for writing to the second address register (64-bit).
|
|---|
| 274 | * Takes a 16-bit payload value. The register value is shifted 16-bits
|
|---|
| 275 | * to the left and then the payload is ORed in. */
|
|---|
| 276 | #define EFI_IMAGE_EVT_CMD_ADDR0 UINT32_C(0x00000006)
|
|---|
| 277 | /** The command for writing to the second address register (64-bit).
|
|---|
| 278 | * Takes a 16-bit payload value. The register value is shifted 16-bits
|
|---|
| 279 | * to the left and then the payload is ORed in. */
|
|---|
| 280 | #define EFI_IMAGE_EVT_CMD_ADDR1 UINT32_C(0x00000007)
|
|---|
| 281 | /** The command for writing to the first size register (64-bit).
|
|---|
| 282 | * Takes a 16-bit payload value. The register value is shifted 16-bits
|
|---|
| 283 | * to the left and then the payload is ORed in. */
|
|---|
| 284 | #define EFI_IMAGE_EVT_CMD_SIZE0 UINT32_C(0x00000008)
|
|---|
| 285 | /** The command for appending a character to the module name.
|
|---|
| 286 | * Takes a 7-bit payload value that. The value is appended to the field if
|
|---|
| 287 | * there is room. */
|
|---|
| 288 | #define EFI_IMAGE_EVT_CMD_NAME UINT32_C(0x00000009)
|
|---|
| 289 |
|
|---|
| 290 | /** @} */
|
|---|
| 291 |
|
|---|
| 292 |
|
|---|
| 293 | /** @} */
|
|---|
| 294 |
|
|---|
| 295 | #endif /* !VBOX_INCLUDED_SRC_EFI_DevEFI_h */
|
|---|
