sim_sleep.h

Go to the documentation of this file.

/*
 * sim_sleep.h
 *
 *  Copyright 2021 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_SLEEP_H__
#define __YASIMAVR_SLEEP_H__
 
#include "sim_peripheral.h"
#include "sim_signal.h"
#include "sim_types.h"
 
YASIMAVR_BEGIN_NAMESPACE
 
//=======================================================================================
/*
 * CTLREQ definitions
*/
 
//AVR_CTLREQ_SLEEP_CALL (defined in sim_peripheral.h) :
//Request sent by the CPU when executing a SLEEP instruction.
//No data is required
 
//AVR_CTLREQ_SLEEP_PSEUDO (defined in sim_peripheral.h) :
//Request sent by the CPU when executing a infinite loop (RJMP .-2) with GIE flag set
//No data is required
 
enum class SleepMode {
    Invalid,
    Active,
    Pseudo,
    Idle,
    ADC,
    Standby,
    ExtStandby,
    PowerDown,
    PowerSave,
};
 
const char* SleepModeName(SleepMode mode) AVR_CORE_PUBLIC_API;
 
 
//=======================================================================================
 
struct SleepConfig {
 
    struct mode_config_t : base_reg_config_t {
        SleepMode mode;
        uint8_t int_mask[16];
    };
 
    std::vector<mode_config_t> modes;
    regbit_t rb_mode;
    regbit_t rb_enable;
};
 
 
class AVR_CORE_PUBLIC_API SleepController : public Peripheral, public SignalHook {
 
public:
 
    explicit SleepController(const SleepConfig& config);
 
    virtual bool init(Device& device) override;
    virtual bool ctlreq(ctlreq_id_t req, ctlreq_data_t* data) override;
    virtual void raised(const signal_data_t& sigdata, int hooktag) override;
 
private:
 
    const SleepConfig& m_config;
    //Index of the current sleep mode in the configuration mode map
    unsigned int m_mode_index;
 
};
 
 
YASIMAVR_END_NAMESPACE
 
#endif //__YASIMAVR_SLEEP_H__