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 42 #include "interfaces/trc_error_log_i.h" 43 #include "interfaces/trc_data_raw_in_i.h" 44 #include "interfaces/trc_instr_decode_i.h" 45 #include "interfaces/trc_tgt_mem_access_i.h" 46 #include "interfaces/trc_gen_elem_in_i.h" 47 #include "interfaces/trc_abs_typed_base_i.h" 48 49 class IDecoderMngr 50 { 51 public: 52 IDecoderMngr() {}; 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 59 //! Get the built in protocol type ID managed by this instance - extern for custom decoders 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 64 //!attach error logger to ptk-processor, or both of pkt processor and pkt decoder pair 65 virtual ocsd_err_t attachErrorLogger(TraceComponent *pComponent, ITraceErrorLog *pIErrorLog) = 0; 66 67 // pkt decoder only 68 //! attach instruction decoder to pkt decoder 69 virtual ocsd_err_t attachInstrDecoder(TraceComponent *pComponent, IInstrDecode *pIInstrDec) = 0; 70 71 //! attach memory accessor to pkt decoder 72 virtual ocsd_err_t attachMemAccessor(TraceComponent *pComponent, ITargetMemAccess *pMemAccessor) = 0; 73 74 //! attach generic output interface to pkt decoder 75 virtual ocsd_err_t attachOutputSink(TraceComponent *pComponent, ITrcGenElemIn *pOutSink) = 0; 76 77 // pkt processor only 78 //! attach a raw packet monitor to pkt processor (solo pkt processor, or pkt processor part of pair) 79 virtual ocsd_err_t attachPktMonitor(TraceComponent *pComponent, ITrcTypedBase *pPktRawDataMon) = 0; 80 81 //! attach a packet indexer to pkt processor (solo pkt processor, or pkt processor part of pair) 82 virtual ocsd_err_t attachPktIndexer(TraceComponent *pComponent, ITrcTypedBase *pPktIndexer) = 0; 83 84 //! attach a packet data sink to pkt processor output (solo pkt processor only - instead of decoder when pkt processor only created.) 85 virtual ocsd_err_t attachPktSink(TraceComponent *pComponent, ITrcTypedBase *pPktDataInSink) = 0; 86 87 // data input connection interface 88 //! get raw data input interface from packet processor 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 */