OpenCSD - CoreSight Trace Decode Library  1.3.3
ocsd_c_api_types.h File Reference

OpenCSD : Trace Decoder "C" API types. More...

#include "opencsd/ocsd_if_types.h"
#include "opencsd/ocsd_if_version.h"
#include "opencsd/trc_gen_elem_types.h"
#include "opencsd/trc_pkt_types.h"
#include "opencsd/etmv3/trc_pkt_types_etmv3.h"
#include "opencsd/etmv4/trc_pkt_types_etmv4.h"
#include "opencsd/ptm/trc_pkt_types_ptm.h"
#include "opencsd/stm/trc_pkt_types_stm.h"
#include "opencsd/ete/trc_pkt_types_ete.h"
Include dependency graph for ocsd_c_api_types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

#define C_API_INVALID_TREE_HANDLE   (dcd_tree_handle_t)0
 
#define C_API_MSGLOGOUT_FLG_NONE   0x0
 
#define C_API_MSGLOGOUT_FLG_FILE   0x1
 
#define C_API_MSGLOGOUT_FLG_STDERR   0x2
 
#define C_API_MSGLOGOUT_FLG_STDOUT   0x4
 
#define C_API_MSGLOGOUT_MASK   0x7
 
enum  _ocsd_c_api_cb_types { OCSD_C_API_CB_PKT_SINK , OCSD_C_API_CB_PKT_MON }
 
typedef void * dcd_tree_handle_t
 
typedef ocsd_datapath_resp_t(* FnTraceElemIn) (const void *p_context, const ocsd_trc_index_t index_sop, const uint8_t trc_chan_id, const ocsd_generic_trace_elem *elem)
 
typedef ocsd_datapath_resp_t(* FnDefPktDataIn) (const void *p_context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const void *p_packet_in)
 
typedef void(* FnDefPktDataMon) (const void *p_context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const void *p_packet_in, const uint32_t size, const uint8_t *p_data)
 
typedef void(* FnDefLoggerPrintStrCB) (const void *p_context, const char *psz_msg_str, const int str_len)
 
typedef enum _ocsd_c_api_cb_types ocsd_c_api_cb_types
 

Detailed Description

OpenCSD : Trace Decoder "C" API types.

Definition in file ocsd_c_api_types.h.

Macro Definition Documentation

◆ C_API_INVALID_TREE_HANDLE

#define C_API_INVALID_TREE_HANDLE   (dcd_tree_handle_t)0

define invalid handle value for decode tree handle

Definition at line 61 of file ocsd_c_api_types.h.

◆ C_API_MSGLOGOUT_FLG_FILE

#define C_API_MSGLOGOUT_FLG_FILE   0x1

Logger output printer - output to file.

Definition at line 66 of file ocsd_c_api_types.h.

◆ C_API_MSGLOGOUT_FLG_NONE

#define C_API_MSGLOGOUT_FLG_NONE   0x0

Logger output printer - no output.

Definition at line 64 of file ocsd_c_api_types.h.

◆ C_API_MSGLOGOUT_FLG_STDERR

#define C_API_MSGLOGOUT_FLG_STDERR   0x2

Logger output printer - output to stderr.

Definition at line 68 of file ocsd_c_api_types.h.

◆ C_API_MSGLOGOUT_FLG_STDOUT

#define C_API_MSGLOGOUT_FLG_STDOUT   0x4

Logger output printer - output to stdout.

Definition at line 70 of file ocsd_c_api_types.h.

◆ C_API_MSGLOGOUT_MASK

#define C_API_MSGLOGOUT_MASK   0x7

Logger output printer - mask of valid flags.

Definition at line 72 of file ocsd_c_api_types.h.

Typedef Documentation

◆ FnDefLoggerPrintStrCB

typedef void(* FnDefLoggerPrintStrCB) (const void *p_context, const char *psz_msg_str, const int str_len)

function pointer tyee for library default logger output to allow client to print zero terminated output string

Definition at line 95 of file ocsd_c_api_types.h.

◆ FnDefPktDataIn

typedef ocsd_datapath_resp_t(* FnDefPktDataIn) (const void *p_context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const void *p_packet_in)

function pointer type for packet processor packet output sink, packet analyser/decoder input - generic declaration

Definition at line 81 of file ocsd_c_api_types.h.

◆ FnDefPktDataMon

typedef void(* FnDefPktDataMon) (const void *p_context, const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const void *p_packet_in, const uint32_t size, const uint8_t *p_data)

function pointer type for packet processor packet monitor sink, raw packet monitor / display input - generic declaration

Definition at line 87 of file ocsd_c_api_types.h.

◆ FnTraceElemIn

typedef ocsd_datapath_resp_t(* FnTraceElemIn) (const void *p_context, const ocsd_trc_index_t index_sop, const uint8_t trc_chan_id, const ocsd_generic_trace_elem *elem)

function pointer type for decoder outputs. all protocols, generic data element input

Definition at line 75 of file ocsd_c_api_types.h.

◆ ocsd_c_api_cb_types

Callback interface type when attaching monitor/sink to packet processor

Enumeration Type Documentation

◆ _ocsd_c_api_cb_types

Callback interface type when attaching monitor/sink to packet processor

Enumerator
OCSD_C_API_CB_PKT_SINK 
OCSD_C_API_CB_PKT_MON 

Attach to the packet processor primary packet output (CB fn is FnDefPktDataIn)

Definition at line 98 of file ocsd_c_api_types.h.