MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Include / Library / MemoryProfileLib.h

/** @file\r
  Provides services to record memory profile of multilevel caller.\r
\r
  Copyright (c) 2016 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _MEMORY_PROFILE_LIB_H_\r
#define _MEMORY_PROFILE_LIB_H_\r
\r
#include <Guid/MemoryProfile.h>\r
\r
/**\r
  Record memory profile of multilevel caller.\r
\r
  @param[in] CallerAddress      Address of caller.\r
  @param[in] Action             Memory profile action.\r
  @param[in] MemoryType         Memory type.\r
                                EfiMaxMemoryType means the MemoryType is unknown.\r
  @param[in] Buffer             Buffer address.\r
  @param[in] Size               Buffer size.\r
  @param[in] ActionString       String for memory profile action.\r
                                Only needed for user defined allocate action.\r
\r
  @return EFI_SUCCESS           Memory profile is updated.\r
  @return EFI_UNSUPPORTED       Memory profile is unsupported,\r
                                or memory profile for the image is not required,\r
                                or memory profile for the memory type is not required.\r
  @return EFI_ACCESS_DENIED     It is during memory profile data getting.\r
  @return EFI_ABORTED           Memory profile recording is not enabled.\r
  @return EFI_OUT_OF_RESOURCES  No enough resource to update memory profile for allocate action.\r
  @return EFI_NOT_FOUND         No matched allocate info found for free action.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
MemoryProfileLibRecord (\r
  IN PHYSICAL_ADDRESS           CallerAddress,\r
  IN MEMORY_PROFILE_ACTION      Action,\r
  IN EFI_MEMORY_TYPE            MemoryType,\r
  IN VOID                       *Buffer,\r
  IN UINTN                      Size,\r
  IN CHAR8                      *ActionString OPTIONAL\r
  );\r
\r
#endif\r