mirror of
https://github.com/Fishwaldo/bl_mcu_sdk.git
synced 2025-07-18 18:58:38 +00:00
[docs] update board,i2s,timer rst
This commit is contained in:
jzlv
parent
54bb05cb4f
commit
130e1c3be4
110 changed files with 4517 additions and 2493 deletions
|
|
@ -1,126 +0,0 @@
|
|||
Board 配置系统
|
||||
=======================
|
||||
|
||||
为了践行 **一切皆文件** 的思想，我们针对嵌入式应用不同的硬件配置需求，提出了一套 Board 配置系统。 **Board 配置系统** 主要是用于嵌入式应用中的时钟、GPIO 、外设默认配置三个基本元素进行初始化的配置系统。
|
||||
|
||||
**Board 配置系统** 包含三个配置文件，以及一个 ``bl_config_wizard`` 图形化配置软件
|
||||
|
||||
- clock_config.h 时钟配置头文件
|
||||
- peripheral_config.h 外设配置头文件
|
||||
- pinmux_config.h 引脚功能配置头文件
|
||||
- bl_config_wizard 图形化界面配置上述三类文件
|
||||
|
||||
用户只需要修改三个配置文件，系统会自动初始化。从而无需在用户程序中，调用一系列的复杂冗长的初始化函数， Boufflao Lab 为方便用户快速简便的生成项目对应的 board 文件，提供了 ``bl_config_wizard`` 配置软件，但目前正处于开发阶段。
|
||||
|
||||
.. figure:: img/config_wizard.png
|
||||
:alt:
|
||||
|
||||
bl_config_wizard 软件预览
|
||||
|
||||
|
||||
Board 配置系统的文件组成
|
||||
--------------------------
|
||||
|
||||
Board 系统主要针对不同的板子来使用，不同的板子创建不同的 board 文件，放在 ``bsp/board`` 目录下，并且一个 board 文件，在 **引脚不冲突** 的情况下，可以共享给不同的 demo 使用，无需再创建多个工程，减少工程文件大小。
|
||||
|
||||
.. error:: 如果引脚冲突，并且非要使用一个 board 文件，请自行修改引脚
|
||||
|
||||
**board.c**
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``board.c`` 主要对时钟、引脚进行初始化
|
||||
|
||||
**blxxx_config.h**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``blxxx_config.h`` 主要是包含一些头文件，给 HAL 层驱动使用。
|
||||
|
||||
.. hint:: 以上两个文件无需用户更改，并且相同的 MCU 可以直接复制粘贴到自己的 board 目录使用
|
||||
|
||||
**clock_config.h**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``clock_config.h`` 主要配置系统和外设的时钟源以及分频系统。
|
||||
|
||||
**peripheral_config.h**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``peripheral_config.h`` 主要包含外设的使能以及参数的配置。
|
||||
|
||||
.. warning:: 以 ``#define BSP_USING_XXX`` 开头的宏，用来开启外设的配置，如果没有使能宏，则无法使用该外设的所有函数
|
||||
|
||||
.. warning:: 以 ``XXX_CONFIG`` 开头的宏，用来初始化外设的配置，后面调用 ``device_open`` 来使用该配置
|
||||
|
||||
|
||||
**pinmux_config.h**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``pinmux_config.h`` 主要配置外设的 GPIO 引脚功能。
|
||||
|
||||
.. warning:: 在 mcu sdk 中，所有 demo 共享这个文件，因此有些 demo 是不能使用的，需要频繁修改该文件的引脚功能配置。如果用户已经定好了引脚的分配，则不用频繁修改。
|
||||
|
||||
|
||||
与 STM32CUBEMX 配置工具的区别
|
||||
------------------------------
|
||||
|
||||
STM32CUBEMX 也是一个配置时钟、外设和 GPIO 初始化的工具，最终生成一个完整的工程，初始化都放在 ``main.c`` 的最开始 ，GPIO 和外设初始化底层会调用到 ``stm32xxx_hal_msp.c`` 中。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
/* MCU Configuration--------------------------------------------------------*/
|
||||
|
||||
/* Reset of all peripherals, Initializes the Flash interface and the Systick. */
|
||||
HAL_Init();
|
||||
|
||||
/* USER CODE BEGIN Init */
|
||||
|
||||
/* USER CODE END Init */
|
||||
|
||||
/* Configure the system clock */
|
||||
SystemClock_Config();
|
||||
|
||||
/* USER CODE BEGIN SysInit */
|
||||
|
||||
/* USER CODE END SysInit */
|
||||
|
||||
/* Initialize all configured peripherals */
|
||||
MX_GPIO_Init();
|
||||
MX_USART1_UART_Init();
|
||||
MX_QUADSPI_Init();
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void HAL_UART_MspInit(UART_HandleTypeDef* huart)
|
||||
{
|
||||
GPIO_InitTypeDef GPIO_InitStruct = {0};
|
||||
if(huart->Instance==UART5)
|
||||
{
|
||||
/* USER CODE BEGIN UART5_MspInit 0 */
|
||||
|
||||
/* USER CODE END UART5_MspInit 0 */
|
||||
/* Peripheral clock enable */
|
||||
__HAL_RCC_UART5_CLK_ENABLE();
|
||||
|
||||
__HAL_RCC_GPIOB_CLK_ENABLE();
|
||||
/**UART5 GPIO Configuration
|
||||
PB12 ------> UART5_RX
|
||||
PB13 ------> UART5_TX
|
||||
*/
|
||||
GPIO_InitStruct.Pin = GPIO_PIN_12|GPIO_PIN_13;
|
||||
GPIO_InitStruct.Mode = GPIO_MODE_AF_PP;
|
||||
GPIO_InitStruct.Pull = GPIO_NOPULL;
|
||||
GPIO_InitStruct.Speed = GPIO_SPEED_FREQ_LOW;
|
||||
GPIO_InitStruct.Alternate = GPIO_AF14_UART5;
|
||||
HAL_GPIO_Init(GPIOB, &GPIO_InitStruct);
|
||||
|
||||
/* UART5 interrupt Init */
|
||||
HAL_NVIC_SetPriority(UART5_IRQn, 0, 0);
|
||||
HAL_NVIC_EnableIRQ(UART5_IRQn);
|
||||
/* USER CODE BEGIN UART5_MspInit 1 */
|
||||
|
||||
/* USER CODE END UART5_MspInit 1 */
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
.. hint:: stm32 生成的工程都是对一个工程起作用，不能够同时编译多个工程。如果使用多个工程，就要生成多个上述两个文件。在使用多个工程时，会间接增加文件大小，增加重复文件。
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 128 KiB |
|
|
@ -316,21 +316,31 @@ DMA 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
+---------------------------+-------------+------------------------+
|
||||
|cmd |args |description |
|
||||
+===========================+=============+========================+
|
||||
|DEVICE_CTRL_SET_INT |NULL |开启dma传输完成中断 |
|
||||
+---------------------------+-------------+------------------------+
|
||||
|DEVICE_CTRL_CLR_INT |NULL |关闭dma传输完成中断 |
|
||||
+---------------------------+-------------+------------------------+
|
||||
|DMA_CHANNEL_GET_STATUS |NULL |获取dma通道完成状态 |
|
||||
+---------------------------+-------------+------------------------+
|
||||
|DMA_CHANNEL_START |NULL |开启dma通道 |
|
||||
+---------------------------+-------------+------------------------+
|
||||
|DMA_CHANNEL_STOP |NULL |关闭dma通道 |
|
||||
+---------------------------+-------------+------------------------+
|
||||
|DMA_CHANNEL_UPDATE |uint32_t |更新dma传输配置 |
|
||||
+---------------------------+-------------+------------------------+
|
||||
.. list-table:: table1
|
||||
:widths: 15 10 30
|
||||
:header-rows: 1
|
||||
|
||||
* - cmd
|
||||
- args
|
||||
- description
|
||||
* - DEVICE_CTRL_SET_INT
|
||||
- NULL
|
||||
- 开启 dma 传输完成中断
|
||||
* - DEVICE_CTRL_CLR_INT
|
||||
- NULL
|
||||
- 关闭 dma 传输完成中断
|
||||
* - DMA_CHANNEL_GET_STATUS
|
||||
- NULL
|
||||
- 获取 dma 通道完成状态
|
||||
* - DMA_CHANNEL_START
|
||||
- NULL
|
||||
- 开启 dma 通道
|
||||
* - DMA_CHANNEL_STOP
|
||||
- NULL
|
||||
- 关闭 dma 通道
|
||||
* - DMA_CHANNEL_UPDATE
|
||||
- NULL
|
||||
- 更新 dma 传输配置
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
|
|||
|
|
@ -181,23 +181,28 @@ PWM 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
+------------------------------------------+---------------------------+--------------------------+
|
||||
|cmd |args |description |
|
||||
+==========================================+===========================+==========================+
|
||||
|DEVICE_CTRL_SET_INT |NULL |弃用 |
|
||||
+------------------------------------------+---------------------------+--------------------------+
|
||||
|DEVICE_CTRL_CLR_INT |NULL |弃用 |
|
||||
+------------------------------------------+---------------------------+--------------------------+
|
||||
|DEVICE_CTRL_RESUME |NULL |开启当前PWM通道 |
|
||||
+------------------------------------------+---------------------------+--------------------------+
|
||||
|DEVICE_CTRL_SUSPEND |NULL |关闭当前PWM通道 |
|
||||
+------------------------------------------+---------------------------+--------------------------+
|
||||
|DEVICE_CTRL_PWM_FREQUENCE_CONFIG |uint32_t |配置当前PWM通道周期值 |
|
||||
+------------------------------------------+---------------------------+--------------------------+
|
||||
|DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG |pwm_dutycycle_config_t |配置当前PWM通道占空比 |
|
||||
+------------------------------------------+---------------------------+--------------------------+
|
||||
|DEVICE_CTRL_PWM_IT_PULSE_COUNT_CONFIG |uint32_t |配置触发PWM中断周期值 |
|
||||
+------------------------------------------+---------------------------+--------------------------+
|
||||
.. list-table:: table1
|
||||
:widths: 15 10 30
|
||||
:header-rows: 1
|
||||
|
||||
* - cmd
|
||||
- args
|
||||
- description
|
||||
* - DEVICE_CTRL_RESUME
|
||||
- NULL
|
||||
- 开启当前 PWM 通道
|
||||
* - DEVICE_CTRL_SUSPEND
|
||||
- NULL
|
||||
- 关闭当前 PWM 通道
|
||||
* - DEVICE_CTRL_PWM_FREQUENCE_CONFIG
|
||||
- NULL
|
||||
- 配置当前 PWM 通道周期值
|
||||
* - DEVICE_CTRL_PWM_DUTYCYCLE_CONFIG
|
||||
- NULL
|
||||
- 配置当前 PWM 通道占空比
|
||||
* - DEVICE_CTRL_PWM_IT_PULSE_COUNT_CONFIG
|
||||
- NULL
|
||||
- 配置触发 PWM 中断周期值
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
|
|||
|
|
@ -212,31 +212,46 @@ SPI 设备除了标准的控制命令，还具有自己特殊的控制命令。
|
|||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|cmd |args |description |
|
||||
+=================================+===================+=======================+
|
||||
|DEVICE_CTRL_SET_INT |NULL |开启spi设备中断 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_CLR_INT |NULL |关闭spi设备中断 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_RESUME |NULL |恢复spi设备 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_SUSPEND |NULL |挂起spi设备 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_ATTACH_TX_DMA |struct device* |链接发送dma设备 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_ATTACH_RX_DMA |struct device* |链接接收dma设备 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_SPI_CONFIG_CLOCK |uint32_t |修改SPI设备时钟 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_TX_DMA_SUSPEND |NULL |挂起spi tx dma模式 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_RX_DMA_SUSPEND |NULL |挂起spi rx dma模式 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_TX_DMA_RESUME |NULL |恢复spi tx dma模式 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
|DEVICE_CTRL_RX_DMA_RESUME |NULL |恢复spi rx dma模式 |
|
||||
+---------------------------------+-------------------+-----------------------+
|
||||
.. list-table:: table1
|
||||
:widths: 15 10 30
|
||||
:header-rows: 1
|
||||
|
||||
* - cmd
|
||||
- args
|
||||
- description
|
||||
* - DEVICE_CTRL_SET_INT
|
||||
- NULL
|
||||
- 开启 spi 设备中断
|
||||
* - DEVICE_CTRL_CLR_INT
|
||||
- NULL
|
||||
- 关闭 spi 设备中断
|
||||
* - DEVICE_CTRL_RESUME
|
||||
- NULL
|
||||
- 恢复 spi 设备
|
||||
* - DEVICE_CTRL_SUSPEND
|
||||
- NULL
|
||||
- 挂起 spi 设备
|
||||
* - DEVICE_CTRL_ATTACH_TX_DMA
|
||||
- NULL
|
||||
- 链接发送 dma 设备
|
||||
* - DEVICE_CTRL_ATTACH_RX_DMA
|
||||
- NULL
|
||||
- 链接接收 dma 设备
|
||||
* - DEVICE_CTRL_SPI_CONFIG_CLOCK
|
||||
- NULL
|
||||
- 修改 spi 设备时钟
|
||||
* - DEVICE_CTRL_TX_DMA_SUSPEND
|
||||
- NULL
|
||||
- 挂起spi tx dma模式
|
||||
* - DEVICE_CTRL_RX_DMA_SUSPEND
|
||||
- NULL
|
||||
- 挂起spi rx dma模式
|
||||
* - DEVICE_CTRL_TX_DMA_RESUME
|
||||
- NULL
|
||||
- 恢复spi tx dma模式
|
||||
* - DEVICE_CTRL_RX_DMA_RESUME
|
||||
- NULL
|
||||
- 恢复spi rx dma模式
|
||||
|
||||
**device_write**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
|
|
|||
|
|
@ -23,27 +23,30 @@ TIMER 设备结构体定义
|
|||
typedef struct timer_device {
|
||||
struct device parent;
|
||||
uint8_t id;
|
||||
uint8_t ch;
|
||||
uint8_t clk_div;
|
||||
timer_cnt_mode cnt_mode;
|
||||
timer_pl_trig_t pl_trig_src;
|
||||
enum timer_cnt_mode_type cnt_mode;
|
||||
enum timer_preload_trigger_type trigger;
|
||||
uint32_t reload;
|
||||
uint32_t timeout1;
|
||||
uint32_t timeout2;
|
||||
uint32_t timeout3;
|
||||
} timer_device_t;
|
||||
|
||||
- parent 继承父类属性
|
||||
- id 定时器 id ，使能定时器 0 则 id 为 0 ，使能定时器 1 则 id 为 1 ，以此类推
|
||||
- ch timer 的通道号
|
||||
- clk_div 时钟分频系数
|
||||
- cnt_mode 计数模式
|
||||
- pl_trig_src 比较器的触发源
|
||||
|
||||
- cnt_mode 计数模式：FreeRun 和 PreLoad
|
||||
- trigger 比较器的触发源
|
||||
- reload 重装载值,只有在 PreLoad 模式下有效
|
||||
- timeout1 COMP0 超时时间，单位 us
|
||||
- timeout2 COMP1 超时时间，单位 us
|
||||
- timeout3 COMP2 超时时间，单位 us
|
||||
|
||||
``ch`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum timer_index_type {
|
||||
TIMER_CH0_INDEX,
|
||||
TIMER_CH1_INDEX,
|
||||
TIMER0_INDEX,
|
||||
TIMER1_INDEX,
|
||||
TIMER_MAX_INDEX
|
||||
};
|
||||
|
||||
|
|
@ -51,21 +54,21 @@ TIMER 设备结构体定义
|
|||
|
||||
.. code-block:: C
|
||||
|
||||
typedef enum {
|
||||
enum timer_cnt_mode_type {
|
||||
TIMER_CNT_PRELOAD,
|
||||
TIMER_CNT_FREERUN,
|
||||
} timer_cnt_mode;
|
||||
};
|
||||
|
||||
``pl_trig_src`` 提供以下类型
|
||||
``trigger`` 提供以下类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef enum {
|
||||
TIMER_PL_TRIG_NONE,
|
||||
TIMER_PL_TRIG_COMP0,
|
||||
TIMER_PL_TRIG_COMP1,
|
||||
TIMER_PL_TRIG_COMP2,
|
||||
} timer_pl_trig_t;
|
||||
enum timer_preload_trigger_type {
|
||||
TIMER_PRELOAD_TRIGGER_NONE,
|
||||
TIMER_PRELOAD_TRIGGER_COMP0,
|
||||
TIMER_PRELOAD_TRIGGER_COMP1,
|
||||
TIMER_PRELOAD_TRIGGER_COMP2,
|
||||
};
|
||||
|
||||
TIMER 设备参数配置表
|
||||
------------------------
|
||||
|
|
@ -75,39 +78,44 @@ TIMER 设备参数配置表
|
|||
.. code-block:: C
|
||||
|
||||
/*参数配置宏*/
|
||||
#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
|
||||
|
||||
#if defined(BSP_USING_TIMER_CH1)
|
||||
#ifndef TIMER_CH1_CONFIG
|
||||
#define TIMER_CH1_CONFIG \
|
||||
{ \
|
||||
.id = 0, \
|
||||
.ch = 1, \
|
||||
.cnt_mode = TIMER_CNT_PRELOAD, \
|
||||
.pl_trig_src = TIMER_PL_TRIG_COMP2, \
|
||||
#if defined(BSP_USING_TIMER1)
|
||||
#ifndef TIMER1_CONFIG
|
||||
#define TIMER1_CONFIG \
|
||||
{ \
|
||||
.id = 1, \
|
||||
.cnt_mode = TIMER_CNT_PRELOAD, \
|
||||
.trigger = TIMER_PRELOAD_TRIGGER_COMP0, \
|
||||
.reload = 0, \
|
||||
.timeout1 = 1000000, \
|
||||
.timeout2 = 2000000, \
|
||||
.timeout3 = 3000000, \
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/*变量定义*/
|
||||
enum timer_index_type {
|
||||
#ifdef BSP_USING_TIMER_CH0
|
||||
TIMER_CH0_INDEX,
|
||||
static timer_device_t timerx_device[TIMER_MAX_INDEX] = {
|
||||
#ifdef BSP_USING_TIMER0
|
||||
TIMER0_CONFIG,
|
||||
#endif
|
||||
#ifdef BSP_USING_TIMER_CH1
|
||||
TIMER_CH1_INDEX,
|
||||
#ifdef BSP_USING_TIMER1
|
||||
TIMER1_CONFIG,
|
||||
#endif
|
||||
TIMER_MAX_INDEX
|
||||
};
|
||||
|
||||
.. note:: 上述配置可以通过 ``TIMER_DEV(dev)->xxx`` 进行修改，只能在调用 ``device_open`` 之前使用。
|
||||
|
|
@ -120,7 +128,7 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
**timer_register**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
``timer_register`` 用来注册 TIMER 设备标准驱动接口，在注册之前需要打开对应 TIMER 设备的宏定义。例如定义宏 ``BSP_USING_TIMER_CH0`` 方可使用 ``TIMER_CH0_INDEX`` 设备,注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 ``TIMER_CH0_INDEX`` 设备。
|
||||
``timer_register`` 用来注册 TIMER 设备标准驱动接口，在注册之前需要打开对应 TIMER 设备的宏定义。例如定义宏 ``BSP_USING_TIMER0`` 方可使用 ``TIMER0_INDEX`` 设备,注册完成以后才可以使用其他接口，如果没有定义宏，则无法使用 ``TIMER0_INDEX`` 设备。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
|
|
@ -129,16 +137,16 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
- index 要注册的设备索引
|
||||
- name 为注册的设备命名
|
||||
|
||||
``index`` 用来选择 TIMER 设备配置，一个 index 对应一个 TIMER 设备配置，比如 ``TIMER_CH0_INDEX`` 对应 ``TIMER_CH0_CONFIG`` 配置，``index`` 有如下可选类型
|
||||
``index`` 用来选择 TIMER 设备配置，一个 index 对应一个 TIMER 设备配置，比如 ``TIMER0_INDEX`` 对应 ``TIMER0_CONFIG`` 配置，``index`` 有如下可选类型
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
enum timer_index_type {
|
||||
#ifdef BSP_USING_TIMER_CH0
|
||||
TIMER_CH0_INDEX,
|
||||
#ifdef BSP_USING_TIMER0
|
||||
TIMER0_INDEX,
|
||||
#endif
|
||||
#ifdef BSP_USING_TIMER_CH1
|
||||
TIMER_CH1_INDEX,
|
||||
#ifdef BSP_USING_TIMER1
|
||||
TIMER1_INDEX,
|
||||
#endif
|
||||
TIMER_MAX_INDEX
|
||||
};
|
||||
|
|
@ -160,11 +168,12 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEVICE_OFLAG_INT 0x01
|
||||
#define DEVICE_OFLAG_POLL 0x02
|
||||
#define DEVICE_CTRL_TIMER_CH_START 0x80
|
||||
#define DEVICE_CTRL_TIMER_CH_STOP 0x81
|
||||
#define DEVICE_CTRL_GET_MATCH_STATUS 0x82
|
||||
#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**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
|
@ -192,14 +201,6 @@ TIMER 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
- args 控制参数
|
||||
- return 不同的控制命令返回的意义不同。
|
||||
|
||||
TIMER 设备除了标准的控制命令，还具有私有的控制命令。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
#define DEVICE_CTRL_TIMER_CH_START 0x80
|
||||
#define DEVICE_CTRL_TIMER_CH_STOP 0x81
|
||||
#define DEVICE_CTRL_GET_MATCH_STATUS 0x82
|
||||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
.. list-table:: table1
|
||||
|
|
@ -215,25 +216,33 @@ TIMER 设备除了标准的控制命令，还具有私有的控制命令。
|
|||
* - DEVICE_CTRL_CLR_INT
|
||||
- NULL
|
||||
- 关闭 TIMER 中断
|
||||
* - DEVICE_CTRL_GET_INT
|
||||
- NULL
|
||||
- 获取当前中断状态
|
||||
* - DEVICE_CTRL_RESUME
|
||||
- NULL
|
||||
- 开启 TIMER
|
||||
- 开启 TIMER 设备
|
||||
* - DEVICE_CTRL_SUSPEND
|
||||
- NULL
|
||||
- 关闭 TIMER
|
||||
* - DEVICE_CTRL_TIMER_CH_START
|
||||
- timer_user_cfg_t
|
||||
- 开启 TIMER 及其中断
|
||||
* - DEVICE_CTRL_TIMER_CH_STOP
|
||||
- timer_user_cfg_t
|
||||
- 关闭 TIMER 及其中断
|
||||
- 关闭 TIMER 设备
|
||||
* - DEVICE_CTRL_GET_CONFIG
|
||||
- NULL
|
||||
- 获取 TIMER 当前的计数值
|
||||
* - DEVICE_CTRL_GET_MATCH_STATUS
|
||||
- uint32_t
|
||||
- 获取 TIMER 比较器的状态
|
||||
|
||||
**device_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 表示写入成功，其他表示错误
|
||||
|
||||
**device_set_callback**
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
|
|
|||
|
|
@ -204,34 +204,46 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
|
|||
|
||||
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
|
||||
|
||||
.. list-table:: table1
|
||||
:widths: 15 10 30
|
||||
:header-rows: 1
|
||||
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|cmd |args |description |
|
||||
+=================================+=====================+==============================+
|
||||
|DEVICE_CTRL_SET_INT |uart_it_type |开启uart设备中断 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_CLR_INT |uart_it_type |关闭uart设备中断 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_CONFIG |uart_param_cfg_t* |修改串口配置 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_ATTACH_TX_DMA |struct device* |链接发送dma设备 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_ATTACH_RX_DMA |struct device* |链接接收dma设备 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_ATTACH_RX_DMA |struct device* |链接接收dma设备 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_TX_DMA_SUSPEND |NULL |挂起uart tx dma模式 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_RX_DMA_SUSPEND |NULL |挂起uart rx dma模式 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_TX_DMA_RESUME |NULL |恢复uart tx dma模式 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_RX_DMA_RESUME |NULL |恢复uart rx dma模式 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_UART_GET_TX_FIFO |uint32_t* |获取uart 发送fifo数据个数 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
|DEVICE_CTRL_UART_GET_RX_FIFO |uint32_t* |获取uart 接收fifo数据个数 |
|
||||
+---------------------------------+---------------------+------------------------------+
|
||||
* - cmd
|
||||
- args
|
||||
- description
|
||||
* - DEVICE_CTRL_SET_INT
|
||||
- uart_it_type
|
||||
- 开启 uart 设备中断
|
||||
* - DEVICE_CTRL_CLR_INT
|
||||
- uart_it_type
|
||||
- 关闭 uart 设备中断
|
||||
* - DEVICE_CTRL_CONFIG
|
||||
- uart_param_cfg_t*
|
||||
- 修改串口配置
|
||||
* - DEVICE_CTRL_ATTACH_TX_DMA
|
||||
- NULL
|
||||
- 链接发送 dma 设备
|
||||
* - DEVICE_CTRL_ATTACH_RX_DMA
|
||||
- NULL
|
||||
- 链接接收 dma 设备
|
||||
* - DEVICE_CTRL_TX_DMA_SUSPEND
|
||||
- NULL
|
||||
- 挂起uart tx dma模式
|
||||
* - DEVICE_CTRL_RX_DMA_SUSPEND
|
||||
- NULL
|
||||
- 挂起uart rx dma模式
|
||||
* - DEVICE_CTRL_TX_DMA_RESUME
|
||||
- NULL
|
||||
- 恢复uart tx dma模式
|
||||
* - DEVICE_CTRL_RX_DMA_RESUME
|
||||
- NULL
|
||||
- 恢复uart rx dma模式
|
||||
* - DEVICE_CTRL_UART_GET_TX_FIFO
|
||||
- uint32_t*
|
||||
- 获取uart tx fifo 数据个数
|
||||
* - DEVICE_CTRL_UART_GET_RX_FIFO
|
||||
- uint32_t*
|
||||
- 获取uart rx fifo 数据个数
|
||||
|
||||
**device_write**
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
|
|
|||
|
|
@ -62,29 +62,191 @@ USB DEVICE 通用接口
|
|||
**usbd_desc_register**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_desc_register`` 用来注册 USB 描述符，描述符种类包括：设备描述符、配置描述符、接口描述符、字符串描述符、设备限定描述符。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_desc_register(const uint8_t *desc);
|
||||
|
||||
- desc 描述符的句柄
|
||||
|
||||
|
||||
**usbd_msosv1_desc_register**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_msosv1_desc_register`` 用来注册一个 WINUSB 描述符，格式按照 ``struct usb_msosv1_descriptor``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_msosv1_desc_register(struct usb_msosv1_descriptor *desc);
|
||||
|
||||
- desc 描述符句柄
|
||||
|
||||
|
||||
**usbd_class_add_interface**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_class_add_interface`` 用来给 USB 设备类增加接口，并将接口信息挂载在类的链表上。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_class_add_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class USB 设备类的句柄
|
||||
- intf USB 设备接口的句柄
|
||||
|
||||
``usbd_class_t`` 定义如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef struct usbd_class {
|
||||
usb_slist_t list;
|
||||
const char *name;
|
||||
usb_slist_t intf_list;
|
||||
} usbd_class_t;
|
||||
|
||||
- list 类的链表节点
|
||||
- name 类的名称
|
||||
- intf_list 接口的链表节点
|
||||
|
||||
``usbd_interface_t`` 定义如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef struct usbd_interface {
|
||||
usb_slist_t list;
|
||||
/** Handler for USB Class specific Control (EP 0) communications */
|
||||
usbd_request_handler class_handler;
|
||||
/** Handler for USB Vendor specific commands */
|
||||
usbd_request_handler vendor_handler;
|
||||
/** Handler for USB custom specific commands */
|
||||
usbd_request_handler custom_handler;
|
||||
/** Handler for USB event notify commands */
|
||||
usbd_notify_handler notify_handler;
|
||||
uint8_t intf_num;
|
||||
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 端点的链表节点
|
||||
|
||||
**usbd_interface_add_endpoint**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_interface_add_endpoint`` 用来给 USB 接口增加端点，并将端点信息挂载在接口的链表上。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_interface_add_endpoint(usbd_interface_t *intf, usbd_endpoint_t *ep);
|
||||
|
||||
|
||||
- intf USB 设备接口的句柄
|
||||
- ep USB 设备端点的句柄
|
||||
|
||||
``usbd_class_t`` 定义如下
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
typedef struct usbd_endpoint {
|
||||
usb_slist_t list;
|
||||
uint8_t ep_addr;
|
||||
usbd_endpoint_callback ep_cb;
|
||||
} usbd_endpoint_t;
|
||||
|
||||
- list 端点的链表节点
|
||||
- ep_addr 端点地址
|
||||
- ep_cb 端点中断回调函数
|
||||
|
||||
**usb_device_is_configured**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usb_device_is_configured`` 用来检查 USB 设备是否被配置（枚举）。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
bool usb_device_is_configured(void);
|
||||
|
||||
- return 配置状态， 0 表示未配置， 1 表示配置成功
|
||||
|
||||
|
||||
USB Device CDC 类接口
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**usbd_cdc_add_acm_interface**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
|
||||
``usbd_cdc_add_acm_interface`` 用来给 USB CDC ACM 类添加接口，并重写该接口相关的函数。重写的函数包括 ``cdc_acm_class_request_handler`` 和 ``cdc_notify_handler``，
|
||||
其中 ``cdc_acm_class_request_handler`` 用于处理 USB CDC ACM Setup 中断请求， ``cdc_notify_handler`` 用于实现 USB CDC 其他中断回调函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_cdc_add_acm_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class 类的句柄
|
||||
- intf 接口句柄
|
||||
|
||||
USB Device MSC 类接口
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**usbd_msc_class_init**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
``usbd_msc_class_init`` 用于初始化 USB MSC 类，注册 USB CDC ACM 设备并为其添加接口，且为接口添加 BLUK OUT 、BULK IN 端点及其回调函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_msc_class_init(uint8_t out_ep, uint8_t in_ep);
|
||||
|
||||
- out_ep 输出端点的地址
|
||||
- in_ep 输入端点的地址
|
||||
|
||||
|
||||
USB Device HID 类接口
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**usbd_hid_add_interface**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
``usbd_hid_add_interface`` 用来给 USB HID 类添加接口，并重写该接口相关的函数。重写的函数包括 ``hid_class_request_handler`` 、 ``hid_custom_request_handler``
|
||||
和 ``hid_notify_handler``，其中 ``hid_class_request_handler`` 用来处理 USB HID 类的 Setup 中断请求， ``hid_custom_request_handler`` 用来处理 USB HID 获取描述符请求，
|
||||
``hid_notify_handler`` 用来处理 USB HID 类的其他中断回调函数。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_hid_add_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class 类的句柄
|
||||
- intf 接口句柄
|
||||
|
||||
|
||||
USB Device AUDIO 类接口
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**usbd_audio_add_interface**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
``usbd_audio_add_interface`` 用来给 USB Audio 类添加接口，并重写该接口相关的函数。重写的函数包括 ``audio_class_request_handler`` 和 ``audio_notify_handler``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_audio_add_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class 类的句柄
|
||||
- intf 接口句柄
|
||||
|
||||
|
||||
USB Device VIDEO 类接口
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
**usbd_video_add_interface**
|
||||
""""""""""""""""""""""""""""""""""""
|
||||
``usbd_video_add_interface`` 用来给 USB Video 类添加接口，并重写该接口相关的函数。重写的函数包括 ``video_class_request_handler`` 和 ``video_notify_handler``。
|
||||
|
||||
.. code-block:: C
|
||||
|
||||
void usbd_video_add_interface(usbd_class_t *class, usbd_interface_t *intf);
|
||||
|
||||
- class 类的句柄
|
||||
- intf 接口句柄
|
||||
Loading…
Add table
Add a link
Reference in a new issue