awtk/docs/manual/platform_t.md

87 lines
1.9 KiB
Markdown
Raw Normal View History

2019-11-15 11:19:47 +08:00
## platform\_t
### 概述
2019-11-15 11:33:43 +08:00
平台接口,包括:获取时间、休眠等函数。
2019-11-15 11:19:47 +08:00
----------------------------------
### 函数
<p id="platform_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
2020-12-08 09:04:40 +08:00
| <a href="#platform_t_get_time_ms64">get\_time\_ms64</a> | 获取当前时间(毫秒)。 |
| <a href="#platform_t_get_time_us64">get\_time\_us64</a> | 获取当前时间(微秒)。 |
2019-11-15 11:33:43 +08:00
| <a href="#platform_t_platform_prepare">platform\_prepare</a> | 平台准备函数。 |
| <a href="#platform_t_sleep_ms">sleep\_ms</a> | 睡眠指定时间。 |
2019-11-15 11:19:47 +08:00
#### get\_time\_ms64 函数
-----------------------
* 函数功能:
2020-12-08 09:04:40 +08:00
> <p id="platform_t_get_time_ms64">获取当前时间(毫秒)。
2019-11-15 11:19:47 +08:00
* 函数原型:
```
uint64_t get_time_ms64 ();
```
* 参数说明:
2020-12-08 09:04:40 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint64\_t | 成功返回当前时间。 |
#### get\_time\_us64 函数
-----------------------
* 函数功能:
> <p id="platform_t_get_time_us64">获取当前时间(微秒)。
* 函数原型:
```
uint64_t get_time_us64 ();
```
* 参数说明:
2019-11-15 11:19:47 +08:00
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint64\_t | 成功返回当前时间。 |
#### platform\_prepare 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="platform_t_platform_prepare">平台准备函数。
2019-11-15 11:19:47 +08:00
* 函数原型:
```
ret_t platform_prepare ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
#### sleep\_ms 函数
-----------------------
* 函数功能:
2019-11-15 11:33:43 +08:00
> <p id="platform_t_sleep_ms">睡眠指定时间。
2019-11-15 11:19:47 +08:00
* 函数原型:
```
void sleep_ms (uint32_t ms);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | void | 无。 |
| ms | uint32\_t | 睡眠时间(毫秒)。 |