xref: /aosp_15_r20/external/OpenCSD/decoder/include/pkt_printers/gen_elem_printer.h (revision 02ca8ccacfba7e0df68f3332a95f3180334d6649)
1 /*
2  * \file       gen_elem_printer.h
3  * \brief      OpenCSD : Generic element printer class.
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 #ifndef ARM_GEN_ELEM_PRINTER_H_INCLUDED
35 #define ARM_GEN_ELEM_PRINTER_H_INCLUDED
36 
37 #include "opencsd.h"
38 
39 class TrcGenericElementPrinter : public ItemPrinter, public ITrcGenElemIn
40 {
41 public:
42     TrcGenericElementPrinter();
~TrcGenericElementPrinter()43     virtual ~TrcGenericElementPrinter() {};
44 
45     virtual ocsd_datapath_resp_t TraceElemIn(const ocsd_trc_index_t index_sop,
46                                               const uint8_t trc_chan_id,
47                                               const OcsdTraceElement &elem);
48 
49     // funtionality to test wait / flush mechanism
ackWait()50     void ackWait() { m_needWaitAck = false; };
needAckWait()51     const bool needAckWait() const { return m_needWaitAck; };
set_collect_stats()52     void set_collect_stats() { m_collect_stats = true; };
53     void printStats();
54 
55 protected:
56     bool m_needWaitAck;
57     bool m_collect_stats;  // collect stats on packets processed
58     int m_packet_counts[(int)OCSD_GEN_TRC_ELEM_CUSTOM + 1];
59 };
60 
61 #endif // ARM_GEN_ELEM_PRINTER_H_INCLUDED
62 
63 /* End of File gen_elem_printer.h */
64