Loading...
Searching...
No Matches
ocsd_c_api_types.h
Go to the documentation of this file.
/*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ARM_OCSD_C_API_TYPES_H_INCLUDED
#define ARM_OCSD_C_API_TYPES_H_INCLUDED
/* select the library types that are C compatible - the interface data types */
#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"
/* pull in the protocol decoder types. */
#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"
/* Specific C-API only types */
typedef void * dcd_tree_handle_t;
#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
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_PKT_SINK,
OCSD_C_API_CB_PKT_MON,
} ocsd_c_api_cb_types;
#endif // ARM_OCSD_C_API_TYPES_H_INCLUDED
/* End of File ocsd_c_api_types.h */
dcd_tree_handle_t
void * dcd_tree_handle_t
Definition ocsd_c_api_types.h:58
ocsd_trc_index_t
uint32_t ocsd_trc_index_t
Definition ocsd_if_types.h:59
ocsd_datapath_resp_t
enum _ocsd_datapath_resp_t ocsd_datapath_resp_t
ocsd_datapath_op_t
enum _ocsd_datapath_op_t ocsd_datapath_op_t
FnDefPktDataIn
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)
Definition ocsd_c_api_types.h:81
FnDefLoggerPrintStrCB
void(* FnDefLoggerPrintStrCB)(const void *p_context, const char *psz_msg_str, const int str_len)
Definition ocsd_c_api_types.h:95
ocsd_c_api_cb_types
enum _ocsd_c_api_cb_types ocsd_c_api_cb_types
FnTraceElemIn
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)
Definition ocsd_c_api_types.h:75
_ocsd_c_api_cb_types
_ocsd_c_api_cb_types
Definition ocsd_c_api_types.h:98
OCSD_C_API_CB_PKT_MON
@ OCSD_C_API_CB_PKT_MON
Definition ocsd_c_api_types.h:100
OCSD_C_API_CB_PKT_SINK
@ OCSD_C_API_CB_PKT_SINK
Definition ocsd_c_api_types.h:99
FnDefPktDataMon
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)
Definition ocsd_c_api_types.h:87
ocsd_if_types.h
OpenCSD : Standard Types used in the library interfaces.
ocsd_if_version.h
_ocsd_generic_trace_elem
Definition trc_gen_elem_types.h:114
trc_gen_elem_types.h
OpenCSD : Decoder Output Generic Element types.
trc_pkt_types.h
OpenCSD: Common "C" types for trace packets.
trc_pkt_types_ete.h
trc_pkt_types_etmv3.h
trc_pkt_types_etmv4.h
trc_pkt_types_ptm.h
trc_pkt_types_stm.h