GitHub-Mirror/bl_mcu_sdk
2
0
Fork 0
mirror of https://github.com/Fishwaldo/bl_mcu_sdk.git synced 2025-07-06 04:48:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[fix] fix docs

Browse source
This commit is contained in:
jzlv 2021-04-27 12:29:58 +08:00
parent 83471b4349
commit 8f7b0919fd
18 changed files with 64 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/development_guide/build/doctrees/Linux_quick_start_ubuntu.doctree
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/Windows_quick_start_cdk.doctree
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/Windows_quick_start_eclipse.doctree
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/api_guide.doctree
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/blink_demo_introduce.doctree
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/breath_pwm_demo_introduce.doctree
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/connecting_hardware.doctree
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/environment.pickle
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/get_started.doctree
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/index.doctree
View file

Binary file not shown.

BIN
docs/development_guide/build/doctrees/uart_loopback_demo_introduce.doctree
View file

Binary file not shown.

4
docs/development_guide/build/html/Linux_quick_start_ubuntu.html
View file

@ -215,7 +215,7 @@
$ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz
$ mkdir -p riscv64-elf-20210120
<span class="hll">$ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120
</span><span class="hll">$ sudo cp ~/riscv64-elf-20210120 /usr/bin
</span><span class="hll">$ sudo cp -rf ~/riscv64-elf-20210120 /usr/bin
</span><span class="hll">$ <span class="nb">echo</span> <span class="s2">&quot;export PATH=\&quot;</span><span class="nv">$PATH</span><span class="s2">:/usr/bin/riscv64-elf-20210120/bin\&quot;&quot;</span> &gt;&gt; ~/.bashrc
</span>$ <span class="nb">source</span> ~/.bashrc
</pre></div>
@ -235,7 +235,7 @@ $ sudo apt install make
$ <span class="nb">cd</span> ~
$ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz
<span class="hll">$ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz
</span><span class="hll">$ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin
</span><span class="hll">$ sudo cp -rf ~/cmake-3.19.3-Linux-x86_64 /usr/bin
</span><span class="hll">$ <span class="nb">echo</span> <span class="s2">&quot;export PATH=\&quot;</span><span class="nv">$PATH</span><span class="s2">:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\&quot;&quot;</span> &gt;&gt; ~/.bashrc
</span>$ <span class="nb">source</span> ~/.bashrc
</pre></div>

4
docs/development_guide/build/html/_sources/Linux_quick_start_ubuntu.rst.txt
View file

@ -23,7 +23,7 @@ Linux 环境开发指南
$ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz
$ mkdir -p riscv64-elf-20210120
$ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120
$ sudo cp ~/riscv64-elf-20210120 /usr/bin
$ sudo cp -rf ~/riscv64-elf-20210120 /usr/bin
$ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\"" >> ~/.bashrc
$ source ~/.bashrc
@ -39,7 +39,7 @@ Linux 环境开发指南
$ cd ~
$ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz
$ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz
$ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin
$ sudo cp -rf ~/cmake-3.19.3-Linux-x86_64 /usr/bin
$ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\"" >> ~/.bashrc
$ source ~/.bashrc

32
docs/development_guide/build/html/_sources/api_guide.rst.txt
View file

@ -207,13 +207,21 @@ API 分层模型
.. code-block:: C
#define DEVICE_CTRL_SET_INT 0x01 /* 设置中断 */
#define DEVICE_CTRL_CLR_INT 0x02 /* 清中断 */
#define DEVICE_CTRL_GET_INT 0x03 /* 获取中断状态 */
#define DEVICE_CTRL_RESUME 0x04 /* 恢复设备 */
#define DEVICE_CTRL_SUSPEND 0x05 /* 挂起设备 */
#define DEVICE_CTRL_CONFIG 0x06 /* 配置设备 */
#define DEVICE_CTRL_GET_CONFIG 0x07 /* 获取设备配置 */
#define DEVICE_CTRL_SET_INT 0x01 /* set interrupt */
#define DEVICE_CTRL_CLR_INT 0x02 /* clear interrupt */
#define DEVICE_CTRL_GET_INT 0x03 /* get interrupt status*/
#define DEVICE_CTRL_RESUME 0x04 /* resume device */
#define DEVICE_CTRL_SUSPEND 0x05 /* suspend device */
#define DEVICE_CTRL_CONFIG 0x06 /* config device */
#define DEVICE_CTRL_GET_CONFIG 0x07 /* get device configuration */
#define DEVICE_CTRL_ATTACH_TX_DMA 0x08
#define DEVICE_CTRL_ATTACH_RX_DMA 0x09
#define DEVICE_CTRL_TX_DMA_SUSPEND 0x0a
#define DEVICE_CTRL_RX_DMA_SUSPEND 0x0b
#define DEVICE_CTRL_TX_DMA_RESUME 0x0c
#define DEVICE_CTRL_RX_DMA_RESUME 0x0d
#define DEVICE_CTRL_RESVD1 0x0E
#define DEVICE_CTRL_RESVD2 0x0F
**device_write**
^^^^^^^^^^^^^^^^
@ -371,7 +379,7 @@ GPIO 全称 General Purpose Input Output（通用输入 / 输出），博流系
bl mcu sdk 的引脚配置方式分为两种。
- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚和工功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。
- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚的功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。
- 通过标准的 GPIO 设备接口配置引脚，缺点是只能配置普通的输入输出和中断功能，复用功能建议还是使用 table 进行配置。
GPIO 设备接口
@ -514,7 +522,7 @@ UART 设备结构体定义
- parity 校验位
- fifo_threshold fifo 阈值,不同 mcu 最大值不同
- tx_dma 附加的发送 dma 句柄
- rx_dma 附加的发送 dma 句柄
- rx_dma 附加的接收 dma 句柄
databits 提供以下类型
@ -679,8 +687,6 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
#define DEVICE_CTRL_UART_GET_TX_FIFO 0x10
#define DEVICE_CTRL_UART_GET_RX_FIFO 0x11
#define DEVICE_CTRL_UART_ATTACH_TX_DMA 0x12
#define DEVICE_CTRL_UART_ATTACH_RX_DMA 0x13
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
@ -693,9 +699,9 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
+---------------------------------------+--------------------------------------+
| DEVICE_CTRL_CONFIG | uart_param_cfg_t |
+---------------------------------------+--------------------------------------+
| DEVICE_CTRL_UART_ATTACH_TX_DMA | dma句柄 |
| DEVICE_CTRL_ATTACH_TX_DMA | dma句柄 |
+---------------------------------------+--------------------------------------+
| DEVICE_CTRL_UART_ATTACH_RX_DMA | dma句柄 |
| DEVICE_CTRL_ATTACH_RX_DMA | dma句柄 |
+---------------------------------------+--------------------------------------+
| DEVICE_CTRL_UART_GET_TX_FIFO | 缓存变量 |
+---------------------------------------+--------------------------------------+

32
docs/development_guide/build/html/api_guide.html
View file

@ -406,13 +406,21 @@
<li><p>return 不同的控制命令返回的意义不同。</p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">cmd</span></code> 提供了以下标准命令，除此之外，不同外设还具有自己的命令</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cp">#define DEVICE_CTRL_SET_INT 0x01 </span><span class="cm">/* 设置中断 */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_CLR_INT 0x02 </span><span class="cm">/* 清中断 */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_GET_INT 0x03 </span><span class="cm">/* 获取中断状态 */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_RESUME 0x04 </span><span class="cm">/* 恢复设备 */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_SUSPEND 0x05 </span><span class="cm">/* 挂起设备 */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_CONFIG 0x06 </span><span class="cm">/* 配置设备 */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_GET_CONFIG 0x07 </span><span class="cm">/* 获取设备配置 */</span><span class="cp"></span>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cp">#define DEVICE_CTRL_SET_INT 0x01 </span><span class="cm">/* set interrupt */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_CLR_INT 0x02 </span><span class="cm">/* clear interrupt */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_GET_INT 0x03 </span><span class="cm">/* get interrupt status*/</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_RESUME 0x04 </span><span class="cm">/* resume device */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_SUSPEND 0x05 </span><span class="cm">/* suspend device */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_CONFIG 0x06 </span><span class="cm">/* config device */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_GET_CONFIG 0x07 </span><span class="cm">/* get device configuration */</span><span class="cp"></span>
<span class="cp">#define DEVICE_CTRL_ATTACH_TX_DMA 0x08</span>
<span class="cp">#define DEVICE_CTRL_ATTACH_RX_DMA 0x09</span>
<span class="cp">#define DEVICE_CTRL_TX_DMA_SUSPEND 0x0a</span>
<span class="cp">#define DEVICE_CTRL_RX_DMA_SUSPEND 0x0b</span>
<span class="cp">#define DEVICE_CTRL_TX_DMA_RESUME 0x0c</span>
<span class="cp">#define DEVICE_CTRL_RX_DMA_RESUME 0x0d</span>
<span class="cp">#define DEVICE_CTRL_RESVD1 0x0E</span>
<span class="cp">#define DEVICE_CTRL_RESVD2 0x0F</span>
</pre></div>
</div>
</div>
@ -554,7 +562,7 @@
</ul>
<p>bl mcu sdk 的引脚配置方式分为两种。</p>
<ul class="simple">
<li><p>GPIO 复用功能通过专门的 <strong>pinmux table</strong> ，用户只需要修改 table 中的相关引脚和工功能，程序会自动配置这些引脚。<strong>pinmux table</strong> 位于 <code class="docutils literal notranslate"><span class="pre">bsp/board/xxx_board</span></code> 目录下 <code class="docutils literal notranslate"><span class="pre">pinmux_config.h</span></code> 文件。</p></li>
<li><p>GPIO 复用功能通过专门的 <strong>pinmux table</strong> ，用户只需要修改 table 中的相关引脚的功能，程序会自动配置这些引脚。<strong>pinmux table</strong> 位于 <code class="docutils literal notranslate"><span class="pre">bsp/board/xxx_board</span></code> 目录下 <code class="docutils literal notranslate"><span class="pre">pinmux_config.h</span></code> 文件。</p></li>
<li><p>通过标准的 GPIO 设备接口配置引脚，缺点是只能配置普通的输入输出和中断功能，复用功能建议还是使用 table 进行配置。</p></li>
</ul>
</div>
@ -683,7 +691,7 @@
<li><p>parity 校验位</p></li>
<li><p>fifo_threshold fifo 阈值,不同 mcu 最大值不同</p></li>
<li><p>tx_dma 附加的发送 dma 句柄</p></li>
<li><p>rx_dma 附加的发送 dma 句柄</p></li>
<li><p>rx_dma 附加的接收 dma 句柄</p></li>
</ul>
<p>databits 提供以下类型</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="k">typedef</span> <span class="k">enum</span>
@ -827,8 +835,6 @@
<p>串口设备除了标准的控制命令，还具有自己特殊的控制命令。</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="cp">#define DEVICE_CTRL_UART_GET_TX_FIFO 0x10</span>
<span class="cp">#define DEVICE_CTRL_UART_GET_RX_FIFO 0x11</span>
<span class="cp">#define DEVICE_CTRL_UART_ATTACH_TX_DMA 0x12</span>
<span class="cp">#define DEVICE_CTRL_UART_ATTACH_RX_DMA 0x13</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">args</span></code> 根据不同的 <code class="docutils literal notranslate"><span class="pre">cmd</span></code> 传入不同，具体如下：</p>
@ -852,10 +858,10 @@
<tr class="row-even"><td><p>DEVICE_CTRL_CONFIG</p></td>
<td><p>uart_param_cfg_t</p></td>
</tr>
<tr class="row-odd"><td><p>DEVICE_CTRL_UART_ATTACH_TX_DMA</p></td>
<tr class="row-odd"><td><p>DEVICE_CTRL_ATTACH_TX_DMA</p></td>
<td><p>dma句柄</p></td>
</tr>
<tr class="row-even"><td><p>DEVICE_CTRL_UART_ATTACH_RX_DMA</p></td>
<tr class="row-even"><td><p>DEVICE_CTRL_ATTACH_RX_DMA</p></td>
<td><p>dma句柄</p></td>
</tr>
<tr class="row-odd"><td><p>DEVICE_CTRL_UART_GET_TX_FIFO</p></td>

2
docs/development_guide/build/html/searchindex.js
View file

File diff suppressed because one or more lines are too long

4
docs/development_guide/source/Linux_quick_start_ubuntu.rst
View file

@ -23,7 +23,7 @@ Linux 环境开发指南
$ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz
$ mkdir -p riscv64-elf-20210120
$ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120
$ sudo cp ~/riscv64-elf-20210120 /usr/bin
$ sudo cp -rf ~/riscv64-elf-20210120 /usr/bin
$ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\"" >> ~/.bashrc
$ source ~/.bashrc
@ -39,7 +39,7 @@ Linux 环境开发指南
$ cd ~
$ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz
$ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz
$ sudo cp ~/cmake-3.19.3-Linux-x86_64 /usr/bin
$ sudo cp -rf ~/cmake-3.19.3-Linux-x86_64 /usr/bin
$ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\"" >> ~/.bashrc
$ source ~/.bashrc

32
docs/development_guide/source/api_guide.rst
View file

@ -207,13 +207,21 @@ API 分层模型
.. code-block:: C
#define DEVICE_CTRL_SET_INT 0x01 /* 设置中断 */
#define DEVICE_CTRL_CLR_INT 0x02 /* 清中断 */
#define DEVICE_CTRL_GET_INT 0x03 /* 获取中断状态 */
#define DEVICE_CTRL_RESUME 0x04 /* 恢复设备 */
#define DEVICE_CTRL_SUSPEND 0x05 /* 挂起设备 */
#define DEVICE_CTRL_CONFIG 0x06 /* 配置设备 */
#define DEVICE_CTRL_GET_CONFIG 0x07 /* 获取设备配置 */
#define DEVICE_CTRL_SET_INT 0x01 /* set interrupt */
#define DEVICE_CTRL_CLR_INT 0x02 /* clear interrupt */
#define DEVICE_CTRL_GET_INT 0x03 /* get interrupt status*/
#define DEVICE_CTRL_RESUME 0x04 /* resume device */
#define DEVICE_CTRL_SUSPEND 0x05 /* suspend device */
#define DEVICE_CTRL_CONFIG 0x06 /* config device */
#define DEVICE_CTRL_GET_CONFIG 0x07 /* get device configuration */
#define DEVICE_CTRL_ATTACH_TX_DMA 0x08
#define DEVICE_CTRL_ATTACH_RX_DMA 0x09
#define DEVICE_CTRL_TX_DMA_SUSPEND 0x0a
#define DEVICE_CTRL_RX_DMA_SUSPEND 0x0b
#define DEVICE_CTRL_TX_DMA_RESUME 0x0c
#define DEVICE_CTRL_RX_DMA_RESUME 0x0d
#define DEVICE_CTRL_RESVD1 0x0E
#define DEVICE_CTRL_RESVD2 0x0F
**device_write**
^^^^^^^^^^^^^^^^
@ -371,7 +379,7 @@ GPIO 全称 General Purpose Input Output（通用输入 / 输出），博流系
bl mcu sdk 的引脚配置方式分为两种。
- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚和工功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。
- GPIO 复用功能通过专门的 **pinmux table** ，用户只需要修改 table 中的相关引脚的功能，程序会自动配置这些引脚。**pinmux table** 位于 ``bsp/board/xxx_board`` 目录下 ``pinmux_config.h`` 文件。
- 通过标准的 GPIO 设备接口配置引脚，缺点是只能配置普通的输入输出和中断功能，复用功能建议还是使用 table 进行配置。
GPIO 设备接口
@ -514,7 +522,7 @@ UART 设备结构体定义
- parity 校验位
- fifo_threshold fifo 阈值,不同 mcu 最大值不同
- tx_dma 附加的发送 dma 句柄
- rx_dma 附加的发送 dma 句柄
- rx_dma 附加的接收 dma 句柄
databits 提供以下类型
@ -679,8 +687,6 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
#define DEVICE_CTRL_UART_GET_TX_FIFO 0x10
#define DEVICE_CTRL_UART_GET_RX_FIFO 0x11
#define DEVICE_CTRL_UART_ATTACH_TX_DMA 0x12
#define DEVICE_CTRL_UART_ATTACH_RX_DMA 0x13
``args`` 根据不同的 ``cmd`` 传入不同，具体如下：
@ -693,9 +699,9 @@ UART 设备接口全部遵循标准设备驱动管理层提供的接口。
+---------------------------------------+--------------------------------------+
| DEVICE_CTRL_CONFIG | uart_param_cfg_t |
+---------------------------------------+--------------------------------------+
| DEVICE_CTRL_UART_ATTACH_TX_DMA | dma句柄 |
| DEVICE_CTRL_ATTACH_TX_DMA | dma句柄 |
+---------------------------------------+--------------------------------------+
| DEVICE_CTRL_UART_ATTACH_RX_DMA | dma句柄 |
| DEVICE_CTRL_ATTACH_RX_DMA | dma句柄 |
+---------------------------------------+--------------------------------------+
| DEVICE_CTRL_UART_GET_TX_FIFO | 缓存变量 |
+---------------------------------------+--------------------------------------+