sc_clock.hh revision 12878
17506Stjones1@inf.ed.ac.uk/* 27506Stjones1@inf.ed.ac.uk * Copyright 2018 Google, Inc. 37506Stjones1@inf.ed.ac.uk * 47506Stjones1@inf.ed.ac.uk * Redistribution and use in source and binary forms, with or without 57506Stjones1@inf.ed.ac.uk * modification, are permitted provided that the following conditions are 67506Stjones1@inf.ed.ac.uk * met: redistributions of source code must retain the above copyright 77506Stjones1@inf.ed.ac.uk * notice, this list of conditions and the following disclaimer; 87506Stjones1@inf.ed.ac.uk * redistributions in binary form must reproduce the above copyright 97506Stjones1@inf.ed.ac.uk * notice, this list of conditions and the following disclaimer in the 107506Stjones1@inf.ed.ac.uk * documentation and/or other materials provided with the distribution; 117506Stjones1@inf.ed.ac.uk * neither the name of the copyright holders nor the names of its 127506Stjones1@inf.ed.ac.uk * contributors may be used to endorse or promote products derived from 137506Stjones1@inf.ed.ac.uk * this software without specific prior written permission. 147506Stjones1@inf.ed.ac.uk * 157506Stjones1@inf.ed.ac.uk * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 167506Stjones1@inf.ed.ac.uk * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 177506Stjones1@inf.ed.ac.uk * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 187506Stjones1@inf.ed.ac.uk * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 197506Stjones1@inf.ed.ac.uk * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 207506Stjones1@inf.ed.ac.uk * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 217506Stjones1@inf.ed.ac.uk * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 227506Stjones1@inf.ed.ac.uk * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 237506Stjones1@inf.ed.ac.uk * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 247506Stjones1@inf.ed.ac.uk * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 257506Stjones1@inf.ed.ac.uk * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 267506Stjones1@inf.ed.ac.uk * 277506Stjones1@inf.ed.ac.uk * Authors: Gabe Black 287506Stjones1@inf.ed.ac.uk */ 297506Stjones1@inf.ed.ac.uk 307506Stjones1@inf.ed.ac.uk#ifndef __SYSTEMC_EXT_CHANNEL_SC_CLOCK_HH__ 317506Stjones1@inf.ed.ac.uk#define __SYSTEMC_EXT_CHANNEL_SC_CLOCK_HH__ 327506Stjones1@inf.ed.ac.uk 337506Stjones1@inf.ed.ac.uk#include "../core/sc_time.hh" 347506Stjones1@inf.ed.ac.uk#include "sc_signal.hh" 357506Stjones1@inf.ed.ac.uk 3611793Sbrandon.potter@amd.comnamespace sc_core 377698SAli.Saidi@ARM.com{ 387506Stjones1@inf.ed.ac.uk 397506Stjones1@inf.ed.ac.uktemplate <class T> 407506Stjones1@inf.ed.ac.ukclass sc_in; 417506Stjones1@inf.ed.ac.uk 427506Stjones1@inf.ed.ac.ukclass sc_time; 437506Stjones1@inf.ed.ac.uk 447506Stjones1@inf.ed.ac.ukclass sc_clock : public sc_signal<bool> 457506Stjones1@inf.ed.ac.uk{ 467506Stjones1@inf.ed.ac.uk public: 477506Stjones1@inf.ed.ac.uk sc_clock(); 487506Stjones1@inf.ed.ac.uk explicit sc_clock(const char *name); 497506Stjones1@inf.ed.ac.uk 507506Stjones1@inf.ed.ac.uk sc_clock(const char *name, const sc_time &period, 517506Stjones1@inf.ed.ac.uk double duty_cycle=0.5, const sc_time &start_time=SC_ZERO_TIME, 529920Syasuko.eckert@amd.com bool posedge_first=true); 539920Syasuko.eckert@amd.com 549920Syasuko.eckert@amd.com sc_clock(const char *name, double period_v, sc_time_unit period_tu, 557506Stjones1@inf.ed.ac.uk double duty_cycle=0.5); 567506Stjones1@inf.ed.ac.uk 577506Stjones1@inf.ed.ac.uk sc_clock(const char *name, double period_v, sc_time_unit period_tu, 587506Stjones1@inf.ed.ac.uk double duty_cycle, double start_time_v, 597720Sgblack@eecs.umich.edu sc_time_unit start_time_tu, bool posedge_first=true); 607506Stjones1@inf.ed.ac.uk 617506Stjones1@inf.ed.ac.uk // Deprecated. 628787Sgblack@eecs.umich.edu sc_clock(const char *name, double period, double duty_cycle=0.5, 638787Sgblack@eecs.umich.edu double start_time=0.0, bool posedge_first=true); 648787Sgblack@eecs.umich.edu 658787Sgblack@eecs.umich.edu virtual ~sc_clock(); 668787Sgblack@eecs.umich.edu 678787Sgblack@eecs.umich.edu virtual void write(const bool &); 688787Sgblack@eecs.umich.edu 697693SAli.Saidi@ARM.com const sc_time &period() const; 707693SAli.Saidi@ARM.com double duty_cycle() const; 717693SAli.Saidi@ARM.com const sc_time &start_time() const; 727693SAli.Saidi@ARM.com bool posedge_first() const; 737693SAli.Saidi@ARM.com 747693SAli.Saidi@ARM.com virtual const char *kind() const; 758791Sgblack@eecs.umich.edu 768791Sgblack@eecs.umich.edu protected: 778791Sgblack@eecs.umich.edu virtual void before_end_of_elaboration(); 788791Sgblack@eecs.umich.edu 798791Sgblack@eecs.umich.edu private: 808791Sgblack@eecs.umich.edu // Disabled 817693SAli.Saidi@ARM.com sc_clock(const sc_clock &) : sc_interface(), sc_signal<bool>() {} 827811Ssteve.reinhardt@amd.com 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