no_os_irq.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_IRQ_H_
#define _NO_OS_IRQ_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
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_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
};
 
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_peripheral {
    NO_OS_GPIO_IRQ,
    NO_OS_UART_IRQ,
    NO_OS_RTC_IRQ,
    NO_OS_TIM_IRQ
};
 
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_ctrl_desc {
    uint32_t    irq_ctrl_id;
    const struct no_os_irq_platform_ops *platform_ops;
    void        *extra;
};
 
struct no_os_callback_desc {
    void (*callback)(void *context);
    void (*legacy_callback)(void *ctx, uint32_t event,
                void *extra); /* TODO: remove this. */
    void *ctx;
    void *legacy_config; /* TODO: remove this. */
    enum no_os_irq_event event;
    enum no_os_irq_peripheral peripheral;
    void *handle;
};
 
struct no_os_irq_platform_ops {
    int32_t (*init)(struct no_os_irq_ctrl_desc **desc,
            const struct no_os_irq_init_param *param);
    int32_t (*register_callback)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id,
                     struct no_os_callback_desc *callback);
    int32_t (*unregister_callback)(struct no_os_irq_ctrl_desc *desc,
                       uint32_t irq_id,
                       struct no_os_callback_desc *callback);
    int32_t (*global_enable)(struct no_os_irq_ctrl_desc *desc);
    int32_t (*global_disable)(struct no_os_irq_ctrl_desc *desc);
    int32_t (*trigger_level_set)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id,
                     enum no_os_irq_trig_level trig);
    int32_t (*enable)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id);
    int32_t (*disable)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id);
    int32_t (*set_priority)(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id,
                uint32_t priority_level);
    int32_t (*remove)(struct no_os_irq_ctrl_desc *desc);
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
/* Initialize a interrupt controller peripheral. */
int32_t 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(). */
int32_t no_os_irq_ctrl_remove(struct no_os_irq_ctrl_desc *desc);
 
/* Register a callback to handle the irq events */
int32_t 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 */
int32_t 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 */
int32_t no_os_irq_global_enable(struct no_os_irq_ctrl_desc *desc);
 
/* Global interrupt disable */
int32_t no_os_irq_global_disable(struct no_os_irq_ctrl_desc *desc);
 
/* Set interrupt trigger level. */
int32_t 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 */
int32_t no_os_irq_enable(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id);
 
/* Disable specific interrupt */
int32_t no_os_irq_disable(struct no_os_irq_ctrl_desc *desc, uint32_t irq_id);
 
int32_t no_os_irq_set_priority(struct no_os_irq_ctrl_desc *desc,
                   uint32_t irq_id,
                   uint32_t priority_level);
#endif // _NO_OS_IRQ_H_