[mirror_edk2.git] / MdePkg / Include / Uefi / UefiBaseType.h

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