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