]> git.proxmox.com Git - mirror_edk2.git/blame - MdePkg/Include/Uefi/UefiBaseType.h
MdePkg/Include: RISC-V definitions.
[mirror_edk2.git] / MdePkg / Include / Uefi / UefiBaseType.h
CommitLineData
c311f86b 1/** @file\r
959ccb23 2 Defines data types and constants introduced in UEFI.\r
3\r
9095d37b 4Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
10a3840f 5Portions copyright (c) 2011 - 2016, ARM Ltd. All rights reserved.<BR>\r
d3abb40d 6Copyright (c) 2020, Hewlett Packard Enterprise Development LP. All rights reserved.<BR>\r
b4319afb 7\r
9344f092 8SPDX-License-Identifier: BSD-2-Clause-Patent\r
959ccb23 9\r
10**/\r
11\r
12#ifndef __UEFI_BASETYPE_H__\r
13#define __UEFI_BASETYPE_H__\r
14\r
a0f1b047 15#include <Base.h>\r
959ccb23 16\r
e0c047a0 17//\r
eaad1319 18// Basic data type definitions introduced in UEFI.\r
e0c047a0 19//\r
20\r
21///\r
22/// 128-bit buffer containing a unique identifier value.\r
8b13229b 23///\r
00edb218 24typedef GUID EFI_GUID;\r
3f748e52 25///\r
af2dc6a7 26/// Function return status for EFI API.\r
3f748e52 27///\r
00edb218 28typedef RETURN_STATUS EFI_STATUS;\r
e0c047a0 29///\r
30/// A collection of related interfaces.\r
31///\r
00edb218 32typedef VOID *EFI_HANDLE;\r
e0c047a0 33///\r
34/// Handle to an event structure.\r
35///\r
00edb218 36typedef VOID *EFI_EVENT;\r
e0c047a0 37///\r
38/// Task priority level.\r
39///\r
00edb218 40typedef UINTN EFI_TPL;\r
e0c047a0 41///\r
42/// Logical block address.\r
43///\r
00edb218 44typedef UINT64 EFI_LBA;\r
6617fcc2 45\r
46///\r
47/// 64-bit physical memory address.\r
48///\r
00edb218 49typedef UINT64 EFI_PHYSICAL_ADDRESS;\r
6617fcc2 50\r
51///\r
52/// 64-bit virtual memory address.\r
53///\r
00edb218 54typedef UINT64 EFI_VIRTUAL_ADDRESS;\r
959ccb23 55\r
fb5148a0 56///\r
57/// EFI Time Abstraction:\r
e189264e 58/// Year: 1900 - 9999\r
fb5148a0 59/// Month: 1 - 12\r
60/// Day: 1 - 31\r
61/// Hour: 0 - 23\r
62/// Minute: 0 - 59\r
63/// Second: 0 - 59\r
64/// Nanosecond: 0 - 999,999,999\r
65/// TimeZone: -1440 to 1440 or 2047\r
66///\r
959ccb23 67typedef struct {\r
68 UINT16 Year;\r
69 UINT8 Month;\r
70 UINT8 Day;\r
71 UINT8 Hour;\r
72 UINT8 Minute;\r
73 UINT8 Second;\r
74 UINT8 Pad1;\r
75 UINT32 Nanosecond;\r
76 INT16 TimeZone;\r
77 UINT8 Daylight;\r
78 UINT8 Pad2;\r
79} EFI_TIME;\r
80\r
d1f95000 81\r
e0c047a0 82///\r
83/// 4-byte buffer. An IPv4 internet protocol address.\r
84///\r
ab4de5c8 85typedef IPv4_ADDRESS EFI_IPv4_ADDRESS;\r
d1f95000 86\r
e0c047a0 87///\r
af2dc6a7 88/// 16-byte buffer. An IPv6 internet protocol address.\r
e0c047a0 89///\r
ab4de5c8 90typedef IPv6_ADDRESS EFI_IPv6_ADDRESS;\r
d1f95000 91\r
e0c047a0 92///\r
93/// 32-byte buffer containing a network Media Access Control address.\r
94///\r
d1f95000 95typedef struct {\r
96 UINT8 Addr[32];\r
97} EFI_MAC_ADDRESS;\r
98\r
e0c047a0 99///\r
100/// 16-byte buffer aligned on a 4-byte boundary.\r
101/// An IPv4 or IPv6 internet protocol address.\r
102///\r
d1f95000 103typedef union {\r
104 UINT32 Addr[4];\r
105 EFI_IPv4_ADDRESS v4;\r
106 EFI_IPv6_ADDRESS v6;\r
107} EFI_IP_ADDRESS;\r
108\r
109\r
d674ed53 110///\r
111/// Enumeration of EFI_STATUS.\r
9095d37b
LG
112///@{\r
113#define EFI_SUCCESS RETURN_SUCCESS\r
114#define EFI_LOAD_ERROR RETURN_LOAD_ERROR\r
115#define EFI_INVALID_PARAMETER RETURN_INVALID_PARAMETER\r
116#define EFI_UNSUPPORTED RETURN_UNSUPPORTED\r
117#define EFI_BAD_BUFFER_SIZE RETURN_BAD_BUFFER_SIZE\r
118#define EFI_BUFFER_TOO_SMALL RETURN_BUFFER_TOO_SMALL\r
119#define EFI_NOT_READY RETURN_NOT_READY\r
120#define EFI_DEVICE_ERROR RETURN_DEVICE_ERROR\r
121#define EFI_WRITE_PROTECTED RETURN_WRITE_PROTECTED\r
122#define EFI_OUT_OF_RESOURCES RETURN_OUT_OF_RESOURCES\r
123#define EFI_VOLUME_CORRUPTED RETURN_VOLUME_CORRUPTED\r
124#define EFI_VOLUME_FULL RETURN_VOLUME_FULL\r
125#define EFI_NO_MEDIA RETURN_NO_MEDIA\r
126#define EFI_MEDIA_CHANGED RETURN_MEDIA_CHANGED\r
127#define EFI_NOT_FOUND RETURN_NOT_FOUND\r
128#define EFI_ACCESS_DENIED RETURN_ACCESS_DENIED\r
129#define EFI_NO_RESPONSE RETURN_NO_RESPONSE\r
130#define EFI_NO_MAPPING RETURN_NO_MAPPING\r
131#define EFI_TIMEOUT RETURN_TIMEOUT\r
132#define EFI_NOT_STARTED RETURN_NOT_STARTED\r
133#define EFI_ALREADY_STARTED RETURN_ALREADY_STARTED\r
134#define EFI_ABORTED RETURN_ABORTED\r
135#define EFI_ICMP_ERROR RETURN_ICMP_ERROR\r
136#define EFI_TFTP_ERROR RETURN_TFTP_ERROR\r
137#define EFI_PROTOCOL_ERROR RETURN_PROTOCOL_ERROR\r
138#define EFI_INCOMPATIBLE_VERSION RETURN_INCOMPATIBLE_VERSION\r
139#define EFI_SECURITY_VIOLATION RETURN_SECURITY_VIOLATION\r
140#define EFI_CRC_ERROR RETURN_CRC_ERROR\r
959ccb23 141#define EFI_END_OF_MEDIA RETURN_END_OF_MEDIA\r
142#define EFI_END_OF_FILE RETURN_END_OF_FILE\r
54cf8780 143#define EFI_INVALID_LANGUAGE RETURN_INVALID_LANGUAGE\r
76336e4e 144#define EFI_COMPROMISED_DATA RETURN_COMPROMISED_DATA\r
10a3840f 145#define EFI_HTTP_ERROR RETURN_HTTP_ERROR\r
959ccb23 146\r
9095d37b
LG
147#define EFI_WARN_UNKNOWN_GLYPH RETURN_WARN_UNKNOWN_GLYPH\r
148#define EFI_WARN_DELETE_FAILURE RETURN_WARN_DELETE_FAILURE\r
149#define EFI_WARN_WRITE_FAILURE RETURN_WARN_WRITE_FAILURE\r
959ccb23 150#define EFI_WARN_BUFFER_TOO_SMALL RETURN_WARN_BUFFER_TOO_SMALL\r
76336e4e 151#define EFI_WARN_STALE_DATA RETURN_WARN_STALE_DATA\r
fed5f447 152#define EFI_WARN_FILE_SYSTEM RETURN_WARN_FILE_SYSTEM\r
d674ed53 153///@}\r
959ccb23 154\r
d674ed53 155///\r
156/// Define macro to encode the status code.\r
9095d37b 157///\r
00edb218 158#define EFIERR(_a) ENCODE_ERROR(_a)\r
959ccb23 159\r
160#define EFI_ERROR(A) RETURN_ERROR(A)\r
161\r
d674ed53 162///\r
163/// ICMP error definitions\r
164///@{\r
165#define EFI_NETWORK_UNREACHABLE EFIERR(100)\r
9095d37b 166#define EFI_HOST_UNREACHABLE EFIERR(101)\r
d674ed53 167#define EFI_PROTOCOL_UNREACHABLE EFIERR(102)\r
168#define EFI_PORT_UNREACHABLE EFIERR(103)\r
169///@}\r
959ccb23 170\r
d674ed53 171///\r
172/// Tcp connection status definitions\r
173///@{\r
174#define EFI_CONNECTION_FIN EFIERR(104)\r
175#define EFI_CONNECTION_RESET EFIERR(105)\r
176#define EFI_CONNECTION_REFUSED EFIERR(106)\r
177///@}\r
959ccb23 178\r
179//\r
180// The EFI memory allocation functions work in units of EFI_PAGEs that are\r
b4221611 181// 4KB. This should in no way be confused with the page size of the processor.\r
959ccb23 182// An EFI_PAGE is just the quanta of memory in EFI.\r
183//\r
b4221611 184#define EFI_PAGE_SIZE SIZE_4KB\r
00edb218
A
185#define EFI_PAGE_MASK 0xFFF\r
186#define EFI_PAGE_SHIFT 12\r
959ccb23 187\r
b4221611 188/**\r
189 Macro that converts a size, in bytes, to a number of EFI_PAGESs.\r
190\r
9095d37b
LG
191 @param Size A size in bytes. This parameter is assumed to be type UINTN.\r
192 Passing in a parameter that is larger than UINTN may produce\r
b4221611 193 unexpected results.\r
194\r
195 @return The number of EFI_PAGESs associated with the number of bytes specified\r
196 by Size.\r
197\r
198**/\r
199#define EFI_SIZE_TO_PAGES(Size) (((Size) >> EFI_PAGE_SHIFT) + (((Size) & EFI_PAGE_MASK) ? 1 : 0))\r
200\r
201/**\r
202 Macro that converts a number of EFI_PAGEs to a size in bytes.\r
203\r
9095d37b
LG
204 @param Pages The number of EFI_PAGES. This parameter is assumed to be\r
205 type UINTN. Passing in a parameter that is larger than\r
b4221611 206 UINTN may produce unexpected results.\r
207\r
9095d37b 208 @return The number of bytes associated with the number of EFI_PAGEs specified\r
b4221611 209 by Pages.\r
9095d37b 210\r
b4221611 211**/\r
212#define EFI_PAGES_TO_SIZE(Pages) ((Pages) << EFI_PAGE_SHIFT)\r
959ccb23 213\r
4ab0dff3 214///\r
af2dc6a7 215/// PE32+ Machine type for IA32 UEFI images.\r
4ab0dff3 216///\r
97f8b30c 217#define EFI_IMAGE_MACHINE_IA32 0x014C\r
4ab0dff3 218\r
219///\r
af2dc6a7 220/// PE32+ Machine type for IA64 UEFI images.\r
4ab0dff3 221///\r
97f8b30c 222#define EFI_IMAGE_MACHINE_IA64 0x0200\r
4ab0dff3 223\r
224///\r
af2dc6a7 225/// PE32+ Machine type for EBC UEFI images.\r
4ab0dff3 226///\r
97f8b30c 227#define EFI_IMAGE_MACHINE_EBC 0x0EBC\r
4ab0dff3 228\r
229///\r
af2dc6a7 230/// PE32+ Machine type for X64 UEFI images.\r
4ab0dff3 231///\r
97f8b30c 232#define EFI_IMAGE_MACHINE_X64 0x8664\r
4ab0dff3 233\r
ebd04fc2 234///\r
af2dc6a7 235/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.\r
ebd04fc2 236///\r
237#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED 0x01C2\r
238\r
b4319afb
HL
239///\r
240/// PE32+ Machine type for AARCH64 A64 images.\r
241///\r
242#define EFI_IMAGE_MACHINE_AARCH64 0xAA64\r
243\r
d3abb40d
AC
244///\r
245/// PE32+ Machine type for RISC-V 32/64/128\r
246///\r
247#define EFI_IMAGE_MACHINE_RISCV32 0x5032\r
248#define EFI_IMAGE_MACHINE_RISCV64 0x5064\r
249#define EFI_IMAGE_MACHINE_RISCV128 0x5128\r
4ab0dff3 250\r
251#if defined (MDE_CPU_IA32)\r
252\r
253#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
431390dc 254 ((Machine) == EFI_IMAGE_MACHINE_IA32)\r
4ab0dff3 255\r
9095d37b 256#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64)\r
4ab0dff3 257\r
4ab0dff3 258#elif defined (MDE_CPU_X64)\r
259\r
260#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
431390dc 261 ((Machine) == EFI_IMAGE_MACHINE_X64)\r
4ab0dff3 262\r
9095d37b 263#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)\r
4ab0dff3 264\r
ebd04fc2 265#elif defined (MDE_CPU_ARM)\r
266\r
3b3c009a 267#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED)\r
ebd04fc2 268\r
3b3c009a 269#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)\r
ebd04fc2 270\r
b4319afb
HL
271#elif defined (MDE_CPU_AARCH64)\r
272\r
273#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
431390dc 274 ((Machine) == EFI_IMAGE_MACHINE_AARCH64)\r
b4319afb
HL
275\r
276#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)\r
277\r
d3abb40d
AC
278#elif defined (MDE_CPU_RISCV64)\r
279#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
280 ((Machine) == EFI_IMAGE_MACHINE_RISCV64)\r
281\r
282#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)\r
283\r
4ab0dff3 284#elif defined (MDE_CPU_EBC)\r
285\r
286///\r
eaad1319 287/// This is just to make sure you can cross compile with the EBC compiler.\r
9095d37b 288/// It does not make sense to have a PE loader coded in EBC.\r
4ab0dff3 289///\r
290#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_EBC)\r
291\r
9095d37b 292#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)\r
4ab0dff3 293\r
294#else\r
295#error Unknown Processor Type\r
296#endif\r
f4e8509b 297\r
959ccb23 298#endif\r