src/systemc/tlm_port_wrapper.hh

   1 /*
   2  * Copyright 2018 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
  28 #ifndef __SYSTEMC_TLM_PORT_WRAPPER_HH__
  29 #define __SYSTEMC_TLM_PORT_WRAPPER_HH__
  30
  31 #include "base/logging.hh"
  32 #include "sim/port.hh"
  33 #include "systemc/ext/tlm_core/2/sockets/sockets.hh"
  34
  35 namespace sc_gem5
  36 {
  37
  38 template <unsigned int BUSWIDTH, typename FW_IF, typename BW_IF, int N,
  39           sc_core::sc_port_policy POL>
  40 class TlmInitiatorBaseWrapper;
  41
  42 template <unsigned int BUSWIDTH, typename FW_IF, typename BW_IF, int N,
  43           sc_core::sc_port_policy POL>
  44 class TlmTargetBaseWrapper;
  45
  46 template <unsigned int BUSWIDTH, typename FW_IF, typename BW_IF, int N,
  47           sc_core::sc_port_policy POL>
  48 class TlmInitiatorBaseWrapper : public ::Port
  49 {
  50   public:
  51     typedef tlm::tlm_base_initiator_socket<BUSWIDTH, FW_IF, BW_IF, N, POL>
  52         InitiatorSocket;
  53     typedef typename InitiatorSocket::base_target_socket_type TargetSocket;
  54     typedef TlmTargetBaseWrapper<BUSWIDTH, FW_IF, BW_IF, N, POL> TargetWrapper;
  55
  56     InitiatorSocket &initiator() { return _initiator; }
  57
  58     TlmInitiatorBaseWrapper(
  59             InitiatorSocket &i, const std::string &_name, PortID _id) :
  60         Port(_name, _id), _initiator(i)
  61     {}
  62
  63     void
  64     bind(::Port &peer) override
  65     {
  66         auto *target = dynamic_cast<TargetWrapper *>(&peer);
  67         fatal_if(!target, "Attempt to bind TLM initiator socket %s to "
  68                 "incompatible port %s.", name(), peer.name());
  69
  70         initiator().bind(target->target());
  71         Port::bind(peer);
  72     }
  73
  74     void
  75     unbind() override
  76     {
  77         panic("TLM sockets can't be unbound.");
  78     }
  79
  80   private:
  81     InitiatorSocket &_initiator;
  82 };
  83
  84 template <unsigned int BUSWIDTH, typename FW_IF, typename BW_IF, int N,
  85           sc_core::sc_port_policy POL>
  86 class TlmTargetBaseWrapper : public ::Port
  87 {
  88   public:
  89     typedef tlm::tlm_base_target_socket<BUSWIDTH, FW_IF, BW_IF, N, POL>
  90         TargetSocket;
  91
  92     TargetSocket &target() { return _target; }
  93
  94     TlmTargetBaseWrapper(TargetSocket &t, const std::string &_name,
  95                          PortID _id) :
  96         Port(_name, _id), _target(t)
  97     {}
  98
  99     void
 100     bind(::Port &peer) override
 101     {
 102         // Ignore attempts to bind a target socket. The initiator will
 103         // handle it.
 104         Port::bind(peer);
 105     }
 106
 107     void
 108     unbind() override
 109     {
 110         panic("TLM sockets can't be unbound.");
 111     }
 112
 113   private:
 114     TargetSocket &_target;
 115 };
 116
 117 template <unsigned int BUSWIDTH=32,
 118           typename TYPES=tlm::tlm_base_protocol_types, int N=1,
 119           sc_core::sc_port_policy POL=sc_core::SC_ONE_OR_MORE_BOUND>
 120 using TlmInitiatorWrapper =
 121     TlmInitiatorBaseWrapper<BUSWIDTH, tlm::tlm_fw_transport_if<TYPES>,
 122                             tlm::tlm_bw_transport_if<TYPES>, N, POL>;
 123
 124 template <unsigned int BUSWIDTH=32,
 125           typename TYPES=tlm::tlm_base_protocol_types, int N=1,
 126           sc_core::sc_port_policy POL=sc_core::SC_ONE_OR_MORE_BOUND>
 127 using TlmTargetWrapper =
 128     TlmTargetBaseWrapper<BUSWIDTH, tlm::tlm_fw_transport_if<TYPES>,
 129                          tlm::tlm_bw_transport_if<TYPES>, N, POL>;
 130
 131 } // namespace sc_gem5
 132
 133 #endif  //__SYSTEMC_TLM_PORT_WRAPPER_HH__