px_board.h

#ifndef __PX_BOARD_H__
#define __PX_BOARD_H__
/* =============================================================================
     ____    ___    ____    ___    _   _    ___    __  __   ___  __  __ TM
    |  _ \  |_ _|  / ___|  / _ \  | \ | |  / _ \  |  \/  | |_ _| \ \/ /
    | |_) |  | |  | |     | | | | |  \| | | | | | | |\/| |  | |   \  /
    |  __/   | |  | |___  | |_| | | |\  | | |_| | | |  | |  | |   /  \
    |_|     |___|  \____|  \___/  |_| \_|  \___/  |_|  |_| |___| /_/\_\
 
    Copyright (c) 2015 Pieter Conradie <https://piconomix.com>
 
    License: MIT
    https://github.com/piconomix/px-fwlib/blob/master/LICENSE.md
   
    Title:          px_board.h : Arduino UNO R3 Board
    Author(s):      Pieter Conradie
    Creation Date:  2015-01-30
 
============================================================================= */
/** 
 *  @ingroup BOARDS_AVR
 *  @defgroup BOARDS_AVR_ARDUINO_UNO px_board.h : Arduino UNO R3 Board
 *  
 *  ![Arduino UNO R3 Board](arduino_uno_r3.jpg)
 *   
 *  Image Copyright (c) [Arduino SA](http://www.arduino.cc).
 *  License: [Creative Commons Attribution ShareAlike 3.0](http://creativecommons.org/licenses/by-sa/3.0/legalcode)
 *  
 *  File(s):
 *  - boards/avr/arduino_uno/inc/px_board.h 
 *  - boards/avr/arduino_uno/inc/px_board_gpio.h 
 *  - boards/avr/arduino_uno/src/px_board.c
 *
 *  @{
 */
 
/* _____STANDARD INCLUDES____________________________________________________ */
 
/* _____PROJECT INCLUDES_____________________________________________________ */
#include "px_defs.h"
#include "px_board_gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
/* _____DEFINITIONS__________________________________________________________ */
/// Board name
#define PX_BOARD_ARDUINO_UNO
 
/// Processor frequency in Hz
#ifndef F_CPU
#define F_CPU           16000000ul
#endif
 
/// @name ADC Channel mux definitions
/// @{
#define ADC0    0
#define ADC1    1
#define ADC2    2
#define ADC3    3
/// @}
 
/* _____TYPE DEFINITIONS_____________________________________________________ */
/// Identify which GPIO pins are used for Chip Select in board_spi_cs_lo() and board_spi_cs_hi()
typedef enum
{
    PX_BOARD_SPI_CS_NONE = 0,  ///< Slave Select pin
    PX_BOARD_SPI_SS,           ///< Slave Select pin
    PX_BOARD_SPI_D2,           ///< Digital 2
    PX_BOARD_SPI_D3,           ///< Digital 3
    PX_BOARD_SPI_D4,           ///< Digital 4
    PX_BOARD_SPI_D5,           ///< Digital 5
    PX_BOARD_SPI_D6,           ///< Digital 6
    PX_BOARD_SPI_D7,           ///< Digital 7
    PX_BOARD_SPI_D8,           ///< Digital 8
    PX_BOARD_SPI_D9,           ///< Digital 9
} px_board_spi_cs_t;
 
/* _____GLOBAL VARIABLES_____________________________________________________ */
 
/* _____GLOBAL FUNCTION DECLARATIONS_________________________________________ */
/** 
 *  Initialise the board hardware.
 */
extern void px_board_init(void);
 
/**
 *  Set specified SPI Chip Select low
 *  
 *  @param cs_id    ID which GPIO pin must be used for Chip Select
 */
extern void px_board_spi_cs_lo(uint8_t cs_id);
 
/**
 *  Set specified SPI Chip Select high
 *  
 *  @param cs_id    ID which GPIO pin must be used for Chip Select
 */
extern void px_board_spi_cs_hi(uint8_t cs_id);
 
/**
 * Blocking delay for specified number of microseconds.
 *  
 * @param delay_us  Number of microseconds to block
 */
extern void px_board_delay_us(uint16_t delay_us);
 
/**
 *  Blocking delay for specified number of milliseconds.
 *  
 *  @param delay_ms  Number of milliseconds to block
 */
void px_board_delay_ms(uint16_t delay_ms);
 
/* _____MACROS_______________________________________________________________ */
/// Enable LED (shared with SPI clock)
#define PX_LED_ON()            PX_GPIO_OUT_SET_HI(PX_GPIO_LED)
/// Disable LED (shared with SPI clock)
#define PX_LED_OFF()           PX_GPIO_OUT_SET_LO(PX_GPIO_LED)
/// Toggle LED (shared with SPI clock)
#define PX_LED_TOGGLE()        PX_GPIO_OUT_TOGGLE(PX_GPIO_LED)
 
#ifdef __cplusplus
}
#endif
 
/// @}
#endif