OpenCSD - CoreSight Trace Decode Library  1.3.3
Classes | Macros | Functions
OpenCSD Library : Packet Processors.

Classes providing Protocol Packet Processing capability. More...

Classes

class  TrcPktProcEtmV3
 
class  TrcPktProcEtmV4I
 
class  TrcPktProcPtm
 
class  TrcPktProcStm
 
class  TrcPktProcI
 Base Packet processing interface. More...
 
class  TrcPktProcBase< P, Pt, Pc >
 Packet Processor base class. Provides common infrastructure and interconnections for packet processors. More...
 

Macros

#define ETMV3_OPFLG_UNFORMATTED_SOURCE   0x00010000
 

Functions

virtual const bool TrcPktProcEtmV4I::isBadPacket () const
 check if the current packet is an error / bad packet More...
 
const bool TrcPktProcPtm::isSync () const
 
void TrcPktProcPtm::throwMalformedPacketErr (const char *pszErrMsg)
 
void TrcPktProcPtm::throwPacketHeaderErr (const char *pszErrMsg)
 
const bool TrcPktProcPtm::readByte ()
 
 TrcPktProcI::TrcPktProcI (const char *component_name)
 
 TrcPktProcI::TrcPktProcI (const char *component_name, int instIDNum)
 
 TrcPktProcBase< P, Pt, Pc >::TrcPktProcBase (const char *component_name)
 
 TrcPktProcBase< P, Pt, Pc >::TrcPktProcBase (const char *component_name, int instIDNum)
 
virtual TrcPktProcBase< P, Pt, Pc >::~TrcPktProcBase ()
 
virtual ocsd_datapath_resp_t TrcPktProcBase< P, Pt, Pc >::TraceDataIn (const ocsd_datapath_op_t op, const ocsd_trc_index_t index, const uint32_t dataBlockSize, const uint8_t *pDataBlock, uint32_t *numBytesProcessed)
 
ocsd_datapath_resp_t TrcPktProcBase< P, Pt, Pc >::outputDecodedPacket (const ocsd_trc_index_t index_sop, const P *pkt)
 
void TrcPktProcBase< P, Pt, Pc >::outputRawPacketToMonitor (const ocsd_trc_index_t index_sop, const P *pkt, const uint32_t size, const uint8_t *p_data)
 
const bool TrcPktProcBase< P, Pt, Pc >::hasRawMon () const
 
void TrcPktProcBase< P, Pt, Pc >::indexPacket (const ocsd_trc_index_t index_sop, const Pt *packet_type)
 
ocsd_datapath_resp_t TrcPktProcBase< P, Pt, Pc >::outputOnAllInterfaces (const ocsd_trc_index_t index_sop, const P *pkt, const Pt *pkt_type, std::vector< uint8_t > &pktdata)
 
ocsd_datapath_resp_t TrcPktProcBase< P, Pt, Pc >::outputOnAllInterfaces (const ocsd_trc_index_t index_sop, const P *pkt, const Pt *pkt_type, const uint8_t *pktdata, uint32_t pktlen)
 
virtual ocsd_err_t TrcPktProcBase< P, Pt, Pc >::setProtocolConfig (const Pc *config)
 < Set the protocol specific configuration for the decoder. More...
 
void TrcPktProcBase< P, Pt, Pc >::ClearConfigObj ()
 
const bool TrcPktProcBase< P, Pt, Pc >::checkInit ()
 
virtual ocsd_err_t TrcPktProcBase< P, Pt, Pc >::getStatsBlock (ocsd_decode_stats_t **pp_stats)
 
virtual void TrcPktProcBase< P, Pt, Pc >::resetStats ()
 

Detailed Description

Classes providing Protocol Packet Processing capability.

Packet processors take an incoming byte stream and convert into discrete packets for the required trace protocol.

Macro Definition Documentation

◆ ETMV3_OPFLG_UNFORMATTED_SOURCE

#define ETMV3_OPFLG_UNFORMATTED_SOURCE   0x00010000

Single ETM source from bypassed formatter - need to check for EOT markers

Definition at line 75 of file trc_pkt_proc_etmv3.h.

Function Documentation

◆ checkInit()

template<class P , class Pt , class Pc >
const bool TrcPktProcBase< P, Pt, Pc >::checkInit
protected

Definition at line 420 of file trc_pkt_proc_base.h.

◆ ClearConfigObj()

template<class P , class Pt , class Pc >
void TrcPktProcBase< P, Pt, Pc >::ClearConfigObj
protected

Definition at line 411 of file trc_pkt_proc_base.h.

◆ getStatsBlock()

template<class P , class Pt , class Pc >
ocsd_err_t TrcPktProcBase< P, Pt, Pc >::getStatsBlock ( ocsd_decode_stats_t **  pp_stats)
virtual

Implements TrcPktProcI.

Definition at line 432 of file trc_pkt_proc_base.h.

◆ hasRawMon()

template<class P , class Pt , class Pc >
const bool TrcPktProcBase< P, Pt, Pc >::hasRawMon
protected

Let the derived class figure out if it needs to collate and send raw data. can improve wait for sync performance if we do not need to save and send unsynced data.

Definition at line 369 of file trc_pkt_proc_base.h.

◆ indexPacket()

template<class P , class Pt , class Pc >
void TrcPktProcBase< P, Pt, Pc >::indexPacket ( const ocsd_trc_index_t  index_sop,
const Pt *  packet_type 
)
protected

Definition at line 374 of file trc_pkt_proc_base.h.

◆ isBadPacket()

const bool TrcPktProcEtmV4I::isBadPacket ( ) const
inlineprotectedvirtual

check if the current packet is an error / bad packet

Implements TrcPktProcI.

Definition at line 206 of file trc_pkt_proc_etmv4i.h.

Here is the call graph for this function:

◆ isSync()

const bool TrcPktProcPtm::isSync ( ) const
inlineprotected

Definition at line 189 of file trc_pkt_proc_ptm.h.

Here is the call graph for this function:

◆ outputDecodedPacket()

template<class P , class Pt , class Pc >
ocsd_datapath_resp_t TrcPktProcBase< P, Pt, Pc >::outputDecodedPacket ( const ocsd_trc_index_t  index_sop,
const P *  pkt 
)
protected

Definition at line 336 of file trc_pkt_proc_base.h.

◆ outputOnAllInterfaces() [1/2]

template<class P , class Pt , class Pc >
ocsd_datapath_resp_t TrcPktProcBase< P, Pt, Pc >::outputOnAllInterfaces ( const ocsd_trc_index_t  index_sop,
const P *  pkt,
const Pt *  pkt_type,
const uint8_t *  pktdata,
uint32_t  pktlen 
)
protected

Definition at line 389 of file trc_pkt_proc_base.h.

◆ outputOnAllInterfaces() [2/2]

template<class P , class Pt , class Pc >
ocsd_datapath_resp_t TrcPktProcBase< P, Pt, Pc >::outputOnAllInterfaces ( const ocsd_trc_index_t  index_sop,
const P *  pkt,
const Pt *  pkt_type,
std::vector< uint8_t > &  pktdata 
)
protected

Definition at line 381 of file trc_pkt_proc_base.h.

◆ outputRawPacketToMonitor()

template<class P , class Pt , class Pc >
void TrcPktProcBase< P, Pt, Pc >::outputRawPacketToMonitor ( const ocsd_trc_index_t  index_sop,
const P *  pkt,
const uint32_t  size,
const uint8_t *  p_data 
)
protected

Definition at line 350 of file trc_pkt_proc_base.h.

◆ readByte()

const bool TrcPktProcPtm::readByte ( )
inlineprotected

Definition at line 205 of file trc_pkt_proc_ptm.h.

◆ resetStats()

template<class P , class Pt , class Pc >
void TrcPktProcBase< P, Pt, Pc >::resetStats
virtual

Implements TrcPktProcI.

Definition at line 439 of file trc_pkt_proc_base.h.

Here is the caller graph for this function:

◆ setProtocolConfig()

template<class P , class Pt , class Pc >
ocsd_err_t TrcPktProcBase< P, Pt, Pc >::setProtocolConfig ( const Pc *  config)
virtual

< Set the protocol specific configuration for the decoder.

Get the configuration for the decoder.

Definition at line 396 of file trc_pkt_proc_base.h.

Here is the caller graph for this function:

◆ throwMalformedPacketErr()

void TrcPktProcPtm::throwMalformedPacketErr ( const char *  pszErrMsg)
inlineprotected

Definition at line 194 of file trc_pkt_proc_ptm.h.

Here is the call graph for this function:

◆ throwPacketHeaderErr()

void TrcPktProcPtm::throwPacketHeaderErr ( const char *  pszErrMsg)
inlineprotected

Definition at line 200 of file trc_pkt_proc_ptm.h.

◆ TraceDataIn()

template<class P , class Pt , class Pc >
ocsd_datapath_resp_t TrcPktProcBase< P, Pt, Pc >::TraceDataIn ( const ocsd_datapath_op_t  op,
const ocsd_trc_index_t  index,
const uint32_t  dataBlockSize,
const uint8_t *  pDataBlock,
uint32_t *  numBytesProcessed 
)
virtual

Byte trace data input interface defined in ITrcDataIn

The base class implementation processes the operation to call the interface functions on TrcPktProcI.

Implements TrcPktProcI.

Definition at line 243 of file trc_pkt_proc_base.h.

◆ TrcPktProcBase() [1/2]

template<class P , class Pt , class Pc >
TrcPktProcBase< P, Pt, Pc >::TrcPktProcBase ( const char *  component_name)

Definition at line 220 of file trc_pkt_proc_base.h.

Here is the call graph for this function:

◆ TrcPktProcBase() [2/2]

template<class P , class Pt , class Pc >
TrcPktProcBase< P, Pt, Pc >::TrcPktProcBase ( const char *  component_name,
int  instIDNum 
)

Definition at line 229 of file trc_pkt_proc_base.h.

Here is the call graph for this function:

◆ TrcPktProcI() [1/2]

TrcPktProcI::TrcPktProcI ( const char *  component_name)
inline

Definition at line 99 of file trc_pkt_proc_base.h.

◆ TrcPktProcI() [2/2]

TrcPktProcI::TrcPktProcI ( const char *  component_name,
int  instIDNum 
)
inline

Definition at line 104 of file trc_pkt_proc_base.h.

◆ ~TrcPktProcBase()

template<class P , class Pt , class Pc >
TrcPktProcBase< P, Pt, Pc >::~TrcPktProcBase
virtual

Definition at line 238 of file trc_pkt_proc_base.h.