10. 初识STM32标准库¶

在上一章中，我们构建了几个控制GPIO外设的函数，算是实现了函数库的雏形，但GPIO还有很多功能函数我们没有实现，而且STM32芯片不仅仅只有GPIO这一个外设。如果我们想要亲自完成这个函数库，工作量非常巨大。ST公司提供的标准软件库，包含了STM32芯片所有寄存器的控制操作，我们直接学习如何使用ST标准库即可，这会极大地方便我们控制STM32芯片。

10.1. CMSIS标准及库层次关系¶

因为基于Cortex系列芯片采用的内核都是相同的，区别主要为核外的片上外设的差异，这些差异却导致软件在同内核，不同外设的芯片上移植困难。为了解决不同的芯片厂商生产的Cortex微控制器软件的兼容性问题， ARM与芯片厂商建立了CMSIS标准(Cortex MicroController Software Interface Standard)。

所谓CMSIS标准，实际是新建了一个软件抽象层。见图 CMSIS架构。

CMSIS标准中最主要的为CMSIS核心层，它包括了：

内核函数层：其中包含用于访问内核寄存器的名称、地址定义，主要由ARM公司提供。

设备外设访问层：提供了片上的核外外设的地址和中断定义，主要由芯片生产商提供。

可见CMSIS层位于硬件层与操作系统或用户层之间，提供了与芯片生产商无关的硬件抽象层，可以为接口外设、实时操作系统提供简单的处理器软件接口，屏蔽了硬件差异，这对软件的移植是有极大的好处的。STM32的库，就是按照CMSIS标准建立的。

10.1.1. 库目录、文件简介¶

STM32标准库可以从官网获得，也可以直接从本书的配套资料得到。本书讲解的例程全部采用3.5.0库文件。以下内容请大家打开STM32标准库文件配合阅读。

解压库文件后进入其目录：

STM32F10x_StdPeriph_Lib_V3.5.0\

软件库各文件夹的内容说明见图 ST标准库。目录：STM32F10x_StdPeriph_Lib_V3.5.0\

Libraries：文件夹下是驱动库的源代码及启动文件，这个非常重要，我们要使用的固件库就在这个文件夹里面。。
Project ：文件夹下是用驱动库写的例子和工程模板，其中那些为每个外设写好的例程对我们非常有用，我们在学习的时候就可以参考这里面的例程，非常全面，简直就是穷尽了外设的所有功能。
Utilities：包含了基于ST官方实验板的例程，不需要用到，略过即可。
stm32f10x_stdperiph_lib_um.chm：库帮助文档，这个很有用，不喜欢直接看源码的可以在合理查询每个外设的函数说明，非常详细。这是一个已经编译好的HTML文件，主要讲述如何使用驱动库来编写自己的应用程序。说得形象一点，这个HTML就是告诉我们： ST公司已经为你写好了每个外设的驱动了，想知道如何运用这些例子就来向我求救吧。不幸的是，这个帮助文档是英文的，这对很多英文不好的朋友来说是一个很大的障碍。但这里要告诉大家，英文仅仅是一种工具，绝对不能让它成为我们学习的障碍。其实这些英文还是很简单的，我们需要的是拿下它的勇气。

在使用库开发时，我们需要把libraries目录下的库函数文件添加到工程中，并查阅库帮助文档来了解ST提供的库函数，这个文档说明了每一个库函数的使用方法。

进入Libraries文件夹看到，关于内核与外设的库文件分别存放在CMSIS和STM32F10x_StdPeriph_Driver文件夹中。

10.1.1.1. CMSIS文件夹。¶

STM32F10x_StdPeriph_Lib_V3.5.0\Libraries\CMSIS\文件夹展开内容见图 CMSIS文件夹内容。目录：Libraries\CMSIS\

$CMSIS文件夹内容目录：Libraries\CMSIS\\$

其中黄色框框住的是我们需要用到的内容，下面我们一一讲解下这几个文件的作用。

内核相关文件

在CoreSupport文件夹中有core_cm3.c和core_cm3.h两个文件。Core_cm3.h头文件里面实现了内核的寄存器映射，对应外设头文件stm32f10x.h，区别就是一个针对内核的外设，一个针对片上（内核之外）的外设。core_cm3.c文件实现了一下操作内核外设寄存器的函数，用的比较少。

我们还需要了解的是core_cm3.h头文件中包含了“stdint.h” 这个头文件，这是一个ANSI C 文件，是独立于处理器之外的，就像我们熟知的C语言头文件 “stdio.h” 文件一样。位于RVMDK这个软件的安装目录下，主要作用是提供一些类型定义。见代码清单:标准库-1。

代码清单:标准库-1：stdint.h文件中的类型定义¶

/* exact-width signed integer types */
typedef   signed          char int8_t;
typedef   signed short     int int16_t;
typedef   signed           int int32_t;
typedef   signed       __int64 int64_t;

/* exact-width unsigned integer types */
typedef unsigned          char uint8_t;
typedef unsigned short     int uint16_t;
typedef unsigned           int uint32_t;
typedef unsigned       __int64 uint64_t;

这些新类型定义屏蔽了在不同芯片平台时，出现的诸如int的大小是16位，还是32位的差异。所以在我们以后的程序中，都将使用新类型如uint8_t 、uint16_t等。

在稍旧版的程序中还经常会出现如u8、u16、u32这样的类型，分别表示的无符号的8位、16位、32位整型。初学者碰到这样的旧类型感觉一头雾水，它们定义的位置在STM32f10x.h文件中。建议在以后的新程序中尽量使用uint8_t 、uint16_t类型的定义。

启动文件

启动文件放在startup/arm这个文件夹下面，这里面启动文件有很多个，不同型号的单片机用的启动文件不一样，有关每个启动文件的详细说明见表

我们开发板中用的STM32F103VET6或者STM32F103ZET6的FLASH都是512K，属于基本型的大容量产品，启动文件统一选择startup_stm32f10x_hd.s。

Stm32f10x.h

这个头文件实现了片上外设的所有寄存器的映射，是一个非常重要的头文件，在内核中与之想对应的头文件是core_cm3.h。

system_stm32f10x.c

system_stm32f10x.c文件实现了STM32的时钟配置，操作的是片上的RCC这个外设。系统在上电之后，首选会执行由汇编编写的启动文件，启动文件中的复位函数中调用的SystemInit函数就在这个文件里面定义。调用完之后，系统的时钟就被初始化成72M。如果后面我们需要重新配置系统时钟，我们就可以参考这个函数重写。为了维持库的完整性，我们不会直接在这个文件里面修改时钟配置函数。

10.1.1.2. STM32F10x_StdPeriph_Driver文件夹¶

文件目录：Libraries\STM32F10x_StdPeriph_Driver

进入libraries目录下的STM32F10x_StdPeriph_Driver文件夹，见图外设驱动。

STM32F10x_StdPeriph_Driver文件夹下有inc（include的缩写）跟src（source的简写）这两个文件夹，这里的文件属于CMSIS之外的的、芯片片上外设部分。src里面是每个设备外设的驱动源程序，inc则是相对应的外设头文件。src及inc文件夹是ST标准库的主要内容，甚至不少人直接认为ST标准库就是指这些文件，可见其重要性。

在src 和inc文件夹里的就是ST公司针对每个STM32外设而编写的库函数文件，每个外设对应一个 .c 和 .h 后缀的文件。我们把这类外设文件统称为：stm32f10x_ppp.c或stm32f10x_ppp.h文件，PPP表示外设名称。如在上一章中我们自建的stm32f10x_gpio.c及stm32f10x_gpio.h文件，就属于这一类。

如针对模数转换(ADC)外设，在src文件夹下有一个stm32f10x_adc.c源文件，在inc文件夹下有一个stm32f10x_adc.h头文件，若我们开发的工程中用到了STM32内部的ADC，则至少要把这两个文件包含到工程里。见图驱动的源文件及头文件。

这两个文件夹中，还有一个很特别的misc.c文件，这个文件提供了外设对内核中的NVIC(中断向量控制器)的访问函数，在配置中断时，我们必须把这个文件添加到工程中。

10.1.1.3. stm32f10x_it.c、 stm32f10x_conf.h和system_stm32f10x.c文件¶

文件目录：STM32F10x_StdPeriph_Lib_V3.5.0\Project\STM32F10x_StdPeriph_Template

在这个文件目录下，存放了官方的一个库工程模板，我们在用库建立一个完整的工程时，还需要添加这个目录下的stm32f10x_it.c、 stm32f10x_it.h、stm32f10x_conf.h和system_stm32f10x.c这四个文件。

stm32f10x_it.c：这个文件是专门用来编写中断服务函数的，在我们修改前，这个文件已经定义了一些系统异常(特殊中断)的接口，其它普通中断服务函数由我们自己添加。但是我们怎么知道这些中断服务函数的接口如何写？是不是可以自定义呢？答案当然不是，这些都可以在汇编启动文件中找到，在学习中断和启动文件的时候我们会详细介绍

system_stm32f10x.c：这个文件包含了STM32芯片上电后初始化系统时钟、扩展外部存储器用的函数，例如我们前两章提到供启动文件调用的“SystemInit”函数，用于上电后初始化时钟，该函数的定义就存储在system_stm32f10x.c文件。 STM32F103系列的芯片，调用库的这个SystemInit函数后，系统时钟被初始化为72MHz，如有需要可以修改这个文件的内容，设置成自己所需的时钟频率，但鉴于保持库的完整性，我们在做系统时钟配置的时候会另外重写时钟配置函数。

stm32f10x_conf.h：这个文件被包含进stm32f10x.h 文件。当我们使用固件库编程的时候，如果需要某个外设的驱动库，就需要包含该外设的头文件：stm32f10x_ppp.h，包含一个还好，如果是用了多外设，就需要包含多个头文件，这不仅影响代码美观也不好管理，现我们用一个头文件stm32f10x_conf.h把这些外设的头文件都包含在里面，让这个配置头文件统一管理这些外设的头文件，我们在应用程序中只需要包含这个配置头文件即可，我们又知道这个头文件在stm32f10x.h的最后被包含，所以最终我们只需要包含stm32f10x.h这个头文件即可，非常方便。Stm32f10x_conf.h见代码清单:标准库-2。默认情况下是所以头文件都被包含，没有被注释掉。我们也可以把不要的都注释掉，只留下需要使用的即可。

代码清单:标准库-2 stm32f10x_conf.h文件配置软件库¶

#include "stm32f10x_adc.h"
#include "stm32f10x_bkp.h"
#include "stm32f10x_can.h"
#include "stm32f10x_cec.h"
#include "stm32f10x_crc.h"
#include "stm32f10x_dac.h"
#include "stm32f10x_dbgmcu.h"
#include "stm32f10x_dma.h"
#include "stm32f10x_exti.h"
#include "stm32f10x_flash.h"
#include "stm32f10x_fsmc.h"
#include "stm32f10x_gpio.h"
#include "stm32f10x_i2c.h"
#include "stm32f10x_iwdg.h"
#include "stm32f10x_pwr.h"
#include "stm32f10x_rcc.h"
#include "stm32f10x_rtc.h"
#include "stm32f10x_sdio.h"
#include "stm32f10x_spi.h"
#include "stm32f10x_tim.h"
#include "stm32f10x_usart.h"
#include "stm32f10x_wwdg.h"
#include "misc.h"

stm32f10x_conf.h这个文件还可配置是否使用“断言”编译选项，见代码清单:标准库-3。

代码清单:标准库-3 断言配置¶

#ifdef  USE_FULL_ASSERT

    /**
    * @brief  The assert_param macro is used for  parameters check.
    * @param  expr: If expr is false, it calls assert_failed function
    *   which reports the name of the source file and the source
    *   line number of the call that failed.
    *   If expr is true, it returns no value.
    * @retval None
    */
    #define assert_param(expr) ((expr) ? (void)0 : assert_failed((uint8_t *)__FILE__, __LINE__))
    /* Exported functions ---------------------------------- */
    void assert_failed(uint8_t* file, uint32_t line);
    #else
    #define assert_param(expr) ((void)0)
    #endif /* USE_FULL_ASSERT */

在ST标准库的函数中，一般会包含输入参数检查，即上述代码中的“assert_param”宏，当参数不符合要求时，会调用“assert_failed”函数，这个函数默认是空的。

实际开发中使用断言时，先通过定义USE_FULL_ASSERT宏来使能断言，然后定义“assert_failed”函数，通常我们会让它调用printf函数输出错误说明。使能断言后，程序运行时会检查函数的输入参数，当软件经过测试，可发布时，会取消USE_FULL_ASSERT宏来去掉断言功能，使程序全速运行。

10.1.2. 库各文件间的关系¶

前面向大家简单介绍了各个库文件的作用，库文件是直接包含进工程即可，丝毫不用修改，而有的文件就要我们在使用的时候根据具体的需要进行配置。接下来从整体上把握一下各个文件在库工程中的层次或关系，这些文件对应到CMSIS标准架构上。见图库各文件关系。

图库各文件关系描述了STM32库各文件之间的调用关系，在实际的使用库开发工程的过程中，我们把位于CMSIS层的文件包含进工程，除了特殊系统时钟需要修改system_stm32f10x.c，其它文件丝毫不用修改，也不建议修改。

对于位于用户层的几个文件，就是我们在使用库的时候，针对不同的应用对库文件进行增删（用条件编译的方法增删）和改动的文件。

10.2. 使帮助文档¶

我们知道，授之以鱼不如授之以渔。官方资料是所有关于STM32知识的源头，所以在本小节介绍如何使用官方资料。官方的帮助手册，是最好的教程，几乎包含了所有在开发过程中遇到的问题。这些资料已整理到了本书附录资料中。

10.2.1. 常用官方资料¶

《STM32F10X-中文参考手册》

这个文件全方位介绍了STM32芯片的各种片上外设，它把STM32的时钟、存储器架构、及各种外设、寄存器都描述得清清楚楚。当我们对STM32的外设感到困惑时，可查阅这个文档。以直接配置寄存器方式开发的话，查阅这个文档寄存器部分的频率会相当高，但这样效率太低了。
《STM32规格书》

本文档相当于STM32的datasheet，包含了STM32芯片所有的引脚功能说明及存储器架构、芯片外设架构说明。后面我们使用STM32其它外设时，常常需要查找这个手册，了解外设对应到STM32的哪个GPIO引脚。
《Cortex™-M3内核编程手册》

本文档由ST公司提供，主要讲解STM32内核寄存器相关的说明，例如系统定时器、NVIC等核外设的寄存器。这部分的内容是《STM32F10X-中文参考手册》没涉及到的内核部分的补充。相对来说，本文档虽然介绍了内核寄存器，但不如以下两个文档详细，要了解内核时，可作为以下两个手册的配合资料使用。
《Cortex-M3权威指南》。

这个手册是由ARM公司提供的，它详细讲解了Cortex内核的架构和特性，要深入了解Cortex-M内核，这是首选，经典中的经典。这个手册也被翻译成中文，出版成书，我们配套的资料里面有提供中文版的电子版。
《stm32f10x_stdperiph_lib_um.chm》

这个就是本章提到的库的帮助文档，在使用库函数时，我们最好通过查阅此文件来了解标准库提供了哪些外设、函数原型或库函数的调用的方法。也可以直接阅读源码里面的函数的函数说明。

10.2.2. 初识库函数¶

所谓库函数，就是STM32的库文件中为我们编写好驱动外设的函数接口，我们只要调用这些库函数，就可以对STM32进行配置，达到控制目的。我们可以不知道库函数是如何实现的，但我们调用函数必须要知道函数的功能、可传入的参数及其意义、和函数的返回值。

于是，有读者就问那么多函数我怎么记呀？我的回答是：会查就行了，哪个人记得了那么多。所以我们学会查阅库帮助文档是很有必要的。

打开库帮助文档《stm32f10x_stdperiph_lib_um.chm》见图库帮助文档

层层打开文档的目录标签：

标签目录：Modules\STM32F10x_StdPeriph_Driver\

可看到STM32F10x _StdPeriph_Driver标签下有很多外设驱动文件的名字MISC、ADC、BKP、CAN等标签。

我们试着查看GPIO的“位设置函数GPIO_SetBits”看看，打开标签：

标签目录：Modules\STM32F10x_StdPeriph_Driver\GPIO\Functions\GPIO_SetBits 见图库帮助文档的函数说明。

利用这个文档，我们即使没有去看它的具体源代码，也知道要怎么利用它了。

如GPIO_SetBits，函数的原型为void GPIO_SetBits(GPIO_TypeDef * GPIOx , uint16_t GPIO_Pin)。它的功能是：输入一个类型为GPIO_TypeDef的指针GPIOx参数，选定要控制的GPIO端口；输入GPIO_Pin_x宏，其中x指端口的引脚号，指定要控制的引脚。

其中输入的参数 GPIOx为ST标准库中定义的自定义数据类型，这两个传入参数均为结构体指针。初学时，我们并不知道如GPIO_TypeDef这样的类型是什么意思，可以点击函数原型中带下划线的 GPIO_TypeDef 就可以查看这个类型的声明了。

就这样初步了解了一下库函数，读者就可以发现STM32的库是写得很优美的。每个函数和数据类型都符合见名知义的原则，当然，这样的名称写起来特别长，而且对于我们来说要输入这么长的英文，很容易出错，所以在开发软件的时候，在用到库函数的地方，直接把库帮助文档中的函数名称复制粘贴到工程文件就可以了。而且，配合MDK软件的代码自动补全功能，可以减少输入量。

有的用户觉得使用库文档麻烦，也可以直接查阅STM32标准库的源码，库帮助文档的说明都是根据源码生成的，所以直接看源码也可以了解函数功能。