README.md
1# STM32F103 ATK-NANO 开发板 BSP 说明
2
3## 简介
4
5本文档为 RT-Thread 开发团队为 STM32F103 ATK-NANO 开发板提供的 BSP (板级支持包) 说明。
6
7主要内容如下：
8
9- 开发板资源介绍
10- BSP 快速上手
11- 进阶使用方法
12
13通过阅读快速上手章节开发者可以快速地上手该 BSP，将 RT-Thread 运行在开发板上。在进阶使用指南章节，将会介绍更多高级功能，帮助开发者利用 RT-Thread 驱动更多板载资源。
14
15## 开发板介绍
16
17ATK-NANO STM32F103 是正点原子推出的一款基于 ARM Cortex-M3 内核的开发板，最高主频为 72Mhz，该开发板具有丰富的板载资源，可以充分发挥 STM32F103 的芯片性能。
18
19开发板外观如下图所示：
20
21
22
23该开发板常用 **板载资源** 如下：
24
25- MCU：STM32F103RBT6，主频 72MHz，128KB FLASH ，20KB RAM
26- 外部 FLASH：W25Q16（SPI，2MB）、EEPROM（24c02）
27- 常用外设
28 - LED：8个，（红色，PC0-PC7）
29 - 按键：4个，KEY_UP（兼具唤醒功能，PA0），KEY0（PC8），KEY1（PC9），KEY2（PD2）
30- 常用接口：USB 转串口、DS18B20/DHT11 接口 、USB SLAVE
31- 调试接口，板载的 ST-LINK SWD 下载
32
33开发板更多详细信息请参考正点原子 [STM32 ATK-NANO 开发板介绍](https://eboard.taobao.com/index.htm)。
34
35## 外设支持
36
37本 BSP 目前对外设的支持情况如下：
38
39| **板载外设** | **支持情况** | **备注** |
40| :----------------- | :----------: | :------------------------------------- |
41| USB 转串口 | 支持 | 使用 UART1 |
42| SPI Flash | 支持 | 使用 SPI1 |
43| 电位器 | 支持 | 使用 ADC1 |
44| **片上外设** | **支持情况** | **备注** |
45| GPIO | 支持 | PA0, PA1...PD2 ---> PIN: 0, 1...63 |
46| UART | 支持 | UART1/2/3 |
47| SPI | 支持 | SPI1/2 |
48| I2C | 支持 | 软件 I2C |
49| RTC | 支持 | 支持外部晶振和内部低速时钟 |
50| WDT | 支持 | |
51| ADC | 支持 | |
52| FLASH | 支持 | 已适配 [FAL](https://github.com/RT-Thread-packages/fal) |
53| **扩展模块** | **支持情况** | **备注** |
54| DS18B20/DHT11 | 暂不支持 | |
55
56
57## 使用说明
58
59使用说明分为如下两个章节：
60
61- 快速上手
62
63 本章节是为刚接触 RT-Thread 的新手准备的使用说明，遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上，看到实验效果 。
64
65- 进阶使用
66
67 本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置，可以开启更多板载资源，实现更多高级功能。
68
69
70### 快速上手
71
72本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程，并且支持 GCC 开发环境。下面以 MDK5 开发环境为例，介绍如何将系统运行起来。
73
74#### 硬件连接
75
76使用数据线连接开发板到 PC，打开电源开关。
77
78#### 编译下载
79
80双击 project.uvprojx 文件，打开 MDK5 工程，编译并下载程序到开发板。
81
82> 工程默认配置使用 JLink 下载程序，在通过 JLink 连接开发板的基础上，点击下载按钮即可下载程序到开发板
83
84#### 运行结果
85
86下载程序成功之后，系统会自动运行，观察开发板上 LED 的运行效果，红色 LED0 会周期性闪烁。
87
88连接开发板对应串口到 PC , 在终端工具里打开相应的串口（115200-8-1-N），复位设备后，可以看到 RT-Thread 的输出信息:
89
90> 注：正点原子开发板 在使用终端工具如：PuTTy、XShell 时，会出现系统不能启动的问题，推荐使用串口调试助手如：sscom
91
92```bash
93 \ | /
94- RT - Thread Operating System
95 / | \ 3.1.1 build Nov 19 2018
96 2006 - 2018 Copyright by rt-thread team
97msh >
98```
99### 进阶使用
100
101此 BSP 默认只开启了 GPIO 和 串口1 的功能，如果需使用 Flash 等更多高级功能，需要利用 ENV 工具对BSP 进行配置，步骤如下：
102
1031. 在 bsp 下打开 env 工具。
104
1052. 输入`menuconfig`命令配置工程，配置好之后保存退出。
106
1073. 输入`pkgs --update`命令更新软件包。
108
1094. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
110
111本章节更多详细的介绍请参考 [STM32 系列 BSP 外设驱动使用教程](../docs/STM32系列BSP外设驱动使用教程.md)。
112
113## 注意事项
114
115
116## 联系人信息
117
118维护人:
119
120- [guozhanxin](https://github.com/Guozhanxin)
