xt_hal_timer.h

浏览该文件的文档.

 
#ifndef __XT_HAL_TIMER_H__
#define __XT_HAL_TIMER_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xt_hal_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */
 
#define XT_HAL_TIMER_INVALID_ID (0xFFFF)
 
#define XT_HAL_TIMER_ACTIVE_BITS_S        (0) // [0..0]
#define XT_HAL_TIMER_ACTIVE_BITS_W        (1)
#define XT_HAL_TIMER_AUTO_RELOAD_BITS_S   (1) // [1..1]
#define XT_HAL_TIMER_AUTO_RELOAD_BITS_W   (1)
#define XT_HAL_TIMER_DIR_BITS_S           (2) // [2..2]
#define XT_HAL_TIMER_DIR_BITS_W           (2)
 
#define XT_HAL_TIMER_START                (0x00 << XT_HAL_TIMER_ACTIVE_BITS_S)      
#define XT_HAL_TIMER_STOP                 (0x01 << XT_HAL_TIMER_ACTIVE_BITS_S)      
#define XT_HAL_TIMER_ONE_SHOT             (0x00 << XT_HAL_TIMER_AUTO_RELOAD_BITS_S) 
#define XT_HAL_TIMER_PERIODIC             (0x01 << XT_HAL_TIMER_AUTO_RELOAD_BITS_S) 
#define XT_HAL_TIMER_DIR_UP               (0x00 << XT_HAL_TIMER_DIR_BITS_S)        
#define XT_HAL_TIMER_DIR_DOWN             (0x01 << XT_HAL_TIMER_DIR_BITS_S)        
#define XT_HAL_TIMER_DEFAULT_MODE         (XT_HAL_TIMER_PERIODIC | XT_HAL_TIMER_DIR_UP | XT_HAL_TIMER_START) 
 
/* ==================== [Typedefs] ========================================== */

enum xt_hal_timer_event_id {
    XT_HAL_TIMER_EVENT_TIMEOUT = 0x00, 
};

typedef void (*xt_hal_timer_cb_t)(uint8_t timer_id, uint32_t event_id);
 
/* ==================== [Global Prototypes] ================================= */

xt_err_t xt_hal_timer_setup(uint8_t timer_id,
                            uint32_t mode,
                            uint32_t tick_freq_hz,
                            uint32_t tick_num,
                            xt_hal_timer_cb_t cb);

xt_err_t xt_hal_timer_close(uint8_t timer_id);

xt_err_t xt_hal_timer_start(uint8_t timer_id);

xt_err_t xt_hal_timer_stop(uint8_t timer_id);

uint32_t xt_hal_timer_get_clk_src_freq(uint8_t timer_id);

uint32_t xt_hal_timer_get_prescaler(uint8_t timer_id);

uint32_t xt_hal_timer_get_count(uint8_t timer_id);
 
/* ==================== [Macros] ============================================ */
  /* xt_hal_timer */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_HAL_TIMER_H__ */