src/systemc/tlm_bridge/TlmBridge.py

   1 # Copyright 2019 Google, Inc.
   2 #
   3 # Redistribution and use in source and binary forms, with or without
   4 # modification, are permitted provided that the following conditions are
   5 # met: redistributions of source code must retain the above copyright
   6 # notice, this list of conditions and the following disclaimer;
   7 # redistributions in binary form must reproduce the above copyright
   8 # notice, this list of conditions and the following disclaimer in the
   9 # documentation and/or other materials provided with the distribution;
  10 # neither the name of the copyright holders nor the names of its
  11 # contributors may be used to endorse or promote products derived from
  12 # this software without specific prior written permission.
  13 #
  14 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25
  26 from m5.objects.SystemC import SystemC_ScModule
  27 from m5.params import *
  28 from m5.proxy import *
  29
  30 from m5.objects.Tlm import TlmTargetSocket, TlmInitiatorSocket
  31
  32 class Gem5ToTlmBridgeBase(SystemC_ScModule):
  33     type = 'Gem5ToTlmBridgeBase'
  34     abstract = True
  35     cxx_class = 'sc_gem5::Gem5ToTlmBridgeBase'
  36     cxx_header = 'systemc/tlm_bridge/gem5_to_tlm.hh'
  37
  38     system = Param.System(Parent.any, "system")
  39
  40     gem5 = ResponsePort('gem5 slave port')
  41     addr_ranges = VectorParam.AddrRange([],
  42             'Addresses served by this port\'s TLM side')
  43
  44 class TlmToGem5BridgeBase(SystemC_ScModule):
  45     type = 'TlmToGem5BridgeBase'
  46     abstract = True
  47     cxx_class = 'sc_gem5::TlmToGem5BridgeBase'
  48     cxx_header = 'systemc/tlm_bridge/tlm_to_gem5.hh'
  49
  50     system = Param.System(Parent.any, "system")
  51
  52     gem5 = RequestPort('gem5 master port')
  53
  54
  55 class Gem5ToTlmBridge32(Gem5ToTlmBridgeBase):
  56     type = 'Gem5ToTlmBridge32'
  57     cxx_template_params = [ 'unsigned int BITWIDTH' ]
  58     cxx_class = 'sc_gem5::Gem5ToTlmBridge<32>'
  59     cxx_header = 'systemc/tlm_bridge/gem5_to_tlm.hh'
  60
  61     tlm = TlmInitiatorSocket(32, 'TLM initiator socket')
  62
  63 class Gem5ToTlmBridge64(Gem5ToTlmBridgeBase):
  64     type = 'Gem5ToTlmBridge64'
  65     cxx_template_params = [ 'unsigned int BITWIDTH' ]
  66     cxx_class = 'sc_gem5::Gem5ToTlmBridge<64>'
  67     cxx_header = 'systemc/tlm_bridge/gem5_to_tlm.hh'
  68
  69     tlm = TlmInitiatorSocket(64, 'TLM initiator socket')
  70
  71
  72 class TlmToGem5Bridge32(TlmToGem5BridgeBase):
  73     type = 'TlmToGem5Bridge32'
  74     cxx_template_params = [ 'unsigned int BITWIDTH' ]
  75     cxx_class = 'sc_gem5::TlmToGem5Bridge<32>'
  76     cxx_header = 'systemc/tlm_bridge/tlm_to_gem5.hh'
  77
  78     tlm = TlmTargetSocket(32, 'TLM target socket')
  79
  80 class TlmToGem5Bridge64(TlmToGem5BridgeBase):
  81     type = 'TlmToGem5Bridge64'
  82     cxx_template_params = [ 'unsigned int BITWIDTH' ]
  83     cxx_class = 'sc_gem5::TlmToGem5Bridge<64>'
  84     cxx_header = 'systemc/tlm_bridge/tlm_to_gem5.hh'
  85
  86     tlm = TlmTargetSocket(64, 'TLM target socket')