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 * Authors: Gabe Black
28 */
29
30#ifndef __SYSTEMC_EXT_CORE_SC_PRIM_HH__
31#define __SYSTEMC_EXT_CORE_SC_PRIM_HH__
32
33#include "sc_object.hh"
34#include "sc_time.hh"
35
36namespace sc_gem5
37{
38
39class Channel;
40
41uint64_t getChangeStamp();
42
43} // namespace sc_gem5
44
45namespace sc_core
46{
47
48class sc_event;
49class sc_event_and_list;
50class sc_event_or_list;
51
52class sc_prim_channel : public sc_object
53{
54 public:
55 virtual const char *kind() const { return "sc_prim_channel"; }
56
57 protected:
58 sc_prim_channel();
59 explicit sc_prim_channel(const char *);
60 virtual ~sc_prim_channel();
61
62 void request_update();
63 void async_request_update();
64 virtual void update() {}
65
66 void next_trigger();
67 void next_trigger(const sc_event &);
68 void next_trigger(const sc_event_or_list &);
69 void next_trigger(const sc_event_and_list &);
70 void next_trigger(const sc_time &);
71 void next_trigger(double, sc_time_unit);
72 void next_trigger(const sc_time &, const sc_event &);
73 void next_trigger(double, sc_time_unit, const sc_event &);
74 void next_trigger(const sc_time &, const sc_event_or_list &);
75 void next_trigger(double, sc_time_unit, const sc_event_or_list &);
76 void next_trigger(const sc_time &, const sc_event_and_list &);
77 void next_trigger(double, sc_time_unit, const sc_event_and_list &);
78
79 // Nonstandard.
80 bool timed_out();
81
82 void wait();
83 void wait(int);
84 void wait(const sc_event &);
85 void wait(const sc_event_or_list &);
86 void wait(const sc_event_and_list &);
87 void wait(const sc_time &);
88 void wait(double, sc_time_unit);
89 void wait(const sc_time &, const sc_event &);
90 void wait(double, sc_time_unit, const sc_event &);
91 void wait(const sc_time &, const sc_event_or_list &);
92 void wait(double, sc_time_unit, const sc_event_or_list &);
93 void wait(const sc_time &, const sc_event_and_list &);
94 void wait(double, sc_time_unit, const sc_event_and_list &);
95
96 friend class sc_gem5::Kernel;
97
98 virtual void before_end_of_elaboration() {}
99 virtual void end_of_elaboration() {}
100 virtual void start_of_simulation() {}
101 virtual void end_of_simulation() {}
102
103 private:
104 // Disabled
105 sc_prim_channel(const sc_prim_channel &);
106 sc_prim_channel &operator = (const sc_prim_channel &);
107
108 friend class sc_gem5::Channel;
109 sc_gem5::Channel *_gem5_channel;
110};
111
112} // namespace sc_core
113
114#endif //__SYSTEMC_EXT_CORE_SC_PRIM_HH__