attiny_x4.h

Go to the documentation of this file.

//   Copyright 2016-2023 Jean-Francois Poilpret
//
//   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 BOARDS_ATTINYX4_HH
#define BOARDS_ATTINYX4_HH
 
#include "io.h"
#include "../bits.h"
#include "../defines.h"
#include <avr/sleep.h>
 
/* This board is based on ATtinyX4/ATtiny */
#define BOARDS_ATTINYX4
#define BOARD_ATTINY
 
namespace board
{
    inline static void init() {}
    
    enum class Port: uint8_t
    {
        PORT_A = 0,
        PORT_B,
        // FastArduino internal: DO NOT USE
        NONE = UINT8_MAX
    };
 
    enum class DigitalPin: uint8_t
    {
        D0_PA0 = 0,
        D1_PA1,
        D2_PA2,
        D3_PA3,
        D4_PA4,
        D5_PA5,
        D6_PA6,
        D7_PA7,
        D8_PB0,
        D9_PB1,
        D10_PB2,
        LED = D7_PA7,
        // FastArduino internal: DO NOT USE
        NONE = UINT8_MAX
    };
 
    enum class AnalogClock: uint8_t
    {
        MAX_FREQ_50KHz = 0,
        MAX_FREQ_100KHz,
        MAX_FREQ_200KHz,
        MAX_FREQ_500KHz,
        MAX_FREQ_1MHz
    };
    
    enum class AnalogReference: uint8_t
    {
        AREF = 0,
        AVCC,
        INTERNAL_1_1V
    };
    
    enum class AnalogPin: uint8_t
    {
        A0 = 0,
        A1,
        A2,
        A3,
        A4,
        A5,
        A6,
        A7,
        TEMP,
        BANDGAP,
        // FastArduino internal: DO NOT USE
        NONE = UINT8_MAX
    };
    
    enum class PWMPin : uint8_t
    {
        D10_PB2_OC0A = 0,
        D7_PA7_OC0B,
        D6_PA6_OC1A,
        D5_PA5_OC1B,
        // FastArduino internal: DO NOT USE
        NONE = UINT8_MAX
    };
    
    enum class ExternalInterruptPin : uint8_t
    {
        D10_PB2_EXT0 = 0
    };
 
    enum class InterruptPin : uint8_t
    {
        D0_PA0_PCI0 = uint8_t(DigitalPin::D0_PA0),
        D1_PA1_PCI0 = uint8_t(DigitalPin::D1_PA1),
        D2_PA2_PCI0 = uint8_t(DigitalPin::D2_PA2),
        D3_PA3_PCI0 = uint8_t(DigitalPin::D3_PA3),
        D4_PA4_PCI0 = uint8_t(DigitalPin::D4_PA4),
        D5_PA5_PCI0 = uint8_t(DigitalPin::D5_PA5),
        D6_PA6_PCI0 = uint8_t(DigitalPin::D6_PA6),
        D7_PA7_PCI0 = uint8_t(DigitalPin::D7_PA7),
        
        D8_PB0_PCI1 = uint8_t(DigitalPin::D8_PB0),
        D9_PB1_PCI1 = uint8_t(DigitalPin::D9_PB1),
        D10_PB2_PCI1 = uint8_t(DigitalPin::D10_PB2)
    };
 
    enum class USART: uint8_t
    {
    };
    
    // IMPORTANT: on my setup, Timer runs faster than expected (9.5s for 10s)
    //TODO check how we can calibrate clock?
    enum class Timer: uint8_t
    {
        TIMER0 = 0,
        TIMER1 = 1
    };
 
    #define SLEEP_MODE_PWR_SAVE     (bits::BV8(SM0, SM1))
    
    enum class SleepMode: uint8_t
    {
        IDLE = SLEEP_MODE_IDLE,
        ADC_NOISE_REDUCTION = SLEEP_MODE_ADC,
        POWER_DOWN = SLEEP_MODE_PWR_DOWN,
        POWER_SAVE = SLEEP_MODE_PWR_SAVE,
        STANDBY = SLEEP_MODE_PWR_SAVE,
        EXTENDED_STANDBY = SLEEP_MODE_PWR_SAVE
    };
};
 
#define ANALOG_COMP_vect ANA_COMP_vect
#define TIMER0_OVF_vect TIM0_OVF_vect
#define TIMER0_COMPA_vect TIM0_COMPA_vect
#define TIMER0_COMPB_vect TIM0_COMPB_vect
#define TIMER1_OVF_vect TIM1_OVF_vect
#define TIMER1_COMPA_vect TIM1_COMPA_vect
#define TIMER1_COMPB_vect TIM1_COMPB_vect
#define EE_READY_vect EE_RDY_vect
 
// Forward declare interrupt service routines to allow them as friends.
extern "C" {
    void ADC_vect(void) SIGNAL_HANDLER;
    void ANALOG_COMP_vect(void) SIGNAL_HANDLER;
    void INT0_vect(void) SIGNAL_HANDLER;
    void PCINT0_vect(void) SIGNAL_HANDLER;
    void PCINT1_vect(void) SIGNAL_HANDLER;
    void TIMER0_COMPA_vect(void) SIGNAL_HANDLER;
    void TIMER0_COMPB_vect(void) SIGNAL_HANDLER;
    void TIMER0_OVF_vect(void) SIGNAL_HANDLER;
    void TIMER1_COMPA_vect(void) SIGNAL_HANDLER;
    void TIMER1_COMPB_vect(void) SIGNAL_HANDLER;
    void TIMER1_OVF_vect(void) SIGNAL_HANDLER;
    void TIMER1_CAPT_vect(void)  SIGNAL_HANDLER;
    void WDT_vect(void) SIGNAL_HANDLER;
    void USI_START_vect(void) SIGNAL_HANDLER;
    void USI_OVF_vect(void) SIGNAL_HANDLER;
    void EE_READY_vect(void) SIGNAL_HANDLER;
}
 
#endif /* BOARDS_ATTINYX4_HH */