Pin.hh

Go to the documentation of this file.

#ifndef COSA_PIN_HH
#define COSA_PIN_HH

#include "Cosa/Types.h"
#include "Cosa/Bits.h"
#include "Cosa/IOStream.hh"

class OutputPin;

class Pin {
public:
  static uint8_t MASK(uint8_t pin)
    __attribute__((always_inline))
  {
    return (_BV(Board::BIT(pin)));
  }

  static volatile uint8_t* PIN(uint8_t pin)
    __attribute__((always_inline))
  {
    return (Board::SFR(pin));
  }

  static volatile uint8_t* DDR(uint8_t pin)
    __attribute__((always_inline))
  {
    return (Board::SFR(pin) + 1);
  }

  static volatile uint8_t* PORT(uint8_t pin)
    __attribute__((always_inline))
  {
    return (Board::SFR(pin) + 2);
  }

  enum Direction {
    MSB_FIRST = 0,
    LSB_FIRST = 1
  } __attribute__((packed));

  Pin(uint8_t pin) :
    m_sfr(Board::SFR(pin)),
    m_mask(MASK(pin)),
    m_pin(pin)
  {}

  uint8_t pin() const
  {
    return (m_pin);
  }

  bool is_set() const
    __attribute__((always_inline))
  {
    return ((*PIN() & m_mask) != 0);
  }

  bool is_high() const
    __attribute__((always_inline))
  {
    return ((*PIN() & m_mask) != 0);
  }

  bool is_on() const
    __attribute__((always_inline))
  {
    return ((*PIN() & m_mask) != 0);
  }

  bool is_clear() const
    __attribute__((always_inline))
  {
    return ((*PIN() & m_mask) == 0);
  }

  bool is_low() const
    __attribute__((always_inline))
  {
    return ((*PIN() & m_mask) == 0);
  }

  bool is_off() const
    __attribute__((always_inline))
  {
    return ((*PIN() & m_mask) == 0);
  }

  bool read() const
    __attribute__((always_inline))
  {
    return ((*PIN() & m_mask) != 0);
  }

  uint8_t read(OutputPin& clk, Direction order = MSB_FIRST) const;

  static bool read(Board::DigitalPin pin)
    __attribute__((always_inline))
  {
    return ((*Board::SFR(pin) & MASK(pin)) != 0);
  }

  operator bool() const
    __attribute__((always_inline))
  {
    return ((*PIN() & m_mask) != 0);
  }

  Pin& operator>>(uint8_t& var)
    __attribute__((always_inline))
  {
    var = ((*PIN() & m_mask) != 0);
    return (*this);
  }

protected:
  volatile uint8_t* const m_sfr;

  const uint8_t m_mask;

  const uint8_t m_pin;

  volatile uint8_t* PIN() const
  {
    return (m_sfr);
  }

  volatile uint8_t* DDR() const
  {
    return (m_sfr + 1);
  }

  volatile uint8_t* PORT() const
  {
    return (m_sfr + 2);
  }

  volatile uint8_t* PCIMR() const
    __attribute__((always_inline))
  {
    return (Board::PCIMR(m_pin));
  }
};

#define asserted(pin)                                                   \
  for (uint8_t __i = (pin.toggle(), 1); __i != 0; __i--, pin.toggle())

#endif