Browse Source

add nrf52832 readme

supperthomas 4 years ago
parent
commit
84de81bed8
3 changed files with 84 additions and 10 deletions
  1. 5 6
      bsp/nrf5x/README.md
  2. 75 0
      bsp/nrf5x/nrf52832/README.md
  3. 4 4
      bsp/nrf5x/nrf52840/README.md

+ 5 - 6
bsp/nrf5x/README.md

@@ -31,13 +31,12 @@ Nordic nRF5x系列BSP 目前支持情况如下:
 ```
 nrf5x
 ├───docs 
-│   └───figures                     // 文档使用图片
+│   └───images                      // nrf5x文档使用图片
 │   └───nRF5x系列BSP制作教程.md
-├───libraries                       
+├───libraries                       // nrf5x系列支持BSP
 │   └───drivers                     // nRF5x 系列设备通用驱动文件 
 │   └───templates                   // 通用设备 BSP 工程模板
-│   │   └───nrf51x                  // nrf51x 系列 BSP 工程模板
-│   │   │   nrf52x                  // nrf52x 系列 BSP 工程模板
+│   │   └───nrf52x                  // nrf52x 系列 BSP 工程模板
 │   │   └───nrf5x_board_kconfig     // 通用 BSP 工程配置文件
 ├───nrf52832                        // nrf52832 BSP 工程
 │   └───application                 // 应用代码
@@ -47,7 +46,7 @@ nrf5x
 │   │   kconfig                     // 工程配置文件
 │   └───rtconfig.h
 ├───nrf52840                        // nrf52840 BSP 工程
-└───README.md                       
+└───README.md                       // nordic 工程整体介绍
 ```
 
 ###  如何使用
@@ -87,7 +86,7 @@ nrf5x
 ![image-20201017190301705](docs/images/softdevice_2.png)
 
 - 保存配置,然后`pkgs --update`, 执行`scons --target=mdk5`  
-- 打开keil 工程,softdevice的工程需要烧入官方的协议栈,所以先要烧入softdevice如果之前已经烧入SDK16.0的softdevice,可以不用执行这一步,点击softdevice工程,烧入即可
+- 打开keil 工程,softdevice的工程需要烧入官方的协议栈,所以先要烧入softdevice(如果之前已经烧入SDK16.0的softdevice,可以不用执行这一步),点击softdevice工程,烧入即可
 
 ![image-20201017192453525](docs/images/image-20201017192453525.png)
 

+ 75 - 0
bsp/nrf5x/nrf52832/README.md

@@ -0,0 +1,75 @@
+# nRF52832-PCA10040 BSP说明
+
+## 简介
+
+该文件夹主要存放所有主芯片为nRF52840的板级支持包。目前默认支持的开发板是官方[PCA10040](https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF52-DK)
+主要内容如下:
+
+- 开发板资源介绍
+- 进阶使用方法
+
+## 开发板介绍
+
+PCA10040-nRF52832是Nordic 官方的开发板,搭载nRF52832 芯片,基于ARM Cortex-M4内核,最高主频64 MHz,具有丰富的资源。
+
+开发板外观如下图所示
+
+![](../docs/images/nrf52832.jpg)
+
+PCA10040-nrf52832开发板常用 **板载资源** 如下:
+
+- MCU:NRF52832,主频 64MHz,512kB FLASH ,64kB RAM
+- MCU 外设: GPIO, UART, SPI, I2C(TWI), RTC,TIMER,NFC,PWM,ADC
+- 板载设
+  - LED:4个 。
+  - 按键:5个,4个USER and 1个RESET 。
+- 常用接口:Arduino Uno 接口
+- 调试接口:板载 J-LINK 调试器。
+
+开发板更多详细信息请参考NORDIC官方[PCA10040](https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF52-DK)
+
+
+
+## 外设支持
+
+本 BSP 目前对外设的支持情况如下:
+
+| **片上外设** | **支持情况** | **备注** |
+| :----------- | :----------: | :------: |
+| GPIO         |     支持     |  GPION   |
+| UART         |     支持     |  UART0   |
+| PWM          |     支持     |   支持   |
+| SPI          |     支持     |   支持   |
+| RTC          |     支持     |          |
+| ADC          |     支持     |          |
+|              |              |          |
+|              |              |          |
+|              |              |          |
+
+
+
+### 进阶使用
+
+此 BSP 默认只开启了 GPIO 和 串口 0 的功能,更多高级功能需要利用 env 工具对 BSP 进行配置,步骤如下:
+
+1. 在 bsp 下打开 env 工具。
+
+2. 输入`menuconfig`命令配置工程,配置好之后保存退出。
+
+3. 输入`pkgs --update`命令更新软件包。
+
+4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
+
+
+
+## 支持其他开发板
+
+客户可以将自己的开发板的.config文件和board/Kconfig文件到board/$(board_name)下面添加README.md即可
+
+## 注意事项
+
+## 联系人信息
+
+维护人:
+
+-  

+ 4 - 4
bsp/nrf5x/nrf52840/README.md

@@ -2,15 +2,15 @@
 
 ## 简介
 
-该文件夹主要存放所有主芯片为nRF52840的板级支持包。目前默认支持的开发板是方[PCA10056](https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF52840-DK)
-主要内容如下:
+该文件夹主要存放所有主芯片为nRF52840的板级支持包。目前默认支持的开发板是方[PCA10056](https://www.nordicsemi.com/Software-and-tools/Development-Kits/nRF52840-DK)
+本文主要内容如下:
 
 - 开发板资源介绍
 - 进阶使用方法
 
 ## 开发板介绍
 
-PCA10056-nRF52840是Nordic 官方的开发板,搭载nRF52840 芯片,基于ARM Cortex-M4内核,最高主频64 MHz,具有丰富的资源。
+PCA10056-nRF52840是Nordic 官方的开发板,搭载nRF52840 芯片,基于ARM Cortex-M4内核,最高主频64 MHz,具有丰富的外设资源。
 
 开发板外观如下图所示
 
@@ -66,7 +66,7 @@ PCA10056-nrf52840 开发板常用 **板载资源** 如下:
 
 ## 支持其他开发板
 
-客户可以将自己的开发板的.config文件和board/Kconfig文件到board/$(board_name)下面添加README.md即可
+客户可以将自己的开发板的.config文件和board/Kconfig文件到board/$(board_name)下面添加README.md即可,使用的时候替换.config文件
 
 ## 注意事项