arch_avr_timer.h

Go to the documentation of this file.

/*
 * arch_avr_timer.h
 *
 *  Copyright 2021-2026 Clement Savergne <csavergne@yahoo.com>
 
    This file is part of yasim-avr.
 
    yasim-avr is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    yasim-avr is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with yasim-avr.  If not, see <http://www.gnu.org/licenses/>.
 */
 
//=======================================================================================
 
#ifndef __YASIMAVR_AVR_TIMER_H__
#define __YASIMAVR_AVR_TIMER_H__
 
#include "arch_avr_globals.h"
#include "core/sim_peripheral.h"
#include "core/sim_interrupt.h"
#include "ioctrl_common/sim_timer.h"
 
YASIMAVR_BEGIN_NAMESPACE
 
 
//=======================================================================================
 
#define AVR_CTLREQ_TMR_GET_EXTCLK_HOOK        (AVR_CTLREQ_BASE + 1)
 
#define AVR_CTLREQ_TMR_GET_CAPT_HOOK          (AVR_CTLREQ_BASE + 2)
 
 
 
struct ArchAVR_TimerConfig {
 
    enum COM {
        COM_NoChange = 0,
        COM_Toggle,
        COM_Clear,
        COM_Set,
        COM_ToggleA,
    };
 
    enum Top {
        Top_OnMax = 0,
        Top_OnFixed,
        Top_OnCompA,
        Top_OnIC,
    };
 
    enum OCR {
        OCR_Unbuffered = 0,
        OCR_UpdateOnTop,
        OCR_UpdateOnBottom,
    };
 
    enum OVF {
        OVF_SetOnMax = 0,
        OVF_SetOnTop,
        OVF_SetOnBottom,
    };
 
    struct clock_config_t : base_reg_config_t {
        TimerCounter::TickSource source;
        unsigned long div;
    };
 
    struct vector_config_t {
        int_vect_t num;
        unsigned char bit;
    };
 
    struct OC_config_t : base_reg_config_t {
        reg_addr_t reg_oc;
        vector_config_t vector;
        regbit_t rb_mode;
        regbit_t rb_force;
    };
 
    struct COM_config_t : base_reg_config_t {
        COM up : 4;
        COM down : 4;
        COM bottom : 4;
        COM top : 4;
    };
 
    struct mode_config_t : base_reg_config_t {
        OVF ovf : 2;
        Top top : 2;
        unsigned int fixed_top_exp : 4;
        OCR ocr : 2;
        bool double_slope : 1;
        bool disable_foc: 1;
        unsigned int com_variant : 4;
    };
 
    typedef std::vector<COM_config_t> COM_variant_t;
 
    bool is_16bits;
 
    std::vector<clock_config_t> clocks;
    std::vector<mode_config_t> modes;
 
    std::vector<COM_variant_t> com_modes;
 
    std::vector<OC_config_t> oc_channels;
 
    regbit_t rb_clock;
    regbit_compound_t rbc_mode;
    reg_addr_t reg_cnt;
    reg_addr_t reg_icr;
    reg_addr_t reg_int_enable;
    reg_addr_t reg_int_flag;
    vector_config_t vect_ovf;
    vector_config_t vect_icr;
 
};
 
 
class AVR_ARCHAVR_PUBLIC_API ArchAVR_Timer : public Peripheral {
 
public:
 
    enum SignalId {
        Signal_OVF,
        Signal_CompMatch,
        Signal_CompOutput,
        Signal_Capt
    };
 
    ArchAVR_Timer(int num, const ArchAVR_TimerConfig& config);
    ~ArchAVR_Timer();
 
    virtual bool init(Device& device) override;
    virtual void reset(int flags) override;
    virtual bool ctlreq(ctlreq_id_t req, ctlreq_data_t* data) override;
    virtual uint8_t ioreg_read_handler(reg_addr_t addr, uint8_t value) override;
    virtual uint8_t ioreg_peek_handler(reg_addr_t addr, uint8_t value) override;
    virtual void ioreg_write_handler(reg_addr_t addr, const ioreg_write_t& data) override;
 
private:
 
    struct OutputCompareChannel;
    friend struct OutputCompareChannel;
 
    const ArchAVR_TimerConfig& m_config;
 
    //***** Clock management *****
    unsigned long m_clk_ps_max;              //Max value counted by the clock prescaler
    //Input Capture Register value
    uint16_t m_icr;
    //Temporary register when the CPU is reading 16-bits registers
    uint8_t m_temp;
    //Current timer/counter mode
    ArchAVR_TimerConfig::mode_config_t m_mode;
    //List of output compare modules
    std::vector<OutputCompareChannel*> m_oc_channels;
    //Timer counter engine
    TimerCounter m_counter;
    BoundFunctionSignalHook<ArchAVR_Timer> m_cnt_hook;
    //Interrupt and signal management
    InterruptFlag m_intflag_ovf;
    InterruptFlag m_intflag_icr;
    DataSignal m_signal;
    BoundFunctionSignalHook<ArchAVR_Timer> m_capt_hook;
 
    void cnt_raised(const signal_data_t& sigdata, int hooktag);
    void update_top();
    void capt_raised(const signal_data_t& sigdata, int hooktag);
    ArchAVR_TimerConfig::COM_config_t get_COM_config(uint8_t regval);
    void change_OC_state(size_t index, int event_flags);
    bool output_active(ArchAVR_TimerConfig::COM_config_t& mode, size_t output_index);
 
};
 
 
YASIMAVR_END_NAMESPACE
 
#endif //__YASIMAVR_AVR_TIMER_H__