board_definition.h

Go to the documentation of this file.

#pragma once
 
#include <stdint.h>
#include <Arduino.h>
#include "type_traits.h"
 
void initBoard(uint32_t baudRate);
 
void boardInitPins(void);
 
uint16_t freeRam(void);
 
void doSystemReset(void);
 
void jumpToBootloader(void);
 
uint8_t getSystemTemp(void);
 
struct statuses;
 
uint16_t getEepromWriteBlockSize(const statuses &current);
 
// Include a specific header for a board.
#if defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) || defined(__AVR_ATmega2561__)
  #include "board_avr2560.h"
#elif defined(CORE_TEENSY)
  #if defined(__MK64FX512__) || defined(__MK66FX1M0__)
    #include "board_teensy35.h"
  #elif defined(__IMXRT1062__)
    #include "board_teensy41.h"
  #endif
#elif defined(STM32_MCU_SERIES) || defined(ARDUINO_ARCH_STM32) || defined(STM32)
  #include "board_stm32_official.h"
#elif defined(__SAME51J19A__)
  #include "board_same51.h"
// Allow external injection of the board definition via compiler flags
#elif defined(EXTERNAL_BOARD_H)
  #include EXTERNAL_BOARD_H
#else
  #error Incorrect board selected. Please select the correct board (Usually Mega 2560) and upload again
#endif
 
#if defined(RTC_ENABLED)
void boardInitRTC(void);
#endif
 
// It is important that we cast this to the actual overflow limit of the timer. 
// The compare variables type can be wider than the timer overflow.
#define SET_COMPARE(compare, value) (compare) = (COMPARE_TYPE)(value)
 
EEPROM_t& getEEPROM(void);
 
constexpr uint32_t MAX_TIMER_PERIOD = ticksToMicros((numeric_limits<COMPARE_TYPE>::max)());