sdrv_btm.h

Go to the documentation of this file.

 
#ifndef INCLUDE_DRV_XLI_BTM_H
#define INCLUDE_DRV_XLI_BTM_H
 
#include <types.h>
#include <compiler.h>
#include <sdrv_common.h>
#include "../source/btm/sdrv_btm_hw.h"
 
#ifndef ASSEMBLY
 
__BEGIN_CDECLS
 
 
/* btm status */
typedef enum btm_status {
    BTM_STATUS_NULL = 0,
    BTM_STATUS_IDLE,
    BTM_STATUS_BUSY,
    BTM_STATUS_ERR
} btm_status_t;
 
/* btm type*/
typedef enum btm_type {
    BTM_TYPE_ONESHOT = 0,
    BTM_TYPE_PERIOD = 1,
    BTM_TYPE_ERR
} btm_type_t;
 
/* time type*/
typedef enum btm_time_type {
    BTM_TIME_MS = 0,
    BTM_TIME_US = 1,
    BTM_TIME_NS = 2
} btm_time_type_t;
 
 
/* btm callback */
typedef void (*btm_callback)(void *arg);
 
 
/* sdrv btm config */
typedef struct sdrv_btm_cfg {
    uint32_t base;
    int irq;
    sdrv_btm_cnt_id_e tmr_id;
    sdrv_btm_hw_cnt_cfg_t tmr_cfg;
} sdrv_btm_cfg_t;
 
 
/* sdrv btm ctrl */
typedef struct sdrv_btm {
    sdrv_btm_cfg_t  *config;
    btm_status_t     status;
    btm_type_t       type;
    btm_time_type_t  time_type;
    uint32_t         time_out;
    btm_callback     callback;
    void             *arg;
    uint32_t         cnt_per_ms;
} sdrv_btm_t;
 
 
/* sdrv btm controller module */
typedef struct sdrv_btm_controller_module {
    sdrv_btm_t *btm_bank[SDRV_BTM_NUM];
} sdrv_btm_controller_module_t;
 
 
status_t sdrv_btm_init(sdrv_btm_t *ctrl, sdrv_btm_cfg_t *cfg);
 
status_t sdrv_btm_deinit(sdrv_btm_t *ctrl);
 
status_t sdrv_btm_start(sdrv_btm_t *ctrl, btm_type_t btm_type, btm_time_type_t time_type,
                        uint32_t time_out);
 
status_t sdrv_btm_stop(sdrv_btm_t *ctrl);
 
status_t sdrv_btm_set_callback(sdrv_btm_t *ctrl, btm_callback callback, void *arg);
 
uint32_t sdrv_btm_get_current_time(sdrv_btm_t *ctrl);
 
 
uint32_t sdrv_btm_get_current_time_ex(sdrv_btm_t *ctrl, btm_time_type_t time_type);
 
 
status_t sdrv_btm_pause(sdrv_btm_t *ctrl);
 
status_t sdrv_btm_continue(sdrv_btm_t *ctrl);
 
uint32_t sdrv_btm_get_counter(sdrv_btm_t *ctrl);
 
status_t sdrv_btm_set_overflow(sdrv_btm_t *ctrl, uint32_t val);
 
status_t sdrv_btm_force_reload(sdrv_btm_t *ctrl);
 
bool sdrv_btm_is_overflowed(sdrv_btm_t *ctrl);
 
status_t sdrv_btm_clear_intr(sdrv_btm_t *ctrl);
 
uint32_t sdrv_btm_count_to_us(sdrv_btm_t *ctrl, uint32_t cnt);
 
__END_CDECLS
 
#endif
 
#endif