xref: /freebsd-src/contrib/opencsd/decoder/include/mem_acc/trc_mem_acc_bufptr.h (revision b6aadd183a8fc19317f893a41f252b32a87759af)
1*c120c564SAndrew Turner /*
2*c120c564SAndrew Turner  * \file       trc_mem_acc_bufptr.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  * 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_BUFPTR_H_INCLUDED
36*c120c564SAndrew Turner #define ARM_TRC_MEM_ACC_BUFPTR_H_INCLUDED
37*c120c564SAndrew Turner 
38*c120c564SAndrew Turner #include "mem_acc/trc_mem_acc_base.h"
39*c120c564SAndrew Turner 
40*c120c564SAndrew Turner /*!
41*c120c564SAndrew Turner  * @class TrcMemAccBufPtr:
42*c120c564SAndrew Turner  * @brief Trace memory accessor for a memory buffer.
43*c120c564SAndrew Turner  *
44*c120c564SAndrew Turner  * Wraps a memory buffer in an memory range accessor object.
45*c120c564SAndrew Turner  * Takes a copy of the buffer pointer which must remain valid
46*c120c564SAndrew Turner  * for the lifetime of the object.
47*c120c564SAndrew Turner  *
48*c120c564SAndrew Turner  */
49*c120c564SAndrew Turner class TrcMemAccBufPtr: public TrcMemAccessorBase
50*c120c564SAndrew Turner {
51*c120c564SAndrew Turner public:
52*c120c564SAndrew Turner     /*!
53*c120c564SAndrew Turner      * Construct the accessor.
54*c120c564SAndrew Turner      * uses the start address as the start of range and calculates the end address
55*c120c564SAndrew Turner      * according to the buffer size
56*c120c564SAndrew Turner      *
57*c120c564SAndrew Turner      * @param s_address : Start address in memory map represented by the data in the buffer.
58*c120c564SAndrew Turner      * @param *p_buffer : pointer to a buffer of binary data.
59*c120c564SAndrew Turner      * @param size : size of the buffer.
60*c120c564SAndrew Turner      *
61*c120c564SAndrew Turner      */
62*c120c564SAndrew Turner     TrcMemAccBufPtr(const ocsd_vaddr_t s_address, const uint8_t *p_buffer, const uint32_t size);
63*c120c564SAndrew Turner 
~TrcMemAccBufPtr()64*c120c564SAndrew Turner     virtual ~TrcMemAccBufPtr() {};  /**< default destructor */
65*c120c564SAndrew Turner 
66*c120c564SAndrew Turner     /** Memory access override - allow decoder to read bytes from the buffer. */
67*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);
68*c120c564SAndrew Turner 
69*c120c564SAndrew Turner private:
70*c120c564SAndrew Turner     const uint8_t *m_p_buffer;  /**< pointer to the memory buffer  */
71*c120c564SAndrew Turner };
72*c120c564SAndrew Turner 
73*c120c564SAndrew Turner #endif // ARM_TRC_MEM_ACC_BUFPTR_H_INCLUDED
74*c120c564SAndrew Turner 
75*c120c564SAndrew Turner /* End of File trc_mem_acc_bufptr.h */
76