xt_timer2.h

浏览该文件的文档.

 
#ifndef __XT_TIMER2_H__
#define __XT_TIMER2_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xtiny.h"
#if (XT_TASK_ENABLE_OS)
#include "cmsis_os2.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

 
/* ==================== [Defines] =========================================== */

#define XT_TIMER2_TIMEOUT_MAX      INT32_MAX
 
#if !defined(XT_TIMER2_DEBUG)
#define XT_TIMER2_DEBUG            1
#endif
 
#if XT_TIMER2_DEBUG
#define XT_TIMER2_MAGIC            (0x159DU)
#endif

#define XT_TIMER2_FREE_MAGIC       ((void *)0xA1B2C3D4)
 
/* ==================== [Typedefs] ========================================== */

typedef uint32_t xt_tick2_t;

typedef struct xt_timer2 xt_timer2_t;

typedef void (*xt_timer2_cb_t)(xt_timer2_t *t, void *user_data);

struct xt_timer2 {
    struct xt_list_node     node;           
    volatile xt_timer2_cb_t cb_func;        
    void                   *user_data;      
    xt_tick2_t              tick_timeout;   
#if XT_TIMER2_DEBUG
    volatile uint16_t       magic;          
#endif
};
 
/* ==================== [Global Prototypes] ================================= */

xt_timer2_t *xt_timer2_new(xt_timer2_cb_t timer_cb, void *user_data);

xt_err_t xt_timer2_delete(xt_timer2_t *t);

xt_err_t xt_timer2_setup(xt_timer2_t *t,
                         xt_timer2_cb_t timer_cb,
                         void *user_data);

xt_err_t xt_timer2_start(xt_timer2_t *t,
                         xt_tick2_t tick_timeout);

xt_err_t xt_timer2_stop(xt_timer2_t *t);

bool xt_timer2_is_running(xt_timer2_t *t);

xt_err_t xt_timer2_set_cb(xt_timer2_t *t, xt_timer2_cb_t cb);

xt_err_t xt_timer2_set_user_data(xt_timer2_t *t, void *user_data);

xt_tick2_t xt_timer2_remain(xt_tick2_t timeout_tick);

xt_tick2_t xt_timer2_handler(void);

void xt_timer2_sys_setup(xt_timer2_t *pool_buf, size_t pool_count);

void xt_timer2_sys_reset(void);

void xt_timer2_enable_custom_tick(bool enable);

void xt_tick2_inc(xt_tick2_t inc);

void xt_tick2_set(xt_tick2_t val);

xt_tick2_t xt_tick2_get(void);
 
/* ==================== [Macros] ============================================ */
  /* xt_timer2 */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XT_TIMER2_H__ */