irq.h

Go to the documentation of this file.

#ifndef DRIVER_IRQ_H
#define DRIVER_IRQ_H

/**********************************************************************/
/**
 * @file
 * @brief External IRQ abstraction
 *
 * @author DT, Jetro AS
 ***********************************************************************/

/**
 * \defgroup irqext External IRQ
 * \ingroup irq
 * \{
 *
 */

/* external from gpio-ext.h*/
struct gpio_ext_t;

/**
 * IRQ handler callback function prototype.
 *
 * \param Module User-defined data
 * \param IoExpander Pointer to the instance of system IO expanders which has triggered the interrupt. NULL for built-in MCU GPIO.
 * \param Pin Pin number which has triggered the interrupt.
 */
typedef void (*irq_handler_cb_t)(void *Module, const struct gpio_ext_t *GpioExt, uint8_t Pin);

/**
 * IRQ configuration database entry
 *
 * \param Callback IRQ handler callback
 * \param Module User-defined data passed to the callback
 */
struct irq_config_t
{
  irq_handler_cb_t Callback;
  void *Module;
};

/**
 * IRQ mode
 */
enum irq_mode_t
{
  IRQ_MODE_DISABLED = 0,    /**< IRQ is disabled */
  IRQ_MODE_RISING,          /**< Rising edge sense */
  IRQ_MODE_FALLING,         /**< Falling edge sense */
};

/**
 * IRQ configuration database index for built-in MCU GPIO interrupts
 * Each entry in the table should represent an offset in the \ref IrqConfig table plus one
 */
extern const uint8_t IntIrqDispatch[32];

/**
 * IRQ configuration database index for IO expanders interrupts
 * Each entry in the table should represent an offset in the \ref IrqConfig table plus one
 *
 */
extern const uint8_t ExtIrqDispatch[];

/**
 * IRQ configuration database. 
 */
extern const struct irq_config_t IrqConfig[];

/**
 * NULL-terminated array of GPIO expanders
*/
extern const struct gpio_ext_t* GpioExpanders[];

/**
 * Trigger an internal IRQ for the pin
 *
 * \param Pin Pin number
 */
extern void IrqTriggerInternal(uint8_t Pin);

/**
 * Trigger an external interrupt
 */
extern void IrqTriggerExternal(void);

/**
 * Enables or disables internal interrupt for the selected pin
 */
void IrqEnableInternal(uint8_t Pin, enum irq_mode_t Mode);

/**
 * Mark an interrrupt pin as an external interrupt trigger
 *
 * \param Pin Pin number
 */
void IrqRegisterExternal(uint8_t Pin);

/**********************************************************************/
/**
 * @brief Name:     GpioInterruptHandler\n
 * GPIO interrupt handler
 * Must be called from GPIOTE_Handler.
 ***********************************************************************/
void GpioInterruptHandler(void);

/** \} */

#endif // DRIVER_IRQ_H