mirror of
https://github.com/Fishwaldo/bl_mcu_sdk.git
synced 2025-07-22 20:59:03 +00:00
[docs] update docs
This commit is contained in:
qqwang
parent
8d46c47542
commit
0d9f65c145
165 changed files with 4363 additions and 1814 deletions
|
|
@ -12,8 +12,8 @@ BLE
|
|||
- 支持配对包括蓝牙4.2中的安全连接特性
|
||||
- 支持永久存储蓝牙特定的设置和数据
|
||||
+ 蓝牙mesh特性
|
||||
- 支持Relay, Friend Node, Low-Power Node (LPN) and GATT Proxy角色
|
||||
- 支持两种Provisioning bearers(PB-ADV & PB-GATT)
|
||||
- TODO
|
||||
|
||||
- BLE协议栈的架构：
|
||||
.. figure:: img/image1.png
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ ADC 设备
|
|||
简介
|
||||
------------------------
|
||||
ADC (Analog-to-digital Converter) 是用于将模拟形式的连续信号转换为数字形式的离散信号的一类设备,他可以将外围电路传感器产生的模拟信号转化为机器可识别的数字信号。
|
||||
博流系列MCU中的ADC设备具有以下特性
|
||||
博流系列 MCU 中的 ADC 设备具有以下特性
|
||||
|
||||
- 可以选择 12/14/16 bits 转换结果输出
|
||||
- ADC最大工作时钟为 2MHZ
|
||||
|
|
@ -32,14 +32,14 @@ ADC 设备结构体定义
|
|||
adc_pga_gain_t gain;
|
||||
} adc_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- clk_div ADC 模块时钟内部分频
|
||||
- vref 参考电压选择 2.0/3.2V 可选
|
||||
- continuous_conv_mode 是否选择为连续模式，若为连续模式，则一次 adc_start 操作， ADC 连续工作，直到 adc_stop 。否则，每 adc_start 一次，adc 仅转换一次结果。
|
||||
- differential_mode 选择是否为差分模式，若为差分模式，则可以测量负电压。
|
||||
- data_width 测量宽度选择，ADC 实际精度为12 bits ，但是通过 OSR 多次取平均可以达到 14bits / 16bits 的精度，注意，当选择更高的数据宽度后，频率会因为取平均而下降。详情可参考枚举信息。
|
||||
- fifo_threshold 此参数影响 DMA 搬运阈值以及 ADC FIFO 中断阈值
|
||||
- gain ADC 对输入信号的增益选择
|
||||
- **parent** 继承父类属性
|
||||
- **clk_div** ADC 模块时钟内部分频
|
||||
- **vref** 参考电压选择 2.0/3.2V 可选
|
||||
- **continuous_conv_mode** 是否选择为连续模式，若为连续模式，则一次 adc_start 操作， ADC 连续工作，直到 adc_stop 。否则，每 adc_start 一次，adc 仅转换一次结果。
|
||||
- **differential_mode** 选择是否为差分模式，若为差分模式，则可以测量负电压。
|
||||
- **data_width** 测量宽度选择，ADC 实际精度为12 bits ，但是通过 OSR 多次取平均可以达到 14bits / 16bits 的精度，注意，当选择更高的数据宽度后，频率会因为取平均而下降。详情可参考枚举信息。
|
||||
- **fifo_threshold** 此参数影响 DMA 搬运阈值以及 ADC FIFO 中断阈值
|
||||
- **gain** ADC 对输入信号的增益选择
|
||||
- 其他待补充
|
||||
|
||||
ADC 设备参数配置表
|
||||
|
|
@ -76,8 +76,8 @@ ADC 设备参数配置表
|
|||
|
||||
ADC 设备接口
|
||||
------------------------
|
||||
ADC 设备接口全部遵循标准设备驱动管理层提供的接口。
|
||||
|
||||
ADC 设备接口全部遵循标准设备驱动管理层提供的接口。
|
||||
|
||||
**adc_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -86,16 +86,16 @@ ADC 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
.. code-block:: C
|
||||
|
||||
int adc_register(enum ADC_index_type index, const char *name);
|
||||
int adc_register(enum adc_index_type index, const char *name);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- flag 默认可读可写属性
|
||||
- **index** 要注册的设备索引
|
||||
- **flag** 默认可读可写属性
|
||||
|
||||
``index`` 用来选择 ADC 设备配置，一个 index 对应一个 ADC 设备配置，比如 ``ADC0_INDEX`` 对应 ``ADC0_CONFIG`` 配置，``index`` 有如下可选类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum ADC_index_type
|
||||
enum adc_index_type
|
||||
{
|
||||
#ifdef BSP_USING_ADC0
|
||||
ADC0_INDEX,
|
||||
|
|
@ -106,17 +106,17 @@ ADC 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于 ADC 设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``adc_open``。
|
||||
``device_open`` 用于打开一个 ADC 设备，实际调用 ``adc_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备句柄
|
||||
- **oflag** 设备的打开方式
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
``oflag`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -130,30 +130,30 @@ ADC 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。实际调用 ``adc_close``。
|
||||
``device_close`` 用于关闭一个 ADC 设备，实际调用 ``adc_close``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备句柄
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对 ADC 设备进行控制和参数的修改。实际调用 ``adc_control``。
|
||||
``device_control`` 用于对 ADC 设备的进行控制和参数的修改，实际调用 ``adc_control``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
- **dev** 设备句柄
|
||||
- **cmd** 设备控制命令
|
||||
- **args** 控制参数
|
||||
- **return** 不同的控制命令返回的意义不同。
|
||||
|
||||
串口设备除了标准的控制命令，还具有自己特殊的控制命令。
|
||||
ADC 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -167,33 +167,46 @@ ADC 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
.. list-table:: table1
|
||||
:widths: 15 10 30
|
||||
:header-rows: 1
|
||||
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| cmd | args | description |
|
||||
+================================+====================+==================================+
|
||||
| DEVICE_CTRL_SET_INT | ADC_it_type | 开启 ADC 设备中断 |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_CLR_INT | ADC_it_type | 关闭 ADC 设备中断 |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_CONFIG | ADC_param_cfg_t* | 修改 ADC 配置 |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_ADC_CHANNEL_CONFIG | adc_channel_cfg_t* | 配置 ADC 通道信息 |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_ATTACH_RX_DMA | struct device* | 链接接收 DMA 设备 |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_ADC_CHANNEL_START | struct device* | 开始/继续 ADC 转换 |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_ADC_CHANNEL_STOP | NULL | 停止 ADC 转换 |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_ADC_VBAT_ON | NULL | 打开内部 VDD 测量电路 |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_ADC_VBAT_OFF | NULL | 关闭内部 VDD 测量电路 |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_ADC_TSEN_ON | NULL | 打开内部温度测量电路(需硬件支持) |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
| DEVICE_CTRL_ADC_TSEN_OFF | uint32_t* | 关闭内部温度测量电路(需硬件支持) |
|
||||
+--------------------------------+--------------------+----------------------------------+
|
||||
|
||||
* - cmd
|
||||
- args
|
||||
- description
|
||||
* - DEVICE_CTRL_SET_INT
|
||||
- adc_it_type
|
||||
- 开启 ADC 设备中断
|
||||
* - DEVICE_CTRL_CLR_INT
|
||||
- adc_it_type
|
||||
- 关闭 ADC 设备中断
|
||||
* - DEVICE_CTRL_CONFIG
|
||||
- ADC_param_cfg_t
|
||||
- 修改 ADC 配置
|
||||
* - DEVICE_CTRL_ADC_CHANNEL_CONFIG
|
||||
- adc_channel_cfg_t
|
||||
- 修改 ADC 通道配置
|
||||
* - DEVICE_CTRL_ATTACH_RX_DMA
|
||||
- struct device*
|
||||
- 链接接收 DMA 设备
|
||||
* - DEVICE_CTRL_ADC_CHANNEL_START
|
||||
- NULL
|
||||
- 开始/继续 ADC 转换
|
||||
* - DEVICE_CTRL_ADC_CHANNEL_STOP
|
||||
- NULL
|
||||
- 停止 ADC 转换
|
||||
* - DEVICE_CTRL_ADC_VBAT_ON
|
||||
- NULL
|
||||
- 打开内部 VDD 测量电路
|
||||
* - DEVICE_CTRL_ADC_VBAT_OFF
|
||||
- NULL
|
||||
- 关闭内部 VDD 测量电路
|
||||
* - DEVICE_CTRL_ADC_TSEN_ON
|
||||
- NULL
|
||||
- 打开内部温度测量电路(需硬件支持)
|
||||
* - DEVICE_CTRL_ADC_TSEN_OFF
|
||||
- NULL
|
||||
- 关闭内部温度测量电路(需硬件支持)
|
||||
|
||||
**device_read**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
|
@ -204,11 +217,11 @@ ADC 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
int device_read(struct device *dev, uint32_t pos, void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要读入的 buffer 缓冲区
|
||||
- size 要读入的长度
|
||||
- return 错误码，0 表示读入成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** 要读入的 buffer 缓冲区
|
||||
- **size** 要读入的长度
|
||||
- **return** 错误码，0 表示读入成功，其他表示错误
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -219,15 +232,15 @@ ADC 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
- **dev** 设备句柄
|
||||
- **callback** 要注册的中断回调函数
|
||||
|
||||
- dev 设备句柄
|
||||
- args 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- size 传输长度
|
||||
- event 中断事件类型
|
||||
- **dev** 设备句柄
|
||||
- **args** 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- **size** 传输长度
|
||||
- **event** 中断事件类型
|
||||
|
||||
串口设备 ``event`` 类型如下
|
||||
``event`` 类型如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@
|
|||
|
||||
uint32_t system_clock_get(enum system_clock_type type);
|
||||
|
||||
- type 获取的系统时钟频率类型
|
||||
- **type** 获取的系统时钟频率类型
|
||||
|
||||
``type`` 提供以下几种类型
|
||||
|
||||
|
|
@ -45,7 +45,7 @@
|
|||
|
||||
uint32_t peripheral_clock_get(enum peripheral_clock_type type);
|
||||
|
||||
- type 获取的外设时钟频率类型
|
||||
- **type** 获取的外设时钟频率类型
|
||||
|
||||
``type`` 提供以下几种类型
|
||||
|
||||
|
|
|
|||
|
|
@ -32,18 +32,18 @@ DMA 设备结构体定义
|
|||
dma_lli_ctrl_t *lli_cfg;
|
||||
} dma_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- id DMA id号，默认0，当前只有一个DMA
|
||||
- ch 通道号
|
||||
- direction 传输方向
|
||||
- transfer_mode 传输模式
|
||||
- src_req 源请求
|
||||
- dst_req 目标请求
|
||||
- src_burst_size 源突发字节数
|
||||
- dst_burst_size 目标突发字节数
|
||||
- src_width 源传输位宽
|
||||
- dst_width 目标传输位宽
|
||||
- lli_cfg 用来存储dma通道的一些信息，用户不用管
|
||||
- **parent** 继承父类属性
|
||||
- **id** DMA id号，默认0，当前只有一个DMA
|
||||
- **ch** 通道号
|
||||
- **direction** 传输方向
|
||||
- **transfer_mode** 传输模式
|
||||
- **src_req** 源请求
|
||||
- **dst_req** 目标请求
|
||||
- **src_burst_size** 源突发字节数
|
||||
- **dst_burst_size** 目标突发字节数
|
||||
- **src_width** 源传输位宽
|
||||
- **dst_width** 目标传输位宽
|
||||
- **lli_cfg** 用来存储dma通道的一些信息，用户不用管
|
||||
|
||||
``direction`` 提供以下类型
|
||||
|
||||
|
|
@ -213,14 +213,14 @@ DMA 设备接口全部遵循标准设备驱动管理层提供的接口。并且
|
|||
**dma_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``dma_register`` 用来注册 DMA 设备标准驱动接口，在注册之前需要打开对应 DMA 设备的通道宏定义。例如定义宏 ``BSP_USING_DMA_CH0`` 方可使用 ``DMA`` 设备的 0 通道,注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 ``DMA`` 设备的 0 通道。
|
||||
``dma_register`` 用来注册一个 DMA 设备标准驱动接口，在注册之前需要打开对应 DMA 设备的通道宏定义。例如定义宏 ``BSP_USING_DMA_CH0`` 方可使用 ``DMA`` 设备的 0 通道,注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 ``DMA`` 设备的 0 通道。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int dma_register(enum dma_index_type index, const char *name);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
- **index** 要注册的设备索引
|
||||
- **name** 为注册的设备命名
|
||||
|
||||
``index`` 用来选择 DMA 设备某个通道的配置，一个 index 对应一个 DMA 设备的一个通道配置，比如 ``DMA_CH0_INDEX`` 对应 DMA 通道0 配置，``index`` 有如下可选类型
|
||||
|
||||
|
|
@ -258,17 +258,17 @@ DMA 设备接口全部遵循标准设备驱动管理层提供的接口。并且
|
|||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``dma_open``。
|
||||
``device_open`` 用于打开一个 DMA 设备的一个通道，实际调用 ``dma_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **oflag** 设备的打开方式
|
||||
- **return** 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
``oflag`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -282,28 +282,28 @@ DMA 设备接口全部遵循标准设备驱动管理层提供的接口。并且
|
|||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。实际调用 ``dma_close``。
|
||||
``device_close`` 用于关闭 DMA 设备的一个通道，实际调用 ``dma_close``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **return** 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对设备进行控制和参数的修改。实际调用 ``dma_control``。
|
||||
``device_control`` 用于对 DMA 设备的一个通道进行控制和参数的修改，实际调用 ``dma_control``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
- **dev** 设备句柄
|
||||
- **cmd** 设备控制命令
|
||||
- **args** 控制参数
|
||||
- **return** 不同的控制命令返回的意义不同。
|
||||
|
||||
DMA 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
||||
|
||||
|
|
@ -345,21 +345,21 @@ DMA 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_set_callback`` 用于注册一个DMA通道中断回调函数。
|
||||
``device_set_callback`` 用于注册一个 DMA 设备的一个通道中断回调函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
- **dev** 设备句柄
|
||||
- **callback** 要注册的中断回调函数
|
||||
|
||||
- dev 设备句柄
|
||||
- args 无用
|
||||
- size 无用
|
||||
- event 中断事件类型
|
||||
- **dev** 设备句柄
|
||||
- **args** 无用
|
||||
- **size** 无用
|
||||
- **event** 中断事件类型
|
||||
|
||||
DMA 设备 ``event`` 类型如下
|
||||
``event`` 类型如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -372,62 +372,95 @@ DMA 设备 ``event`` 类型如下
|
|||
**dma_channel_start**
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``dma_channel_start`` 用于开启DMA通道。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DMA_CHANNEL_START``。
|
||||
``dma_channel_start`` 用于开启 DMA 通道。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DMA_CHANNEL_START``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
dma_channel_start(dev)
|
||||
|
||||
- dev 需要开启的pwm通道句柄
|
||||
- **dev** 需要开启的 dma 通道句柄
|
||||
|
||||
|
||||
**dma_channel_stop**
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``dma_channel_stop`` 用于关闭DMA通道。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DMA_CHANNEL_STOP``。
|
||||
``dma_channel_stop`` 用于关闭一个 DMA 通道。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DMA_CHANNEL_STOP``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
dma_channel_stop(dev)
|
||||
|
||||
- dev 需要关闭的pwm通道句柄
|
||||
- **dev** 需要关闭的 dma 通道句柄
|
||||
|
||||
|
||||
**dma_channel_update**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``dma_channel_update`` 用于更新DMA配置。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DMA_CHANNEL_UPDATE``。
|
||||
``dma_channel_update`` 用于更新 DMA 的一个通道配置。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DMA_CHANNEL_UPDATE``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
dma_channel_update(dev,list)
|
||||
|
||||
- dev 需要更新的pwm通道句柄
|
||||
- list dma_lli_ctrl_t句柄
|
||||
- **dev** 需要更新的 dma 通道句柄
|
||||
- **list** dma_lli_ctrl_t句柄
|
||||
|
||||
|
||||
**dma_channel_check_busy**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``dma_channel_check_busy`` 用于查询当前使用的DMA通道是否传输完成。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DMA_CHANNEL_GET_STATUS``。
|
||||
``dma_channel_check_busy`` 用于查询当前使用的 DMA 通道是否传输完成。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DMA_CHANNEL_GET_STATUS``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
dma_channel_check_busy(dev)
|
||||
|
||||
- dev 需要查询的DMA通道句柄
|
||||
- 返回当前DMA状态，0为传输完成，1为未传输完成
|
||||
- **dev** 需要查询的 dma 通道句柄
|
||||
- **return** 当前 dma 状态，0为传输完成，1为未传输完成
|
||||
|
||||
**dma_reload**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``dma_reload`` 用于更新DMA某个通道的配置，相比于 ``dma_channel_update`` ,该函数无需用户传递很多参数，只需要填入源地址和目标地址，以及长度，内部会自己计算后再进行配置。此函数调用后，DMA通道是没有开启的，需要手动调用 ``dma_channel_start`` 函数。
|
||||
``dma_reload`` 用于更新 DMA 一个通道的配置，相比于 ``dma_channel_update`` ,该函数无需用户传递很多参数，只需要填入源地址和目标地址，以及长度，内部会自己计算后再进行配置。此函数调用后，DMA通道是没有开启的，需要手动调用 ``dma_channel_start`` 函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int dma_reload(struct device *dev, uint32_t src_addr, uint32_t dst_addr, uint32_t transfer_size);
|
||||
|
||||
- dev 需要查询的DMA通道句柄
|
||||
- src_addr 传输源地址
|
||||
- dst_addr 传输目标地址
|
||||
- transfer_size 传输字节总长度，如果传输的位数是16位、32位，这里需要进行转换成字节长度。
|
||||
- **dev** 需要查询的DMA通道句柄
|
||||
- **src_addr** 传输源地址
|
||||
- **dst_addr** 传输目标地址
|
||||
- **transfer_size** 传输字节总长度，如果传输的位数是16位、32位，这里需要进行转换成字节长度。
|
||||
|
||||
|
||||
|
||||
DMA 的效率与FIFO
|
||||
------------------------
|
||||
|
||||
内存到内存
|
||||
^^^^^^^^^^^^^^^
|
||||
|
||||
- DMA在搬运数据时，会以设定的位宽 ``xxx_width`` 与 设定的突发量 ``xxx_burst_size`` 去访问总线进行数据读写，在内存到内存的搬运时，一般 source 端与 destination 端的配置相同。
|
||||
|
||||
- 在总的数据量(data size)不变的情况下，位宽 ``xxx_width`` 越大传输速度越快，效率越高，但传输的数据总量(data size)必须是位宽 ``xxx_width`` 的整倍数，数据的地址也必须是 ``xxx_width`` 的整倍数(地址对齐)，否则会出错。
|
||||
|
||||
- 在连续读写时，burst 突发模式的总线利用效率比 single 单次模式高得多，因此可以尽量提高 ``xxx_burst_size``，但注意，DMA0 的每个通道只有 16Byte 的 FIFO，因此 width 乘 burst_size 的积必须小于等于 16Byte。
|
||||
|
||||
因此在内存到内存搬运数据时，最高效的是 ``xxx_width`` 值为 ``DMA_TRANSFER_WIDTH_32BIT``, ``xxx_burst_size`` 值为 ``DMA_BURST_4BYTE``,此时完全利用了 DMA 的FIFO，读写最快，总线占用最少，但要求数据量与地址满足对齐要求。
|
||||
|
||||
|
||||
外设到内存 与 内存到外设
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
很多传输接口外设是存在 tx-FIFO 与 rx-FIFO 的，这些 FIFO 可以让外设的使用更加灵活方便，在与 DMA 配合使用时也可以增加效率。
|
||||
|
||||
- 在使用 DMA-接口外设 发送数据时，注意 DMA 的 ``des_width`` 与外设的 tx-FIFO 有效数据宽度应当一致，如使用 UART 时一般为 DMA_TRANSFER_WIDTH_8BIT。接收数据时 DMA 的 ``src_width`` 与 rx-FIFO 有效数据宽度也要一致。
|
||||
|
||||
- 外设端的 burst_size 对 外设的 FIFO 深度有要求，burst_size 必须小于等于 外设配置的 ``fifo_threshold`` 以保证不会出现写溢出或读溢出。
|
||||
|
||||
- 内存端配置的 burst_size 和 width 与外设端的可以不相等，但 burst_size 与 width 的乘积必须相等，并且小于 16Byte。内存端配置更高的 ``xxx_width`` 可以提高传输速度，减少对总线占用，但注意对数据量(data size)与地址的对齐要求。
|
||||
|
||||
如对于 I2S ,他的 tx 与 rx 的 FIFO 深度都为 8，I2S 最佳的 ``fifo_threshold`` 应为 4，DMA 的 ``xxx_burst_size`` 应该为 ``DMA_BURST_4BYTE``，这样能保证 I2S 的 FIFO 能留有一定余量防止出现 rx-FIFO 溢出与 tx-FIFO 欠载，又减少 DMA 了对总线的占用。
|
||||
|
||||
又如对于 SPI ，他的 tx 与 rx 的 FIFO 深度都为 4，若使用 burst_size 为 4 的方式传输，那么 SPI 的 ``fifo_threshold`` 只能是 4，没有冗余，若此时 CPU 在占用总线导致 DMA 传输不及时，可能会出现SPI传输间歇，在SPI从机模式下还可能出现发送欠载与接收溢出。
|
||||
因此对于 SPI 而言，最佳的 ``fifo_threshold`` 应为 1，DMA 的 ``xxx_burst_size`` 应为 ``DMA_BURST_1BYTE``，此时 DMA 虽然对总线的访问效率一般，但保证了 SPI 的 FIFO 有冗余，不会出现上诉问题。
|
||||
|
|
@ -13,7 +13,7 @@ GPIO 全称 General Purpose Input Output（通用输入 / 输出），博流系
|
|||
- 硬件消抖
|
||||
- 驱动能力控制
|
||||
|
||||
bl mcu sdk 的引脚配置方式分为两种。
|
||||
**bl mcu sdk** 的引脚配置方式分为两种。
|
||||
|
||||
- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚的功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。
|
||||
- 通过标准的 GPIO 设备接口配置引脚，缺点是只能配置普通的输入输出和中断功能，复用功能建议还是使用 table 进行配置。
|
||||
|
|
@ -30,8 +30,8 @@ GPIO 设备接口
|
|||
|
||||
void gpio_set_mode(uint32_t pin, uint32_t mode);
|
||||
|
||||
- pin 要配置的引脚
|
||||
- mode 要配置的引脚功能
|
||||
- **pin** 要配置的引脚
|
||||
- **mode** 要配置的引脚功能
|
||||
|
||||
``mode`` 提供以下几种类型
|
||||
|
||||
|
|
@ -62,8 +62,8 @@ GPIO 设备接口
|
|||
void gpio_write(uint32_t pin, uint32_t value);
|
||||
|
||||
|
||||
- pin 要设置的引脚
|
||||
- value 要设置的电平
|
||||
- **pin** 要设置的引脚
|
||||
- **value** 要设置的电平
|
||||
|
||||
**gpio_toggle**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -74,7 +74,7 @@ GPIO 设备接口
|
|||
|
||||
void gpio_toggle(uint32_t pin);
|
||||
|
||||
- pin 要翻转的引脚
|
||||
- **pin** 要翻转的引脚
|
||||
|
||||
**gpio_read**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -86,8 +86,8 @@ GPIO 设备接口
|
|||
int gpio_read(uint32_t pin);
|
||||
|
||||
|
||||
- pin 要读取电平的引脚
|
||||
- return 0 为低电平，1 为高电平
|
||||
- **pin** 要读取电平的引脚
|
||||
- **return** 0 为低电平，1 为高电平
|
||||
|
||||
**gpio_attach_irq**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -98,8 +98,8 @@ GPIO 设备接口
|
|||
|
||||
void gpio_attach_irq(uint32_t pin, void (*cbfun)(uint32_t pin));
|
||||
|
||||
- pin 要附加中断回调的引脚
|
||||
- cbfun 要注册的中断回调函数
|
||||
- **pin** 要附加中断回调的引脚
|
||||
- **cbfun** 要注册的中断回调函数
|
||||
|
||||
**gpio_irq_enable**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -110,5 +110,5 @@ GPIO 设备接口
|
|||
|
||||
void gpio_irq_enable(uint32_t pin,uint8_t enabled);
|
||||
|
||||
- pin 要开启或者关闭中断的引脚
|
||||
- enabled 0 为关闭中断，1 为打开中断
|
||||
- **pin** 要开启或者关闭中断的引脚
|
||||
- **enabled** 0 为关闭中断，1 为打开中断
|
||||
|
|
|
|||
|
|
@ -27,10 +27,10 @@ I2C 设备结构体定义
|
|||
uint32_t phase;
|
||||
} i2c_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- ch i2c id，0 表示 i2c0,1 表示 i2c1
|
||||
- mode i2c 传输模式，0 为使用硬件 i2c，1 为使用软件 i2c，当前软件 i2c 暂时无效
|
||||
- phase 用来计算 i2c 实际时序时钟 ，公式：i2c_clk = i2c_source_clk/(4*(phase+1))
|
||||
- **parent** 继承父类属性
|
||||
- **ch** i2c id，0 表示 i2c0,1 表示 i2c1
|
||||
- **mode** i2c 传输模式，0 为使用硬件 i2c，1 为使用软件 i2c，当前软件 i2c 暂时无效
|
||||
- **phase** 用来计算 i2c 实际时序时钟 ，公式：i2c_clk = i2c_source_clk/(4*(phase+1))
|
||||
- 其他待补充
|
||||
|
||||
I2C 设备参数配置表
|
||||
|
|
@ -71,14 +71,14 @@ I2C 设备标准接口当前仅使用 ``device_open`` , 并提供标准的数据
|
|||
**i2c_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``i2c_register`` 用来注册 I2C 设备标准驱动接口，在注册之前需要打开对应 I2C 设备的宏定义。例如定义宏 ``BSP_USING_I2C0`` 方可使用 ``I2C0`` 设备,注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 ``I2C0`` 设备。
|
||||
``i2c_register`` 用来注册一个 I2C 设备标准驱动接口，在注册之前需要打开对应 I2C 设备的宏定义。例如定义宏 ``BSP_USING_I2C0`` 方可使用 ``I2C0`` 设备,注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 ``I2C0`` 设备。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int i2c_register(enum i2c_index_type index, const char *name);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
- **index** 要注册的设备索引
|
||||
- **name** 为注册的设备命名
|
||||
|
||||
``index`` 用来选择 I2C 设备,一个 index 对应一个 I2C 设备配置，比如 ``I2C0_INDEX`` 对应 ``I2C0_CONFIG`` 配置，``index`` 有如下可选类型
|
||||
|
||||
|
|
@ -95,17 +95,17 @@ I2C 设备标准接口当前仅使用 ``device_open`` , 并提供标准的数据
|
|||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``i2c_open``。
|
||||
``device_open`` 用于打开一个 I2C 设备，实际调用 ``i2c_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **oflag** 设备的打开方式
|
||||
- **return** 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
``oflag`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -125,10 +125,10 @@ I2C 设备标准接口当前仅使用 ``device_open`` , 并提供标准的数据
|
|||
|
||||
int i2c_transfer(struct device *dev, i2c_msg_t msgs[], uint32_t num);
|
||||
|
||||
- dev 设备句柄
|
||||
- msgs 需要传输的消息
|
||||
- num 消息个数
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **msgs** 需要传输的消息
|
||||
- **num** 消息个数
|
||||
- **return** 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``i2c_msg_t`` 结构体定义如下：
|
||||
|
||||
|
|
@ -143,11 +143,11 @@ I2C 设备标准接口当前仅使用 ``device_open`` , 并提供标准的数据
|
|||
uint8_t *buf;
|
||||
} i2c_msg_t;
|
||||
|
||||
- slaveaddr i2c 从设备7位从机地址
|
||||
- subaddr i2c 从设备寄存器地址
|
||||
- flags 读写模式以及寄存器地址长度
|
||||
- len 传输数据长度
|
||||
- buf 数据缓冲区
|
||||
- **slaveaddr** i2c 从设备7位从机地址
|
||||
- **subaddr** i2c 从设备寄存器地址
|
||||
- **flags** 读写模式以及寄存器地址长度
|
||||
- **len** 传输数据长度
|
||||
- **buf** 数据缓冲区
|
||||
|
||||
其中 ``flags`` 有如下定义：
|
||||
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@ I2S 设备
|
|||
|
||||
简介
|
||||
------------------------
|
||||
|
||||
I2S (Inter—IC Sound) 总线, 又称集成电路内置音频总线，为数字音频设备之间的音频数据传输而制定的一种总线标准，
|
||||
该总线专门用于音频设备之间的数据传输，广泛应用于各种多媒体系统。博流系列 MCU 中 I2S 设备具有以下特性：
|
||||
|
||||
|
|
@ -33,17 +34,17 @@ I2S 设备结构体定义
|
|||
void *rx_dma;
|
||||
} i2s_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- id 外设 id 号, 0 表示 I2S0
|
||||
- iis_mode 主从模式选择
|
||||
- interface_mode 协议类型
|
||||
- sampl_freq_hz 音频数据采样率
|
||||
- channel_num 音频通道数，非 DSP 模式下最高 2 通道
|
||||
- frame_size 帧格式长度，即每个通道音频的 BCLK 个数
|
||||
- data_size 实际的有效音频数据位宽，不能大于 frame_size
|
||||
- fifo_threshold 收发数据的 fifo 深度阈值
|
||||
- tx_dma 附加的发送 dma 句柄
|
||||
- rx_dma 附加的接收 dma 句柄
|
||||
- **parent** 继承父类属性
|
||||
- **id** 外设 id 号, 0 表示 I2S0
|
||||
- **iis_mode** 主从模式选择
|
||||
- **interface_mode** 协议类型
|
||||
- **sampl_freq_hz** 音频数据采样率
|
||||
- **channel_num** 音频通道数，非 DSP 模式下最高 2 通道
|
||||
- **frame_size** 帧格式长度，即每个通道音频的 BCLK 个数
|
||||
- **data_size** 实际的有效音频数据位宽，不能大于 frame_size
|
||||
- **fifo_threshold** 收发数据的 fifo 深度阈值
|
||||
- **tx_dma** 附加的发送 dma 句柄
|
||||
- **rx_dma** 附加的接收 dma 句柄
|
||||
|
||||
``iis_mode`` 提供以下类型
|
||||
|
||||
|
|
@ -104,7 +105,7 @@ I2S 设备参数配置表
|
|||
|
||||
每一个 I2S 设备都有一个参数配置宏,宏定义位于 ``bsp/board/xxx`` 目录下 ``peripheral_config.h`` 文件,
|
||||
因此无需用户自己定义变量。当用户打开对应设备的宏，该设备的配置才生效。
|
||||
例如打开宏 ``BSP_USING_I2S0`` ，``I2S0_CONFIG`` 即生效，同时 ``I2S0`` 设备就可以进行注册和使用了。
|
||||
例如打开宏 ``BSP_USING_I2S0`` ， ``I2S0_CONFIG`` 即生效，同时 ``I2S0`` 设备就可以进行注册和使用了。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -140,7 +141,7 @@ I2S 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**i2s_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``i2s_register`` 用来注册 I2S 标准驱动接口，在注册之前需要打开对应 I2S 设备的宏定义,例如定义宏 ``BSP_USING_I2S0`` 方可使用 I2S0 设备。注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 I2S 设备。
|
||||
``i2s_register`` 用来注册一个 I2S 标准驱动接口，在注册之前需要打开对应 I2S 设备的宏定义,例如定义宏 ``BSP_USING_I2S0`` 方可使用 I2S0 设备。注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 I2S 设备。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -163,18 +164,18 @@ I2S 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``i2s_open``。
|
||||
``device_open`` 用于开启一个 I2S 设备，实际调用 ``i2s_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **oflag** 设备的打开方式
|
||||
- **return** 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
``oflag`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -186,28 +187,28 @@ I2S 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。实际调用 ``i2s_close``。
|
||||
``device_close`` 用于关闭一个 I2S 设备，实际调用 ``i2s_close``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **return** 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对设备进行控制和参数的修改。实际调用 ``i2s_control``。
|
||||
``device_control`` 用于对 I2S 设备的进行控制和参数的修改，实际调用 ``i2s_control``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
- **dev** 设备句柄
|
||||
- **cmd** 设备控制命令
|
||||
- **args** 控制参数
|
||||
- **return** 不同的控制命令返回的意义不同。
|
||||
|
||||
I2S 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
||||
|
||||
|
|
@ -247,11 +248,11 @@ I2S 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
|
||||
int device_write(struct device *dev, uint32_t pos, const void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要写入的 buffer 缓冲区
|
||||
- size 要写入的长度
|
||||
- return 错误码，0 表示写入成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** 要写入的 buffer 缓冲区
|
||||
- **size** 要写入的长度
|
||||
- **return** 错误码，0 表示写入成功，其他表示错误
|
||||
|
||||
**device_read**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
|
@ -262,9 +263,9 @@ I2S 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
|
||||
int device_read(struct device *dev, uint32_t pos, void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要读入的 buffer 缓冲区
|
||||
- size 要读入的长度
|
||||
- return 错误码，0 表示读入成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** 要读入的 buffer 缓冲区
|
||||
- **size** 要读入的长度
|
||||
- **return** 错误码，0 表示读入成功，其他表示错误
|
||||
|
||||
|
|
|
|||
|
|
@ -26,13 +26,13 @@ PWM 设备结构体定义
|
|||
|
||||
} pwm_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- ch 通道号，使能PWM通道0则ch为0，使能PWM通道0则ch为1，以此类推
|
||||
- polarity_invert_mode 极性翻转使能
|
||||
- period PWM 周期值
|
||||
- threshold_low PWM 低门限阈值,不能大于period
|
||||
- threshold_high PWM 高门限阈值,不能大于period
|
||||
- it_pulse_count 触发中断条件的周期计数值
|
||||
- **parent** 继承父类属性
|
||||
- **ch** 通道号，使能PWM通道0则ch为0，使能PWM通道0则ch为1，以此类推
|
||||
- **polarity_invert_mode** 极性翻转使能
|
||||
- **period** PWM 周期值
|
||||
- **threshold_low** PWM 低门限阈值,不能大于period
|
||||
- **threshold_high** PWM 高门限阈值,不能大于period
|
||||
- **it_pulse_count** 触发中断条件的周期计数值
|
||||
|
||||
.. note:: PWM 实际频率 = PWM 时钟源/分频/period ，period 非 PWM 实际周期，
|
||||
|
||||
|
|
@ -90,14 +90,14 @@ PWM 设备接口全部遵循标准设备驱动管理层提供的接口。并且
|
|||
**pwm_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pwm_register`` 用来注册 PWM 设备的一个通道的标准驱动接口，在注册之前需要打开对应 PWM 设备某个通道的宏定义,例如定义 ``BSP_USING_PWM_CH0`` 方可使用 ``PWM`` 通道0 设备。注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 PWM 设备。
|
||||
``pwm_register`` 用来注册一个 PWM 设备的一个通道的标准驱动接口，在注册之前需要打开对应 PWM 设备某个通道的宏定义,例如定义 ``BSP_USING_PWM_CH0`` 方可使用 ``PWM`` 通道0 设备。注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 PWM 设备。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int pwm_register(enum pwm_index_type index, const char *name);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
- **index** 要注册的设备索引
|
||||
- **name** 为注册的设备命名
|
||||
|
||||
``index`` 用来选择 PWM 设备某个通道的配置，一个 index 对应一个 PWM 设备的一个通道配置，比如 ``PWM_CH0_INDEX`` 对应 PWM 通道0 配置，``index`` 有如下可选类型
|
||||
|
||||
|
|
@ -126,17 +126,17 @@ PWM 设备接口全部遵循标准设备驱动管理层提供的接口。并且
|
|||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``pwm_open``。
|
||||
``device_open`` 用于打开一个 PWM 设备的一个通道，实际调用 ``pwm_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **oflag** 设备的打开方式
|
||||
- **return** 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
``oflag`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -150,28 +150,28 @@ PWM 设备接口全部遵循标准设备驱动管理层提供的接口。并且
|
|||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。实际调用 ``pwm_close``。
|
||||
``device_close`` 用于关闭一个 PWM 设备的一个通道，实际调用 ``pwm_close``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **return** 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对设备进行控制和参数的修改。实际调用 ``pwm_control``。
|
||||
``device_control`` 用于对 PWM 设备的一个通道进行控制和参数的修改，实际调用 ``pwm_control``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
- **dev** 设备句柄
|
||||
- **cmd** 设备控制命令
|
||||
- **args** 控制参数
|
||||
- **return** 不同的控制命令返回的意义不同。
|
||||
|
||||
PWM 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
||||
|
||||
|
|
@ -195,33 +195,33 @@ PWM 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
- NULL
|
||||
- 关闭当前 PWM 通道
|
||||
* - DEVICE_CTRL_PWM_FREQUENCE_CONFIG
|
||||
- NULL
|
||||
- uint32_t
|
||||
- 配置当前 PWM 通道周期值
|
||||
* - DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG
|
||||
- NULL
|
||||
- pwm_dutycycle_config_t
|
||||
- 配置当前 PWM 通道占空比
|
||||
* - DEVICE_CTRL_PWM_IT_PULSE_COUNT_CONFIG
|
||||
- NULL
|
||||
- uint32_t
|
||||
- 配置触发 PWM 中断周期值
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_set_callback`` 用于注册一个PWM通道中断回调函数。
|
||||
``device_set_callback`` 用于注册一个 PWM 设备的一个通道中断回调函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
- **dev** 设备句柄
|
||||
- **callback** 要注册的中断回调函数
|
||||
|
||||
- dev 设备句柄
|
||||
- args 无用
|
||||
- size 无用
|
||||
- event 中断事件类型
|
||||
- **dev** 设备句柄
|
||||
- **args** 无用
|
||||
- **size** 无用
|
||||
- **event** 中断事件类型
|
||||
|
||||
PWM设备 ``event`` 类型如下
|
||||
``event`` 类型如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -233,61 +233,61 @@ PWM设备 ``event`` 类型如下
|
|||
**pwm_channel_start**
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pwm_channel_start`` 用于开启PWM通道。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEVICE_CTRL_RESUME``。
|
||||
``pwm_channel_start`` 用于开启 PWM 通道。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEVICE_CTRL_RESUME``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
pwm_channel_start(dev)
|
||||
|
||||
- dev 需要开启的pwm通道句柄
|
||||
- **dev** 需要开启的 pwm 通道句柄
|
||||
|
||||
|
||||
**pwm_channel_stop**
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pwm_channel_stop`` 用于关闭PWM通道。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEVICE_CTRL_SUSPEND``。
|
||||
``pwm_channel_stop`` 用于关闭 PWM 通道。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEVICE_CTRL_SUSPEND``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
pwm_channel_stop(dev)
|
||||
|
||||
- dev 需要关闭的pwm通道句柄
|
||||
- **dev** 需要关闭的 pwm 通道句柄
|
||||
|
||||
|
||||
**pwm_channel_freq_update**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pwm_channel_freq_update`` 用于更新PWM通道的频率。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEIVCE_CTRL_PWM_FREQUENCE_CONFIG``。
|
||||
``pwm_channel_freq_update`` 用于更新 PWM 通道的频率。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEIVCE_CTRL_PWM_FREQUENCE_CONFIG``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
pwm_channel_freq_update(dev,count)
|
||||
|
||||
- dev 需要更新的pwm通道句柄
|
||||
- count 周期值 ，实际频率=pwm_clk/pwm_div/count
|
||||
- **dev** 需要更新的 pwm 通道句柄
|
||||
- **count** 周期值，实际频率 = pwm_clk/pwm_div/count
|
||||
|
||||
**pwm_channel_dutycycle_update**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pwm_channel_dutycycle_update`` 用于更新PWM通道的频率。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG``。
|
||||
``pwm_channel_dutycycle_update`` 用于更新 PWM 通道的频率。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
pwm_channel_dutycycle_update(dev,cfg)
|
||||
|
||||
- dev 需要更新周期计数值的pwm通道句柄
|
||||
- cfg pwm_dutycycle_config_t句柄
|
||||
- **dev** 需要更新周期计数值的 pwm 通道句柄
|
||||
- **cfg** pwm_dutycycle_config_t 句柄
|
||||
|
||||
|
||||
**pwm_it_pulse_count_update**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pwm_it_pulse_count_update`` 用于更新PWM通道的计数值，需要先使能PWM中断才起作用，当pwm计数达到设置的周期计数值则会产生中断。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEIVCE_CTRL_PWM_IT_PULSE_COUNT_CONFIG``。
|
||||
``pwm_it_pulse_count_update`` 用于更新 PWM 通道的计数值，需要先使能 PWM 中断才起作用，当 pwm 计数达到设置的周期计数值则会产生中断。实际是调用 ``device_control`` ，其中 ``cmd`` 为 ``DEIVCE_CTRL_PWM_IT_PULSE_COUNT_CONFIG``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
pwm_it_pulse_count_update(dev,count)
|
||||
|
||||
- dev 需要更新周期计数值的pwm通道句柄
|
||||
- count 周期计数值
|
||||
- **dev** 需要更新周期计数值的 pwm 通道句柄
|
||||
- **count** 周期计数值
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,317 @@
|
|||
QDEC 设备
|
||||
=========================
|
||||
|
||||
简介
|
||||
------------------------
|
||||
|
||||
QDEC（quadrature decoder）正交解码器，用于将双路旋转编码器产生的两组相位相差 90 度的脉冲解码为对应转速和旋转方向。博流系列 MCU 中 QDEC 设备具有以下特性：
|
||||
|
||||
- 拥有 3 组 QDEC 设备可使用
|
||||
- 多种时钟来源选择，QDEC 的时钟源可以设置为 32KHz 或者 32MHz，当使用 32KHz 的时钟源时，可以从睡眠模式中唤醒
|
||||
- 5-bit 时钟分频器，分频系数为 1-32
|
||||
- 16-bit 脉冲计数器，计数范围 -32768~32767 pulse/sample
|
||||
- 12 种可配置的 sample 周期（32us~131ms per sample at 1MHz）
|
||||
- 16-bit 可设置的 report 周期（0~65535 sample/report）
|
||||
- 内置一个可随采样进行闪烁的 LED 功能（LED on/off 0~511 us/sample）
|
||||
- 支持 4 路可配置中断源（sample 中断、report 中断、error 中断、overflow 中断）
|
||||
- 可配置为 PDS 的唤醒源（clock source 需要配置为 32KHz）
|
||||
|
||||
QDEC 设备结构体定义
|
||||
------------------------
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef struct qdec_device {
|
||||
struct device parent;
|
||||
uint8_t id;
|
||||
uint8_t acc_mode;
|
||||
uint8_t sample_mode;
|
||||
uint8_t sample_period;
|
||||
uint8_t report_mode;
|
||||
uint32_t report_period;
|
||||
uint8_t led_en;
|
||||
uint8_t led_swap;
|
||||
uint16_t led_period;
|
||||
uint8_t deglitch_en;
|
||||
uint8_t deglitch_strength;
|
||||
} qdec_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- id 正交解码器 id ，使用正交解码器 0 则 id 为 0 ，使用正交解码器 1 则 id 为 1 ，以此类推
|
||||
- acc_mode QDEC 计数模式：连续计数和溢出即停止 两种模式
|
||||
- sample_mode QDEC 采样模式：连续采样和完成采样即停止 两种模式
|
||||
- sample_period QDEC 采样周期选择
|
||||
- report_mode QDEC report 模式
|
||||
- report_period report 周期设置
|
||||
- led_en 随动 LED 功能使能
|
||||
- led_swap led 引脚交换
|
||||
- led_period led 输出频率
|
||||
- deglitch_en 消抖功能使能
|
||||
- deglitch_strength 消抖长度
|
||||
|
||||
``id`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum qdec_index_type {
|
||||
QDEC0_INDEX,
|
||||
QDEC1_INDEX,
|
||||
QDEC2_INDEX,
|
||||
QDEC_MAX_INDEX,
|
||||
};
|
||||
|
||||
``acc_mode`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum acc_mode_type {
|
||||
QDEC_ACC_STOP_SAMPLE_IF_OVERFLOW,
|
||||
QDEC_ACC_CONTINUE_ACCUMULATE,
|
||||
};
|
||||
|
||||
``sample_mode`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum sample_mode_type {
|
||||
QDEC_SAMPLE_SINGLE_MOD,
|
||||
QDEC_SAMPLE_CONTINUE_MOD,
|
||||
};
|
||||
|
||||
``report_mode`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum report_mode_type {
|
||||
QDEC_REPORT_SAMPLE_CHANGE_MOD,
|
||||
QDEC_REPORT_TIME_MOD,
|
||||
};
|
||||
|
||||
|
||||
QDEC 设备参数配置表
|
||||
------------------------
|
||||
|
||||
每一个 QDEC 设备都有一个参数配置宏，宏定义位于 ``bsp/board/xxx`` 目录下 ``peripheral_config.h`` 文件，变量定义位于 ``hal_qdec.c`` 中，因此无需用户自己定义变量。当用户打开对应设备的宏，该设备的配置才生效。例如打开宏 ``BSP_USING_QDEC0`` ，``QDEC0_CONFIG`` 即生效，同时 ``QDEC0_INDEX`` 设备就可以进行注册和使用了。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
/*参数配置宏*/
|
||||
#if defined(BSP_USING_QDEC0)
|
||||
#ifndef QDEC0_CONFIG
|
||||
#define QDEC0_CONFIG \
|
||||
{ \
|
||||
.id = 0, \
|
||||
.acc_mode = QDEC_ACC_CONTINUE_ACCUMULATE, \
|
||||
.sample_mode = QDEC_SAMPLE_SINGLE_MOD, \
|
||||
.sample_period = QDEC_SAMPLE_PERIOD_256US, \
|
||||
.report_mode = QDEC_REPORT_TIME_MOD, \
|
||||
.report_period = 2000, \
|
||||
.led_en = ENABLE, \
|
||||
.led_swap = DISABLE, \
|
||||
.led_period = 7, \
|
||||
.deglitch_en = DISABLE, \
|
||||
.deglitch_strength = 0x0, \
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#if defined(BSP_USING_QDEC1)
|
||||
#ifndef QDEC1_CONFIG
|
||||
#define QDEC1_CONFIG \
|
||||
{ \
|
||||
.id = 1, \
|
||||
.acc_mode = QDEC_ACC_CONTINUE_ACCUMULATE, \
|
||||
.sample_mode = QDEC_SAMPLE_SINGLE_MOD, \
|
||||
.sample_period = QDEC_SAMPLE_PERIOD_256US, \
|
||||
.report_mode = QDEC_REPORT_TIME_MOD, \
|
||||
.report_period = 2000, \
|
||||
.led_en = ENABLE, \
|
||||
.led_swap = DISABLE, \
|
||||
.led_period = 7, \
|
||||
.deglitch_en = DISABLE, \
|
||||
.deglitch_strength = 0x0, \
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#if defined(BSP_USING_QDEC2)
|
||||
#ifndef QDEC2_CONFIG
|
||||
#define QDEC2_CONFIG \
|
||||
{ \
|
||||
.id = 2, \
|
||||
.acc_mode = QDEC_ACC_CONTINUE_ACCUMULATE, \
|
||||
.sample_mode = QDEC_SAMPLE_SINGLE_MOD, \
|
||||
.sample_period = QDEC_SAMPLE_PERIOD_256US, \
|
||||
.report_mode = QDEC_REPORT_TIME_MOD, \
|
||||
.report_period = 2000, \
|
||||
.led_en = ENABLE, \
|
||||
.led_swap = DISABLE, \
|
||||
.led_period = 7, \
|
||||
.deglitch_en = DISABLE, \
|
||||
.deglitch_strength = 0x0, \
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/*变量定义*/
|
||||
static qdec_device_t qdecx_device[QDEC_MAX_INDEX] = {
|
||||
#ifdef BSP_USING_QDEC0
|
||||
QDEC0_CONFIG,
|
||||
#endif
|
||||
#ifdef BSP_USING_QDEC1
|
||||
QDEC1_CONFIG,
|
||||
#endif
|
||||
#ifdef BSP_USING_QDEC2
|
||||
QDEC2_CONFIG,
|
||||
#endif
|
||||
};
|
||||
|
||||
.. note:: 上述配置可以通过 ``QDEC_DEV(dev)->xxx`` 进行修改，只能在调用 ``device_open`` 之前使用。
|
||||
|
||||
QDEC 设备接口
|
||||
------------------------
|
||||
|
||||
QDEC 设备接口全部遵循标准设备驱动管理层提供的接口。
|
||||
|
||||
**qdec_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``qdec_register`` 用来注册 QDEC 设备标准驱动接口，在注册之前需要打开对应 QDEC 设备的宏定义。例如定义宏 ``BSP_USING_QDEC0`` 方可使用 ``QDEC0_INDEX`` 设备，注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 ``QDEC0_INDEX`` 设备。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int qdec_register(enum qdec_index_type index, const char *name);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
|
||||
``index`` 用来选择 QDEC 设备配置，一个 index 对应一个 QDEC 设备配置，比如 ``QDEC0_INDEX`` 对应 ``QDEC0_CONFIG`` 配置，``index`` 有如下可选类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum qdec_index_type {
|
||||
#ifdef BSP_USING_QDEC0
|
||||
QDEC0_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_QDEC1
|
||||
QDEC1_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_QDEC2
|
||||
QDEC2_INDEX,
|
||||
#endif
|
||||
QDEC_MAX_INDEX,
|
||||
};
|
||||
|
||||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于 QDEC 设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``qdec_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEVICE_OFLAG_STREAM_TX 0x001 /* 设备以轮训发送模式打开 */
|
||||
#define DEVICE_OFLAG_STREAM_RX 0x002 /* 设备以轮训接收模式打开 */
|
||||
#define DEVICE_OFLAG_INT_TX 0x004 /* 设备以中断发送模式打开 */
|
||||
#define DEVICE_OFLAG_INT_RX 0x008 /* 设备以中断接收模式打开 */
|
||||
#define DEVICE_OFLAG_DMA_TX 0x010 /* 设备以 DMA 发送模式打开 */
|
||||
#define DEVICE_OFLAG_DMA_RX 0x020 /* 设备以 DMA 接收模式打开 */
|
||||
|
||||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。实际调用 ``qdec_close``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对 QDEC 设备进行控制和参数的修改。实际调用 ``qdec_control``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
.. list-table:: table1
|
||||
:widths: 15 10 30
|
||||
:header-rows: 1
|
||||
|
||||
* - cmd
|
||||
- args
|
||||
- description
|
||||
* - DEVICE_CTRL_SET_INT
|
||||
- NULL
|
||||
- 开启 QDEC 中断
|
||||
* - DEVICE_CTRL_CLR_INT
|
||||
- NULL
|
||||
- 关闭 QDEC 中断
|
||||
* - DEVICE_CTRL_GET_INT
|
||||
- NULL
|
||||
- 获取当前中断状态
|
||||
* - DEVICE_CTRL_RESUME
|
||||
- NULL
|
||||
- 开启 QDEC
|
||||
* - DEVICE_CTRL_SUSPEND
|
||||
- NULL
|
||||
- 关闭 QDEC
|
||||
* - DEVICE_CTRL_GET_SAMPLE_VAL
|
||||
- NULL
|
||||
- 获取 QDEC 当前的计数值
|
||||
* - DEVICE_CTRL_GET_SAMPLE_DIR
|
||||
- NULL
|
||||
- 获取 QDEC 当前的计数方向
|
||||
* - DEVICE_CTRL_GET_ERROR_CNT
|
||||
- NULL
|
||||
- 获取 QDEC 当前的错误计数次数
|
||||
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_set_callback`` 用于注册一个 QDEC 中断回调函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
|
||||
- dev 设备句柄
|
||||
- args 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- size 传输长度
|
||||
- event 中断事件类型
|
||||
|
||||
QDEC 设备 ``event`` 类型如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum qdec_event_type {
|
||||
QDEC_REPORT_EVENT, /*!< report interrupt */
|
||||
QDEC_SAMPLE_EVENT, /*!< sample interrupt */
|
||||
QDEC_ERROR_EVENT, /*!< error interrupt */
|
||||
QDEC_OVERFLOW_EVENT, /*!< ACC1 and ACC2 overflow interrupt */
|
||||
QDEC_ALL_EVENT, /*!< interrupt max num */
|
||||
};
|
||||
|
|
@ -38,17 +38,17 @@ SPI 设备结构体定义
|
|||
void* rx_dma;
|
||||
} spi_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- id SPI id，0 表示 SPI0
|
||||
- clk SPI 时钟频率
|
||||
- mode 主机模式或者从机模式
|
||||
- direction 传输先行模式
|
||||
- clk_polaraity 时钟极性
|
||||
- clk_phase 时钟相位
|
||||
- datasize 数据传输位宽
|
||||
- fifo_threshold fifo 阈值, 最大为 4
|
||||
- tx_dma 附加的发送 dma 句柄
|
||||
- rx_dma 附加的接收 dma 句柄
|
||||
- **parent** 继承父类属性
|
||||
- **id** SPI id，0 表示 SPI0
|
||||
- **clk** SPI 时钟频率
|
||||
- **mode** 主机模式或者从机模式
|
||||
- **direction** 传输先行模式
|
||||
- **clk_polaraity** 时钟极性
|
||||
- **clk_phase** 时钟相位
|
||||
- **datasize** 数据传输位宽
|
||||
- **fifo_threshold** fifo 阈值, 最大为 4
|
||||
- **tx_dma** 附加的发送 dma 句柄
|
||||
- **rx_dma** 附加的接收 dma 句柄
|
||||
|
||||
``mode`` 提供以下类型
|
||||
|
||||
|
|
@ -139,8 +139,8 @@ SPI 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
int spi_register(enum spi_index_type index, const char *name);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
- **index** 要注册的设备索引
|
||||
- **name** 为注册的设备命名
|
||||
|
||||
``index`` 用来选择 SPI 设备配置，一个 index 对应一个 SPI 设备配置，比如 ``SPI0_INDEX`` 对应 ``SPI0_CONFIG`` 配置，``index`` 有如下可选类型
|
||||
|
||||
|
|
@ -157,17 +157,17 @@ SPI 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``spi_open``。
|
||||
``device_open`` 用于打开一个 SPI 设备，实际调用 ``spi_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **oflag** 设备的打开方式
|
||||
- **return** 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
``oflag`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -181,28 +181,28 @@ SPI 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。实际调用 ``spi_close``。
|
||||
``device_close`` 用于关闭一个 SPI 设备，实际调用 ``spi_close``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **return** 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对设备进行控制和参数的修改。实际调用 ``spi_control``。
|
||||
``device_control`` 用于对 SPI 设备进行控制和参数的修改，实际调用 ``spi_control``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
- **dev** 设备句柄
|
||||
- **cmd** 设备控制命令
|
||||
- **args** 控制参数
|
||||
- **return** 不同的控制命令返回的意义不同。
|
||||
|
||||
SPI 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
||||
|
||||
|
|
@ -262,11 +262,11 @@ SPI 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
|
||||
int device_write(struct device *dev, uint32_t pos, const void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要写入的 buffer 缓冲区
|
||||
- size 要写入的长度
|
||||
- return 错误码，0 表示写入成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** 要写入的 buffer 缓冲区
|
||||
- **size** 要写入的长度
|
||||
- **return** 错误码，0 表示写入成功，其他表示错误
|
||||
|
||||
**device_read**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
|
@ -277,11 +277,11 @@ SPI 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
|
||||
int device_read(struct device *dev, uint32_t pos, void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要读入的 buffer 缓冲区
|
||||
- size 要读入的长度
|
||||
- return 错误码，0 表示读入成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** 要读入的 buffer 缓冲区
|
||||
- **size** 要读入的长度
|
||||
- **return** 错误码，0 表示读入成功，其他表示错误
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -292,15 +292,15 @@ SPI 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
- **dev** 设备句柄
|
||||
- **callback** 要注册的中断回调函数
|
||||
|
||||
- dev 设备句柄
|
||||
- args 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- size 传输长度
|
||||
- event 中断事件类型
|
||||
- **dev** 设备句柄
|
||||
- **args** 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- **size** 传输长度
|
||||
- **event** 中断事件类型
|
||||
|
||||
SPI 设备 ``event`` 类型如下
|
||||
``event`` 类型如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -320,10 +320,10 @@ SPI 设备 ``event`` 类型如下
|
|||
|
||||
int spi_transmit(struct device *dev, void *buffer, uint32_t size, uint8_t type);
|
||||
|
||||
- dev 设备句柄
|
||||
- buffer 发送数据缓冲区
|
||||
- size 发送长度
|
||||
- type 发送位宽类型
|
||||
- **dev** 设备句柄
|
||||
- **buffer** 发送数据缓冲区
|
||||
- **size** 发送长度
|
||||
- **type** 发送位宽类型
|
||||
|
||||
``type`` 提供以下类型
|
||||
|
||||
|
|
@ -343,10 +343,10 @@ SPI 设备 ``event`` 类型如下
|
|||
|
||||
int spi_receive(struct device *dev, void *buffer, uint32_t size, uint8_t type);
|
||||
|
||||
- dev 设备句柄
|
||||
- buffer 接收数据缓冲区
|
||||
- size 接收长度
|
||||
- type 位宽类型
|
||||
- **dev** 设备句柄
|
||||
- **buffer** 接收数据缓冲区
|
||||
- **size** 接收长度
|
||||
- **type** 位宽类型
|
||||
|
||||
**spi_transmit_receive**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -357,8 +357,8 @@ SPI 设备 ``event`` 类型如下
|
|||
|
||||
int spi_transmit_receive(struct device *dev, const void *send_buf, void *recv_buf, uint32_t length, uint8_t type);
|
||||
|
||||
- dev 设备句柄
|
||||
- send_buf 发送数据缓冲区
|
||||
- recv_buf 接收数据缓冲区
|
||||
- length 收发长度
|
||||
- type 位宽类型
|
||||
- **dev** 设备句柄
|
||||
- **send_buf** 发送数据缓冲区
|
||||
- **recv_buf** 接收数据缓冲区
|
||||
- **length** 收发长度
|
||||
- **type** 位宽类型
|
||||
|
|
|
|||
|
|
@ -31,14 +31,14 @@ TIMER 设备结构体定义
|
|||
uint32_t timeout3;
|
||||
} timer_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- id 定时器 id ，使能定时器 0 则 id 为 0 ，使能定时器 1 则 id 为 1 ，以此类推
|
||||
- cnt_mode 计数模式：FreeRun 和 PreLoad
|
||||
- trigger 比较器的触发源
|
||||
- reload 重装载值,只有在 PreLoad 模式下有效
|
||||
- timeout1 COMP0 超时时间，单位 us
|
||||
- timeout2 COMP1 超时时间，单位 us
|
||||
- timeout3 COMP2 超时时间，单位 us
|
||||
- **parent** 继承父类属性
|
||||
- **id** 定时器 id ，使能定时器 0 则 id 为 0 ，使能定时器 1 则 id 为 1 ，以此类推
|
||||
- **cnt_mode** 计数模式：FreeRun 和 PreLoad
|
||||
- **trigger** 比较器的触发源
|
||||
- **reload** 重装载值,只有在 PreLoad 模式下有效
|
||||
- **timeout1** COMP0 超时时间，单位 us
|
||||
- **timeout2** COMP1 超时时间，单位 us
|
||||
- **timeout3** COMP2 超时时间，单位 us
|
||||
|
||||
``ch`` 提供以下类型
|
||||
|
||||
|
|
@ -134,8 +134,8 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
int timer_register(enum timer_index_type index, const char *name);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
- **index** 要注册的设备索引
|
||||
- **name** 为注册的设备命名
|
||||
|
||||
``index`` 用来选择 TIMER 设备配置，一个 index 对应一个 TIMER 设备配置，比如 ``TIMER0_INDEX`` 对应 ``TIMER0_CONFIG`` 配置，``index`` 有如下可选类型
|
||||
|
||||
|
|
@ -154,17 +154,17 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于 TIMER 设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``timer_open``。
|
||||
``device_open`` 用于打开一个 TIMER 设备，实际调用 ``timer_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **oflag** 设备的打开方式
|
||||
- **return** 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
``oflag`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -178,28 +178,28 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。实际调用 ``timer_close``。
|
||||
``device_close`` 用于关闭一个 TIMER 设备，实际调用 ``timer_close``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **return** 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对 TIMER 设备进行控制和参数的修改。实际调用 ``timer_control``。
|
||||
``device_control`` 用于对 TIMER 设备的进行控制和参数的修改，实际调用 ``timer_control``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
- **dev** 设备句柄
|
||||
- **cmd** 设备控制命令
|
||||
- **args** 控制参数
|
||||
- **return** 不同的控制命令返回的意义不同。
|
||||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
|
|
@ -211,10 +211,10 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
- args
|
||||
- description
|
||||
* - DEVICE_CTRL_SET_INT
|
||||
- NULL
|
||||
- timer_it_type
|
||||
- 开启 TIMER 中断
|
||||
* - DEVICE_CTRL_CLR_INT
|
||||
- NULL
|
||||
- timer_it_type
|
||||
- 关闭 TIMER 中断
|
||||
* - DEVICE_CTRL_GET_INT
|
||||
- NULL
|
||||
|
|
@ -232,36 +232,36 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_write**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_write`` 用于 Timer 设备配置超时时间。实际调用 ``timer_write``。
|
||||
``device_write`` 用于配置 TIMER 设备超时时间，实际调用 ``timer_write``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_write(struct device *dev, uint32_t pos, const void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer timer_timeout_cfg_t 句柄
|
||||
- size timer_timeout_cfg_t 个数
|
||||
- return 错误码，0 表示写入成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** timer_timeout_cfg_t 句柄
|
||||
- **size** timer_timeout_cfg_t 个数
|
||||
- **return** 错误码，0 表示写入成功，其他表示错误
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_set_callback`` 用于注册一个 TIMER 中断回调函数。
|
||||
``device_set_callback`` 用于注册一个 TIMER 设备中断回调函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
- **dev** 设备句柄
|
||||
- **callback** 要注册的中断回调函数
|
||||
|
||||
- dev 设备句柄
|
||||
- args 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- size 传输长度
|
||||
- event 中断事件类型
|
||||
- **dev** 设备句柄
|
||||
- **args** 无
|
||||
- **size** 无
|
||||
- **event** 中断事件类型
|
||||
|
||||
TIMER 设备 ``event`` 类型如下
|
||||
``event`` 类型如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
|
|||
|
|
@ -34,15 +34,15 @@ UART 设备结构体定义
|
|||
void* rx_dma;
|
||||
} uart_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- id 串口 id，使能串口0则id为0，使能串口1则id为1，以此类推
|
||||
- baudrate 波特率
|
||||
- databits 数据位
|
||||
- stopbits 停止位
|
||||
- parity 校验位
|
||||
- fifo_threshold fifo 阈值,不同 mcu 最大值不同
|
||||
- tx_dma 附加的发送 dma 句柄
|
||||
- rx_dma 附加的接收 dma 句柄
|
||||
- **parent** 继承父类属性
|
||||
- **id** 串口 id，使能串口0则id为0，使能串口1则id为1，以此类推
|
||||
- **baudrate** 波特率
|
||||
- **databits** 数据位
|
||||
- **stopbits** 停止位
|
||||
- **parity** 校验位
|
||||
- **fifo_threshold** fifo 阈值,不同 mcu 最大值不同
|
||||
- **tx_dma** 附加的发送 dma 句柄
|
||||
- **rx_dma** 附加的接收 dma 句柄
|
||||
|
||||
``databits`` 提供以下类型
|
||||
|
||||
|
|
@ -127,8 +127,8 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
int uart_register(enum uart_index_type index, const char *name);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
- **index** 要注册的设备索引
|
||||
- **name** 为注册的设备命名
|
||||
|
||||
``index`` 用来选择 UART 设备配置，一个 index 对应一个 UART 设备配置，比如 ``UART0_INDEX`` 对应 ``UART0_CONFIG`` 配置，``index`` 有如下可选类型
|
||||
|
||||
|
|
@ -148,17 +148,17 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于 UART 设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``uart_open``。
|
||||
``device_open`` 用于打开 UART 设备，实际调用 ``uart_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0 表示打开成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **oflag** 设备的打开方式
|
||||
- **return** 错误码，0 表示打开成功，其他表示错误
|
||||
|
||||
``oflag`` 可以写入以下参数：
|
||||
``oflag`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -172,28 +172,28 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。实际调用 ``uart_close``。
|
||||
``device_close`` 用于关闭 UART 设备，实际调用 ``uart_close``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0 表示关闭成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **return** 错误码，0 表示关闭成功，其他表示错误
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对 UART 设备进行控制和参数的修改。实际调用 ``uart_control``。
|
||||
``device_control`` 用于对 UART 设备的进行控制和参数的修改，实际调用 ``uart_control``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
- **dev** 设备句柄
|
||||
- **cmd** 设备控制命令
|
||||
- **args** 控制参数
|
||||
- **return** 不同的控制命令返回的意义不同。
|
||||
|
||||
串口设备除了标准的控制命令，还具有自己特殊的控制命令。
|
||||
|
||||
|
|
@ -254,11 +254,11 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
int device_write(struct device *dev, uint32_t pos, const void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要写入的 buffer 缓冲区
|
||||
- size 要写入的长度
|
||||
- return 错误码，0 表示写入成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** 要写入的 buffer 缓冲区
|
||||
- **size** 要写入的长度
|
||||
- **return** 错误码，0 表示写入成功，其他表示错误
|
||||
|
||||
**device_read**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
|
@ -269,30 +269,30 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
int device_read(struct device *dev, uint32_t pos, void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要读入的 buffer 缓冲区
|
||||
- size 要读入的长度
|
||||
- return 错误码，0 表示读入成功，其他表示错误
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** 要读入的 buffer 缓冲区
|
||||
- **size** 要读入的长度
|
||||
- **return** 错误码，0 表示读入成功，其他表示错误
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_set_callback`` 用于注册一个串口中断回调函数。
|
||||
``device_set_callback`` 用于注册一个 UART 设备中断回调函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
- **dev** 设备句柄
|
||||
- **callback** 要注册的中断回调函数
|
||||
|
||||
- dev 设备句柄
|
||||
- args 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- size 传输长度
|
||||
- event 中断事件类型
|
||||
- **dev** 设备句柄
|
||||
- **args** 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- **size** 传输长度
|
||||
- **event** 中断事件类型
|
||||
|
||||
串口设备 ``event`` 类型如下
|
||||
``event`` 类型如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
|
|||
|
|
@ -28,12 +28,12 @@ USB 设备结构体定义
|
|||
void *rx_dma;
|
||||
} usb_dc_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- id USB id，0 表示 USB0
|
||||
- in_ep USB 输入端点的参数
|
||||
- out_ep USB 输出端点的参数
|
||||
- tx_dma 附加的发送 dma 句柄
|
||||
- rx_dma 附加的接收 dma 句柄
|
||||
- **parent** 继承父类属性
|
||||
- **id** USB id，0 表示 USB0
|
||||
- **in_ep** USB 输入端点的参数
|
||||
- **out_ep** USB 输出端点的参数
|
||||
- **tx_dma** 附加的发送 dma 句柄
|
||||
- **rx_dma** 附加的接收 dma 句柄
|
||||
|
||||
|
||||
``in_ep`` ``out_ep`` 的结构如下
|
||||
|
|
@ -47,9 +47,9 @@ USB 设备结构体定义
|
|||
struct usb_dc_ep_cfg ep_cfg;
|
||||
} usb_dc_ep_state_t;
|
||||
|
||||
- ep_ena 继承父类属性
|
||||
- is_stalled 挂起状态，0表示非挂起状态，1表示挂起状态
|
||||
- ep_cfg 端点的属性
|
||||
- **ep_ena** 继承父类属性
|
||||
- **is_stalled** 挂起状态，0表示非挂起状态，1表示挂起状态
|
||||
- **ep_cfg** 端点的属性
|
||||
|
||||
|
||||
``ep_cfg`` 的结构如下
|
||||
|
|
@ -62,9 +62,9 @@ USB 设备结构体定义
|
|||
uint8_t ep_type;
|
||||
};
|
||||
|
||||
- ep_addr 端点的地址
|
||||
- ep_mps 端点最大 packet 长度
|
||||
- ep_type 端点传输类型
|
||||
- **ep_addr** 端点的地址
|
||||
- **ep_mps** 端点最大 packet 长度
|
||||
- **ep_type** 端点传输类型
|
||||
|
||||
|
||||
.. note:: 以上参数无需用户配置
|
||||
|
|
@ -77,54 +77,54 @@ USB 设备接口遵循标准设备驱动管理层提供的接口。
|
|||
**usb_dc_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``usb_dc_register`` 用来注册 USB 设备标准驱动接口，在注册之前需要打开对应 USB 设备的宏定义,例如定义宏 ``BSP_USING_USB`` 方可使用 USB 设备。注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 USB 设备。
|
||||
``usb_dc_register`` 用来注册一个 USB 从设备标准驱动接口，在注册之前需要打开对应 USB 设备的宏定义,例如定义宏 ``BSP_USING_USB`` 方可使用 USB 设备。注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 USB 设备。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int usb_dc_register(enum usb_index_type index, const char *name);
|
||||
|
||||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **index** 要注册的设备索引
|
||||
- **name** 为注册的设备命名
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
**device_open**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_open`` 用于设备的打开，``oflag`` 表示以何种方式打开。实际调用 ``usb_open``。
|
||||
``device_open`` 用于打开一个 USB 设备，实际调用 ``usb_open``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_open(struct device *dev, uint16_t oflag);
|
||||
|
||||
- dev 设备句柄
|
||||
- oflag 设备的打开方式
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备句柄
|
||||
- **oflag** 设备的打开方式
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
**device_close**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_close`` 用于设备的关闭。实际调用 ``usb_close``。
|
||||
``device_close`` 用于关闭一个 USB 设备，实际调用 ``usb_close``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_close(struct device *dev);
|
||||
|
||||
- dev 设备句柄
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备句柄
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
**device_control**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``device_control`` 用于根据命令对设备进行控制和参数的修改。实际调用 ``usb_control``。
|
||||
``device_control`` 用于对 USB 设备的进行控制和参数的修改，实际调用 ``usb_control``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
int device_control(struct device *dev, int cmd, void *args);
|
||||
|
||||
- dev 设备句柄
|
||||
- cmd 设备控制命令
|
||||
- args 控制参数
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备句柄
|
||||
- **cmd** 设备控制命令
|
||||
- **args** 控制参数
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
USB 设备除了标准的控制命令，还具有私有的控制命令。
|
||||
|
||||
|
|
@ -135,6 +135,9 @@ USB 设备除了标准的控制命令，还具有私有的控制命令。
|
|||
* - cmd
|
||||
- args
|
||||
- description
|
||||
* - DEVICE_CTRL_SET_INT
|
||||
- uint32_t
|
||||
- 开启 USB 中断
|
||||
* - DEVICE_CTRL_USB_DC_SET_ACK
|
||||
- uint32_t
|
||||
- 设置 USB 设备 ACK 状态
|
||||
|
|
@ -163,20 +166,6 @@ USB 设备除了标准的控制命令，还具有私有的控制命令。
|
|||
- uint32_t
|
||||
- 开启 USB 设备通过 dma 接收
|
||||
|
||||
``args`` 支持的标准控制命令 ``cmd`` 具体如下：
|
||||
|
||||
.. list-table:: table2
|
||||
:widths: 15 10 30
|
||||
:header-rows: 1
|
||||
|
||||
* - cmd
|
||||
- args
|
||||
- description
|
||||
* - DEVICE_CTRL_SET_INT
|
||||
- uint32_t
|
||||
- 开启 USB 中断
|
||||
|
||||
|
||||
**device_write**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
|
|
@ -186,11 +175,11 @@ USB 设备除了标准的控制命令，还具有私有的控制命令。
|
|||
|
||||
int device_write(struct device *dev, uint32_t pos, const void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要写入的 buffer 缓冲区
|
||||
- size 要写入的长度
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** 要写入的 buffer 缓冲区
|
||||
- **size** 要写入的长度
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
**device_read**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
|
@ -201,11 +190,11 @@ USB 设备除了标准的控制命令，还具有私有的控制命令。
|
|||
|
||||
int device_read(struct device *dev, uint32_t pos, void *buffer, uint32_t size);
|
||||
|
||||
- dev 设备句柄
|
||||
- pos 无作用
|
||||
- buffer 要读入的 buffer 缓冲区
|
||||
- size 要读入的长度
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备句柄
|
||||
- **pos** 无作用
|
||||
- **buffer** 要读入的 buffer 缓冲区
|
||||
- **size** 要读入的长度
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -216,16 +205,16 @@ USB 设备除了标准的控制命令，还具有私有的控制命令。
|
|||
|
||||
int device_set_callback(struct device *dev, void (*callback)(struct device *dev, void *args, uint32_t size, uint32_t event));
|
||||
|
||||
- dev 设备句柄
|
||||
- callback 要注册的中断回调函数
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备句柄
|
||||
- **callback** 要注册的中断回调函数
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
- dev 设备句柄
|
||||
- args 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- size 传输长度
|
||||
- event 中断事件类型
|
||||
- **dev** 设备句柄
|
||||
- **args** 接收发送缓冲区，数据类型为 uint8_t*
|
||||
- **size** 传输长度
|
||||
- **event** 中断事件类型
|
||||
|
||||
USB 设备 ``event`` 类型如下
|
||||
``event`` 类型如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -270,10 +259,10 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_send_from_ringbuffer(struct device *dev, Ring_Buffer_Type *rb, uint8_t ep);
|
||||
|
||||
- dev 设备指针
|
||||
- rb rinbuffer 结构体指针
|
||||
- ep 端点地址
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备指针
|
||||
- **rb** rinbuffer 结构体指针
|
||||
- **ep** 端点地址
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
**usb_dc_receive_to_ringbuffer**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -284,10 +273,10 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_receive_to_ringbuffer(struct device *dev, Ring_Buffer_Type *rb, uint8_t ep);
|
||||
|
||||
- dev 设备指针
|
||||
- rb rinbuffer 结构体指针
|
||||
- ep 端点地址
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **dev** 设备指针
|
||||
- **rb** rinbuffer 结构体指针
|
||||
- **ep** 端点地址
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
.. important:: 以下函数为 USB Device 协议栈需要实现的 porting 接口，用户无需在应用层调用。
|
||||
|
||||
|
|
@ -302,8 +291,8 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_set_address(const uint8_t addr);
|
||||
|
||||
- addr USB 设备的地址
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **addr** USB 设备的地址
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
.. _usb_dc_ep_open:
|
||||
|
||||
|
|
@ -316,8 +305,8 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_ep_open(const struct usbd_endpoint_cfg *ep_cfg);
|
||||
|
||||
- ep_cfg 端点的属性
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **ep_cfg** 端点的属性
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
.. _usb_dc_ep_close:
|
||||
|
||||
|
|
@ -330,8 +319,8 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_ep_close(const uint8_t ep);
|
||||
|
||||
- ep 端点地址
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **ep** 端点地址
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
.. _usb_dc_ep_set_stall:
|
||||
|
||||
|
|
@ -344,8 +333,8 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_ep_set_stall(const uint8_t ep);
|
||||
|
||||
- ep 端点地址
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **ep** 端点地址
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
.. _usb_dc_ep_clear_stall:
|
||||
|
||||
|
|
@ -358,8 +347,8 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_ep_clear_stall(const uint8_t ep);
|
||||
|
||||
- ep 端点地址
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **ep** 端点地址
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
.. _usb_dc_ep_is_stalled:
|
||||
|
||||
|
|
@ -372,9 +361,9 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_ep_is_stalled(const uint8_t ep, uint8_t *stalled);
|
||||
|
||||
- ep 端点id
|
||||
- stalled 保存挂起状态的地址， 0 表示非挂起状态， 1 表示挂起状态
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **ep** 端点id
|
||||
- **stalled** 保存挂起状态的地址， 0 表示非挂起状态， 1 表示挂起状态
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
.. _usb_dc_ep_write:
|
||||
|
||||
|
|
@ -387,11 +376,11 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_ep_write(const uint8_t ep, const uint8_t *data, uint32_t data_len, uint32_t *ret_bytes);
|
||||
|
||||
- ep 端点地址
|
||||
- data 要发送的数据地址
|
||||
- data_len 要发送数据的长度
|
||||
- ret_bytes 实际成功发生的数据长度
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **ep** 端点地址
|
||||
- **data** 要发送的数据地址
|
||||
- **data_len** 要发送数据的长度
|
||||
- **ret_bytes** 实际成功发生的数据长度
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
||||
.. _usb_dc_ep_read:
|
||||
|
||||
|
|
@ -404,8 +393,8 @@ USB 设备 ``event`` 类型如下
|
|||
|
||||
int usb_dc_ep_read(const uint8_t ep, uint8_t *data, uint32_t max_data_len, uint32_t *read_bytes);
|
||||
|
||||
- ep 端点地址
|
||||
- data 要接收数据的地址
|
||||
- data_len 要接收数据的长度，不能大于最大包长
|
||||
- ret_bytes 实际成功接收的数据长度
|
||||
- return 错误码，0表示成功，其他表示失败
|
||||
- **ep** 端点地址
|
||||
- **data** 要接收数据的地址
|
||||
- **data_len** 要接收数据的长度，不能大于最大包长
|
||||
- **ret_bytes** 实际成功接收的数据长度
|
||||
- **return** 错误码，0表示成功，其他表示失败
|
||||
|
|
|
|||
|
|
@ -16,4 +16,5 @@ Peripheral
|
|||
ADC 设备 <api_adc>
|
||||
DAC 设备 <api_dac>
|
||||
TIMER 设备 <api_timer>
|
||||
QDEC 设备 <api_qdec>
|
||||
USB 设备 <api_usb>
|
||||
|
|
@ -35,7 +35,7 @@ Shell 接口
|
|||
|
||||
void shell_handler(uint8_t data);
|
||||
|
||||
- data 接收的数据
|
||||
- **data** 接收的数据
|
||||
|
||||
**SHELL_CMD_EXPORT**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -44,8 +44,8 @@ Shell 接口
|
|||
|
||||
.. c:macro:: SHELL_CMD_EXPORT(command, desc)
|
||||
|
||||
- command 注册的函数名，后面输入 command 来运行该函数
|
||||
- desc 对该函数的描述
|
||||
- **command** 注册的函数名，后面输入 command 来运行该函数
|
||||
- **desc** 对该函数的描述
|
||||
|
||||
**SHELL_CMD_EXPORT_ALIAS**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -54,9 +54,9 @@ Shell 接口
|
|||
|
||||
.. c:macro:: SHELL_CMD_EXPORT_ALIAS(command, alias, desc)
|
||||
|
||||
- command 注册的函数名
|
||||
- alias 函数名的别名，后面输入 alias 来运行该函数
|
||||
- desc 对该函数的描述
|
||||
- **command** 注册的函数名
|
||||
- **alias** 函数名的别名，后面输入 alias 来运行该函数
|
||||
- **desc** 对该函数的描述
|
||||
|
||||
Shell 内置命令
|
||||
-----------------
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ USB DEVICE 控制器接口
|
|||
return usb;
|
||||
}
|
||||
|
||||
- device 返回 USB 设备句柄
|
||||
- **device** 返回 USB 设备句柄
|
||||
|
||||
.. note::中断处理函数则是调用 ``usbd_event_notify_handler``
|
||||
|
||||
|
|
@ -68,7 +68,7 @@ USB DEVICE 通用接口
|
|||
|
||||
void usbd_desc_register(const uint8_t *desc);
|
||||
|
||||
- desc 描述符的句柄
|
||||
- **desc** 描述符的句柄
|
||||
|
||||
|
||||
**usbd_msosv1_desc_register**
|
||||
|
|
@ -80,7 +80,7 @@ USB DEVICE 通用接口
|
|||
|
||||
void usbd_msosv1_desc_register(struct usb_msosv1_descriptor *desc);
|
||||
|
||||
- desc 描述符句柄
|
||||
- **desc** 描述符句柄
|
||||
|
||||
|
||||
**usbd_class_add_interface**
|
||||
|
|
@ -92,8 +92,8 @@ USB DEVICE 通用接口
|
|||
|
||||
void usbd_class_add_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class USB 设备类的句柄
|
||||
- intf USB 设备接口的句柄
|
||||
- **class** USB 设备类的句柄
|
||||
- **intf** USB 设备接口的句柄
|
||||
|
||||
``usbd_class_t`` 定义如下
|
||||
|
||||
|
|
@ -105,9 +105,9 @@ USB DEVICE 通用接口
|
|||
usb_slist_t intf_list;
|
||||
} usbd_class_t;
|
||||
|
||||
- list 类的链表节点
|
||||
- name 类的名称
|
||||
- intf_list 接口的链表节点
|
||||
- **list** 类的链表节点
|
||||
- **name** 类的名称
|
||||
- **intf_list** 接口的链表节点
|
||||
|
||||
``usbd_interface_t`` 定义如下
|
||||
|
||||
|
|
@ -127,13 +127,13 @@ USB DEVICE 通用接口
|
|||
usb_slist_t ep_list;
|
||||
} usbd_interface_t;
|
||||
|
||||
- list 接口的链表节点
|
||||
- class_handler class setup 请求回调函数
|
||||
- vendor_handler vendor setup 请求回调函数
|
||||
- custom_handler custom setup 请求回调函数
|
||||
- notify_handler 中断标志、协议栈相关状态回调函数
|
||||
- intf_num 当前接口偏移
|
||||
- ep_list 端点的链表节点
|
||||
- **list** 接口的链表节点
|
||||
- **class_handler** class setup 请求回调函数
|
||||
- **vendor_handler** vendor setup 请求回调函数
|
||||
- **custom_handler** custom setup 请求回调函数
|
||||
- **notify_handler** 中断标志、协议栈相关状态回调函数
|
||||
- **intf_num** 当前接口偏移
|
||||
- **ep_list** 端点的链表节点
|
||||
|
||||
**usbd_interface_add_endpoint**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
|
@ -145,8 +145,8 @@ USB DEVICE 通用接口
|
|||
void usbd_interface_add_endpoint(usbd_interface_t *intf, usbd_endpoint_t *ep);
|
||||
|
||||
|
||||
- intf USB 设备接口的句柄
|
||||
- ep USB 设备端点的句柄
|
||||
- **intf** USB 设备接口的句柄
|
||||
- **ep** USB 设备端点的句柄
|
||||
|
||||
``usbd_class_t`` 定义如下
|
||||
|
||||
|
|
@ -158,9 +158,9 @@ USB DEVICE 通用接口
|
|||
usbd_endpoint_callback ep_cb;
|
||||
} usbd_endpoint_t;
|
||||
|
||||
- list 端点的链表节点
|
||||
- ep_addr 端点地址
|
||||
- ep_cb 端点中断回调函数
|
||||
- **list** 端点的链表节点
|
||||
- **ep_addr** 端点地址
|
||||
- **ep_cb** 端点中断回调函数
|
||||
|
||||
**usb_device_is_configured**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
|
@ -171,7 +171,7 @@ USB DEVICE 通用接口
|
|||
|
||||
bool usb_device_is_configured(void);
|
||||
|
||||
- return 配置状态， 0 表示未配置， 1 表示配置成功
|
||||
- **return** 配置状态， 0 表示未配置， 1 表示配置成功
|
||||
|
||||
|
||||
USB Device CDC 类接口
|
||||
|
|
@ -187,8 +187,8 @@ USB Device CDC 类接口
|
|||
|
||||
void usbd_cdc_add_acm_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class 类的句柄
|
||||
- intf 接口句柄
|
||||
- **class** 类的句柄
|
||||
- **intf** 接口句柄
|
||||
|
||||
USB Device MSC 类接口
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
@ -201,8 +201,8 @@ USB Device MSC 类接口
|
|||
|
||||
void usbd_msc_class_init(uint8_t out_ep, uint8_t in_ep);
|
||||
|
||||
- out_ep 输出端点的地址
|
||||
- in_ep 输入端点的地址
|
||||
- **out_ep** 输出端点的地址
|
||||
- **in_ep** 输入端点的地址
|
||||
|
||||
|
||||
USB Device HID 类接口
|
||||
|
|
@ -218,8 +218,8 @@ USB Device HID 类接口
|
|||
|
||||
void usbd_hid_add_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class 类的句柄
|
||||
- intf 接口句柄
|
||||
- **class** 类的句柄
|
||||
- **intf** 接口句柄
|
||||
|
||||
|
||||
USB Device AUDIO 类接口
|
||||
|
|
@ -233,8 +233,8 @@ USB Device AUDIO 类接口
|
|||
|
||||
void usbd_audio_add_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class 类的句柄
|
||||
- intf 接口句柄
|
||||
- **class** 类的句柄
|
||||
- **intf** 接口句柄
|
||||
|
||||
|
||||
USB Device VIDEO 类接口
|
||||
|
|
@ -248,5 +248,5 @@ USB Device VIDEO 类接口
|
|||
|
||||
void usbd_video_add_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class 类的句柄
|
||||
- intf 接口句柄
|
||||
- **class** 类的句柄
|
||||
- **intf** 接口句柄
|
||||
|
|
@ -98,6 +98,7 @@ examples 的目录结构
|
|||
|
||||
- 添加有依赖库的新工程的步骤与添加单个源文件工程基本步骤一致
|
||||
- 如使用的依赖库在本 SDK 中已存在，那么就只需要修改 CMakeLists.txt 即可
|
||||
|
||||
- 如使用的依赖库不存在则需要自行添加，详见后续说明
|
||||
|
||||
已存在的情况下，目录结构如下：
|
||||
|
|
|
|||
|
|
@ -150,5 +150,43 @@ BL706_AVB 开发板
|
|||
RXD <--> TX0
|
||||
GND <--> GND
|
||||
|
||||
-
|
||||
|
||||
BL706 AVB 开发板与其他子模块的连接方法
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 本节主要介绍 BL706_AVB 板与其他模块的连接的方法，主要包括摄像头的连接、音频 Codec 模块的连接、SPI 屏幕的连接。
|
||||
|
||||
**BL706_AVB 连接 GC0308 摄像头模块**
|
||||
|
||||
- 1. 首先，将 BL706_AVB 开发板背面的 ``J5`` 抽屉式 FPC 排线座黑色的锁扣部分，从边缘将其拔出
|
||||
|
||||
.. figure:: img/connect_camera_1.png
|
||||
:alt:
|
||||
|
||||
|
||||
- 2. 完全拔出后，如下图所示；
|
||||
|
||||
.. figure:: img/connect_camera_2.png
|
||||
:alt:
|
||||
|
||||
|
||||
- 3. FPC 排线座是抽屉下接式，因此接下来将摄像头无金属接触点的一面朝上，插入 FPC 排线座
|
||||
|
||||
.. figure:: img/connect_camera_3.png
|
||||
:alt:
|
||||
|
||||
|
||||
- 4. 将摄像头插入后，把黑色锁扣压紧
|
||||
|
||||
.. figure:: img/connect_camera_4.png
|
||||
:alt:
|
||||
|
||||
|
||||
**BL706_AVB 连接 Audio Codec 模块**
|
||||
|
||||
- 将 Audio Codec 模块的 ``HD19`` 组排针，插入 BL706_AVB 开发板的 ``HD11`` 排母座；注意模块是向外延申的。
|
||||
- 示意图如下：
|
||||
|
||||
.. figure:: img/connect_codec_1.png
|
||||
:alt:
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
|
||||
BL706_Iot 开发板如下图所示
|
||||
|
||||
.. figure:: img/bl702_iot.png
|
||||
.. figure:: img/bl706_iot.png
|
||||
:alt:
|
||||
|
||||
BL706_IoT
|
||||
|
|
@ -57,7 +57,7 @@ BL706_AVB 开发板如下图所示
|
|||
**Windows**
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Sipeed RV-Debugger Plus 调试器在 Windows 系统中所以时我们需要将驱动更换为 ``Win USB`` 驱动
|
||||
Sipeed RV-Debugger Plus 调试器在 Windows 系统中使用时我们需要将驱动更换为 ``Win USB`` 驱动
|
||||
|
||||
- 1. 首先，将调试器 Type-C USB 接口使用 USB 数据线连接到 PC 主机，打开 PC 的设备管理器，在端口一栏可以看到调试器被识别为两个串口（*注：不是开发板上的串口*），或者在 ``通用串行总线控制器`` 看到 ``USB Serial Converter A`` 和 ``USB Serial Converter B``
|
||||
|
||||
|
|
@ -101,6 +101,9 @@ Sipeed RV-Debugger Plus 调试器在 Windows 系统中所以时我们需要将
|
|||
.. code-block:: bash
|
||||
|
||||
$ lsusb
|
||||
...
|
||||
Bus 001 Device 003: ID 0403:6010 Future Technology Devices International, Ltd FT2232C Dual USB-UART/FIFO IC
|
||||
...
|
||||
|
||||
.. figure:: img/sipeed_rv_debugger_8.png
|
||||
|
||||
|
|
|
|||
BIN
docs/development_guide/source/get_started/img/bl706_iot.png
Normal file
BIN
docs/development_guide/source/get_started/img/bl706_iot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.7 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 754 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 715 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 504 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 731 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 568 KiB |
|
|
@ -69,7 +69,7 @@ ADC - 按键检测电压
|
|||
adc_channel_cfg.pos_channel = posChList;
|
||||
adc_channel_cfg.neg_channel = negChList;
|
||||
|
||||
adc_register(ADC0_INDEX, "adc_key", DEVICE_OFLAG_STREAM_RX);
|
||||
adc_register(ADC0_INDEX, "adc_key");
|
||||
|
||||
adc_key = device_find("adc_key");
|
||||
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ I2S 的配置与使能:
|
|||
:linenos:
|
||||
|
||||
/* register & open i2s device */
|
||||
i2s_register(I2S0_INDEX, "I2S", DEVICE_OFLAG_RDWR);
|
||||
i2s_register(I2S0_INDEX, "I2S");
|
||||
i2s = device_find("I2S");
|
||||
if (i2s) {
|
||||
I2S_DEV(i2s)->iis_mode = I2S_MODE_MASTER;
|
||||
|
|
|
|||
|
|
@ -0,0 +1,238 @@
|
|||
I2S - 录音回环播放
|
||||
=========================
|
||||
|
||||
本 demo 演示 I2S 录音回环播放, 使用的音频芯片 ES8388 编码与解码, 另外需要使用 I2C 对 ES8388 配置。
|
||||
若使用其他音频解码芯片，请自行配置，本文档仅重点讲述 I2S 的使用，对音频芯片不做过多介绍。
|
||||
|
||||
硬件连接
|
||||
-----------------------------
|
||||
|
||||
- 本 demo 基于 BL706_AVB 开发板，需要用到 ES8388 音频子板，连接方式如下：
|
||||
|
||||
.. list-table::
|
||||
:widths: 30 30
|
||||
:header-rows: 1
|
||||
|
||||
* - GPIO function
|
||||
- GPIO pin
|
||||
* - CLK_OUT(MCLK)
|
||||
- GPIO6
|
||||
* - I2S_BCLK
|
||||
- GPIO4
|
||||
* - I2S_FS
|
||||
- GPIO29
|
||||
* - I2S_DO
|
||||
- GPIO30
|
||||
* - I2S_DI
|
||||
- GPIO3
|
||||
* - I2C_SCL
|
||||
- GPIO16
|
||||
* - I2C_SDA
|
||||
- GPIO11
|
||||
|
||||
- 本 demo 用到的内部外设资源如下：
|
||||
|
||||
.. list-table::
|
||||
:widths: 10 40
|
||||
:header-rows: 1
|
||||
|
||||
* - peripheral
|
||||
- role
|
||||
* - I2S
|
||||
- 标准音频数据接口，用于向 ES8388 音频子板传送音频数据
|
||||
* - I2C
|
||||
- 一种串行通讯总线，用于配置 ES8388 的寄存器设置
|
||||
* - DMA-CH2
|
||||
- 直接存储访问技术，用于配合 I2S 高效发送音频数据，减少对 CPU 的负载
|
||||
* - DMA-CH3
|
||||
- 直接存储访问技术，用于配合 I2S 高效接收音频数据，减少对 CPU 的负载
|
||||
* - CLK_OUT
|
||||
- 引脚复用对外输出指定时钟信号，用作提供MCLK时钟
|
||||
|
||||
软件实现
|
||||
-----------------------------
|
||||
|
||||
本文档不再详细介绍 I2C 与 DMA，主要介绍 I2S 相关配置，其他外设可以查看对应的文档。
|
||||
|
||||
- 软件代码见 ``examples/i2s/i2s_play_form_record``
|
||||
|
||||
- 配置 ``I2S, I2C, CLK_OUT(MCLK)`` 相关复用引脚，见 ``bsp/board/bl706_iot/pinmux_config.h`` 中的宏定义选项:
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
#define CONFIG_GPIO6_FUNC GPIO_FUN_CLK_OUT
|
||||
#define CONFIG_GPIO3_FUNC GPIO_FUN_I2S
|
||||
#define CONFIG_GPIO4_FUNC GPIO_FUN_I2S
|
||||
#define CONFIG_GPIO29_FUNC GPIO_FUN_I2S
|
||||
#define CONFIG_GPIO30_FUNC GPIO_FUN_I2S
|
||||
#define CONFIG_GPIO11_FUNC GPIO_FUN_I2C
|
||||
#define CONFIG_GPIO16_FUNC GPIO_FUN_I2C
|
||||
|
||||
- 配置 ES8388 的参数，初始化 ES8388 ，其中会用到 I2C 外设，具体过程可见 ``bsp/bsp_common/es8388/es8388.c``
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
static ES8388_Cfg_Type ES8388Cfg = {
|
||||
.work_mode = ES8388_CODEC_MDOE, /*!< ES8388 work mode */
|
||||
.role = ES8388_SLAVE, /*!< ES8388 role */
|
||||
.mic_input_mode = ES8388_DIFF_ENDED_MIC, /*!< ES8388 mic input mode */
|
||||
.mic_pga = ES8388_MIC_PGA_3DB, /*!< ES8388 mic PGA */
|
||||
.i2s_frame = ES8388_LEFT_JUSTIFY_FRAME, /*!< ES8388 I2S frame */
|
||||
.data_width = ES8388_DATA_LEN_16, /*!< ES8388 I2S dataWitdh */
|
||||
};
|
||||
|
||||
/* init ES8388 Codec */
|
||||
ES8388_Init(&ES8388Cfg);
|
||||
ES8388_Set_Voice_Volume(60);
|
||||
|
||||
|
||||
I2S 的配置与使能:
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 使能 ``BSP_USING_I2S0`` 并配置 ``I2S`` 设备配置，见 ``bsp/board/bl706_iot/peripheral_config.h`` 中：
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
#define BSP_USING_I2S0
|
||||
|
||||
#if defined(BSP_USING_I2S0)
|
||||
#ifndef I2S0_CONFIG
|
||||
#define I2S0_CONFIG \
|
||||
{ \
|
||||
.id = 0, \
|
||||
.iis_mode = I2S_MODE_MASTER, \
|
||||
.interface_mode = I2S_MODE_LEFT, \
|
||||
.sampl_freq_hz = 16 * 1000, \
|
||||
.channel_num = I2S_FS_CHANNELS_NUM_2, \
|
||||
.frame_size = I2S_FRAME_LEN_16, \
|
||||
.data_size = I2S_DATA_LEN_16, \
|
||||
.fifo_threshold = 4, \
|
||||
}
|
||||
|
||||
- 先调用 ``i2s_register`` 函数注册 ``I2S`` 设备
|
||||
- 然后通过 ``find`` 函数找到设备对应的句柄，保存于 ``i2s`` 中
|
||||
- 最后填写配置参数后，使用 ``device_open`` 来打开 ``I2S`` 设备
|
||||
- 如果不填写配置参数，会默认使用 ``bsp/board/bl706_avb/peripheral_config.h`` 中预设的参数
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
/* register & open i2s device */
|
||||
i2s_register(I2S0_INDEX, "I2S", DEVICE_OFLAG_RDWR);
|
||||
i2s = device_find("I2S");
|
||||
if (i2s) {
|
||||
I2S_DEV(i2s)->iis_mode = I2S_MODE_MASTER;
|
||||
I2S_DEV(i2s)->interface_mode = I2S_MODE_LEFT;
|
||||
I2S_DEV(i2s)->sampl_freq_hz = 16 * 1000;
|
||||
I2S_DEV(i2s)->channel_num = I2S_FS_CHANNELS_NUM_2;
|
||||
I2S_DEV(i2s)->frame_size = I2S_FRAME_LEN_16;
|
||||
I2S_DEV(i2s)->data_size = I2S_DATA_LEN_16;
|
||||
I2S_DEV(i2s)->fifo_threshold = 4;
|
||||
device_open(i2s, DEVICE_OFLAG_DMA_TX | DEVICE_OFLAG_DMA_RX);
|
||||
}
|
||||
|
||||
DMA 的配置与使能
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 为了 I2S 更高效，减少对 CPU 的占用，需要配置 DMA 来搬运数据。本次会用到两个 DMA 通道，分别用于 I2S 的数据发送与接收。
|
||||
- 启用其中一路 DMA 的完成中断，用以处理双缓存数据的切换，将获取的音频数据再发送出去，回环播放。具体配置可见 DMA 文档，配置代码如下：
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
/* register & open dma device */
|
||||
dma_register(DMA0_CH3_INDEX, "dma_ch3_i2s_rx");
|
||||
dma_ch3 = device_find("dma_ch3_i2s_rx");
|
||||
if (dma_ch3) {
|
||||
DMA_DEV(dma_ch3)->direction = DMA_PERIPH_TO_MEMORY;
|
||||
DMA_DEV(dma_ch3)->transfer_mode = DMA_LLI_ONCE_MODE;
|
||||
DMA_DEV(dma_ch3)->src_req = DMA_REQUEST_I2S_RX;
|
||||
DMA_DEV(dma_ch3)->dst_req = DMA_REQUEST_NONE;
|
||||
DMA_DEV(dma_ch3)->src_width = DMA_TRANSFER_WIDTH_32BIT;
|
||||
DMA_DEV(dma_ch3)->dst_width = DMA_TRANSFER_WIDTH_32BIT;
|
||||
DMA_DEV(dma_ch3)->src_burst_size = DMA_BURST_4BYTE;
|
||||
DMA_DEV(dma_ch3)->dst_burst_size = DMA_BURST_4BYTE;
|
||||
device_open(dma_ch3, 0);
|
||||
|
||||
/* connect i2s device and dma device */
|
||||
device_control(i2s, DEVICE_CTRL_ATTACH_RX_DMA, (void *)dma_ch3);
|
||||
|
||||
/* Set the interrupt function, for double buffering*/
|
||||
device_set_callback(dma_ch3, dma_ch3_irq_callback);
|
||||
device_control(dma_ch3, DEVICE_CTRL_SET_INT, NULL);
|
||||
}
|
||||
|
||||
dma_register(DMA0_CH2_INDEX, "dma_ch2_i2s_tx");
|
||||
dma_ch2 = device_find("dma_ch2_i2s_tx");
|
||||
if (dma_ch2) {
|
||||
DMA_DEV(dma_ch2)->direction = DMA_MEMORY_TO_PERIPH;
|
||||
DMA_DEV(dma_ch2)->transfer_mode = DMA_LLI_ONCE_MODE;
|
||||
DMA_DEV(dma_ch2)->src_req = DMA_REQUEST_NONE;
|
||||
DMA_DEV(dma_ch2)->dst_req = DMA_REQUEST_I2S_TX;
|
||||
DMA_DEV(dma_ch2)->src_width = DMA_TRANSFER_WIDTH_32BIT;
|
||||
DMA_DEV(dma_ch2)->dst_width = DMA_TRANSFER_WIDTH_32BIT;
|
||||
DMA_DEV(dma_ch2)->src_burst_size = DMA_BURST_4BYTE;
|
||||
DMA_DEV(dma_ch2)->dst_burst_size = DMA_BURST_4BYTE;
|
||||
device_open(dma_ch2, 0);
|
||||
|
||||
/* connect i2s device and dma device */
|
||||
device_control(i2s, DEVICE_CTRL_ATTACH_TX_DMA, (void *)dma_ch2);
|
||||
|
||||
/* Set the interrupt function, for double buffering*/
|
||||
device_set_callback(dma_ch2, NULL);
|
||||
device_control(dma_ch2, DEVICE_CTRL_SET_INT, NULL);
|
||||
}
|
||||
|
||||
|
||||
.. important:: 这里 DMA 的传输宽度设置为了 ``DMA_TRANSFER_WIDTH_32BIT``,但前面 I2S 的配置是16位有效数据，这是因为 I2S 在初始化时默认使用了合并 FIFO 功能，\
|
||||
即当双声道时有效数据位宽为8位或者16位时，会将双声道数据同时放入同一个 FIFO 中,合并为16位或32位，提高 FIFO 利用效率，具体原因请看 api_dma 文档最后一节
|
||||
|
||||
.. important:: 这里 DMA 的 ``src_burst_size`` 与 ``dst_burst_size`` 都为 DMA_BURST_4BYTE，这要求 I2S 初始化时，其中的 ``fifo_threshold`` 要大于等于4，具体原因请看 api_dma 文档最后一节
|
||||
|
||||
DMA 中断回调函数
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 本例程使用双缓冲的方式处理数据，同时录音与播音，一个 buff 用以录音，另一个 buff 用以播音，在 DMA 完成中断里切换：
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
static void dma_ch3_irq_callback(struct device *dev, void *args, uint32_t size, uint32_t state)
|
||||
{
|
||||
device_read(i2s, 0, Data_Buff[!buff_using_num], BUFF_SIZE);
|
||||
|
||||
device_write(i2s, 0, Data_Buff[buff_using_num], BUFF_SIZE);
|
||||
|
||||
buff_using_num = !buff_using_num;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
编译和烧录
|
||||
-----------------------------
|
||||
|
||||
- **CDK 编译**
|
||||
|
||||
打开项目中提供的工程文件：i2s_play_form_record.cdkproj
|
||||
|
||||
参照 :ref:`windows_cdk_quick_start` 的步骤编译下载即可
|
||||
|
||||
- **命令行编译**
|
||||
|
||||
.. code-block:: bash
|
||||
:linenos:
|
||||
|
||||
$ cd <sdk_path>/bl_mcu_sdk
|
||||
$ make BOARD=bl706_avb APP=i2s_play_form_record
|
||||
|
||||
- **烧录**
|
||||
|
||||
详见 :ref:`bl_dev_cube`
|
||||
|
||||
实验现象
|
||||
-----------------------------
|
||||
|
||||
录音与播音回环,类似于扩音器
|
||||
|
|
@ -1,9 +1,10 @@
|
|||
=======================
|
||||
I2S 示例
|
||||
=======================
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
I2S - 播放flash内置音乐 <i2s_play_from_flash_demo>
|
||||
=======================
|
||||
I2S 示例
|
||||
=======================
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
I2S - 播放flash内置音乐 <i2s_play_from_flash_demo>
|
||||
I2S - 回环播放 <i2s_play_from_record_demo>
|
||||
|
|
@ -81,16 +81,16 @@ PWM - 呼吸灯
|
|||
:linenos:
|
||||
|
||||
for (pwm_cfg.threshold_high = 0; pwm_cfg.threshold_high <= 32; pwm_cfg.threshold_high++) {
|
||||
device_control(led_breath, DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg);
|
||||
device_control(led_breath, DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg);
|
||||
bflb_platform_delay_ms(50);
|
||||
}
|
||||
|
||||
for (pwm_cfg.threshold_high = 32; 0 <= pwm_cfg.threshold_high && pwm_cfg.threshold_high <= 32; pwm_cfg.threshold_high--) {
|
||||
device_control(led_breath, DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg);
|
||||
device_control(led_breath, DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg);
|
||||
bflb_platform_delay_ms(50);
|
||||
}
|
||||
|
||||
- 使用 ``device_contorl`` 函数，配合 ``DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG`` 指令，可以修改当前 PWM 通道的占空比。
|
||||
- 使用 ``device_contorl`` 函数，配合 ``DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG`` 指令，可以修改当前 PWM 通道的占空比。
|
||||
|
||||
编译和烧录
|
||||
-----------------------------
|
||||
|
|
|
|||
|
|
@ -240,13 +240,13 @@ PWM - 驱动步进电机
|
|||
pwm_cfg[3].threshold_low = 0;
|
||||
pwm_cfg[3].threshold_high = 0;
|
||||
}
|
||||
device_control(motor_ch0, DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg[0]);
|
||||
device_control(motor_ch1, DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg[1]);
|
||||
device_control(motor_ch2, DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg[2]);
|
||||
device_control(motor_ch3, DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg[3]);
|
||||
device_control(motor_ch0, DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg[0]);
|
||||
device_control(motor_ch1, DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg[1]);
|
||||
device_control(motor_ch2, DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg[2]);
|
||||
device_control(motor_ch3, DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG, &pwm_cfg[3]);
|
||||
}
|
||||
|
||||
- 使用 ``device_contorl`` 函数，配合 ``DEIVCE_CTRL_PWM_DUTYCYCLE_CONFIG`` 指令，修改4个 PWM 通道的的高低阈值。
|
||||
- 使用 ``device_contorl`` 函数，配合 ``DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG`` 指令，修改4个 PWM 通道的的高低阈值。
|
||||
|
||||
.. note:: 该函数的功能主要用于切换步进电机的方向
|
||||
|
||||
|
|
|
|||
|
|
@ -6,4 +6,4 @@ TIMER 示例
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
TIMER - 定时器中断 <timer_interrupt_demo>
|
||||
TIMER - 秒中断定时 <timer_interrupt_demo>
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
TIMER - 定时器中断
|
||||
TIMER - 秒中断定时
|
||||
====================
|
||||
|
||||
本 demo 基于 TIMER 外设周期性触发中断模式编写。
|
||||
本 demo 基于 TIMER 中断模式秒中断定时。
|
||||
|
||||
软件实现
|
||||
-----------------------------
|
||||
|
|
@ -11,75 +11,72 @@ TIMER - 定时器中断
|
|||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
#define TIMER_CLK_SRC (0)
|
||||
#define TIMER_CLK_DIV (0)
|
||||
#define BSP_TIMER0_CLOCK_SOURCE ROOT_CLOCK_SOURCE_FCLK
|
||||
#define BSP_TIMER0_CLOCK_DIV 0
|
||||
|
||||
- 配置 ``TIMER`` 设备时钟源，见 ``drivers\bl702_driver\hal_drv\default_config\timer_config.h``和``drivers\bl702_driver\hal_drv\src\hal_timer.c``
|
||||
- 配置 ``TIMER`` 设备时钟源，见 ``bsp/board/bl706_iot/clock_config.h``
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
#define CONFIG_GPIO14_FUNC GPIO_FUN_UART0_TX
|
||||
#define CONFIG_GPIO15_FUNC GPIO_FUN_UART0_RX
|
||||
#define BSP_USING_TIMER0
|
||||
|
||||
- 配置 ``UART`` 设备复用引脚，见 ``bsp/board/bl706_iot/pinmux_config.h``
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
#define BSP_USING_TIMER_CH0
|
||||
|
||||
#if defined(BSP_USING_TIMER_CH0)
|
||||
#ifndef TIMER_CH0_CONFIG
|
||||
#define TIMER_CH0_CONFIG \
|
||||
{ \
|
||||
.id = 0, \
|
||||
.ch = 0, \
|
||||
.cnt_mode = TIMER_CNT_PRELOAD, \
|
||||
.pl_trig_src = TIMER_PL_TRIG_COMP0, \
|
||||
#if defined(BSP_USING_TIMER0)
|
||||
#ifndef TIMER0_CONFIG
|
||||
#define TIMER0_CONFIG \
|
||||
{ \
|
||||
.id = 0, \
|
||||
.cnt_mode = TIMER_CNT_PRELOAD, \
|
||||
.trigger = TIMER_PRELOAD_TRIGGER_COMP2, \
|
||||
.reload = 0, \
|
||||
.timeout1 = 1000000, \
|
||||
.timeout2 = 2000000, \
|
||||
.timeout3 = 3000000, \
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
- 使能 ``BSP_USING_TIMER_CH0`` 并配置 ``TIMER`` 设备配置，见 ``bsp/board/bl706_iot/peripheral_config.h``
|
||||
- 使能 ``BSP_USING_TIMER0`` 并配置 ``TIMER0`` 设备配置，见 ``bsp/board/bl706_iot/peripheral_config.h``
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
if (timer_ch0) {
|
||||
device_open(timer_ch0, DEVICE_OFLAG_INT);
|
||||
device_set_callback(timer_ch0, timer_ch0_irq_callback);
|
||||
device_control(timer_ch0, DEVICE_CTRL_SET_INT, NULL);
|
||||
device_control(timer_ch0, DEVICE_CTRL_TIMER_CH_START, (void *)(&timer_user_cfg));
|
||||
timer_register(TIMER0_INDEX, "timer0");
|
||||
|
||||
timer0 = device_find("timer0");
|
||||
|
||||
if (timer0) {
|
||||
device_open(timer0, DEVICE_OFLAG_INT_TX); /* 1s,2s,3s timing*/
|
||||
device_set_callback(timer0, timer0_irq_callback);
|
||||
device_control(timer0, DEVICE_CTRL_SET_INT, (void *)(TIMER_COMP0_IT | TIMER_COMP1_IT | TIMER_COMP2_IT));
|
||||
} else {
|
||||
MSG("timer device open failed! \n");
|
||||
}
|
||||
|
||||
- 通过 ``timer_ch0_irq_callback`` 函数，注册用户指定的 ``TIMER0`` 中断服务函数。通过 ``device_control`` 函数使能中断和配置定时周期。
|
||||
- 调用 ``timer_register`` 函数注册 ``TIMER`` 设备，当前注册 ``TIMER0``
|
||||
- 然后通过 ``find`` 函数找到设备对应的句柄，保存于 ``timer0`` 句柄中
|
||||
- 最后使用 ``device_open`` 以中断模式来打开 ``timer0`` 设备
|
||||
- 调用 ``device_set_callback`` 函数，注册用户指定的 ``TIMER0`` 中断服务函数。调用 ``device_control`` 函数使能中断和配置定时周期。
|
||||
|
||||
.. code-block:: C
|
||||
:linenos:
|
||||
|
||||
void timer_ch0_irq_callback(struct device *dev, void *args, uint32_t size, uint32_t state)
|
||||
void timer0_irq_callback(struct device *dev, void *args, uint32_t size, uint32_t state)
|
||||
{
|
||||
MSG("timer ch0 interrupt! \n");
|
||||
|
||||
if (state == TIMER_EVENT_COMP0) {
|
||||
cnt++;
|
||||
MSG("timer event comp0! cnt=%d\n", cnt);
|
||||
MSG("timer event comp0! \r\n");
|
||||
} else if (state == TIMER_EVENT_COMP1) {
|
||||
MSG("timer event comp1! \n");
|
||||
MSG("timer event comp1! \r\n");
|
||||
} else if (state == TIMER_EVENT_COMP2) {
|
||||
MSG("timer event comp2! \n");
|
||||
BL_CASE_SUCCESS;
|
||||
timer_timeout_cfg_t cfg = { 2, 12000000 }; /*modify compare id 2 timeout 12s*/
|
||||
device_write(dev, 0, &cfg, sizeof(timer_timeout_cfg_t));
|
||||
MSG("timer event comp2! \r\n");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
- 此函数是示例的中断服务函数，作用是判断具体是哪个 COMP 触发的中断和打印 COMP0 触发中断的次数。
|
||||
|
||||
- ``state`` 会输入 ``TIMER`` 设备的 EVENT 类型
|
||||
- ``args`` 包含了返回数据指针
|
||||
- ``size`` 包含返回数据的长度
|
||||
- ``dev`` 为中断的 ``TIMER`` 设备句柄
|
||||
|
||||
- ``device_write`` 则是在达到 comp2 超时时间时，修改 comp2 的超时时间为 12s。
|
||||
|
||||
编译和烧录
|
||||
-----------------------------
|
||||
|
|
@ -106,9 +103,3 @@ TIMER - 定时器中断
|
|||
实验现象
|
||||
-----------------------------
|
||||
|
||||
每 1 秒触发 1 次 ``timer ch0`` ``COMP0`` 中断，每次触发 ``TIMER`` 中断都会打印一次 ``timer ch0 interrupt!`` ，并且 ``cnt`` 值每次都会加 1 。
|
||||
串口打印：
|
||||
|
||||
``timer ch0 interrupt! timer event comp0! cnt=1``
|
||||
``timer ch0 interrupt! timer event comp0! cnt=2``
|
||||
``timer ch0 interrupt! timer event comp0! cnt=3``
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue