1*c120c564SAndrew Turner /* 2*c120c564SAndrew Turner * \file trc_data_raw_in_i.h 3*c120c564SAndrew Turner * \brief OpenCSD : 4*c120c564SAndrew Turner * 5*c120c564SAndrew Turner * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved. 6*c120c564SAndrew Turner */ 7*c120c564SAndrew Turner 8*c120c564SAndrew Turner /* 9*c120c564SAndrew Turner * Redistribution and use in source and binary forms, with or without modification, 10*c120c564SAndrew Turner * are permitted provided that the following conditions are met: 11*c120c564SAndrew Turner * 12*c120c564SAndrew Turner * 1. Redistributions of source code must retain the above copyright notice, 13*c120c564SAndrew Turner * this list of conditions and the following disclaimer. 14*c120c564SAndrew Turner * 15*c120c564SAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright notice, 16*c120c564SAndrew Turner * this list of conditions and the following disclaimer in the documentation 17*c120c564SAndrew Turner * and/or other materials provided with the distribution. 18*c120c564SAndrew Turner * 19*c120c564SAndrew Turner * 3. Neither the name of the copyright holder nor the names of its contributors 20*c120c564SAndrew Turner * may be used to endorse or promote products derived from this software without 21*c120c564SAndrew Turner * specific prior written permission. 22*c120c564SAndrew Turner * 23*c120c564SAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND 24*c120c564SAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 25*c120c564SAndrew Turner * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 26*c120c564SAndrew Turner * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 27*c120c564SAndrew Turner * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 28*c120c564SAndrew Turner * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 29*c120c564SAndrew Turner * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 30*c120c564SAndrew Turner * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31*c120c564SAndrew Turner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 32*c120c564SAndrew Turner * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33*c120c564SAndrew Turner */ 34*c120c564SAndrew Turner 35*c120c564SAndrew Turner #ifndef ARM_TRCDATA_RAW_IN_I_H_INCLUDED 36*c120c564SAndrew Turner #define ARM_TRCDATA_RAW_IN_I_H_INCLUDED 37*c120c564SAndrew Turner 38*c120c564SAndrew Turner #include "opencsd/ocsd_if_types.h" 39*c120c564SAndrew Turner 40*c120c564SAndrew Turner /** @class ITrcDataIn 41*c120c564SAndrew Turner * 42*c120c564SAndrew Turner * @brief Interface to either trace data frame deformatter or packet processor. 43*c120c564SAndrew Turner * 44*c120c564SAndrew Turner * @ingroup ocsd_interfaces 45*c120c564SAndrew Turner * 46*c120c564SAndrew Turner * Interface class to a processor that can consume raw formatted trace byte stream from a trace reader 47*c120c564SAndrew Turner * or raw source buffer into a deformatter object. 48*c120c564SAndrew Turner * 49*c120c564SAndrew Turner * Also used to interface a single trace source ID data stream into a packet processor. 50*c120c564SAndrew Turner * 51*c120c564SAndrew Turner */ 52*c120c564SAndrew Turner class ITrcDataIn { 53*c120c564SAndrew Turner public: ITrcDataIn()54*c120c564SAndrew Turner ITrcDataIn() {}; /**< Default constructor. */ ~ITrcDataIn()55*c120c564SAndrew Turner virtual ~ITrcDataIn() {}; /**< Default destructor. */ 56*c120c564SAndrew Turner 57*c120c564SAndrew Turner /*! 58*c120c564SAndrew Turner * Data input method for a component on the Trace decode datapath. 59*c120c564SAndrew Turner * Datapath operations passed to the component, which responds with data path response codes. 60*c120c564SAndrew Turner * 61*c120c564SAndrew Turner * This API is for raw trace data, which can be:- 62*c120c564SAndrew Turner * - CoreSight formatted frame data for input to the frame deformatter. 63*c120c564SAndrew Turner * - Single binary source data for input to a packet decoder. 64*c120c564SAndrew Turner * 65*c120c564SAndrew Turner * @param op : Data path operation. 66*c120c564SAndrew Turner * @param index : Byte index of start of pDataBlock data as offset from start of captured data. May be zero for none-data operation 67*c120c564SAndrew Turner * @param dataBlockSize : Size of data block. Zero for none-data operation. 68*c120c564SAndrew Turner * @param *pDataBlock : pointer to data block. Null for none-data operation 69*c120c564SAndrew Turner * @param *numBytesProcessed : Pointer to count of data used by processor. Set by processor on data operation. Null for none-data operation 70*c120c564SAndrew Turner * 71*c120c564SAndrew Turner * @return ocsd_datapath_resp_t : Standard data path response code. 72*c120c564SAndrew Turner */ 73*c120c564SAndrew Turner virtual ocsd_datapath_resp_t TraceDataIn( const ocsd_datapath_op_t op, 74*c120c564SAndrew Turner const ocsd_trc_index_t index, 75*c120c564SAndrew Turner const uint32_t dataBlockSize, 76*c120c564SAndrew Turner const uint8_t *pDataBlock, 77*c120c564SAndrew Turner uint32_t *numBytesProcessed) = 0; 78*c120c564SAndrew Turner 79*c120c564SAndrew Turner }; 80*c120c564SAndrew Turner 81*c120c564SAndrew Turner #endif // ARM_TRCDATA_RAW_IN_I_H_INCLUDED 82*c120c564SAndrew Turner 83*c120c564SAndrew Turner 84*c120c564SAndrew Turner /* End of File trc_data_raw_in_i.h */ 85