xf_hal_tim.h

浏览该文件的文档.

 
#ifndef __XF_HAL_TIM_H__
#define __XF_HAL_TIM_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_hal_device_config.h"
 
#if XF_HAL_TIM_IS_ENABLE
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
typedef uint32_t xf_tim_num_t;
 
typedef void (*xf_hal_tim_cb_t)(xf_tim_num_t tim_num, uint32_t ticks, void *user_data);
 
typedef struct _xf_hal_tim_callback_t {
    xf_hal_tim_cb_t callback;
    void *user_data;
} xf_hal_tim_callback_t;
 
typedef enum _xf_hal_tim_active_t {
    _XF_HAL_TIM_ACTIVE_BASE = 0,
 
    XF_HAL_TIM_ACTIVE_STOP = _XF_HAL_TIM_ACTIVE_BASE, 
    XF_HAL_TIM_ACTIVE_START,    
    _XF_HAL_TIM_ACTIVE_MAX
} xf_hal_tim_active_t;
 
typedef enum _xf_hal_tim_count_dir_t {
    _XF_HAL_TIM_COUNT_DIR_BASE = 0,
 
    XF_HAL_TIM_COUNT_DIR_UP = _XF_HAL_TIM_COUNT_DIR_BASE, 
    XF_HAL_TIM_COUNT_DIR_DOWN,      
    XF_HAL_TIM_COUNT_DIR_CENTER,    
    _XF_HAL_TIM_COUNT_DIR_MAX
} xf_hal_tim_count_dir_t;
 
typedef enum _xf_hal_tim_cmd_t {
    XF_HAL_TIM_CMD_DEFAULT          = 0,            
    XF_HAL_TIM_CMD_ACTIVE           = 0X1 << 0,     
    XF_HAL_TIM_CMD_AUTO_RELOAD      = 0X1 << 1,     
    XF_HAL_TIM_CMD_COUNT_DIR        = 0X1 << 2,     
    XF_HAL_TIM_CMD_TICK_FREQ_HZ     = 0X1 << 3,     
    XF_HAL_TIM_CMD_TARGET_TICKS     = 0X1 << 4,     
    XF_HAL_TIM_CMD_CB               = 0X1 << 5,     
    XF_HAL_TIM_CMD_ISR              = 0X1 << 6,     
    XF_HAL_TIM_CMD_ALL             = 0x7FFFFFFF,  
} xf_hal_tim_cmd_t;
 
typedef struct _xf_hal_tim_config_t {
    uint32_t active     : 1;    
    uint32_t auto_reload: 1;    
    uint32_t count_dir  : 2;    
    uint32_t reverse    : 28;
    uint32_t tick_freq_hz;      
    uint32_t target_ticks;      
    xf_hal_tim_callback_t cb;   
    xf_hal_tim_callback_t isr;  
} xf_hal_tim_config_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_hal_tim_init(xf_tim_num_t tim_num, uint32_t tick_freq_hz, xf_hal_tim_count_dir_t count_dir,
                         bool auto_reload);
 
xf_err_t xf_hal_tim_deinit(xf_tim_num_t tim_num);
 
xf_err_t xf_hal_tim_set_cb(xf_tim_num_t tim_num, xf_hal_tim_cb_t callback, void *user_data);
 
xf_err_t xf_hal_tim_set_isr(xf_tim_num_t tim_num, xf_hal_tim_cb_t callback, void *user_data);
 
xf_err_t xf_hal_tim_start(xf_tim_num_t tim_num, uint32_t target_ticks);
 
xf_err_t xf_hal_tim_stop(xf_tim_num_t tim_num);
 
xf_err_t xf_hal_tim_set_raw_ticks(xf_tim_num_t tim_num, uint32_t ticks);
 
uint32_t xf_hal_tim_get_raw_ticks(xf_tim_num_t tim_num);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // XF_HAL_TIM_IS_ENABLE
 
#endif // __XF_HAL_TIM_H__