System Trace Module(STM) Library API Reference Guide
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
_STMConfigObj Struct Reference

#include <StmLibrary.h>

Data Fields

uint32_t STM_XportBaseAddr
 
uint32_t STM_ChannelResolution
 
uint32_t STM_CntlBaseAddr
 
STMXport_callback pCallBack
 
eSTM_XmitPrintfMode xmit_printf_mode
 
bool optimize_strings
 

Detailed Description

eSTM_XportModuleType

Set the transport module type to MIPI STM or CoreSight STM.

STMConfigObj

This struct is used to communicate configuration parameters to the library.

Field Documentation

uint32_t _STMConfigObj::STM_XportBaseAddr

The STM module's Transport base address.

uint32_t _STMConfigObj::STM_ChannelResolution

The STM units channel resolution in bytes. Valid values for MIPI is either 1024 or 4096, ARM is 256

uint32_t _STMConfigObj::STM_CntlBaseAddr

MIPI or CoreSight STM 2.0 Control register mapping base address.

STMXport_callback _STMConfigObj::pCallBack

This is a pointer to a callback function that if not NULL is called on completion of most API functions

eSTM_XmitPrintfMode _STMConfigObj::xmit_printf_mode

STM transmit mode (optimized or character) for STMXport_printf() and STMXport_logMsg functions.

bool _STMConfigObj::optimize_strings

If xmit_printf_mode is eSend_optimized, then optimize_strings determines if string values are transported as a pointer (optimize_strings true) or by value (optimize_strings false). Optimize_strings only affects the %s case of a STMXport_printf() or STMXport_logMsg format string. If optimize_strings is true only a pointer to the %s constant char string is transported. If optimize_strings is false, the complete "C" string (null terminated) byte buffer pointed to by %s is transported.


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