leonardo.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_LEONARDO_HH
#define BOARDS_LEONARDO_HH
 
#include "io.h"
#include "../defines.h"
#include <avr/sleep.h>
 
/* This board is based on ATmega32u4 */
#define BOARD_ATMEGA32U4
 
namespace board
{
    inline static void init()
    {
        // Disable USB controller by default
        *((volatile uint8_t*) USBCON) = 0;
        *((volatile uint8_t*) UDCON) = 0;
        // Disable all interrupts
        *((volatile uint8_t*) UDINT) = 0;
        *((volatile uint8_t*) UDIEN) = 0;
    }
    
    enum class Port: uint8_t
    {
        PORT_B = 0,
        PORT_C,
        PORT_D,
        PORT_E,
        PORT_F,
        // FastArduino internal: DO NOT USE
        NONE = UINT8_MAX
    };
    
    enum class DigitalPin: uint8_t
    {
        D0_PD2 = 0,
        D0 = D0_PD2,
        D1_PD3,
        D1 = D1_PD3,
        D2_PD1,
        D2 = D2_PD1,
        D3_PD0,
        D3 = D3_PD0,
        D4_PD4,
        D4 = D4_PD4,
        D5_PC6,
        D5 = D5_PC6,
        D6_PD7,
        D6 = D6_PD7,
        D7_PE6,
        D7 = D7_PE6,
        D8_PB4,
        D8 = D8_PB4,
        D9_PB5,
        D9 = D9_PB5,
        D10_PB6,
        D10 = D10_PB6,
        D11_PB7,
        D11 = D11_PB7,
        D12_PD6,
        D12 = D12_PD6,
        D13_PC7,
        D13 = D13_PC7,
        
        A0_PF7,
        A0 = A0_PF7,
        A1_PF6,
        A1 = A1_PF6,
        A2_PF5,
        A2 = A2_PF5,
        A3_PF4,
        A3 = A3_PF4,
        A4_PF1,
        A4 = A4_PF1,
        A5_PF0,
        A5 = A5_PF0,
        
        SCK_PB1,
        MOSI_PB2,
        MISO_PB3,
        
        RXLED_PB0,
        TXLED_PD5,
        
        LED = D13_PC7,
        // 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_2_56V
    };
    
    enum class AnalogPin: uint8_t
    {
        A0_ADC7 = 0,
        A0 = A0_ADC7,
        A1_ADC6,
        A1 = A1_ADC6,
        A2_ADC5,
        A2 = A2_ADC5,
        A3_ADC4,
        A3 = A3_ADC4,
        A4_ADC1,
        A4 = A4_ADC1,
        A5_ADC0,
        A5 = A5_ADC0,
 
        A6_D4_ADC8,
        D4 = A6_D4_ADC8,
        A7_D6_ADC10,
        D6 = A7_D6_ADC10,
        A8_D8_ADC11,
        D8 = A8_D8_ADC11,
        A9_D9_ADC12,
        D9 = A9_D9_ADC12,
        A10_D10_ADC13,
        D10 = A10_D10_ADC13,
        A11_D12_ADC9,
        D12 = A11_D12_ADC9,
        
        TEMP,
        BANDGAP,
        // FastArduino internal: DO NOT USE
        NONE = UINT8_MAX
    };
    
    enum class PWMPin : uint8_t
    {
        D11_PB7_OC0A = 0,
        D3_PD0_OC0B,
        D9_PB5_OC1A,
        D10_PB6_OC1B,
        D11_PB7_OC1C,
        D5_PC6_OC3A,
        //TODO High-speed timer (Timer4) related PWM pins are not listed here because Timer4 is not supported yet
 
        D3 = D3_PD0_OC0B,
        D9 = D9_PB5_OC1A,
        D10 = D10_PB6_OC1B,
        D5 = D5_PC6_OC3A,
        // FastArduino internal: DO NOT USE
        NONE = UINT8_MAX
    };
    
    enum class ExternalInterruptPin : uint8_t
    {
        D3_PD0_EXT0 = 0,
        D2_PD1_EXT1,
        D0_PD2_EXT2,
        D1_PD3_EXT3,
        D7_PE6_EXT6,
 
        D3 = D3_PD0_EXT0,
        D2 = D2_PD1_EXT1,
        D0 = D0_PD2_EXT2,
        D1 = D1_PD3_EXT3,
        D7 = D7_PE6_EXT6
    };
 
    enum class InterruptPin : uint8_t
    {
        RXLED_PB0_PCI0 = uint8_t(DigitalPin::RXLED_PB0),
        SCK_PB1_PCI0 = uint8_t(DigitalPin::SCK_PB1),
        MOSI_PB2_PCI0 = uint8_t(DigitalPin::MOSI_PB2),
        MISO_PB3_PCI0 = uint8_t(DigitalPin::MISO_PB3),
        D8_PB4_PCI0 = uint8_t(DigitalPin::D8_PB4),
        D9_PB5_PCI0 = uint8_t(DigitalPin::D9_PB5),
        D10_PB6_PCI0 = uint8_t(DigitalPin::D10_PB6),
        D11_PB7_PCI0 = uint8_t(DigitalPin::D11_PB7),
 
        D8 = D8_PB4_PCI0,
        D9 = D9_PB5_PCI0,
        D10 = D10_PB6_PCI0,
        D11 = D11_PB7_PCI0
    };
 
    enum class USART: uint8_t
    {
        USART1 = 1
    };
    
    enum class Timer: uint8_t
    {
        TIMER0 = 0,
        TIMER1 = 1,
        TIMER3 = 3
    };
    
    //TODO Add specific enumeration for High-speed timer? (or specific traits?)
    
    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 INT3_vect(void) SIGNAL_HANDLER;
    void INT6_vect(void) SIGNAL_HANDLER;
    void PCINT0_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_CAPT_vect(void)  SIGNAL_HANDLER;
    void TIMER1_COMPA_vect(void) SIGNAL_HANDLER;
    void TIMER1_COMPB_vect(void) SIGNAL_HANDLER;
    void TIMER1_COMPC_vect(void) SIGNAL_HANDLER;
    void TIMER1_OVF_vect(void) SIGNAL_HANDLER;
    void TIMER3_CAPT_vect(void)  SIGNAL_HANDLER;
    void TIMER3_COMPA_vect(void) SIGNAL_HANDLER;
    void TIMER3_COMPB_vect(void) SIGNAL_HANDLER;
    void TIMER3_COMPC_vect(void) SIGNAL_HANDLER;
    void TIMER3_OVF_vect(void) SIGNAL_HANDLER;
    void TIMER4_COMPA_vect(void) SIGNAL_HANDLER;
    void TIMER4_COMPB_vect(void) SIGNAL_HANDLER;
    void TIMER4_COMPD_vect(void) SIGNAL_HANDLER;
    void TIMER4_OVF_vect(void) SIGNAL_HANDLER;
    void TWI_vect(void) SIGNAL_HANDLER;
    void WDT_vect(void) SIGNAL_HANDLER;
    void USART1_RX_vect(void) SIGNAL_HANDLER;
    void USART1_TX_vect(void) SIGNAL_HANDLER;
    void USART1_UDRE_vect(void) SIGNAL_HANDLER;
    void EE_READY_vect(void) SIGNAL_HANDLER;
}
 
#endif /* BOARDS_LEONARDO_HH */