target_socket.hh revision 13521:74fa3ac44057 
1/*****************************************************************************
2
3  Licensed to Accellera Systems Initiative Inc. (Accellera) under one or
4  more contributor license agreements.  See the NOTICE file distributed
5  with this work for additional information regarding copyright ownership.
6  Accellera licenses this file to you under the Apache License, Version 2.0
7  (the "License"); you may not use this file except in compliance with the
8  License.  You may obtain a copy of the License at
9
10    http://www.apache.org/licenses/LICENSE-2.0
11
12  Unless required by applicable law or agreed to in writing, software
13  distributed under the License is distributed on an "AS IS" BASIS,
14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
15  implied.  See the License for the specific language governing
16  permissions and limitations under the License.
17
18 *****************************************************************************/
19
20#ifndef __SYSTEMC_EXT_TLM_CORE_2_SOCKETS_TARGET_SOCKET_HH__
21#define __SYSTEMC_EXT_TLM_CORE_2_SOCKETS_TARGET_SOCKET_HH__
22
23#include "tlm_core/2/interfaces/fw_bw_ifs.hh"
24#include "tlm_core/2/sockets/base_socket_if.hh"
25
26namespace tlm
27{
28
29template <unsigned int BUSWIDTH=32, typename FW_IF=tlm_fw_transport_if<>,
30          typename BW_IF=tlm_bw_transport_if<>>
31class tlm_base_target_socket_b
32{
33  public:
34    virtual ~tlm_base_target_socket_b() {}
35
36    virtual sc_core::sc_port_b<BW_IF> &get_base_port() = 0;
37    virtual sc_core::sc_export<FW_IF> &get_base_export() = 0;
38    virtual FW_IF &get_base_interface() = 0;
39};
40
41template <unsigned int BUSWIDTH, typename FW_IF, typename BW_IF>
42class tlm_base_initiator_socket_b;
43
44template <unsigned int BUSWIDTH, typename FW_IF, typename BW_IF, int N,
45          sc_core::sc_port_policy POL>
46class tlm_base_initiator_socket;
47
48template <unsigned int BUSWIDTH=32, typename FW_IF=tlm_fw_transport_if<>,
49          typename BW_IF=tlm_bw_transport_if<>, int N=1,
50          sc_core::sc_port_policy POL=sc_core::SC_ONE_OR_MORE_BOUND>
51class tlm_base_target_socket :
52    public tlm_base_socket_if,
53    public tlm_base_target_socket_b<BUSWIDTH, FW_IF, BW_IF>,
54    public sc_core::sc_export<FW_IF>
55{
56  public:
57    typedef FW_IF fw_interface_type;
58    typedef BW_IF bw_interface_type;
59    typedef sc_core::sc_port<bw_interface_type, N, POL> port_type;
60
61    typedef sc_core::sc_export<fw_interface_type> export_type;
62    typedef tlm_base_initiator_socket_b<
63        BUSWIDTH, fw_interface_type, bw_interface_type>
64        base_initiator_socket_type;
65
66    typedef tlm_base_target_socket_b<
67        BUSWIDTH, fw_interface_type, bw_interface_type> base_type;
68
69    template <unsigned int, typename, typename, int, sc_core::sc_port_policy>
70    friend class tlm_base_initiator_socket;
71
72  public:
73    tlm_base_target_socket() :
74        export_type(sc_core::sc_gen_unique_name("tlm_base_target_socket")),
75        m_port(sc_core::sc_gen_unique_name("tlm_base_target_socket_port"))
76    {}
77
78    explicit tlm_base_target_socket(const char *name) :
79        export_type(name), m_port(sc_core::sc_gen_unique_name(
80                    (std::string(name) + "_port").c_str()))
81    {}
82
83    virtual const char *kind() const { return "tlm_base_target_socket"; }
84
85    //
86    // Bind target socket to initiator socket
87    // - Binds the port of the initiator socket to the export of the target
88    //   socket
89    // - Binds the port of the target socket to the export of the initiator
90    //   socket
91    //
92    virtual void
93    bind(base_initiator_socket_type &s)
94    {
95        // initiator.port -> target.export
96        (s.get_base_port())(get_base_interface());
97        // target.port -> initiator.export
98        get_base_port()(s.get_base_interface());
99    }
100
101    void operator () (base_initiator_socket_type &s) { bind(s); }
102
103    //
104    // Bind target socket to target socket (hierarchical bind)
105    // - Binds both the export and the port
106    //
107    virtual void
108    bind(base_type &s)
109    {
110        // export
111        (get_base_export())(s.get_base_export());
112        // port
113        (s.get_base_port())(get_base_port());
114    }
115
116    void operator () (base_type &s) { bind(s); }
117
118    //
119    // Bind interface to socket
120    // - Binds the interface to the export
121    //
122    virtual void
123    bind(fw_interface_type &ifs)
124    {
125        export_type *exp = &get_base_export();
126        if (this == exp) {
127            export_type::bind(ifs);
128        } else {
129            exp->bind( ifs );
130        }
131    }
132
133    void operator () (fw_interface_type &s) { bind(s); }
134
135    //
136    // Forward to 'size()' of port class.
137    //
138    int size() const { return m_port.size(); }
139
140    //
141    // Forward to 'operator->()' of port class.
142    //
143    bw_interface_type *operator->() { return m_port.operator->(); }
144
145    //
146    // Forward to 'operator[]()' of port class.
147    //
148    bw_interface_type *operator[](int i) { return m_port.operator[](i); }
149
150    // Implementation of tlm_base_socket_if functions.
151    virtual sc_core::sc_port_base &get_port_base() { return m_port; }
152    virtual sc_core::sc_port_base const &
153    get_port_base() const
154    {
155        return m_port;
156    }
157    virtual sc_core::sc_export_base &get_export_base() { return *this; }
158    virtual sc_core::sc_export_base const &
159    get_export_base() const
160    {
161        return *this;
162    }
163    virtual unsigned int get_bus_width() const { return BUSWIDTH; }
164    virtual tlm_socket_category
165    get_socket_category() const
166    {
167        return TLM_TARGET_SOCKET;
168    }
169
170    // Implementation of tlm_base_target_socket_b functions
171    virtual sc_core::sc_port_b<BW_IF> &get_base_port() { return m_port; }
172    virtual sc_core::sc_port_b<BW_IF> const &
173    get_base_port() const
174    {
175        return m_port;
176    }
177
178    virtual FW_IF &get_base_interface() { return *this; }
179    virtual FW_IF const &get_base_interface() const { return *this; }
180
181    virtual sc_core::sc_export<FW_IF> &get_base_export() { return *this; }
182    virtual sc_core::sc_export<FW_IF> const &
183    get_base_export() const
184    {
185        return *this;
186    }
187
188  protected:
189    port_type m_port;
190};
191
192template <unsigned int BUSWIDTH=32, typename TYPES=tlm_base_protocol_types,
193          int N=1, sc_core::sc_port_policy POL=sc_core::SC_ONE_OR_MORE_BOUND>
194class tlm_target_socket :
195    public tlm_base_target_socket<
196        BUSWIDTH, tlm_fw_transport_if<TYPES>,
197        tlm_bw_transport_if<TYPES>, N, POL>
198{
199  public:
200    tlm_target_socket() :
201        tlm_base_target_socket<
202            BUSWIDTH, tlm_fw_transport_if<TYPES>,
203            tlm_bw_transport_if<TYPES>, N, POL>()
204    {}
205
206    explicit tlm_target_socket(const char *name) :
207        tlm_base_target_socket<
208            BUSWIDTH, tlm_fw_transport_if<TYPES>,
209            tlm_bw_transport_if<TYPES>, N, POL>(name)
210    {}
211
212    virtual const char* kind() const { return "tlm_target_socket"; }
213
214    virtual sc_core::sc_type_index
215    get_protocol_types() const
216    {
217        return typeid(TYPES);
218    }
219};
220
221} // namespace tlm
222
223#endif /* __SYSTEMC_EXT_TLM_CORE_2_SOCKETS_TARGET_SOCKET_HH__ */
224