Common Platform (CP) Tracer Library API Reference Guide (TCI6630K2L Version)
|
#include <CPTLib.h>
Data Fields | |
bool | ForceOwnership |
CPT_CallBack | pCPT_CallBack |
bool | STM_LogMsgEnable |
STMHandle * | pSTMHandle |
int32_t | STMMessageCh |
eCPT_UseCase | CPT_UseCaseId |
uint32_t | SampleWindowSize |
uint32_t | AddrExportMask |
int32_t | CPUClockRateMhz |
uint32_t | DataOptions |
bool _CPT_CfgOptions::ForceOwnership |
If true and another thread or core has ownership (not the debugger) then allow this open to take ownership. Default for this parameter is false.
CPT_CallBack _CPT_CfgOptions::pCPT_CallBack |
CPT_CallBack is called by any CPT Library function prior to returning an error. May be set to NULL to disable this feature. If CPT_OpenModule() is called with a NULL CPT_CfgOptions pointer then the default for this parameter is NULL.
bool _CPT_CfgOptions::STM_LogMsgEnable |
Enable or disable library generated logging messages. The default for this parameter is enabled
STMHandle* _CPT_CfgOptions::pSTMHandle |
A pointer to a STM Handle for logging and providing meta data (possibly required by host tools). If NULL STM logging is disabled. If CPT_OpenModule() is called with a NULL CPT_CfgOptions pointer then the default for this parameter is NULL.
int32_t _CPT_CfgOptions::STMMessageCh |
A channel to use for CPT Library STM Messages (if pSTMHandle is not NULL) generated by:
eCPT_UseCase _CPT_CfgOptions::CPT_UseCaseId |
See eCPT_UseCase for details on each use case
uint32_t _CPT_CfgOptions::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.
uint32_t _CPT_CfgOptions::AddrExportMask |
6-bit value (bits 5:0) in the range of 0 to 37 that defines the 10 address bits used in STM message generation:
int32_t _CPT_CfgOptions::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.
uint32_t _CPT_CfgOptions::DataOptions |
This is a bit field that enables sw filtering of certain data characteristics. Bit 0 - If 1 suppress zero data, if 0 don't suppress zero data. If a CP Tracer is enabled during cycles where no accesses are performed this option allows the zero data provided in these cases to be suppressed from the CP Tracer data provided on the host. This option will have no effect on the actual STM bandwidth (in other words all data is transmitted), but it may reduce host file sizes significantly and in some cases decrease data processing times significantly.