gem5_to_tlm.hh revision 13846 
1/*
2 * Copyright 2019 Google, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * Copyright (c) 2015, University of Kaiserslautern
28 * Copyright (c) 2016, Dresden University of Technology (TU Dresden)
29 * All rights reserved.
30 *
31 * Redistribution and use in source and binary forms, with or without
32 * modification, are permitted provided that the following conditions are
33 * met:
34 *
35 * 1. Redistributions of source code must retain the above copyright notice,
36 *    this list of conditions and the following disclaimer.
37 *
38 * 2. Redistributions in binary form must reproduce the above copyright
39 *    notice, this list of conditions and the following disclaimer in the
40 *    documentation and/or other materials provided with the distribution.
41 *
42 * 3. Neither the name of the copyright holder nor the names of its
43 *    contributors may be used to endorse or promote products derived from
44 *    this software without specific prior written permission.
45 *
46 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
47 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
48 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
49 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
50 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
51 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
52 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
53 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
54 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
55 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
56 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
57 *
58 * Authors: Gabe Black
59 *          Matthias Jung
60 *          Christian Menard
61 */
62
63#ifndef __SYSTEMC_TLM_BRIDGE_GEM5_TO_TLM_HH__
64#define __SYSTEMC_TLM_BRIDGE_GEM5_TO_TLM_HH__
65
66#include <string>
67
68#include "mem/port.hh"
69#include "params/Gem5ToTlmBridgeBase.hh"
70#include "sim/system.hh"
71#include "systemc/ext/core/sc_module.hh"
72#include "systemc/ext/core/sc_module_name.hh"
73#include "systemc/ext/tlm_core/2/generic_payload/gp.hh"
74#include "systemc/ext/tlm_utils/simple_initiator_socket.h"
75#include "systemc/tlm_bridge/sc_peq.hh"
76#include "systemc/tlm_port_wrapper.hh"
77
78namespace sc_gem5
79{
80
81class Gem5ToTlmBridgeBase : public sc_core::sc_module
82{
83  protected:
84    using sc_core::sc_module::sc_module;
85};
86
87template <unsigned int BITWIDTH>
88class Gem5ToTlmBridge : public Gem5ToTlmBridgeBase
89{
90  private:
91    class BridgeSlavePort : public SlavePort
92    {
93      protected:
94        Gem5ToTlmBridge<BITWIDTH> &bridge;
95
96        AddrRangeList
97        getAddrRanges() const override
98        {
99            return bridge.getAddrRanges();
100        }
101        Tick
102        recvAtomic(PacketPtr pkt) override
103        {
104            return bridge.recvAtomic(pkt);
105        }
106        Tick
107        recvAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor) override
108        {
109            return bridge.recvAtomicBackdoor(pkt, backdoor);
110        }
111        void
112        recvFunctional(PacketPtr pkt) override
113        {
114            return bridge.recvFunctional(pkt);
115        }
116        bool
117        recvTimingReq(PacketPtr pkt) override
118        {
119            return bridge.recvTimingReq(pkt);
120        }
121        bool
122        tryTiming(PacketPtr pkt) override
123        {
124            return bridge.tryTiming(pkt);
125        }
126        bool
127        recvTimingSnoopResp(PacketPtr pkt) override
128        {
129            return bridge.recvTimingSnoopResp(pkt);
130        }
131        void recvRespRetry() override { bridge.recvRespRetry(); }
132
133      public:
134        BridgeSlavePort(const std::string &name_,
135                        Gem5ToTlmBridge<BITWIDTH> &bridge_) :
136            SlavePort(name_, nullptr), bridge(bridge_)
137        {}
138    };
139
140    BridgeSlavePort bsp;
141    tlm_utils::simple_initiator_socket<
142        Gem5ToTlmBridge<BITWIDTH>, BITWIDTH> socket;
143    sc_gem5::TlmInitiatorWrapper<BITWIDTH> wrapper;
144
145    System *system;
146
147    /**
148     * A transaction after BEGIN_REQ has been sent but before END_REQ, which
149     * is blocking the request channel (Exlusion Rule, see IEEE1666)
150     */
151    tlm::tlm_generic_payload *blockingRequest;
152
153    /**
154     * Did another gem5 request arrive while currently blocked?
155     * This variable is needed when a retry should happen
156     */
157    bool needToSendRequestRetry;
158
159    /**
160     * A response which has been asked to retry by gem5 and so is blocking
161     * the response channel
162     */
163    tlm::tlm_generic_payload *blockingResponse;
164
165    AddrRangeList addrRanges;
166
167  protected:
168    void pec(Gem5SystemC::PayloadEvent<Gem5ToTlmBridge<BITWIDTH>> *pe,
169             tlm::tlm_generic_payload &trans, const tlm::tlm_phase &phase);
170
171    MemBackdoorPtr getBackdoor(tlm::tlm_generic_payload &trans);
172    AddrRangeMap<MemBackdoorPtr> backdoorMap;
173
174    // The gem5 port interface.
175    Tick recvAtomic(PacketPtr packet);
176    Tick recvAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor);
177    void recvFunctional(PacketPtr packet);
178    bool recvTimingReq(PacketPtr packet);
179    bool tryTiming(PacketPtr packet);
180    bool recvTimingSnoopResp(PacketPtr packet);
181    void recvRespRetry();
182    void recvFunctionalSnoop(PacketPtr packet);
183    AddrRangeList getAddrRanges() const { return addrRanges; }
184
185    // The TLM initiator interface.
186    tlm::tlm_sync_enum nb_transport_bw(tlm::tlm_generic_payload &trans,
187                                       tlm::tlm_phase &phase,
188                                       sc_core::sc_time &t);
189    void invalidate_direct_mem_ptr(
190            sc_dt::uint64 start_range, sc_dt::uint64 end_range);
191
192  public:
193    ::Port &gem5_getPort(const std::string &if_name, int idx=-1) override;
194
195    typedef Gem5ToTlmBridgeBaseParams Params;
196    Gem5ToTlmBridge(Params *p, const sc_core::sc_module_name &mn);
197
198    tlm_utils::simple_initiator_socket<Gem5ToTlmBridge<BITWIDTH>, BITWIDTH> &
199    getSocket()
200    {
201        return socket;
202    }
203
204    void before_end_of_elaboration() override;
205};
206
207} // namespace sc_gem5
208
209#endif // __SYSTEMC_TLM_BRIDGE_GEM5_TO_TLM_HH__
210