utils_pins.h

Go to the documentation of this file.

 
#ifndef UTILS_PINS_H
#define UTILS_PINS_H
 
#include <Arduino.h>
 
inline constexpr uint8_t unused_pin{ 0xff }; 
 
#if defined(__DOXYGEN__)
inline constexpr void togglePin(uint8_t pin);
 
inline constexpr void setPinON(uint8_t pin);
inline void setPinsON(uint16_t pins);
 
inline constexpr void setPinOFF(uint8_t pin);
inline void setPinsOFF(uint16_t pins);
 
inline constexpr bool getPinState(uint8_t pin);
 
inline void setPinsAsOutput(uint16_t pins);
inline void setPinsAsInputPullup(uint16_t pins);
#else
inline constexpr void togglePin(uint8_t pin) __attribute__((always_inline));
 
inline constexpr void setPinON(uint8_t pin) __attribute__((always_inline));
inline void setPinsON(uint16_t pins) __attribute__((always_inline));
 
inline constexpr void setPinOFF(uint8_t pin) __attribute__((always_inline));
inline void setPinsOFF(uint16_t pins) __attribute__((always_inline));
 
inline constexpr bool getPinState(uint8_t pin) __attribute__((always_inline));
 
inline void setPinsAsOutput(uint16_t pins) __attribute__((always_inline));
inline void setPinsAsInputPullup(uint16_t pins) __attribute__((always_inline));
#endif

template< typename T > constexpr void bit_set(T& _dest, const uint8_t bit)
{
  _dest |= (T)0x01 << bit;
}

template< typename T > constexpr uint8_t bit_read(const T& _src, const uint8_t bit)
{
  return (_src >> bit) & (T)0x01;
}

template< typename T > constexpr uint8_t bit_clear(T& _dest, const uint8_t bit)
{
  return _dest &= ~((T)0x01 << bit);
}

void constexpr togglePin(const uint8_t pin)
{
  if (pin < 8u)
  {
    bit_set(PIND, pin);
  }
  else if (pin < 14u)
  {
    bit_set(PINB, pin - 8u);
  }
  else
  {
    bit_set(PINC, pin - 14u);
  }
}

inline constexpr void setPinState(const uint8_t pin, const bool bState)
{
  if (bState)
  {
    setPinON(pin);
  }
  else
  {
    setPinOFF(pin);
  }
}

inline constexpr void setPinON(const uint8_t pin)
{
  if (pin < 8u)
  {
    bit_set(PORTD, pin);
  }
  else if (pin < 14u)
  {
    bit_set(PORTB, pin - 8u);
  }
  else
  {
    bit_set(PORTC, pin - 14u);
  }
}

inline void setPinsON(const uint16_t pins)
{
  PORTD |= lowByte(pins);
  PORTB |= highByte(pins);
}

inline constexpr void setPinOFF(const uint8_t pin)
{
  if (pin < 8u)
  {
    bit_clear(PORTD, pin);
  }
  else if (pin < 14u)
  {
    bit_clear(PORTB, pin - 8u);
  }
  else
  {
    bit_clear(PORTC, pin - 14u);
  }
}

inline void setPinsOFF(const uint16_t pins)
{
  PORTD &= ~lowByte(pins);
  PORTB &= ~highByte(pins);
}

inline constexpr bool getPinState(const uint8_t pin)
{
  if (pin < 8u)
  {
    return bit_read(PIND, pin);
  }
  else if (pin < 14u)
  {
    return bit_read(PINB, pin - 8u);
  }
  else
  {
    return bit_read(PINC, pin - 14u);
  }
}

inline void setPinsAsOutput(const uint16_t pins)
{
  DDRD |= lowByte(pins);
  DDRB |= highByte(pins);
}

inline void setPinsAsInputPullup(const uint16_t pins)
{
  DDRD &= ~lowByte(pins);  // Set pins as input
  PORTD |= lowByte(pins);  // Enable pull-up resistors
 
  DDRB &= ~highByte(pins);  // Set pins as input
  PORTB |= highByte(pins);  // Enable pull-up resistors
}
 
#endif /* UTILS_PINS_H */