sc_fifo_out.hh revision 13123 
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_FIFO_OUT_HH__
31#define __SYSTEMC_EXT_CHANNEL_SC_FIFO_OUT_HH__
32
33#include "../core/sc_port.hh"
34#include "sc_fifo_out_if.hh"
35#include "warn_unimpl.hh"
36
37namespace sc_core
38{
39
40class sc_event;
41class sc_event_finder;
42
43template <class T>
44class sc_fifo_out : public sc_port<sc_fifo_out_if<T>, 0>
45{
46  public:
47    sc_fifo_out() : sc_port<sc_fifo_out_if<T>, 0>(),
48        _dataReadFinder(*this, &sc_fifo_out_if<T>::data_read_event)
49    {}
50    explicit sc_fifo_out(const char *name) :
51            sc_port<sc_fifo_out_if<T>, 0>(name),
52        _dataReadFinder(*this, &sc_fifo_out_if<T>::data_read_event)
53    {}
54    virtual ~sc_fifo_out() {}
55
56    // Deprecated binding constructors.
57    explicit sc_fifo_out(const sc_fifo_out_if<T> &interface) :
58        sc_port<sc_fifo_out_if<T>, 0>(interface),
59        _dataReadFinder(*this, &sc_fifo_out_if<T>::data_read_event)
60    {}
61    sc_fifo_out(const char *name, const sc_fifo_out_if<T> &interface) :
62        sc_port<sc_fifo_out_if<T>, 0>(name, interface),
63        _dataReadFinder(*this, &sc_fifo_out_if<T>::data_read_event)
64    {}
65    explicit sc_fifo_out(sc_port_b<sc_fifo_out_if<T> > &parent) :
66        sc_port<sc_fifo_out_if<T>, 0>(parent),
67        _dataReadFinder(*this, &sc_fifo_out_if<T>::data_read_event)
68    {}
69    sc_fifo_out(const char *name, sc_port_b<sc_fifo_out_if<T> > &parent) :
70        sc_port<sc_fifo_out_if<T>, 0>(name, parent),
71        _dataReadFinder(*this, &sc_fifo_out_if<T>::data_read_event)
72    {}
73    explicit sc_fifo_out(sc_port<sc_fifo_out_if<T>, 0> &parent) :
74        sc_port<sc_fifo_out_if<T>, 0>(parent),
75        _dataReadFinder(*this, &sc_fifo_out_if<T>::data_read_event)
76    {}
77    sc_fifo_out(const char *name, sc_port<sc_fifo_out_if<T>, 0> &parent) :
78        sc_port<sc_fifo_out_if<T>, 0>(name, parent),
79        _dataReadFinder(*this, &sc_fifo_out_if<T>::data_read_event)
80    {}
81
82    void write(const T &t) { (*this)->write(t); }
83    bool nb_write(const T &t) { return (*this)->nb_write(t); }
84    const sc_event &
85    data_read_event() const
86    {
87        return (*this)->data_read_event();
88    }
89    sc_event_finder &data_read() const { return _dataReadFinder; }
90    int num_free() const { return (*this)->num_free(); }
91    virtual const char *kind() const { return "sc_fifo_out"; }
92
93  private:
94    // Disabled
95    sc_fifo_out(const sc_fifo_out<T> &) : sc_port<sc_fifo_out_if<T>, 0>() {}
96    sc_fifo_out<T> &operator = (const sc_fifo_out<T> &) { return *this; }
97
98    mutable sc_event_finder_t<sc_fifo_out_if<T> > _dataReadFinder;
99};
100
101} // namespace sc_core
102
103#endif  //__SYSTEMC_EXT_CHANNEL_SC_FIFO_OUT_HH__
104