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

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