1*c120c564SAndrew Turner /* 2*c120c564SAndrew Turner * \file trc_indexer_src_i.h 3*c120c564SAndrew Turner * \brief OpenCSD : 4*c120c564SAndrew Turner * 5*c120c564SAndrew Turner * \copyright Copyright (c) 2015, ARM Limited. All Rights Reserved. 6*c120c564SAndrew Turner */ 7*c120c564SAndrew Turner 8*c120c564SAndrew Turner 9*c120c564SAndrew Turner /* 10*c120c564SAndrew Turner * Redistribution and use in source and binary forms, with or without modification, 11*c120c564SAndrew Turner * are permitted provided that the following conditions are met: 12*c120c564SAndrew Turner * 13*c120c564SAndrew Turner * 1. Redistributions of source code must retain the above copyright notice, 14*c120c564SAndrew Turner * this list of conditions and the following disclaimer. 15*c120c564SAndrew Turner * 16*c120c564SAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright notice, 17*c120c564SAndrew Turner * this list of conditions and the following disclaimer in the documentation 18*c120c564SAndrew Turner * and/or other materials provided with the distribution. 19*c120c564SAndrew Turner * 20*c120c564SAndrew Turner * 3. Neither the name of the copyright holder nor the names of its contributors 21*c120c564SAndrew Turner * may be used to endorse or promote products derived from this software without 22*c120c564SAndrew Turner * specific prior written permission. 23*c120c564SAndrew Turner * 24*c120c564SAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND 25*c120c564SAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 26*c120c564SAndrew Turner * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 27*c120c564SAndrew Turner * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 28*c120c564SAndrew Turner * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 29*c120c564SAndrew Turner * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 30*c120c564SAndrew Turner * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 31*c120c564SAndrew Turner * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 32*c120c564SAndrew Turner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 33*c120c564SAndrew Turner * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34*c120c564SAndrew Turner */ 35*c120c564SAndrew Turner 36*c120c564SAndrew Turner 37*c120c564SAndrew Turner #ifndef ARM_TRC_INDEXER_SRC_I_H_INCLUDED 38*c120c564SAndrew Turner #define ARM_TRC_INDEXER_SRC_I_H_INCLUDED 39*c120c564SAndrew Turner 40*c120c564SAndrew Turner #include <vector> 41*c120c564SAndrew Turner #include "opencsd/ocsd_if_types.h" 42*c120c564SAndrew Turner 43*c120c564SAndrew Turner /*! 44*c120c564SAndrew Turner * @class ITrcSrcIndexCreator 45*c120c564SAndrew Turner * 46*c120c564SAndrew Turner * @brief Interface class to index the frame formatted trace stream 47*c120c564SAndrew Turner * 48*c120c564SAndrew Turner * @ingroup ocsd_interfaces 49*c120c564SAndrew Turner * 50*c120c564SAndrew Turner * This indexer creates an index of trace IDs present in the frame formatted trace stream. 51*c120c564SAndrew Turner * It will also index any trigger point markers indicated in the frame format. 52*c120c564SAndrew Turner * 53*c120c564SAndrew Turner * Indexing is optional at runtime. Indexes can be saved and re-used. 54*c120c564SAndrew Turner */ 55*c120c564SAndrew Turner class ITrcSrcIndexCreator 56*c120c564SAndrew Turner { 57*c120c564SAndrew Turner public: ITrcSrcIndexCreator()58*c120c564SAndrew Turner ITrcSrcIndexCreator() {}; /**< Default constructor. */ ~ITrcSrcIndexCreator()59*c120c564SAndrew Turner virtual ~ITrcSrcIndexCreator() {}; /**< Default destructor. */ 60*c120c564SAndrew Turner 61*c120c564SAndrew Turner /*! 62*c120c564SAndrew Turner * The size of block that the indexer will split trace into - this is effectively the 63*c120c564SAndrew Turner * index granularity. The indexing will indicate if an indexed element - e.g. a source 64*c120c564SAndrew Turner * ID - is present in the block. Smaller granularity will mean a larger index but more 65*c120c564SAndrew Turner * resolution in IDs and event positions. 66*c120c564SAndrew Turner * 67*c120c564SAndrew Turner * Block sizes will be power of 2 aligned, not less 256 bytes (16 frames). 68*c120c564SAndrew Turner * Indexer will choose block size based on total trace size and desired granularity. 69*c120c564SAndrew Turner * 70*c120c564SAndrew Turner * @return uint32_t : Size of indexing block. 71*c120c564SAndrew Turner */ 72*c120c564SAndrew Turner virtual const uint32_t IndexBlockSize() const; 73*c120c564SAndrew Turner 74*c120c564SAndrew Turner /*! 75*c120c564SAndrew Turner * Index a single ID 76*c120c564SAndrew Turner * 77*c120c564SAndrew Turner * @param src_idx : trace index of source ID 78*c120c564SAndrew Turner * @param ID : The source ID. 79*c120c564SAndrew Turner * 80*c120c564SAndrew Turner * @return virtual ocsd_err_t : OCSD_OK if successful. 81*c120c564SAndrew Turner */ 82*c120c564SAndrew Turner virtual ocsd_err_t TrcIDIndex(const ocsd_trc_index_t src_idx, const uint8_t ID) = 0; 83*c120c564SAndrew Turner 84*c120c564SAndrew Turner /*! 85*c120c564SAndrew Turner * Index a set of IDs in a block. 86*c120c564SAndrew Turner * Block is assumed to be one of size IndexBlockSize() 87*c120c564SAndrew Turner * 88*c120c564SAndrew Turner * May be used by the deformatter to collate IDs and reduce indexing calls. 89*c120c564SAndrew Turner * May be used by hardware capture source that has its own index of IDs, to transfer 90*c120c564SAndrew Turner * indexing information into the decoder indexer. 91*c120c564SAndrew Turner * 92*c120c564SAndrew Turner * @param src_idx_start : Index of start of block. 93*c120c564SAndrew Turner * @param IDs : IDs within the block. 94*c120c564SAndrew Turner * 95*c120c564SAndrew Turner * @return virtual ocsd_err_t : OCSD_OK if successful. 96*c120c564SAndrew Turner */ 97*c120c564SAndrew Turner virtual ocsd_err_t TrcIDBlockMap(const ocsd_trc_index_t src_idx_start, const std::vector<uint8_t> IDs) = 0; 98*c120c564SAndrew Turner 99*c120c564SAndrew Turner /*! 100*c120c564SAndrew Turner * The CoreSight frame format can use a reserved ID to indicate trigger or other 101*c120c564SAndrew Turner * events programmed into the trace protocol generator. 102*c120c564SAndrew Turner * This call indexes these events. 103*c120c564SAndrew Turner * 104*c120c564SAndrew Turner * @param src_idx : trace index of the event. 105*c120c564SAndrew Turner * @param event_type : type of event. 106*c120c564SAndrew Turner * 107*c120c564SAndrew Turner * @return ocsd_err_t : OCSD_OK if indexed correctly, OCSD_ERR_INVALID_PARAM_VAL if incorrect value used. 108*c120c564SAndrew Turner */ 109*c120c564SAndrew Turner virtual ocsd_err_t TrcEventIndex(const ocsd_trc_index_t src_idx, const int event_type) = 0; 110*c120c564SAndrew Turner 111*c120c564SAndrew Turner 112*c120c564SAndrew Turner /*! 113*c120c564SAndrew Turner * When the frame formatter is using frame syncs (typically TPIU output captured on off chip capture 114*c120c564SAndrew Turner * device), this index call notes the position of these elements. 115*c120c564SAndrew Turner * 116*c120c564SAndrew Turner * @param src_idx : trace index of sync point. 117*c120c564SAndrew Turner */ 118*c120c564SAndrew Turner virtual void TrcSyncIndex(const ocsd_trc_index_t src_idx); 119*c120c564SAndrew Turner 120*c120c564SAndrew Turner }; 121*c120c564SAndrew Turner 122*c120c564SAndrew Turner #endif // ARM_TRC_INDEXER_SRC_I_H_INCLUDED 123*c120c564SAndrew Turner 124*c120c564SAndrew Turner /* End of File trc_indexer_src_i.h */ 125