MdePkg: Clean up source files

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

diff --git a/MdePkg/Include/Uefi/UefiBaseType.h b/MdePkg/Include/Uefi/UefiBaseType.h
index d9556cd2ec4e44e02a5819c9562341e4624f0c77..401db7f620b394cbbcae74a18f57e64cdbf10b23 100644 (file)
--- a/MdePkg/Include/Uefi/UefiBaseType.h
+++ b/MdePkg/Include/Uefi/UefiBaseType.h
@@ -1,15 +1,15 @@
 /** @file\r
   Defines data types and constants introduced in UEFI.\r
 \r
 /** @file\r
   Defines data types and constants introduced in UEFI.\r
 \r

-Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\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
 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
+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
 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
+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
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r


@@ -114,44 +114,44 @@ typedef union {
 \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
-#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
 #define EFI_COMPROMISED_DATA      RETURN_COMPROMISED_DATA\r
 #define EFI_HTTP_ERROR            RETURN_HTTP_ERROR\r
 \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
 #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


@@ -159,7 +159,7 @@ typedef union {
 \r
 ///\r
 /// Define macro to encode the status code.\r
 \r
 ///\r
 /// Define macro to encode the status code.\r

-/// \r
+///\r

 #define EFIERR(_a)                ENCODE_ERROR(_a)\r
 \r
 #define EFI_ERROR(A)              RETURN_ERROR(A)\r
 #define EFIERR(_a)                ENCODE_ERROR(_a)\r
 \r
 #define EFI_ERROR(A)              RETURN_ERROR(A)\r


@@ -168,7 +168,7 @@ typedef union {
 /// ICMP error definitions\r
 ///@{\r
 #define EFI_NETWORK_UNREACHABLE   EFIERR(100)\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
 #define EFI_PROTOCOL_UNREACHABLE  EFIERR(102)\r
 #define EFI_PORT_UNREACHABLE      EFIERR(103)\r
 ///@}\r


@@ -193,8 +193,8 @@ typedef union {
 /**\r
   Macro that converts a size, in bytes, to a number of EFI_PAGESs.\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
                     unexpected results.\r
 \r
   @return  The number of EFI_PAGESs associated with the number of bytes specified\r


@@ -206,13 +206,13 @@ typedef union {
 /**\r
   Macro that converts a number of EFI_PAGEs to a size in bytes.\r
 \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
+  @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
                     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
            by Pages.\r

-  \r
+\r

 **/\r
 #define EFI_PAGES_TO_SIZE(Pages)  ((Pages) << EFI_PAGE_SHIFT)\r
 \r
 **/\r
 #define EFI_PAGES_TO_SIZE(Pages)  ((Pages) << EFI_PAGE_SHIFT)\r
 \r


@@ -252,21 +252,21 @@ typedef union {
 #define EFI_IMAGE_MACHINE_TYPE_SUPPORTED(Machine) \\r
   (((Machine) == EFI_IMAGE_MACHINE_IA32) || ((Machine) == EFI_IMAGE_MACHINE_EBC))\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
+#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
 \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
+#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
 \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
+#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) ((Machine) == EFI_IMAGE_MACHINE_IA32)\r

 \r
 #elif defined (MDE_CPU_ARM)\r
 \r
 \r
 #elif defined (MDE_CPU_ARM)\r
 \r


@@ -285,11 +285,11 @@ typedef union {
 \r
 ///\r
 /// This is just to make sure you can cross compile with the EBC compiler.\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
 \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
+#define EFI_IMAGE_MACHINE_CROSS_TYPE_SUPPORTED(Machine) (FALSE)\r

 \r
 #else\r
 #error Unknown Processor Type\r
 \r
 #else\r
 #error Unknown Processor Type\r