1 /* 2 * \file trc_gen_elem_in_i.h 3 * \brief OpenCSD : Generic Trace Element interface. 4 * 5 * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved. 6 */ 7 8 9 /* 10 * Redistribution and use in source and binary forms, with or without modification, 11 * are permitted provided that the following conditions are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright notice, 17 * this list of conditions and the following disclaimer in the documentation 18 * and/or other materials provided with the distribution. 19 * 20 * 3. Neither the name of the copyright holder nor the names of its contributors 21 * may be used to endorse or promote products derived from this software without 22 * specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 26 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 27 * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 28 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 29 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 31 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34 */ 35 36 #ifndef ARM_TRC_GEN_ELEM_IN_I_H_INCLUDED 37 #define ARM_TRC_GEN_ELEM_IN_I_H_INCLUDED 38 39 class OcsdTraceElement; 40 41 /*! 42 * @class ITrcGenElemIn 43 44 * @brief Interface for the input of generic trace elements. 45 * 46 * @ingroup ocsd_interfaces 47 * 48 * This interface is the principal output attachment point for the trace packet decoders. 49 * 50 */ 51 class ITrcGenElemIn 52 { 53 public: ITrcGenElemIn()54 ITrcGenElemIn() {}; /**< Default constructor. */ ~ITrcGenElemIn()55 virtual ~ITrcGenElemIn() {}; /**< Default destructor. */ 56 57 58 /*! 59 * Interface for analysis blocks that take generic trace elements as their input. 60 * Final interface on the decode data path. The index provided is that for the generating 61 * trace packet. Multiple generic elements may be produced from a single packet so they will 62 * all have the same start index. 63 * 64 * @param index_sop : Trace index for start of packet generating this element. 65 * @param trc_chan_id : CoreSight Trace ID for this source. 66 * @param &elem : Generic trace element generated from the deocde data path 67 * 68 * @return ocsd_datapath_resp_t : Standard data path response. 69 */ 70 virtual ocsd_datapath_resp_t TraceElemIn(const ocsd_trc_index_t index_sop, 71 const uint8_t trc_chan_id, 72 const OcsdTraceElement &elem) = 0; 73 }; 74 75 #endif // ARM_TRC_GEN_ELEM_IN_I_H_INCLUDED 76 77 /* End of File trc_gen_elem_in_i.h */ 78