VirtualBox

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

Last change on this file since 65532 was 62500, checked in by vboxsync, 8 years ago

(C) 2016

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