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_buffer.h -- The sc_buffer<T> primitive channel class.
2312027Sjungma@eit.uni-kl.de                 Like sc_signal<T>, but *every* write causes an event.
2412027Sjungma@eit.uni-kl.de
2512027Sjungma@eit.uni-kl.de  Original Author: Martin Janssen, Synopsys, Inc., 2001-05-21
2612027Sjungma@eit.uni-kl.de
2712027Sjungma@eit.uni-kl.de  CHANGE LOG IS AT THE END OF THE FILE
2812027Sjungma@eit.uni-kl.de *****************************************************************************/
2912027Sjungma@eit.uni-kl.de
3012027Sjungma@eit.uni-kl.de#ifndef SC_BUFFER_H
3112027Sjungma@eit.uni-kl.de#define SC_BUFFER_H
3212027Sjungma@eit.uni-kl.de
3312027Sjungma@eit.uni-kl.de
3412027Sjungma@eit.uni-kl.de#include "sysc/communication/sc_signal.h"
3512027Sjungma@eit.uni-kl.de
3612027Sjungma@eit.uni-kl.denamespace sc_core {
3712027Sjungma@eit.uni-kl.de
3812027Sjungma@eit.uni-kl.de// ----------------------------------------------------------------------------
3912027Sjungma@eit.uni-kl.de//  CLASS : sc_buffer<T>
4012027Sjungma@eit.uni-kl.de//
4112027Sjungma@eit.uni-kl.de//  The sc_buffer<T> primitive channel class.
4212027Sjungma@eit.uni-kl.de// ----------------------------------------------------------------------------
4312027Sjungma@eit.uni-kl.de
4412027Sjungma@eit.uni-kl.detemplate< typename T, sc_writer_policy POL = SC_DEFAULT_WRITER_POLICY >
4512027Sjungma@eit.uni-kl.declass sc_buffer
4612027Sjungma@eit.uni-kl.de: public sc_signal<T,POL>
4712027Sjungma@eit.uni-kl.de{
4812027Sjungma@eit.uni-kl.depublic:
4912027Sjungma@eit.uni-kl.de
5012027Sjungma@eit.uni-kl.de    // typedefs
5112027Sjungma@eit.uni-kl.de
5212027Sjungma@eit.uni-kl.de    typedef sc_buffer<T,POL> this_type;
5312027Sjungma@eit.uni-kl.de    typedef sc_signal<T,POL> base_type;
5412027Sjungma@eit.uni-kl.de
5512027Sjungma@eit.uni-kl.depublic:
5612027Sjungma@eit.uni-kl.de
5712027Sjungma@eit.uni-kl.de    // constructors
5812027Sjungma@eit.uni-kl.de
5912027Sjungma@eit.uni-kl.de    sc_buffer()
6012027Sjungma@eit.uni-kl.de	: base_type( sc_gen_unique_name( "buffer" ) )
6112027Sjungma@eit.uni-kl.de	{}
6212027Sjungma@eit.uni-kl.de
6312027Sjungma@eit.uni-kl.de    explicit sc_buffer( const char* name_ )
6412027Sjungma@eit.uni-kl.de	: base_type( name_ )
6512027Sjungma@eit.uni-kl.de	{}
6612027Sjungma@eit.uni-kl.de
6712027Sjungma@eit.uni-kl.de    sc_buffer( const char* name_, const T& initial_value_ )
6812027Sjungma@eit.uni-kl.de      : base_type( name_, initial_value_ )
6912027Sjungma@eit.uni-kl.de    {}
7012027Sjungma@eit.uni-kl.de
7112027Sjungma@eit.uni-kl.de    // interface methods
7212027Sjungma@eit.uni-kl.de
7312027Sjungma@eit.uni-kl.de    // write the new value
7412027Sjungma@eit.uni-kl.de    virtual void write( const T& );
7512027Sjungma@eit.uni-kl.de
7612027Sjungma@eit.uni-kl.de
7712027Sjungma@eit.uni-kl.de    // other methods
7812027Sjungma@eit.uni-kl.de
7912027Sjungma@eit.uni-kl.de    this_type& operator = ( const T& a )
8012027Sjungma@eit.uni-kl.de	{ write( a ); return *this; }
8112027Sjungma@eit.uni-kl.de
8212027Sjungma@eit.uni-kl.de    this_type& operator = ( const sc_signal_in_if<T>& a )
8312027Sjungma@eit.uni-kl.de	{ write( a.read() ); return *this; }
8412027Sjungma@eit.uni-kl.de
8512027Sjungma@eit.uni-kl.de    this_type& operator = ( const this_type& a )
8612027Sjungma@eit.uni-kl.de	{ write( a.read() ); return *this; }
8712027Sjungma@eit.uni-kl.de
8812027Sjungma@eit.uni-kl.de    virtual const char* kind() const
8912027Sjungma@eit.uni-kl.de        { return "sc_buffer"; }
9012027Sjungma@eit.uni-kl.de
9112027Sjungma@eit.uni-kl.deprotected:
9212027Sjungma@eit.uni-kl.de
9312027Sjungma@eit.uni-kl.de    virtual void update();
9412027Sjungma@eit.uni-kl.de
9512027Sjungma@eit.uni-kl.deprivate:
9612027Sjungma@eit.uni-kl.de
9712027Sjungma@eit.uni-kl.de    // disabled
9812027Sjungma@eit.uni-kl.de    sc_buffer( const this_type& );
9912027Sjungma@eit.uni-kl.de};
10012027Sjungma@eit.uni-kl.de
10112027Sjungma@eit.uni-kl.de
10212027Sjungma@eit.uni-kl.de// IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII
10312027Sjungma@eit.uni-kl.de
10412027Sjungma@eit.uni-kl.de// write the new value
10512027Sjungma@eit.uni-kl.de
10612027Sjungma@eit.uni-kl.detemplate< typename T, sc_writer_policy POL >
10712027Sjungma@eit.uni-kl.deinline
10812027Sjungma@eit.uni-kl.devoid
10912027Sjungma@eit.uni-kl.desc_buffer<T,POL>::write( const T& value_ )
11012027Sjungma@eit.uni-kl.de{
11112027Sjungma@eit.uni-kl.de    if( !base_type::policy_type::check_write(this,true) )
11212027Sjungma@eit.uni-kl.de      return;
11312027Sjungma@eit.uni-kl.de
11412027Sjungma@eit.uni-kl.de    this->m_new_val = value_;
11512027Sjungma@eit.uni-kl.de    this->request_update();
11612027Sjungma@eit.uni-kl.de}
11712027Sjungma@eit.uni-kl.de
11812027Sjungma@eit.uni-kl.de
11912027Sjungma@eit.uni-kl.detemplate< typename T, sc_writer_policy POL >
12012027Sjungma@eit.uni-kl.deinline
12112027Sjungma@eit.uni-kl.devoid
12212027Sjungma@eit.uni-kl.desc_buffer<T,POL>::update()
12312027Sjungma@eit.uni-kl.de{
12412027Sjungma@eit.uni-kl.de    base_type::policy_type::update();
12512027Sjungma@eit.uni-kl.de    base_type::do_update();
12612027Sjungma@eit.uni-kl.de}
12712027Sjungma@eit.uni-kl.de
12812027Sjungma@eit.uni-kl.de} // namespace sc_core
12912027Sjungma@eit.uni-kl.de
13012027Sjungma@eit.uni-kl.de#endif
13112027Sjungma@eit.uni-kl.de
13212027Sjungma@eit.uni-kl.de//$Log: sc_buffer.h,v $
13312027Sjungma@eit.uni-kl.de//Revision 1.7  2011/08/26 20:45:39  acg
13412027Sjungma@eit.uni-kl.de// Andy Goodrich: moved the modification log to the end of the file to
13512027Sjungma@eit.uni-kl.de// eliminate source line number skew when check-ins are done.
13612027Sjungma@eit.uni-kl.de//
13712027Sjungma@eit.uni-kl.de//Revision 1.6  2011/04/08 18:22:45  acg
13812027Sjungma@eit.uni-kl.de// Philipp A. Hartmann: use the context of the primitive channel to get
13912027Sjungma@eit.uni-kl.de// the change stamp value.
14012027Sjungma@eit.uni-kl.de//
14112027Sjungma@eit.uni-kl.de//Revision 1.5  2011/04/05 20:48:09  acg
14212027Sjungma@eit.uni-kl.de// Andy Goodrich: changes to make sure that event(), posedge() and negedge()
14312027Sjungma@eit.uni-kl.de// only return true if the clock has not moved.
14412027Sjungma@eit.uni-kl.de//
14512027Sjungma@eit.uni-kl.de//Revision 1.4  2011/04/05 06:15:18  acg
14612027Sjungma@eit.uni-kl.de// Philipp A. Hartmann: sc_writer_policy: ignore no-ops in delta check.
14712027Sjungma@eit.uni-kl.de//
14812027Sjungma@eit.uni-kl.de//Revision 1.3  2011/02/18 20:23:45  acg
14912027Sjungma@eit.uni-kl.de// Andy Goodrich: Copyright update.
15012027Sjungma@eit.uni-kl.de//
15112027Sjungma@eit.uni-kl.de//Revision 1.2  2010/12/07 19:50:36  acg
15212027Sjungma@eit.uni-kl.de// Andy Goodrich: addition of writer policies, courtesy of Philipp Hartmann.
15312027Sjungma@eit.uni-kl.de//
15412027Sjungma@eit.uni-kl.de//Revision 1.1.1.1  2006/12/15 20:20:04  acg
15512027Sjungma@eit.uni-kl.de//SystemC 2.3
15612027Sjungma@eit.uni-kl.de//
15712027Sjungma@eit.uni-kl.de//Revision 1.8  2006/03/13 20:19:43  acg
15812027Sjungma@eit.uni-kl.de// Andy Goodrich: changed sc_event instances into pointers to sc_event instances
15912027Sjungma@eit.uni-kl.de// that are allocated as needed. This saves considerable storage for large
16012027Sjungma@eit.uni-kl.de// numbers of signals, etc.
16112027Sjungma@eit.uni-kl.de//
16212027Sjungma@eit.uni-kl.de//Revision 1.7  2006/01/26 21:00:49  acg
16312027Sjungma@eit.uni-kl.de// Andy Goodrich: conversion to use sc_event::notify(SC_ZERO_TIME) instead of
16412027Sjungma@eit.uni-kl.de// sc_event::notify_delayed()
16512027Sjungma@eit.uni-kl.de//
16612027Sjungma@eit.uni-kl.de//Revision 1.6  2006/01/24 20:46:31  acg
16712027Sjungma@eit.uni-kl.de//Andy Goodrich: changes to eliminate use of deprecated features. For instance,
16812027Sjungma@eit.uni-kl.de//using notify(SC_ZERO_TIME) in place of notify_delayed().
16912027Sjungma@eit.uni-kl.de//
17012027Sjungma@eit.uni-kl.de//Revision 1.5  2006/01/19 19:18:25  acg
17112027Sjungma@eit.uni-kl.de//Andy Goodrich: eliminated check_writer in favor of inline code within the
17212027Sjungma@eit.uni-kl.de//write() method since we always execute the check_writer code even when
17312027Sjungma@eit.uni-kl.de//check writing is turned off.
17412027Sjungma@eit.uni-kl.de//
17512027Sjungma@eit.uni-kl.de//Revision 1.4  2006/01/19 00:30:57  acg
17612027Sjungma@eit.uni-kl.de//Andy Goodrich: Yet another implementation for disabling write checks on
17712027Sjungma@eit.uni-kl.de//signals. This version uses an environment variable, SC_SIGNAL_WRITE_CHECK,
17812027Sjungma@eit.uni-kl.de//that when set to DISABLE will turn off write checking.
17912027Sjungma@eit.uni-kl.de//
18012027Sjungma@eit.uni-kl.de//Revision 1.3  2006/01/13 18:47:20  acg
18112027Sjungma@eit.uni-kl.de//Reversed sense of multiwriter signal check. It now defaults to ON unless the
18212027Sjungma@eit.uni-kl.de//user defines SC_NO_WRITE_CHEK before inclusion of the file.
18312027Sjungma@eit.uni-kl.de//
18412027Sjungma@eit.uni-kl.de//Revision 1.2  2006/01/03 23:18:26  acg
18512027Sjungma@eit.uni-kl.de//Changed copyright to include 2006.
18612027Sjungma@eit.uni-kl.de//
18712027Sjungma@eit.uni-kl.de//Revision 1.1.1.1  2005/12/19 23:16:43  acg
18812027Sjungma@eit.uni-kl.de//First check in of SystemC 2.1 into its own archive.
18912027Sjungma@eit.uni-kl.de//
19012027Sjungma@eit.uni-kl.de//Revision 1.9  2005/06/10 22:43:55  acg
19112027Sjungma@eit.uni-kl.de//Added CVS change log annotation.
19212027Sjungma@eit.uni-kl.de//
19312027Sjungma@eit.uni-kl.de
19412027Sjungma@eit.uni-kl.de// Taf!
195