summaryrefslogtreecommitdiff
path: root/bsp/stm32/libraries/templates/stm32mp1xx/README.md
blob: 191f1fa5aa8ee52a49e6206be705f39db721d8a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# BSP README 模板

## 简介

本文档为 xxx 开发板的 BSP (板级支持包) 说明。

主要内容如下:

- 开发板资源介绍
- BSP 快速上手
- 进阶使用方法

通过阅读快速上手章节开发者可以快速地上手该 BSP,将 RT-Thread 运行在开发板上。在进阶使用指南章节,将会介绍更多高级功能,帮助开发者利用 RT-Thread 驱动更多板载资源。

## 开发板介绍

【此处简单介绍一下开发板】

开发板外观如下图所示:

![board](figures/board.png)

该开发板常用 **板载资源** 如下:

- MCU:STM32MP157AACx
- 常用外设
  - LED:4个 ,LD4 (PA14), LD6 (PA13),LD7 (PH7),LD8 (PD11)
  - 按键,4个,WAKE_UP,RESET (NRST),USER1(PA14),USER2 (PA13)
- 常用接口:USB 转串口、SD 卡接口、以太网接口、MIPI接口、USB HOST、Audio、HDMI、Arduino
- 调试接口,标准 JTAG/SWD

开发板更多详细信息请参考【厂商名】 [xxx开发板介绍](https://xxx)。

## 外设支持

本 BSP 目前对外设的支持情况如下:

| **板载外设** | **支持情况** |     **备注**     |
| :----------- | :----------: | :--------------: |
| USB 转串口   |     支持     |                  |
| SD卡         |   暂不支持   |                  |
| 以太网       |   暂不支持   |                  |
| 音频接口     |   暂不支持   |                  |
| **片上外设** | **支持情况** |     **备注**     |
| GPIO         |     支持     |                  |
| UART         |     支持     | UART4 (ST-Link)  |
| EXTI         |     支持     |                  |
| SPI          |     支持     |                  |
| TIM          |     支持     |                  |
| LPTIM        |     支持     |                  |
| I2C          |     支持     | 软件、硬件都支持 |
| ADC          |     支持     |                  |
| DAC          |     支持     |                  |
| WWDG         |     支持     |                  |
| USB Device   |   暂不支持   |                  |
| USB Host     |   暂不支持   |                  |


## 使用说明

使用说明分为如下两个章节:

- 快速上手

    本章节是为刚接触 RT-Thread 的新手准备的使用说明,遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上,看到实验效果 。

- 进阶使用

    本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置,可以开启更多板载资源,实现更多高级功能。


### 快速上手

本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程,并且支持 GCC 开发环境。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。

#### 硬件连接

使用数据线连接开发板到 PC,打开电源开关。

#### 编译下载

双击 project.eww 文件,打开 IAR 工程,编译并下载程序到开发板。

> 工程默认配置使用 xxx 仿真器下载程序,在通过 xxx 连接开发板的基础上,点击下载按钮即可下载程序到开发板

#### 运行结果

下载程序成功之后,系统会自动运行,【这里写开发板运行起来之后的现象,如:LED 闪烁等】。

 连接开发板对应串口到 PC , 在终端工具里打开相应的串口(115200-8-1-N),复位设备后,可以看到 RT-Thread 的输出信息:

```bash
 \ | /
- RT -     Thread Operating System
 / | \     3.1.1 build Nov 19 2018
 2006 - 2018 Copyright by rt-thread team
msh >
```

### 进阶使用

此 BSP 默认只开启了 GPIO 和 串口4 的功能,如果需更多高级功能,需要利用 ENV 工具对BSP 进行配置,步骤如下:

1. 在 bsp 下打开 env 工具。

2. 输入`menuconfig`命令配置工程,配置好之后保存退出。

3. 输入`pkgs --update`命令更新软件包。

4. 输入`scons --target=iar` 命令重新生成工程。

本章节更多详细的介绍请参考 [STM32 系列 BSP 外设驱动使用教程](../docs/STM32系列BSP外设驱动使用教程.md)。

## 注意事项

- xxx

## 联系人信息

维护人:

-  [xxx](https://个人主页), 邮箱:<[email protected]>