OpenCSD - CoreSight Trace Decode Library  0.14.4
ocsd_c_api_types.h
Go to the documentation of this file.
1 
8 /*
9  * Redistribution and use in source and binary forms, with or without modification,
10  * are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. Neither the name of the copyright holder nor the names of its contributors
20  * may be used to endorse or promote products derived from this software without
21  * specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef ARM_OCSD_C_API_TYPES_H_INCLUDED
36 #define ARM_OCSD_C_API_TYPES_H_INCLUDED
37 
38 /* select the library types that are C compatible - the interface data types */
39 #include "opencsd/ocsd_if_types.h"
42 #include "opencsd/trc_pkt_types.h"
43 
44 /* pull in the protocol decoder types. */
49 
54 /* Specific C-API only types */
55 
57 typedef void * dcd_tree_handle_t;
58 
60 #define C_API_INVALID_TREE_HANDLE (dcd_tree_handle_t)0
61 
63 #define C_API_MSGLOGOUT_FLG_NONE 0x0
64 
65 #define C_API_MSGLOGOUT_FLG_FILE 0x1
66 
67 #define C_API_MSGLOGOUT_FLG_STDERR 0x2
68 
69 #define C_API_MSGLOGOUT_FLG_STDOUT 0x4
70 
71 #define C_API_MSGLOGOUT_MASK 0x7
72 
74 typedef ocsd_datapath_resp_t (* FnTraceElemIn)( const void *p_context,
75  const ocsd_trc_index_t index_sop,
76  const uint8_t trc_chan_id,
77  const ocsd_generic_trace_elem *elem);
78 
80 typedef ocsd_datapath_resp_t (* FnDefPktDataIn)(const void *p_context,
81  const ocsd_datapath_op_t op,
82  const ocsd_trc_index_t index_sop,
83  const void *p_packet_in);
84 
86 typedef void (* FnDefPktDataMon)(const void *p_context,
87  const ocsd_datapath_op_t op,
88  const ocsd_trc_index_t index_sop,
89  const void *p_packet_in,
90  const uint32_t size,
91  const uint8_t *p_data);
92 
94 typedef void (* FnDefLoggerPrintStrCB)(const void *p_context, const char *psz_msg_str, const int str_len);
95 
97 typedef enum _ocsd_c_api_cb_types {
101 
104 #endif // ARM_OCSD_C_API_TYPES_H_INCLUDED
105 
106 /* End of File ocsd_c_api_types.h */
ocsd_datapath_resp_t
enum _ocsd_datapath_resp_t ocsd_datapath_resp_t
FnDefLoggerPrintStrCB
void(* FnDefLoggerPrintStrCB)(const void *p_context, const char *psz_msg_str, const int str_len)
Definition: ocsd_c_api_types.h:94
_ocsd_c_api_cb_types
_ocsd_c_api_cb_types
Definition: ocsd_c_api_types.h:97
OCSD_C_API_CB_PKT_MON
@ OCSD_C_API_CB_PKT_MON
Definition: ocsd_c_api_types.h:99
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:74
ocsd_if_types.h
OpenCSD : Standard Types used in the library interfaces.
_ocsd_generic_trace_elem
Definition: trc_gen_elem_types.h:89
trc_pkt_types_etmv4.h
trc_gen_elem_types.h
OpenCSD : Decoder Output Generic Element types.
trc_pkt_types_stm.h
trc_pkt_types_etmv3.h
ocsd_datapath_op_t
enum _ocsd_datapath_op_t ocsd_datapath_op_t
trc_pkt_types_ptm.h
dcd_tree_handle_t
void * dcd_tree_handle_t
Definition: ocsd_c_api_types.h:57
ocsd_trc_index_t
uint32_t ocsd_trc_index_t
Definition: ocsd_if_types.h:67
ocsd_if_version.h
trc_pkt_types.h
OpenCSD: Common "C" types for trace packets.
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:86
ocsd_c_api_cb_types
enum _ocsd_c_api_cb_types ocsd_c_api_cb_types
OCSD_C_API_CB_PKT_SINK
@ OCSD_C_API_CB_PKT_SINK
Definition: ocsd_c_api_types.h:98
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:80