sc_fifo.hh revision 13123
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 3313123Sgabeblack@google.com#include <list> 3413123Sgabeblack@google.com 3512841Sgabeblack@google.com#include "../core/sc_module.hh" // for sc_gen_unique_name 3612841Sgabeblack@google.com#include "../core/sc_prim.hh" 3712841Sgabeblack@google.com#include "sc_fifo_in_if.hh" 3812841Sgabeblack@google.com#include "sc_fifo_out_if.hh" 3912841Sgabeblack@google.com#include "warn_unimpl.hh" 4012841Sgabeblack@google.com 4112841Sgabeblack@google.comnamespace sc_core 4212841Sgabeblack@google.com{ 4312841Sgabeblack@google.com 4412841Sgabeblack@google.comclass sc_port_base; 4512841Sgabeblack@google.comclass sc_event; 4612841Sgabeblack@google.com 4712841Sgabeblack@google.comtemplate <class T> 4812841Sgabeblack@google.comclass sc_fifo : public sc_fifo_in_if<T>, 4912841Sgabeblack@google.com public sc_fifo_out_if<T>, 5012841Sgabeblack@google.com public sc_prim_channel 5112841Sgabeblack@google.com{ 5212841Sgabeblack@google.com public: 5312841Sgabeblack@google.com explicit sc_fifo(int size=16) : 5412841Sgabeblack@google.com sc_fifo_in_if<T>(), sc_fifo_out_if<T>(), 5513123Sgabeblack@google.com sc_prim_channel(sc_gen_unique_name("fifo")), 5613123Sgabeblack@google.com _size(size), _readsHappened(false) 5712841Sgabeblack@google.com {} 5812841Sgabeblack@google.com explicit sc_fifo(const char *name, int size=16) : 5912841Sgabeblack@google.com sc_fifo_in_if<T>(), sc_fifo_out_if<T>(), 6013123Sgabeblack@google.com sc_prim_channel(name), _size(size), _readsHappened(false) 6112841Sgabeblack@google.com {} 6212841Sgabeblack@google.com virtual ~sc_fifo() {} 6312841Sgabeblack@google.com 6412841Sgabeblack@google.com virtual void 6512841Sgabeblack@google.com register_port(sc_port_base &, const char *) 6612841Sgabeblack@google.com { 6712841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 6812841Sgabeblack@google.com } 6912841Sgabeblack@google.com 7012841Sgabeblack@google.com virtual void 7113123Sgabeblack@google.com read(T &t) 7212841Sgabeblack@google.com { 7313123Sgabeblack@google.com while (num_available() == 0) 7413123Sgabeblack@google.com sc_core::wait(_dataWriteEvent); 7513123Sgabeblack@google.com _readsHappened = true; 7613123Sgabeblack@google.com t = _entries.front(); 7713123Sgabeblack@google.com _entries.pop_front(); 7813123Sgabeblack@google.com request_update(); 7912841Sgabeblack@google.com } 8012841Sgabeblack@google.com virtual T 8112841Sgabeblack@google.com read() 8212841Sgabeblack@google.com { 8313123Sgabeblack@google.com T t; 8413123Sgabeblack@google.com read(t); 8513123Sgabeblack@google.com return t; 8612841Sgabeblack@google.com } 8712841Sgabeblack@google.com virtual bool 8813123Sgabeblack@google.com nb_read(T &t) 8912841Sgabeblack@google.com { 9013123Sgabeblack@google.com if (num_available()) { 9113123Sgabeblack@google.com read(t); 9213123Sgabeblack@google.com return true; 9313123Sgabeblack@google.com } else { 9413123Sgabeblack@google.com return false; 9513123Sgabeblack@google.com } 9612841Sgabeblack@google.com } 9713123Sgabeblack@google.com operator T() { return read(); } 9812841Sgabeblack@google.com 9912841Sgabeblack@google.com virtual void 10013123Sgabeblack@google.com write(const T &t) 10112841Sgabeblack@google.com { 10213123Sgabeblack@google.com while (num_free() == 0) 10313123Sgabeblack@google.com sc_core::wait(_dataReadEvent); 10413123Sgabeblack@google.com _pending.emplace_back(t); 10513123Sgabeblack@google.com request_update(); 10612841Sgabeblack@google.com } 10712841Sgabeblack@google.com virtual bool 10813123Sgabeblack@google.com nb_write(const T &t) 10912841Sgabeblack@google.com { 11013123Sgabeblack@google.com if (num_free()) { 11113123Sgabeblack@google.com write(t); 11213123Sgabeblack@google.com return true; 11313123Sgabeblack@google.com } else { 11413123Sgabeblack@google.com return false; 11513123Sgabeblack@google.com } 11612841Sgabeblack@google.com } 11712841Sgabeblack@google.com sc_fifo<T> & 11813123Sgabeblack@google.com operator = (const T &t) 11912841Sgabeblack@google.com { 12013123Sgabeblack@google.com write(t); 12112841Sgabeblack@google.com return *this; 12212841Sgabeblack@google.com } 12312841Sgabeblack@google.com 12412841Sgabeblack@google.com virtual const sc_event & 12512853Sgabeblack@google.com data_written_event() const 12612841Sgabeblack@google.com { 12713123Sgabeblack@google.com return _dataWriteEvent; 12812841Sgabeblack@google.com } 12912841Sgabeblack@google.com virtual const sc_event & 13012841Sgabeblack@google.com data_read_event() const 13112841Sgabeblack@google.com { 13213123Sgabeblack@google.com return _dataReadEvent; 13312841Sgabeblack@google.com } 13412841Sgabeblack@google.com 13513123Sgabeblack@google.com virtual int num_available() const { return _entries.size(); } 13612841Sgabeblack@google.com virtual int 13712841Sgabeblack@google.com num_free() const 13812841Sgabeblack@google.com { 13913123Sgabeblack@google.com return _size - _entries.size() - _pending.size(); 14012841Sgabeblack@google.com } 14112841Sgabeblack@google.com 14212841Sgabeblack@google.com virtual void 14313123Sgabeblack@google.com print(std::ostream &os=std::cout) const 14412841Sgabeblack@google.com { 14513123Sgabeblack@google.com for (typename ::std::list<T>::iterator pos = _entries.begin(); 14613123Sgabeblack@google.com pos != _entries.end(); pos++) { 14713123Sgabeblack@google.com os << *pos << ::std::endl; 14813123Sgabeblack@google.com } 14912841Sgabeblack@google.com } 15012841Sgabeblack@google.com virtual void 15112841Sgabeblack@google.com dump(std::ostream & =std::cout) const 15212841Sgabeblack@google.com { 15312841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 15412841Sgabeblack@google.com } 15512841Sgabeblack@google.com virtual const char *kind() const { return "sc_fifo"; } 15612841Sgabeblack@google.com 15712841Sgabeblack@google.com protected: 15812841Sgabeblack@google.com virtual void 15912841Sgabeblack@google.com update() 16012841Sgabeblack@google.com { 16113123Sgabeblack@google.com if (!_pending.empty()) { 16213123Sgabeblack@google.com _dataWriteEvent.notify(SC_ZERO_TIME); 16313123Sgabeblack@google.com _entries.insert(_entries.end(), _pending.begin(), _pending.end()); 16413123Sgabeblack@google.com _pending.clear(); 16513123Sgabeblack@google.com } 16613123Sgabeblack@google.com if (_readsHappened) { 16713123Sgabeblack@google.com _readsHappened = false; 16813123Sgabeblack@google.com _dataReadEvent.notify(SC_ZERO_TIME); 16913123Sgabeblack@google.com } 17012841Sgabeblack@google.com } 17112841Sgabeblack@google.com 17212841Sgabeblack@google.com private: 17312841Sgabeblack@google.com // Disabled 17412841Sgabeblack@google.com sc_fifo(const sc_fifo<T> &) : 17512841Sgabeblack@google.com sc_fifo_in_if<T>(), sc_fifo_in_if<T>(), sc_prim_channel() 17612841Sgabeblack@google.com {} 17712841Sgabeblack@google.com sc_fifo &operator = (const sc_fifo<T> &) { return *this; } 17813123Sgabeblack@google.com 17913123Sgabeblack@google.com sc_event _dataReadEvent; 18013123Sgabeblack@google.com sc_event _dataWriteEvent; 18113123Sgabeblack@google.com 18213123Sgabeblack@google.com int _size; 18313123Sgabeblack@google.com mutable std::list<T> _entries; 18413123Sgabeblack@google.com mutable std::list<T> _pending; 18513123Sgabeblack@google.com bool _readsHappened; 18612841Sgabeblack@google.com}; 18712841Sgabeblack@google.com 18812841Sgabeblack@google.comtemplate <class T> 18912841Sgabeblack@google.cominline std::ostream & 19012841Sgabeblack@google.comoperator << (std::ostream &os, const sc_fifo<T> &) 19112841Sgabeblack@google.com{ 19212841Sgabeblack@google.com sc_channel_warn_unimpl(__PRETTY_FUNCTION__); 19312841Sgabeblack@google.com return os; 19412841Sgabeblack@google.com} 19512841Sgabeblack@google.com 19612841Sgabeblack@google.com} // namespace sc_core 19712841Sgabeblack@google.com 19812841Sgabeblack@google.com#endif //__SYSTEMC_EXT_CHANNEL_SC_FIFO_HH__ 199