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