Add comment that describes the TPL restrictions for the Data Hub Protocol.

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

diff --git a/MdePkg/Include/Uefi/UefiBaseType.h b/MdePkg/Include/Uefi/UefiBaseType.h
index 9cf36b344ff9ff6610d6350cf0a0ee141704015e..5b8a7620728f6e899cd512864a0017d239a0b86c 100644 (file)
--- a/MdePkg/Include/Uefi/UefiBaseType.h
+++ b/MdePkg/Include/Uefi/UefiBaseType.h
@@ -1,15 +1,14 @@
 /** @file\r
   Defines data types and constants introduced in UEFI.\r
 \r
-  Copyright (c) 2006 - 2009, Intel Corporation<BR>\r
-  Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>\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 - 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
 \r
 **/\r
 \r
@@ -27,7 +26,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
@@ -91,7 +90,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
@@ -189,32 +188,36 @@ typedef union {
 #define EFI_PAGE_MASK             0xFFF\r
 #define EFI_PAGE_SHIFT            12\r
 \r
+//\r
+// It is expected that a parameter for the following two macros is of type UINTN.\r
+// Be careful to pass a UINT64 parameter because 32-bit build break may happen\r
+// if << or >> shift operations are performed on a 64-bit integer with 32-bit C compiler.\r
+//\r
 #define EFI_SIZE_TO_PAGES(a)  (((a) >> EFI_PAGE_SHIFT) + (((a) & EFI_PAGE_MASK) ? 1 : 0))\r
-\r
 #define EFI_PAGES_TO_SIZE(a)   ( (a) << EFI_PAGE_SHIFT)\r
 \r
 ///\r
-/// PE32+ Machine type for IA32 UEFI images\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
+/// 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
+/// 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
+/// 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
+/// PE32+ Machine type for ARM mixed ARM and Thumb/Thumb2 images.\r
 ///\r
 #define EFI_IMAGE_MACHINE_ARMTHUMB_MIXED  0x01C2\r
 \r