ShellPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ShellPkg / DynamicCommand / DpDynamicCommand / Dp.h

/** @file\r
  Header file for 'dp' command functions.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _DP_H_\r
#define _DP_H_\r
\r
\r
#include <Uefi.h>\r
\r
#include <Guid/Performance.h>\r
#include <Guid/ExtendedFirmwarePerformance.h>\r
#include <Guid/FirmwarePerformance.h>\r
\r
#include <Protocol/HiiPackageList.h>\r
#include <Protocol/DevicePath.h>\r
#include <Protocol/LoadedImage.h>\r
#include <Protocol/UnicodeCollation.h>\r
\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/ShellLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/SortLib.h>\r
#include <Library/HiiLib.h>\r
#include <Library/FileHandleLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
#include <Library/PerformanceLib.h>\r
\r
extern EFI_HANDLE mDpHiiHandle;\r
\r
#define DP_MAJOR_VERSION        2\r
#define DP_MINOR_VERSION        5\r
\r
/**\r
  * The value assigned to DP_DEBUG controls which debug output\r
  * is generated.  Set it to ZERO to disable.\r
**/\r
#define DP_DEBUG                0\r
\r
#define DEFAULT_THRESHOLD       1000    ///< One millisecond.\r
#define DEFAULT_DISPLAYCOUNT    50\r
#define MAXIMUM_DISPLAYCOUNT    999999  ///< Arbitrary maximum reasonable number.\r
\r
#define PERF_MAXDUR             0xFFFFFFFFFFFFFFFFULL\r
\r
/// Determine whether  0 <= C < L.  If L == 0, return true regardless of C.\r
#define WITHIN_LIMIT( C, L)   ( ((L) == 0) || ((C) < (L)) )\r
\r
/// Structure for storing Timer specific information.\r
typedef struct {\r
  UINT64    StartCount;   ///< Value timer is initialized with.\r
  UINT64    EndCount;     ///< Value timer has just before it wraps.\r
  UINT32    Frequency;    ///< Timer count frequency in KHz.\r
  BOOLEAN   CountUp;      ///< TRUE if the counter counts up.\r
} TIMER_INFO;\r
\r
/** Initialize one PERF_CUM_DATA structure instance for token t.\r
  *\r
  * This parameterized macro takes a single argument, t, which is expected\r
  * to resolve to a pointer to an ASCII string literal.  This parameter may\r
  * take any one of the following forms:\r
  *   - PERF_INIT_CUM_DATA("Token")         A string literal\r
  *   - PERF_INIT_CUM_DATA(pointer)         A pointer -- CHAR8 *pointer;\r
  *   - PERF_INIT_CUM_DATA(array)           Address of an array -- CHAR8 array[N];\r
**/\r
#define PERF_INIT_CUM_DATA(t)   { 0ULL, PERF_MAXDUR, 0ULL, (t), 0U }\r
\r
typedef struct {\r
  UINT64  Duration;     ///< Cumulative duration for this item.\r
  UINT64  MinDur;       ///< Smallest duration encountered.\r
  UINT64  MaxDur;       ///< Largest duration encountered.\r
  CHAR8   *Name;        ///< ASCII name of this item.\r
  UINT32  Count;        ///< Total number of measurements accumulated.\r
} PERF_CUM_DATA;\r
\r
typedef struct {\r
  UINT32                NumTrace;         ///< Number of recorded TRACE performance measurements.\r
  UINT32                NumIncomplete;    ///< Number of measurements with no END value.\r
  UINT32                NumSummary;       ///< Number of summary section measurements.\r
  UINT32                NumHandles;       ///< Number of measurements with handles.\r
  UINT32                NumPEIMs;         ///< Number of measurements of PEIMs.\r
  UINT32                NumGlobal;        ///< Number of measurements with END value and NULL handle.\r
} PERF_SUMMARY_DATA;\r
\r
typedef struct {\r
  CONST VOID            *Handle;\r
  CONST CHAR8           *Token;           ///< Measured token string name.\r
  CONST CHAR8           *Module;          ///< Module string name.\r
  UINT64                StartTimeStamp;   ///< Start time point.\r
  UINT64                EndTimeStamp;     ///< End time point.\r
  UINT32                Identifier;       ///< Identifier.\r
} MEASUREMENT_RECORD;\r
\r
typedef struct {\r
  CHAR8                 *Name;            ///< Measured token string name.\r
  UINT64                CumulativeTime;   ///< Accumulated Elapsed Time.\r
  UINT64                MinTime;          ///< Minimum Elapsed Time.\r
  UINT64                MaxTime;          ///< Maximum Elapsed Time.\r
  UINT32                Count;            ///< Number of measurements accumulated.\r
} PROFILE_RECORD;\r
\r
/**\r
  Dump performance data.\r
\r
  @param[in]  ImageHandle     The image handle.\r
  @param[in]  SystemTable     The system table.\r
\r
  @retval SHELL_SUCCESS            Command completed successfully.\r
  @retval SHELL_INVALID_PARAMETER  Command usage error.\r
  @retval SHELL_ABORTED            The user aborts the operation.\r
  @retval value                    Unknown error.\r
**/\r
SHELL_STATUS\r
RunDp (\r
  IN EFI_HANDLE               ImageHandle,\r
  IN EFI_SYSTEM_TABLE         *SystemTable\r
  );\r
\r
/**\r
  Retrive HII package list from ImageHandle and publish to HII database.\r
\r
  @param ImageHandle            The image handle of the process.\r
\r
  @return HII handle.\r
**/\r
EFI_HANDLE\r
InitializeHiiPackage (\r
  EFI_HANDLE                  ImageHandle\r
  );\r
#endif  // _DP_H_\r