1*c120c564SAndrew Turner /*!
2*c120c564SAndrew Turner * \file trc_mem_acc_cb.h
3*c120c564SAndrew Turner * \brief OpenCSD : Callback trace memory accessor.
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 * Redistribution and use in source and binary forms, with or without modification,
10*c120c564SAndrew Turner * are permitted provided that the following conditions are met:
11*c120c564SAndrew Turner *
12*c120c564SAndrew Turner * 1. Redistributions of source code must retain the above copyright notice,
13*c120c564SAndrew Turner * this list of conditions and the following disclaimer.
14*c120c564SAndrew Turner *
15*c120c564SAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright notice,
16*c120c564SAndrew Turner * this list of conditions and the following disclaimer in the documentation
17*c120c564SAndrew Turner * and/or other materials provided with the distribution.
18*c120c564SAndrew Turner *
19*c120c564SAndrew Turner * 3. Neither the name of the copyright holder nor the names of its contributors
20*c120c564SAndrew Turner * may be used to endorse or promote products derived from this software without
21*c120c564SAndrew Turner * specific prior written permission.
22*c120c564SAndrew Turner *
23*c120c564SAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS' AND
24*c120c564SAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
25*c120c564SAndrew Turner * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26*c120c564SAndrew Turner * IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27*c120c564SAndrew Turner * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
28*c120c564SAndrew Turner * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29*c120c564SAndrew Turner * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
30*c120c564SAndrew Turner * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31*c120c564SAndrew Turner * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32*c120c564SAndrew Turner * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33*c120c564SAndrew Turner */
34*c120c564SAndrew Turner
35*c120c564SAndrew Turner #ifndef ARM_TRC_MEM_ACC_CB_H_INCLUDED
36*c120c564SAndrew Turner #define ARM_TRC_MEM_ACC_CB_H_INCLUDED
37*c120c564SAndrew Turner
38*c120c564SAndrew Turner #include "mem_acc/trc_mem_acc_base.h"
39*c120c564SAndrew Turner #include "mem_acc/trc_mem_acc_cb_if.h"
40*c120c564SAndrew Turner
41*c120c564SAndrew Turner class TrcMemAccCB : public TrcMemAccessorBase
42*c120c564SAndrew Turner {
43*c120c564SAndrew Turner public:
44*c120c564SAndrew Turner TrcMemAccCB(const ocsd_vaddr_t s_address,
45*c120c564SAndrew Turner const ocsd_vaddr_t e_address,
46*c120c564SAndrew Turner const ocsd_mem_space_acc_t mem_space);
47*c120c564SAndrew Turner
48*c120c564SAndrew Turner
~TrcMemAccCB()49*c120c564SAndrew Turner virtual ~TrcMemAccCB() {};
50*c120c564SAndrew Turner
51*c120c564SAndrew Turner /** Memory access override - allow decoder to read bytes from the buffer. */
52*c120c564SAndrew Turner 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*c120c564SAndrew Turner
54*c120c564SAndrew Turner void setCBIfClass(TrcMemAccCBIF *p_if);
55*c120c564SAndrew Turner void setCBIfFn(Fn_MemAcc_CB p_fn, const void *p_context);
56*c120c564SAndrew Turner void setCBIDIfFn(Fn_MemAccID_CB p_fn, const void *p_context);
57*c120c564SAndrew Turner
58*c120c564SAndrew Turner private:
59*c120c564SAndrew Turner void clearCBptrs();
60*c120c564SAndrew Turner TrcMemAccCBIF *m_p_CBclass; //<! callback class.
61*c120c564SAndrew Turner Fn_MemAcc_CB m_p_CBfn; //<! callback function.
62*c120c564SAndrew Turner Fn_MemAccID_CB m_p_CBIDfn; //<! callback with ID function.
63*c120c564SAndrew Turner const void *m_p_cbfn_context; //<! context pointer for callback function.
64*c120c564SAndrew Turner };
65*c120c564SAndrew Turner
clearCBptrs()66*c120c564SAndrew Turner inline void TrcMemAccCB::clearCBptrs()
67*c120c564SAndrew Turner {
68*c120c564SAndrew Turner m_p_CBclass = 0;
69*c120c564SAndrew Turner m_p_CBfn = 0;
70*c120c564SAndrew Turner m_p_CBIDfn = 0;
71*c120c564SAndrew Turner m_p_cbfn_context = 0;
72*c120c564SAndrew Turner }
73*c120c564SAndrew Turner
setCBIfClass(TrcMemAccCBIF * p_if)74*c120c564SAndrew Turner inline void TrcMemAccCB::setCBIfClass(TrcMemAccCBIF *p_if)
75*c120c564SAndrew Turner {
76*c120c564SAndrew Turner clearCBptrs(); // only one callback type per accessor.
77*c120c564SAndrew Turner m_p_CBclass = p_if;
78*c120c564SAndrew Turner }
79*c120c564SAndrew Turner
setCBIfFn(Fn_MemAcc_CB p_fn,const void * p_context)80*c120c564SAndrew Turner inline void TrcMemAccCB::setCBIfFn(Fn_MemAcc_CB p_fn, const void *p_context)
81*c120c564SAndrew Turner {
82*c120c564SAndrew Turner clearCBptrs(); // only one callback type per accessor.
83*c120c564SAndrew Turner m_p_CBfn = p_fn;
84*c120c564SAndrew Turner m_p_cbfn_context = p_context;
85*c120c564SAndrew Turner }
86*c120c564SAndrew Turner
setCBIDIfFn(Fn_MemAccID_CB p_fn,const void * p_context)87*c120c564SAndrew Turner inline void TrcMemAccCB::setCBIDIfFn(Fn_MemAccID_CB p_fn, const void *p_context)
88*c120c564SAndrew Turner {
89*c120c564SAndrew Turner clearCBptrs(); // only one callback type per accessor.
90*c120c564SAndrew Turner m_p_CBIDfn = p_fn;
91*c120c564SAndrew Turner m_p_cbfn_context = p_context;
92*c120c564SAndrew Turner }
93*c120c564SAndrew Turner
94*c120c564SAndrew Turner #endif // ARM_TRC_MEM_ACC_CB_H_INCLUDED
95*c120c564SAndrew Turner
96*c120c564SAndrew Turner /* End of File trc_mem_acc_cb.h */
97