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