sc_fifo_ifs.h revision 12027
112027Sjungma@eit.uni-kl.de/***************************************************************************** 212027Sjungma@eit.uni-kl.de 312027Sjungma@eit.uni-kl.de Licensed to Accellera Systems Initiative Inc. (Accellera) under one or 412027Sjungma@eit.uni-kl.de more contributor license agreements. See the NOTICE file distributed 512027Sjungma@eit.uni-kl.de with this work for additional information regarding copyright ownership. 612027Sjungma@eit.uni-kl.de Accellera licenses this file to you under the Apache License, Version 2.0 712027Sjungma@eit.uni-kl.de (the "License"); you may not use this file except in compliance with the 812027Sjungma@eit.uni-kl.de License. You may obtain a copy of the License at 912027Sjungma@eit.uni-kl.de 1012027Sjungma@eit.uni-kl.de http://www.apache.org/licenses/LICENSE-2.0 1112027Sjungma@eit.uni-kl.de 1212027Sjungma@eit.uni-kl.de Unless required by applicable law or agreed to in writing, software 1312027Sjungma@eit.uni-kl.de distributed under the License is distributed on an "AS IS" BASIS, 1412027Sjungma@eit.uni-kl.de WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 1512027Sjungma@eit.uni-kl.de implied. See the License for the specific language governing 1612027Sjungma@eit.uni-kl.de permissions and limitations under the License. 1712027Sjungma@eit.uni-kl.de 1812027Sjungma@eit.uni-kl.de *****************************************************************************/ 1912027Sjungma@eit.uni-kl.de 2012027Sjungma@eit.uni-kl.de/***************************************************************************** 2112027Sjungma@eit.uni-kl.de 2212027Sjungma@eit.uni-kl.de sc_fifo_ifs.h -- The sc_fifo<T> interface classes. 2312027Sjungma@eit.uni-kl.de 2412027Sjungma@eit.uni-kl.de Original Author: Martin Janssen, Synopsys, Inc., 2001-05-21 2512027Sjungma@eit.uni-kl.de 2612027Sjungma@eit.uni-kl.de CHANGE LOG IS AT THE END OF THE FILE 2712027Sjungma@eit.uni-kl.de *****************************************************************************/ 2812027Sjungma@eit.uni-kl.de 2912027Sjungma@eit.uni-kl.de#ifndef SC_FIFO_IFS_H 3012027Sjungma@eit.uni-kl.de#define SC_FIFO_IFS_H 3112027Sjungma@eit.uni-kl.de 3212027Sjungma@eit.uni-kl.de 3312027Sjungma@eit.uni-kl.de#include "sysc/communication/sc_interface.h" 3412027Sjungma@eit.uni-kl.de 3512027Sjungma@eit.uni-kl.denamespace sc_core { 3612027Sjungma@eit.uni-kl.de 3712027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 3812027Sjungma@eit.uni-kl.de// CLASS : sc_fifo_nonblocking_in_if<T> 3912027Sjungma@eit.uni-kl.de// 4012027Sjungma@eit.uni-kl.de// The sc_fifo<T> input nonblocking interface class. 4112027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 4212027Sjungma@eit.uni-kl.de 4312027Sjungma@eit.uni-kl.detemplate <class T> 4412027Sjungma@eit.uni-kl.declass sc_fifo_nonblocking_in_if 4512027Sjungma@eit.uni-kl.de: virtual public sc_interface 4612027Sjungma@eit.uni-kl.de{ 4712027Sjungma@eit.uni-kl.depublic: 4812027Sjungma@eit.uni-kl.de 4912027Sjungma@eit.uni-kl.de // non-blocking read 5012027Sjungma@eit.uni-kl.de virtual bool nb_read( T& ) = 0; 5112027Sjungma@eit.uni-kl.de 5212027Sjungma@eit.uni-kl.de // get the data written event 5312027Sjungma@eit.uni-kl.de virtual const sc_event& data_written_event() const = 0; 5412027Sjungma@eit.uni-kl.de}; 5512027Sjungma@eit.uni-kl.de 5612027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 5712027Sjungma@eit.uni-kl.de// CLASS : sc_fifo_blocking_in_if<T> 5812027Sjungma@eit.uni-kl.de// 5912027Sjungma@eit.uni-kl.de// The sc_fifo<T> input blocking interface class. 6012027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 6112027Sjungma@eit.uni-kl.de 6212027Sjungma@eit.uni-kl.detemplate <class T> 6312027Sjungma@eit.uni-kl.declass sc_fifo_blocking_in_if 6412027Sjungma@eit.uni-kl.de: virtual public sc_interface 6512027Sjungma@eit.uni-kl.de{ 6612027Sjungma@eit.uni-kl.depublic: 6712027Sjungma@eit.uni-kl.de 6812027Sjungma@eit.uni-kl.de // blocking read 6912027Sjungma@eit.uni-kl.de virtual void read( T& ) = 0; 7012027Sjungma@eit.uni-kl.de virtual T read() = 0; 7112027Sjungma@eit.uni-kl.de}; 7212027Sjungma@eit.uni-kl.de 7312027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 7412027Sjungma@eit.uni-kl.de// CLASS : sc_fifo_in_if<T> 7512027Sjungma@eit.uni-kl.de// 7612027Sjungma@eit.uni-kl.de// The sc_fifo<T> input interface class. 7712027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 7812027Sjungma@eit.uni-kl.de 7912027Sjungma@eit.uni-kl.detemplate <class T> 8012027Sjungma@eit.uni-kl.declass sc_fifo_in_if 8112027Sjungma@eit.uni-kl.de: public sc_fifo_nonblocking_in_if<T>, 8212027Sjungma@eit.uni-kl.de public sc_fifo_blocking_in_if<T> 8312027Sjungma@eit.uni-kl.de{ 8412027Sjungma@eit.uni-kl.depublic: 8512027Sjungma@eit.uni-kl.de 8612027Sjungma@eit.uni-kl.de // get the number of available samples 8712027Sjungma@eit.uni-kl.de virtual int num_available() const = 0; 8812027Sjungma@eit.uni-kl.de 8912027Sjungma@eit.uni-kl.deprotected: 9012027Sjungma@eit.uni-kl.de 9112027Sjungma@eit.uni-kl.de // constructor 9212027Sjungma@eit.uni-kl.de 9312027Sjungma@eit.uni-kl.de sc_fifo_in_if() 9412027Sjungma@eit.uni-kl.de {} 9512027Sjungma@eit.uni-kl.de 9612027Sjungma@eit.uni-kl.deprivate: 9712027Sjungma@eit.uni-kl.de 9812027Sjungma@eit.uni-kl.de // disabled 9912027Sjungma@eit.uni-kl.de sc_fifo_in_if( const sc_fifo_in_if<T>& ); 10012027Sjungma@eit.uni-kl.de sc_fifo_in_if<T>& operator = ( const sc_fifo_in_if<T>& ); 10112027Sjungma@eit.uni-kl.de}; 10212027Sjungma@eit.uni-kl.de 10312027Sjungma@eit.uni-kl.de 10412027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 10512027Sjungma@eit.uni-kl.de// CLASS : sc_fifo_nonblocking_out_if<T> 10612027Sjungma@eit.uni-kl.de// 10712027Sjungma@eit.uni-kl.de// The sc_fifo<T> nonblocking output interface class. 10812027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 10912027Sjungma@eit.uni-kl.de 11012027Sjungma@eit.uni-kl.detemplate <class T> 11112027Sjungma@eit.uni-kl.declass sc_fifo_nonblocking_out_if 11212027Sjungma@eit.uni-kl.de: virtual public sc_interface 11312027Sjungma@eit.uni-kl.de{ 11412027Sjungma@eit.uni-kl.depublic: 11512027Sjungma@eit.uni-kl.de 11612027Sjungma@eit.uni-kl.de // non-blocking write 11712027Sjungma@eit.uni-kl.de virtual bool nb_write( const T& ) = 0; 11812027Sjungma@eit.uni-kl.de 11912027Sjungma@eit.uni-kl.de // get the data read event 12012027Sjungma@eit.uni-kl.de virtual const sc_event& data_read_event() const = 0; 12112027Sjungma@eit.uni-kl.de}; 12212027Sjungma@eit.uni-kl.de 12312027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 12412027Sjungma@eit.uni-kl.de// CLASS : sc_fifo_blocking_out_if<T> 12512027Sjungma@eit.uni-kl.de// 12612027Sjungma@eit.uni-kl.de// The sc_fifo<T> blocking output interface class. 12712027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 12812027Sjungma@eit.uni-kl.de 12912027Sjungma@eit.uni-kl.detemplate <class T> 13012027Sjungma@eit.uni-kl.declass sc_fifo_blocking_out_if 13112027Sjungma@eit.uni-kl.de: virtual public sc_interface 13212027Sjungma@eit.uni-kl.de{ 13312027Sjungma@eit.uni-kl.depublic: 13412027Sjungma@eit.uni-kl.de 13512027Sjungma@eit.uni-kl.de // blocking write 13612027Sjungma@eit.uni-kl.de virtual void write( const T& ) = 0; 13712027Sjungma@eit.uni-kl.de 13812027Sjungma@eit.uni-kl.de}; 13912027Sjungma@eit.uni-kl.de 14012027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 14112027Sjungma@eit.uni-kl.de// CLASS : sc_fifo_out_if<T> 14212027Sjungma@eit.uni-kl.de// 14312027Sjungma@eit.uni-kl.de// The sc_fifo<T> output interface class. 14412027Sjungma@eit.uni-kl.de// ---------------------------------------------------------------------------- 14512027Sjungma@eit.uni-kl.de 14612027Sjungma@eit.uni-kl.detemplate <class T> 14712027Sjungma@eit.uni-kl.declass sc_fifo_out_if 14812027Sjungma@eit.uni-kl.de: public sc_fifo_nonblocking_out_if<T>, 14912027Sjungma@eit.uni-kl.de public sc_fifo_blocking_out_if<T> 15012027Sjungma@eit.uni-kl.de{ 15112027Sjungma@eit.uni-kl.depublic: 15212027Sjungma@eit.uni-kl.de 15312027Sjungma@eit.uni-kl.de // get the number of free spaces 15412027Sjungma@eit.uni-kl.de virtual int num_free() const = 0; 15512027Sjungma@eit.uni-kl.de 15612027Sjungma@eit.uni-kl.deprotected: 15712027Sjungma@eit.uni-kl.de 15812027Sjungma@eit.uni-kl.de // constructor 15912027Sjungma@eit.uni-kl.de 16012027Sjungma@eit.uni-kl.de sc_fifo_out_if() 16112027Sjungma@eit.uni-kl.de {} 16212027Sjungma@eit.uni-kl.de 16312027Sjungma@eit.uni-kl.deprivate: 16412027Sjungma@eit.uni-kl.de 16512027Sjungma@eit.uni-kl.de // disabled 16612027Sjungma@eit.uni-kl.de sc_fifo_out_if( const sc_fifo_out_if<T>& ); 16712027Sjungma@eit.uni-kl.de sc_fifo_out_if<T>& operator = ( const sc_fifo_out_if<T>& ); 16812027Sjungma@eit.uni-kl.de}; 16912027Sjungma@eit.uni-kl.de 17012027Sjungma@eit.uni-kl.de/***************************************************************************** 17112027Sjungma@eit.uni-kl.de 17212027Sjungma@eit.uni-kl.de MODIFICATION LOG - modifiers, enter your name, affiliation, date and 17312027Sjungma@eit.uni-kl.de changes you are making here. 17412027Sjungma@eit.uni-kl.de 17512027Sjungma@eit.uni-kl.de Name, Affiliation, Date: Bishnupriya Bhattacharye, Cadence Design Systems, 17612027Sjungma@eit.uni-kl.de 30 Jan, 2004 17712027Sjungma@eit.uni-kl.de Description of Modification: Split up the interfaces into blocking and 17812027Sjungma@eit.uni-kl.de non blocking parts 17912027Sjungma@eit.uni-kl.de 18012027Sjungma@eit.uni-kl.de Name, Affiliation, Date: 18112027Sjungma@eit.uni-kl.de Description of Modification: 18212027Sjungma@eit.uni-kl.de 18312027Sjungma@eit.uni-kl.de *****************************************************************************/ 18412027Sjungma@eit.uni-kl.de//$Log: sc_fifo_ifs.h,v $ 18512027Sjungma@eit.uni-kl.de//Revision 1.3 2011/08/26 20:45:40 acg 18612027Sjungma@eit.uni-kl.de// Andy Goodrich: moved the modification log to the end of the file to 18712027Sjungma@eit.uni-kl.de// eliminate source line number skew when check-ins are done. 18812027Sjungma@eit.uni-kl.de// 18912027Sjungma@eit.uni-kl.de//Revision 1.2 2011/02/18 20:23:45 acg 19012027Sjungma@eit.uni-kl.de// Andy Goodrich: Copyright update. 19112027Sjungma@eit.uni-kl.de// 19212027Sjungma@eit.uni-kl.de//Revision 1.1.1.1 2006/12/15 20:20:04 acg 19312027Sjungma@eit.uni-kl.de//SystemC 2.3 19412027Sjungma@eit.uni-kl.de// 19512027Sjungma@eit.uni-kl.de//Revision 1.2 2006/01/03 23:18:26 acg 19612027Sjungma@eit.uni-kl.de//Changed copyright to include 2006. 19712027Sjungma@eit.uni-kl.de// 19812027Sjungma@eit.uni-kl.de//Revision 1.1.1.1 2005/12/19 23:16:43 acg 19912027Sjungma@eit.uni-kl.de//First check in of SystemC 2.1 into its own archive. 20012027Sjungma@eit.uni-kl.de// 20112027Sjungma@eit.uni-kl.de//Revision 1.10 2005/06/10 22:43:55 acg 20212027Sjungma@eit.uni-kl.de//Added CVS change log annotation. 20312027Sjungma@eit.uni-kl.de// 20412027Sjungma@eit.uni-kl.de 20512027Sjungma@eit.uni-kl.de} // namespace sc_core 20612027Sjungma@eit.uni-kl.de 20712027Sjungma@eit.uni-kl.de#endif 20812027Sjungma@eit.uni-kl.de 20912027Sjungma@eit.uni-kl.de// Taf! 210