1# BSP README 模板
2
3## 简介
4
5本文档为ek-tm4c123gxl开发板的 BSP (板级支持包) 说明。
6
7主要内容如下:
8
9- 开发板资源介绍
10- BSP 快速上手
11- 进阶使用方法
12
13通过阅读快速上手章节开发者可以快速地上手该 BSP,将 RT-Thread 运行在开发板上。在进阶使用指南章节,将会介绍更多高级功能,帮助开发者利用 RT-Thread 驱动更多板载资源。
14
15## 开发板介绍
16
17【此处简单介绍一下开发板】
18
19开发板外观如下图所示:
20
21![](E:\00MyWorkSpace\tm4c123_rtos\tm4c123bsp\figures\board.jpg)
22
23该开发板常用 **板载资源** 如下:
24
25- MCU:TM4C123Gh6PM,主频 80MHz,256KB FLASH ,32KB RAM
26- 外部 RAM:型号,xMB
27- 外部 FLASH:型号,xMB
28- 常用外设
29  - LED:1个三色,(红色,PF1),(蓝色,PF2),(绿色,PF3)
30  - 按键:2个,SW1(PF4),SW2(兼具唤醒功能,PF0)
31- 常用接口:ICDI(具串口功能)、USB接口
32- 调试接口,ICDI
33
34开发板更多详细信息请参考【TI】 [TM4C123G开发板介绍](https://www.ti.com/tool/EK-TM4C123GXL?DCMP=stellaris-launchpad&HQS=tm4c123g-launchpad)35
36## 外设支持
37
38本 BSP 目前对外设的支持情况如下:
39
40| **板载外设**      | **支持情况** | **备注**                              |
41| :----------------- | :----------: | :------------------------------------- |
42| USB 转串口        |     支持     |                                       |
43| SPI Flash         |     暂不支持     |                                       |
44| 以太网            |     暂不支持     |                                       |
45| SD卡              |   暂不支持   |                                       |
46| CAN               |   暂不支持   |                                       |
47| **片上外设**      | **支持情况** | **备注**                              |
48| GPIO              |     支持     | PF0, PF1... PF4---> PIN: 0, 1...4 |
49| UART              |     支持     | UART0/1/2/3                        |
50| SPI               |     支持     | SPI0/1/2                            |
51| I2C               |     支持     | 软件 I2C                              |
52| SDIO              |   暂不支持   | 即将支持                              |
53| RTC               |   暂不支持   | 即将支持                              |
54| PWM               |   支持   | PWM0/1/2/3/4/5/6/7             |
55| USB Device        |   暂不支持   | 即将支持                              |
56| USB Host          |   暂不支持   | 即将支持                              |
57| IWG               |   暂不支持   | 即将支持                              |
58| **扩展模块**      | **支持情况** | **备注**                              |
59|     xxx 模块      |   支持   |                                      |
60
61## 使用说明
62
63使用说明分为如下两个章节:
64
65- 快速上手
66
67    本章节是为刚接触 RT-Thread 的新手准备的使用说明,遵循简单的步骤即可将 RT-Thread 操作系统运行在该开发板上,看到实验效果 。
68
69- 进阶使用
70
71    本章节是为需要在 RT-Thread 操作系统上使用更多开发板资源的开发者准备的。通过使用 ENV 工具对 BSP 进行配置,可以开启更多板载资源,实现更多高级功能。
72
73
74### 快速上手
75
76本 BSP 为开发者提供 MDK4、MDK5 和 IAR 工程,并且支持 GCC 开发环境。下面以 MDK5 开发环境为例,介绍如何将系统运行起来。
77
78#### 硬件连接
79
80使用数据线连接开发板到 PC,打开电源开关。
81
82#### 编译下载
83
84双击 project.uvprojx 文件,打开 MDK5 工程,编译并下载程序到开发板。
85
86> 工程默认配置使用 ICDI 仿真器下载程序,在通过USB连接开发板的基础上,点击下载按钮即可下载程序到开发板
87
88#### 运行结果
89
90下载程序成功之后,系统会自动运行,【这里写开发板运行起来之后的现象,如:LED 闪烁等】。
91
92连接开发板对应串口到 PC , 在终端工具里打开相应的串口(115200-8-1-N),复位设备后,可以看到 RT-Thread 的输出信息:
93
94```bash
95 \ | /
96- RT -     Thread Operating System
97 / | \     3.1.1 build Nov 19 2018
98 2006 - 2018 Copyright by rt-thread team
99msh >
100```
101### 进阶使用
102
103此 BSP 默认只开启了 GPIO 和 串口0 的功能,如果需使用 SD 卡、Flash 等更多高级功能,需要利用 ENV 工具对BSP 进行配置,步骤如下:
104
1051. 在 bsp 下打开 env 工具。
106
1072. 输入`menuconfig`命令配置工程,配置好之后保存退出。
108
1093. 输入`pkgs --update`命令更新软件包。
110
1114. 输入`scons --target=mdk4/mdk5/iar` 命令重新生成工程。
112
113本章节更多详细的介绍请结合 [STM32 系列 BSP 外设驱动使用教程](../docs/STM32系列BSP外设驱动使用教程.md)学习使用。
114
115## 注意事项
116
117- 本BSP配置片上外设在board/tm4c123gh6pz_config.c/h中进行配置。配置时钟在board.c文件中进行
118
119## 联系人信息
120
121维护人:
122
123-  [AHTYDHD](https://github.com/LYH-ux), 邮箱:<1780328728@qq.com>