atmega_xx4.h

//   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_ATMEGA_XX4_HH
#define BOARDS_ATMEGA_XX4_HH
 
#include "io.h"
#include "../defines.h"
#include <avr/sleep.h>
 
/* This board is based on ATmega644 or 1284 */
#define BOARDS_ATMEGAXX4
 
namespace board
{
    inline static void init() {}
    
    enum class Port: uint8_t
    {
        PORT_A = 0,
        PORT_B,
        PORT_C,
        PORT_D,
        // 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,
        D11_PB3,
        D12_PB4,
        D13_PB5,
        D14_PB6,
        D15_PB7,
 
        D16_PC0,
        D17_PC1,
        D18_PC2,
        D19_PC3,
        D20_PC4,
        D21_PC5,
        D22_PC6,
        D23_PC7,
 
        D24_PD0,
        D25_PD1,
        D26_PD2,
        D27_PD3,
        D28_PD4,
        D29_PD5,
        D30_PD6,
        D31_PD7,
 
        LED = D8_PB0,
        // FastArduino internal: DO NOT USE
        NONE = 0XFF
    };
 
    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,
        INTERNAL_2_56V
    };
    
    enum class AnalogPin: uint8_t
    {
        A0 = 0,
        A1,
        A2,
        A3,
        A4,
        A5,
        A6,
        A7,
        BANDGAP,
        // FastArduino internal: DO NOT USE
        NONE = UINT8_MAX
    };
    
    enum class PWMPin : uint8_t
    {
        D11_PB3_OC0A = 0,
        D12_PB4_OC0B,
        D28_PD4_OC1B,
        D29_PD5_OC1A,
        D30_PD6_OC2B,
        D31_PD7_OC2A,
 
#ifdef __AVR_ATmega1284P__
        D14_PB6_OC3A,
        D15_PB7_OC3B,
#endif
        // FastArduino internal: DO NOT USE
        NONE = UINT8_MAX
    };
    
    enum class ExternalInterruptPin : uint8_t
    {
        D26_PD2_EXT0 = 0,
        D27_PD3_EXT1,
        D10_PB2_EXT2
    };
 
    enum class InterruptPin : uint8_t
    {
        // PA0-7
        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),
 
        // PB0-7
        D8_PB0_PCI1 = uint8_t(DigitalPin::D8_PB0),
        D9_PB1_PCI1 = uint8_t(DigitalPin::D9_PB1),
        D10_PB2_PCI1 = uint8_t(DigitalPin::D10_PB2),
        D11_PB3_PCI1 = uint8_t(DigitalPin::D11_PB3),
        D12_PB4_PCI1 = uint8_t(DigitalPin::D12_PB4),
        D13_PB5_PCI1 = uint8_t(DigitalPin::D13_PB5),
        D14_PB6_PCI1 = uint8_t(DigitalPin::D14_PB6),
        D15_PB7_PCI1 = uint8_t(DigitalPin::D15_PB7),
 
        // PC0-7
        D16_PC0_PCI2 = uint8_t(DigitalPin::D16_PC0),
        D17_PC1_PCI2 = uint8_t(DigitalPin::D17_PC1),
        D18_PC2_PCI2 = uint8_t(DigitalPin::D18_PC2),
        D19_PC3_PCI2 = uint8_t(DigitalPin::D19_PC3),
        D20_PC4_PCI2 = uint8_t(DigitalPin::D20_PC4),
        D21_PC5_PCI2 = uint8_t(DigitalPin::D21_PC5),
        D22_PC6_PCI2 = uint8_t(DigitalPin::D22_PC6),
        D23_PC7_PCI2 = uint8_t(DigitalPin::D23_PC7),
 
        // PD0-7
        D24_PD0_PCI3 = uint8_t(DigitalPin::D24_PD0),
        D25_PD1_PCI3 = uint8_t(DigitalPin::D25_PD1),
        D26_PD2_PCI3 = uint8_t(DigitalPin::D26_PD2),
        D27_PD3_PCI3 = uint8_t(DigitalPin::D27_PD3),
        D28_PD4_PCI3 = uint8_t(DigitalPin::D28_PD4),
        D29_PD5_PCI3 = uint8_t(DigitalPin::D29_PD5),
        D30_PD6_PCI3 = uint8_t(DigitalPin::D30_PD6),
        D31_PD7_PCI3 = uint8_t(DigitalPin::D31_PD7),
    };
 
    enum class USART: uint8_t
    {
        USART0 = 0,
        USART1 = 1
    };
 
    enum class Timer: uint8_t
    {
        TIMER0 = 0,
        TIMER1 = 1,
        TIMER2 = 2,
#ifdef __AVR_ATmega1284P__
        TIMER3 = 3
#endif
    };
    
    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_STANDBY,
        EXTENDED_STANDBY = SLEEP_MODE_EXT_STANDBY
    };
};
 
// 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 INT1_vect(void) SIGNAL_HANDLER;
    void INT2_vect(void) SIGNAL_HANDLER;
    void PCINT0_vect(void) SIGNAL_HANDLER;
    void PCINT1_vect(void) SIGNAL_HANDLER;
    void PCINT2_vect(void) SIGNAL_HANDLER;
    void PCINT3_vect(void) SIGNAL_HANDLER;
    void SPI_STC_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 TIMER2_COMPA_vect(void) SIGNAL_HANDLER;
    void TIMER2_COMPB_vect(void) SIGNAL_HANDLER;
    void TIMER2_OVF_vect(void) SIGNAL_HANDLER;
    void TWI_vect(void) SIGNAL_HANDLER;
    void WDT_vect(void) SIGNAL_HANDLER;
    void USART0_UDRE_vect(void) SIGNAL_HANDLER;
    void USART0_RX_vect(void) SIGNAL_HANDLER;
    void USART0_TX_vect(void) SIGNAL_HANDLER;
    void USART1_UDRE_vect(void) SIGNAL_HANDLER;
    void USART1_RX_vect(void) SIGNAL_HANDLER;
    void USART1_TX_vect(void) SIGNAL_HANDLER;
    void EE_READY_vect(void) SIGNAL_HANDLER;
}
#endif /* BOARDS_ATMEGA_XX4_HH */