iohelp.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*
* IO convenience functions
*---------------------------------------------------------------------------*
* 16-Apr-2014 ShaneG
*
* These functions provide simple ways to deal with common IO functions.
*--------------------------------------------------------------------------*/
#ifndef __IOHELP_H
#define __IOHELP_H

//--- Required definitions
#include <stdint.h>
#include <stdbool.h>
#include <avr/io.h>

#ifdef __cplusplus
extern "C" {
#endif

//---------------------------------------------------------------------------
// Digital helper functions
//---------------------------------------------------------------------------

#define pinHigh(pin) \
  PORTB |= (1 << pin)

#define pinLow(pin) \
  PORTB &= ~(1 << pin)

void pinSet(uint8_t pin, bool value);

#define pinGet(pin) \
  (PINB & (1 << pin))

//---------------------------------------------------------------------------
// Analog helper functions
//---------------------------------------------------------------------------

typedef enum _ANALOG {
  ADC0 = 0x00, 
  ADC1,        
  ADC2,        
  ADC3,        
  ADC4 = 0x0F  
  } ANALOG;

void adcInit(ANALOG adc);

uint16_t adcRead(ANALOG adc, uint8_t skip, uint8_t average);

//---------------------------------------------------------------------------
// Hardware PWM helpers
//---------------------------------------------------------------------------

typedef enum _PWM {
  PWM0 = 0, 
  PWM1 = 1, 
  } PWM;

void pwmInit();

void pwmOut(PWM pwm, uint8_t value);

//---------------------------------------------------------------------------
// Software PWM implementation
//---------------------------------------------------------------------------

typedef enum _SPWM {
  SPWM0 = 0, 
  SPWM1 = 1, 
  SPWM2 = 2, 
  SPWM3 = 3, 
  } SPWM;

void spwmInit();

void spwmOut(SPWM pwm, uint8_t value);

uint8_t spwmValue(SPWM pwm);

//---------------------------------------------------------------------------
// Software SPI
//---------------------------------------------------------------------------

void sspiInit(uint8_t sck, uint8_t mosi, uint8_t miso);

void sspiOutMSB(uint8_t sck, uint8_t mosi, uint16_t data, uint8_t bits);

uint16_t sspiInMSB(uint8_t sck, uint8_t miso, uint8_t bits);

uint16_t sspiInOutMSB(uint8_t sck, uint8_t mosi, uint8_t miso, uint16_t data, uint8_t bits);

void sspiOutLSB(uint8_t sck, uint8_t mosi, uint16_t data, uint8_t bits);

uint16_t sspiInLSB(uint8_t sck, uint8_t miso, uint8_t bits);

uint16_t sspiInOutLSB(uint8_t sck, uint8_t mosi, uint8_t miso, uint16_t data, uint8_t bits);

#ifdef __cplusplus
}
#endif

#endif /* __IOHELP_H */