summaryrefslogtreecommitdiff
path: root/src/systemc/sc_port_wrapper.hh
blob: b6f6f8504a0286a0ea05b995c804dade5a770429 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
/*
 * Copyright 2019 Google LLC.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Chun-Chen TK Hsu
 */

#ifndef __SYSTEMC_SC_PORT_WRAPPER_HH__
#define __SYSTEMC_SC_PORT_WRAPPER_HH__

#include <string>
#include <type_traits>

#include "base/logging.hh"
#include "sim/port.hh"
#include "systemc/ext/core/sc_export.hh"
#include "systemc/ext/core/sc_interface.hh"
#include "systemc/ext/core/sc_port.hh"

namespace sc_gem5
{

// Forward declaration
template <typename IF>
class ScPortWrapper;
template <typename IF>
class ScInterfaceWrapper;
template <typename IF>
class ScExportWrapper;

template <typename IF>
class ScPortWrapper : public ::Port
{
  public:
    using ScPort = sc_core::sc_port_b<IF>;

    ScPortWrapper(ScPort& p, const std::string& name, PortID id)
        : Port(name, id), port_(p)
    {}

    ScPort&
    port()
    {
        return port_;
    }

    void
    unbind() override
    {
        panic("sc_port can't be unbound.");
    }

    void
    bind(::Port& peer) override
    {
        // Try ScPortWrapper or ScInterfaceWrapper
        if (auto* beer = dynamic_cast<ScPortWrapper<IF>*>(&peer)) {
            port_.bind(beer->port());
        } else if (auto* iface =
                       dynamic_cast<ScInterfaceWrapper<IF>*>(&peer)) {
            port_.bind(iface->interface());
        } else {
            fatal("Attempt to bind sc_port %s to incompatible port %s.",
                  name(), peer.name());
        }
    }

  private:
    ScPort& port_;
};

template <typename IF>
class ScInterfaceWrapper : public ::Port
{
  public:
    ScInterfaceWrapper(IF& i, const std::string name, PortID id)
        : Port(name, id), iface_(i)
    {}

    IF&
    interface()
    {
        return iface_;
    }

    void
    unbind() override
    {
        panic("sc_interface can't be unbound.");
    }

    void
    bind(::Port& peer) override
    {
        // fatal error if peer is neither ScPortWrapper nor ScExportWrapper
        fatal_if(!dynamic_cast<ScPortWrapper<IF>*>(&peer) &&
                     !dynamic_cast<ScExportWrapper<IF>*>(&peer),
                 "Attempt to bind sc_interface %s to incompatible port %s.",
                 name(), peer.name());

        // Don't bind to peer otherwise we may have error messages saying that
        // this interface has already be bound since the peer may already did
        // that. Just let sc_port or sc_export do the binding
    }

  private:
    IF& iface_;
};

template <typename IF>
class ScExportWrapper : public ::Port
{
  public:
    using ScExport = sc_core::sc_export<IF>;

    ScExportWrapper(ScExport& p, const std::string& name, PortID id)
        : Port(name, id), port_(p)
    {}

    ScExport&
    port()
    {
        return port_;
    }

    void
    unbind() override
    {
        panic("sc_export cannot be unbound.");
    }

    void
    bind(::Port& peer) override
    {
        auto* iface = dynamic_cast<ScInterfaceWrapper<IF>*>(&peer);
        fatal_if(!iface,
                 "Attempt to bind sc_export %s to incompatible port %s.",
                 name(), peer.name());

        port_.bind(iface->interface());
    }

  private:
    ScExport& port_;
};

}  // namespace sc_gem5

#endif  // __SYSTEMC_SC_PORT_WRAPPER_HH__