tlm_recorder_module.h

/*******************************************************************************
 * Copyright 2016, 2025 MINRES Technologies GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/
 
#ifndef TLM_NW_SCV_TLM_RECORDER_MODULE_H
#define TLM_NW_SCV_TLM_RECORDER_MODULE_H
#include "tlm/nw/tlm_network_sockets.h"
#include "tlm_recorder.h"
#include <tlm_utils/simple_initiator_socket.h>
#include <tlm_utils/simple_target_socket.h>

namespace tlm {
namespace nw {
namespace scv {
template <typename CMDENUM, unsigned int FLIT_WITH, typename TYPES> class tlm_recorder_module : public sc_core::sc_module {
public:
    SC_HAS_PROCESS(tlm_recorder_module); // NOLINT
    tlm::nw::tlm_network_target_socket<FLIT_WITH, CMDENUM, TYPES> ts{"ts"};
    tlm::nw::tlm_network_initiator_socket<FLIT_WITH, CMDENUM, TYPES> is{"is"};
    tlm_recorder_module(sc_core::sc_module_name name, bool recording_enabled = true,
                        SCVNS scv_tr_db* tr_db = SCVNS scv_tr_db::get_default_db())
    : sc_module(name)
    , recorder(sc_core::sc_object::name(), is.get_base_port(), ts.get_base_port(), recording_enabled, tr_db) {
        // bind the sockets to the module
        is.bind(recorder);
        ts.bind(recorder);
    }
 
    virtual ~tlm_recorder_module() {}
 
    tlm_recorder<TYPES> recorder;
 
private:
    void start_of_simulation() override { recorder.initialize_streams(); }
};
} // namespace scv
} // namespace nw
} // namespace tlm
 
#endif /* TLM_NW_SCV_TLM_RECORDER_MODULE_H */