Browse Source

【English Readme】[stm32f413 nucleo] add English version readme

mysterywolf 4 years ago
parent
commit
bc2ed1fc81
2 changed files with 210 additions and 122 deletions
  1. 88 122
      bsp/stm32/stm32f413-st-nucleo/README.md
  2. 122 0
      bsp/stm32/stm32f413-st-nucleo/README_zh.md

+ 88 - 122
bsp/stm32/stm32f413-st-nucleo/README.md

@@ -1,122 +1,88 @@
-# NUCLEO-F413ZH 开发板 BSP 说明
-
-## 简介
-
-本文档为 RT-Thread 开发团队为 NUCLEO-F413ZH 开发板的 BSP (板级支持包) 说明。
-
-主要内容如下:
-
-- 开发板资源介绍
-- BSP 快速上手
-- 进阶使用方法
-
-通过阅读快速上手章节开发者可以快速地上手该 BSP,将 RT-Thread 运行在开发板上。在进阶使用指南章节,将会介绍更多高级功能,帮助开发者利用 RT-Thread 驱动更多板载资源。
-
-## 开发板介绍
-
-探索者 NUCLEO-F413ZH 是意法半导体推出的一款基于 ARM Cortex-M4 内核的开发板,最高主频为 100Mhz,该开发板具有丰富的板载资源,可以充分发挥 NUCLEO-F413ZH 的芯片性能。
-
-开发板外观如下图所示:
-
-![board](figures/board.png)
-
-该开发板常用 **板载资源** 如下:
-
-- MCU:STM32F413ZH,主频 100MHz,1536KB FLASH ,320KB RAM
-- 常用外设
-  - LED:8个,user LED (JP5跳帽需连接)(黄色,PB0,LD1;蓝色,PB7,LD2;红色,PB14,LD3), USB communication (LD4), over current (LD5), power LED (黄色,LD6), USB FAULT (LD7), VBUS (LD8)。
-  - 按键:2个,B1(USER,PC13),B2(RESET)
-- 常用接口:USB 支持 3 种不同接口:虚拟 COM 端口、大容量存储和调试端口等。
-- 调试接口,板载 ST-LINK/V2-1 调试器。
-
-开发板更多详细信息请参考意法半导体 [NUCLEO-F413ZH 开发板介绍](https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-mpu-eval-tools/stm32-mcu-mpu-eval-tools/stm32-nucleo-boards/nucleo-f413zh.html)。
-
-## 外设支持
-
-本 BSP 目前对外设的支持情况如下:
-
-| **板载外设** | **支持情况** | **备注**                              |
-| :------------ | :----------: | :-----------------------------------: |
-|STLINK TO USART|     支持    |                  UART3                 |
-
-| **片上外设** | **支持情况** |               **备注**                |
-| :------------ | :----------: | :-----------------------------------: |
-| GPIO         |     支持     |                                        |
-| UART         |     支持     |              UART2/3                   |
-| SPI          |     支持     |              SPI2                      |
-| I2C          |     支持     |              I2C1(软件模拟)            |
-| TIMER        |     支持     |              TIM11/13/14               |
-| PWM          |     支持     |              PWM2_CH4                  |
-| ADC          |     支持     |              ADC1_IN5                  |
-| RTC          |     支持     |     支持外部晶振和内部低速时钟         |
-| WDT          |     支持     |             独立看门狗                 |
-| Onchip Flash |     支持     |             片上Flash                  |
-| USB OTG_FS   |     支持     |         OTGFS as USB device            |
-| Onchip Flash |     支持     |             片上Flash                  |
-| USB Device   |     支持     |         OTGFS as USB device            |
-| RNG          |     支持     |       Random Number Generator          |
-| UDID         |     支持     |     Unique Device Identifier           |
-
-## 使用说明
-
-使用说明分为如下两个章节:
-
-- 快速上手
-
-    本章节是为刚接触 RT-Thread 的新手准备的使用说明,遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上,看到实验效果 。
-
-- 进阶使用
-
-    本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置,可以开启更多板载资源,实现更多高级功能。
-
-
-### 快速上手
-
-本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程,并且支持 GCC 开发环境。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。
-
-#### 硬件连接
-
-使用 Type-A to Micro-B 线连接开发板和 PC 供电,黄色 LED LD6 (PWR) 和 LD4 (COM) 会点亮。
-
-#### 编译下载
-
-双击 project.uvprojx 文件,打开 MDK5 工程,编译并下载程序到开发板。
-
-> 工程默认配置使用 板载ST-LINK 仿真器下载程序,在通过 Micro USB线 连接开发板的基础上,点击下载按钮即可下载程序到开发板
-
-#### 运行结果
-
-下载程序成功之后,系统会自动运行,在JP5跳帽连接时,观察开发板上LD1的运行效果,黄色LED会周期性闪烁。
-
-连接开发板对应串口到 PC , 在终端工具里打开相应的串口(115200-8-1-N),复位设备后,可以看到 RT-Thread 的输出信息:
-
-```bash
- \ | /
-- RT -     Thread Operating System
- / | \     4.0.3 build Apr 28 2020
- 2006 - 2020 Copyright by rt-thread team
-msh >
-```
-### 进阶使用
-
-此 BSP 默认只开启了 GPIO 和 UART3 的功能,更多高级功能需要利用 ENV 工具对 BSP 进行配置,步骤如下:
-
-1. 在 bsp 下打开 env 工具。
-
-2. 输入`menuconfig`命令配置工程,配置好之后保存退出。
-
-3. 输入`pkgs --update`命令更新软件包。
-
-4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
-
-本章节更多详细的介绍请参考 [STM32 系列 BSP 外设驱动使用教程](../docs/STM32系列BSP外设驱动使用教程.md)。
-
-## 注意事项
-
-暂无
-
-## 联系人信息
-
-维护人:
-
-- [flybreak](https://github.com/XYX12306) ,邮箱:<2669599387@qq.com>
+# STM32F413-Nucleo BSP Introduction
+
+[中文](README_zh.md) 
+
+## MCU: STM32F413ZH @100MHz, 1.5 MB FLASH,  320KB RAM
+
+The STM32F413xG/H devices are based on the high-performance Arm® Cortex®-M4 32-bit RISC core operating at a frequency of up to 100 MHz. Their Cortex®-M4 core features a Floating point unit (FPU) single precision which supports all Arm single-precision data-processing instructions and data types. It also implements a full set of DSP instructions and a memory protection unit (MPU) which enhances application security.
+
+The STM32F413xG/H devices belong to the STM32F4 access product lines (with products combining power efficiency, performance and integration) while adding a new innovative feature called Batch Acquisition Mode (BAM) allowing to save even more power consumption during data batching.
+The STM32F413xG/H devices incorporate high-speed embedded memories (up to 1.5 Mbytes of Flash memory, 320 Kbytes of SRAM), and an extensive range of enhanced I/Os and peripherals connected to two APB buses, three AHB buses and a 32-bit multi-AHB bus matrix.
+All devices offer a 12-bit ADC, two 12-bit DACs, a low-power RTC, twelve general-purpose 16-bit timers including two PWM timer for motor control, two general-purpose 32-bit timers and a low power timer.
+They also feature standard and advanced communication interfaces.
+
+#### KEY FEATURES
+
+- Dynamic Efficiency Line with eBAM (enhanced Batch Acquisition Mode)
+  - 1.7 V to 3.6 V power supply
+  - -40 °C to 85/105/125 °C temperature range
+- Core: Arm® 32-bit Cortex®-M4 CPU with FPU, Adaptive real-time accelerator (ART Accelerator™) allowing 0-wait state execution from Flash memory, frequency up to 100 MHz, memory protection unit, 125 DMIPS/ 1.25 DMIPS/MHz (Dhrystone 2.1), and DSP instructions
+- Memories
+  - Up to 1.5 Mbytes of Flash memory
+  - 320 Kbytes of SRAM
+  - Flexible external static memory controller with up to 16-bit data bus: SRAM, PSRAM, NOR Flash memory
+  - Dual mode Quad-SPI interface
+- LCD parallel interface, 8080/6800 modes
+- Clock, reset and supply management
+  - 1.7 to 3.6 V application supply and I/Os
+  - POR, PDR, PVD and BOR
+  - 4-to-26 MHz crystal oscillator
+  - Internal 16 MHz factory-trimmed RC
+  - 32 kHz oscillator for RTC with calibration
+  - Internal 32 kHz RC with calibration
+- Power consumption
+  - Run: 112 μA/MHz (peripheral off)
+  - Stop (Flash in Stop mode, fast wakeup time): 42 μA Typ.; 80 μA max @25 °C
+  - Stop (Flash in Deep power down mode, slow wakeup time): 15 μA Typ.; 46 μA max @25 °C
+  - Standby without RTC: 1.1 μA Typ.; 14.7 μA max at @85 °C
+  - VBAT supply for RTC: 1 μA @25 °C
+- 2x12-bit D/A converters
+- 1×12-bit, 2.4 MSPS ADC: up to 16 channels
+- 6x digital filters for sigma delta modulator, 12x PDM interfaces, with stereo microphone and sound source localization support
+- General-purpose DMA: 16-stream DMA
+
+- Up to 18 timers: up to twelve 16-bit timers, two 32-bit timers up to 100 MHz each with up to four IC/OC/PWM or pulse counter and quadrature (incremental) encoder input, two watchdog timers (independent and window), one SysTick timer, and a low-power timer
+- Debug mode
+  - Serial wire debug (SWD) & JTAG
+  - Cortex®-M4 Embedded Trace Macrocell™
+- Up to 114 I/O ports with interrupt capability
+  - Up to 109 fast I/Os up to 100 MHz
+  - Up to 114 five V-tolerant I/Os
+- Up to 24 communication interfaces
+  - Up to 4x I2C interfaces (SMBus/PMBus)
+  - Up to 10 UARTS: 4 USARTs / 6 UARTs (2 x 12.5 Mbit/s, 2 x 6.25 Mbit/s), ISO 7816 interface, LIN, IrDA, modem control)
+  - Up to 5 SPI/I2Ss (up to 50 Mbit/s, SPI or I2S audio protocol), out of which 2 muxed full-duplex I2S interfaces
+  - SDIO interface (SD/MMC/eMMC)
+  - Advanced connectivity: USB 2.0 full-speed device/host/OTG controller with PHY
+  - 3x CAN (2.0B Active)
+  - 1xSAI
+- True random number generator
+- CRC calculation unit
+- 96-bit unique ID
+- RTC: subsecond accuracy, hardware calendar
+- All packages are ECOPACK®2
+
+
+
+## Read more
+
+|                          Documents                           |                         Description                          |
+| :----------------------------------------------------------: | :----------------------------------------------------------: |
+| [STM32_Nucleo-144_BSP_Introduction](../docs/STM32_Nucleo-144_BSP_Introduction.md) | How to run RT-Thread on STM32 Nucleo-144 boards (**Must-Read**) |
+| [STM32F413ZH ST Official Website](https://www.st.com/zh/microcontrollers-microprocessors/stm32f413zh.html#documentation) |          STM32F413ZH datasheet and other resources           |
+
+
+
+## Maintained By
+
+[flybreak](https://github.com/guozhanxin)  g1171407708@163.com
+
+
+
+## Translated By
+
+Meco Man @ RT-Thread Community
+
+> jiantingman@foxmail.com 
+>
+> https://github.com/mysterywolf

+ 122 - 0
bsp/stm32/stm32f413-st-nucleo/README_zh.md

@@ -0,0 +1,122 @@
+# NUCLEO-F413ZH 开发板 BSP 说明
+
+## 简介
+
+本文档为 RT-Thread 开发团队为 NUCLEO-F413ZH 开发板的 BSP (板级支持包) 说明。
+
+主要内容如下:
+
+- 开发板资源介绍
+- BSP 快速上手
+- 进阶使用方法
+
+通过阅读快速上手章节开发者可以快速地上手该 BSP,将 RT-Thread 运行在开发板上。在进阶使用指南章节,将会介绍更多高级功能,帮助开发者利用 RT-Thread 驱动更多板载资源。
+
+## 开发板介绍
+
+探索者 NUCLEO-F413ZH 是意法半导体推出的一款基于 ARM Cortex-M4 内核的开发板,最高主频为 100Mhz,该开发板具有丰富的板载资源,可以充分发挥 NUCLEO-F413ZH 的芯片性能。
+
+开发板外观如下图所示:
+
+![board](figures/board.png)
+
+该开发板常用 **板载资源** 如下:
+
+- MCU:STM32F413ZH,主频 100MHz,1536KB FLASH ,320KB RAM
+- 常用外设
+  - LED:8个,user LED (JP5跳帽需连接)(黄色,PB0,LD1;蓝色,PB7,LD2;红色,PB14,LD3), USB communication (LD4), over current (LD5), power LED (黄色,LD6), USB FAULT (LD7), VBUS (LD8)。
+  - 按键:2个,B1(USER,PC13),B2(RESET)
+- 常用接口:USB 支持 3 种不同接口:虚拟 COM 端口、大容量存储和调试端口等。
+- 调试接口,板载 ST-LINK/V2-1 调试器。
+
+开发板更多详细信息请参考意法半导体 [NUCLEO-F413ZH 开发板介绍](https://www.st.com/content/st_com/en/products/evaluation-tools/product-evaluation-tools/mcu-mpu-eval-tools/stm32-mcu-mpu-eval-tools/stm32-nucleo-boards/nucleo-f413zh.html)。
+
+## 外设支持
+
+本 BSP 目前对外设的支持情况如下:
+
+| **板载外设** | **支持情况** | **备注**                              |
+| :------------ | :----------: | :-----------------------------------: |
+|STLINK TO USART|     支持    |                  UART3                 |
+
+| **片上外设** | **支持情况** |               **备注**                |
+| :------------ | :----------: | :-----------------------------------: |
+| GPIO         |     支持     |                                        |
+| UART         |     支持     |              UART2/3                   |
+| SPI          |     支持     |              SPI2                      |
+| I2C          |     支持     |              I2C1(软件模拟)            |
+| TIMER        |     支持     |              TIM11/13/14               |
+| PWM          |     支持     |              PWM2_CH4                  |
+| ADC          |     支持     |              ADC1_IN5                  |
+| RTC          |     支持     |     支持外部晶振和内部低速时钟         |
+| WDT          |     支持     |             独立看门狗                 |
+| Onchip Flash |     支持     |             片上Flash                  |
+| USB OTG_FS   |     支持     |         OTGFS as USB device            |
+| Onchip Flash |     支持     |             片上Flash                  |
+| USB Device   |     支持     |         OTGFS as USB device            |
+| RNG          |     支持     |       Random Number Generator          |
+| UDID         |     支持     |     Unique Device Identifier           |
+
+## 使用说明
+
+使用说明分为如下两个章节:
+
+- 快速上手
+
+    本章节是为刚接触 RT-Thread 的新手准备的使用说明,遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上,看到实验效果 。
+
+- 进阶使用
+
+    本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置,可以开启更多板载资源,实现更多高级功能。
+
+
+### 快速上手
+
+本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程,并且支持 GCC 开发环境。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。
+
+#### 硬件连接
+
+使用 Type-A to Micro-B 线连接开发板和 PC 供电,黄色 LED LD6 (PWR) 和 LD4 (COM) 会点亮。
+
+#### 编译下载
+
+双击 project.uvprojx 文件,打开 MDK5 工程,编译并下载程序到开发板。
+
+> 工程默认配置使用 板载ST-LINK 仿真器下载程序,在通过 Micro USB线 连接开发板的基础上,点击下载按钮即可下载程序到开发板
+
+#### 运行结果
+
+下载程序成功之后,系统会自动运行,在JP5跳帽连接时,观察开发板上LD1的运行效果,黄色LED会周期性闪烁。
+
+连接开发板对应串口到 PC , 在终端工具里打开相应的串口(115200-8-1-N),复位设备后,可以看到 RT-Thread 的输出信息:
+
+```bash
+ \ | /
+- RT -     Thread Operating System
+ / | \     4.0.3 build Apr 28 2020
+ 2006 - 2020 Copyright by rt-thread team
+msh >
+```
+### 进阶使用
+
+此 BSP 默认只开启了 GPIO 和 UART3 的功能,更多高级功能需要利用 ENV 工具对 BSP 进行配置,步骤如下:
+
+1. 在 bsp 下打开 env 工具。
+
+2. 输入`menuconfig`命令配置工程,配置好之后保存退出。
+
+3. 输入`pkgs --update`命令更新软件包。
+
+4. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
+
+本章节更多详细的介绍请参考 [STM32 系列 BSP 外设驱动使用教程](../docs/STM32系列BSP外设驱动使用教程.md)。
+
+## 注意事项
+
+暂无
+
+## 联系人信息
+
+维护人:
+
+- [flybreak](https://github.com/XYX12306) ,邮箱:<2669599387@qq.com>