OpenCSD - CoreSight Trace Decode Library 1.1.1
Loading...
Searching...
No Matches
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{
63public:
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
78protected:
79
80 /* implementation packet decoding interface */
86 virtual const uint8_t getCoreSightTraceID() = 0;
87
88 /* init handling */
89 const bool checkInit();
90 /* Called on first init confirmation */
91 virtual void onFirstInitOK() {};
92
93 /* data output */
94 ocsd_datapath_resp_t outputTraceElement(const OcsdTraceElement &elem); // use current index
95 ocsd_datapath_resp_t outputTraceElementIdx(ocsd_trc_index_t idx, const OcsdTraceElement &elem); // use supplied index (where decoder caches elements)
96
97 /* target access */
98 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);
99
100 /* instruction decode */
102
106
108
111
112 std::string init_err_msg;
113
116
117};
118
119inline TrcPktDecodeI::TrcPktDecodeI(const char *component_name) :
120 TraceComponent(component_name),
121 m_index_curr_pkt(0),
122 m_decode_init_ok(false),
123 m_config_init_ok(false),
124 m_uses_memaccess(true),
125 m_uses_idecode(true)
126{
127}
128
129inline TrcPktDecodeI::TrcPktDecodeI(const char *component_name, int instIDNum) :
130 TraceComponent(component_name, instIDNum),
131 m_index_curr_pkt(0),
132 m_decode_init_ok(false),
133 m_config_init_ok(false),
134 m_uses_memaccess(true),
135 m_uses_idecode(true)
136{
137}
138
139inline const bool TrcPktDecodeI::checkInit()
140{
142 {
144 init_err_msg = "No decoder configuration information";
146 init_err_msg = "No element output interface attached and enabled";
148 init_err_msg = "No memory access interface attached and enabled";
150 init_err_msg = "No instruction decoder interface attached and enabled";
151 else
152 m_decode_init_ok = true;
155 }
156 return m_decode_init_ok;
157}
158
160{
162}
163
165{
167}
168
170{
172 return m_instr_decode.first()->DecodeInstruction(instr_info);
174}
175
176inline 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)
177{
179 return m_mem_access.first()->ReadTargetMemory(address,getCoreSightTraceID(),mem_space, num_bytes,p_buffer);
181}
182
183/**********************************************************************/
184template <class P, class Pc>
186{
187public:
188 TrcPktDecodeBase(const char *component_name);
189 TrcPktDecodeBase(const char *component_name, int instIDNum);
191
193 const ocsd_trc_index_t index_sop,
194 const P *p_packet_in);
195
196
197 /* protocol configuration */
198 ocsd_err_t setProtocolConfig(const Pc *config);
199 const Pc * getProtocolConfig() const { return m_config; };
200
201protected:
203
204 /* the protocol configuration */
206 /* the current input packet */
208
209};
210
211
212template <class P, class Pc> TrcPktDecodeBase<P, Pc>::TrcPktDecodeBase(const char *component_name) :
213 TrcPktDecodeI(component_name),
214 m_config(0)
215{
216}
217
218template <class P, class Pc> TrcPktDecodeBase<P, Pc>::TrcPktDecodeBase(const char *component_name, int instIDNum) :
219 TrcPktDecodeI(component_name,instIDNum),
220 m_config(0)
221{
222}
223
224template <class P, class Pc> TrcPktDecodeBase<P, Pc>::~TrcPktDecodeBase()
225{
226 ClearConfigObj();
227}
228
230 const ocsd_trc_index_t index_sop,
231 const P *p_packet_in)
232{
234 if(!checkInit())
235 {
236 LogError(ocsdError(OCSD_ERR_SEV_ERROR,OCSD_ERR_NOT_INIT,init_err_msg));
238 }
239
240 switch(op)
241 {
242 case OCSD_OP_DATA:
243 if(p_packet_in == 0)
244 {
247 }
248 else
249 {
250 m_curr_packet_in = p_packet_in;
251 m_index_curr_pkt = index_sop;
252 resp = processPacket();
253 }
254 break;
255
256 case OCSD_OP_EOT:
257 resp = onEOT();
258 break;
259
260 case OCSD_OP_FLUSH:
261 resp = onFlush();
262 break;
263
264 case OCSD_OP_RESET:
265 resp = onReset();
266 break;
267
268 default:
271 break;
272 }
273 return resp;
274}
275
276 /* protocol configuration */
277template <class P, class Pc> ocsd_err_t TrcPktDecodeBase<P, Pc>::setProtocolConfig(const Pc *config)
278{
280 if(config != 0)
281 {
282 ClearConfigObj(); // remove any current config
283 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.
284 if(m_config != 0)
285 {
286 err = onProtocolConfig();
287 if(err == OCSD_OK)
288 m_config_init_ok = true;
289 }
290 else
291 err = OCSD_ERR_MEM;
292 }
293 return err;
294}
295
296template <class P, class Pc> void TrcPktDecodeBase<P, Pc>::ClearConfigObj()
297{
298 if(m_config)
299 {
300 delete m_config;
301 m_config = 0;
302 }
303}
304
306#endif // ARM_TRC_PKT_DECODE_BASE_H_INCLUDED
307
308/* End of File trc_pkt_decode_base.h */
virtual ocsd_err_t DecodeInstruction(ocsd_instr_info *instr_info)=0
Interface class providing an input for discrete protocol packets.
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
virtual ocsd_datapath_resp_t TraceElemIn(const ocsd_trc_index_t index_sop, const uint8_t trc_chan_id, const OcsdTraceElement &elem)=0
Generic trace element class.
Base class for all decode components in the library.
const Pc * getProtocolConfig() const
componentAttachPt< ITargetMemAccess > m_mem_access
virtual void onFirstInitOK()
virtual ocsd_datapath_resp_t processPacket()=0
componentAttachPt< ITrcGenElemIn > m_trace_elem_out
componentAttachPt< ITargetMemAccess > * getMemoryAccessAttachPt()
componentAttachPt< IInstrDecode > m_instr_decode
const bool getUsesIDecode() const
ocsd_trc_index_t m_index_curr_pkt
void setUsesMemAccess(bool bUsesMemaccess)
const bool getUsesMemAccess() const
void setUsesIDecode(bool bUsesIDecode)
componentAttachPt< ITrcGenElemIn > * getTraceElemOutAttachPt()
virtual ocsd_err_t onProtocolConfig()=0
std::string init_err_msg
error message for init error
virtual ocsd_datapath_resp_t onFlush()=0
virtual const uint8_t getCoreSightTraceID()=0
virtual ocsd_datapath_resp_t onReset()=0
bool m_decode_init_ok
set true if all attachments in place for decode. (remove checks in main throughput paths)
virtual ocsd_datapath_resp_t onEOT()=0
componentAttachPt< IInstrDecode > * getInstrDecodeAttachPt()
bool m_config_init_ok
set true if config set.
Single component interface pointer attachment point.
const bool hasAttachedAndEnabled() const
OpenCSD : Component attachment point interface class.
uint32_t ocsd_trc_index_t
enum _ocsd_datapath_resp_t ocsd_datapath_resp_t
enum _ocsd_mem_space_acc_t ocsd_mem_space_acc_t
enum _ocsd_datapath_op_t ocsd_datapath_op_t
enum _ocsd_err_t ocsd_err_t
uint64_t ocsd_vaddr_t
@ OCSD_ERR_DCD_INTERFACE_UNUSED
@ OCSD_OK
@ OCSD_ERR_INVALID_PARAM_VAL
@ OCSD_ERR_NOT_INIT
@ OCSD_ERR_MEM
@ OCSD_RESP_CONT
@ OCSD_RESP_FATAL_NOT_INIT
@ OCSD_RESP_FATAL_INVALID_PARAM
@ OCSD_RESP_FATAL_INVALID_OP
@ OCSD_OP_EOT
@ OCSD_OP_FLUSH
@ OCSD_OP_DATA
@ OCSD_OP_RESET
@ OCSD_ERR_SEV_ERROR
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)
TrcPktDecodeBase(const char *component_name)
virtual ocsd_datapath_resp_t PacketDataIn(const ocsd_datapath_op_t op, const ocsd_trc_index_t index_sop, const P *p_packet_in)
TrcPktDecodeI(const char *component_name)
ocsd_datapath_resp_t outputTraceElement(const OcsdTraceElement &elem)
TrcPktDecodeBase(const char *component_name, int instIDNum)
ocsd_err_t instrDecode(ocsd_instr_info *instr_info)
ocsd_err_t setProtocolConfig(const Pc *config)
ocsd_datapath_resp_t outputTraceElementIdx(ocsd_trc_index_t idx, const OcsdTraceElement &elem)
const bool checkInit()
OpenCSD : Base trace decode component.