lby/mr-library
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

1.优化keil文件不最后不加一行报警告的问题。

Browse Source
This commit is contained in:
MacRsh
2023-10-14 23:17:35 +08:00
parent fcfbc93a3b
commit 1a940136f9
66 changed files with 365 additions and 353 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
document/developer/coding_style.md
View File

@@ -164,7 +164,7 @@
...
}
```
3. 结构体，宏等定义需添加注释：
```c

48
document/user/device/dac.md
View File

@@ -31,7 +31,7 @@ mr_device_t mr_device_find(const char *name);
|:--------|:-------|
| name | DAC设备名 |
| **返回** | |
| DAC | 查找设备成功 |
| DAC | 查找设备成功 |
| MR_NULL | 查找设备失败 |
----------
@@ -42,13 +42,13 @@ mr_device_t mr_device_find(const char *name);
mr_err_t mr_device_open(mr_device_t device, mr_uint8_t oflags);
```
| 参数 | 描述 |
|:------------|:-------|
| device | DAC设备 |
| oflags | 打开方式 |
| **返回** | |
| MR_ERR_OK | 打开设备成功 |
| 错误码 | 打开设备失败 |
| 参数 | 描述 |
|:----------|:-------|
| device | DAC设备 |
| oflags | 打开方式 |
| **返回** | |
| MR_ERR_OK | 打开设备成功 |
| 错误码 | 打开设备失败 |
DAC设备支持以下打开方式：
@@ -64,14 +64,14 @@ MR_DEVICE_OFLAG_WRONLY /* 只写 */
mr_err_t mr_device_ioctl(mr_device_t device, int cmd, void *args);
```
| 参数 | 描述 |
|:----------|:--------|
| device | DAC设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
| 参数 | 描述 |
|:----------|:-------|
| device | DAC设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
DAC设备支持以下命令：
@@ -124,14 +124,14 @@ mr_device_ioctl(dac_device, MR_DEVICE_CTRL_SET_CONFIG, &dac_config);
mr_ssize_t mr_device_write(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:----------|:--------|
| device | DAC设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
| 参数 | 描述 |
|:----------|:-------|
| device | DAC设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
- 写入位置：需要写入数据的通道，有效范围：0-31。
- 写入数据：DAC设备输出值，类型为：uint32。

64
document/user/device/i2c.md
View File

@@ -22,14 +22,14 @@ I2C（Inter-Integrated Circuit）是一种串行外设接口，用于连接和
mr_err_t mr_i2c_device_add(mr_i2c_device_t i2c_device, const char *name, mr_uint32_t address);
```
| 参数 | 描述 |
|:-----------|:---------|
| i2c_device | I2C设备 |
| name | I2C设备名 |
| address | I2C设备地址 |
| **返回** | |
| MR_ERR_OK | 添加设备成功 |
| 错误码 | 添加设备失败 |
| 参数 | 描述 |
|:-----------|:--------|
| i2c_device | I2C设备 |
| name | I2C设备名 |
| address | I2C设备地址 |
| **返回** | |
| MR_ERR_OK | 添加设备成功 |
| 错误码 | 添加设备失败 |
I2C设备地址为未向左移1位的地址。
@@ -39,14 +39,14 @@ I2C设备地址为未向左移1位的地址。
mr_err_t mr_device_ioctl(mr_device_t device, int cmd, void *args);
```
| 参数 | 描述 |
|:----------|:--------|
| device | I2C设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
| 参数 | 描述 |
|:----------|:-------|
| device | I2C设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
I2C设备支持以下命令：
@@ -133,14 +133,14 @@ mr_device_ioctl(i2c1_device, MR_DEVICE_CTRL_CONNECT, MR_NULL);
mr_ssize_t mr_device_read(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:------------|:-------|
| device | I2C设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
| 参数 | 描述 |
|:----------|:-------|
| device | I2C设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
- 读取位置：需要读取的（寄存器）地址，如读取0x23地址数据，则pos = 0x23，有效范围：0-2147483647。地址长度根据设置的pos_bits，如不使用时请赋值：-1。
@@ -169,14 +169,14 @@ mr_device_read(i2c_device, 0x23, buffer, sizeof(buffer));
mr_ssize_t mr_device_write(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:------------|:-------|
| device | I2C设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
| 参数 | 描述 |
|:----------|:-------|
| device | I2C设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
- 写入位置：需要写入的（寄存器）地址，如写入0x23地址数据，则pos = 0x23，有效范围：0-2147483647。地址长度根据设置的pos_bits，如不使用时请赋值：-1。

74
document/user/device/pin.md
View File

@@ -27,12 +27,12 @@ GPIO（通用目的输入/输出）是一种可以通过软件进行控制的硬
mr_device_t mr_device_find(const char *name);
```
| 参数 | 描述 |
|:----------|:----------|
| name | PIN设备名 |
| **返回** | |
| PIN | 查找设备成功 |
| MR_NULL | 查找设备失败 |
| 参数 | 描述 |
|:--------|:-------|
| name | PIN设备名 |
| **返回** | |
| PIN | 查找设备成功 |
| MR_NULL | 查找设备失败 |
----------
@@ -42,13 +42,13 @@ mr_device_t mr_device_find(const char *name);
mr_err_t mr_device_open(mr_device_t device, mr_uint8_t oflags);
```
| 参数 | 描述 |
|:------------|:-------|
| device | PIN设备 |
| oflags | 打开方式 |
| **返回** | |
| MR_ERR_OK | 打开设备成功 |
| 错误码 | 打开设备失败 |
| 参数 | 描述 |
|:----------|:-------|
| device | PIN设备 |
| oflags | 打开方式 |
| **返回** | |
| MR_ERR_OK | 打开设备成功 |
| 错误码 | 打开设备失败 |
PIN设备支持以下打开方式：
@@ -66,14 +66,14 @@ MR_DEVICE_OFLAG_RDWR /* 可读可
mr_err_t mr_device_ioctl(mr_device_t device, int cmd, void *args);
```
| 参数 | 描述 |
|:----------|:--------|
| device | PIN设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
| 参数 | 描述 |
|:----------|:-------|
| device | PIN设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
PIN设备支持以下命令：
@@ -177,14 +177,14 @@ mr_device_ioctl(pin_device, MR_DEVICE_CTRL_SET_RX_CB, pin_device_cb);
mr_ssize_t mr_device_read(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:----------|:--------|
| device | PIN设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
| 参数 | 描述 |
|:----------|:-------|
| device | PIN设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
- 读取位置：需要读取的IO编号，如读取B13，则pos = 29，有效范围：>=0。
- 读取数据：PIN设备IO输入电平，类型为：int8。
@@ -219,14 +219,14 @@ mr_device_read(pin_device, PIN_NUMBER, &pin_level, sizeof(pin_level));
mr_ssize_t mr_device_write(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:----------|:--------|
| device | PIN设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
| 参数 | 描述 |
|:----------|:-------|
| device | PIN设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
- 写入位置：需要写入的IO编号，如读取B13，则pos = 29，有效范围：>=0。
- 写入数据：PIN设备IO输出电平，类型为：int8。

74
document/user/device/serial.md
View File

@@ -27,12 +27,12 @@ UART（Universal Asynchronous Receiver/Transmitter）即通用异步收发传输
mr_device_t mr_device_find(const char *name);
```
| 参数 | 描述 |
|:---------|:------------|
| name | SERIAL设备名 |
| **返回** | |
| SERIAL | 查找设备成功 |
| MR_NULL | 查找设备失败 |
| 参数 | 描述 |
|:--------|:----------|
| name | SERIAL设备名 |
| **返回** | |
| SERIAL | 查找设备成功 |
| MR_NULL | 查找设备失败 |
----------
@@ -42,13 +42,13 @@ mr_device_t mr_device_find(const char *name);
mr_err_t mr_device_open(mr_device_t device, mr_uint8_t oflags);
```
| 参数 | 描述 |
|:------------|:-----------|
| device | SERIAL设备 |
| oflags | 打开方式 |
| **返回** | |
| MR_ERR_OK | 打开设备成功 |
| 错误码 | 打开设备失败 |
| 参数 | 描述 |
|:----------|:---------|
| device | SERIAL设备 |
| oflags | 打开方式 |
| **返回** | |
| MR_ERR_OK | 打开设备成功 |
| 错误码 | 打开设备失败 |
SERIAL设备支持以下打开方式：
@@ -76,14 +76,14 @@ MR_DEVICE_OFLAG_NONBLOCKING /* 非阻塞
mr_err_t mr_device_ioctl(mr_device_t device, int cmd, void *args);
```
| 参数 | 描述 |
|:----------|:-----------|
| device | SERIAL设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
| 参数 | 描述 |
|:----------|:---------|
| device | SERIAL设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
SERIAL设备支持以下命令：
@@ -226,14 +226,14 @@ mr_device_ioctl(serial_device, MR_DEVICE_CTRL_SET_TX_BUFSZ, &bufsz);
mr_ssize_t mr_device_read(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:------------|:-------------|
| device | SERIAL设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
| 参数 | 描述 |
|:----------|:---------|
| device | SERIAL设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
使用示例：
@@ -261,14 +261,14 @@ mr_device_read(serial_device, 0, buffer, sizeof(buffer));
mr_ssize_t mr_device_write(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:----------|:----------|
| device | SERIAL设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
| 参数 | 描述 |
|:----------|:---------|
| device | SERIAL设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
使用示例：

48
document/user/device/spi.md
View File

@@ -43,14 +43,14 @@ mr_err_t mr_spi_device_add(mr_spi_device_t spi_device, const char *name, mr_off_
mr_err_t mr_device_ioctl(mr_device_t device, int cmd, void *args);
```
| 参数 | 描述 |
|:----------|:--------|
| device | SPI设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
| 参数 | 描述 |
|:----------|:-------|
| device | SPI设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
SPI设备支持以下命令：
@@ -240,14 +240,14 @@ mr_device_ioctl(spi_device, MR_DEVICE_CTRL_SPI_TRANSFER, &spi_transfer);
mr_ssize_t mr_device_read(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:------------|:-------|
| device | SPI设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
| 参数 | 描述 |
|:----------|:-------|
| device | SPI设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
- 读取位置：需要读取的（寄存器）地址，如读取0x23地址数据，则pos = 0x23，有效范围：0-2147483647。地址长度根据设置的pos_bits，如不使用时请赋值：-1。
@@ -276,14 +276,14 @@ mr_device_read(spi_device, 0x23, buffer, sizeof(buffer));
mr_ssize_t mr_device_write(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:------------|:-------|
| device | SPI设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
| 参数 | 描述 |
|:----------|:-------|
| device | SPI设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
- 写入位置：需要写入的（寄存器）地址，如写入0x23地址数据，则pos = 0x23，有效范围：0-2147483647。地址长度根据设置的pos_bits，如不使用时请赋值：-1。

75
document/user/device/timer.md
View File

@@ -21,12 +21,12 @@
mr_device_t mr_device_find(const char *name);
```
| 参数 | 描述 |
|:----------|:-------------|
| name | TIMER设备名 |
| **返回** | |
| TIMER | 查找设备成功 |
| MR_NULL | 查找设备失败 |
| 参数 | 描述 |
|:--------|:---------|
| name | TIMER设备名 |
| **返回** | |
| TIMER | 查找设备成功 |
| MR_NULL | 查找设备失败 |
----------
@@ -36,13 +36,13 @@ mr_device_t mr_device_find(const char *name);
mr_err_t mr_device_open(mr_device_t device, mr_uint8_t oflags);
```
| 参数 | 描述 |
|:------------|:-----------|
| device | TIMER设备 |
| oflags | 打开方式 |
| **返回** | |
| MR_ERR_OK | 打开设备成功 |
| 错误码 | 打开设备失败 |
| 参数 | 描述 |
|:----------|:--------|
| device | TIMER设备 |
| oflags | 打开方式 |
| **返回** | |
| MR_ERR_OK | 打开设备成功 |
| 错误码 | 打开设备失败 |
TIMER设备支持以下打开方式：
@@ -60,15 +60,14 @@ MR_DEVICE_OFLAG_RDWR /* 可读可
mr_err_t mr_device_ioctl(mr_device_t device, int cmd, void *args);
```
| 参数 | 描述 |
|:----------|:------------|
| device | TIMER设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
| 参数 | 描述 |
|:----------|:--------|
| device | TIMER设备 |
| cmd | 控制命令 |
| args | 控制参数 |
| **返回** | |
| MR_ERR_OK | 控制设备成功 |
| 错误码 | 控制设备失败 |
TIMER设备支持以下命令：
@@ -134,14 +133,14 @@ mr_device_ioctl(serial_device, MR_DEVICE_CTRL_SET_RX_CB, timer_device_rx_cb);
mr_ssize_t mr_device_read(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:------------|:--------------|
| device | TIMER设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
| 参数 | 描述 |
|:----------|:--------|
| device | TIMER设备 |
| pos | 读取位置 |
| buffer | 读取数据 |
| size | 读取数据大小 |
| **返回** | |
| 实际读取的数据大小 | |
- 读取数据：TIMER设备已运行时间（单位us），类型为：uint32。
@@ -169,14 +168,14 @@ mr_device_read(serial_device, 0, &buffer, sizeof(buffer));
mr_ssize_t mr_device_write(mr_device_t device, mr_off_t pos, const void *buffer, mr_size_t size);
```
| 参数 | 描述 |
|:----------|:-----------|
| device | TIMER设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
| 参数 | 描述 |
|:----------|:--------|
| device | TIMER设备 |
| pos | 写入位置 |
| buffer | 写入数据 |
| size | 写入数据大小 |
| **返回** | |
| 实际写入的数据大小 | |
- 写入数据：TIMER设备定时时间（单位us），定时范围1us-4294.967295s,类型为：uint32。写入多个数据时将取最后一个有效数据。

22
document/user/usage_guide.md
View File

@@ -8,17 +8,17 @@
代码包含以下文件：
| 名称 | 描述 |
|:-----------|:--------|
| mr_library | |
| -bsp | 板级支持包 |
| -device | 设备文件 |
| -document | 文档 |
| -driver | 驱动文件 |
| -include | 库头文件 |
| -module | 组件 |
| -package | 软件包 |
| -src | 库源文件 |
| 名称 | 描述 |
|:-----------|:------|
| mr_library | |
| -bsp | 板级支持包 |
| -device | 设备文件 |
| -document | 文档 |
| -driver | 驱动文件 |
| -include | 库头文件 |
| -module | 组件 |
| -package | 软件包 |
| -src | 库源文件 |
选择需要的文件：