1*c120c564SAndrew Turner /*
2*c120c564SAndrew Turner * \file gen_elem_printer.h
3*c120c564SAndrew Turner * \brief OpenCSD : Generic element printer class.
4*c120c564SAndrew Turner *
5*c120c564SAndrew Turner * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved.
6*c120c564SAndrew Turner */
7*c120c564SAndrew Turner
8*c120c564SAndrew Turner /*
9*c120c564SAndrew Turner * Redistribution and use in source and binary forms, with or without modification,
10*c120c564SAndrew Turner * are permitted provided that the following conditions are met:
11*c120c564SAndrew Turner *
12*c120c564SAndrew Turner * 1. Redistributions of source code must retain the above copyright notice,
13*c120c564SAndrew Turner * this list of conditions and the following disclaimer.
14*c120c564SAndrew Turner *
15*c120c564SAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright notice,
16*c120c564SAndrew Turner * this list of conditions and the following disclaimer in the documentation
17*c120c564SAndrew Turner * and/or other materials provided with the distribution.
18*c120c564SAndrew Turner *
19*c120c564SAndrew Turner * 3. Neither the name of the copyright holder nor the names of its contributors
20*c120c564SAndrew Turner * may be used to endorse or promote products derived from this software without
21*c120c564SAndrew Turner * specific prior written permission.
22*c120c564SAndrew Turner *
23*c120c564SAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
24*c120c564SAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25*c120c564SAndrew Turner * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26*c120c564SAndrew Turner * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27*c120c564SAndrew Turner * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28*c120c564SAndrew Turner * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29*c120c564SAndrew Turner * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30*c120c564SAndrew Turner * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31*c120c564SAndrew Turner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32*c120c564SAndrew Turner * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33*c120c564SAndrew Turner */
34*c120c564SAndrew Turner #ifndef ARM_GEN_ELEM_PRINTER_H_INCLUDED
35*c120c564SAndrew Turner #define ARM_GEN_ELEM_PRINTER_H_INCLUDED
36*c120c564SAndrew Turner
37*c120c564SAndrew Turner #include "opencsd.h"
38*c120c564SAndrew Turner
39*c120c564SAndrew Turner class TrcGenericElementPrinter : public ItemPrinter, public ITrcGenElemIn
40*c120c564SAndrew Turner {
41*c120c564SAndrew Turner public:
42*c120c564SAndrew Turner TrcGenericElementPrinter();
~TrcGenericElementPrinter()43*c120c564SAndrew Turner virtual ~TrcGenericElementPrinter() {};
44*c120c564SAndrew Turner
45*c120c564SAndrew Turner virtual ocsd_datapath_resp_t TraceElemIn(const ocsd_trc_index_t index_sop,
46*c120c564SAndrew Turner const uint8_t trc_chan_id,
47*c120c564SAndrew Turner const OcsdTraceElement &elem);
48*c120c564SAndrew Turner
49*c120c564SAndrew Turner // funtionality to test wait / flush mechanism
ackWait()50*c120c564SAndrew Turner void ackWait() { m_needWaitAck = false; };
needAckWait()51*c120c564SAndrew Turner const bool needAckWait() const { return m_needWaitAck; };
52*c120c564SAndrew Turner
53*c120c564SAndrew Turner protected:
54*c120c564SAndrew Turner bool m_needWaitAck;
55*c120c564SAndrew Turner };
56*c120c564SAndrew Turner
57*c120c564SAndrew Turner
TrcGenericElementPrinter()58*c120c564SAndrew Turner inline TrcGenericElementPrinter::TrcGenericElementPrinter() :
59*c120c564SAndrew Turner m_needWaitAck(false)
60*c120c564SAndrew Turner {
61*c120c564SAndrew Turner }
62*c120c564SAndrew Turner
TraceElemIn(const ocsd_trc_index_t index_sop,const uint8_t trc_chan_id,const OcsdTraceElement & elem)63*c120c564SAndrew Turner inline ocsd_datapath_resp_t TrcGenericElementPrinter::TraceElemIn(const ocsd_trc_index_t index_sop,
64*c120c564SAndrew Turner const uint8_t trc_chan_id,
65*c120c564SAndrew Turner const OcsdTraceElement &elem)
66*c120c564SAndrew Turner {
67*c120c564SAndrew Turner ocsd_datapath_resp_t resp = OCSD_RESP_CONT;
68*c120c564SAndrew Turner std::string elemStr;
69*c120c564SAndrew Turner std::ostringstream oss;
70*c120c564SAndrew Turner oss << "Idx:" << index_sop << "; ID:"<< std::hex << (uint32_t)trc_chan_id << "; ";
71*c120c564SAndrew Turner elem.toString(elemStr);
72*c120c564SAndrew Turner oss << elemStr << std::endl;
73*c120c564SAndrew Turner itemPrintLine(oss.str());
74*c120c564SAndrew Turner
75*c120c564SAndrew Turner // funtionality to test wait / flush mechanism
76*c120c564SAndrew Turner if(m_needWaitAck)
77*c120c564SAndrew Turner {
78*c120c564SAndrew Turner oss.str("");
79*c120c564SAndrew Turner oss << "WARNING: Generic Element Printer; New element without previous _WAIT acknowledged\n";
80*c120c564SAndrew Turner itemPrintLine(oss.str());
81*c120c564SAndrew Turner m_needWaitAck = false;
82*c120c564SAndrew Turner }
83*c120c564SAndrew Turner
84*c120c564SAndrew Turner if(getTestWaits())
85*c120c564SAndrew Turner {
86*c120c564SAndrew Turner resp = OCSD_RESP_WAIT; // return _WAIT for the 1st N packets.
87*c120c564SAndrew Turner decTestWaits();
88*c120c564SAndrew Turner m_needWaitAck = true;
89*c120c564SAndrew Turner }
90*c120c564SAndrew Turner return resp;
91*c120c564SAndrew Turner }
92*c120c564SAndrew Turner
93*c120c564SAndrew Turner #endif // ARM_GEN_ELEM_PRINTER_H_INCLUDED
94*c120c564SAndrew Turner
95*c120c564SAndrew Turner /* End of File gen_elem_printer.h */
96