README.md
1# ktime
2
3## 1、介绍
4
5ktime 为 kernel time，为内核时间子系统，实现了内核启动时间以及芯片内核 cputimer 时间管理以及一个 ns 精度的高精度定时器，
6
7## 2、如何打开 ktime
8
9使用 ktime 需要在 RT-Thread 的 menuconfig 中选择它，具体路径如下：
10
11```
12RT-Thread Components
13 [*] Ktime: kernel time
14```
15
16## 3、使用 ktime
17
18> 函数的功能以及参数类型已经写在头文件的注释之中，本文不再赘述
19
20### 3.1、boottime
21
22boottime 为系统启动时间，即为系统从上电开始到现在运行的时间，默认的时间基准为芯片内核的 cputimer 的 cnt 值，已经适配了 aarch64 与 riscv64 平台，例如 stm32 等平台需要在自己的 bsp 里面进行适配（boottime 里面函数都为 weak function），需要注意 tick 从中断到设置中间的时延
23
24**此值应当为 Readonly**
25
26### 3.2、cputimer
27
28cputimer 为芯片内核的 cputimer，也可以认为是 os tick 来源的那个定时器，cputimer 主要是提供了一个统一的接口去获得其分辨率，频率，cnt 值
29
30**此值应当为 Readonly**
31
32### 3.3、hrtimer
33
34> TODO: hrtimer 目前还是使用优先级链表的方式进行管理，在遇到任务的大规模并发时还是存在部分性能问题，待内核有一个统一的红黑树组件后，再进行优化
35
36hrtimer 为高精度定时器，需要重写其 weak 函数（需要对接到硬件定时器，否则默认走的是软件定时器，分辨率只有 os tick 的值）才能正常使用，其主要使用方法：
37
38#### 3.3.1、延时
39
40hrtimer 的延时并不是 while(1)式死等，它会将一个线程挂起，睡眠多少时间后通过硬件定时器将其唤醒（注：延时 ns 并不是真的能准确的延时这么多，而是在保证性能的情况下尽可能的延时）
41
42- rt_ktime_hrtimer_sleep：单位为 cputimer 的 tick 值
43- rt_ktime_hrtimer_ndelay：单位为 ns
44- rt_ktime_hrtimer_udelay：单位为 us
45- rt_ktime_hrtimer_mdelay：单位为 ms
46
47#### 3.3.1、定时器
48
49hrtimer 还提供了一套 rt_timer 风格的 api
50
51- rt_ktime_hrtimer_init
52- rt_ktime_hrtimer_delete
53- rt_ktime_hrtimer_start
54- rt_ktime_hrtimer_stop
55- rt_ktime_hrtimer_control
56- rt_ktime_hrtimer_detach
57
58需要注意，此定时器回调函数依旧处于中断之中，不能做一些耗时的任务
59
60## 5、联系方式
61
62- 维护：xqyjlj
63- 主页：https://github.com/xqyjlj
64