2 * \file trc_indexer_pkt_i.h
3 * \brief OpenCSD : Trace packet indexer
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_TRC_INDEXER_PKT_I_H_INCLUDED
37 #define ARM_TRC_INDEXER_PKT_I_H_INCLUDED
39 #include "trc_abs_typed_base_i.h"
42 * @class ITrcPktIndexer
44 * @brief Templated interface class to index packet types.
46 * @ingroup ocsd_interfaces
48 * Each protocol version will have an associated indexer that will index significant
49 * packets such as synchronisation points, timestamps, trigger events.
51 * Creating an index is optional at runtime, but will allow any analysis program to synchronise the
52 * different trace streams.
54 * Indexes need to be created only once and can be saved for re-use.
56 * Packet processors should be created to support the attachment of an indexer.
60 class ITrcPktIndexer : public ITrcTypedBase
63 ITrcPktIndexer() {}; /**< Default constructor. */
64 virtual ~ITrcPktIndexer() {}; /**< Default destructor. */
67 * Interface method for trace packet indexing. Implementated by a channel packet indexer.
69 * @param index_sop : trace index at the start of the packet.
70 * @param *packet_type : The packet type being indexed.
72 virtual void TracePktIndex(const ocsd_trc_index_t index_sop, const Pt *packet_type) = 0;
75 #endif // ARM_TRC_INDEXER_PKT_I_H_INCLUDED
77 /* End of File trc_indexer_pkt_i.h */