no_os_timer.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_SRC_TIMER_H_
#define _NO_OS_SRC_TIMER_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
#define TIMER_MAX_TABLE 4
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
struct no_os_timer_desc {
    void *mutex;
    uint16_t id;
    uint32_t freq_hz;
    uint32_t ticks_count;
    const struct no_os_timer_platform_ops *platform_ops;
    void *extra;
};
 
struct no_os_timer_platform_ops ;
 
struct no_os_timer_init_param {
    uint16_t id;
    uint32_t freq_hz;
    uint32_t ticks_count;
    const struct no_os_timer_platform_ops *platform_ops;
    void *extra;
};
 
struct no_os_timer_platform_ops {
    int32_t (*init)(struct no_os_timer_desc **,
            const struct no_os_timer_init_param *);
    int32_t (*start)(struct no_os_timer_desc *);
    int32_t (*stop)(struct no_os_timer_desc *);
    int32_t (*counter_get)(struct no_os_timer_desc *, uint32_t *counter);
    int32_t (*counter_set)(struct no_os_timer_desc *, uint32_t new_val);
    int32_t (*count_clk_get)(struct no_os_timer_desc *, uint32_t *freq_hz);
    int32_t (*count_clk_set)(struct no_os_timer_desc *, uint32_t freq_hz);
    int32_t (*get_elapsed_time_nsec)(struct no_os_timer_desc *,
                     uint64_t *elapsed_time);
    int32_t (*remove)(struct no_os_timer_desc *);
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
/* Initialize hardware timer and the handler structure associated with it. */
int32_t no_os_timer_init(struct no_os_timer_desc **desc,
             const struct no_os_timer_init_param *param);
 
/* Free the memory allocated by timer_setup(). */
int32_t no_os_timer_remove(struct no_os_timer_desc *desc);
 
/* Start a timer. */
int32_t no_os_timer_start(struct no_os_timer_desc *desc);
 
/* Stop a timer from counting. */
int32_t no_os_timer_stop(struct no_os_timer_desc *desc);
 
/* Get the value of the counter register for the timer. */
int32_t no_os_timer_counter_get(struct no_os_timer_desc *desc,
                uint32_t *counter);
 
/* Set the timer counter register value. */
int32_t no_os_timer_counter_set(struct no_os_timer_desc *desc,
                uint32_t new_val);
 
/* Get the timer clock frequency. */
int32_t no_os_timer_count_clk_get(struct no_os_timer_desc *desc,
                  uint32_t *freq_hz);
 
/* Set the timer clock frequency. */
int32_t no_os_timer_count_clk_set(struct no_os_timer_desc *desc,
                  uint32_t freq_hz);
 
/* Get the elapsed time in nsec for the timer. */
int32_t no_os_timer_get_elapsed_time_nsec(struct no_os_timer_desc *desc,
        uint64_t *elapsed_time);
 
#endif // _NO_OS_SRC_TIMER_H_