summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author褚仕成 <[email protected]>2023-02-06 09:13:29 +0800
committerMan, Jianting (Meco) <[email protected]>2023-02-05 22:03:27 -0500
commit60199160cfcccd4a689c7b85f41d7c179f8d7b13 (patch)
tree9fcd3ef42a2671508eea4f94739b12214edd3963
parent98e0c58527664ae645920729663f0bead1b3dc3f (diff)
[bsp][lpc55sxx] add: README_zh and README
-rw-r--r--bsp/lpc55sxx/lpc55s69_nxp_evk/README.md120
-rw-r--r--bsp/lpc55sxx/lpc55s69_nxp_evk/README_zh.md176
2 files changed, 235 insertions, 61 deletions
diff --git a/bsp/lpc55sxx/lpc55s69_nxp_evk/README.md b/bsp/lpc55sxx/lpc55s69_nxp_evk/README.md
index 2305a35405..57981c6950 100644
--- a/bsp/lpc55sxx/lpc55s69_nxp_evk/README.md
+++ b/bsp/lpc55sxx/lpc55s69_nxp_evk/README.md
@@ -1,43 +1,43 @@
-# LPC55S69-EVK 板级支持包
+# LPC55S69-EVK BSP Introduction
-## 1. 简介(Introduction)
+**English** | [中文](README_zh.md)
-LPC55S69 是由恩智浦NXP半导体推出的基于Cortex-M33内核的高性能单片机
-包括如下硬件特性:
+## 1. Introduction
-| 硬件 | 描述 |
+The LPC55S69 is a high-performance microcontroller based on the Cortex-M33 core from NXP Semiconductors.
+Includes the following hardware features:
+
+| HARDWARE | DESCRIPTION |
| -- | -- |
-|芯片型号| LPC556x/LPC55S6x 全系列 |
+|Chip model| LPC556x/LPC55S6x Full range |
|CPU| Cortex-M33 Dual Core, with FPU |
-|主频| 150MHz |
-|基本外设| 8个Flexcomm(任意配置为USART/SPI/I2C/I2S) / 1个50MHz SPI / 双USB(1高1全,支持主从) |
-|特色| PowerQuad DSP协处理器 / 安全外设:PRINCE/PUF/CASPER/AES-256/HASH |
-
-## 2. 硬件开发环境(Hardware development system)
+|Frequency| 150MHz |
+|Basic peripherals| 8 x Flexcomm (optionally configured as USART/SPI/I2C/I2S) / 1 x 50MHz SPI / Dual USB (1 H and 1 Full, Master-Slave Support) |
+|Characteristic| PowerQuad DSP coprocessor/security peripheral: PRINCE/PUF/CASPER/AES-256/HASH |
-开发板(EVK)
+## 2. Hardware development system
-![开发板示意图](./figures/board.png)
+![Schematic diagram of the development board](./figures/board.png)
-## 3. 编译说明
+## 3. Quickly Get Started
-| 环境 | 说明 |
-| ------------ | ------------------------------------------------------------ |
-| PC操作系统 | Linux/MacOS/Windows |
-| 编译器 | arm-none-eabi-gcc version 6.3.1 20170620 (release)/armcc/iar |
-| 构建工具 | scons/mdk5/iar |
-| 依赖软件环境 | Env工具/(MDK或IAR或arm-none-eabi-gcc)/git/调试器驱动 |
+| ENVIRONMENT | DESCRIPTION |
+| ------------------- | ------------------------------------------------------------ |
+| PC Operating System | Linux/MacOS/Windows |
+| Compiler | arm-none-eabi-gcc version 6.3.1 20170620 (release)/armcc/iar |
+| Build tools | scons/mdk5/iar |
+| Depends | Env tool/(MDK or IAR or arm-none-eabi-gcc)/git/debugger driver |
-1) 下载源码
+1) Download the source code
```bash
git clone https://github.com/RT-Thread/rt-thread.git
```
-2) 配置工程并准备env
+2) Configure the project and prepare the ENV
(Linux/Mac)
@@ -50,9 +50,9 @@ LPC55S69 是由恩智浦NXP半导体推出的基于Cortex-M33内核的高性能�
(Windows)
->在[RT-Thread官网][1]下载ENV工具包
+>Download the ENV toolkit [RT-Thread][1]
-3) 配置芯片型号
+3) Configure the chip model
(Linux/Mac)
@@ -60,15 +60,15 @@ LPC55S69 是由恩智浦NXP半导体推出的基于Cortex-M33内核的高性能�
scons --menuconfig
```
-(Windows(ENV环境中))
+(Windows(use ENV))
```bash
menuconfig
```
-在menuconfig页面配置并选择对应的芯片型号,若开发环境为MDK/IAR,则需要生成工程
+On the menuconfig page, configure and select the corresponding chip model, if the development environment is MDK/IAR, you need to generate the project.
-4) 生成工程(Mac/Linux下请跳过此步骤)
+4) Build Project (please skip this step under Mac/Linux)
(Windows IAR)
@@ -83,39 +83,39 @@ LPC55S69 是由恩智浦NXP半导体推出的基于Cortex-M33内核的高性能�
scons --target=mdk5 -s
```
-*该板级支持包不支持生成mdk4的工程
+*This board support package does not support projects that generate MDK4
-**MDK 与 IAR 在生成完成工程之后一定要在工程中手动选择一次芯片信号,否则会产生严重编译错误**
+**MDK and IAR must manually select the chip signal once in the project after the project is built, otherwise a serious compilation error will be generated.**
-5) 编译
+5) Compile
-使用MDK或IAR请参见对应教程
+To use the MDK or IAR, see the corresponding tutorial
(Windows arm-none-eabi-gcc)
-使用以下指令设置gcc路径
+Use the following command to set the GCC path
```bash
- SET RTT_EXEC_PATH=[GCC路径]
+ SET RTT_EXEC_PATH=[GCC path]
```
(Linux/Mac arm-none-eabi-gcc)
-使用以下指令设置gcc路径
+Use the following command to set the GCC path
```bash
- export RTT_EXEC_PATH=[GCC路径]
+ export RTT_EXEC_PATH=[GCC path]
```
-编译(WindowsLinux/Mac arm-none-eabi-gcc)
+Compile(WindowsLinux/Mac arm-none-eabi-gcc)
```bash
scons -j4
```
-或者通过 `scons --exec-path="GCC工具链路径"` 命令,在指定工具链位置的同时直接编译。
+Or use the `scons --exec-path="GCC toolchain path"`command to compile directly while specifying the toolchain location.
-出现下列信息即为编译成功
+The following message indicates that the compilation was successful
```bash
LINK rtthread-lpc55s69.elf
@@ -127,15 +127,15 @@ LPC55S69 是由恩智浦NXP半导体推出的基于Cortex-M33内核的高性能�
```
-如果编译正确无误,会产生rtthread-lpc55s6x.elf、rtthread.bin文件。其中rtthread.bin为二进制固件
+If compiled correctly, the rtthread-lpc55s6x.elf, rtthread.bin file will be generated. where rtthread .bin binary firmware
-## 3. 烧写及执行
+## 3. Download and Execution
-烧写可以使用仿真器 ISP等多种方式 此处不再赘述
+Programming can use emulators, ISPs, and other ways to repeat them here.
-### 3.1 运行结果
+### 3.1 Running Results
-如果编译 & 烧写无误,会在Flexcomm0串口*上看到RT-Thread的启动logo信息:
+If the compilation & programming is correct, you will see the RT-Thread startup logo information on the Flexcomm0 serial port*:
```bash
\ | /
@@ -146,29 +146,27 @@ uising armclang, version: 6120001
msh />
```
-*默认串口
+*Default serial port
-## 4. 驱动支持情况及计划
+## 4. Peripheral Condition
-| 驱动 | 支持情况 | 备注 |
+| **On-board Peripherals** | **Support** | **Remark** |
| ---------- | :------: | :--------------------------: |
-| UART | 支持 | UART0/2 |
-| GPIO | 支持 | 自动根据芯片型号选择引脚布局 |
-| SPI | 支持 | 支持High Speed SPI |
-| USB Device | 不支持 | 暂不支持 |
-| USB Host | 不支持 | 暂不支持 |
-| Windowed WatchDog | 不支持 | 支持 |
-| ADC | 不支持 | 暂不支持 |
-| I2C | 支持 | 可配合MMA8562 |
-| I2C Sensor | 支持 | 获取板上MMA8562加速度传感器数据 |
-| RTC | 支持 | RTC时钟自动配置 |
-| SDIO | 支持 | 操作SD卡 |
-| I2S | 不支持 | 暂不支持 |
-
-## 6. 联系人信息
+| UART | yes | UART0/2 |
+| GPIO | yes | Automatically selects the pinout based on the chip model |
+| SPI | yes | Support High Speed SPI |
+| USB Device | no | |
+| USB Host | no | |
+| Windowed WatchDog | no | |
+| ADC | no | |
+| I2C | yes | Can be used with MMA8562 |
+| I2C Sensor | yes | Acquire onboard MMA8562 accelerometer data |
+| RTC | yes | RTC clock auto-configuration |
+| SDIO | yes | Operate the SD card |
+| I2S | no | |
-维护人:
+## 6. Maintained By
diff --git a/bsp/lpc55sxx/lpc55s69_nxp_evk/README_zh.md b/bsp/lpc55sxx/lpc55s69_nxp_evk/README_zh.md
new file mode 100644
index 0000000000..2b7efc0939
--- /dev/null
+++ b/bsp/lpc55sxx/lpc55s69_nxp_evk/README_zh.md
@@ -0,0 +1,176 @@
+# LPC55S69-EVK 板级支持包
+
+**[English](README.md)** | 中文
+
+## 1. 简介(Introduction)
+
+LPC55S69 是由恩智浦NXP半导体推出的基于Cortex-M33内核的高性能单片机
+包括如下硬件特性:
+
+| 硬件 | 描述 |
+| -- | -- |
+|芯片型号| LPC556x/LPC55S6x 全系列 |
+|CPU| Cortex-M33 Dual Core, with FPU |
+|主频| 150MHz |
+|基本外设| 8个Flexcomm(任意配置为USART/SPI/I2C/I2S) / 1个50MHz SPI / 双USB(1高1全,支持主从) |
+|特色| PowerQuad DSP协处理器 / 安全外设:PRINCE/PUF/CASPER/AES-256/HASH |
+
+## 2. 硬件开发环境(Hardware development system)
+
+开发板(EVK)
+
+![开发板示意图](./figures/board.png)
+
+
+
+## 3. 编译说明
+
+
+| 环境 | 说明 |
+| ------------ | ------------------------------------------------------------ |
+| PC操作系统 | Linux/MacOS/Windows |
+| 编译器 | arm-none-eabi-gcc version 6.3.1 20170620 (release)/armcc/iar |
+| 构建工具 | scons/mdk5/iar |
+| 依赖软件环境 | Env工具/(MDK或IAR或arm-none-eabi-gcc)/git/调试器驱动 |
+
+1) 下载源码
+
+```bash
+ git clone https://github.com/RT-Thread/rt-thread.git
+```
+
+2) 配置工程并准备env
+
+(Linux/Mac)
+
+```bash
+ cd rt-thread/bsp/lpc55s69_evk
+ scons --menuconfig
+ source ~/.env/env.sh
+ pkgs --upgrade
+```
+
+(Windows)
+
+>在[RT-Thread官网][1]下载ENV工具包
+
+3) 配置芯片型号
+
+(Linux/Mac)
+
+```bash
+ scons --menuconfig
+```
+
+(Windows(ENV环境中))
+
+```bash
+ menuconfig
+```
+
+在menuconfig页面配置并选择对应的芯片型号,若开发环境为MDK/IAR,则需要生成工程
+
+4) 生成工程(Mac/Linux下请跳过此步骤)
+
+(Windows IAR)
+
+```bash
+ SET RTT_CC=iar
+ scons --target=iar -s
+```
+
+(Windows MDK5)*
+
+```bash
+ scons --target=mdk5 -s
+```
+
+*该板级支持包不支持生成mdk4的工程
+
+**MDK 与 IAR 在生成完成工程之后一定要在工程中手动选择一次芯片信号,否则会产生严重编译错误**
+
+
+
+5) 编译
+
+使用MDK或IAR请参见对应教程
+
+(Windows arm-none-eabi-gcc)
+使用以下指令设置gcc路径
+
+```bash
+ SET RTT_EXEC_PATH=[GCC路径]
+```
+
+(Linux/Mac arm-none-eabi-gcc)
+使用以下指令设置gcc路径
+
+```bash
+ export RTT_EXEC_PATH=[GCC路径]
+```
+
+编译(WindowsLinux/Mac arm-none-eabi-gcc)
+
+```bash
+ scons -j4
+```
+
+或者通过 `scons --exec-path="GCC工具链路径"` 命令,在指定工具链位置的同时直接编译。
+
+出现下列信息即为编译成功
+
+```bash
+ LINK rtthread-lpc55s69.elf
+ arm-none-eabi-objcopy -O binary rtthread-lpc55s6x.elf rtthread.bin
+ arm-none-eabi-size rtthread-lpc55s69.elf
+ text data bss dec hex filename
+ 41596 356 1456 43408 a990 rtthread-lpc55s6x.elf
+ scons: done building targets.
+```
+
+
+如果编译正确无误,会产生rtthread-lpc55s6x.elf、rtthread.bin文件。其中rtthread.bin为二进制固件
+
+## 3. 烧写及执行
+
+烧写可以使用仿真器 ISP等多种方式 此处不再赘述
+
+### 3.1 运行结果
+
+如果编译 & 烧写无误,会在Flexcomm0串口*上看到RT-Thread的启动logo信息:
+
+```bash
+ \ | /
+- RT - Thread Operating System
+ / | \ 4.0.1 build Jul 30 2019
+ 2006 - 2019 Copyright by rt-thread team
+uising armclang, version: 6120001
+msh />
+```
+
+*默认串口
+
+
+## 4. 驱动支持情况及计划
+
+| 驱动 | 支持情况 | 备注 |
+| ---------- | :------: | :--------------------------: |
+| UART | 支持 | UART0/2 |
+| GPIO | 支持 | 自动根据芯片型号选择引脚布局 |
+| SPI | 支持 | 支持High Speed SPI |
+| USB Device | 不支持 | 暂不支持 |
+| USB Host | 不支持 | 暂不支持 |
+| Windowed WatchDog | 不支持 | 支持 |
+| ADC | 不支持 | 暂不支持 |
+| I2C | 支持 | 可配合MMA8562 |
+| I2C Sensor | 支持 | 获取板上MMA8562加速度传感器数据 |
+| RTC | 支持 | RTC时钟自动配置 |
+| SDIO | 支持 | 操作SD卡 |
+| I2S | 不支持 | 暂不支持 |
+
+## 6. 联系人信息
+
+维护人:
+