1 /*
2  * \file       trc_pkt_proc_etmv4.h
3  * \brief      OpenCSD : ETMv4 packet processor interface classes.
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_TRC_PKT_PROC_ETMV4_H_INCLUDED
36 #define ARM_TRC_PKT_PROC_ETMV4_H_INCLUDED
37 
38 
39 #include "trc_pkt_types_etmv4.h"
40 #include "common/trc_pkt_proc_base.h"
41 
42 class EtmV4IPktProcImpl;    /**< ETMv4 I channel packet processor */
43 class EtmV4DPktProcImpl;    /**< ETMv4 D channel packet processor */
44 class EtmV4ITrcPacket;
45 class EtmV4DTrcPacket;
46 class EtmV4Config;
47 
48 /** @addtogroup ocsd_pkt_proc
49 @{*/
50 
51 class TrcPktProcEtmV4I : public TrcPktProcBase< EtmV4ITrcPacket,  ocsd_etmv4_i_pkt_type, EtmV4Config>
52 {
53 public:
54     TrcPktProcEtmV4I();
55     TrcPktProcEtmV4I(int instIDNum);
56     virtual ~TrcPktProcEtmV4I();
57 
58 protected:
59     /* implementation packet processing interface */
60     virtual ocsd_datapath_resp_t processData(  const ocsd_trc_index_t index,
61                                                 const uint32_t dataBlockSize,
62                                                 const uint8_t *pDataBlock,
63                                                 uint32_t *numBytesProcessed);
64     virtual ocsd_datapath_resp_t onEOT();
65     virtual ocsd_datapath_resp_t onReset();
66     virtual ocsd_datapath_resp_t onFlush();
67     virtual ocsd_err_t onProtocolConfig();
68     virtual const bool isBadPacket() const;
69 
70     friend class EtmV4IPktProcImpl;
71 
72     EtmV4IPktProcImpl *m_pProcessor;
73 };
74 
75 
76 class TrcPktProcEtmV4D : public TrcPktProcBase< EtmV4DTrcPacket,  ocsd_etmv4_d_pkt_type, EtmV4Config>
77 {
78 public:
79     TrcPktProcEtmV4D();
80     TrcPktProcEtmV4D(int instIDNum);
81     virtual ~TrcPktProcEtmV4D();
82 
83 protected:
84     /* implementation packet processing interface */
85     virtual ocsd_datapath_resp_t processData(  const ocsd_trc_index_t index,
86                                                 const uint32_t dataBlockSize,
87                                                 const uint8_t *pDataBlock,
88                                                 uint32_t *numBytesProcessed);
89     virtual ocsd_datapath_resp_t onEOT();
90     virtual ocsd_datapath_resp_t onReset();
91     virtual ocsd_datapath_resp_t onFlush();
92     virtual ocsd_err_t onProtocolConfig();
93     virtual const bool isBadPacket() const;
94 
95     friend class EtmV4DPktProcImpl;
96 
97     EtmV4DPktProcImpl *m_pProcessor;
98 };
99 
100 /** @}*/
101 
102 #endif // ARM_TRC_PKT_PROC_ETMV4_H_INCLUDED
103 
104 /* End of File trc_pkt_proc_etmv4.h */
105