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