gem5_to_tlm.hh revision 13823:040971e0f728 
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        void
107        recvFunctional(PacketPtr pkt) override
108        {
109            return bridge.recvFunctional(pkt);
110        }
111        bool
112        recvTimingReq(PacketPtr pkt) override
113        {
114            return bridge.recvTimingReq(pkt);
115        }
116        bool
117        tryTiming(PacketPtr pkt) override
118        {
119            return bridge.tryTiming(pkt);
120        }
121        bool
122        recvTimingSnoopResp(PacketPtr pkt) override
123        {
124            return bridge.recvTimingSnoopResp(pkt);
125        }
126        void recvRespRetry() override { bridge.recvRespRetry(); }
127
128      public:
129        BridgeSlavePort(const std::string &name_,
130                        Gem5ToTlmBridge<BITWIDTH> &bridge_) :
131            SlavePort(name_, nullptr), bridge(bridge_)
132        {}
133    };
134
135    BridgeSlavePort bsp;
136    tlm_utils::simple_initiator_socket<
137        Gem5ToTlmBridge<BITWIDTH>, BITWIDTH> socket;
138    sc_gem5::TlmInitiatorWrapper<BITWIDTH> wrapper;
139
140    System *system;
141
142    /**
143     * A transaction after BEGIN_REQ has been sent but before END_REQ, which
144     * is blocking the request channel (Exlusion Rule, see IEEE1666)
145     */
146    tlm::tlm_generic_payload *blockingRequest;
147
148    /**
149     * Did another gem5 request arrive while currently blocked?
150     * This variable is needed when a retry should happen
151     */
152    bool needToSendRequestRetry;
153
154    /**
155     * A response which has been asked to retry by gem5 and so is blocking
156     * the response channel
157     */
158    tlm::tlm_generic_payload *blockingResponse;
159
160    AddrRangeList addrRanges;
161
162  protected:
163    void pec(Gem5SystemC::PayloadEvent<Gem5ToTlmBridge<BITWIDTH>> *pe,
164             tlm::tlm_generic_payload &trans, const tlm::tlm_phase &phase);
165
166    // The gem5 port interface.
167    Tick recvAtomic(PacketPtr packet);
168    void recvFunctional(PacketPtr packet);
169    bool recvTimingReq(PacketPtr packet);
170    bool tryTiming(PacketPtr packet);
171    bool recvTimingSnoopResp(PacketPtr packet);
172    void recvRespRetry();
173    void recvFunctionalSnoop(PacketPtr packet);
174    AddrRangeList getAddrRanges() const { return addrRanges; }
175
176    // The TLM initiator interface.
177    tlm::tlm_sync_enum nb_transport_bw(tlm::tlm_generic_payload &trans,
178                                       tlm::tlm_phase &phase,
179                                       sc_core::sc_time &t);
180
181  public:
182    ::Port &gem5_getPort(const std::string &if_name, int idx=-1) override;
183
184    typedef Gem5ToTlmBridgeBaseParams Params;
185    Gem5ToTlmBridge(Params *p, const sc_core::sc_module_name &mn);
186
187    tlm_utils::simple_initiator_socket<Gem5ToTlmBridge<BITWIDTH>, BITWIDTH> &
188    getSocket()
189    {
190        return socket;
191    }
192
193    void before_end_of_elaboration() override;
194};
195
196} // namespace sc_gem5
197
198#endif // __SYSTEMC_TLM_BRIDGE_GEM5_TO_TLM_HH__
199