no_os_irq.h

Go to the documentation of this file.

/***************************************************************************/
 
#ifndef _NO_OS_IRQ_H_
#define _NO_OS_IRQ_H_
 
#include <stdint.h>

enum no_os_irq_uart_event_e {
    NO_OS_IRQ_WRITE_DONE,
    NO_OS_IRQ_READ_DONE,
    NO_OS_IRQ_ERROR
};
enum no_os_irq_uart_event_e {…};
 
enum no_os_irq_event {
    NO_OS_EVT_GPIO,
    NO_OS_EVT_UART_TX_COMPLETE,
    NO_OS_EVT_UART_RX_COMPLETE,
    NO_OS_EVT_UART_ERROR,
    NO_OS_EVT_RTC,
    NO_OS_EVT_XINT,
    NO_OS_EVT_TIM_ELAPSED,
    NO_OS_EVT_TIM_PWM_PULSE_FINISHED,
    NO_OS_EVT_LPTIM_PWM_PULSE_FINISHED,
    NO_OS_EVT_DMA_RX_COMPLETE,
    NO_OS_EVT_DMA_RX_HALF_COMPLETE,
    NO_OS_EVT_DMA_TX_COMPLETE,
    NO_OS_EVT_USB,
};
enum no_os_irq_event {…};
 
enum no_os_irq_trig_level {
    NO_OS_IRQ_LEVEL_LOW,
    NO_OS_IRQ_LEVEL_HIGH,
    NO_OS_IRQ_EDGE_FALLING,
    NO_OS_IRQ_EDGE_RISING,
    NO_OS_IRQ_EDGE_BOTH
};
enum no_os_irq_trig_level {…};
 
enum no_os_irq_peripheral {
    NO_OS_GPIO_IRQ,
    NO_OS_UART_IRQ,
    NO_OS_RTC_IRQ,
    NO_OS_TIM_IRQ,
    NO_OS_LPTIM_IRQ,
    NO_OS_TDM_DMA_IRQ,
    NO_OS_TIM_DMA_IRQ,
    NO_OS_SPI_DMA_IRQ,
    NO_OS_DMA_IRQ,
    NO_OS_USB_IRQ,
};
enum no_os_irq_peripheral {…};

struct no_os_irq_platform_ops ;

struct no_os_irq_init_param {
    uint32_t    irq_ctrl_id;
    const struct no_os_irq_platform_ops *platform_ops;
    void        *extra;
};
struct no_os_irq_init_param {…};

struct no_os_irq_ctrl_desc {
    uint32_t    irq_ctrl_id;
    const struct no_os_irq_platform_ops *platform_ops;
    /* Reference counter */
    uint32_t ref;
    void        *extra;
};
struct no_os_irq_ctrl_desc {…};

struct no_os_callback_desc {
    void (*callback)(void *context);
    void *ctx;
    enum no_os_irq_event event;
    enum no_os_irq_peripheral peripheral;
    void *handle;
};
struct no_os_callback_desc {…};

struct no_os_irq_platform_ops {
    int (*init)(struct no_os_irq_ctrl_desc **desc,
            const struct no_os_irq_init_param *param);
    int (*register_callback)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id,
                 struct no_os_callback_desc *callback);
    int (*unregister_callback)(struct no_os_irq_ctrl_desc *desc,
                   uint32_t irq_id,
                   struct no_os_callback_desc *callback);
    int (*global_enable)(struct no_os_irq_ctrl_desc *desc);
    int (*global_disable)(struct no_os_irq_ctrl_desc *desc);
    int (*trigger_level_set)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id,
                 enum no_os_irq_trig_level trig);
    int (*enable)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id);
    int (*disable)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id);
    int (*set_priority)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id,
                uint32_t priority_level);
    int (*get_priority)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id,
                uint32_t *priority_level);
    int (*remove)(struct no_os_irq_ctrl_desc *desc);
    int(*clear_pending)(struct no_os_irq_ctrl_desc* desc, uint32_t irq_id);
};
struct no_os_irq_platform_ops {…};
 
/* Initialize a interrupt controller peripheral. */
int no_os_irq_ctrl_init(struct no_os_irq_ctrl_desc **desc,
            const struct no_os_irq_init_param *param);
 
/* Free the resources allocated by no_os_irq_ctrl_init(). */
int no_os_irq_ctrl_remove(struct no_os_irq_ctrl_desc *desc);
 
/* Register a callback to handle the irq events */
int no_os_irq_register_callback(struct no_os_irq_ctrl_desc *desc,
                uint32_t irq_id,
                struct no_os_callback_desc *callback_desc);
 
/* Unregisters a generic IRQ handling function */
int no_os_irq_unregister_callback(struct no_os_irq_ctrl_desc *desc,
                  uint32_t irq_id,
                  struct no_os_callback_desc *callback_desc);
 
/* Global interrupt enable */
int no_os_irq_global_enable(struct no_os_irq_ctrl_desc *desc);
 
/* Global interrupt disable */
int no_os_irq_global_disable(struct no_os_irq_ctrl_desc *desc);
 
/* Set interrupt trigger level. */
int no_os_irq_trigger_level_set(struct no_os_irq_ctrl_desc *desc,
                uint32_t irq_id,
                enum no_os_irq_trig_level trig);
 
/* Enable specific interrupt */
int no_os_irq_enable(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id);
 
/* Disable specific interrupt */
int no_os_irq_disable(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id);

int no_os_irq_set_priority(struct no_os_irq_ctrl_desc *desc,
               uint32_t irq_id,
               uint32_t priority_level);

int no_os_irq_get_priority(struct no_os_irq_ctrl_desc *desc,
               uint32_t irq_id,
               uint32_t *priority_level);
 
/* Clear the pending interrupts */
int no_os_irq_clear_pending(struct no_os_irq_ctrl_desc* desc,
                uint32_t irq_id);
#endif // _NO_OS_IRQ_H_