OpenCSD - CoreSight Trace Decode Library  0.12.1
ocsd_if_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_IF_TYPES_H_INCLUDED
36 #define ARM_OCSD_IF_TYPES_H_INCLUDED
37 
38 #include <stdint.h>
39 #include <stddef.h>
40 #if defined(_MSC_VER) && (_MSC_VER < 1900)
41 
42 #define __PRI64_PREFIX "ll"
43 #define PRIX64 __PRI64_PREFIX "X"
44 #define PRIu64 __PRI64_PREFIX "u"
45 #define PRIu32 "u"
46 #else
47 #include <inttypes.h>
48 #endif
49 
50 
63 #ifdef ENABLE_LARGE_TRACE_SOURCES
64 typedef uint64_t ocsd_trc_index_t;
65 #define OCSD_TRC_IDX_STR PRIu64
66 #else
67 typedef uint32_t ocsd_trc_index_t;
68 #define OCSD_TRC_IDX_STR PRIu32
69 #endif
70 
72 #define OCSD_BAD_TRC_INDEX ((ocsd_trc_index_t)-1)
73 
74 #define OCSD_BAD_CS_SRC_ID ((uint8_t)-1)
75 
76 #define OCSD_IS_VALID_CS_SRC_ID(id) ((id > 0) && (id < 0x70))
77 
78 #define OCSD_IS_RESERVED_CS_SRC_ID(id) ((id == 0) || ((id >= 0x70) && (id <= 0x7F))
79 
85 typedef enum _ocsd_err_t {
86 
87  /* general return errors */
88  OCSD_OK = 0,
98  /* attachment point errors */
102  /* source reader errors */
106  /* data path errors */
108  /* frame deformatter errors */
111  /* packet processor errors - protocol issues etc */
115  /* packet decoder errors */
123  /* decode tree errors */
125  /* target memory access errors */
131  /* test errors - errors generated only by the test code, not the library */
136  /* decoder registration */
141  /* decoder config */
143  /* end marker*/
145 } ocsd_err_t;
146 
147 /* component handle types */
148 typedef unsigned int ocsd_hndl_rdr_t;
149 typedef unsigned int ocsd_hndl_err_log_t;
151 /* common invalid handle type */
152 #define OCSD_INVALID_HANDLE (unsigned int)-1
166 typedef enum _ocsd_err_severity_t {
172 
180 typedef enum _ocsd_datapath_op_t {
186 
190 typedef enum _ocsd_datapath_resp_t {
203 
205 #define OCSD_DATA_RESP_IS_FATAL(x) (x >= OCSD_RESP_FATAL_NOT_INIT)
206 
207 #define OCSD_DATA_RESP_IS_WARN(x) ((x == OCSD_RESP_WARN_CONT) || (x == OCSD_RESP_WARN_WAIT))
208 
209 #define OCSD_DATA_RESP_IS_ERR(x) ((x == OCSD_RESP_ERR_CONT) || (x == OCSD_RESP_ERR_WAIT))
210 
211 #define OCSD_DATA_RESP_IS_WARN_OR_ERR(x) (OCSD_DATA_RESP_IS_ERR(x) || OCSD_DATA_RESP_IS_WARN(x))
212 
213 #define OCSD_DATA_RESP_IS_CONT(x) (x < OCSD_RESP_WAIT)
214 
215 #define OCSD_DATA_RESP_IS_WAIT(x) ((x >= OCSD_RESP_WAIT) && (x < OCSD_RESP_FATAL_NOT_INIT))
216 
233 
234 
238 typedef enum _ocsd_dcd_tree_src_t {
242 
243 #define OCSD_DFRMTR_HAS_FSYNCS 0x01
244 #define OCSD_DFRMTR_HAS_HSYNCS 0x02
245 #define OCSD_DFRMTR_FRAME_MEM_ALIGN 0x04
246 #define OCSD_DFRMTR_PACKED_RAW_OUT 0x08
247 #define OCSD_DFRMTR_UNPACKED_RAW_OUT 0x10
248 #define OCSD_DFRMTR_RESET_ON_4X_FSYNC 0x20
249 #define OCSD_DFRMTR_VALID_MASK 0x3F
251 #define OCSD_DFRMTR_FRAME_SIZE 0x10
261 #define OCSD_CMPNAME_PREFIX_SOURCE_READER "SRDR"
262 
263 #define OCSD_CMPNAME_PREFIX_FRAMEDEFORMATTER "DFMT"
264 
265 #define OCSD_CMPNAME_PREFIX_PKTPROC "PKTP"
266 
267 #define OCSD_CMPNAME_PREFIX_PKTDEC "PDEC"
268 
275 typedef enum _ocsd_arch_version {
282 
283 // macros for arch version comparisons.
284 #define OCSD_IS_V8_ARCH(arch) ((arch >= ARCH_V8) && (arch <= ARCH_V8r3))
285 #define OCSD_MIN_V8_ARCH(arch) (arch >= ARCH_V8)
286 
288 typedef enum _ocsd_core_profile {
295 
297 typedef struct _ocsd_arch_profile_t {
301 
302 /* may want to use a 32 bit v-addr when running on 32 bit only ARM platforms. */
303 #ifdef USE_32BIT_V_ADDR
304 typedef uint32_t ocsd_vaddr_t;
305 #define OCSD_MAX_VA_BITSIZE 32
306 #define OCSD_VA_MASK ~0UL
307 #else
308 typedef uint64_t ocsd_vaddr_t;
309 #define OCSD_MAX_VA_BITSIZE 64
310 #define OCSD_VA_MASK ~0ULL
311 #endif
312 
314 #define OCSD_BIT_MASK(bits) (bits == OCSD_MAX_VA_BITSIZE) ? OCSD_VA_MASK : ((ocsd_vaddr_t)1 << bits) - 1
315 
324 typedef enum _ocsd_isa
325 {
333 } ocsd_isa;
334 
337 typedef enum _ocsd_sec_level
338 {
341 } ocsd_sec_level ;
342 
345 typedef enum _ocsd_ex_level
346 {
348  ocsd_EL0 = 0,
352 } ocsd_ex_level;
353 
354 
356 typedef enum _ocsd_instr_type {
364 
368 typedef enum _ocsd_instr_subtype {
375 
382 typedef struct _ocsd_instr_info {
383  /* input information */
387  uint32_t opcode;
389  uint8_t wfi_wfe_branch;
391  /* instruction decode info */
395  uint8_t instr_size;
396  uint8_t is_conditional;
397  uint8_t is_link;
401 
402 
406 typedef struct _ocsd_pe_context {
409  uint32_t context_id;
410  uint32_t vmid;
411  struct {
412  uint32_t bits64:1;
413  uint32_t ctxt_id_valid:1;
414  uint32_t vmid_valid:1;
415  uint32_t el_valid:1;
416  };
418 
419 
428 typedef enum _ocsd_mem_space_acc_t {
437 
459 typedef uint32_t (* Fn_MemAcc_CB)(const void *p_context, const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint32_t reqBytes, uint8_t *byteBuffer);
460 
483 typedef uint32_t (* Fn_MemAccID_CB)(const void *p_context, const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint8_t trcID, const uint32_t reqBytes, uint8_t *byteBuffer);
484 
485 
487 typedef struct _ocsd_file_mem_region {
488  size_t file_offset;
490  size_t region_size;
492 
500 #define OCSD_OPFLG_PKTPROC_NOFWD_BAD_PKTS 0x00000001
501 #define OCSD_OPFLG_PKTPROC_NOMON_BAD_PKTS 0x00000002
502 #define OCSD_OPFLG_PKTPROC_ERR_BAD_PKTS 0x00000004
503 #define OCSD_OPFLG_PKTPROC_UNSYNC_ON_BAD_PKTS 0x00000008
506 #define OCSD_OPFLG_PKTPROC_COMMON (OCSD_OPFLG_PKTPROC_NOFWD_BAD_PKTS | \
507  OCSD_OPFLG_PKTPROC_NOMON_BAD_PKTS | \
508  OCSD_OPFLG_PKTPROC_ERR_BAD_PKTS | \
509  OCSD_OPFLG_PKTPROC_UNSYNC_ON_BAD_PKTS )
510 
518 #define OCSD_OPFLG_PKTDEC_ERROR_BAD_PKTS 0x00000001
521 #define OCSD_OPFLG_PKTDEC_COMMON (OCSD_OPFLG_PKTDEC_ERROR_BAD_PKTS)
522 
534 #define OCSD_CREATE_FLG_PACKET_PROC 0x01
535 #define OCSD_CREATE_FLG_FULL_DECODER 0x02
536 #define OCSD_CREATE_FLG_INST_ID 0x04
538 #define OCSD_BUILTIN_DCD_STM "STM"
539 #define OCSD_BUILTIN_DCD_ETMV3 "ETMV3"
540 #define OCSD_BUILTIN_DCD_ETMV4I "ETMV4I"
541 #define OCSD_BUILTIN_DCD_ETMV4D "ETMV4D"
542 #define OCSD_BUILTIN_DCD_PTM "PTM"
546 typedef enum _ocsd_trace_protocol_t {
549 /* Built in library decoders */
556 /* others to be added here */
559 /* Custom / external decoders */
570 
573 
575 #define OCSD_PROTOCOL_IS_BUILTIN(P) ((P > OCSD_PROTOCOL_UNKNOWN) && (P < OCSD_PROTOCOL_BUILTIN_END))
576 
578 #define OCSD_PROTOCOL_IS_CUSTOM(P) ((P >= OCSD_PROTOCOL_CUSTOM_0) && (P < OCSD_PROTOCOL_END ))
579 
598 typedef struct _ocsd_swt_info {
599  uint16_t swt_master_id;
600  uint16_t swt_channel_id;
601  union {
602  struct {
605  uint32_t swt_marker_packet:1;
606  uint32_t swt_has_timestamp:1;
607  uint32_t swt_marker_first:1;
608  uint32_t swt_master_err:1;
609  uint32_t swt_global_err:1;
610  uint32_t swt_trigger_event:1;
611  uint32_t swt_frequency:1;
612  uint32_t swt_id_valid:1;
613  };
614  uint32_t swt_flag_bits;
615  };
617 
619 #define SWT_ID_VALID_MASK (0x1 << 23)
620 
624 #endif // ARM_OCSD_IF_TYPES_H_INCLUDED
625 
626 /* End of File opencsd/ocsd_if_types.h */
enum _ocsd_datapath_op_t ocsd_datapath_op_t
uint32_t swt_master_err
uint32_t swt_has_timestamp
ocsd_ex_level exception_level
_ocsd_datapath_op_t
uint32_t swt_marker_packet
uint32_t(* Fn_MemAcc_CB)(const void *p_context, const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint32_t reqBytes, uint8_t *byteBuffer)
_ocsd_datapath_resp_t
ocsd_core_profile_t profile
uint32_t ctxt_id_valid
uint32_t swt_global_err
_ocsd_mem_space_acc_t
uint64_t ocsd_vaddr_t
uint16_t swt_channel_id
struct _ocsd_arch_profile_t ocsd_arch_profile_t
enum _ocsd_datapath_resp_t ocsd_datapath_resp_t
_ocsd_instr_subtype
struct _ocsd_file_mem_region ocsd_file_mem_region_t
enum _ocsd_ex_level ocsd_ex_level
ocsd_vaddr_t instr_addr
uint32_t(* Fn_MemAccID_CB)(const void *p_context, const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint8_t trcID, const uint32_t reqBytes, uint8_t *byteBuffer)
enum _ocsd_instr_type ocsd_instr_type
uint32_t swt_trigger_event
struct _ocsd_instr_info ocsd_instr_info
enum _ocsd_dcd_tree_src_t ocsd_dcd_tree_src_t
uint32_t swt_payload_pkt_bitsize
enum _ocsd_err_t ocsd_err_t
_ocsd_instr_type
_ocsd_arch_version
_ocsd_ex_level
ocsd_instr_subtype sub_type
uint8_t thumb_it_conditions
struct _ocsd_pe_context ocsd_pe_context
enum _ocsd_core_profile ocsd_core_profile_t
ocsd_arch_profile_t pe_type
ocsd_vaddr_t start_address
enum _ocsd_isa ocsd_isa
unsigned int ocsd_hndl_err_log_t
uint32_t swt_marker_first
uint32_t swt_id_valid
enum _ocsd_sec_level ocsd_sec_level
_rcdtl_rawframe_elem_t
enum _ocsd_mem_space_acc_t ocsd_mem_space_acc_t
ocsd_arch_version_t arch
uint32_t swt_payload_num_packets
enum _rcdtl_rawframe_elem_t ocsd_rawframe_elem_t
uint8_t is_conditional
uint8_t dsb_dmb_waypoints
ocsd_vaddr_t branch_addr
ocsd_sec_level security_level
uint8_t wfi_wfe_branch
_ocsd_core_profile
uint32_t ocsd_trc_index_t
Definition: ocsd_if_types.h:67
ocsd_instr_type type
_ocsd_err_t
Definition: ocsd_if_types.h:85
uint32_t swt_frequency
_ocsd_sec_level
_ocsd_isa
enum _ocsd_trace_protocol_t ocsd_trace_protocol_t
uint16_t swt_master_id
_ocsd_dcd_tree_src_t
enum _ocsd_instr_subtype ocsd_instr_subtype
struct _ocsd_swt_info ocsd_swt_info_t
enum _ocsd_arch_version ocsd_arch_version_t
unsigned int ocsd_hndl_rdr_t
enum _ocsd_err_severity_t ocsd_err_severity_t
uint32_t swt_flag_bits