stm32_gpio_irq.h

Go to the documentation of this file.

/************************************************************************//**
 * \file    heivs/stm32_gpio_irq.h
 * \brief   GPIO interrupts
 * \author  marc dot pignat at hevs dot ch
 * \defgroup gpio_irq GPIO Interrupts
 * \ingroup gpio
 * @{
 ***************************************************************************/
#ifndef HEIVS_STM32_GPIO_IRQ_H
#define HEIVS_STM32_GPIO_IRQ_H

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

#ifdef __cplusplus
    extern "C" {
#endif

/**
 * Gpio IRQ modes
 */
enum gpio_irq_mode_e
{
    GPIO_IRQ_MODE_DISABLED,         ///< Disabled
    GPIO_IRQ_MODE_EDGE_FALLING,     ///< Falling edge
    GPIO_IRQ_MODE_EDGE_RISING,      ///< Rising edge
    GPIO_IRQ_MODE_EDGE_BOTH,        ///< Both edge
    GPIO_IRQ_MODE_LEVEL_LOW,        ///< Level low (emulated)
    GPIO_IRQ_MODE_LEVEL_HIGH,       ///< Level high (emulated)
};

/**
 * \brief Setup interrupt on GPIO
 *
 * \param gpio the [gpio](\ref gpio_t)  to use (will be configured)
 * \param handler handler's return value: see below
 * \param mode #gpio_irq_mode_e of the interrupt
 * \param prio the priority for the NVIC
 *
 * \return #NO_ERROR for no problem
 *
 * \warning ::GPIO_IRQ_MODE_LEVEL_LOW and ::GPIO_IRQ_MODE_LEVEL_HIGH interrupts
 * are emulated.
 *
 * When using ::GPIO_IRQ_MODE_LEVEL_LOW and ::GPIO_IRQ_MODE_LEVEL_HIGH, the
 * handler will be called continuously unless the pin level change to the
 * inactive level. Deferred processing is possible, the handler can return true,
 * and the loop will break. The deferred handler MUST call gpio_irq_restore()
 * after the interrupt has been handled to restore normal behavior.
 */
status_e gpio_irq_setup(const struct gpio_t *gpio, uint32_t (*handler)(const struct gpio_t *gpio), enum gpio_irq_mode_e mode, uint32_t prio);

/**
 * \brief Disable a gpio interrupt
 *
 * \param gpio the gpio to use
 * \return #NO_ERROR for no problem
 */
status_e gpio_irq_disable(const struct gpio_t *gpio);

/**
 * \brief Restore a gpio interrupt
 *
 * \param gpio the gpio to use
 * \see used with gpio_irq_setup and ::GPIO_IRQ_MODE_LEVEL_LOW or ::GPIO_IRQ_MODE_LEVEL_HIGH
 */
status_e gpio_irq_restore(const struct gpio_t *gpio);

#ifdef __cplusplus
}
#endif

/**
 * @}
 */
#endif /* HEIVS_STM32_GPIO_IRQ_H */