sc_fifo.hh revision 12853
112841Sgabeblack@google.com/* 212841Sgabeblack@google.com * Copyright 2018 Google, Inc. 312841Sgabeblack@google.com * 412841Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 512841Sgabeblack@google.com * modification, are permitted provided that the following conditions are 612841Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 712841Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 812841Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 912841Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1012841Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1112841Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1212841Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1312841Sgabeblack@google.com * this software without specific prior written permission. 1412841Sgabeblack@google.com * 1512841Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1612841Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1712841Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1812841Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 1912841Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2012841Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2112841Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2212841Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2312841Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2412841Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2512841Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2612841Sgabeblack@google.com * 2712841Sgabeblack@google.com * Authors: Gabe Black 2812841Sgabeblack@google.com */ 2912841Sgabeblack@google.com 3012841Sgabeblack@google.com#ifndef __SYSTEMC_EXT_CHANNEL_SC_FIFO_HH__ 3112841Sgabeblack@google.com#define __SYSTEMC_EXT_CHANNEL_SC_FIFO_HH__ 3212841Sgabeblack@google.com 3312841Sgabeblack@google.com#include "../core/sc_module.hh" // for sc_gen_unique_name 3412841Sgabeblack@google.com#include "../core/sc_prim.hh" 3512841Sgabeblack@google.com#include "sc_fifo_in_if.hh" 3612841Sgabeblack@google.com#include "sc_fifo_out_if.hh" 3712841Sgabeblack@google.com#include "warn_unimpl.hh" 3812841Sgabeblack@google.com 3912841Sgabeblack@google.comnamespace sc_core 4012841Sgabeblack@google.com{ 4112841Sgabeblack@google.com 4212841Sgabeblack@google.comclass sc_port_base; 4312841Sgabeblack@google.comclass sc_event; 4412841Sgabeblack@google.com 4512841Sgabeblack@google.comtemplate <class T> 4612841Sgabeblack@google.comclass sc_fifo : public sc_fifo_in_if<T>, 4712841Sgabeblack@google.com public sc_fifo_out_if<T>, 4812841Sgabeblack@google.com public sc_prim_channel 4912841Sgabeblack@google.com{ 5012841Sgabeblack@google.com public: 5112841Sgabeblack@google.com explicit sc_fifo(int size=16) : 5212841Sgabeblack@google.com sc_fifo_in_if<T>(), sc_fifo_out_if<T>(), 5312841Sgabeblack@google.com sc_prim_channel(sc_gen_unique_name("fifo")) 5412841Sgabeblack@google.com {} 5512841Sgabeblack@google.com explicit sc_fifo(const char *name, int size=16) : 5612841Sgabeblack@google.com sc_fifo_in_if<T>(), sc_fifo_out_if<T>(), 5712841Sgabeblack@google.com sc_prim_channel(name) 5812841Sgabeblack@google.com {} 5912841Sgabeblack@google.com virtual ~sc_fifo() {} 6012841Sgabeblack@google.com 6112841Sgabeblack@google.com virtual void 6212841Sgabeblack@google.com register_port(sc_port_base &, const char *) 6312841Sgabeblack@google.com { 6412841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 6512841Sgabeblack@google.com } 6612841Sgabeblack@google.com 6712841Sgabeblack@google.com virtual void 6812841Sgabeblack@google.com read(T &) 6912841Sgabeblack@google.com { 7012841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 7112841Sgabeblack@google.com } 7212841Sgabeblack@google.com virtual T 7312841Sgabeblack@google.com read() 7412841Sgabeblack@google.com { 7512841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 7612841Sgabeblack@google.com return *(T *)nullptr; 7712841Sgabeblack@google.com } 7812841Sgabeblack@google.com virtual bool 7912841Sgabeblack@google.com nb_read(T &) 8012841Sgabeblack@google.com { 8112841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 8212841Sgabeblack@google.com return false; 8312841Sgabeblack@google.com } 8412841Sgabeblack@google.com operator T() 8512841Sgabeblack@google.com { 8612841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 8712841Sgabeblack@google.com return *(T *)nullptr; 8812841Sgabeblack@google.com } 8912841Sgabeblack@google.com 9012841Sgabeblack@google.com virtual void 9112841Sgabeblack@google.com write(const T &) 9212841Sgabeblack@google.com { 9312841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 9412841Sgabeblack@google.com } 9512841Sgabeblack@google.com virtual bool 9612841Sgabeblack@google.com nb_write(const T&) 9712841Sgabeblack@google.com { 9812841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 9912841Sgabeblack@google.com return false; 10012841Sgabeblack@google.com } 10112841Sgabeblack@google.com sc_fifo<T> & 10212841Sgabeblack@google.com operator = (const T &) 10312841Sgabeblack@google.com { 10412841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 10512841Sgabeblack@google.com return *this; 10612841Sgabeblack@google.com } 10712841Sgabeblack@google.com 10812841Sgabeblack@google.com virtual const sc_event & 10912853Sgabeblack@google.com data_written_event() const 11012841Sgabeblack@google.com { 11112841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 11212841Sgabeblack@google.com return *(const sc_event *)nullptr; 11312841Sgabeblack@google.com } 11412841Sgabeblack@google.com virtual const sc_event & 11512841Sgabeblack@google.com data_read_event() const 11612841Sgabeblack@google.com { 11712841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 11812841Sgabeblack@google.com return *(const sc_event *)nullptr; 11912841Sgabeblack@google.com } 12012841Sgabeblack@google.com 12112841Sgabeblack@google.com virtual int 12212841Sgabeblack@google.com num_available() const 12312841Sgabeblack@google.com { 12412841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 12512841Sgabeblack@google.com return 0; 12612841Sgabeblack@google.com } 12712841Sgabeblack@google.com virtual int 12812841Sgabeblack@google.com num_free() const 12912841Sgabeblack@google.com { 13012841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 13112841Sgabeblack@google.com return 0; 13212841Sgabeblack@google.com } 13312841Sgabeblack@google.com 13412841Sgabeblack@google.com virtual void 13512841Sgabeblack@google.com print(std::ostream & =std::cout) const 13612841Sgabeblack@google.com { 13712841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 13812841Sgabeblack@google.com } 13912841Sgabeblack@google.com virtual void 14012841Sgabeblack@google.com dump(std::ostream & =std::cout) const 14112841Sgabeblack@google.com { 14212841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 14312841Sgabeblack@google.com } 14412841Sgabeblack@google.com virtual const char *kind() const { return "sc_fifo"; } 14512841Sgabeblack@google.com 14612841Sgabeblack@google.com protected: 14712841Sgabeblack@google.com virtual void 14812841Sgabeblack@google.com update() 14912841Sgabeblack@google.com { 15012841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 15112841Sgabeblack@google.com } 15212841Sgabeblack@google.com 15312841Sgabeblack@google.com private: 15412841Sgabeblack@google.com // Disabled 15512841Sgabeblack@google.com sc_fifo(const sc_fifo<T> &) : 15612841Sgabeblack@google.com sc_fifo_in_if<T>(), sc_fifo_in_if<T>(), sc_prim_channel() 15712841Sgabeblack@google.com {} 15812841Sgabeblack@google.com sc_fifo &operator = (const sc_fifo<T> &) { return *this; } 15912841Sgabeblack@google.com}; 16012841Sgabeblack@google.com 16112841Sgabeblack@google.comtemplate <class T> 16212841Sgabeblack@google.cominline std::ostream & 16312841Sgabeblack@google.comoperator << (std::ostream &os, const sc_fifo<T> &) 16412841Sgabeblack@google.com{ 16512841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 16612841Sgabeblack@google.com return os; 16712841Sgabeblack@google.com} 16812841Sgabeblack@google.com 16912841Sgabeblack@google.com} // namespace sc_core 17012841Sgabeblack@google.com 17112841Sgabeblack@google.com#endif //__SYSTEMC_EXT_CHANNEL_SC_FIFO_HH__ 172