bsp.h

Go to the documentation of this file.

/************************************************************************//**
 * \file    heivs/bsp.h
 * \brief   BSP - Board Support Package
 * \author  marc dot pignat at hevs dot ch
 ***************************************************************************/

#ifndef HEIVS_BSP_H
#define HEIVS_BSP_H
/************************************************************************//**
 * \defgroup bsp Board support package
 * \ingroup libheivs_stm32
 * @{
 * \brief Support for common devices (buttons, leds, ...)
 ***************************************************************************/

#include "heivs/error.h"
#include "heivs/stm32_gpio.h"

#if defined(BOARD_STM32F4_DISCOVERY)
#include "heivs/bsp_stm32f4_discovery.h"
#elif defined (BOARD_STM32F4_DISCOVERY_LCD)
#include "heivs/bsp_stm32f4_discovery_lcd.h"
#elif defined (BOARD_STM32F4_GEVAL)
#include "heivs/bsp_stm32f4_geval.h"
#elif defined (BOARD_STM32_CAMERA)
#include "heivs/bsp_stm32_camera.h"
#elif defined (BOARD_ARMEBS4)
#include "heivs/bsp_armebs4.h"
#elif defined (BOARD_ENVIROBOT_SC)
#include "heivs/bsp_envirobot_sc.h"
#else
#error Please define BOARD_STM32F4_DISCOVERY, BOARD_STM32F4_GEVAL, BOARD_STM32_CAMERA or BOARD_ARMEBS4 globally
#endif

#if !defined(BSP_LED_NR)
#error heivs/bsp_CURRENT_BOARD.h must define BSP_LED_NR
#endif

#if !defined(BSP_BUTTON_NR)
#error heivs/bsp_CURRENT_BOARD.h must define BSP_BUTTON_NR
#endif

#if !defined(BSP_I2C_BUS_COUNT)
#error heivs/bsp_CURRENT_BOARD.h must define BSP_I2C_BUS_COUNT
#endif

#if !defined(BSP_SPI_BUS_COUNT)
#error heivs/bsp_CURRENT_BOARD.h must define BSP_SPI_BUS_COUNT
#endif

#if !defined(BSP_USART_BUS_COUNT)
#error heivs/bsp_CURRENT_BOARD.h must define BSP_USART_BUS_COUNT
#endif

/**
 * \def BSP_BOARD_PRETTY_NAME
 * \brief User friendly name
 */
#if !defined(BSP_BOARD_PRETTY_NAME)
#error heivs/bsp_CURRENT_BOARD.h must define BSP_BOARD_PRETTY_NAME
#endif

#if !defined(BSP_HAS_NVM)
#define BSP_HAS_NVM 0
#endif

#if (BSP_HAS_NVM != 0) && (BSP_HAS_NVM != 1)
#error BSP_HAS_NVM should be defined as 0 or 1
#endif

#ifdef __cplusplus
    extern "C" {
#endif

/************************************************************************//**
 * \brief Initialize the whole board
 *
 * \return #NO_ERROR for no problem
 ***************************************************************************/
status_e bsp_init(void);

/************************************************************************//**
 * \brief Set a led (ON or OFF)
 * \param nr the led number
 * \param value 0 for OFF, anything else : ON
 *
 ***************************************************************************/
void bsp_led_set(uint32_t nr, uint32_t value);

#ifdef BSP_PWM_LED_STEPS
/************************************************************************//**
 * \brief Set the value of a led
 * \param led the led number, 0..BSP_LED_NR-1
 * \param value the value from 0 to BSP_PWM_LED_STEPS, 0 is off
 *
 * \see BSP_LED_NR
 * \see BSP_PWM_LED_STEPS
 ***************************************************************************/
void bsp_led_set_pwm(uint32_t led, uint32_t value);
#else
//#define bsp_led_set_pwm(x,y) ERROR_your_BSP_does_not_support_pwm_leds
#endif

/************************************************************************//**
 * \brief Get a button
 * \param nr the button number
 * \return value 0 for "not pressed", anything else : "pressed"
 ***************************************************************************/
uint32_t bsp_button_get(uint32_t nr);

/************************************************************************//**
 * \brief Get all buttons
 *
 * \return the value of each buttons stored in every bits of the return value
 ***************************************************************************/
uint32_t bsp_button_get_all(void);

/************************************************************************//**
 * \brief get buttons gpios
 * \return the pointer on the first element of an array of gpios
 ***************************************************************************/
const struct gpio_t *bsp_button_gpios(void);

/************************************************************************//**
 * \brief Set a irq handler for all button changes
 * \param handler The handler for button changed with those parameters is : the current value, was, the value of the last call
 * \return #NO_ERROR for no problem
 ***************************************************************************/
status_e bsp_set_button_irq_handler(void (*handler)(uint32_t is, uint32_t was));

/************************************************************************//**
 * \brief toggle a led
 * \param nr the led number
 ***************************************************************************/
void bsp_led_toggle(uint32_t nr);

/************************************************************************//**
 * \brief fatal error
 *
 * \param status The status of the fatal error
 *
 * This function will halt the CPU if a debugger is connected.
 ***************************************************************************/
__attribute__ ((weak, noreturn))
void bsp_fatal(status_e status);

/************************************************************************//**
 * \brief Reset reason initialization
 *
 * Save the reset reason, called from startup code
 ***************************************************************************/
void bsp_reset_reason_init(void);

/************************************************************************//**
 * \brief Reset reason get
 * \return the value of RCC->CSR at boot time
 *
 * This value has been saved by bsp_reset_reason_init from startup code
 ***************************************************************************/
uint32_t bsp_reset_reason_get(void);

/************************************************************************//**
 * \brief Reset reason clear
 *
 * Clear the reset reason value from RCC->CSR
 ***************************************************************************/
void bsp_reset_reason_clear(void);

#ifndef HSE_VALUE
extern uint32_t HSE_VALUE;
#endif

#ifdef __cplusplus
    }
#endif

/************************************************************************//**
 * @}
 ***************************************************************************/

#endif /* HEIVS_BSP_H */