xref: /gem5/src/systemc/ext/channel/sc_inout.hh

/*
 * Copyright 2018 Google, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Gabe Black
 */

#ifndef __SYSTEMC_EXT_CHANNEL_SC_INOUT_HH__
#define __SYSTEMC_EXT_CHANNEL_SC_INOUT_HH__

#include <string>

#include "../core/sc_port.hh"
#include "sc_signal_inout_if.hh"
#include "warn_unimpl.hh"

namespace sc_dt
{

class sc_logic;

} // namespace sc_dt

namespace sc_core
{

class sc_event;
class sc_event_finder;
class sc_trace_file;

template <class T>
class sc_inout : public sc_port<sc_signal_inout_if<T>, 1>
{
  public:
    sc_inout() : sc_port<sc_signal_inout_if<T>, 1>() {}
    explicit sc_inout(const char *name) :
            sc_port<sc_signal_inout_if<T>, 1>(name)
    {}
    virtual ~sc_inout() {}

    // Deprecated binding constructors.
    explicit sc_inout(const sc_signal_inout_if<T> &interface) :
        sc_port<sc_signal_inout_if<T>, 1>(interface)
    {}
    sc_inout(const char *name, const sc_signal_inout_if<T> &interface) :
        sc_port<sc_signal_inout_if<T>, 1>(name, interface)
    {}
    explicit sc_inout(sc_port_b<sc_signal_inout_if<T> > &parent) :
        sc_port<sc_signal_inout_if<T>, 1>(parent)
    {}
    sc_inout(const char *name, sc_port_b<sc_signal_inout_if<T> > &parent) :
        sc_port<sc_signal_inout_if<T>, 1>(name, parent)
    {}
    explicit sc_inout(sc_port<sc_signal_inout_if<T>, 1> &parent) :
        sc_port<sc_signal_inout_if<T>, 1>(parent)
    {}
    sc_inout(const char *name, sc_port<sc_signal_inout_if<T>, 1> &parent) :
        sc_port<sc_signal_inout_if<T>, 1>(name, parent)
    {}

    void
    initialize(const T &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    void
    initialize(const sc_signal_in_if<T> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

    virtual void end_of_elaboration() {}

    const T &
    read() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const T *)nullptr;
    }
    operator const T& () const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const T *)nullptr;
    }

    void
    write(const T &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    sc_inout<T> &
    operator = (const T &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<T> *)nullptr;
    }
    sc_inout<T> &
    operator = (const sc_signal_in_if<T> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<T> *)nullptr;
    }
    sc_inout<T> &
    operator = (const sc_port<sc_signal_in_if<T>, 1> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<T> *)nullptr;
    }
    sc_inout<T> &
    operator = (const sc_port<sc_signal_inout_if<T>, 1> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<T> *)nullptr;
    }
    sc_inout<T> &
    operator = (const sc_inout<T> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<T> *)nullptr;
    }

    const sc_event &
    default_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    const sc_event &
    value_changed_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    bool
    event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }
    sc_event_finder &
    value_changed() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event_finder *)nullptr;
    }

    virtual const char *kind() const { return "sc_inout"; }

  private:
    // Disabled
    sc_inout(const sc_inout<T> &) : sc_port<sc_signal_inout_if<T>, 1>() {}
};

template <class T>
inline void
sc_trace(sc_trace_file *, const sc_inout<T> &, const std::string &)
{
    sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
}

template <>
class sc_inout<bool> : public sc_port<sc_signal_inout_if<bool>, 1>
{
  public:
    sc_inout() : sc_port<sc_signal_inout_if<bool>, 1>() {}
    explicit sc_inout(const char *name) :
            sc_port<sc_signal_inout_if<bool>, 1>(name)
    {}
    virtual ~sc_inout() {}

    // Deprecated binding constructors.
    explicit sc_inout(const sc_signal_inout_if<bool> &interface) :
        sc_port<sc_signal_inout_if<bool>, 1>(interface)
    {}
    sc_inout(const char *name, const sc_signal_inout_if<bool> &interface) :
        sc_port<sc_signal_inout_if<bool>, 1>(name, interface)
    {}
    explicit sc_inout(sc_port_b<sc_signal_inout_if<bool> > &parent) :
        sc_port<sc_signal_inout_if<bool>, 1>(parent)
    {}
    sc_inout(const char *name, sc_port_b<sc_signal_inout_if<bool> > &parent) :
        sc_port<sc_signal_inout_if<bool>, 1>(name, parent)
    {}
    explicit sc_inout(sc_port<sc_signal_inout_if<bool>, 1> &parent) :
        sc_port<sc_signal_inout_if<bool>, 1>(parent)
    {}
    sc_inout(const char *name, sc_port<sc_signal_inout_if<bool>, 1> &parent) :
        sc_port<sc_signal_inout_if<bool>, 1>(name, parent)
    {}

    void
    initialize(const bool &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    void
    initialize(const sc_signal_in_if<bool> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

    virtual void end_of_elaboration() {}

    const bool &
    read() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(bool *)nullptr;
    }
    operator const bool& () const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(bool *)nullptr;
    }

    void
    write(const bool &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    sc_inout<bool> &
    operator = (const bool &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<bool> *)nullptr;
    }
    sc_inout<bool> &
    operator = (const sc_signal_in_if<bool> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<bool> *)nullptr;
    }
    sc_inout<bool> &
    operator = (const sc_port<sc_signal_in_if<bool>, 1> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<bool> *)nullptr;
    }
    sc_inout<bool> &
    operator = (const sc_port<sc_signal_inout_if<bool>, 1> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<bool> *)nullptr;
    }
    sc_inout<bool> &
    operator = (const sc_inout<bool> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<bool> *)nullptr;
    }

    const sc_event &
    default_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    const sc_event &
    value_changed_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    const sc_event &
    posedge_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    const sc_event &
    negedge_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }

    bool
    event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }
    bool
    posedge() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }
    bool
    negedge() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }

    sc_event_finder &
    value_changed() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event_finder *)nullptr;
    }
    sc_event_finder &
    pos() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event_finder *)nullptr;
    }
    sc_event_finder &
    neg() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event_finder *)nullptr;
    }

    virtual const char *kind() const { return "sc_inout"; }

  private:
    // Disabled
    sc_inout(const sc_inout<bool> &) :
            sc_port<sc_signal_inout_if<bool>, 1>() {}
};

template <>
inline void sc_trace<bool>(
        sc_trace_file *, const sc_inout<bool> &, const std::string &)
{
    sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
}

template <>
class sc_inout<sc_dt::sc_logic> :
        public sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>
{
  public:
    sc_inout() : sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>() {}
    explicit sc_inout(const char *name) :
            sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>(name)
    {}
    virtual ~sc_inout() {}

    // Deprecated binding constructors.
    explicit sc_inout(const sc_signal_inout_if<sc_dt::sc_logic> &interface) :
        sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>(interface)
    {}
    sc_inout(const char *name,
            const sc_signal_inout_if<sc_dt::sc_logic> &interface) :
        sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>(name, interface)
    {}
    explicit sc_inout(
            sc_port_b<sc_signal_inout_if<sc_dt::sc_logic> > &parent) :
        sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>(parent)
    {}
    sc_inout(const char *name,
            sc_port_b<sc_signal_inout_if<sc_dt::sc_logic> > &parent) :
        sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>(name, parent)
    {}
    explicit sc_inout(
            sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1> &parent) :
        sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>(parent)
    {}
    sc_inout(const char *name,
            sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1> &parent) :
        sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>(name, parent)
    {}

    void
    initialize(const sc_dt::sc_logic &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    void
    initialize(const sc_signal_in_if<sc_dt::sc_logic> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }

    virtual void end_of_elaboration() {}

    const sc_dt::sc_logic &
    read() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const sc_dt::sc_logic *)nullptr;
    }
    operator const sc_dt::sc_logic& () const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(const sc_dt::sc_logic *)nullptr;
    }

    void
    write(const sc_dt::sc_logic &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
    }
    sc_inout<sc_dt::sc_logic> &
    operator = (const sc_dt::sc_logic &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<sc_dt::sc_logic> *)nullptr;
    }
    sc_inout<sc_dt::sc_logic> &
    operator = (const sc_signal_in_if<sc_dt::sc_logic> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<sc_dt::sc_logic> *)nullptr;
    }
    sc_inout<sc_dt::sc_logic> &
    operator = (const sc_port<sc_signal_in_if<sc_dt::sc_logic>, 1> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<sc_dt::sc_logic> *)nullptr;
    }
    sc_inout<sc_dt::sc_logic> &
    operator = (const sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<sc_dt::sc_logic> *)nullptr;
    }
    sc_inout<sc_dt::sc_logic> &
    operator = (const sc_inout<sc_dt::sc_logic> &)
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_inout<sc_dt::sc_logic> *)nullptr;
    }

    const sc_event &
    default_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    const sc_event &
    value_changed_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    const sc_event &
    posedge_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }
    const sc_event &
    negedge_event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event *)nullptr;
    }

    bool
    event() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }
    bool
    posedge() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }
    bool
    negedge() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return false;
    }

    sc_event_finder &
    value_changed() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event_finder *)nullptr;
    }
    sc_event_finder &
    pos() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event_finder *)nullptr;
    }
    sc_event_finder &
    neg() const
    {
        sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
        return *(sc_event_finder *)nullptr;
    }

    virtual const char *kind() const { return "sc_inout"; }

  private:
    // Disabled
    sc_inout(const sc_inout<sc_dt::sc_logic> &) :
            sc_port<sc_signal_inout_if<sc_dt::sc_logic>, 1>()
    {}
};

template <>
inline void
sc_trace<sc_dt::sc_logic>(sc_trace_file *, const sc_inout<sc_dt::sc_logic> &,
                          const std::string &)
{
    sc_channel_warn_unimpl(__PRETTY_FUNCTION__);
}

} // namespace sc_core

#endif  //__SYSTEMC_EXT_CHANNEL_SC_INOUT_HH__