OpenCSD - CoreSight Trace Decode Library  1.3.3
trc_pkt_decode_stm.h
Go to the documentation of this file.
1 /*
2  * \file trc_pkt_decode_stm.h
3  * \brief OpenCSD : STM packet decoder
4  *
5  * Convert the incoming indidvidual STM packets to
6  *
7  * \copyright Copyright (c) 2016, ARM Limited. All Rights Reserved.
8  */
9 
10 
11 /*
12  * Redistribution and use in source and binary forms, with or without modification,
13  * are permitted provided that the following conditions are met:
14  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  * this list of conditions and the following disclaimer.
17  *
18  * 2. Redistributions in binary form must reproduce the above copyright notice,
19  * this list of conditions and the following disclaimer in the documentation
20  * and/or other materials provided with the distribution.
21  *
22  * 3. Neither the name of the copyright holder nor the names of its contributors
23  * may be used to endorse or promote products derived from this software without
24  * specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
28  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29  * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
30  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
31  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
33  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 
39 #ifndef ARM_TRC_PKT_DECODE_STM_H_INCLUDED
40 #define ARM_TRC_PKT_DECODE_STM_H_INCLUDED
41 
42 
46 #include "common/trc_gen_elem.h"
47 
48 class TrcPktDecodeStm : public TrcPktDecodeBase<StmTrcPacket, STMConfig>
49 {
50 public:
52  TrcPktDecodeStm(int instIDNum);
53  virtual ~TrcPktDecodeStm();
54 
55 protected:
56  /* implementation packet decoding interface */
62  virtual const uint8_t getCoreSightTraceID() { return m_CSID; };
63 
64  /* local decode methods */
65 
66 private:
67  void initDecoder();
68  void resetDecoder();
69  void initPayloadBuffer();
70  bool isInit() { return (bool)((m_config != 0) && (m_payload_buffer != 0)); };
71  ocsd_datapath_resp_t decodePacket(bool &bPktDone);
72  void clearSWTPerPcktInfo();
73  void updatePayload(bool &bSendPacket);
74 
75  typedef enum {
76  NO_SYNC,
77  WAIT_SYNC,
78  DECODE_PKTS
79  } processor_state_t;
80 
81  processor_state_t m_curr_state;
82  unsync_info_t m_unsync_info;
83 
84  ocsd_swt_info_t m_swt_packet_info;
85 
86  uint8_t *m_payload_buffer;
87  int m_payload_size;
88  int m_payload_used;
89  bool m_payload_odd_nibble;
90  int m_num_pkt_correlation;
91 
92  uint8_t m_CSID;
93 
94  bool m_decode_pass1;
95 
96 
97 
98 //** output element
99  OcsdTraceElement m_output_elem;
100 };
101 
102 #endif // ARM_TRC_PKT_DECODE_STM_H_INCLUDED
103 
104 /* End of File trc_pkt_decode_stm.h */
Generic trace element class.
Definition: trc_gen_elem.h:50
virtual ~TrcPktDecodeStm()
virtual ocsd_err_t onProtocolConfig()
virtual ocsd_datapath_resp_t processPacket()
virtual ocsd_datapath_resp_t onEOT()
TrcPktDecodeStm(int instIDNum)
virtual const uint8_t getCoreSightTraceID()
virtual ocsd_datapath_resp_t onFlush()
virtual ocsd_datapath_resp_t onReset()
enum _unsync_info_t unsync_info_t
enum _ocsd_datapath_resp_t ocsd_datapath_resp_t
enum _ocsd_err_t ocsd_err_t
OpenCSD : Decoder Generic trace element output class.
OpenCSD : Trace Packet decoder base class.
OpenCSD : STM packet class.