Clock and Timer Management 的协作图:

结构体
struct	rt_timer

宏定义
#define	_update_process_times(tick)

#define	RT_TIMER_FLAG_DEACTIVATED 0x0

#define	RT_TIMER_FLAG_ACTIVATED 0x1

#define	RT_TIMER_FLAG_ONE_SHOT 0x0

#define	RT_TIMER_FLAG_PERIODIC 0x2

#define	RT_TIMER_FLAG_HARD_TIMER 0x0

#define	RT_TIMER_FLAG_SOFT_TIMER 0x4

#define	RT_TIMER_FLAG_THREAD_TIMER (0x8 \| RT_TIMER_FLAG_HARD_TIMER)

#define	RT_TIMER_CTRL_SET_TIME 0x0

#define	RT_TIMER_CTRL_GET_TIME 0x1

#define	RT_TIMER_CTRL_SET_ONESHOT 0x2

#define	RT_TIMER_CTRL_SET_PERIODIC 0x3

#define	RT_TIMER_CTRL_GET_STATE 0x4

#define	RT_TIMER_CTRL_GET_REMAIN_TIME 0x5

#define	RT_TIMER_CTRL_GET_FUNC 0x6

#define	RT_TIMER_CTRL_SET_FUNC 0x7

#define	RT_TIMER_CTRL_GET_PARM 0x8

#define	RT_TIMER_CTRL_SET_PARM 0x9

#define	RT_TIMER_SKIP_LIST_LEVEL 1

#define	RT_TIMER_SKIP_LIST_MASK 0x3

类型定义
typedef void(*	rt_timer_func_t) (void *parameter)

typedef struct rt_timer *	rt_timer_t

函数
rt_tick_t	rt_tick_get (void)

	RTM_EXPORT (rt_tick_get)

void	rt_tick_set (rt_tick_t tick)

void	rt_tick_increase (void)

void	rt_tick_increase_tick (rt_tick_t tick)

rt_tick_t	rt_tick_from_millisecond (rt_int32_t ms)

	RTM_EXPORT (rt_tick_from_millisecond)

rt_weak rt_tick_t	rt_tick_get_millisecond (void)

void	rt_timer_init (rt_timer_t timer, const char name, void(timeout)(void parameter), void parameter, rt_tick_t time, rt_uint8_t flag)

	RTM_EXPORT (rt_timer_init)

rt_err_t	rt_timer_detach (rt_timer_t timer)

	RTM_EXPORT (rt_timer_detach)

rt_timer_t	rt_timer_create (const char name, void(timeout)(void parameter), void parameter, rt_tick_t time, rt_uint8_t flag)

	RTM_EXPORT (rt_timer_create)

rt_err_t	rt_timer_delete (rt_timer_t timer)

	RTM_EXPORT (rt_timer_delete)

rt_err_t	rt_timer_start (rt_timer_t timer)

	RTM_EXPORT (rt_timer_start)

rt_err_t	rt_timer_stop (rt_timer_t timer)

	RTM_EXPORT (rt_timer_stop)

rt_err_t	rt_timer_control (rt_timer_t timer, int cmd, void *arg)

	RTM_EXPORT (rt_timer_control)

void	rt_timer_check (void)

rt_tick_t	rt_timer_next_timeout_tick (void)

void	rt_tick_sethook (void(*hook)(void))

void	rt_system_timer_init (void)

void	rt_system_timer_thread_init (void)

void	rt_timer_enter_sethook (void(hook)(struct rt_timer timer))

void	rt_timer_exit_sethook (void(hook)(struct rt_timer timer))

详细描述

clock and system timer management

RT-Thread uses clock tick to implement shared time-slice scheduling.

The timing sensitivity of thread is implemented by timers. The timer can be set as one-shot or periodic timeout.

宏定义说明

◆ _update_process_times

#define _update_process_times ( tick )

在文件 clock.c 第 113 行定义.

◆ RT_TIMER_FLAG_DEACTIVATED

#define RT_TIMER_FLAG_DEACTIVATED 0x0

clock & timer macros timer is deactive

在文件 rtdef.h 第 524 行定义.

◆ RT_TIMER_FLAG_ACTIVATED

#define RT_TIMER_FLAG_ACTIVATED 0x1

timer is active

在文件 rtdef.h 第 525 行定义.

◆ RT_TIMER_FLAG_ONE_SHOT

#define RT_TIMER_FLAG_ONE_SHOT 0x0

one shot timer

在文件 rtdef.h 第 526 行定义.

◆ RT_TIMER_FLAG_PERIODIC

#define RT_TIMER_FLAG_PERIODIC 0x2

periodic timer

在文件 rtdef.h 第 527 行定义.

◆ RT_TIMER_FLAG_HARD_TIMER

#define RT_TIMER_FLAG_HARD_TIMER 0x0

hard timer,the timer's callback function will be called in tick isr.

在文件 rtdef.h 第 529 行定义.

◆ RT_TIMER_FLAG_SOFT_TIMER

#define RT_TIMER_FLAG_SOFT_TIMER 0x4

soft timer,the timer's callback function will be called in timer thread.

在文件 rtdef.h 第 530 行定义.

◆ RT_TIMER_FLAG_THREAD_TIMER

#define RT_TIMER_FLAG_THREAD_TIMER (0x8 | RT_TIMER_FLAG_HARD_TIMER)

thread timer that cooperates with scheduler directly

在文件 rtdef.h 第 531 行定义.

531#define RT_TIMER_FLAG_THREAD_TIMER \

532 (0x8 | RT_TIMER_FLAG_HARD_TIMER)

◆ RT_TIMER_CTRL_SET_TIME

#define RT_TIMER_CTRL_SET_TIME 0x0

set timer control command

在文件 rtdef.h 第 534 行定义.

◆ RT_TIMER_CTRL_GET_TIME

#define RT_TIMER_CTRL_GET_TIME 0x1

get timer control command

在文件 rtdef.h 第 535 行定义.

◆ RT_TIMER_CTRL_SET_ONESHOT

#define RT_TIMER_CTRL_SET_ONESHOT 0x2

change timer to one shot

在文件 rtdef.h 第 536 行定义.

◆ RT_TIMER_CTRL_SET_PERIODIC

#define RT_TIMER_CTRL_SET_PERIODIC 0x3

change timer to periodic

在文件 rtdef.h 第 537 行定义.

◆ RT_TIMER_CTRL_GET_STATE

#define RT_TIMER_CTRL_GET_STATE 0x4

get timer run state active or deactive

在文件 rtdef.h 第 538 行定义.

◆ RT_TIMER_CTRL_GET_REMAIN_TIME

#define RT_TIMER_CTRL_GET_REMAIN_TIME 0x5

get the remaining hang time

在文件 rtdef.h 第 539 行定义.

◆ RT_TIMER_CTRL_GET_FUNC

#define RT_TIMER_CTRL_GET_FUNC 0x6

get timer timeout func

在文件 rtdef.h 第 540 行定义.

◆ RT_TIMER_CTRL_SET_FUNC

#define RT_TIMER_CTRL_SET_FUNC 0x7

set timer timeout func

在文件 rtdef.h 第 541 行定义.

◆ RT_TIMER_CTRL_GET_PARM

#define RT_TIMER_CTRL_GET_PARM 0x8

get timer parameter

在文件 rtdef.h 第 542 行定义.

◆ RT_TIMER_CTRL_SET_PARM

#define RT_TIMER_CTRL_SET_PARM 0x9

get timer parameter

在文件 rtdef.h 第 543 行定义.

◆ RT_TIMER_SKIP_LIST_LEVEL

#define RT_TIMER_SKIP_LIST_LEVEL 1

在文件 rtdef.h 第 546 行定义.

◆ RT_TIMER_SKIP_LIST_MASK

#define RT_TIMER_SKIP_LIST_MASK 0x3

Timer skips the list mask

在文件 rtdef.h 第 551 行定义.

类型定义说明

◆ rt_timer_func_t

typedef void(* rt_timer_func_t) (void *parameter)

timeout handler of rt_timer

在文件 rtdef.h 第 557 行定义.

◆ rt_timer_t

typedef struct rt_timer* rt_timer_t

在文件 rtdef.h 第 574 行定义.

函数说明

◆ rt_tick_get()

rt_tick_t rt_tick_get ( void )

This function will return current tick from operating system startup.

返回: Return current tick.

在文件 clock.c 第 69 行定义.

{
    /* return the global tick */
    return (rt_tick_t)rt_atomic_load(&(rt_tick));
}

引用了 rt_atomic_load.

这是这个函数的调用关系图:

◆ RTM_EXPORT() [1/9]

RTM_EXPORT ( rt_tick_get )

引用了 rt_tick_get().

函数调用图:

◆ rt_tick_set()

void rt_tick_set ( rt_tick_t tick )

This function will set current tick.

参数

tick	is the value that you will set.

在文件 clock.c 第 81 行定义.

{
    rt_atomic_store(&(rt_tick), tick);
}

引用了 rt_atomic_store.

◆ rt_tick_increase()

void rt_tick_increase ( void )

This function will notify kernel there is one tick passed. Normally, this function is invoked by clock ISR.

在文件 clock.c 第 120 行定义.

{
    RT_ASSERT(rt_interrupt_get_nest() > 0);
 
    RT_OBJECT_HOOK_CALL(rt_tick_hook, ());
 
    /* tracing cpu usage */
    _update_process_times(1);
 
    /* increase the global tick */
#ifdef RT_USING_SMP
    /* get percpu and increase the tick */
    rt_atomic_add(&(rt_cpu_self()->tick), 1);
#else
    rt_atomic_add(&(rt_tick), 1);
#endif /* RT_USING_SMP */
 
    /* check time slice */
    rt_sched_tick_increase(1);
 
    /* check timer */
#ifdef RT_USING_SMP
    if (rt_cpu_get_id() != 0)
    {
        return;
    }
#endif
    rt_timer_check();
}

引用了 _update_process_times, RT_ASSERT, rt_atomic_add, rt_cpu_get_id, rt_cpu_self(), rt_interrupt_get_nest(), RT_OBJECT_HOOK_CALL, rt_sched_tick_increase() , 以及 rt_timer_check().

函数调用图:

◆ rt_tick_increase_tick()

void rt_tick_increase_tick ( rt_tick_t tick )

This function will notify kernel there is n tick passed. Normally, this function is invoked by clock ISR.

在文件 clock.c 第 154 行定义.

{
    RT_ASSERT(rt_interrupt_get_nest() > 0);
 
    RT_OBJECT_HOOK_CALL(rt_tick_hook, ());
 
    /* tracing cpu usage */
    _update_process_times(tick);
 
    /* increase the global tick */
#ifdef RT_USING_SMP
    /* get percpu and increase the tick */
    rt_atomic_add(&(rt_cpu_self()->tick), tick);
#else
    rt_atomic_add(&(rt_tick), tick);
#endif /* RT_USING_SMP */
 
    /* check time slice */
    rt_sched_tick_increase(tick);
 
    /* check timer */
#ifdef RT_USING_SMP
    if (rt_cpu_get_id() != 0)
    {
        return;
    }
#endif
    rt_timer_check();
 
#ifdef RT_USING_VDSO
    rt_vdso_update_glob_time();
#endif
}

引用了 _update_process_times, RT_ASSERT, rt_atomic_add, rt_cpu_get_id, rt_cpu_self(), rt_interrupt_get_nest(), RT_OBJECT_HOOK_CALL, rt_sched_tick_increase() , 以及 rt_timer_check().

函数调用图:

◆ rt_tick_from_millisecond()

rt_tick_t rt_tick_from_millisecond ( rt_int32_t ms )

This function will calculate the tick from millisecond.

参数

ms	is the specified millisecond. Negative Number wait forever Zero not wait Max 0x7fffffff

返回: Return the calculated tick.

在文件 clock.c 第 198 行定义.

{
    rt_tick_t tick;
 
    if (ms < 0)
    {
        tick = (rt_tick_t)RT_WAITING_FOREVER;
    }
    else
    {
#if RT_TICK_PER_SECOND == 1000u
        tick = ms;
#else
        tick = RT_TICK_PER_SECOND * (ms / 1000);
        tick += (RT_TICK_PER_SECOND * (ms % 1000) + 999) / 1000;
#endif /* RT_TICK_PER_SECOND == 1000u */
    }
 
    /* return the calculated tick */
    return tick;
}

引用了 RT_WAITING_FOREVER.

这是这个函数的调用关系图:

◆ RTM_EXPORT() [2/9]

RTM_EXPORT ( rt_tick_from_millisecond )

引用了 rt_tick_from_millisecond().

函数调用图:

◆ rt_tick_get_millisecond()

rt_tick_t rt_tick_get_millisecond ( void )

This function will return the passed millisecond from boot.

注解: if the value of RT_TICK_PER_SECOND is lower than 1000 or is not an integral multiple of 1000, this function will not provide the correct 1ms-based tick.

返回: Return passed millisecond from boot.

在文件 clock.c 第 230 行定义.

{
#if RT_TICK_PER_SECOND == 0 /* make cppcheck happy*/
#error "RT_TICK_PER_SECOND must be greater than zero"
#endif
 
#if 1000 % RT_TICK_PER_SECOND == 0u
    return rt_tick_get() * (1000u / RT_TICK_PER_SECOND);
#else
    #warning "rt-thread cannot provide a correct 1ms-based tick any longer,\
    please redefine this function in another file by using a high-precision hard-timer."
    return 0;
#endif /* 1000 % RT_TICK_PER_SECOND == 0u */
}

引用了 rt_tick_get().

函数调用图:

◆ rt_timer_init()

void rt_timer_init	(	rt_timer_t	timer,
		const char *	name,
		void(*	timeout )(void *parameter),
		void *	parameter,
		rt_tick_t	time,
		rt_uint8_t	flag )

This function will initialize a timer normally this function is used to initialize a static timer object.

参数

timer	is the point of timer
name	is a pointer to the name of the timer
timeout	is the callback of timer
parameter	is the param of the callback
time	is timeout ticks of timer NOTE: The max timeout tick should be no more than (RT_TICK_MAX/2 - 1).
flag	is the flag of timer

在文件 timer.c 第 267 行定义.

{
    /* parameter check */
    RT_ASSERT(timer != RT_NULL);
    RT_ASSERT(timeout != RT_NULL);
    RT_ASSERT(time < RT_TICK_MAX / 2);
 
    /* timer object initialization */
    rt_object_init(&(timer->parent), RT_Object_Class_Timer, name);
 
    _timer_init(timer, timeout, parameter, time, flag);
}

引用了 rt_timer::parameter, rt_timer::parent, RT_ASSERT, RT_NULL, RT_Object_Class_Timer, rt_object_init() , 以及 RT_TICK_MAX.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [3/9]

RTM_EXPORT ( rt_timer_init )

引用了 rt_timer_init().

函数调用图:

◆ rt_timer_detach()

rt_err_t rt_timer_detach ( rt_timer_t timer )

This function will detach a timer from timer management.

参数

timer is the timer to be detached

返回: the status of detach

在文件 timer.c 第 293 行定义.

{
    rt_base_t level;
    struct rt_spinlock *spinlock;
 
    /* parameter check */
    RT_ASSERT(timer != RT_NULL);
    RT_ASSERT(rt_object_get_type(&timer->parent) == RT_Object_Class_Timer);
    RT_ASSERT(rt_object_is_systemobject(&timer->parent));
 
    spinlock = _timerlock_idx(timer);
    level = rt_spin_lock_irqsave(spinlock);
 
    _timer_remove(timer);
    /* stop timer */
    timer->parent.flag &= ~RT_TIMER_FLAG_ACTIVATED;
 
    rt_spin_unlock_irqrestore(spinlock, level);
    rt_object_detach(&(timer->parent));
 
    return RT_EOK;
}

引用了 _timer_remove(), _timerlock_idx(), rt_object::flag, rt_timer::parent, RT_ASSERT, RT_NULL, RT_Object_Class_Timer, rt_object_detach(), rt_object_get_type(), rt_object_is_systemobject(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore() , 以及 RT_TIMER_FLAG_ACTIVATED.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [4/9]

RTM_EXPORT ( rt_timer_detach )

引用了 rt_timer_detach().

函数调用图:

◆ rt_timer_create()

rt_timer_t rt_timer_create	(	const char *	name,
		void(*	timeout )(void *parameter),
		void *	parameter,
		rt_tick_t	time,
		rt_uint8_t	flag )

This function will create a timer

参数

name	is the name of timer
timeout	is the timeout function
parameter	is the parameter of timeout function
time	is timeout ticks of the timer NOTE: The max timeout tick should be no more than (RT_TICK_MAX/2 - 1).
flag	is the flag of timer. Timer will invoke the timeout function according to the selected values of flag, if one or more of the following flags is set. RT_TIMER_FLAG_ONE_SHOT One shot timing RT_TIMER_FLAG_PERIODIC Periodic timing RT_TIMER_FLAG_HARD_TIMER Hardware timer RT_TIMER_FLAG_SOFT_TIMER Software timer RT_TIMER_FLAG_THREAD_TIMER Thread timer NOTE: You can use multiple values with "\|" logical operator. By default, system will use the RT_TIME_FLAG_HARD_TIMER.

返回: the created timer object

在文件 timer.c 第 345 行定义.

{
    struct rt_timer *timer;
 
    /* parameter check */
    RT_ASSERT(timeout != RT_NULL);
    RT_ASSERT(time < RT_TICK_MAX / 2);
 
    /* allocate a object */
    timer = (struct rt_timer *)rt_object_allocate(RT_Object_Class_Timer, name);
    if (timer == RT_NULL)
    {
        return RT_NULL;
    }
 
    _timer_init(timer, timeout, parameter, time, flag);
 
    return timer;
}

引用了 rt_timer::parameter, RT_ASSERT, RT_NULL, rt_object_allocate(), RT_Object_Class_Timer , 以及 RT_TICK_MAX.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [5/9]

RTM_EXPORT ( rt_timer_create )

引用了 rt_timer_create().

函数调用图:

◆ rt_timer_delete()

rt_err_t rt_timer_delete ( rt_timer_t timer )

This function will delete a timer and release timer memory

参数

timer the timer to be deleted

返回: the operation status, RT_EOK on OK; -RT_ERROR on error

在文件 timer.c 第 377 行定义.

{
    rt_base_t level;
    struct rt_spinlock *spinlock;
 
    /* parameter check */
    RT_ASSERT(timer != RT_NULL);
    RT_ASSERT(rt_object_get_type(&timer->parent) == RT_Object_Class_Timer);
    RT_ASSERT(rt_object_is_systemobject(&timer->parent) == RT_FALSE);
 
    spinlock = _timerlock_idx(timer);
 
    level = rt_spin_lock_irqsave(spinlock);
 
    _timer_remove(timer);
    /* stop timer */
    timer->parent.flag &= ~RT_TIMER_FLAG_ACTIVATED;
    rt_spin_unlock_irqrestore(spinlock, level);
    rt_object_delete(&(timer->parent));
 
    return RT_EOK;
}

引用了 _timer_remove(), _timerlock_idx(), rt_object::flag, rt_timer::parent, RT_ASSERT, RT_FALSE, RT_NULL, RT_Object_Class_Timer, rt_object_delete(), rt_object_get_type(), rt_object_is_systemobject(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore() , 以及 RT_TIMER_FLAG_ACTIVATED.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [6/9]

RTM_EXPORT ( rt_timer_delete )

引用了 rt_timer_delete(), RT_TIMER_FLAG_ACTIVATED , 以及 RT_TIMER_SKIP_LIST_LEVEL.

函数调用图:

◆ rt_timer_start()

rt_err_t rt_timer_start ( rt_timer_t timer )

This function will start the timer

参数

timer the timer to be started

返回: the operation status, RT_EOK on OK, -RT_ERROR on error

在文件 timer.c 第 562 行定义.

{
    rt_sched_lock_level_t slvl;
    int is_thread_timer = 0;
    struct rt_spinlock *spinlock;
    rt_list_t *timer_list;
    rt_base_t level;
    rt_err_t err;
 
    /* parameter check */
    RT_ASSERT(timer != RT_NULL);
    RT_ASSERT(rt_object_get_type(&timer->parent) == RT_Object_Class_Timer);
 
#ifdef RT_USING_TIMER_ALL_SOFT
    timer_list = _soft_timer_list;
    spinlock = &_stimer_lock;
#else
#ifdef RT_USING_TIMER_SOFT
    if (timer->parent.flag & RT_TIMER_FLAG_SOFT_TIMER)
    {
        timer_list = _soft_timer_list;
        spinlock = &_stimer_lock;
    }
    else
#endif /* RT_USING_TIMER_SOFT */
    {
        timer_list = _timer_list;
        spinlock = &_htimer_lock;
    }
#endif
 
    if (timer->parent.flag & RT_TIMER_FLAG_THREAD_TIMER)
    {
        rt_thread_t thread;
        is_thread_timer = 1;
        rt_sched_lock(&slvl);
 
        thread = rt_container_of(timer, struct rt_thread, thread_timer);
        RT_ASSERT(rt_object_get_type(&thread->parent) == RT_Object_Class_Thread);
        rt_sched_thread_timer_start(thread);
    }
 
    level = rt_spin_lock_irqsave(spinlock);
 
    err = _timer_start(timer_list, timer);
 
    rt_spin_unlock_irqrestore(spinlock, level);
 
    if (is_thread_timer)
    {
        rt_sched_unlock(slvl);
    }
 
    return err;
}

引用了 rt_object::flag, rt_thread::parent, rt_timer::parent, RT_ASSERT, rt_container_of, RT_NULL, RT_Object_Class_Thread, RT_Object_Class_Timer, rt_object_get_type(), rt_sched_lock(), rt_sched_thread_timer_start(), rt_sched_unlock(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore(), RT_TIMER_FLAG_SOFT_TIMER , 以及 RT_TIMER_FLAG_THREAD_TIMER.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [7/9]

RTM_EXPORT ( rt_timer_start )

引用了 rt_timer_start().

函数调用图:

◆ rt_timer_stop()

rt_err_t rt_timer_stop ( rt_timer_t timer )

This function will stop the timer

参数

timer the timer to be stopped

返回: the operation status, RT_EOK on OK, -RT_ERROR on error

在文件 timer.c 第 626 行定义.

{
    rt_base_t level;
    struct rt_spinlock *spinlock;
 
    /* timer check */
    RT_ASSERT(timer != RT_NULL);
    RT_ASSERT(rt_object_get_type(&timer->parent) == RT_Object_Class_Timer);
 
    spinlock = _timerlock_idx(timer);
 
    level = rt_spin_lock_irqsave(spinlock);
 
    if (!(timer->parent.flag & RT_TIMER_FLAG_ACTIVATED))
    {
        rt_spin_unlock_irqrestore(spinlock, level);
        return -RT_ERROR;
    }
    RT_OBJECT_HOOK_CALL(rt_object_put_hook, (&(timer->parent)));
 
    _timer_remove(timer);
    /* change status */
    timer->parent.flag &= ~RT_TIMER_FLAG_ACTIVATED;
 
    rt_spin_unlock_irqrestore(spinlock, level);
 
    return RT_EOK;
}

引用了 _timer_remove(), _timerlock_idx(), rt_object::flag, rt_timer::parent, RT_ASSERT, RT_NULL, RT_Object_Class_Timer, rt_object_get_type(), RT_OBJECT_HOOK_CALL, rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore() , 以及 RT_TIMER_FLAG_ACTIVATED.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [8/9]

RTM_EXPORT ( rt_timer_stop )

引用了 rt_timer_stop().

函数调用图:

◆ rt_timer_control()

rt_err_t rt_timer_control	(	rt_timer_t	timer,
		int	cmd,
		void *	arg )

This function will get or set some options of the timer

参数

timer	the timer to be get or set
cmd	the control command
arg	the argument

返回: the statu of control

在文件 timer.c 第 665 行定义.

{
    struct rt_spinlock *spinlock;
    rt_base_t level;
 
    /* parameter check */
    RT_ASSERT(timer != RT_NULL);
    RT_ASSERT(rt_object_get_type(&timer->parent) == RT_Object_Class_Timer);
 
    spinlock = _timerlock_idx(timer);
 
    level = rt_spin_lock_irqsave(spinlock);
    switch (cmd)
    {
    case RT_TIMER_CTRL_GET_TIME:
        *(rt_tick_t *)arg = timer->init_tick;
        break;
 
    case RT_TIMER_CTRL_SET_TIME:
        RT_ASSERT((*(rt_tick_t *)arg) < RT_TICK_MAX / 2);
        if (timer->parent.flag & RT_TIMER_FLAG_ACTIVATED)
        {
            _timer_remove(timer);
            timer->parent.flag &= ~RT_TIMER_FLAG_ACTIVATED;
        }
        timer->init_tick = *(rt_tick_t *)arg;
        break;
 
    case RT_TIMER_CTRL_SET_ONESHOT:
        timer->parent.flag &= ~RT_TIMER_FLAG_PERIODIC;
        break;
 
    case RT_TIMER_CTRL_SET_PERIODIC:
        timer->parent.flag |= RT_TIMER_FLAG_PERIODIC;
        break;
 
    case RT_TIMER_CTRL_GET_STATE:
        if(timer->parent.flag & RT_TIMER_FLAG_ACTIVATED)
        {
            /*timer is start and run*/
            *(rt_uint32_t *)arg = RT_TIMER_FLAG_ACTIVATED;
        }
        else
        {
            /*timer is stop*/
            *(rt_uint32_t *)arg = RT_TIMER_FLAG_DEACTIVATED;
        }
        break;
 
    case RT_TIMER_CTRL_GET_REMAIN_TIME:
        *(rt_tick_t *)arg =  timer->timeout_tick;
        break;
    case RT_TIMER_CTRL_GET_FUNC:
        *(void **)arg = (void *)timer->timeout_func;
        break;
 
    case RT_TIMER_CTRL_SET_FUNC:
        timer->timeout_func = (void (*)(void*))arg;
        break;
 
    case RT_TIMER_CTRL_GET_PARM:
        *(void **)arg = timer->parameter;
        break;
 
    case RT_TIMER_CTRL_SET_PARM:
        timer->parameter = arg;
        break;
 
    default:
        break;
    }
    rt_spin_unlock_irqrestore(spinlock, level);
 
    return RT_EOK;
}

引用了 _timer_remove(), _timerlock_idx(), rt_object::flag, rt_timer::init_tick, rt_timer::parameter, rt_timer::parent, RT_ASSERT, RT_NULL, RT_Object_Class_Timer, rt_object_get_type(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore(), RT_TICK_MAX, RT_TIMER_CTRL_GET_FUNC, RT_TIMER_CTRL_GET_PARM, RT_TIMER_CTRL_GET_REMAIN_TIME, RT_TIMER_CTRL_GET_STATE, RT_TIMER_CTRL_GET_TIME, RT_TIMER_CTRL_SET_FUNC, RT_TIMER_CTRL_SET_ONESHOT, RT_TIMER_CTRL_SET_PARM, RT_TIMER_CTRL_SET_PERIODIC, RT_TIMER_CTRL_SET_TIME, RT_TIMER_FLAG_ACTIVATED, RT_TIMER_FLAG_DEACTIVATED, RT_TIMER_FLAG_PERIODIC, rt_timer::timeout_func , 以及 rt_timer::timeout_tick.

函数调用图:

这是这个函数的调用关系图:

◆ RTM_EXPORT() [9/9]

RTM_EXPORT ( rt_timer_control )

引用了 rt_timer_control().

函数调用图:

◆ rt_timer_check()

void rt_timer_check ( void )

This function will check timer list, if a timeout event happens, the corresponding timeout function will be invoked.

注解: This function shall be invoked in operating system timer interrupt.

在文件 timer.c 第 748 行定义.

{
    RT_ASSERT(rt_interrupt_get_nest() > 0);
 
#ifdef RT_USING_SMP
    /* Running on core 0 only */
    if (rt_cpu_get_id() != 0)
    {
        return;
    }
#endif
 
#ifdef RT_USING_TIMER_SOFT
    rt_err_t ret = RT_ERROR;
    rt_tick_t next_timeout;
 
    ret = _timer_list_next_timeout(_soft_timer_list, &next_timeout);
    if ((ret == RT_EOK) && (next_timeout <= rt_tick_get()))
    {
        rt_sem_release(&_soft_timer_sem);
    }
#endif
#ifndef RT_USING_TIMER_ALL_SOFT
    _timer_check(_timer_list, &_htimer_lock);
#endif
}

引用了 RT_ASSERT, rt_cpu_get_id, rt_interrupt_get_nest(), rt_sem_release() , 以及 rt_tick_get().

函数调用图:

这是这个函数的调用关系图:

◆ rt_timer_next_timeout_tick()

rt_tick_t rt_timer_next_timeout_tick ( void )

This function will return the next timeout tick in the system.

返回: the next timeout tick in the system

在文件 timer.c 第 780 行定义.

{
    rt_base_t level;
    rt_tick_t htimer_next_timeout = RT_TICK_MAX, stimer_next_timeout = RT_TICK_MAX;
 
#ifndef RT_USING_TIMER_ALL_SOFT
    level = rt_spin_lock_irqsave(&_htimer_lock);
    _timer_list_next_timeout(_timer_list, &htimer_next_timeout);
    rt_spin_unlock_irqrestore(&_htimer_lock, level);
#endif
 
#ifdef RT_USING_TIMER_SOFT
    level = rt_spin_lock_irqsave(&_stimer_lock);
    _timer_list_next_timeout(_soft_timer_list, &stimer_next_timeout);
    rt_spin_unlock_irqrestore(&_stimer_lock, level);
#endif
 
    return htimer_next_timeout < stimer_next_timeout ? htimer_next_timeout : stimer_next_timeout;
}

引用了 rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore() , 以及 RT_TICK_MAX.

函数调用图:

◆ rt_tick_sethook()

void rt_tick_sethook ( void(* hook )(void) )

◆ rt_system_timer_init()

void rt_system_timer_init ( void )

This function will initialize system timer

在文件 timer.c 第 823 行定义.

{
#ifndef RT_USING_TIMER_ALL_SOFT
    rt_size_t i;
 
    for (i = 0; i < sizeof(_timer_list) / sizeof(_timer_list[0]); i++)
    {
        rt_list_init(_timer_list + i);
    }
 
    rt_spin_lock_init(&_htimer_lock);
#endif
}

引用了 rt_list_init() , 以及 rt_spin_lock_init().

函数调用图:

◆ rt_system_timer_thread_init()

void rt_system_timer_thread_init ( void )

This function will initialize system timer thread

在文件 timer.c 第 842 行定义.

{
#ifdef RT_USING_TIMER_SOFT
    int i;
 
    for (i = 0;
         i < sizeof(_soft_timer_list) / sizeof(_soft_timer_list[0]);
         i++)
    {
        rt_list_init(_soft_timer_list + i);
    }
    rt_spin_lock_init(&_stimer_lock);
    rt_sem_init(&_soft_timer_sem, "stimer", 0, RT_IPC_FLAG_PRIO);
    rt_sem_control(&_soft_timer_sem, RT_IPC_CMD_SET_VLIMIT, (void*)1);
    /* start software timer thread */
    rt_thread_init(&_timer_thread,
                   "timer",
                   _timer_thread_entry,
                   RT_NULL,
                   &_timer_thread_stack[0],
                   sizeof(_timer_thread_stack),
                   RT_TIMER_THREAD_PRIO,
                   10);
 
    /* startup */
    rt_thread_startup(&_timer_thread);
#endif /* RT_USING_TIMER_SOFT */
}

引用了 RT_IPC_CMD_SET_VLIMIT, RT_IPC_FLAG_PRIO, rt_list_init(), RT_NULL, rt_sem_control(), rt_sem_init(), rt_spin_lock_init(), rt_thread_init() , 以及 rt_thread_startup().

函数调用图:

◆ rt_timer_enter_sethook()

void rt_timer_enter_sethook ( void(* hook )(struct rt_timer *timer) )

◆ rt_timer_exit_sethook()

void rt_timer_exit_sethook ( void(* hook )(struct rt_timer *timer) )

结构体

宏定义

类型定义

函数

详细描述

宏定义说明

◆ _update_process_times

◆ RT_TIMER_FLAG_DEACTIVATED

◆ RT_TIMER_FLAG_ACTIVATED

◆ RT_TIMER_FLAG_ONE_SHOT

◆ RT_TIMER_FLAG_PERIODIC

◆ RT_TIMER_FLAG_HARD_TIMER

◆ RT_TIMER_FLAG_SOFT_TIMER

◆ RT_TIMER_FLAG_THREAD_TIMER

◆ RT_TIMER_CTRL_SET_TIME

◆ RT_TIMER_CTRL_GET_TIME

◆ RT_TIMER_CTRL_SET_ONESHOT

◆ RT_TIMER_CTRL_SET_PERIODIC

◆ RT_TIMER_CTRL_GET_STATE

◆ RT_TIMER_CTRL_GET_REMAIN_TIME

◆ RT_TIMER_CTRL_GET_FUNC

◆ RT_TIMER_CTRL_SET_FUNC

◆ RT_TIMER_CTRL_GET_PARM

◆ RT_TIMER_CTRL_SET_PARM

◆ RT_TIMER_SKIP_LIST_LEVEL

◆ RT_TIMER_SKIP_LIST_MASK

类型定义说明

◆ rt_timer_func_t

◆ rt_timer_t

函数说明

◆ rt_tick_get()

◆ RTM_EXPORT() [1/9]

◆ rt_tick_set()

◆ rt_tick_increase()

◆ rt_tick_increase_tick()

◆ rt_tick_from_millisecond()

◆ RTM_EXPORT() [2/9]

◆ rt_tick_get_millisecond()

◆ rt_timer_init()

◆ RTM_EXPORT() [3/9]

◆ rt_timer_detach()

◆ RTM_EXPORT() [4/9]

◆ rt_timer_create()

◆ RTM_EXPORT() [5/9]

◆ rt_timer_delete()

◆ RTM_EXPORT() [6/9]

◆ rt_timer_start()

◆ RTM_EXPORT() [7/9]

◆ rt_timer_stop()

◆ RTM_EXPORT() [8/9]

◆ rt_timer_control()

◆ RTM_EXPORT() [9/9]

◆ rt_timer_check()

◆ rt_timer_next_timeout_tick()

◆ rt_tick_sethook()

◆ rt_system_timer_init()

◆ rt_system_timer_thread_init()

◆ rt_timer_enter_sethook()

◆ rt_timer_exit_sethook()