1 /* 2 * \file trc_pkt_in_i.h 3 * \brief OpenCSD : Interface for trace protocol packet input 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_PKT_IN_I_H_INCLUDED 37 #define ARM_TRC_PKT_IN_I_H_INCLUDED 38 39 #include "trc_abs_typed_base_i.h" 40 41 /*! 42 * @class IPktDataIn 43 * @ingroup ocsd_interfaces 44 * @brief Interface class providing an input for discrete protocol packets. 45 * 46 * Implemented by trace protocol packet decoders to convert packets into 47 * generic trace elements. 48 * 49 * Packet class used will contain information on the latest packet, 50 * and any intra-packet state. 51 * 52 */ 53 template<class P> 54 class IPktDataIn : public ITrcTypedBase 55 { 56 public: 57 IPktDataIn() {}; /**< Default constructor. */ 58 virtual ~IPktDataIn() {}; /**< Default destructor. */ 59 60 /*! 61 * Interface function to process a single protocol packet. 62 * Pass a trace index for the start of packet and a pointer to a packet when the 63 * datapath operation is OCSD_OP_DATA. 64 * 65 * @param op : Datapath operation. 66 * @param index_sop : Trace index for the start of the packet, 0 if not OCSD_OP_DATA. 67 * @param *p_packet_in : Protocol Packet - when data path operation is OCSD_OP_DATA. null otherwise. 68 * 69 * @return ocsd_datapath_resp_t : Standard data path response. 70 */ 71 virtual ocsd_datapath_resp_t PacketDataIn( const ocsd_datapath_op_t op, 72 const ocsd_trc_index_t index_sop, 73 const P *p_packet_in) = 0; 74 75 76 }; 77 78 #endif // ARM_TRC_PKT_IN_I_H_INCLUDED 79 80 /* End of File trc_proc_pkt_in_i.h */ 81