mirror of
https://github.com/Fishwaldo/bl_mcu_sdk.git
synced 2025-07-08 05:48:28 +00:00
[docs] add english readme
This commit is contained in:
qqwang
parent
cec78e1093
commit
e6e363da7e
2 changed files with 239 additions and 81 deletions
97
README.md
97
README.md
|
|
@ -1,8 +1,12 @@
|
||||||
# 简介
|
|
||||||
|
|
||||||
**bl mcu sdk** 是博流智能科技团队专为 BL602/BL604,BL702/BL704/BL706 以及未来其他系列芯片提供的 MCU 软件开发包。
|
[中文版](README_zh.md)
|
||||||
|
|
||||||
## 代码框架
|
# Introduction
|
||||||
|
|
||||||
|
**bl mcu sdk** is an MCU software development kit provided by the Bouffalo Lab Team for BL602/BL604, BL702/BL704/BL706 and other series of chips in the future.
|
||||||
|
|
||||||
|
## Code Framework
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -58,85 +62,88 @@ bl_mcu_sdk
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- bsp/bsp_common 存放一些板级相关的常用外设驱动代码
|
- bsp/bsp_common : stores some common peripheral driver codes related to the board
|
||||||
- bsp/board 存放板级描述文件 clock_config.h(描述时钟配置文件) pinmux_config.h(描述io功能文件) peripheral_config.h(描述外设默认配置文件) 这几个文件共同形成board文件夹描述特定应用的所有硬件信息。
|
- bsp/board : stores the board-level description file such as `clock_config.h` (describes the clock configuration file) `pinmux_config.h` (describes the io function file) `peripheral_config.h` (describes the default configuration file of the peripheral) , These files together describe the board hardware information.
|
||||||
- common 存放一些常见的与硬件无关的算法函数库
|
- common : stores some common algorithm function libraries that have nothing to do with hardware
|
||||||
- components 存放第三方库公共组件库
|
- components : store the third-party library public component library
|
||||||
- drivers 存放博流智能提供的公共芯片底层驱动库
|
- drivers store the public chip underlying driver library provided by Boliu Intelligence
|
||||||
- examples 存放官方提供的示例代码
|
- examples : store the official sample code
|
||||||
- out 中间文件，用来存放编译链接后的产生的bin文件
|
- out : intermediate file, used to store the bin file generated after compiling and linking
|
||||||
- tools 存放编译下载相关的工具包
|
- tools : store toolkits related to compiling and downloading
|
||||||
- docs 存放教程文档以及其他帮助信息
|
- docs : store tutorial documents and other help information
|
||||||
|
|
||||||
更多文件目录参考信息，请查阅 [bl mcu sdk 文档教程](http://bouffalolab.gitee.io/bl_mcu_sdk)
|
For more file directory reference information, please refer to [bl mcu sdk documentation tutorial](http://bouffalolab.gitee.io/bl_mcu_sdk)
|
||||||
## 层次结构
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
[](https://imgtu.com/i/RpUVoj)
|
[](https://imgtu.com/i/RpUVoj)
|
||||||
|
|
||||||
# 资源
|
# Resources
|
||||||
|
|
||||||
## 硬件资源
|
## Hardware Resources
|
||||||
|
|
||||||
- BL706 IOT 开发板
|
- BL706 IOT Development board
|
||||||
[](https://imgtu.com/i/RpUI0g)
|
[](https://imgtu.com/i/RpUI0g)
|
||||||
|
|
||||||
- BL706 AVB 开发板
|
- BL706 AVB Development Board
|
||||||
[](https://imgtu.com/i/Rpa7DO)
|
[](https://imgtu.com/i/Rpa7DO)
|
||||||
|
|
||||||
|
|
||||||
目前暂时没有提供官方的购买渠道，如果想获得上述开发板，可到任意开源社区留言申请。
|
There is currently no official purchase channel. If you want to get the above development board, you can apply for it in any open source community.
|
||||||
## 芯片手册
|
|
||||||
|
|
||||||
[芯片参考手册](https://dev.bouffalolab.com/media/upload/doc/BL702_BL704_706_RM_zh_CN_1.1.pdf)|[芯片数据手册](https://dev.bouffalolab.com/media/upload/doc/BL702_BL704_BL706_DS_zh_CN_Combo_2.0.pdf)
|
## Chip Manual
|
||||||
|
|
||||||
更多资料请访问 BouffaloLab 开发者网站: [https://dev.bouffalolab.com/](https://dev.bouffalolab.com/)
|
[Chip Reference Manual](https://dev.bouffalolab.com/media/upload/doc/BL702_BL704_706_RM_zh_CN_1.1.pdf) | [Chip Data Manual](https://dev.bouffalolab.com/media/upload/doc/BL702_BL704_BL706_DS_zh_CN_Combo_2.0.pdf)
|
||||||
|
|
||||||
## 文档教程
|
For more information, please visit the BouffaloLab developer website: [https://dev.bouffalolab.com/](https://dev.bouffalolab.com/)
|
||||||
|
|
||||||
包含 bl mcu sdk 开发的快速入门教程， api 手册以及驱动框架等详细介绍
|
|
||||||
|
|
||||||
- [bl mcu sdk 文档教程](http://bouffalolab.gitee.io/bl_mcu_sdk)
|
## Documentation Tutorial
|
||||||
|
|
||||||
## 视频教程
|
Contains a quick start tutorial for bl mcu sdk development, api manual and a detailed introduction to the driver framework, etc.
|
||||||
|
|
||||||
- [BL706 MCU 开发系列视频教程](https://www.bilibili.com/video/BV1xK4y1P7ur)
|
- [bl mcu sdk documentation tutorial](http://bouffalolab.gitee.io/bl_mcu_sdk)
|
||||||
|
|
||||||
## 开发工具
|
## Video tutorial
|
||||||
|
|
||||||
### 命令行开发
|
- [BL706 MCU Development Series Video Tutorial](https://www.bilibili.com/video/BV1xK4y1P7ur)
|
||||||
|
|
||||||
命令行开发需要的工具，具体使用方法参考 [linux 开发指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Linux_quick_start_ubuntu.html)
|
## development tools
|
||||||
|
|
||||||
- [cmake 3.19](https://cmake.org/files/v3.19/)， cmake 编译工具，建议使用 cmake v3.19 以上版本
|
### Command line development
|
||||||
|
|
||||||
### Eclipse开发
|
For the tools needed for command line development, please refer to [linux development guide](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Linux_quick_start_ubuntu.html)
|
||||||
|
|
||||||
Eclipse 开发需要的工具，具体使用方法参考 [Eclipse 开发指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_eclipse.html)
|
- [cmake 3.19](https://cmake.org/files/v3.19/), cmake compilation tool, it is recommended to use cmake v3.19 or above
|
||||||
|
|
||||||
- [Eclipse](https://dev.bouffalolab.com/media/upload/download/BouffaloLab_eclipse_x86_64_win.zip) Windows 下 eclipse 开发免安装包
|
### Eclipse development
|
||||||
- [J-Link v10](https://www.segger.com/downloads/jlink)， J-Link 调试器，用于在线调试芯片，建议使用 J-Link V10 以上版本硬件，软件驱动建议使用 V6.98 版本
|
|
||||||
|
|
||||||
### CDK开发
|
For the tools needed for Eclipse development, please refer to [Eclipse Development Guide](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_eclipse.html)
|
||||||
|
|
||||||
CDK 开发需要的工具，具体使用方法参考 [CDK 开发指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_cdk.html)
|
- [Eclipse](https://dev.bouffalolab.com/media/upload/download/BouffaloLab_eclipse_x86_64_win.zip) eclipse development free installation package under Windows
|
||||||
|
- [J-Link v10](https://www.segger.com/downloads/jlink), J-Link debugger, used to debug the chip online, it is recommended to use the hardware of J-Link V10 or above, and the software driver is recommended to use V6 .98 version
|
||||||
|
|
||||||
- [CDK](https://occ.t-head.cn/development/activities/cdk)，平头哥剑池 CDK 集成开发环境，建议使用 CDK v2.8.4 以上版本
|
### CDK Development
|
||||||
|
|
||||||
### 烧写工具
|
For tools needed for CDK development, please refer to [CDK Development Guide](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_cdk.html)
|
||||||
|
|
||||||
除了可以使用 CK-link、J-link 以及命令行烧写以外，还支持图形化的烧写工具。
|
- [CDK](https://occ.t-head.cn/development/activities/cdk), CDK integrated development environment of Pingtou Gejianchi, it is recommended to use CDK v2.8.4 or above
|
||||||
博流提供的图形化烧写工具：
|
|
||||||
|
### Burning tool
|
||||||
|
|
||||||
|
In addition to using CK-link, J-link and command line programming, it also supports graphical programming tools.
|
||||||
|
Graphical programming tools provided by Boliu:
|
||||||
|
|
||||||
- [Bouffalo Lab Dev Cube For Windows](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-win32.zip)
|
- [Bouffalo Lab Dev Cube For Windows](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-win32.zip)
|
||||||
- [Bouffalo Lab Dev Cube For Ubuntu](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-linux-x86.tar.gz)
|
- [Bouffalo Lab Dev Cube For Ubuntu](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-linux-x86.tar.gz)
|
||||||
|
|
||||||
## 论坛
|
## Forum
|
||||||
|
|
||||||
博流开发者交流论坛: [https://bbs.bouffalolab.com/](https://bbs.bouffalolab.com/)
|
Bouffalolab Developer Forum: [https://bbs.bouffalolab.com/](https://bbs.bouffalolab.com/)
|
||||||
|
|
||||||
# 许可协议
|
# License
|
||||||
|
|
||||||
**bl mcu sdk** 完全开源，遵循 Apache License 2.0 开源许可协议，可以免费在商业产品中使用，并且不需要公开私有代码。
|
**bl mcu sdk** is completely open source and follows the Apache License 2.0 open source license agreement. It can be used in commercial products for free and does not require public private code.
|
||||||
|
|
||||||
```
|
```
|
||||||
/*
|
/*
|
||||||
|
|
|
||||||
151
README_zh.md
Normal file
151
README_zh.md
Normal file
|
|
@ -0,0 +1,151 @@
|
||||||
|
|
||||||
|
|
||||||
|
[English Version](README_en.md)
|
||||||
|
|
||||||
|
# 简介
|
||||||
|
|
||||||
|
**bl mcu sdk** 是博流智能科技团队专为 BL602/BL604,BL702/BL704/BL706 以及未来其他系列芯片提供的 MCU 软件开发包。
|
||||||
|
|
||||||
|
## 代码框架
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
bl_mcu_sdk
|
||||||
|
├── bsp
|
||||||
|
│ ├── board
|
||||||
|
│ │ ├── bl706_avb
|
||||||
|
│ │ ├── bl706_iot
|
||||||
|
│ │ └── bl602_xxx
|
||||||
|
│ └── bsp_common
|
||||||
|
├── common
|
||||||
|
│ ├── device
|
||||||
|
│ ├── libc
|
||||||
|
│ ├── list
|
||||||
|
│ ├── memheap
|
||||||
|
│ ├── misc
|
||||||
|
│ ├── partition
|
||||||
|
│ ├── ring_buffer
|
||||||
|
│ └── soft_crc
|
||||||
|
├── components
|
||||||
|
│ ├── fatfs
|
||||||
|
│ ├── freertos
|
||||||
|
│ ├── shell
|
||||||
|
│ └── usb_stack
|
||||||
|
├── docs
|
||||||
|
│ ├── bl70x_docs
|
||||||
|
│ ├── development_guide
|
||||||
|
├── drivers
|
||||||
|
│ ├── bl602_driver
|
||||||
|
│ └── bl702_driver
|
||||||
|
├── examples
|
||||||
|
│ ├── adc
|
||||||
|
│ ├── audio
|
||||||
|
│ ├── camera
|
||||||
|
│ ├── coremark
|
||||||
|
│ ├── dac
|
||||||
|
│ ├── dhrystone
|
||||||
|
│ ├── dma
|
||||||
|
│ ├── gpio
|
||||||
|
│ ├── hellowd
|
||||||
|
│ ├── i2c
|
||||||
|
│ ├── i2s
|
||||||
|
│ ├── memheap
|
||||||
|
│ ├── spi
|
||||||
|
│ ├── uart
|
||||||
|
│ └── usb
|
||||||
|
├── out
|
||||||
|
└── tools
|
||||||
|
├── bflb_flash_tool
|
||||||
|
├── cdk_flashloader
|
||||||
|
├── cmake
|
||||||
|
└── openocd
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
- bsp/bsp_common : 存放一些板级相关的常用外设驱动代码
|
||||||
|
- bsp/board : 存放板级描述文件 `clock_config.h`(描述时钟配置文件) `pinmux_config.h`(描述io功能文件) `peripheral_config.h` (描述外设默认配置文件) 这几个文件共同形成 board 文件夹描述特定应用的所有硬件信息。
|
||||||
|
- common : 存放一些常见的与硬件无关的算法函数库
|
||||||
|
- components : 存放第三方库公共组件库
|
||||||
|
- drivers : 存放博流智能提供的公共芯片底层驱动库
|
||||||
|
- examples : 存放官方提供的示例代码
|
||||||
|
- out : 中间文件，用来存放编译链接后的产生的bin文件
|
||||||
|
- tools : 存放编译下载相关的工具包
|
||||||
|
- docs : 存放教程文档以及其他帮助信息
|
||||||
|
|
||||||
|
更多文件目录参考信息，请查阅 [bl mcu sdk 文档教程](http://bouffalolab.gitee.io/bl_mcu_sdk)
|
||||||
|
## 层次结构
|
||||||
|
|
||||||
|
[](https://imgtu.com/i/RpUVoj)
|
||||||
|
|
||||||
|
# 资源
|
||||||
|
|
||||||
|
## 硬件资源
|
||||||
|
|
||||||
|
- BL706 IOT 开发板
|
||||||
|
[](https://imgtu.com/i/RpUI0g)
|
||||||
|
|
||||||
|
- BL706 AVB 开发板
|
||||||
|
[](https://imgtu.com/i/Rpa7DO)
|
||||||
|
|
||||||
|
|
||||||
|
目前暂时没有提供官方的购买渠道，如果想获得上述开发板，可到任意开源社区留言申请。
|
||||||
|
## 芯片手册
|
||||||
|
|
||||||
|
[芯片参考手册](https://dev.bouffalolab.com/media/upload/doc/BL702_BL704_706_RM_zh_CN_1.1.pdf)|[芯片数据手册](https://dev.bouffalolab.com/media/upload/doc/BL702_BL704_BL706_DS_zh_CN_Combo_2.0.pdf)
|
||||||
|
|
||||||
|
更多资料请访问 BouffaloLab 开发者网站: [https://dev.bouffalolab.com/](https://dev.bouffalolab.com/)
|
||||||
|
|
||||||
|
## 文档教程
|
||||||
|
|
||||||
|
包含 bl mcu sdk 开发的快速入门教程， api 手册以及驱动框架等详细介绍
|
||||||
|
|
||||||
|
- [bl mcu sdk 文档教程](http://bouffalolab.gitee.io/bl_mcu_sdk)
|
||||||
|
|
||||||
|
## 视频教程
|
||||||
|
|
||||||
|
- [BL706 MCU 开发系列视频教程](https://www.bilibili.com/video/BV1xK4y1P7ur)
|
||||||
|
|
||||||
|
## 开发工具
|
||||||
|
|
||||||
|
### 命令行开发
|
||||||
|
|
||||||
|
命令行开发需要的工具，具体使用方法参考 [linux 开发指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Linux_quick_start_ubuntu.html)
|
||||||
|
|
||||||
|
- [cmake 3.19](https://cmake.org/files/v3.19/)， cmake 编译工具，建议使用 cmake v3.19 以上版本
|
||||||
|
|
||||||
|
### Eclipse开发
|
||||||
|
|
||||||
|
Eclipse 开发需要的工具，具体使用方法参考 [Eclipse 开发指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_eclipse.html)
|
||||||
|
|
||||||
|
- [Eclipse](https://dev.bouffalolab.com/media/upload/download/BouffaloLab_eclipse_x86_64_win.zip) Windows 下 eclipse 开发免安装包
|
||||||
|
- [J-Link v10](https://www.segger.com/downloads/jlink)， J-Link 调试器，用于在线调试芯片，建议使用 J-Link V10 以上版本硬件，软件驱动建议使用 V6.98 版本
|
||||||
|
|
||||||
|
### CDK开发
|
||||||
|
|
||||||
|
CDK 开发需要的工具，具体使用方法参考 [CDK 开发指南](http://bouffalolab.gitee.io/bl_mcu_sdk/get_started/Windows_quick_start_cdk.html)
|
||||||
|
|
||||||
|
- [CDK](https://occ.t-head.cn/development/activities/cdk)，平头哥剑池 CDK 集成开发环境，建议使用 CDK v2.8.4 以上版本
|
||||||
|
|
||||||
|
### 烧写工具
|
||||||
|
|
||||||
|
除了可以使用 CK-link、J-link 以及命令行烧写以外，还支持图形化的烧写工具。
|
||||||
|
博流提供的图形化烧写工具：
|
||||||
|
|
||||||
|
- [Bouffalo Lab Dev Cube For Windows](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-win32.zip)
|
||||||
|
- [Bouffalo Lab Dev Cube For Ubuntu](https://dev.bouffalolab.com/media/upload/download/BouffaloLabDevCube-1.5.3-linux-x86.tar.gz)
|
||||||
|
|
||||||
|
## 论坛
|
||||||
|
|
||||||
|
博流开发者交流论坛: [https://bbs.bouffalolab.com/](https://bbs.bouffalolab.com/)
|
||||||
|
|
||||||
|
# 许可协议
|
||||||
|
|
||||||
|
**bl mcu sdk** 完全开源，遵循 Apache License 2.0 开源许可协议，可以免费在商业产品中使用，并且不需要公开私有代码。
|
||||||
|
|
||||||
|
```
|
||||||
|
/*
|
||||||
|
* Copyright (c) 2021 Bouffalolab team
|
||||||
|
*
|
||||||
|
* SPDX-License-Identifier: Apache-2.0
|
||||||
|
*/
|
||||||
|
```
|
||||||
Loading…
Add table
Add a link
Reference in a new issue