Synchronization of MDE Library Spec., Mde.dec, and corresponding head files in MdePkg...

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

/** @file\r
  Provides a service to publish discovered system resources.\r
\r
Copyright (c) 2006 - 2008, 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
\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
#ifndef __RESOURCE_PUBLICATION_LIB__\r
#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
\r
  @param  MemoryBegin               The start address of the memory being declared.\r
  @param  MemoryLength              The number of bytes of memory being declared.\r
\r
  @retval  RETURN_SUCCESS           The memory buffer was published.\r
  @retval  RETURN_OUT_OF_RESOURCES  There are not enough resources to publish the memory buffer\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
PublishSystemMemory (\r
  IN PHYSICAL_ADDRESS       MemoryBegin,\r
  IN UINT64                 MemoryLength\r
  );\r
\r
#endif\r