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# Authors: Gabe Black
27
28from m5.objects.SystemC import SystemC_ScModule
29from m5.params import *
30from m5.proxy import *
31
32from m5.objects.Tlm import TlmTargetSocket, TlmInitiatorSocket
33
34class Gem5ToTlmBridgeBase(SystemC_ScModule):
35    type = 'Gem5ToTlmBridgeBase'
36    abstract = True
37    cxx_class = 'sc_gem5::Gem5ToTlmBridgeBase'
38    cxx_header = 'systemc/tlm_bridge/gem5_to_tlm.hh'
39
40    system = Param.System(Parent.any, "system")
41
42    gem5 = SlavePort('gem5 slave port')
43    addr_ranges = VectorParam.AddrRange([],
44            'Addresses served by this port\'s TLM side')
45
46class TlmToGem5BridgeBase(SystemC_ScModule):
47    type = 'TlmToGem5BridgeBase'
48    abstract = True
49    cxx_class = 'sc_gem5::TlmToGem5BridgeBase'
50    cxx_header = 'systemc/tlm_bridge/tlm_to_gem5.hh'
51
52    system = Param.System(Parent.any, "system")
53
54    gem5 = MasterPort('gem5 master port')
55
56
57class Gem5ToTlmBridge32(Gem5ToTlmBridgeBase):
58    type = 'Gem5ToTlmBridge32'
59    cxx_template_params = [ 'unsigned int BITWIDTH' ]
60    cxx_class = 'sc_gem5::Gem5ToTlmBridge<32>'
61    cxx_header = 'systemc/tlm_bridge/gem5_to_tlm.hh'
62
63    tlm = TlmInitiatorSocket(32, 'TLM initiator socket')
64
65class Gem5ToTlmBridge64(Gem5ToTlmBridgeBase):
66    type = 'Gem5ToTlmBridge64'
67    cxx_template_params = [ 'unsigned int BITWIDTH' ]
68    cxx_class = 'sc_gem5::Gem5ToTlmBridge<64>'
69    cxx_header = 'systemc/tlm_bridge/gem5_to_tlm.hh'
70
71    tlm = TlmInitiatorSocket(64, 'TLM initiator socket')
72
73
74class TlmToGem5Bridge32(TlmToGem5BridgeBase):
75    type = 'TlmToGem5Bridge32'
76    cxx_template_params = [ 'unsigned int BITWIDTH' ]
77    cxx_class = 'sc_gem5::TlmToGem5Bridge<32>'
78    cxx_header = 'systemc/tlm_bridge/tlm_to_gem5.hh'
79
80    tlm = TlmTargetSocket(32, 'TLM target socket')
81
82class TlmToGem5Bridge64(TlmToGem5BridgeBase):
83    type = 'TlmToGem5Bridge64'
84    cxx_template_params = [ 'unsigned int BITWIDTH' ]
85    cxx_class = 'sc_gem5::TlmToGem5Bridge<64>'
86    cxx_header = 'systemc/tlm_bridge/tlm_to_gem5.hh'
87
88    tlm = TlmTargetSocket(64, 'TLM target socket')
89