1/*
2 * \file       trc_mem_acc_mapper.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_MAPPER_H_INCLUDED
36#define ARM_TRC_MEM_ACC_MAPPER_H_INCLUDED
37
38#include <vector>
39
40#include "opencsd/ocsd_if_types.h"
41#include "interfaces/trc_tgt_mem_access_i.h"
42#include "interfaces/trc_error_log_i.h"
43#include "mem_acc/trc_mem_acc_base.h"
44
45typedef enum _memacc_mapper_t {
46    MEMACC_MAP_GLOBAL,
47} memacc_mapper_t;
48
49class TrcMemAccMapper : public ITargetMemAccess
50{
51public:
52    TrcMemAccMapper();
53    TrcMemAccMapper(bool using_trace_id);
54    virtual ~TrcMemAccMapper();
55
56// decoder memory access interface
57    virtual ocsd_err_t ReadTargetMemory(   const ocsd_vaddr_t address,
58                                            const uint8_t cs_trace_id,
59                                            const ocsd_mem_space_acc_t mem_space,
60                                            uint32_t *num_bytes,
61                                            uint8_t *p_buffer);
62
63// mapper memory area configuration interface
64
65    // add an accessor to this map
66    virtual ocsd_err_t AddAccessor(TrcMemAccessorBase *p_accessor, const uint8_t cs_trace_id) = 0;
67
68    // remove a specific accessor
69    virtual ocsd_err_t RemoveAccessor(const TrcMemAccessorBase *p_accessor) = 0;
70
71
72    // clear all attached accessors from the map
73    void RemoveAllAccessors();
74
75    // remove a single accessor based on address.
76    ocsd_err_t RemoveAccessorByAddress(const ocsd_vaddr_t st_address, const ocsd_mem_space_acc_t mem_space, const uint8_t cs_trace_id = 0);
77
78    // set the error log.
79    void setErrorLog(ITraceErrorLog *err_log_i) { m_err_log = err_log_i;  };
80
81    // print out the ranges in this mapper.
82    virtual void logMappedRanges() = 0;
83
84protected:
85    virtual bool findAccessor(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint8_t cs_trace_id) = 0;     // set m_acc_curr if found valid range, leave unchanged if not.
86    virtual bool readFromCurrent(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint8_t cs_trace_id) = 0;
87    virtual TrcMemAccessorBase *getFirstAccessor() = 0;
88    virtual TrcMemAccessorBase *getNextAccessor() = 0;
89    virtual void clearAccessorList() = 0;
90
91    void LogMessage(const std::string &msg);
92
93    TrcMemAccessorBase *m_acc_curr;     // most recently used - try this first.
94    uint8_t m_trace_id_curr;            // trace ID for the current accessor
95    const bool m_using_trace_id;        // true if we are using separate memory spaces by TraceID.
96    ITraceErrorLog *m_err_log;          // error log to print out mappings on request.
97};
98
99
100// address spaces common to all sources using this mapper.
101// trace id unused.
102class TrcMemAccMapGlobalSpace : public TrcMemAccMapper
103{
104public:
105    TrcMemAccMapGlobalSpace();
106    virtual ~TrcMemAccMapGlobalSpace();
107
108    // mapper creation interface - prevent overlaps
109    virtual ocsd_err_t AddAccessor(TrcMemAccessorBase *p_accessor, const uint8_t cs_trace_id);
110
111    // print out the ranges in this mapper.
112    virtual void logMappedRanges();
113
114protected:
115    virtual bool findAccessor(const ocsd_vaddr_t address, const ocsd_mem_space_acc_t mem_space, const uint8_t cs_trace_id);
116    virtual bool readFromCurrent(const ocsd_vaddr_t address,const ocsd_mem_space_acc_t mem_space,  const uint8_t cs_trace_id);
117    virtual TrcMemAccessorBase *getFirstAccessor();
118    virtual TrcMemAccessorBase *getNextAccessor();
119    virtual void clearAccessorList();
120    virtual ocsd_err_t RemoveAccessor(const TrcMemAccessorBase *p_accessor);
121
122    std::vector<TrcMemAccessorBase *> m_acc_global;
123    std::vector<TrcMemAccessorBase *>::iterator m_acc_it;
124};
125
126#endif // ARM_TRC_MEM_ACC_MAPPER_H_INCLUDED
127
128/* End of File trc_mem_acc_mapper.h */
129