update codes per MdePkg doxgen review comments.

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

diff --git a/MdePkg/Include/Uefi/UefiBaseType.h b/MdePkg/Include/Uefi/UefiBaseType.h
index 0d681a3a4d954cfeba3200d76e2944c2a4fb703a..c500a0fc1f3cb9862b0063268cae3a446cacb13c 100644 (file)
--- a/MdePkg/Include/Uefi/UefiBaseType.h
+++ b/MdePkg/Include/Uefi/UefiBaseType.h
@@ -15,10 +15,10 @@
 #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
+// Basic data type definitions introduced in UEFI.\r
 //\r
 \r
 ///\r
@@ -45,10 +45,16 @@ typedef UINTN                     EFI_TPL;
 /// 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
-typedef UINT64                    EFI_VIRTUAL_ADDRESS;\r
 \r
-typedef UINT16                    STRING_REF;\r
+///\r
+/// 64-bit virtual memory address.\r
+///\r
+typedef UINT64                    EFI_VIRTUAL_ADDRESS;\r
 \r
 ///\r
 /// EFI Time Abstraction:\r
@@ -156,19 +162,7 @@ typedef union {
 \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
 //\r
 // The EFI memory allocation functions work in units of EFI_PAGEs that are\r
@@ -183,21 +177,61 @@ typedef union {
 \r
 #define EFI_PAGES_TO_SIZE(a)   ( (a) << EFI_PAGE_SHIFT)\r
 \r
+///\r
+/// PE32+ Machine type for IA32 UEFI images\r
+///\r
+#define EFI_IMAGE_MACHINE_IA32      0x014C\r
 \r
-#define EFI_MAX_BIT               MAX_BIT\r
-#define EFI_MAX_ADDRESS           MAX_ADDRESS\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
-/// Limited buffer size for a language code recommended by RFC3066\r
-/// (42 characters plus a NULL terminator)\r
+/// PE32+ Machine type for X64 UEFI images\r
 ///\r
-#define RFC_3066_ENTRY_SIZE             (42 + 1)\r
+#define EFI_IMAGE_MACHINE_X64       0x8664\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_EBC)\r
 \r
 ///\r
-/// The size of a 3 character ISO639 language code.\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. You need to \r
+/// understand the basic.\r
 ///\r
-#define ISO_639_2_ENTRY_SIZE            3\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