xref: /freebsd/contrib/opencsd/decoder/include/opencsd.h (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1 /*!
2  * \file       opencsd.h
3  * \brief      OpenCSD: Open CoreSight Trace Decoder -Master include file for C++ library
4  *
5  * \copyright  Copyright (c) 2015, ARM Limited. All Rights Reserved.
6  */
7 
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_OPENCSD_H_INCLUDED
36 #define ARM_OPENCSD_H_INCLUDED
37 
38 /** C interface types */
39 #include "opencsd/ocsd_if_types.h"
40 #include "opencsd/trc_pkt_types.h"
41 #include "opencsd/trc_gen_elem_types.h"
42 
43 /* C++ abstract interfaces */
44 #include "interfaces/trc_data_raw_in_i.h"
45 #include "interfaces/trc_data_rawframe_in_i.h"
46 #include "interfaces/trc_error_log_i.h"
47 #include "interfaces/trc_gen_elem_in_i.h"
48 #include "interfaces/trc_instr_decode_i.h"
49 #include "interfaces/trc_pkt_in_i.h"
50 #include "interfaces/trc_pkt_raw_in_i.h"
51 #include "interfaces/trc_tgt_mem_access_i.h"
52 
53 /* protocol base classes and generic elements */
54 #include "common/ocsd_version.h"
55 #include "common/ocsd_error.h"
56 #include "common/trc_gen_elem.h"
57 #include "common/trc_core_arch_map.h"
58 
59 /** Implemented Protocol decoders */
60 #include "common/trc_frame_deformatter.h"
61 
62 #include "opencsd/etmv3/etmv3_decoder.h"
63 #include "opencsd/etmv4/etmv4_decoder.h"
64 #include "opencsd/ptm/ptm_decoder.h"
65 #include "opencsd/stm/stm_decoder.h"
66 
67 /** C++ library object types */
68 #include "common/ocsd_error_logger.h"
69 #include "common/ocsd_msg_logger.h"
70 #include "i_dec/trc_i_decode.h"
71 #include "mem_acc/trc_mem_acc.h"
72 
73 /* printers for builtin packet elements */
74 #include "pkt_printers/trc_pkt_printers.h"
75 #include "pkt_printers/trc_print_fact.h"
76 
77 /** The decode tree and decoder register*/
78 #include "common/ocsd_lib_dcd_register.h"
79 #include "common/ocsd_dcd_tree.h"
80 
81 
82 #endif // ARM_OPENCSD_H_INCLUDED
83 
84 /* End of File opencsd.h */
85