Ctools Use Case Library
Data Fields
ctools_cpt_sysprofilecfg Struct Reference

CP Tracer configuration parameters for System Profiling Use-cases (Bandwidth or Latency profiling) More...

#include <ctools_uclib_cpt.h>

Data Fields

const ctools_cpt_modidqualModIDQual
 
uint32_t CPT_ModCnt
 
uint32_t CPUClockRateMhz
 
uint32_t SampleWindowSize
 

Detailed Description

CP Tracer configuration parameters for System Profiling Use-cases (Bandwidth or Latency profiling)

ctools_cpt_sysprofilecfg

Field Documentation

uint32_t ctools_cpt_sysprofilecfg::CPT_ModCnt

Count or number of CPT Module for which System bandwidth profiling needs to be enabled.

uint32_t ctools_cpt_sysprofilecfg::CPUClockRateMhz

CPU clock rate in Mhz. This value is provided to host tools through meta data STM messages and is used to calculate throughput. If this value is non-zero the host decoder will convert throughput data to Bytes/Second. If this value is zero the host decoder will convert throughput data to Bytes/CPU-Cycle.

const ctools_cpt_modidqual* ctools_cpt_sysprofilecfg::ModIDQual

Pointer to an array of structures containing CPT Module Ids and their corresponding qualifiers for which System profiling needs to be enabled.

uint32_t ctools_cpt_sysprofilecfg::SampleWindowSize

32-bit non-zero value used to set the sample window size in CP Tracer clocks. Setting to 0 is not legal and will result in CPT_OpenModule() returning eCPT_Error_Invalid_Parameter. If CPT_OpenModule() is called with a NULL CPT_CfgOptions pointer then the default for this parameter is 64K. This value is provided to host tools through meta data STM messages and is used to calculate throughput for statistic messages.


The documentation for this struct was generated from the following file: