VirtualBox

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

Last change on this file since 78339 was 76565, checked in by vboxsync, 6 years ago

Devices: Use VBOX_INCLUDED_SRC_ as header guard prefix with scm.

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