MdePkg/Include/Library/ResourcePublicationLib.h

   1 /** @file
   2   Declare presence of resources in the platform
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __RESOURCE_PUBLICATION_LIB__
  16 #define __RESOURCE_PUBLICATION_LIB__
  17
  18 /**
  19
  20   Declares the presence of permanent system memory in the platform.
  21
  22   Declares that the system memory buffer specified by MemoryBegin and MemoryLength
  23   as permanent memory that may be used for general purpose use by software.
  24   The amount of memory available to software may be less than MemoryLength
  25   if published memory has alignment restrictions.
  26
  27   @param  MemoryBegin               The start address of the memory being declared.
  28   @param  MemoryLength              The number of bytes of memory being declared.
  29
  30   @retval  RETURN_SUCCESS           The memory buffer was published.
  31   @retval  RETURN_OUT_OF_RESOURCES  There are not enough resources to publish the memory buffer
  32
  33 **/
  34 RETURN_STATUS
  35 EFIAPI
  36 PublishSystemMemory (
  37   IN PHYSICAL_ADDRESS       MemoryBegin,
  38   IN UINT64                 MemoryLength
  39   );
  40
  41 #endif