xf_hal_gpio.h

浏览该文件的文档.

 
#ifndef __XF_HAL_GPIO_H__
#define __XF_HAL_GPIO_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_hal_device_config.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
#define XF_HAL_GPIO_NUM_NONE   ((xf_gpio_num_t)-1)
 
/* ==================== [Typedefs] ========================================== */
 
typedef uint32_t xf_gpio_num_t;
 
#if XF_HAL_GPIO_IS_ENABLE
 
typedef void (*xf_hal_gpio_irq_cb_t)(xf_gpio_num_t gpio_num, bool level, void *user_data);
 
typedef enum _xf_hal_gpio_intr_type_t {
    _XF_HAL_GPIO_INTR_BASE = 0,     
    XF_HAL_GPIO_INTR_TYPE_DISABLE = _XF_HAL_GPIO_INTR_BASE, 
    XF_HAL_GPIO_INTR_TYPE_RISING,   
    XF_HAL_GPIO_INTR_TYPE_FALLING,  
    XF_HAL_GPIO_INTR_TYPE_ANY,      
    _XF_HAL_GPIO_INTR_TYPE_MAX,     
} xf_hal_gpio_intr_type_t;
 
typedef enum _xf_hal_gpio_dir_t {
    _XF_HAL_GPIO_DIR_BASE = 0,  
    XF_HAL_GPIO_DIR_IN = _XF_HAL_GPIO_DIR_BASE, 
    XF_HAL_GPIO_DIR_OUT,        
    XF_HAL_GPIO_DIR_OUT_OD,     
    _XF_HAL_GPIO_DIR_MAX        
} xf_hal_gpio_dir_t;
 
typedef enum _xf_hal_gpio_pull_t {
    _XF_HAL_GPIO_PULL_BASE = 0, 
    XF_HAL_GPIO_PULL_NONE = _XF_HAL_GPIO_PULL_BASE, 
    XF_HAL_GPIO_PULL_UP,        
    XF_HAL_GPIO_PULL_DOWN,      
    _XF_HAL_GPIO_PULL_MAX       
} xf_hal_gpio_pull_t;
 
typedef struct _xf_hal_gpio_irq_t {
    xf_hal_gpio_irq_cb_t callback;  
    void *user_data;                
} xf_hal_gpio_callback_t;
 
typedef enum _xf_hal_gpio_cmd_t {
    XF_HAL_GPIO_CMD_DEFAULT     = 0x0,          
    XF_HAL_GPIO_CMD_DIRECTION   = 0x1 << 0,     
    XF_HAL_GPIO_CMD_PULL        = 0x1 << 1,     
    XF_HAL_GPIO_CMD_SPEED       = 0x1 << 2,     
    XF_HAL_GPIO_CMD_INTR_ENABLE = 0x1 << 3,     
    XF_HAL_GPIO_CMD_INTR_TYPE   = 0x1 << 4,     
    XF_HAL_GPIO_CMD_INTR_CB     = 0x1 << 5,     
    XF_HAL_GPIO_CMD_INTR_ISR    = 0x1 << 6,     
    XF_HAL_GPIO_CMD_ALL         = 0x7FFFFFFF,  
} xf_hal_gpio_cmd_t;
 
typedef struct _xf_hal_gpio_config_t {
    uint32_t direction      : 2;    
    uint32_t pull           : 2;    
    uint32_t speed          : 25;   
    uint32_t intr_enable    : 1;    
    uint32_t intr_type      : 2;    
    xf_hal_gpio_callback_t cb;      
    xf_hal_gpio_callback_t isr;     
} xf_hal_gpio_config_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_hal_gpio_init(xf_gpio_num_t gpio_num, xf_hal_gpio_dir_t direction);
 
xf_err_t xf_hal_gpio_deinit(xf_gpio_num_t gpio_num);
 
xf_err_t xf_hal_gpio_set_direction(xf_gpio_num_t gpio_num, xf_hal_gpio_dir_t direction);
 
xf_err_t xf_hal_gpio_set_pull(xf_gpio_num_t gpio_num, xf_hal_gpio_pull_t pull);
 
xf_err_t xf_hal_gpio_set_speed(xf_gpio_num_t gpio_num, uint32_t speed);
 
xf_err_t xf_hal_gpio_set_intr_cb(xf_gpio_num_t gpio_num, xf_hal_gpio_irq_cb_t callback, void *user_data);
 
xf_err_t xf_hal_gpio_set_intr_isr(xf_gpio_num_t gpio_num, xf_hal_gpio_irq_cb_t callback, void *user_data);
 
xf_err_t xf_hal_gpio_set_intr_type(xf_gpio_num_t gpio_num, xf_hal_gpio_intr_type_t intr_type);
 
xf_err_t xf_hal_gpio_set_intr_enable(xf_gpio_num_t gpio_num);
 
xf_err_t xf_hal_gpio_set_intr_disable(xf_gpio_num_t gpio_num);
 
xf_err_t xf_hal_gpio_set_level(xf_gpio_num_t gpio_num, bool level);
 
bool xf_hal_gpio_get_level(xf_gpio_num_t gpio_num);
 
/* ==================== [Macros] ============================================ */
 
#endif // XF_HAL_GPIO_IS_ENABLE
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // __XF_HAL_GPIO_H__