2 * \file trc_data_rawframe_in_i.h
5 * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved.
10 * Redistribution and use in source and binary forms, with or without modification,
11 * are permitted provided that the following conditions are met:
13 * 1. Redistributions of source code must retain the above copyright notice,
14 * this list of conditions and the following disclaimer.
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.
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.
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.
36 #ifndef ARM_TRCDATA_RAWFRAME_IN_I_H_INCLUDED
37 #define ARM_TRCDATA_RAWFRAME_IN_I_H_INCLUDED
39 #include "opencsd/ocsd_if_types.h"
42 * @class ITrcRawFrameIn
44 * @brief Interface to monitor the raw frame decode progress..
46 * @ingroup ocsd_interfaces
48 * This interface allows a program to monitor the contents of the CoreSight frames passing through the
53 class ITrcRawFrameIn {
55 ITrcRawFrameIn() {}; /**< Default constructor. */
56 virtual ~ITrcRawFrameIn() {}; /**< Default destructor. */
59 * Interface to monitor CoreSight frame data. Output as blocks of data.
61 * @param op : Data path operation.
62 * @param index : Byte index of start of pDataBlock data as offset from start of captured data. May be zero for none-data operation
63 * @param frame_element : Type of frame element being output.
64 * @param dataBlockSize : size of frame element.
65 * @param *pDataBlock : pointer to frame data.
66 * @param traceID : Trace ID when element type ID data.
68 * @return ocsd_err_t : Standard library erroc code. Monitor only, not on data path.
70 virtual ocsd_err_t TraceRawFrameIn( const ocsd_datapath_op_t op,
71 const ocsd_trc_index_t index,
72 const ocsd_rawframe_elem_t frame_element,
73 const int dataBlockSize,
74 const uint8_t *pDataBlock,
75 const uint8_t traceID) = 0;
79 #endif // ARM_TRCDATA_RAWFRAME_IN_I_H_INCLUDED
81 /* End of File trc_data_rawframe_in_i.h */