qk_extendedif.h

/*
 * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All Rights Reserved.
 * Author: GreenSocs 2022
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
 
#ifndef QK_EXTENDEDIF_H
#define QK_EXTENDEDIF_H
 
#ifndef SC_INCLUDE_DYNAMIC_PROCESSES
#define SC_INCLUDE_DYNAMIC_PROCESSES
#endif
 
#include <systemc>
#include <tlm>
#include <tlm_utils/tlm_quantumkeeper.h>
 
#include <scp/report.h>
 
#include <libgsutils.h>
 
namespace gs {
 
/* this quantumkeeper is inteded as an interface for other more
 * sophisticated QKs. However if provides a trivial implementation making it
 * identicle to a standard tlm-2.0 QK
 */
namespace SyncPolicy {
enum Type { SYSTEMC_THREAD, OS_THREAD };
}
 
class tlm_quantumkeeper_extended : public tlm_utils::tlm_quantumkeeper, public sc_core::sc_object
{
public:
    tlm_quantumkeeper_extended(): sc_object("qk") {}
 
    /*
     * Additional functions
     */
 
    // based on standard tlm2 QK.
    virtual sc_core::sc_time time_to_sync()
    {
        if (m_next_sync_point > (m_local_time + sc_core::sc_time_stamp()))
            return m_next_sync_point - (m_local_time + sc_core::sc_time_stamp());
        else
            return sc_core::SC_ZERO_TIME;
    }
 
    // stop trying to syncronise
    virtual void stop() {}
 
    // start trying to syncronise, (and start job for convenience)
    virtual void start(std::function<void()> job = nullptr)
    {
        if (job) sc_core::sc_spawn(job);
    }
 
    virtual SyncPolicy::Type get_thread_type() const { return SyncPolicy::SYSTEMC_THREAD; }
 
    // non-const need_sync as some sync policies need a non-const version
    virtual bool need_sync() { return tlm_utils::tlm_quantumkeeper::need_sync(); }
 
    virtual bool need_sync() const override
    {
        SCP_INFO("Libgssync") << "const need_sync called, probably wanted to call non-const version";
        return tlm_utils::tlm_quantumkeeper::need_sync();
    }
 
    // NB, the following function is only for the convenience of
    // the 'old' sync policys. This can/should be removed.
    virtual void run_on_systemc(std::function<void()> job) { job(); }
};
} // namespace gs
 
#endif // QK_EXTENDEDIF_H