1/*
2 * \file       trc_pkt_raw_in_i.h
3 * \brief      OpenCSD :
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_RAW_IN_I_H_INCLUDED
37#define ARM_TRC_PKT_RAW_IN_I_H_INCLUDED
38
39#include "trc_abs_typed_base_i.h"
40
41/*!
42 * @class IPktRawDataMon
43 *
44 * @brief Interface class for packet processor monitor.
45 *
46 * @addtogroup ocsd_interfaces
47 *
48 * This interface provides a monitor point for the packet processor block.
49 * The templated interface is called with a complete packet of the given
50 * type, plus the raw packet bytes. Use for tools which need to display compplete
51 * packets or require additional processing on raw packet data.
52 *
53 * This interface is not part of the data decode path and cannot provide feedback.
54 *
55 */
56template<class P>
57class IPktRawDataMon : public ITrcTypedBase
58{
59public:
60    IPktRawDataMon() {}; /**< Default constructor. */
61    virtual ~IPktRawDataMon() {};  /**< Default destructor. */
62
63    /*!
64     * Interface monitor function called with a complete packet, or other
65     * data path operation.
66     *
67     * @param op : Datapath operation
68     * @param index_sop : start of packet index
69     * @param *pkt : The expanded packet
70     * @param size : size of packet data bytes
71     * @param *p_data : the packet data bytes.
72     *
73     */
74    virtual void RawPacketDataMon( const ocsd_datapath_op_t op,
75                                   const ocsd_trc_index_t index_sop,
76                                   const P *pkt,
77                                   const uint32_t size,
78                                   const uint8_t *p_data) = 0;
79};
80
81#endif // ARM_TRC_PKT_RAW_IN_I_H_INCLUDED
82
83/* End of File trc_pkt_raw_in_i.h */
84