CloudEdge/bl_mcu_sdk
Archived
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

[doc] update readme icons

Browse Source
This commit is contained in:
jzlv 2022-10-21 11:42:28 +08:00
parent 664c605ada
commit a527cf7721
3 changed files with 149 additions and 147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@ -15,41 +15,41 @@ Note2：due to the non-generic peripherals, the code style and interface name in
| CHIP | v1.4.5 | latest |
|:-------------:|:--------:|:-------:|
|BL602/BL604 | ✔️ | ❌ |
|BL702/BL704/BL706 | ✔️ | ✔️ |
|BL616 | ❌ | ✔️ |
|BL808 | ❌ | ✔️ |
|BL602/BL604 | √ | × |
|BL702/BL704/BL706 | √ | √ |
|BL616 | × | √ |
|BL808 | × | √ |
## LHAL Support
**LHAL** is a low level hal driver for common peripherals designed by Bouffalo Lab, in order to support all the Bouffalo chips with the same api . Also it is convenient for users to use and port to other platforms.
Note：**✔️** means supported ；**❌** means not supported；**❓** means supported but not tested ；**➖** means no such peripheral。
Note：**√** means supported ；**×** means not supported；**○** means supported but not tested ；**-** means no such peripheral。
| Peripheral | BL602/BL604 | BL702/BL704/BL706 | BL616 | BL808 |
|:-------:|:---------------:|:--------------------:|:--------------:|:--------------:|
| ADC | ❓ | ✔️ | ✔️ | ❓ |
| CAM | ➖ | ❌ | ❌ | ❌ |
| DAC | ❓ | ✔️ | ✔️ | ❓ |
| DMA | ❓ | ✔️ | ✔️ | ✔️ |
| EFUSE | ❌ | ❌ | ❌ | ❌ |
| EMAC | ➖ | ✔️ | ✔️ | ✔️ |
| FLASH | ❌ | ❌ | ❌ | ❌ |
| GPIO | ❓ | ✔️ | ✔️ | ✔️ |
| I2C | ❓ | ✔️ | ✔️ | ❓ |
| IR | ❓ | ✔️ | ✔️ | ❓ |
| MJPEG | ❌ | ❌ | ❌ | ❌ |
| PWM_v1 | ❓ | ✔️ | ➖ | ➖ |
| PWM_v2 | ➖ | ➖ | ✔️ | ✔️ |
| RTC | ❓ | ✔️ | ✔️ | ✔️ |
| SEC_AES | ❓ | ✔️ | ✔️ | ✔️ |
| SEC_SHA | ❓ | ✔️ | ✔️ | ✔️ |
| SEC_TRNG | ❓ | ✔️ | ✔️ | ✔️ |
| SPI | ❓ | ✔️ | ✔️ | ❓ |
| TIMER | ❓ | ✔️ | ✔️ | ✔️ |
| UART | ❓ | ✔️ | ✔️ | ✔️ |
| USB_v1 | ➖ | ✔️ | ➖ | ➖ |
| USB_v2 | ➖ | ➖ | ✔️ | ✔️ |
| Peripheral | BL602/BL604 | BL702/BL704/BL706 | BL616 | BL808 |
|:------------:|:--------------:|:--------------------:|:-----------:|:--------:|
| ADC | ○ | √ | √ | ○ |
| CAM | - | × | × | × |
| DAC | ○ | √ | √ | ○ |
| DMA | ○ | √ | √ | √ |
| EFUSE | × | × | × | × |
| EMAC | - | √ | √ | √ |
| FLASH | × | × | × | × |
| GPIO | ○ | √ | √ | √ |
| I2C | ○ | √ | √ | ○ |
| IR | ○ | √ | √ | ○ |
| MJPEG | × | × | × | × |
| PWM_v1 | ○ | √ | - | - |
| PWM_v2 | - | - | √ | √ |
| RTC | ○ | √ | √ | √ |
| SEC_AES | ○ | √ | √ | √ |
| SEC_SHA | ○ | √ | √ | √ |
| SEC_TRNG | ○ | √ | √ | √ |
| SPI | ○ | √ | √ | ○ |
| TIMER | ○ | √ | √ | √ |
| UART | ○ | √ | √ | √ |
| USB_v1 | - | √ | - | - |
| USB_v2 | - | - | √ | √ |
## Code Framework
@ -146,6 +146,7 @@ TODO
To get more bl mcu sdk documentation tutorial, like api manual or peripheral demo and so on, please visit:
- [bl mcu sdk v2.0 documentation tutorial](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/)
- [bl mcu sdk v1.4.5 documentation tutorial](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_en/index.html)
## Video Tutorial

59
README_zh.md
View File

@ -15,41 +15,41 @@
| 芯片 | v1.4.5 | latest |
|:-------------:|:--------:|:-------:|
|BL602/BL604 | ✔️ | ❌ |
|BL702/BL704/BL706 | ✔️ | ✔️ |
|BL616 | ❌ | ✔️ |
|BL808 | ❌ | ✔️ |
|BL602/BL604 | √ | × |
|BL702/BL704/BL706 | √ | √ |
|BL616 | × | √ |
|BL808 | × | √ |
## LHAL 支持情况
**LHAL** 是博流为统一通用外设接口而设计的驱动库，代码精炼并且支持博流所有系列芯片，方便用户使用和移植到其他平台。
备注：**✔️** 表示已支持；**❌** 表示未支持；**❓** 表示已支持但未测试；**➖** 表示没有该外设。
备注：**√** 表示已支持；**×** 表示未支持；**○** 表示已支持但未测试；**-** 表示没有该外设。
| 外设 | BL602/BL604 | BL702/BL704/BL706 | BL616 | BL808 |
|:-------:|:---------------:|:--------------------:|:--------------:|:--------------:|
| ADC | ❓ | ✔️ | ✔️ | ❓ |
| CAM | ➖ | ❌ | ❌ | ❌ |
| DAC | ❓ | ✔️ | ✔️ | ❓ |
| DMA | ❓ | ✔️ | ✔️ | ✔️ |
| EFUSE | ❌ | ❌ | ❌ | ❌ |
| EMAC | ➖ | ✔️ | ✔️ | ✔️ |
| FLASH | ❌ | ❌ | ❌ | ❌ |
| GPIO | ❓ | ✔️ | ✔️ | ✔️ |
| I2C | ❓ | ✔️ | ✔️ | ❓ |
| IR | ❓ | ✔️ | ✔️ | ❓ |
| MJPEG | ❌ | ❌ | ❌ | ❌ |
| PWM_v1 | ❓ | ✔️ | ➖ | ➖ |
| PWM_v2 | ➖ | ➖ | ✔️ | ✔️ |
| RTC | ❓ | ✔️ | ✔️ | ✔️ |
| SEC_AES | ❓ | ✔️ | ✔️ | ✔️ |
| SEC_SHA | ❓ | ✔️ | ✔️ | ✔️ |
| SEC_TRNG | ❓ | ✔️ | ✔️ | ✔️ |
| SPI | ❓ | ✔️ | ✔️ | ❓ |
| TIMER | ❓ | ✔️ | ✔️ | ✔️ |
| UART | ❓ | ✔️ | ✔️ | ✔️ |
| USB_v1 | ➖ | ✔️ | ➖ | ➖ |
| USB_v2 | ➖ | ➖ | ✔️ | ✔️ |
| 外设 | BL602/BL604 | BL702/BL704/BL706 | BL616 | BL808 |
|:------------:|:--------------:|:--------------------:|:-----------:|:--------:|
| ADC | ○ | √ | √ | ○ |
| CAM | - | × | × | × |
| DAC | ○ | √ | √ | ○ |
| DMA | ○ | √ | √ | √ |
| EFUSE | × | × | × | × |
| EMAC | - | √ | √ | √ |
| FLASH | × | × | × | × |
| GPIO | ○ | √ | √ | √ |
| I2C | ○ | √ | √ | ○ |
| IR | ○ | √ | √ | ○ |
| MJPEG | × | × | × | × |
| PWM_v1 | ○ | √ | - | - |
| PWM_v2 | - | - | √ | √ |
| RTC | ○ | √ | √ | √ |
| SEC_AES | ○ | √ | √ | √ |
| SEC_SHA | ○ | √ | √ | √ |
| SEC_TRNG | ○ | √ | √ | √ |
| SPI | ○ | √ | √ | ○ |
| TIMER | ○ | √ | √ | √ |
| UART | ○ | √ | √ | √ |
| USB_v1 | - | √ | - | - |
| USB_v2 | - | - | √ | √ |
# 代码框架
@ -144,6 +144,7 @@ TODO
获取更多 bl mcu sdk 开发相关的教程，如环境搭建、 api 手册、外设 demo 等，请参考：
- [bl mcu sdk v2.0 文档教程](https://bl-mcu-sdk.readthedocs.io/zh_CN/latest/)
- [bl mcu sdk v1.4.5 文档教程](https://dev.bouffalolab.com/media/doc/sdk/bl_mcu_sdk_zh/index.html)
# 视频教程

178
docs/source/api_reference/peripherals/index.rst
View File

@ -62,7 +62,7 @@ API 支持情况
了解了上面的基本概念以后，接下来就可以查阅相关 **LHAL** API 并使用了。当前已经支持的 **LHAL** API 列表如下：
.. note:: **✔️** 表示已支持； **❌** 表示未支持； **❓** 表示已支持但未测试； **➖** 表示没有该外设。
.. note:: **√** 表示已支持； **×** 表示未支持； **○** 表示已支持但未测试； **-** 表示没有该外设。
.. list-table::
:widths: 10 10 10 10 10
@ -74,115 +74,115 @@ API 支持情况
- BL616
- BL808
* - ADC
- ❓
- ✔️
- ✔️
- ❓
- ○
- √
- √
- ○
* - CAM
- ➖
- ❌
- ❌
- ❌
- **-**
- ×
- ×
- ×
* - DAC
- ❓
- ✔️
- ✔️
- ❓
- ○
- √
- √
- ○
* - DMA
- ❓
- ✔️
- ✔️
- ✔️
- ○
- √
- √
- √
* - EFUSE
- ❌
- ❌
- ❌
- ❌
- ×
- ×
- ×
- ×
* - EMAC
- ➖
- ✔️
- ✔️
- ✔️
- **-**
- √
- √
- √
* - FLASH
- ❌
- ❌
- ❌
- ❌
- ×
- ×
- ×
- ×
* - GPIO
- ❓
- ✔️
- ✔️
- ✔️
- ○
- √
- √
- √
* - I2C
- ❓
- ✔️
- ✔️
- ❓
- ○
- √
- √
- ○
* - IR
- ❓
- ✔️
- ✔️
- ✔️
- ○
- √
- √
- √
* - MJPEG
- ❌
- ❌
- ❌
- ❌
- ×
- ×
- ×
- ×
* - PWM_v1
- ❓
- ✔️
- ➖
- ➖
- ○
- √
- **-**
- **-**
* - PWM_v2
- ➖
- ➖
- ✔️
- ✔️
- **-**
- **-**
- √
- √
* - RTC
- ❓
- ✔️
- ✔️
- ✔️
- ○
- √
- √
- √
* - SEC_AES
- ❓
- ✔️
- ✔️
- ✔️
- ○
- √
- √
- √
* - SEC_SHA
- ❓
- ✔️
- ✔️
- ✔️
- ○
- √
- √
- √
* - SEC_TRNG
- ❓
- ✔️
- ✔️
- ✔️
- ○
- √
- √
- √
* - SPI
- ❓
- ✔️
- ✔️
- ❓
- ○
- √
- √
- ○
* - TIMER
- ❓
- ✔️
- ✔️
- ✔️
- ○
- √
- √
- √
* - UART
- ❓
- ✔️
- ✔️
- ✔️
- ○
- √
- √
- √
* - USB_v1
- ➖
- ✔️
- ➖
- ➖
- **-**
- √
- **-**
- **-**
* - USB_v2
- ➖
- ➖
- ✔️
- ✔️
- **-**
- **-**
- √
- √
API 列表
---------------