MdePkg: Clean up source files

[mirror_edk2.git] / MdePkg / Include / Library / ResourcePublicationLib.h

diff --git a/MdePkg/Include/Library/ResourcePublicationLib.h b/MdePkg/Include/Library/ResourcePublicationLib.h
index ccd3eaed2583a9628eeb2b5ca6cfdc194eeffdd4..08e779d68c128791aed0c5e7d352d66717ed9f92 100644 (file)
--- a/MdePkg/Include/Library/ResourcePublicationLib.h
+++ b/MdePkg/Include/Library/ResourcePublicationLib.h
@@ -1,16 +1,14 @@
 /** @file\r
-  Declare presence of resources in the platform\r
+  Provides a service to publish discovered system resources.\r
 \r
-  Copyright (c) 2006, 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
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+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
-\r
-  Module Name:  ResourcePublicationLib.h\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,13 +16,14 @@
 #define __RESOURCE_PUBLICATION_LIB__\r
 \r
 /**\r
-  \r
   Declares the presence of permanent system memory in the platform.\r
 \r
   Declares that the system memory buffer specified by MemoryBegin and MemoryLength\r
   as permanent memory that may be used for general purpose use by software.\r
   The amount of memory available to software may be less than MemoryLength\r
-  if published memory has alignment restrictions.  \r
+  if published memory has alignment restrictions.\r
+  If MemoryLength is 0, then ASSERT().\r
+  If MemoryLength is greater than (MAX_ADDRESS - MemoryBegin + 1), then ASSERT().\r
 \r
   @param  MemoryBegin               The start address of the memory being declared.\r
   @param  MemoryLength              The number of bytes of memory being declared.\r
@@ -38,7 +37,6 @@ EFIAPI
 PublishSystemMemory (\r
   IN PHYSICAL_ADDRESS       MemoryBegin,\r
   IN UINT64                 MemoryLength\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r