sc_clock.hh (12841:22aa7ba47bf9) sc_clock.hh (12878:97fdce181f51)
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_CHANNEL_SC_CLOCK_HH__
31#define __SYSTEMC_EXT_CHANNEL_SC_CLOCK_HH__
32
33#include "../core/sc_time.hh"
34#include "sc_signal.hh"
35
36namespace sc_core
37{
38
39template <class T>
40class sc_in;
41
42class sc_time;
43
44class sc_clock : public sc_signal<bool>
45{
46 public:
47 sc_clock();
48 explicit sc_clock(const char *name);
49
50 sc_clock(const char *name, const sc_time &period,
51 double duty_cycle=0.5, const sc_time &start_time=SC_ZERO_TIME,
52 bool posedge_first=true);
53
54 sc_clock(const char *name, double period_v, sc_time_unit period_tu,
55 double duty_cycle=0.5);
56
57 sc_clock(const char *name, double period_v, sc_time_unit period_tu,
58 double duty_cycle, double start_time_v,
59 sc_time_unit start_time_tu, bool posedge_first=true);
60
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_CHANNEL_SC_CLOCK_HH__
31#define __SYSTEMC_EXT_CHANNEL_SC_CLOCK_HH__
32
33#include "../core/sc_time.hh"
34#include "sc_signal.hh"
35
36namespace sc_core
37{
38
39template <class T>
40class sc_in;
41
42class sc_time;
43
44class sc_clock : public sc_signal<bool>
45{
46 public:
47 sc_clock();
48 explicit sc_clock(const char *name);
49
50 sc_clock(const char *name, const sc_time &period,
51 double duty_cycle=0.5, const sc_time &start_time=SC_ZERO_TIME,
52 bool posedge_first=true);
53
54 sc_clock(const char *name, double period_v, sc_time_unit period_tu,
55 double duty_cycle=0.5);
56
57 sc_clock(const char *name, double period_v, sc_time_unit period_tu,
58 double duty_cycle, double start_time_v,
59 sc_time_unit start_time_tu, bool posedge_first=true);
60
61 // Deprecated.
62 sc_clock(const char *name, double period, double duty_cycle=0.5,
63 double start_time=0.0, bool posedge_first=true);
64
61 virtual ~sc_clock();
62
63 virtual void write(const bool &);
64
65 const sc_time &period() const;
66 double duty_cycle() const;
67 const sc_time &start_time() const;
68 bool posedge_first() const;
69
70 virtual const char *kind() const;
71
72 protected:
73 virtual void before_end_of_elaboration();
74
75 private:
76 // Disabled
77 sc_clock(const sc_clock &) : sc_interface(), sc_signal<bool>() {}
78 sc_clock &operator = (const sc_clock &) { return *this; }
79};
80
81typedef sc_in<bool> sc_in_clk;
82
65 virtual ~sc_clock();
66
67 virtual void write(const bool &);
68
69 const sc_time &period() const;
70 double duty_cycle() const;
71 const sc_time &start_time() const;
72 bool posedge_first() const;
73
74 virtual const char *kind() const;
75
76 protected:
77 virtual void before_end_of_elaboration();
78
79 private:
80 // Disabled
81 sc_clock(const sc_clock &) : sc_interface(), sc_signal<bool>() {}
82 sc_clock &operator = (const sc_clock &) { return *this; }
83};
84
85typedef sc_in<bool> sc_in_clk;
86
87// Deprecated
88typedef sc_inout<bool> sc_inout_clk;
89typedef sc_out<bool> sc_out_clk;
90
83} // namespace sc_core
84
85#endif //__SYSTEMC_EXT_CHANNEL_SC_CLOCK_HH__
91} // namespace sc_core
92
93#endif //__SYSTEMC_EXT_CHANNEL_SC_CLOCK_HH__