MdeModulePkg: Clean up source files

[mirror_edk2.git] / MdeModulePkg / Library / SmmCorePerformanceLib / SmmCorePerformanceLibInternal.h

/** @file\r
  Master header files for SmmCorePerformanceLib instance.\r
\r
  This header file holds the prototypes of the SMM Performance and PerformanceEx Protocol published by this\r
  library instance at its constructor.\r
\r
Copyright (c) 2011 - 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
**/\r
\r
#ifndef _SMM_CORE_PERFORMANCE_LIB_INTERNAL_H_\r
#define _SMM_CORE_PERFORMANCE_LIB_INTERNAL_H_\r
\r
\r
#include <Guid/Performance.h>\r
#include <Guid/PerformanceMeasurement.h>\r
#include <Guid/ExtendedFirmwarePerformance.h>\r
#include <Guid/FirmwarePerformance.h>\r
#include <Guid/ZeroGuid.h>\r
#include <Guid/EventGroup.h>\r
\r
#include <Library/SmmServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PerformanceLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/TimerLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/SynchronizationLib.h>\r
#include <Library/SmmMemLib.h>\r
#include <Library/ReportStatusCodeLib.h>\r
#include <Library/DxeServicesLib.h>\r
#include <Library/PeCoffGetEntryPointLib.h>\r
\r
#include <Protocol/SmmBase2.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/DevicePathToText.h>\r
\r
//\r
// Interface declarations for SMM PerformanceMeasurement Protocol.\r
//\r
/**\r
  Create performance record with event description and a timestamp.\r
\r
  @param CallerIdentifier  - Image handle or pointer to caller ID GUID.\r
  @param Guid              - Pointer to a GUID.\r
  @param String            - Pointer to a string describing the measurement.\r
  @param TimeStamp         - 64-bit time stamp.\r
  @param Address           - Pointer to a location in memory relevant to the measurement.\r
  @param Identifier        - Performance identifier describing the type of measurement.\r
  @param Attribute         - The attribute of the measurement. According to attribute can create a start\r
                             record for PERF_START/PERF_START_EX, or a end record for PERF_END/PERF_END_EX,\r
                             or a general record for other Perf macros.\r
\r
  @retval EFI_SUCCESS           - Successfully created performance record.\r
  @retval EFI_OUT_OF_RESOURCES  - Ran out of space to store the records.\r
  @retval EFI_INVALID_PARAMETER - Invalid parameter passed to function - NULL\r
                                  pointer or invalid PerfId.\r
**/\r
EFI_STATUS\r
EFIAPI\r
CreatePerformanceMeasurement(\r
  IN CONST VOID                        *CallerIdentifier, OPTIONAL\r
  IN CONST VOID                        *Guid,     OPTIONAL\r
  IN CONST CHAR8                       *String,   OPTIONAL\r
  IN       UINT64                      TimeStamp, OPTIONAL\r
  IN       UINT64                      Address,   OPTIONAL\r
  IN       UINT32                      Identifier,\r
  IN       PERF_MEASUREMENT_ATTRIBUTE  Attribute\r
  );\r
\r
#endif\r