新建基于STM32F103ZET6的工程-HAL库版本

1、STM32F103ZET6简介

　　STM32F103ZET6的FLASH容量为512K，64K的SRAM。按照STM32芯片的容量产品划分，STM32F103ZET6属于大容量的芯片。

2、下载HAL固件库

　　打开STM32的官方网址：https://www.st.com/。

　　在官网上通过搜素STM32CubeF1找到如上图所显示的内容，这个就是STM32F1系列的固件包文件，点击“获取软件”下载。

3、安装STM32F1的Pack

　　到http://www.keil.com/dd2/pack/ 网站下载STM32F1 Pack 安装包，如果不安装STM32F1的Pack，则在使用MDK创建工程选择芯片型号的时候找不到对应的IC型号，当然如果安装MDK的时候已经有对应的Pack了，则不用安装了。如下图：

　　下载Pack后双击下载的文件进行安装，Pack安装包会自动找到MDK的安装目录进行安装，直接点击下一步进行安装即可，安装完成后可以在MDK的Device中看到STM32F1Series。

4、STM32CubeF1固件包说明

　　STM32CubeF1固件包的根目录如下图所示。

　　_htmresc文件夹:

　　这个文件夹放的是一些图片和网站的资料，个人觉得没什么用。　　　　

　　Documentation文件夹：

　　里面就一个STM32CubeF1的说明文档，而且是英文的，看得懂的可以琢磨。

　　Utilities文件夹：

　　该文件夹下面是一些其他组件，基本没怎么使用。

　　Middlewares文件夹：

　　如果做基本的开发，这个文件夹也不怎么使用。Middlewares文件夹中包含了ST和Third_Party两个子文件夹，它们的内容如下：

　　ST\STemWim文件夹：

　　存放的是STemWin工具包。

　　ST\STM32_TouchSensing_Library文件夹：

　　存放的是STM32电容触摸支持包。

　　ST\STM32_USB_Device_Library文件夹：

　　USB从机设备支持包。

　　ST\STM32_USB_Host_Library文件夹：

　　USB主机设备支持包。

　　Third_Party\FatFs文件夹：

　　FAT文件系统支持包。

　　Third_Party\FreeRTOS文件夹：

　　FreeRTOS实时系统支持包。

　　Drivers文件夹：

　　Dreivers文件夹下有如图所示几个子文件夹。

　　BSP文件夹：

　　该文件夹也叫板级支持包，该包提供的是直接与硬件打交道的API，如触摸屏，LCD，SRAM以及EEPROM等板载硬件资源驱动。该文件夹中还有多种ST官方Discovery开发板，Nucleo开发板以及EVAL板的硬件驱动API文件，如果要编写相关的硬件驱动，可以参考这些文件夹中的程序。

　　CMSIS文件夹：

　　该文件夹内包含的是符号CMSIS标志的软件抽象层组件的相关文件。主要包括DSP库(DSP_LIB文件夹)，Cortex-M内核及其设备文件(Include文件夹)，微控制器专用头文件/启动代码/专用系统文件等(Device文件夹)。

　　STM32F1xx_HAL_Driver文件夹：

　　该文件夹包含了所有的STM32F1xx系列HAL库头文件和源文件，也就是所有底层硬件抽象层API声明和定义。它的作用是屏蔽了复杂的硬件寄存器操作，统一了外设的接口函数。该文件夹包含Src和Inc两个子文件夹，其中Src子文件夹存放的是.c源文件，Inc子文件夹存放的是与之对应的.h头文件。每个.c源文件对应一个.h头文件。源文件名称基本遵循stm32f1xx_hal_ppp.c定义格式,头文件名称基本遵循stm32f1xx_hal_ppp.h定义格式。

　　Projects文件夹：

　　该文件夹存放的是一些可以直接编译的实例工程。每一个文件夹对应一个ST官方的Demo板。

　　通过上面的介绍可以看出在STM32CubeF1固件包中用到的就Drivers、Projects文件夹中的文件。

5、创建基于HAL的新工程 

　　新建一个文件夹，用来存放创建的工程，在这个文件夹中创建几个子文件夹，用来存放对应的文件。

　　CORTEX文件夹：

　　存放内核和启动文件。

　　MDK-PRO文件夹：

　　存放工程文件。

　　OUTPUT文件夹存：

　　存放工程编译生成的一些文件

　　STM32F1xx_HAL_Driver文件夹：

　　存放STM32F1 HAL库头文件和源文件。

　　最后在MDK-PRO文件夹下新建Inc和Src两个子文件夹。

　　打开MDK并点击创建新工程。

 

　　输入工程名称，然后选择将工程保存到MDK-PRO文件夹中。

　　下一步是选择对应的STM32 IC的型号，在这里选择STM32F103ZE。

　　点击OK就创建好新的工程了，只是这是一个空的工程，什么都没有，如下图。

　　接下来先将工程的编译输出文件设置到OUTPUT文件夹中。在MDK软件中，选择“Options for Target”，在弹出来的界面中选择Output选项卡，点击“Select Folder for Listings…”，在弹出来的界面中选择OUTPUT文件夹。

　　然后再选择Listing选项卡，点击“Select Folder for Listings…”，也在弹出来的界面中选择OUTPUT文件夹。

　　从STM32CubeF1包里复制文件到新工程里。

　　1、将"STM32Cube_FW_F1_V1.7.0\Drivers\STM32F1xx_HAL_Driver"文件夹中的Inc和Src文件夹复制到新工程的STM32F1xx_HAL_Driver文件夹下。

　　2、复制相应的启动文件和关键头文件到新工程目录下：

　　将STM32Cube_FW_F1_V1.7.0\Drivers\CMSIS\Device\ST\STM32F1xx\Source\Templates\arm文件夹中的startup_stm32f103xe.s文件复制到CORTEX文件夹中。　　

 

　　将STM32Cube_FW_F1_V1.7.0\Drivers\CMSIS\Include文件夹中的cmsis_armcc.h、core_cm3.h、core_cmFunc.h、core_cmInstr.h、core_cmSimd.h文件复制到CORTEX文件夹中。

 

　　3、复制工程需要用到的一些头文件和源文件。

　　在MDK-PRO文件夹中创建Inc和Src两个子文件夹，Inc存放头文件，Src存放源文件。

　　将STM32Cube_FW_F1_V1.7.0\Drivers\CMSIS\Device\ST\STM32F1xx\Include文件夹中的stm32f1xx.h、stm32f103xe.h、system_stm32f1xx.h文件复制到MDK-PRO文件夹的Inc文件夹中。

　　将STM32Cube_FW_F1_V1.7.0\Projects\STM32F103RB-Nucleo\Templates\Inc文件夹中的main.h、stm32f1xx_hal_conf.h、stm32f1xx_it.h文件复制到MKD-PRO文件夹的Inc文件夹中。

　　将STM32Cube_FW_F1_V1.7.0\Projects\STM32F103RB-Nucleo\Templates\Src文件夹中的main.c、stm32f1xx_hal_msp.c、stm32f1xx_it.c、system_stm32f1xx.c文件复制到MDK-PRO文件夹的Src文件夹中。

　　将上面步骤的文件复制完之后。用鼠标右击MDK工程栏中的Group,选择‘Manage Project Items’。然后添加如下图所示的Group。

　　在MDK中创建完分组之后，往Group里面添加需要的文件。

　　将STM32F1xx_HAL_Driver\Src文件夹下的.c源文件添加到工程中的HAL-LIBRARY组。

　　其它组所需要添加的文件如下图所示：

　　添加完文件到MDK后，点击OK，工程如下图所示：

　　指定头文件（.h文件）所在的路径：

　　很多.c源代码都有一个对应的.h文件，但是.h文件是存在不同的目录的，必须告诉编译器.h文件在哪个目录下，编译器才能找到对应的.h文件进行编译，否则就会报错。

　　如下图所示选择C/C++选项卡，点击Include Paths。将所有.h文件所在的文件夹添加进去。最后点击OK退出。

　　定义全局宏定义标识符，定义了全局宏定义标识符后，编译器会根据宏定义进行选择编译。打开C/C++选型卡，在define栏输入“USE_HAL_DRIVER, STM32F103xE”，这两个标识符在stm32f1xx.h文件当中有用到。

　　点击编译工程。提示找不到“stm32f1xx_nucleo.h”，双击跳转到出错点。

　　将44行的#include "stm32f1xx_nucleo.h"删除，再编译就没发现错误了。

但是当进行全部编译的时候发现有提示又错误。

　　这里的错误提示是指函数重复定义了。定义的函数在“stm32f1xx_hal_msp.c”和“stm32f1xx_hal_msp_template.c”这两个文件中。在这里将“stm32f1xx_hal_msp_template.c”文件Remove掉。如下图：

　　再将工程能的模板文件删除掉，找到“stm32f1xx_hal_timebase_rtc_alarm_template.c”和“stm32f1xx_hal_timebase_tim_template.c”并删除，带有template的就是模板文件。

　　再次编译文件，可以看到没有错误产生了。

6、系统初始化之后的中断优先级分组号和时钟设置

　　默认情况下调用HAL初始化函数HAL_Init之后，会将中断优先级分组设置为4，可以通过修改HAL_Init函数的内容来更改分组。打开stm32f1xx_hal.c文件，找到HAL_Init函数，如下图：

修改173行的HAL_NVIC_SetPPriorityGrouping函数中的参数就可以了。　　 

时钟设置： 

　　关于时钟的设置，需要注意stm32f1xx_hal_conf.h文件里面HSE_VALUE宏定义的值，这个值是外部晶振大小的值，如果跟实际值对不上，那么跑的时钟可能会跟预计的不同，需要注意。比如外部晶振用的是8M，那么HSE_VALUE宏的值应该设为8000000U，如下图：

7、工程文件说明

　　任何一个MDK工程，不管有多复杂，无非就是一些.c源文件和.h头文件，还有一些类似.s的启动文件或者lib文件等。在工程中，他们通过各种包含关系组织在一起，被用户代码最终调用或者引用。只要了解了这些文件的作用以及它们之间的包含关系，就能理解这个工程的运行流程。熟悉了文件后，可以自己删减外设功能，减少工程的代码量。

　　1、文件介绍：

　　　　1、HAL库文件介绍：

　　stm32f1xx_hal_ppp.c/.h文件是一些基本外设的操作API（接口函数），ppp代表任意外设。其中stm32f1xx_hal_cortex.c/.h比较特殊，它是一些Cortex内核通用函数声明和定义，如中断优先级NVIC配置，系统软复位以及Systick配置等。

　　stm32f1xx_hal_ppp_ex.c/.h文件是拓展外设特性的API（接口函数）。

　　stm32f1xx_hal.c文件包含了HAL通用API（比如HAL_Init,HAL_DeInit,HAL_Delay等）。

　　stm32f1xx_hal.h文件是HAL库的头文件，它应被客户代码所包含。

　　stm32f1xx_hal_conf.h文件是HAL库的配置文件，主要用来选择使能何种外设以及一些时钟相关参数设置。它应被客户代码所包含。

　　stm32f1xx_hal_def.h文件包含了HAL库的通用数据类型定义和宏定义。

　　2、stm32f1xx_it.c/ stm32f1xx_it.h文件

　　stm32f1xx_it.h中主要是一些中断服务函数的申明。stm32f1xx_it.c中是这些中断服务函数的定义，而这些函数定义除了Systick中断服务函数SysTick_Handler外基本都是空函数，没有任何控制逻辑。一般情况下，可以去掉这两个文件，然后把中断服务函数写在工程中的任何一个可见文件中。

　　3、stm32f1xx.h头文件

　　stm32f1xx.h文件很重要，它是所有stm32f1系列的顶层头文件，使用STM32F1任何型号的芯片，都需要包含这个头文件。同时因为stm32f1系列芯片型号非常多，ST为每种芯片型号定义了一个特有的片上外设访问层头文件，比如STM32F103xE系列，ST定义了一个头文件stm32f103xe.h，然后stm32F1xx.h顶层头文件会根据工程芯片型号，来选择包含对应芯片的片上外设访问层头文件。打开stm32f1xx.h文件可以看到如下图所示：

　　以STM32F103ZET6为例，如果定义了宏定义标识符STM32F103xE，那么头文件stm32f1xx.h将会包含头文件stm32f103xe.h。在前面的时候我们已经在C/C++选项卡里面输入全局宏定义标识符STM32F103xE.所以头文件stm32f103xe.h一定会被整个工程所引用。

　　4、stm32f103xe.h头文件

　　stm32f103xe.h头文件是STM32F103xE系列芯片通用的片上外设访问层头文件，只要进行STM32F103ZET6开发，就必然要使用到该文件。该文件主要是一些结构体和宏定义标识符。这个文件的主要作用是寄存器定义声明以及封装内存操作。

　　5、system_stm32f1xx.c/ system_stm32f1xx.h文件

　　这两个文件主要是声明和定义了系统初始化函数SystemInit以及系统时钟更新函数　　　　SystemCoreClockUpdate。函数SystemInit的作用是进行时钟系统的一些初始化操作以及中断向量表编译地址设置，但它并没有设置具体的时钟值。在启动文件startup_stm32f103xe.s中设置系统复位后，直接调用SystemInit函数进行系统初始化。SystemCoreClockUpdate函数是在系统时钟配置进行修改后，调用这个函数来更新全局变量SystemCoreClock的值，变量SystemCoreClock是一个全局变量，开放这个变量可以方便我们在用户代码中直接使用这个变量来进行一些时钟运算。

　　6、stm32f1xx_hal_msp.c文件

　　MSP，全称MCU support package，函数名字找那个带有MSPInit的函数的作用是进行MCU级别硬件初始化设置，并且它们通常会被上一层的初始化函数所调用，这样做的目的是为了把MCU相关的硬件初始化剥夺出来，方便用户代码在不同型号的MCU上移植。stm32lxx_hal_msp.c文件定义了两个函数HAL_MspInit和HAL_MspDeInit。这两个函数分别被文件stm32f1xx_hal.c中的HAL_Init和HAL_DeInit所调用。HAL_MspInit函数的作用主要是进行MCU相关的硬件初始化操作。这样的话，在系统启动后调用了HAL_Init之后，会自动调用硬件初始化函数。实际上，在工程中直接删除掉stm32f1xx_hal_msp.c文件也不会对程序运行产生影响。

　　7、startup_stm32f103xe.s启动文件

　　STM32系列所有芯片工程都会有一个.s的启动文件，不同型号的stm32芯片启动文件也是不一样的。启动文件的作用主要是进行堆栈的初始化，中断向量表以及中断函数定义等。启动文件有一个很重要的作用就是系统复位后引导进入C语言的main函数。

　　如上图所示，Rest_handler是复位函数，在系统启动的时候会执行，系统启动后，先调用SystemInit函数进行系统初始化，然后引导进入main函数执行用户代码。

　　8、文件包含关系

 　　整个工程的文件包含关系如下图所示：

 

　　从上图可以看出各个文件之间的包含关系，顶层头文件stm32f1xx.h直接或间接包含了其他所有工程必要头文件，所以在用户代码中，只需要包含顶层头文件stm32f1xx.h即可。

　　首先包含stm32f1xx.h，然后包含stm32f1xx_hal.h(.c/.h文件主要实现HAL库的初始化、系统滴答相关函数及CPU的调试模式配置)，再包含stm32f1xx_hal_conf.h(该文件是一个用户级别的配置文件，用来实现对HAL库的裁剪)。

　　2、HAL库源文件说明：

　　HAL库文件名均以stm32f1xx_hal开头，后面加上_外设或者模块名，比如stm32f1xx_hal_adc.c。

　　初始化/反初始化函数：HAL_PPP_Init()，HAL_PPP_DeInit()。

　　IO操作函数：HAL_PPP_Read(),HAL_PPP_Write()，HAL_PPP_Transmit()，HAL_PPP_Receive()。

　　控制函数：HAL_PPP_Set()，HAL_PPP_Get()。

　　状态和错误：HAL_PPP_GetState()，HAL_PPP_GetError()。

　　在STM32Cube中包含了LL库，目前LL库和HAL库捆绑发布，所以在HAL库源码中，还有一些名为stm32f1xx_ll_ppp的源码文件，这些文件就是新增的LL库文件，使用CubeMX生成项目时，也可以选择LL库。

　　HAL库最大的特点就是对底层进行了抽象。在此结构下，用户代码的处理主要分为三大部分：

　　处理外设句柄（实现用户功能）。

　　处理MSP。

　　处理各种回调函数。

　　外设句柄：

　　HAL库在结构上，对每个外设抽象成了一个称为ppp_HandleTypeDef的结构体，其中ppp就是每个外设的名字。所有的函数都是工作的ppp_HandleTyepDef指针之下。

　　多实例支持：

　　每个外设/模块实例都有自己的句柄。因此实例资源是独立的。

　　外围进程相互通信：

　　该句柄用于管理进程例程之间的共享数据资源。

　　3、三种编程方式：

　　HAL库对所有的函数模型也进行了统一。在HAL库中，支持三种编程模式：轮询模式、中断模式、DMA模式（如果外设支持）。其中带有_IT的表示工作在中断模式下；带_DMA的工作在DMA模式下；什么都没带的就是轮询模式。

　　HAL库架构下统一采用宏的形式对各种中断等进行配置，针对每种外设主要有以下宏：

　　__HAL_PPP_ENABLE_IT(__HANDLE__,__INTERRUPT__)：使能一个指定的外设中断。

　　__HAL_PPP_DISABLE_IT(__HANDLE__,__INTERRUPT__)：失能一个指定的外设中断。

　　__HAL_PPP_GET_IT(__HANDLE__,__INTERRUPT__)：获得一个指定的外设中断状态。

　　__HAL_PPP_CLEAR_IT(__HANDLE__,__INTERRUPT__)：清除一个指定的外设中断状态。

　　__HAL_PPP_GET_FLAG(__HANDLE__,__FLAG__)：获得一个指定的外设的标志状态。

　　__HAL_PPP_CLEAR_FLAG(__HANDLE__,__FLAG__)：清除一个指定的外设的标志状态。

　　__HAL_PPP_ENABLE(__HANDLE__)：使能外设。

　　__HAL_PPP_DISABLE(__HANDLE__)：失能外设。

　　__HAL_PPP_XXX(__HANDLE__,__PARAM__)：指定外设的宏定义。

　　__HAL_PPP_GET_IT_SOURCE(__HANDLE__,__INTERRUPT__)：检查中断源。

8、HAL库函数中__weak修饰符讲解

　　在HAL库中，很多回调函数前面使用__weak修饰符，weak顾名思义是“弱”的意思，所以一般称加了__weak修饰符的函数为“弱函数”，最终编译器编译的时候，会选择用户自己定义的函数，如果用户没有重新定义这个函数，那么编译器就会执行__weak声明的函数，并且编译不会报错。

　　__weak在回调函数的时候经常用到。这样的好处是，系统默认定义了一个空的回调函数，保证编译器不会报错。同时，如果用户自己要定义用户回调函数，那么只需要重新定义即可，不需要考虑函数重复定义的问题。

9、Msp回调函数执行过程解读

　　当我们调用HAL的外设初始化函数，比如HAL_PPP_Init()(PPP代表某某某外设),那么在HAL_PPP_Init()函数内一般就会包含一个HAL_PPP_MspInit()的函数，该函数就是回调函数。该回调函数一般是一个空函数，而且是用__weak修饰符定义的，没有任何实际的控制逻辑，由于它是用__weak修饰符定义的函数,那么就可以重新定义HAL_PPP_MspInit()函数，最终执行的也是用户重新定义的HAL_PPP_MspInit()函数。

10、系统时钟

　　HAL库的系统时钟是通过SystemClock_Config函数进行初始化的。但是手动移植过来的SystemClock_Config函数并没有配置好。可以通过STM32CubeMX软件进行重新配置。

11、删减工程

　　HAL库包含了很多的功能，所有外设的功能都抽象出来了。在实际应用中有些外设是用不到的，如果把整个HAL库都包含着工程之中，那就会使得编译后的工程很大，不仅编译时间久，占用的资源也多。所以在实际应用中，只要包含有用到的外设功能就可以了了，其他的可以裁剪掉。

　　stm32f1xx_hal_conf.h这个头文件里面引用了HAL库源文件的.h文件。stm32f1xx_hal_conf.h中所定义的一些宏，通过定义宏来判断是否引用所对应的头文件，比如HAL_ADC_MODULE_ENABLED宏，用来确定是否引用头文件“stm32f1xx_hal_adc.h”。如下图所示：

 

　　如果某些外设用不到，可以屏蔽掉该外设所对应的宏使得对应的头文件不被包含。比如如果只用到GPIO口，那么其他外设可以屏蔽掉，但是需要注意的是，就算只用GPIO外设，有一些文件也是要用到的，比如RCC，如果屏蔽掉这些文件，就会造成编译出错。

　　如果实在不知道哪一些文件屏蔽删除会出错，可以逐条屏蔽删除后编译，确认是否会出错。

　　以下是只保留GPIO口功能的工程：

　　从图中可以看到只保留了HAL_MODULE_ENABLED、HAL_CORTEX_MODULE_ENABLED、HAL_FLASH_MODULE_ENABLED、HAL_GPIO_MODULE_ENABLED、HAL_RCC_MODULE_ENABLED这4个宏，其他的都屏蔽掉，编译并没有报错。

　　接下来是删减工程中添加的HAL库.c文件。删减后如下图所示：

　　可以看到HAL-LIBRARY组删除了很多文件，再编译发现也能通过，而且编译的速度比删除前快了很多。