Use SmmMemLib to check communication buffer.

[mirror_edk2.git] / MdeModulePkg / Library / PiSmmCoreMemoryAllocationLib / PiSmmCoreMemoryAllocationServices.h

/** @file\r
  Contains function prototypes for Memory Services in the SMM Core.\r
\r
  This header file borrows the PiSmmCore Memory Allocation services as the primitive\r
  for memory allocation. \r
\r
  Copyright (c) 2008 - 2015, 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
**/\r
\r
#ifndef _PI_SMM_CORE_MEMORY_ALLOCATION_SERVICES_H_\r
#define _PI_SMM_CORE_MEMORY_ALLOCATION_SERVICES_H_\r
\r
typedef struct {\r
  UINTN                           Signature;\r
  ///\r
  /// The ImageHandle passed into the entry point of the SMM IPL.  This ImageHandle\r
  /// is used by the SMM Core to fill in the ParentImageHandle field of the Loaded\r
  /// Image Protocol for each SMM Driver that is dispatched by the SMM Core.\r
  ///\r
  EFI_HANDLE                      SmmIplImageHandle;\r
  ///\r
  /// The number of SMRAM ranges passed from the SMM IPL to the SMM Core.  The SMM\r
  /// Core uses these ranges of SMRAM to initialize the SMM Core memory manager.\r
  ///\r
  UINTN                           SmramRangeCount;\r
  ///\r
  /// A table of SMRAM ranges passed from the SMM IPL to the SMM Core.  The SMM\r
  /// Core uses these ranges of SMRAM to initialize the SMM Core memory manager.\r
  ///\r
  EFI_SMRAM_DESCRIPTOR            *SmramRanges;\r
} SMM_CORE_PRIVATE_DATA;\r
\r
/**\r
  Called to initialize the memory service.\r
\r
  @param   SmramRangeCount       Number of SMRAM Regions\r
  @param   SmramRanges           Pointer to SMRAM Descriptors\r
\r
**/\r
VOID\r
SmmInitializeMemoryServices (\r
  IN UINTN                 SmramRangeCount,\r
  IN EFI_SMRAM_DESCRIPTOR  *SmramRanges\r
  );\r
\r
/**\r
  Allocates pages from the memory map.\r
\r
  @param  Type                   The type of allocation to perform\r
  @param  MemoryType             The type of memory to turn the allocated pages\r
                                 into\r
  @param  NumberOfPages          The number of pages to allocate\r
  @param  Memory                 A pointer to receive the base allocated memory\r
                                 address\r
\r
  @retval EFI_INVALID_PARAMETER  Parameters violate checking rules defined in spec.\r
  @retval EFI_NOT_FOUND          Could not allocate pages match the requirement.\r
  @retval EFI_OUT_OF_RESOURCES   No enough pages to allocate.\r
  @retval EFI_SUCCESS            Pages successfully allocated.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmAllocatePages (\r
  IN      EFI_ALLOCATE_TYPE         Type,\r
  IN      EFI_MEMORY_TYPE           MemoryType,\r
  IN      UINTN                     NumberOfPages,\r
  OUT     EFI_PHYSICAL_ADDRESS      *Memory\r
  );\r
\r
/**\r
  Frees previous allocated pages.\r
\r
  @param  Memory                 Base address of memory being freed\r
  @param  NumberOfPages          The number of pages to free\r
\r
  @retval EFI_NOT_FOUND          Could not find the entry that covers the range\r
  @retval EFI_INVALID_PARAMETER  Address not aligned\r
  @return EFI_SUCCESS            Pages successfully freed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmFreePages (\r
  IN      EFI_PHYSICAL_ADDRESS      Memory,\r
  IN      UINTN                     NumberOfPages\r
  );\r
\r
/**\r
  Allocate pool of a particular type.\r
\r
  @param  PoolType               Type of pool to allocate\r
  @param  Size                   The amount of pool to allocate\r
  @param  Buffer                 The address to return a pointer to the allocated\r
                                 pool\r
\r
  @retval EFI_INVALID_PARAMETER  PoolType not valid\r
  @retval EFI_OUT_OF_RESOURCES   Size exceeds max pool size or allocation failed.\r
  @retval EFI_SUCCESS            Pool successfully allocated.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmAllocatePool (\r
  IN      EFI_MEMORY_TYPE           PoolType,\r
  IN      UINTN                     Size,\r
  OUT     VOID                      **Buffer\r
  );\r
\r
/**\r
  Frees pool.\r
\r
  @param  Buffer                 The allocated pool entry to free\r
\r
  @retval EFI_INVALID_PARAMETER  Buffer is not a valid value.\r
  @retval EFI_SUCCESS            Pool successfully freed.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmFreePool (\r
  IN      VOID                      *Buffer\r
  );\r
\r
#endif\r