arch_xt_twi.h

Go to the documentation of this file.

/*
 * arch_xt_twi.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_XT_TWI_H__
#define __YASIMAVR_XT_TWI_H__
 
#include "arch_xt_globals.h"
#include "core/sim_interrupt.h"
 
YASIMAVR_BEGIN_NAMESPACE
 
 
//=======================================================================================
 
struct ArchXT_TWIConfig {
 
    reg_addr_t reg_base;
    int_vect_t iv_host;
    int_vect_t iv_client;
    bool dual_ctrl;
 
};
 
class AVR_ARCHXT_PUBLIC_API ArchXT_TWI : public Peripheral {
 
public:
 
    ArchXT_TWI(uint8_t num, const ArchXT_TWIConfig& config);
    virtual ~ArchXT_TWI();
 
    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:
 
    class _Client;
    friend class _Client;
    class _Host;
    friend class _Host;
    class _PinDriver;
    friend class _PinDriver;
 
    const ArchXT_TWIConfig& m_config;
 
    _Client* m_client;
    _Host* m_host;
    _PinDriver* m_driver;
    BoundFunctionSignalHook<ArchXT_TWI> m_host_hook;
    BoundFunctionSignalHook<ArchXT_TWI> m_client_hook;
    bool m_pending_host_address;
    bool m_pending_host_rx_data;
    bool m_pending_client_rx_data;
    uint8_t m_host_cmd;
    uint8_t m_client_cmd;
 
    InterruptFlag m_intflag_host;
    InterruptFlag m_intflag_client;
 
    void reset_host();
    void clear_host_status();
    void clear_client_status();
    bool address_match(uint8_t addr_byte);
    void execute_host_command();
    void execute_client_command();
    void host_signal_raised(const signal_data_t& sigdata, int);
    void client_signal_raised(const signal_data_t& sigdata, int);
 
};
 
 
YASIMAVR_END_NAMESPACE
 
#endif //__YASIMAVR_XT_TWI_H__