]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Uefi/UefiBaseType.h
UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm
[mirror_edk2.git] / MdePkg / Include / Uefi / UefiBaseType.h
index e24168fb51d749d9e413c57135aeaae122975f59..83975a08eb4c2faf31787af26db51d8edfe4bbff 100644 (file)
@@ -1,14 +1,12 @@
 /** @file\r
   Defines data types and constants introduced in UEFI.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\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
+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
@@ -24,37 +22,37 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 ///\r
 /// 128-bit buffer containing a unique identifier value.\r
 ///\r
-typedef GUID                      EFI_GUID;\r
+typedef GUID EFI_GUID;\r
 ///\r
 /// Function return status for EFI API.\r
 ///\r
-typedef RETURN_STATUS             EFI_STATUS;\r
+typedef RETURN_STATUS EFI_STATUS;\r
 ///\r
 /// A collection of related interfaces.\r
 ///\r
-typedef VOID                      *EFI_HANDLE;\r
+typedef VOID *EFI_HANDLE;\r
 ///\r
 /// Handle to an event structure.\r
 ///\r
-typedef VOID                      *EFI_EVENT;\r
+typedef VOID *EFI_EVENT;\r
 ///\r
 /// Task priority level.\r
 ///\r
-typedef UINTN                     EFI_TPL;\r
+typedef UINTN EFI_TPL;\r
 ///\r
 /// Logical block address.\r
 ///\r
-typedef UINT64                    EFI_LBA;\r
+typedef UINT64 EFI_LBA;\r
 \r
 ///\r
 /// 64-bit physical memory address.\r
 ///\r
-typedef UINT64                    EFI_PHYSICAL_ADDRESS;\r
+typedef UINT64 EFI_PHYSICAL_ADDRESS;\r
 \r
 ///\r
 /// 64-bit virtual memory address.\r
 ///\r
-typedef UINT64                    EFI_VIRTUAL_ADDRESS;\r
+typedef UINT64 EFI_VIRTUAL_ADDRESS;\r
 \r
 ///\r
 /// EFI Time Abstraction:\r
@@ -68,39 +66,34 @@ typedef UINT64                    EFI_VIRTUAL_ADDRESS;
 ///  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
+  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
+typedef IPv4_ADDRESS 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
+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
+  UINT8    Addr[32];\r
 } EFI_MAC_ADDRESS;\r
 \r
 ///\r
@@ -108,65 +101,68 @@ typedef struct {
 /// 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
+  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
+///@{\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
-\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_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 EFIERR(_a)  ENCODE_ERROR(_a)\r
 \r
-#define EFI_ERROR(A)              RETURN_ERROR(A)\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_HOST_UNREACHABLE      EFIERR(101)\r
 #define EFI_PROTOCOL_UNREACHABLE  EFIERR(102)\r
 #define EFI_PORT_UNREACHABLE      EFIERR(103)\r
 ///@}\r
@@ -174,9 +170,9 @@ typedef union {
 ///\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
+#define EFI_CONNECTION_FIN      EFIERR(104)\r
+#define EFI_CONNECTION_RESET    EFIERR(105)\r
+#define EFI_CONNECTION_REFUSED  EFIERR(106)\r
 ///@}\r
 \r
 //\r
@@ -184,15 +180,15 @@ typedef union {
 // 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
+#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
+  @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
@@ -204,82 +200,124 @@ typedef union {
 /**\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
+  @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
+  @return  The number of bytes associated with the number of EFI_PAGEs specified\r
            by Pages.\r
-  \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
+#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
+#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
+#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
+#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
-#if   defined (MDE_CPU_IA32)\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) || ((Machine) == EFI_IMAGE_MACHINE_EBC))\r
+  ((Machine) == EFI_IMAGE_MACHINE_IA32)\r
 \r
-#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_X64) \r
+#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_X64)\r
 \r
-#elif defined (MDE_CPU_IPF)\r
+  #elif defined (MDE_CPU_X64)\r
 \r
 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
-  (((Machine) == EFI_IMAGE_MACHINE_IA64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))\r
+  ((Machine) == EFI_IMAGE_MACHINE_X64)\r
+\r
+#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_IA32)\r
 \r
-#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) \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
-#elif defined (MDE_CPU_X64)\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_X64) || ((Machine) == EFI_IMAGE_MACHINE_EBC))\r
+  ((Machine) == EFI_IMAGE_MACHINE_RISCV64)\r
 \r
-#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32) \r
+#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)\r
 \r
-#elif defined (MDE_CPU_ARM)\r
+  #elif defined (MDE_CPU_LOONGARCH64)\r
 \r
 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
-  (((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED) || ((Machine) == EFI_IMAGE_MACHINE_EBC))\r
+    ((Machine) == EFI_IMAGE_MACHINE_LOONGARCH64)\r
 \r
-#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_ARMTHUMB_MIXED) \r
+#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)\r
 \r
-#elif defined (MDE_CPU_EBC)\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
+/// 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
+#define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine)  ((Machine) == EFI_IMAGE_MACHINE_EBC)\r
 \r
-#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE) \r
+#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine)  (FALSE)\r
 \r
+  #else\r
+    #error Unknown Processor Type\r
+  #endif\r
 #else\r
-#error Unknown Processor Type\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