]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Uefi/UefiBaseType.h
MdePkg: Add definition for new warning code EFI_WARN_FILE_SYSTEM.
[mirror_edk2.git] / MdePkg / Include / Uefi / UefiBaseType.h
index fb0ac22dbbf2ddddde38de6f8189faee77c471ff..84e4dc65bf7d1e3c051ba9bde3657835ca84f2be 100644 (file)
@@ -1,14 +1,16 @@
 /** @file\r
   Defines data types and constants introduced in UEFI.\r
 \r
-  Copyright (c) 2006 - 2008, 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 - 2016, 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
@@ -18,7 +20,7 @@
 #include <Base.h>\r
 \r
 //\r
-// Basical data type definitions introduced in UEFI.\r
+// Basic data type definitions introduced in UEFI.\r
 //\r
 \r
 ///\r
@@ -26,7 +28,7 @@
 ///\r
 typedef GUID                      EFI_GUID;\r
 ///\r
-/// Function return status for EFI API\r
+/// Function return status for EFI API.\r
 ///\r
 typedef RETURN_STATUS             EFI_STATUS;\r
 ///\r
@@ -58,7 +60,7 @@ typedef UINT64                    EFI_VIRTUAL_ADDRESS;
 \r
 ///\r
 /// EFI Time Abstraction:\r
-///  Year:       1998 - 20XX\r
+///  Year:       1900 - 9999\r
 ///  Month:      1 - 12\r
 ///  Day:        1 - 31\r
 ///  Hour:       0 - 23\r
@@ -90,7 +92,7 @@ typedef struct {
 } EFI_IPv4_ADDRESS;\r
 \r
 ///\r
-/// 16-byte buffer. An IPv6 internet protocol address\r
+/// 16-byte buffer. An IPv6 internet protocol address.\r
 ///\r
 typedef struct {\r
   UINT8 Addr[16];\r
@@ -114,9 +116,9 @@ typedef union {
 } EFI_IP_ADDRESS;\r
 \r
 \r
-//\r
-// Enumeration of EFI_STATUS.\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
@@ -148,65 +150,105 @@ typedef union {
 #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
-//\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
+/// 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
+  @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_PAGES_TO_SIZE(a)   ( (a) << EFI_PAGE_SHIFT)\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
-/// Limited buffer size for a language code recommended by RFC3066\r
-/// (42 characters plus a NULL terminator)\r
+/// PE32+ Machine type for IA32 UEFI images.\r
 ///\r
-#define RFC_3066_ENTRY_SIZE             (42 + 1)\r
+#define EFI_IMAGE_MACHINE_IA32            0x014C\r
 \r
 ///\r
-/// The size of a 3 character ISO639 language code.\r
+/// PE32+ Machine type for IA64 UEFI images.\r
 ///\r
-#define ISO_639_2_ENTRY_SIZE            3\r
+#define EFI_IMAGE_MACHINE_IA64            0x0200\r
 \r
 ///\r
-/// PE32+ Machine type for IA32 UEFI images\r
+/// PE32+ Machine type for EBC UEFI images.\r
 ///\r
-#define EFI_IMAGE_MACHINE_IA32      0x014C\r
+#define EFI_IMAGE_MACHINE_EBC             0x0EBC\r
 \r
 ///\r
-/// PE32+ Machine type for IA64 UEFI images\r
+/// PE32+ Machine type for X64 UEFI images.\r
 ///\r
-#define EFI_IMAGE_MACHINE_IA64      0x0200\r
+#define EFI_IMAGE_MACHINE_X64             0x8664\r
 \r
 ///\r
-/// PE32+ Machine type for EBC UEFI images\r
+/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.\r
 ///\r
-#define EFI_IMAGE_MACHINE_EBC       0x0EBC\r
+#define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED  0x01C2\r
 \r
 ///\r
-/// PE32+ Machine type for X64 UEFI images\r
+/// PE32+ Machine type for AARCH64 A64 images.\r
 ///\r
-#define EFI_IMAGE_MACHINE_X64       0x8664\r
+#define EFI_IMAGE_MACHINE_AARCH64  0xAA64\r
 \r
 \r
 #if   defined (MDE_CPU_IA32)\r
@@ -230,12 +272,25 @@ typedef union {
 \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 compiiler.\r
-/// It does not make sense to have a PE loader coded in EBC. You need to \r
-/// understand the basic \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