KEIL5环境下利用HAL库开发STM32项目_工程搭建方法
KEIL5环境下利用HAL库开发STM32项目_工程搭建方法
【摘要】本文主要讲述在KEIL5环境下,如何搭建基于HAL库的STM32项目模板工程,全篇以STM32F103ZE芯片为例进行讲解,并对工程中主要的几个关键文件作用进行了阐述,适合入门级别同学参考借鉴。
步骤
-
准备工作:
- 创建工程根目录。在电脑某磁盘根目录下建立Template文件夹,后面所建立的工程都可以放在这个文件夹下面,当然名字可以任取,避免使用中文路径。
- 新建 4 个子文件夹(CORE , HALLIB, OBJ 和 USER/Project )。这些文件夹名字实际上是可以任取的,这样取名只是为了方便识别。
- 下载HAL 库开发包。建议去 ST 官网下载,因为我们以STM32F1 系列芯片讲解,所以我下载的是STM32CubeF1 包:STM32Cube_FW_F1_V1.8.6
- 下载安装KEIL开发环境。我安装的是Keil uvision5
-
创建空壳工程:
- 打开 Keil,点击菜单 Project –>New Uvision Project ,然后将目录定位到刚才建立的文件夹 Template 之下的 USER/Project 子目录, 工程取名为 Template 之后点击保存, 工程文件就都保存到Project 文件夹下面。
- 接下来会出现一个选择 Device 的界面,就是选择我们的芯片型号,这里我们定位到STMicroelectronics 下面的 STM32F103ZE(实际型号根据你自己的来)。需要注意的是,如果找不到你要的芯片型号,那就需要安装对应的器件 pack 。
- 点击 OK, MDK 会弹出 Manage Run-Time Environment 对话框,这里可以添加自己需要的组件,从而方便构建开发环境,这里不做介绍,直接点击 Cancel 。
- 此时,可以回到USER/Project文件夹下,多出了很多KEIL自动创建的文件及文件夹。
- Template.uvprojx :工程文件,非常关键,不能删除。MDK5.23
生成的工程文件是以.uvprojx 为后缀的。 - DebugConfig 文件夹 :存储KEIL的调试配置文件
- Listings 和 Objects 文件夹 :存储 MDK 编译过程的中间件
- Template.uvprojx :工程文件,非常关键,不能删除。MDK5.23
-
向工程目录添加HAL库等必需文件
- A. 将 STM32CubeF1 包里的外设驱动源文件复制到我们的工程目录文件夹
- 打开\STM32Cube_FW_F1_V1.8.6\Drivers\STM32F1xx_HAL_Driver 下面,将目录下面的 Src,Inc 文件夹复制到我们刚才建立的 HALLIB 文件夹。每个外设对应一个.c 文件和一个.h 头文件,可以根据项目需要选择其中部分文件,也可以全部复制过去。
- B. 将 STM32CubeF1 包里的启动文件以及编译器头文件复制到我们的工程目录文件夹
- 打开STM32Cube_FW_F1_V1.8.6\Drivers\CMSIS\Device\ST\STM32F1xx\Source\Templates\arm,找到需要的启动文件
startup_stm32f103xe.s
,并复制到CORE目录。 具体根据你使用的芯片型号选择。 - 打开STM32Cube_FW_F1_V1.8.6\Drivers\CMSIS\Include,将里面的4个头文件:
cmsis_armcc.h
,cmsis_armclang.h
,cmsis_compiler.h
,core_cm3.h
复制到 CORE 目录
- 打开STM32Cube_FW_F1_V1.8.6\Drivers\CMSIS\Device\ST\STM32F1xx\Source\Templates\arm,找到需要的启动文件
- C. 将 STM32CubeF1 包里的芯片相关头文件复制到我们的工程目录文件夹
- 打开STM32Cube_FW_F1_V1.8.6\Drivers\CMSIS\Device\ST\STM32F1xx\Include, 将里面的 3 个文件
stm32f1xx.h
,system_stm32f1xx.h
和stm32f103xe.h
复制到 USER 目录 - 打开STM32Cube_FW_F1_V1.8.0\Projects\STM3210E_EVAL\Templates\Inc 目录,将
stm32f1xx_it.h
,stm32f1xx_hal_conf.h
和``main.h`这3个头文件复制到USER 目录 - 打开STM32Cube_FW_F1_V1.8.0\Projects\STM3210E_EVAL\Templates\Src 目录,将
system_stm32f1xx.c
,stm32f1xx_it.c
,stm32f1xx_hal_msp.c
和main.c
复制到 USER 目录
- 打开STM32Cube_FW_F1_V1.8.6\Drivers\CMSIS\Device\ST\STM32F1xx\Include, 将里面的 3 个文件
- A. 将 STM32CubeF1 包里的外设驱动源文件复制到我们的工程目录文件夹
-
将复制过来的文件加入到KEIL工程
- 打开刚刚创建的KEIL空工程,右键点击 Target1,选择 Manage Project Items, 可以在 Project Targets 栏,将默认的Target 名字修改为 Template
- 在 Groups 栏删掉默认的 Source Group1,并新建4个Groups: USER, USER\Drivers, CORE,和 HALLIB,然后点击 OK。
- 选中对应的组名,点击Add Files…,依次为各组添加源文件
- 选择HALLIB,然后点击右边的 Add Files,定位到我们刚才建立的目录\HALLIB\Src 下面,将里面所有的文件选中(Ctrl+A),然后点击 Add,然后 Close。需要说明的是,对于我们写代码,如果只用到了其中的某个外设,我们可以不用全部添加,只选择用到的外设库文件即可。
- 选择CORE 分组,定位到我们刚才建立的目录CORE ,将里面所有的文件选中(Ctrl+A),然后点击 Add,然后 Close。注意,默认添加的时候文件类型为.c, 添加.h 头文件和 startup_stm32f103xe.s 启动文件的时候,你需要选择文件类型为 All files 才能看得到这些文件。
- 选择USER 分组,定位到我们刚才建立的目录USER,将里面所有的.c 文件:
main.c
,stm32f1xx_hal_msp.c
,stm32f1xx_it.c
,system_stm32f1xx.c
四个文件添加进来。 - USER\Drivers主要存放后期我们自己写的驱动文件(调试串口驱动、时钟配置文件、延时函数等),目前暂无文件添加。添加完所有文件到工程中之后,我们点击 OK 按钮。
-
设置头文件存放路径
- 点击魔术棒,选中C/C++选项卡,点击Include Paths栏右侧三个点标志,将工程目录下所有存放了头文件的目录全部添加进去。例如:\CORE, \USER\ ,HALLIB\Inc等。
-
**添加全局宏定义标识符 **
- 点击魔术棒之后,进入 C/C++选项卡,然后在 Define 输入框连输入:
USE_HAL_DRIVER,STM32F103xE
- 点击魔术棒之后,进入 C/C++选项卡,然后在 Define 输入框连输入:
-
编译工程
- 点击魔术棒之后,进入Output 选项卡。勾上“Create HEX File” 选项和 Browse Information 选项。 Create HEX File 选项选
上是要求编译之后生成 HEX 文件。 而 Browse Information 选项选上是方便我们查看工程中的一些函数变量定义等。 - 编辑main函数,之后编译工程,可以看到在工程的USER\Project\Objects里生成了对应的hex文件,将其下载到开发板即可。
- 点击魔术棒之后,进入Output 选项卡。勾上“Create HEX File” 选项和 Browse Information 选项。 Create HEX File 选项选
-
关键文件介绍
-
HAL库相关头文件
- sm32f1xx_hal.c:包含 HAL 通用 API(比如 HAL_Init,HAL_DeInit,HAL_Delay 等)。
- stm32f1xx_hal.h :HAL 的头文件,我们在编写任意文件前,首先要包含的就是该头文件
- stm32f1xx_hal_conf.h :HAL 的配置文件,主要用来选择使能何种外 设以及一些时钟相关参数设置。其本身应该 被客户代码所包含。
- stm32f1xx_hal_def.h :包含 HAL 的通用数据类型定义和宏定义
-
中断相关
- stm32f1xx_it.c :中断服务函数定义,而这些函数定义除了 Systick 中断服务函数SysTick_Handler 外基本都是空函数,没有任何控制逻辑。我们可以去掉这两个文件,然后把中断服务函数写在工程中的任何一个可见文件中。
- stm32f1xx_it.h :主要是一些中断服务函数的声明
-
芯片头文件
- stm32f1xx.h :它是所有 stm32f1 系列的顶层头文件。使用 STM32F1 任何型号的芯片,都需要包含这个头文件。 因为 stm32f1 系列芯片型号非常多, ST 为每种芯片型号定义了一个特有的片上外设访问层头文件,stm32f1xx.h 顶层头文件会根据工程芯片型号,来选择包含对应芯片的片上外设访问层头文件。 例如,我们在 C/C++选项卡里面输入的全局宏定义标识符中就包含了标识符 STM32F103xx,所以我们的工程就会自动包含头文件 stm32f103xx.h
- stm32f103xx.h :是 stm32f103 系列芯片通用的片上外设访问层头文件,里面主要是一些结构体和宏定义标识符,主要作用是寄存器定义声明以及封装内存操作。
-
系统初始化文件
- system_stm32f1xx.c :定义了系统初始化函数 SystemInit 以及系统时钟更新函数systemCoreClockUpdate。SystemInit 函数的作用是进行时钟系统的一些初始化操作以及中断向量表偏移地址设置,但它并没有设置具体的时钟值,这是与标准库的最大区别(在使用标准库的时候, SystemInit 函数会帮我们配置好系统时钟配置相关的各个寄存器)。在启动文件startup_stm32f103xx.s 中会设置系统复位后,直接调用 SystemInit 函数进行系统初始化。 SystemCoreClockUpdate 函数是在系统时钟配置进行修改后,调用这个函数来更新全局变量 SystemCoreClock 的值,变量 SystemCoreClock 是一个全局变量,开放这个变量可以方便我们在用户代码中直接使用这个变量来进行一些时钟运算。
- system_stm32f1xx.h :声明了系统初始化函数 SystemInit 以及系统时钟更新函数 SystemCoreClockUpdate
-
MCU 级别硬件初始化文件
- stm32f1xx_hal_msp.c :MSP,全称为 MCU support package,函数名字中带有 MspInit 的函数,它们的作用是进行 MCU 级别硬件初始化设置,并且它们通常会被上一层的初始化函数所调用,这样做的目的是为了把MCU相关的硬件初始化剥夺出来,方便用户代码在不同型号的MCU上移植。 该文件定义了两个函数 HAL_MspInit 和 HAL_MspDeInit。这两个函数分别被文件 stm32f1xx_hal.c 中的 HAL_Init 和 HAL_DeInit 所调用。 HAL_MspInit 函数的主要作用是进行 MCU 相关的硬件初始化操作。例如我们要初始化某些硬件,我们可以硬件相关的初始化配置写在 HAL_MspInit 函数中。这样的话,在系统启动后调用了 HAL_Init之 后 , 会自动调用硬件初始化函数 。
-
启动文件
-
startup_stm32f103xe.s :STM32 系列所有芯片工程都会有一个.s 启动文件。对于不同型号的 stm32 芯片启动文件也是不一样的。 作用主要是进行堆栈的初始化,中断向量表以及中断函数定义等。启动文件有一个很重要的作用就是系统复位后引导进入 main 函数
; Reset handler Reset_Handler PROC EXPORT Reset_Handler [WEAK] IMPORT __main IMPORT SystemInit LDR R0, =SystemInit BLX R0 LDR R0, =__main BX R0 ENDP
- 开发板接通电源或按下复位键之后,就会跳到Reset_Handler中断处理函数处执行,这几行代码的作用是在系统启动之前,首先调用 SystemInit 函数进行系统初始化,然后引导进入 main 函数执行用户代码。
-
-