OpenCSD - CoreSight Trace Decode Library  1.3.3
ocsd_dcd_mngr_i.h
Go to the documentation of this file.
1 /*
2  * \file ocsd_dcd_mngr_i.h
3  * \brief OpenCSD : Decoder manager interface.
4  *
5  * \copyright Copyright (c) 2016, 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_OCSD_DCD_MNGR_I_H_INCLUDED
36 #define ARM_OCSD_DCD_MNGR_I_H_INCLUDED
37 
38 #include "opencsd/ocsd_if_types.h"
39 #include "common/trc_cs_config.h"
40 #include "common/trc_component.h"
41 
48 
50 {
51 public:
53  virtual ~IDecoderMngr() {};
54 
55 // create and destroy decoders
56  virtual ocsd_err_t createDecoder(const int create_flags, const int instID, const CSConfig *p_config, TraceComponent **ppComponent) = 0;
57  virtual ocsd_err_t destroyDecoder(TraceComponent *pComponent) = 0;
58 
60  virtual const ocsd_trace_protocol_t getProtocolType() const = 0;
61 
62 // connect decoders to other components - (replace current / 0 pointer value to detach );
63 // compatible with all decoders
65  virtual ocsd_err_t attachErrorLogger(TraceComponent *pComponent, ITraceErrorLog *pIErrorLog) = 0;
66 
67 // pkt decoder only
69  virtual ocsd_err_t attachInstrDecoder(TraceComponent *pComponent, IInstrDecode *pIInstrDec) = 0;
70 
72  virtual ocsd_err_t attachMemAccessor(TraceComponent *pComponent, ITargetMemAccess *pMemAccessor) = 0;
73 
75  virtual ocsd_err_t attachOutputSink(TraceComponent *pComponent, ITrcGenElemIn *pOutSink) = 0;
76 
77 // pkt processor only
79  virtual ocsd_err_t attachPktMonitor(TraceComponent *pComponent, ITrcTypedBase *pPktRawDataMon) = 0;
80 
82  virtual ocsd_err_t attachPktIndexer(TraceComponent *pComponent, ITrcTypedBase *pPktIndexer) = 0;
83 
85  virtual ocsd_err_t attachPktSink(TraceComponent *pComponent, ITrcTypedBase *pPktDataInSink) = 0;
86 
87 // data input connection interface
89  virtual ocsd_err_t getDataInputI(TraceComponent *pComponent, ITrcDataIn **ppDataIn) = 0;
90 
91 // create configuration from data structure
92  virtual ocsd_err_t createConfigFromDataStruct(CSConfig **pConfigBase, const void *pDataStruct) = 0;
93 
94 };
95 
96 #endif // ARM_OCSD_DCD_MNGR_I_H_INCLUDED
97 
98 /* End of File ocsd_dcd_mngr.h */
Base class for configuration data on CoreSight trace component.
Definition: trc_cs_config.h:50
virtual ocsd_err_t attachOutputSink(TraceComponent *pComponent, ITrcGenElemIn *pOutSink)=0
attach generic output interface to pkt decoder
virtual ocsd_err_t attachInstrDecoder(TraceComponent *pComponent, IInstrDecode *pIInstrDec)=0
attach instruction decoder to pkt decoder
virtual ocsd_err_t attachMemAccessor(TraceComponent *pComponent, ITargetMemAccess *pMemAccessor)=0
attach memory accessor to pkt decoder
virtual ocsd_err_t getDataInputI(TraceComponent *pComponent, ITrcDataIn **ppDataIn)=0
get raw data input interface from packet processor
virtual ocsd_err_t attachPktIndexer(TraceComponent *pComponent, ITrcTypedBase *pPktIndexer)=0
attach a packet indexer to pkt processor (solo pkt processor, or pkt processor part of pair)
virtual ocsd_err_t attachPktMonitor(TraceComponent *pComponent, ITrcTypedBase *pPktRawDataMon)=0
attach a raw packet monitor to pkt processor (solo pkt processor, or pkt processor part of pair)
virtual const ocsd_trace_protocol_t getProtocolType() const =0
Get the built in protocol type ID managed by this instance - extern for custom decoders.
virtual ocsd_err_t createDecoder(const int create_flags, const int instID, const CSConfig *p_config, TraceComponent **ppComponent)=0
virtual ocsd_err_t destroyDecoder(TraceComponent *pComponent)=0
virtual ~IDecoderMngr()
virtual ocsd_err_t attachErrorLogger(TraceComponent *pComponent, ITraceErrorLog *pIErrorLog)=0
attach error logger to ptk-processor, or both of pkt processor and pkt decoder pair
virtual ocsd_err_t createConfigFromDataStruct(CSConfig **pConfigBase, const void *pDataStruct)=0
virtual ocsd_err_t attachPktSink(TraceComponent *pComponent, ITrcTypedBase *pPktDataInSink)=0
attach a packet data sink to pkt processor output (solo pkt processor only - instead of decoder when ...
Interface class to an instruction opcode decoder.
Interface to target memory access.
Error logging interface.
Interface to either trace data frame deformatter or packet processor.
Interface for the input of generic trace elements.
Abstract base class to for interfaces templated types.
Base class for all decode components in the library.
Definition: trc_component.h:57
enum _ocsd_trace_protocol_t ocsd_trace_protocol_t
enum _ocsd_err_t ocsd_err_t
OpenCSD : Standard Types used in the library interfaces.
OpenCSD : Base trace decode component.