sc_buffer.hh revision 13277 
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_CHANNEL_SC_BUFFER_HH__
31#define __SYSTEMC_EXT_CHANNEL_SC_BUFFER_HH__
32
33#include "../core/sc_module.hh" // for sc_gen_unique_name
34#include "sc_signal.hh"
35
36namespace sc_core
37{
38
39// Having a default value for the WRITER_POLICY parameter is non-standard, but
40// matches the Accellera implementation to enable the regression tests.
41template <class T, sc_writer_policy WRITER_POLICY=SC_ONE_WRITER>
42class sc_buffer : public sc_signal<T, WRITER_POLICY>
43{
44  public:
45    sc_buffer() : sc_signal<T, WRITER_POLICY>(sc_gen_unique_name("buffer")) {}
46    explicit sc_buffer(const char *name) :
47            sc_signal<T, WRITER_POLICY>(sc_gen_unique_name(name))
48    {}
49
50    virtual void
51    write(const T &t)
52    {
53#       if !defined(SC_NO_WRITE_CHECK)
54        {
55            this->_checker.checkWriter();
56        }
57#       endif
58        this->m_new_val = t;
59        this->request_update();
60    }
61
62    sc_buffer<T, WRITER_POLICY> &
63    operator = (const T &arg)
64    {
65        write(arg);
66        return *this;
67    }
68    sc_buffer<T, WRITER_POLICY> &
69    operator = (const sc_signal<T, WRITER_POLICY> &arg)
70    {
71        write(arg.read());
72        return *this;
73    }
74    sc_buffer<T, WRITER_POLICY> &
75    operator = (const sc_buffer<T, WRITER_POLICY> &arg)
76    {
77        write(arg.read());
78        return *this;
79    }
80
81    virtual const char *kind() const { return "sc_buffer"; }
82
83  protected:
84    virtual void
85    update()
86    {
87        this->m_cur_val = this->m_new_val;
88        this->_signalChange();
89    }
90
91  private:
92    // Disabled
93    sc_buffer(const sc_buffer<T, WRITER_POLICY> &) {}
94};
95
96} // namespace sc_core
97
98#endif  //__SYSTEMC_EXT_CHANNEL_SC_BUFFER_HH__
99