[update] update doc&errata

This commit is contained in:
jzlv 2021-06-07 19:02:53 +08:00
parent ee8ed272aa
commit 322bbbe17e
230 changed files with 3248 additions and 24793 deletions

View file

@ -11,7 +11,7 @@ I2C (Inter-Intergrated Circuit) 是一种串行通讯总线,使用多主从架
- 灵活配置的从机地址 ``slaveAddr`` 、寄存器地址 ``subAddr``
- 可以灵活调整的时钟频率
- 支持轮询、中断、DMA传输
- 支持轮询、中断、DMA 传输
I2C 设备结构体定义
@ -28,15 +28,15 @@ I2C 设备结构体定义
} i2c_device_t;
- parent 继承父类属性
- ch i2c id0表示i2c0,1表示i2c1
- mode i2c传输模式0 为使用硬件i2c1为使用软件i2c当前软件i2c暂时无效
- ch i2c id0 表示 i2c0,1 表示 i2c1
- mode i2c 传输模式0 为使用硬件 i2c1 为使用软件 i2c当前软件 i2c 暂时无效
- phase
- 其他待补充
I2C 设备参数配置表
------------------------
每一个 I2C 设备都有一个参数配置宏,宏定义位于 ``bsp/board/xxx`` 目录下 ``peripheral_config.h`` 文件,变量定义位于 ``hal_pwm.c`` 中,因此无需用户自己定义变量。当用户打开对应设备的宏,该设备的配置才生效。例如打开宏 ``BSP_USING_I2C0`` ``I2C0_CONFIG`` 即生效,同时 ``I2C`` 设备就可以进行注册和使用了。
每一个 I2C 设备都有一个参数配置宏,宏定义位于 ``bsp/board/xxx`` 目录下 ``peripheral_config.h`` 文件,变量定义位于 ``hal_i2c.c`` 中,因此无需用户自己定义变量。当用户打开对应设备的宏,该设备的配置才生效。例如打开宏 ``BSP_USING_I2C0`` ``I2C0_CONFIG`` 即生效,同时 ``I2C`` 设备就可以进行注册和使用了。
.. code-block:: C
@ -120,7 +120,7 @@ I2C 设备标准接口当前仅使用 ``device_open`` , 并提供标准的数据
**i2c_transfer**
^^^^^^^^^^^^^^^^
``i2c_transfer`` 用于设备的数据传输,形参中 ``msgs`` 中的成员 ``flags`` 指示传输的方向是写还是读并且指定寄存器地址长度是0、1、2。
``i2c_transfer`` 用于设备的数据传输,形参中 ``msgs`` 中的成员 ``flags`` 指示传输的方向是写还是读,并且指定寄存器地址长度是 0、1、2。
.. code-block:: C
@ -144,8 +144,8 @@ I2C 设备标准接口当前仅使用 ``device_open`` , 并提供标准的数据
uint8_t *buf;
} i2c_msg_t;
- slaveaddr i2c从设备7位从机地址
- subaddr i2c从设备寄存器地址
- slaveaddr i2c 从设备7位从机地址
- subaddr i2c 从设备寄存器地址
- flags 读写模式以及寄存器地址长度
- len 传输数据长度
- buf 数据缓冲区

View file

@ -16,7 +16,7 @@ SDI数据输入、SDO数据输出、SCLK时钟、CS片选
- 可配置 MSB/LSB 优先传输
- 接收过滤功能
- 从设备下的超时机制
- 支持轮询、中断、DMA传输
- 支持轮询、中断、DMA 传输
SPI 设备结构体定义
------------------------
@ -39,14 +39,14 @@ SPI 设备结构体定义
} spi_device_t;
- parent 继承父类属性
- id SPI id0表示 SPI0
- id SPI id0 表示 SPI0
- clk SPI 时钟频率
- mode 主机模式或者从机模式
- direction 传输先行模式
- clk_polaraity 时钟极性
- clk_phase 时钟相位
- datasize 数据传输位宽
- fifo_threshold fifo 阈值, 最大为4
- fifo_threshold fifo 阈值, 最大为 4
- tx_dma 附加的发送 dma 句柄
- rx_dma 附加的接收 dma 句柄
@ -93,7 +93,7 @@ SPI 设备结构体定义
SPI 设备参数配置表
------------------------
每一个 SPI 设备都有一个参数配置宏,宏定义位于 ``bsp/board/xxx`` 目录下 ``peripheral_config.h`` 文件,变量定义位于 ``hal_uart.c`` 中,因此无需用户自己定义变量。当用户打开对应设备的宏,该设备的配置才生效。例如打开宏 ``BSP_USING_SPI0`` ``SPI0_CONFIG`` 即生效,同时 ``SPI0`` 设备就可以进行注册和使用了。
每一个 SPI 设备都有一个参数配置宏,宏定义位于 ``bsp/board/xxx`` 目录下 ``peripheral_config.h`` 文件,变量定义位于 ``hal_spi.c`` 中,因此无需用户自己定义变量。当用户打开对应设备的宏,该设备的配置才生效。例如打开宏 ``BSP_USING_SPI0`` ``SPI0_CONFIG`` 即生效,同时 ``SPI0`` 设备就可以进行注册和使用了。
.. code-block:: C

View file

@ -11,7 +11,7 @@ API 分层模型
整体的代码分层框架如图所示:
.. figure:: img/api1.png
.. figure:: img/sw_arch.png
:alt:
code structure

Binary file not shown.

After

Width:  |  Height:  |  Size: 224 KiB