xref: /gem5/src/systemc/ext/channel/sc_signal_rv.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_SIGNAL_RV_HH__
#define __SYSTEMC_EXT_CHANNEL_SC_SIGNAL_RV_HH__

#include "../core/sc_module.hh" // for sc_gen_unique_name
#include "../dt/bit/sc_logic.hh"
#include "../dt/bit/sc_lv.hh"
#include "sc_signal.hh"

namespace sc_gem5
{

class Process;
Process *getCurrentProcess();

} // namespace sc_gem5

namespace sc_dt
{

template <int W>
class sc_lv;

};

namespace sc_core
{

class sc_port_base;

template <int W>
class sc_signal_rv : public sc_signal<sc_dt::sc_lv<W>, SC_MANY_WRITERS>
{
  public:
    sc_signal_rv() : sc_signal<sc_dt::sc_lv<W>, SC_MANY_WRITERS>(
            sc_gen_unique_name("signal_rv"))
    {}
    sc_signal_rv(const char *name) :
            sc_signal<sc_dt::sc_lv<W>, SC_MANY_WRITERS>(name)
    {}
    virtual ~sc_signal_rv() {}

    virtual void register_port(sc_port_base &, const char *) {}

    virtual void
    write(const sc_dt::sc_lv<W> &l)
    {
        ::sc_gem5::Process *p = ::sc_gem5::getCurrentProcess();

        auto it = inputs.find(p);
        if (it == inputs.end()) {
            inputs.emplace(p, l);
            this->request_update();
        } else if (it->second != l) {
            it->second = l;
            this->request_update();
        }
    }
    sc_signal_rv<W> &
    operator = (const sc_dt::sc_lv<W> &l)
    {
        write(l);
        return *this;
    }
    sc_signal_rv<W> &
    operator = (const sc_signal_rv<W> &r)
    {
        write(r.read());
        return *this;
    }

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

  protected:
    virtual void
    update()
    {
        using sc_dt::Log_0;
        using sc_dt::Log_1;
        using sc_dt::Log_Z;
        using sc_dt::Log_X;
        static sc_dt::sc_logic_value_t merge_table[4][4] = {
            { Log_0, Log_X, Log_0, Log_X },
            { Log_X, Log_1, Log_1, Log_X },
            { Log_0, Log_1, Log_Z, Log_X },
            { Log_X, Log_X, Log_X, Log_X }
        };

        // Resolve the inputs, and give the result to the underlying
        // signal class.
        for (int i = 0; i < W; i++) {
            sc_dt::sc_logic_value_t bit = Log_Z;
            for (auto &input: inputs)
                bit = merge_table[bit][input.second.get_bit(i)];
            this->m_new_val.set_bit(i, bit);
        }

        // Ask the signal to update it's value.
        sc_signal<sc_dt::sc_lv<W>, SC_MANY_WRITERS>::update();
    }

  private:
    // Disabled
    sc_signal_rv(const sc_signal_rv<W> &) :
            sc_signal<sc_dt::sc_lv<W>, SC_MANY_WRITERS>()
    {}

    std::map<::sc_gem5::Process *, sc_dt::sc_lv<W> > inputs;
};

} // namespace sc_core

#endif  //__SYSTEMC_EXT_CHANNEL_SC_SIGNAL_RV_HH__