1/*
2 * Copyright (c) 2017 Jason Lowe-Power
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 *
28 * Authors: Jason Lowe-Power
29 */
30
31#ifndef __LEARNING_GEM5_HELLO_OBJECT_HH__
32#define __LEARNING_GEM5_HELLO_OBJECT_HH__
33
34#include <string>
35
36#include "learning_gem5/part2/goodbye_object.hh"
37#include "params/HelloObject.hh"
38#include "sim/sim_object.hh"
39
40class HelloObject : public SimObject
41{
42  private:
43    /**
44     * Example function to execute on an event trigger
45     */
46    void processEvent();
47
48    /// An event that wraps the above function
49    EventFunctionWrapper event;
50
51    /// Pointer to the corresponding GoodbyeObject. Set via Python
52    GoodbyeObject* goodbye;
53
54    /// The name of this object in the Python config file
55    const std::string myName;
56
57    /// Latency between calling the event (in ticks)
58    const Tick latency;
59
60    /// Number of times left to fire the event before goodbye
61    int timesLeft;
62
63  public:
64    HelloObject(HelloObjectParams *p);
65
66    /**
67     * Part of a SimObject's initilaization. Startup is called after all
68     * SimObjects have been constructed. It is called after the user calls
69     * simulate() for the first time.
70     */
71    void startup();
72};
73
74#endif // __LEARNING_GEM5_HELLO_OBJECT_HH__
75