initiator.h

/*******************************************************************************
 * Copyright 2019-2022 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 _BUS_AHB_PIN_INITIATOR_H_
#define _BUS_AHB_PIN_INITIATOR_H_
 
#include <tlm/scc/target_mixin.h>
#include <tlm>
#include <tlm_utils/peq_with_get.h>
#include <type_traits>
 
namespace ahb {
namespace pin {
 
template <unsigned WIDTH> class initiator : sc_core::sc_module {
    static constexpr bool is_larger(unsigned x) { return x > 64U; }
    using data_t = typename std::conditional<is_larger(WIDTH), sc_dt::sc_biguint<WIDTH>, sc_dt::sc_uint<WIDTH>>::type;
 
public:
    sc_core::sc_in<bool> HCLK_i{"HCLK_i"};
    sc_core::sc_in<bool> HRESETn_i{"HRESETn_i"};
    sc_core::sc_out<sc_dt::sc_uint<32>> HADDR_o{"HADDR_o"};
    sc_core::sc_out<sc_dt::sc_uint<3>> HBURST_o{"HBURST_o"};
    sc_core::sc_out<bool> HMASTLOCK_o{"HMASTLOCK_o"};
    sc_core::sc_out<sc_dt::sc_uint<4>> HPROT_o{"HPROT_o"};
    sc_core::sc_out<sc_dt::sc_uint<3>> HSIZE_o{"HSIZE_o"};
    sc_core::sc_out<sc_dt::sc_uint<2>> HTRANS_o{"HTRANS_o"};
    sc_core::sc_out<data_t> HWDATA_o{"HWDATA_o"};
    sc_core::sc_out<bool> HWRITE_o{"HWRITE_o"};
    sc_core::sc_in<data_t> HRDATA_i{"HRDATA_i"};
    sc_core::sc_in<bool> HREADY_i{"HREADY_i"};
    sc_core::sc_in<bool> HRESP_i{"HRESP_i"};
 
    tlm::scc::target_mixin<tlm::tlm_target_socket<WIDTH>> tsckt{"tsckt"};
 
    initiator(const sc_core::sc_module_name& nm);
    virtual ~initiator() = default;
 
private:
    struct data_phase_desc {
        tlm::tlm_generic_payload* gp;
        unsigned size;
        unsigned length;
    };
    void bus_addr_task();
    void bus_data_task();
 
    tlm_utils::peq_with_get<tlm::tlm_generic_payload> inqueue{"inqueue"};
    tlm_utils::peq_with_get<tlm::tlm_generic_payload> tx_in_flight{"tx_in_flight"};
};
 
} // namespace pin
} /* namespace ahb */
 
#endif /* _BUS_AHB_PIN_INITIATOR_H_ */