rt-thread/components/drivers/ktime/inc/ktime.h

/*
 * Copyright (c) 2006-2023, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2023-07-10     xqyjlj       The first version.
 */

#ifndef __KTIME_H__
#define __KTIME_H__

#include <stdint.h>
#include <sys/time.h>

#include "rtthread.h"

#define RT_KTIME_RESMUL (1000000UL)

struct rt_ktime_hrtimer
{
    struct rt_object    parent; /**< inherit from rt_object */
    rt_list_t           row;
    void               *parameter;
    unsigned long       init_cnt;
    unsigned long       timeout_cnt;
    rt_err_t            error;
    struct rt_semaphore sem;
    void (*timeout_func)(void *parameter);
};
typedef struct rt_ktime_hrtimer *rt_ktime_hrtimer_t;

/**
 * @brief Get boottime with us precision
 *
 * @param tv: timeval
 * @return rt_err_t
 */
rt_err_t rt_ktime_boottime_get_us(struct timeval *tv);

/**
 * @brief Get boottime with s precision
 *
 * @param t: time_t
 * @return rt_err_t
 */
rt_err_t rt_ktime_boottime_get_s(time_t *t);

/**
 * @brief Get boottime with ns precision
 *
 * @param ts: timespec
 * @return rt_err_t
 */
rt_err_t rt_ktime_boottime_get_ns(struct timespec *ts);

/**
 * @brief Get cputimer resolution
 *
 * @return (resolution * RT_KTIME_RESMUL)
 */
unsigned long rt_ktime_cputimer_getres(void);

/**
 * @brief Get cputimer frequency
 *
 * @return frequency
 */
unsigned long rt_ktime_cputimer_getfrq(void);

/**
 * @brief Get cputimer the value of the cnt counter
 *
 * @return cnt
 */
unsigned long rt_ktime_cputimer_getcnt(void);

/**
 * @brief Get cputimer the cnt value corresponding to 1 os tick
 *
 * @return step
 */
unsigned long rt_ktime_cputimer_getstep(void);

/**
 * @brief Init cputimer
 *
 */
void rt_ktime_cputimer_init(void);

/**
 * @brief Get hrtimer resolution
 *
 * @return (resolution * RT_KTIME_RESMUL)
 */
unsigned long rt_ktime_hrtimer_getres(void);

/**
 * @brief Get hrtimer frequency
 *
 * @return frequency
 */
unsigned long rt_ktime_hrtimer_getfrq(void);

/**
 * @brief Get hrtimer the value of the cnt counter
 *
 * @return cnt
 */
unsigned long rt_ktime_hrtimer_getcnt(void);

/**
 * @brief set hrtimer timeout, when timeout, the timer callback will call timeout
 *
 * @param cnt: hrtimer requires a timing cnt value
 * @param timeout: timeout callback
 * @param param: parameter
 * @return rt_err_t
 */
rt_err_t rt_ktime_hrtimer_settimeout(unsigned long cnt, void (*timeout)(void *param), void *param);

void     rt_ktime_hrtimer_init(rt_ktime_hrtimer_t timer,
                               const char        *name,
                               unsigned long      cnt,
                               rt_uint8_t         flag,
                               void (*timeout)(void *parameter),
                               void *parameter);
rt_err_t rt_ktime_hrtimer_start(rt_ktime_hrtimer_t timer);
rt_err_t rt_ktime_hrtimer_stop(rt_ktime_hrtimer_t timer);
rt_err_t rt_ktime_hrtimer_control(rt_ktime_hrtimer_t timer, int cmd, void *arg);
rt_err_t rt_ktime_hrtimer_detach(rt_ktime_hrtimer_t timer);

rt_inline void rt_ktime_hrtimer_keep_errno(rt_ktime_hrtimer_t timer, rt_err_t err)
{
    RT_ASSERT(timer != RT_NULL);

    timer->error = err;
}

/**
 * @brief sleep by the cputimer cnt value
 *
 * @param cnt: the cputimer cnt value
 * @return rt_err_t
 */
rt_err_t rt_ktime_hrtimer_sleep(unsigned long cnt);

/**
 * @brief sleep by ns
 *
 * @param ns: ns
 * @return rt_err_t
 */
rt_err_t rt_ktime_hrtimer_ndelay(unsigned long ns);

/**
 * @brief sleep by us
 *
 * @param us: us
 * @return rt_err_t
 */
rt_err_t rt_ktime_hrtimer_udelay(unsigned long us);

/**
 * @brief sleep by ms
 *
 * @param ms: ms
 * @return rt_err_t
 */
rt_err_t rt_ktime_hrtimer_mdelay(unsigned long ms);

#endif