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