1# Copyright 2018 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.params import *
29from m5.SimObject import SimObject
30
31from SystemC import SystemC_ScModule
32
33# This class is a subclass of sc_module, and all the special magic which makes
34# that work is handled in the base classes.
35class SystemC_Printer(SystemC_ScModule):
36    type = 'SystemC_Printer'
37    cxx_class = 'Printer'
38    cxx_header = 'systemc_simple_object/printer.hh'
39    # This parameter will be available in the SystemC_PrinterParams::create
40    # function and can be passed to the c++ object's constructor, used to set
41    # one of its member variables, as a parameter to one of its methods, etc.
42    prefix = Param.String('', 'Prefix for each word')
43
44# This is a standard gem5 SimObject class with no special accomodation for the
45# fact that one of its parameters is a systemc object.
46class Gem5_Feeder(SimObject):
47    type = 'Gem5_Feeder'
48    cxx_class = 'Feeder'
49    cxx_header = 'systemc_simple_object/feeder.hh'
50    # This parameter will be a pointer to an instance of the class above.
51    printer = Param.SystemC_Printer('Printer for our words.')
52    delay = Param.Latency('1ns', 'Time to wait between each word.')
53    strings = VectorParam.String([], 'Words to print.')
54