sc_clock.hh revision 12878:97fdce181f51
112855Sgabeblack@google.com/* 212855Sgabeblack@google.com * Copyright 2018 Google, Inc. 312855Sgabeblack@google.com * 412855Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 512855Sgabeblack@google.com * modification, are permitted provided that the following conditions are 612855Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 712855Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 812855Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 912855Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1012855Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1112855Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1212855Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1312855Sgabeblack@google.com * this software without specific prior written permission. 1412855Sgabeblack@google.com * 1512855Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1612855Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1712855Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1812855Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1912855Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2012855Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2112855Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2212855Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2312855Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2412855Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2512855Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2612855Sgabeblack@google.com * 2712855Sgabeblack@google.com * Authors: Gabe Black 2812855Sgabeblack@google.com */ 2912855Sgabeblack@google.com 3012855Sgabeblack@google.com#ifndef __SYSTEMC_EXT_CHANNEL_SC_CLOCK_HH__ 3112855Sgabeblack@google.com#define __SYSTEMC_EXT_CHANNEL_SC_CLOCK_HH__ 3212855Sgabeblack@google.com 3312855Sgabeblack@google.com#include "../core/sc_time.hh" 3412855Sgabeblack@google.com#include "sc_signal.hh" 3512855Sgabeblack@google.com 3612855Sgabeblack@google.comnamespace sc_core 3712855Sgabeblack@google.com{ 3812855Sgabeblack@google.com 3912855Sgabeblack@google.comtemplate <class T> 4012855Sgabeblack@google.comclass sc_in; 4112855Sgabeblack@google.com 4212855Sgabeblack@google.comclass sc_time; 4312855Sgabeblack@google.com 4412855Sgabeblack@google.comclass sc_clock : public sc_signal<bool> 4512855Sgabeblack@google.com{ 4612855Sgabeblack@google.com public: 4712855Sgabeblack@google.com sc_clock(); 4812855Sgabeblack@google.com explicit sc_clock(const char *name); 4912855Sgabeblack@google.com 5012855Sgabeblack@google.com sc_clock(const char *name, const sc_time &period, 5112855Sgabeblack@google.com double duty_cycle=0.5, const sc_time &start_time=SC_ZERO_TIME, 5212855Sgabeblack@google.com bool posedge_first=true); 5312855Sgabeblack@google.com 5412855Sgabeblack@google.com sc_clock(const char *name, double period_v, sc_time_unit period_tu, 5512855Sgabeblack@google.com 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 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 91} // namespace sc_core 92 93#endif //__SYSTEMC_EXT_CHANNEL_SC_CLOCK_HH__ 94