/** @file\r
-\r
Defines data types and constants introduced in UEFI.\r
\r
- Copyright (c) 2006 - 2007, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
- are licensed and made available under the terms and conditions of the BSD License\r
- which accompanies this distribution. 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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+Portions copyright (c) 2011 - 2016, ARM Ltd. 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
+#include <Base.h>\r
\r
//\r
-// Basical data type definitions introduced in UEFI.\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
+///\r
+/// Handle to an event structure.\r
+///\r
typedef VOID *EFI_EVENT;\r
-\r
+///\r
+/// Task priority level.\r
+///\r
typedef UINTN EFI_TPL;\r
-\r
-\r
+///\r
+/// Logical block address.\r
+///\r
typedef UINT64 EFI_LBA;\r
\r
-\r
-typedef UINT16 STRING_REF;\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: 2000 - 20XX\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
+///\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
} EFI_TIME;\r
\r
\r
-//\r
-// Networking Definitions\r
-//\r
-typedef struct {\r
- UINT8 Addr[4];\r
-} EFI_IPv4_ADDRESS;\r
+///\r
+/// 4-byte buffer. An IPv4 internet protocol address.\r
+///\r
+typedef IPv4_ADDRESS EFI_IPv4_ADDRESS;\r
\r
-typedef struct {\r
- UINT8 Addr[16];\r
-} EFI_IPv6_ADDRESS;\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_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
+///\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_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 NULL_HANDLE ((VOID *) 0)\r
-\r
-//\r
-// Define macro to encode the status code.\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
-// Define macros to build data structure signatures from characters.\r
-//\r
-#define EFI_SIGNATURE_16(A, B) ((A) | (B << 8))\r
-#define EFI_SIGNATURE_32(A, B, C, D) (EFI_SIGNATURE_16 (A, B) | (EFI_SIGNATURE_16 (C, D) << 16))\r
-#define EFI_SIGNATURE_64(A, B, C, D, E, F, G, H) \\r
- (EFI_SIGNATURE_32 (A, B, C, D) | ((UINT64) (EFI_SIGNATURE_32 (E, F, G, H)) << 32))\r
-\r
-\r
-//\r
-// Returns the byte offset to a field within a structure\r
-//\r
-#define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))\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
-// 4K. This should in no way be confused with the page size of the processor.\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 0x1000\r
+#define EFI_PAGE_SIZE SIZE_4KB\r
#define EFI_PAGE_MASK 0xFFF\r
#define EFI_PAGE_SHIFT 12\r
\r
-#define EFI_SIZE_TO_PAGES(a) (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))\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
-#define EFI_PAGES_TO_SIZE(a) ( (a) << EFI_PAGE_SHIFT)\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
-#define EFI_MAX_BIT MAX_BIT\r
-#define EFI_MAX_ADDRESS MAX_ADDRESS\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)\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_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
projects / mirror_edk2.git / blobdiff