contrib/opencsd/decoder/include/mem_acc/trc_mem_acc_cb.h

   1 /*!
   2  * \file       trc_mem_acc_cb.h
   3  * \brief      OpenCSD : Callback trace memory accessor.
   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_TRC_MEM_ACC_CB_H_INCLUDED
  36 #define ARM_TRC_MEM_ACC_CB_H_INCLUDED
  37
  38 #include "mem_acc/trc_mem_acc_base.h"
  39 #include "mem_acc/trc_mem_acc_cb_if.h"
  40
  41 class TrcMemAccCB : public TrcMemAccessorBase
  42 {
  43 public:
  44     TrcMemAccCB(const ocsd_vaddr_t s_address,
  45                 const ocsd_vaddr_t e_address,
  46                 const ocsd_mem_space_acc_t mem_space);
  47
  48
  49     virtual ~TrcMemAccCB() {};
  50
  51     /** Memory access override - allow decoder to read bytes from the buffer. */
  52     virtual const uint32_t readBytes(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t memSpace, const uint8_t trcID, const uint32_t reqBytes, uint8_t *byteBuffer);
  53
  54     void setCBIfClass(TrcMemAccCBIF *p_if);
  55     void setCBIfFn(Fn_MemAcc_CB p_fn, const void *p_context);
  56     void setCBIDIfFn(Fn_MemAccID_CB p_fn, const void *p_context);
  57
  58 private:
  59     void clearCBptrs();
  60     TrcMemAccCBIF *m_p_CBclass;     //<! callback class.
  61     Fn_MemAcc_CB m_p_CBfn;          //<! callback function.
  62     Fn_MemAccID_CB m_p_CBIDfn;       //<! callback with ID function.
  63     const void *m_p_cbfn_context;   //<! context pointer for callback function.
  64 };
  65
  66 inline void TrcMemAccCB::clearCBptrs()
  67 {
  68     m_p_CBclass = 0;
  69     m_p_CBfn = 0;
  70     m_p_CBIDfn = 0;
  71     m_p_cbfn_context = 0;
  72 }
  73
  74 inline void TrcMemAccCB::setCBIfClass(TrcMemAccCBIF *p_if)
  75 {
  76     clearCBptrs();   // only one callback type per accessor.
  77     m_p_CBclass = p_if;
  78 }
  79
  80 inline void TrcMemAccCB::setCBIfFn(Fn_MemAcc_CB p_fn, const void *p_context)
  81 {
  82     clearCBptrs();   // only one callback type per accessor.
  83     m_p_CBfn = p_fn;
  84     m_p_cbfn_context = p_context;
  85 }
  86
  87 inline void TrcMemAccCB::setCBIDIfFn(Fn_MemAccID_CB p_fn, const void *p_context)
  88 {
  89     clearCBptrs();   // only one callback type per accessor.
  90     m_p_CBIDfn = p_fn;
  91     m_p_cbfn_context = p_context;
  92 }
  93
  94 #endif // ARM_TRC_MEM_ACC_CB_H_INCLUDED
  95
  96 /* End of File trc_mem_acc_cb.h */