OpenCSD - CoreSight Trace Decode Library  0.9.0
trc_pkt_decode_base.h
Go to the documentation of this file.
1 
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_DECODE_BASE_H_INCLUDED
36 #define ARM_TRC_PKT_DECODE_BASE_H_INCLUDED
37 
38 #include "trc_component.h"
39 #include "comp_attach_pt_t.h"
40 
45 
62 {
63 public:
64  TrcPktDecodeI(const char *component_name);
65  TrcPktDecodeI(const char *component_name, int instIDNum);
66  virtual ~TrcPktDecodeI() {};
67 
71 
72  void setUsesMemAccess(bool bUsesMemaccess) { m_uses_memaccess = bUsesMemaccess; };
73  const bool getUsesMemAccess() const { return m_uses_memaccess; };
74 
75  void setUsesIDecode(bool bUsesIDecode) { m_uses_idecode = bUsesIDecode; };
76  const bool getUsesIDecode() const { return m_uses_idecode; };
77 
78 protected:
79 
80  /* implementation packet decoding interface */
81  virtual ocsd_datapath_resp_t processPacket() = 0;
82  virtual ocsd_datapath_resp_t onEOT() = 0;
83  virtual ocsd_datapath_resp_t onReset() = 0;
84  virtual ocsd_datapath_resp_t onFlush() = 0;
85  virtual ocsd_err_t onProtocolConfig() = 0;
86  virtual const uint8_t getCoreSightTraceID() = 0;
87 
88  const bool checkInit();
89 
90  /* data output */
91  ocsd_datapath_resp_t outputTraceElement(const OcsdTraceElement &elem); // use current index
92  ocsd_datapath_resp_t outputTraceElementIdx(ocsd_trc_index_t idx, const OcsdTraceElement &elem); // use supplied index (where decoder caches elements)
93 
94  /* target access */
95  ocsd_err_t accessMemory(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, uint32_t *num_bytes, uint8_t *p_buffer);
96 
97  /* instruction decode */
99 
103 
105 
108 
109  std::string init_err_msg;
110 
113 
114 };
115 
116 inline TrcPktDecodeI::TrcPktDecodeI(const char *component_name) :
117  TraceComponent(component_name),
118  m_index_curr_pkt(0),
119  m_decode_init_ok(false),
120  m_config_init_ok(false),
121  m_uses_memaccess(true),
122  m_uses_idecode(true)
123 {
124 }
125 
126 inline TrcPktDecodeI::TrcPktDecodeI(const char *component_name, int instIDNum) :
127  TraceComponent(component_name, instIDNum),
128  m_index_curr_pkt(0),
129  m_decode_init_ok(false),
130  m_config_init_ok(false),
131  m_uses_memaccess(true),
132  m_uses_idecode(true)
133 {
134 }
135 
136 inline const bool TrcPktDecodeI::checkInit()
137 {
138  if(!m_decode_init_ok)
139  {
140  if(!m_config_init_ok)
141  init_err_msg = "No decoder configuration information";
143  init_err_msg = "No element output interface attached and enabled";
145  init_err_msg = "No memory access interface attached and enabled";
147  init_err_msg = "No instruction decoder interface attached and enabled";
148  else
149  m_decode_init_ok = true;
150  }
151  return m_decode_init_ok;
152 }
153 
155 {
157 }
158 
160 {
161  return m_trace_elem_out.first()->TraceElemIn(idx, getCoreSightTraceID(), elem);
162 }
163 
165 {
166  if(m_uses_idecode)
167  return m_instr_decode.first()->DecodeInstruction(instr_info);
169 }
170 
171 inline ocsd_err_t TrcPktDecodeI::accessMemory(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, uint32_t *num_bytes, uint8_t *p_buffer)
172 {
173  if(m_uses_memaccess)
174  return m_mem_access.first()->ReadTargetMemory(address,getCoreSightTraceID(),mem_space, num_bytes,p_buffer);
176 }
177 
178 /**********************************************************************/
179 template <class P, class Pc>
180 class TrcPktDecodeBase : public TrcPktDecodeI, public IPktDataIn<P>
181 {
182 public:
183  TrcPktDecodeBase(const char *component_name);
184  TrcPktDecodeBase(const char *component_name, int instIDNum);
185  virtual ~TrcPktDecodeBase();
186 
187  virtual ocsd_datapath_resp_t PacketDataIn( const ocsd_datapath_op_t op,
188  const ocsd_trc_index_t index_sop,
189  const P *p_packet_in);
190 
191 
192  /* protocol configuration */
193  ocsd_err_t setProtocolConfig(const Pc *config);
194  const Pc * getProtocolConfig() const { return m_config; };
195 
196 protected:
197  void ClearConfigObj();
198 
199  /* the protocol configuration */
200  Pc * m_config;
201  /* the current input packet */
202  const P * m_curr_packet_in;
203 
204 };
205 
206 
207 template <class P, class Pc> TrcPktDecodeBase<P, Pc>::TrcPktDecodeBase(const char *component_name) :
208  TrcPktDecodeI(component_name),
209  m_config(0)
210 {
211 }
212 
213 template <class P, class Pc> TrcPktDecodeBase<P, Pc>::TrcPktDecodeBase(const char *component_name, int instIDNum) :
214  TrcPktDecodeI(component_name,instIDNum),
215  m_config(0)
216 {
217 }
218 
219 template <class P, class Pc> TrcPktDecodeBase<P, Pc>::~TrcPktDecodeBase()
220 {
221  ClearConfigObj();
222 }
223 
225  const ocsd_trc_index_t index_sop,
226  const P *p_packet_in)
227 {
229  if(!checkInit())
230  {
233  }
234 
235  switch(op)
236  {
237  case OCSD_OP_DATA:
238  if(p_packet_in == 0)
239  {
242  }
243  else
244  {
245  m_curr_packet_in = p_packet_in;
246  m_index_curr_pkt = index_sop;
247  resp = processPacket();
248  }
249  break;
250 
251  case OCSD_OP_EOT:
252  resp = onEOT();
253  break;
254 
255  case OCSD_OP_FLUSH:
256  resp = onFlush();
257  break;
258 
259  case OCSD_OP_RESET:
260  resp = onReset();
261  break;
262 
263  default:
266  break;
267  }
268  return resp;
269 }
270 
271  /* protocol configuration */
272 template <class P, class Pc> ocsd_err_t TrcPktDecodeBase<P, Pc>::setProtocolConfig(const Pc *config)
273 {
275  if(config != 0)
276  {
277  ClearConfigObj(); // remove any current config
278  m_config = new (std::nothrow) Pc(*config); // make a copy of the config - don't rely on the object passed in being valid outside the context of the call.
279  if(m_config != 0)
280  {
281  err = onProtocolConfig();
282  if(err == OCSD_OK)
283  m_config_init_ok = true;
284  }
285  else
286  err = OCSD_ERR_MEM;
287  }
288  return err;
289 }
290 
291 template <class P, class Pc> void TrcPktDecodeBase<P, Pc>::ClearConfigObj()
292 {
293  if(m_config)
294  {
295  delete m_config;
296  m_config = 0;
297  }
298 }
299 
301 #endif // ARM_TRC_PKT_DECODE_BASE_H_INCLUDED
302 
303 /* End of File trc_pkt_decode_base.h */
enum _ocsd_datapath_op_t ocsd_datapath_op_t
virtual ocsd_datapath_resp_t TraceElemIn(const ocsd_trc_index_t index_sop, const uint8_t trc_chan_id, const OcsdTraceElement &elem)=0
virtual ocsd_datapath_resp_t onEOT()=0
ocsd_err_t accessMemory(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, uint32_t *num_bytes, uint8_t *p_buffer)
uint64_t ocsd_vaddr_t
virtual const uint8_t getCoreSightTraceID()=0
enum _ocsd_datapath_resp_t ocsd_datapath_resp_t
componentAttachPt< ITargetMemAccess > m_mem_access
ocsd_datapath_resp_t outputTraceElement(const OcsdTraceElement &elem)
const Pc * getProtocolConfig() const
componentAttachPt< IInstrDecode > m_instr_decode
void setUsesIDecode(bool bUsesIDecode)
virtual ocsd_datapath_resp_t processPacket()=0
componentAttachPt< ITrcGenElemIn > * getTraceElemOutAttachPt()
virtual ocsd_datapath_resp_t onFlush()=0
virtual ocsd_err_t onProtocolConfig()=0
Base class for all decode components in the library.
Definition: trc_component.h:56
ocsd_err_t setProtocolConfig(const Pc *config)
virtual ocsd_datapath_resp_t onReset()=0
const bool getUsesMemAccess() const
enum _ocsd_err_t ocsd_err_t
void setUsesMemAccess(bool bUsesMemaccess)
TrcPktDecodeI(const char *component_name)
ocsd_err_t instrDecode(ocsd_instr_info *instr_info)
TrcPktDecodeBase(const char *component_name)
virtual ocsd_err_t DecodeInstruction(ocsd_instr_info *instr_info)=0
void LogError(const ocsdError &Error)
const bool getUsesIDecode() const
Generic trace element class.
Definition: trc_gen_elem.h:49
componentAttachPt< IInstrDecode > * getInstrDecodeAttachPt()
virtual T * first()
virtual ocsd_datapath_resp_t PacketDataIn(const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const P *p_packet_in)
bool m_config_init_ok
set true if config set.
enum _ocsd_mem_space_acc_t ocsd_mem_space_acc_t
bool m_decode_init_ok
set true if all attachments in place for decode. (remove checks in main throughput paths) ...
const bool hasAttachedAndEnabled() const
virtual ~TrcPktDecodeI()
ocsd_datapath_resp_t outputTraceElementIdx(ocsd_trc_index_t idx, const OcsdTraceElement &elem)
virtual ocsd_err_t ReadTargetMemory(const ocsd_vaddr_t address, const uint8_t cs_trace_id, const ocsd_mem_space_acc_t mem_space, uint32_t *num_bytes, uint8_t *p_buffer)=0
uint32_t ocsd_trc_index_t
Definition: ocsd_if_types.h:67
std::string init_err_msg
error message for init error
OpenCSD : Base trace decode component.
Interface class providing an input for discrete protocol packets.
Definition: trc_pkt_in_i.h:54
const bool checkInit()
ocsd_trc_index_t m_index_curr_pkt
componentAttachPt< ITargetMemAccess > * getMemoryAccessAttachPt()
OpenCSD : Component attachment point interface class.
componentAttachPt< ITrcGenElemIn > m_trace_elem_out