STM32固件库使用说明材料的中文翻译.doc

, UM0427用户手册 32位基于ARM微控制器STM32F101xx与STM32F103xx 固件函数库 介绍本手册介绍了32位基于ARM微控制器STM32F101xx与STM32F103xx的固件函数库。该函数库是一个固件函数包，它由程序、数据结构和宏组成，包括了微控制器所有外设的性能特征。该函数库还包括每一个外设的驱动描述和应用实例。通过使用本固件函数库，无需深入掌握细节，用户也可以轻松应用每一个外设。因此，使用本固态函数库可以大大减少用户的程序编写时间，进而降低开发成本。每个外设驱动都由一组函数组成，这组函数覆盖了该外设所有功能。每个器件的开发都由一个通用API (application programming interface 应用编程界面)驱动，API对该驱动程序的结构，函数和参数名称都进行了标准化。所有的驱动源代码都符合“Strict ANSI-C”标准（项目于范例文件符合扩充ANSI-C标准）。我们已经把驱动源代码文档化，他们同时兼容MISRA-C 2004标准（根据需要，我们可以提供兼容矩阵）。由于整个固态函数库按照“Strict ANSI-C”标准编写，它不受不同开发环境的影响。仅对话启动文件取决于开发环境。该固态函数库通过校验所有库函数的输入值来实现实时错误检测。该动态校验提高了软件的鲁棒性。实时检测适合于用户应用程序的开发和调试。但这会增加了成本，可以在最终应用程序代码中移去，以优化代码大小和执行速度。想要了解更多细节，请参阅Section 2.5。因为该固件库是通用的，并且包括了所有外设的功能，所以应用程序代码的大小和执行速度可能不是最优的。对大多数应用程序来说，用户可以直接使用之，对于那些在代码大小和执行速度方面有严格要求的应用程序，该固件库驱动程序可以作为如何设置外设的一份参考资料，根据实际需求对其进行调整。 此份固件库用户手册的整体架构如下：n 定义，文档约定和固态函数库规则。 n 固态函数库概述（包的内容，库的架构），安装指南，库使用实例。n 固件库具体描述：设置架构和每个外设的函数。 STM32F101xx和STM32F103xx在整个文档中被写作STM32F101x。,1.文档和库规范本用户手册和固态函数库按照以下章节所描述的规范编写。1.1 缩写Table 1. 本文档所有缩写定义缩写外设/单元ADC模数转换器BKP备份寄存器CAN控制器局域网模块DMA直接内存存取控制器EXTI外部中断事件控制器FLASH闪存存储器GPIO通用输入输出I2C内部集成电路IWDG独立看门狗NVIC嵌套中断向量列表控制器PWR电源/功耗控制RCC复位与时钟控制器RTC实时时钟SPI串行外设接口SysTick系统嘀嗒定时器TIM通用定时器TIM1高级控制定时器USART通用同步异步接收发射端WWDG窗口看门狗1.2 命名规则固态函数库遵从以下命名规则：PPP表示任一外设缩写，例如：ADC。更多缩写相关信息参阅章节1.1 缩写。系统、源程序文件和头文件命名都以“stm32f10x_”作为开头，例如：stm32f10x_conf.h。常量仅被应用于一个文件的，定义于该文件中；被应用于多个文件的，在对应头文件中定义。所有常量都由英文字母大写书写。寄存器作为常量处理。他们的命名都由英文字母大写书写。在大多数情况下，他们采用与缩写规范与本用户手册一致。外设函数的命名以该外设的缩写加下划线为开头。每个单词的第一个字母都由英文字母大写书写，例如：SPI_SendData。在函数名中，只允许存在一个下划线，用以分隔外设缩写和函数名的其它部分。名为PPP_Init的函数，其功能是根据PPP_InitTypeDef中指定的参数，初始化外设PPP，例如TIM_Init.名为PPP_DeInit的函数，其功能为复位外设PPP的所有寄存器至缺省值，例如TIM_DeInit.名为PPP_StructInit的函数，其功能为通过设置PPP_InitTypeDef 结构中的各种参数来定义外设的功能，例如：USART_StructInit.名为PPP_Cmd的函数，其功能为使能或者失能外设PPP，例如： SPI_Cmd.名为PPP_ITConfig的函数，其功能为使能或者失能来自外设PPP某中断源，例如： RCC_ITConfig.名为PPP_DMAConfig的函数，其功能为使能或者失能外设PPP的DMA接口，例如：TIM1_DMAConfig.用以配置外设功能的函数，总是以字符串“Config”结尾，例如GPIO_PinRemapConfig.名为PPP_GetFlagStatus的函数，其功能为检查外设PPP某标志位被设置与否，例如：I2C_GetFlagStatus.名为PPP_ClearFlag的函数，其功能为清除外设PPP标志位，例如：I2C_ClearFlag.名为PPP_GetITStatus的函数，其功能为判断来自外设PPP的中断发生与否，例如：I2C_GetITStatus.名为PPP_ClearITPendingBit的函数，其功能为清除外设PPP中断待处理标志位，例如： I2C_ClearITPendingBit.1.3 编码规则本章节描述了固态函书库的编码规则。1.3.1变量固态函数库定义了24个变量类型，他们的类型和大小是固定的。在文件stm32f10x_type.h中我们定义了这些变量：typedef signed long s32;typedef signed short s16;typedef signed char s8;typedef signed long const sc32; /* Read Only */typedef signed short const sc16; /* Read Only */typedef signed char const sc8; /* Read Only */typedef volatile signed long vs32;typedef volatile signed short vs16;typedef volatile signed char vs8;typedef volatile signed long const vsc32; /* Read Only */typedef volatile signed short const vsc16; /* Read Only */typedef volatile signed char const vsc8; /* Read Only */typedef unsigned long u32;typedef unsigned short u16;typedef unsigned char u8;typedef unsigned long const uc32; /* Read Only */typedef unsigned short const uc16; /* Read Only */typedef unsigned char const uc8; /* Read Only */typedef volatile unsigned long vu32;typedef volatile unsigned short vu16;typedef volatile unsigned char vu8;typedef volatile unsigned long const vuc32; /* Read Only */typedef volatile unsigned short const vuc16; /* Read Only */typedef volatile unsigned char const vuc8; /* Read Only */1.3.2布尔型在文件stm32f10x_type.h中，布尔形变量被定义如下：Typedef enumFALSE = 0,TRUE = !FALSE bool;1.3.3 标志位状态类型在文件stm32f10x_type.h中，我们定义标志位类型（FlagStatus type）的2个可能值为“设置”与“重置”（SET or RESET）。typedef enumRESET = 0, SET = !RESET FlagStatus;1.3.4 功能状态类型在文件stm32f10x_type.h中，我们定义功能状态类型（FunctionalState type）的2个可能值为“使能”与“失能”（ENABLE or DISABLE）。typedef enumDISABLE = 0,ENABLE = !DISABLE FunctionalState;1.3.5 错误状态类型在文件stm32f10x_type.h中，我们错误状态类型类型（ErrorStatus type）的2个可能值为“成功”与“出错”（SUCCESS or ERROR）。Typedef enum ERROR = 0,SUCCESS = !ERROR ErrorStatus;1.3.6 外设用户可以通过指向各个外设的指针访问各外设的控制寄存器。这些指针所指向的数据结构与各个外设的控制寄存器布局一一对应。外设控制寄存器结构文件stm32f10x_map.h包含了所有外设控制寄存器的结构，下例为SPI寄存器结构的声明：/*- Serial Peripheral Interface -*/typedef structvu16 CR1; u16 RESERVED0;vu16 CR2;u16 RESERVED1;vu16 SR;u16 RESERVED2;vu16 DR;u16 RESERVED3;vu16 CRCPR;u16 RESERVED4;vu16 RXCRCR;u16 RESERVED5;vu16 TXCRCR;u16 RESERVED6; SPI_TypeDef;寄存器命名遵循上节的寄存器缩写命名规则。RESERVEDi（i为一个整数索引值）表示被保留区域。外设声明文件stm32f10x_map.h包含了所有外设的声明，下例为SPI外设的声明：#ifndef EXT#Define EXT extern#endif.#define PERIPH_BASE (u32)0x40000000)#define APB1PERIPH_BASE PERIPH_BASE#define APB2PERIPH_BASE (PERIPH_BASE + 0x10000)./* SPI2 Base Address definition*/#define SPI2_BASE (APB1PERIPH_BASE + 0x3800)./* SPI2 peripheral declaration*/#ifndef DEBUG.#ifdef _SPI2 #define SPI2 (SPI_TypeDef *) SPI2_BASE)#endif /*_SPI2 */.#else /* DEBUG */. #ifdef _SPI2 EXT SPI_TypeDef *SPI2;#endif /*_SPI2 */.#endif /* DEBUG */如果用户希望使用外设SPI，那么必须在文件stm32f10x_conf.h中定义_SPI标签。通过定义标签_SPIn，用户可以访问外设SPIn的寄存器。例如，用户必须在文件stm32f10x_conf.h中定义标签_SPI2，否则是不能访问SPI2的寄存器的。在文件stm32f10x_conf.h中，用户可以按照下例定义标签_SPI 和_SPIn。#define _SPI #define _SPI1 #define _SPI2每个外设都有若干寄存器专门分配给标志位。我们按照相应的结构定义这些寄存器。标志位的命名，同样遵循上节的外设缩写规范，以PPP_FLAG_开始。对于不同的外设，标志位都被定义在相应的文件stm32f10x_ppp.h中。用户想要进入除错（DEBUG）模式的话，必须在文件stm32f10x_conf.h中定义标签DEBUG。这样会在SRAM的外设结构部分创建一个指针。因此我们可以简化除错过程，并且通过转储外设获得来获得所有寄存器的状态。在所有情况下，SPI2都是一个指向外设SPI2首地址的指针。变量DEBUG可以仿照下例定义：#define DEBUG 1可以初始化DEBUG模式与文件stm32f10x_lib.c中如下：#ifdef DEBUGvoid debug(void) .#ifdef _SPI2SPI2 = (SPI_TypeDef *) SPI2_BASE;#endif /*_SPI2 */. #endif /* DEBUG*/Note：1 当用户选择DEBUG模式，宏assert_param被扩展，同时运行时间检查功能也在固态函数库代码中被激活。2 进入DEBUG模式会增大代码的尺寸，降低代码的运行效率。因此，我们强烈建议仅仅在除错的时候使用相应代码，在最终的应用程序中，删除它们。,2. 固件函数库2.1 压缩包描述STM32F10x固件函数库被压缩在一个zip文件中。解压该文件会产生一个文件夹：STM32F10xFWLibFWLib，包含如下所示的子文件夹：Figure 1：固件函数库文件夹结构2.1.1 文件夹Examples文件夹Examples，对应每一个STM32外设，都包含一个子文件夹。这些子文件夹包含了整套文件，组成典型的例子，来示范如何使用对应外设。这些文件有：readme.txt：每个例子的简单描述和使用说明。stm32f10x_conf.h：该头文件设置了所有使用到的外设，由不同的“DEFINE”语句组成。stm32f10x_it.c：该源文件包含了所有的中断处理程序（如果未使用中断，则所有的函数体都为空）。stm32f10x.it.h：该头文件包含了所有的中断处理程序的原形。main.c：例程代码。注：所有的例程的使用，都不受不同软件开发环境的影响。2.1.2 文件夹Library文件夹Library包含组成固件函数库核心的所有子文件夹和文件：n 子文件夹inc包含了固件函数库所需的头文件，用户无需修改该文件夹：-stm32f10x_type.h：所有其他文件使用的通用数据类型和枚举。- stm32f10x_map.h：外设存储器映像和寄存器数据结构。- stm32f10x_lib.h：主头文件夹，包含了其他头文件。- stm32f10x_ppp.h：每个外设对应一个头文件，包含了该外设使用的函数原形，数据结构和枚举。- cortexm3_macro.h： 文件cortexm3_macro.s对应的头文件。n 子文件夹src包含了固件函数库所需的源文件，用户无需修改该文件夹：-stm32f10x_ppp.c：每个外设对应一个源文件，包含了该外设使用的函数体。- stm32f10x_lib.c：初始化所有外设的指针。注：所有代码都按照Strict ANSI-C标准书写，都不受不同软件开发环境的影响。2.1.3 文件夹Project文件夹Project包含了一个标准的程序项目模板，包括库文件的编译和所有用户可修改的文件，可用以建立新的工程。- stm32f10x_conf.h：项目配置头文件，默认为设置了所有的外设。- stm32f10x_it.c：该源文件包含了所有的中断处理程序（所有的函数体默认为空）。stm32f10x_it.h：该头文件包含了所有的中断处理程序的原形。main.c：主函数体文件夹EWARM，RVMDK，RIDE：用于不同开发环境使用，详情查询各文件夹下的文件readme.txt。2.2 固件函数库文件描述Table 2列举和描述了固件函数库使用的所有文件。固件函数库的体系和文件相互包括的联系表示在Figure 2中。每一个外设都有一个对应的源文件：stm32f10x_ppp.c和一个对应的头文件：stm32f10x_ppp.h。文件stm32f10x_ppp.c包含了使用外设PPP所需的所有固件函数。提供所有外设一个存储器映像文件stm32f10x_map.h。它包含了所有寄存器的声明，既可以用于Debug模式也可以用于release模式。头文件stm32f10x_lib.h包含了所有外设头文件的头文件。它是唯一一个用户需要包括在自己应用中的文件，起到应用和库之间界面的作用。文件stm32f10x_conf.h是唯一一个需要由用户修改的文件。它作为应用和库之间的界面，指定了一系列参数。Table 2. 固件函数库文件描述文件名描述stm32f10x_conf.h参数设置文件，起到应用和库之间界面的作用。用户必须在运行自己的程序前修改该文件。 用户可以利用模板使能或者失能外设。也可以修改外部晶振的参数。也可以是用该文件在编译前使能Debug或者release模式。main.c主函数体示例。stm32f10x_it.h头文件，包含所有中断处理函数原形。stm32f10x_it.c外设中断函数文件。用户可以加入自己的中断程序代码。对于指向同一个中断向量的多个不同中断请求，可以利用函数通过判断外设的中断标志位来确定准确的中断源。固件函数库提供了这些函数的名称。stm32f10x_lib.h包含了所有外设的头文件的头文件。它是唯一一个用户需要包括在自己应用中的文件，起到应用和库之间界面的作用。stm32f10x_lib.cDebug模式初始化文件。它包括多个指针的定义，每个指针指向特定外设的首地址，以及在Debug模式被使能时，被调用的函数的定义。stm32f10x_map.h该文件包含了存储器映像和所有寄存器物理地址的声明，既可以用于Debug模式也可以用于release模式。所有外设都使用该文件。stm32f10x_type.h通用声明文件。包含所有外设驱动使用的通用类型和常数。stm32f10x_ppp.c由C语言编写的外设PPP的驱动源程序文件。stm32f10x_ppp.h外设PPP的头文件。包含外设PPP函数的定义，和这些函数使用的变量。cortexm3_macro.h文件cortexm3_macro.s的头文件cortexm3_macro.sCortex-M3内核特殊指令的指令包装。Figure 2. 固件函数库文件体系结构2.3 外设的初始化和设置本节按步骤描述了如何初始化和设置任意外设。这里PPP代表任意外设。1.在主应用文件中，声明一个结构PPP_InitTypeDef，例如：PPP_InitTypeDef PPP_InitStructure;这里PPP_InitStructure是一个位于内存中的工作变量，用来初始化一个或者多个外设PPP。2.为变量PPP_InitStructure的各个结构成员填入允许的值。可以采用以下2种方式：a）按照如下程序设置整个结构体PPP_InitStructure.member1=val1; PPP_InitStructure.member2 = val2;PPP_InitStructure.memberN = valN;/* where N is the number of the structure members */以上步骤可以合并在同一行里，用以优化代码大小：PPP_InitTypeDef PPP_InitStructure = val1, val2,., valNb）仅设置结构体中的部分成员：这种情况下，用户应当首先调用函数PPP_SturcInit(.)来初始化变量PPP_InitStructure，然后再修改其中需要修改的成员。这样可以保证其他成员的值（多为缺省值）被正确填入。PPP_StructInit(&PPP_InitStructure);PP_InitStructure.memberX = valX;PPP_InitStructure.memberY = valY;/*where X and Y are the members the user wants to configure*/3. 调用函数PPP_Init(.)来初始化外设PPP。4. 在这一步，外设PPP已被初始化。可以调用函数PPP_Cmd(.)来使能之。PPP_Cmd(PPP, ENABLE);可以通过调用一系列函数来使用外设。每个外设都拥有各自的功能函数。更多细节参阅 Section3 外设固件概述。注：1. 在设置一个外设前，必须调用以下一个函数来使能它的时钟：RCC_AHBPeriphClockCmd(RCC_AHBPeriph_PPPx, ENABLE); RCC_APB2PeriphClockCmd(RCC_APB2Periph_PPPx, ENABLE); RCC_APB1PeriphClockCmd(RCC_APB1Periph_PPPx, ENABLE);2. 可以调用函数PPP_Deinit(.)来把外设PPP的所有寄存器复位为缺省值：PPP_DeInit(PPP)3. 在外设设置完成以后，继续修改它的一些参数，可以参照如下步骤：PPP_InitStucture.memberX = valX; PPP_InitStructure.memberY = valY; /* where X and Y are the onlymembers that user wants to modify*/PPP_Init(PPP, &PPP_InitStructure);2.4 位段（Bit-Banding）Cortex-M3 存储器映像包括两个位段(bit-band)区。这两个位段区将别名存储器区中的每个字映射到位段存储器区的一个位，在别名存储区写入一个字具有对位段区的目标位执读-改-写操作的相同效果。所有STM32F10x外设寄存器都被映射到一个位段(bit-band)区。这个特性在各个函数中对单个比特进行置1/置0操作时被大量使用，用以减小和优化代码尺寸。Section 2.4.1和Section 2.4.2给出了外设固件函数库中如何实现位段访问的描述。2.4.1 映射公式映射公式给出别名区中的每个字是如何对应位带区的相应位的，公式如下：bit_word_offset = (byte_offset x 32) + (bit_number 4)bit_word_addr = bit_band_base + bit_word_offset其中：bit_word_offset是目标位在存取器位段区中的位置。bit_word_addr 是别名存储器区中字的地址，它映射到某个目标位。bit_band_base 是别名区的起始地址。byte_offset 是包含目标位的字节在位段的序号。bit_number 是目标位所在位置（0-31）。2.4.2 应用实例下例展现了如何把寄存器RCC_CR的PLLON24位，映射到别名区：/* Peripheral base address in the bit-band region */#define PERIPH_BASE (u32)0x40000000)/* Peripheral address in the alias region */#define PERIPH_BB_BASE (u32)0x42000000)/* - RCC registers bit address in the alias region - */#define RCC_OFFSET (RCC_BASE - PERIPH_BASE)/* - CR Register -*/* Alias word address of PLLON bit */#define CR_OFFSET (RCC_OFFSET + 0x00)#define PLLON_BitNumber 0x18#define CR_PLLON_BB (PERIPH_BB_BASE + (CR_OFFSET * 32(PLLON_BitNumber * 4)编写一个使能/失能PLL的函数，步骤如下：.#define CR_PLLON_Set (u32)0x01000000)#define CR_PLLON_Reset (u32)0xFEFFFFFF).void RCC_PLLCmd(FunctionalState NewState)if (NewState != DISABLE) /* Enable PLL */RCC->CR |= CR_PLLON_Set; else /* Disable PLL */RCC->CR &= CR_PLLON_Reset; Using bit-band access this function will be coded as follows:void RCC_PLLCmd(FunctionalState NewState)*(vu32 *) CR_PLLON_BB = (u32)NewState;2.5 运行时间检测固件函数库通过检查库函书的输入来实现运行时间错误侦测。通过使用宏assert_param来实现运行时间检测。所有要求输入参数的函数都使用这个宏。它可以检查输入参数是否在允许的范围之内。例：函数PWR_ClearFlagstm32f10x_pwr.c:void PWR_ClearFlag(u32 PWR_FLAG)/* Check the parameters */assert_param(IS_PWR_CLEAR_FLAG(PWR_FLAG);PWR->CR |= PWR_FLAG << 2;stm32f10x_pwr.h:/* PWR Flag */#define PWR_FLAG_WU (u32)0x00000001) #define PWR_FLAG_SB (u32)0x00000002) #define PWR_FLAG_PVDO (u32)0x00000004)#define IS_PWR_CLEAR_FLAG(FLAG) (FLAG = PWR_FLAG_WU) | (FLAG = PWR_FLAG_SB)如果传给宏assert_param的参数为false，则调用函数assert_failed并返回被错误调用的函数所在的文件名和行数。如果传给宏assert_param的参数为true，则无返回值。宏assert_param编写于文件stm32f10x_conf.h中：/* Exported macro -*/#ifdef DEBUG/* * * Macro Name : assert_param * Description : The assert_param macro is used for functions parameters check.* It is used only if the library is compiled in DEBUG mode.* Input : - 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. * Return : None */#define assert_param(expr) (expr) ? (void)0 : assert_failed(u8 *)_FILE_, _LINE_)/* Exported functions - */void assert_failed(u8* file, u32 line);#else#define assert_param(expr) (void)0)#endif /* DEBUG */函数assert_failed编写于文件main.c或者其他用户C文件：#ifdef DEBUG/* * Function name : assert_failed * Description : Reports the name of the source file and the source line number.* where the assert_param error has occurred.* Input : - file: pointer to the source file name * - line: assert_param error line source number* Output : None * Return : None */void assert_failed(u8* file, u32 line)/* User can add his own implementation to report the file name and line number, ex: printf("Wrong parameters value: file %s on line %drn", file, line) */* Infinite loop */while (1) #endif注：运行时间检查，即宏assert_param应当只在库在Debug模式下编译时使用。建议在用户应用代码的开发和调试阶段使用运行时间检查，在最终的代码中去掉它们以改进代码尺寸和速度。如果用户仍然希望在最终的代码中保留这项功能，可以在调用库函数前，重新使用宏assert_param来测试输入参数。,3. 外设固件概述本节系统描述了每一个外设固件函数库。完整地描述所有相关函数并提供如何使用他们的例子。 函数的描述按如下格式进行：Table 3. 函数描述格式函数名外设函数的名称函数原形原形声明功能描述简要解释函数是如何执行的输入参数x输入参数描述输出参数x输出参数描述返回值函数的返回值先决条件调用函数前应满足的要求被调用函数其他被该函数调用的库函数,4. 模拟/数字转换器4.1 ADC寄存器结构4.2 ADC库函数5. 备份寄存器（BKP）5.1 BKP寄存器结构5.2 BKP库函数6 控制器局域网（CAN）6.1 CAN寄存器结构6.2 CAN库函数7 DMA控制器（DMA）7.1 DMA寄存器结构7.2 DMA库函数8 外部中断/事件控制器（EXTI）8.1 EXTI寄存器结构8.2 EXTI库函数9 FLASH存储器(FLASH)9.1 FLASH寄存器结构9.2 FLASH库函数,10 通用输入/输出（GPIO）GPIO驱动可以用作多个用途，包括管脚设置，单位设置/重置，锁定机制，从端口管脚读入或者向端口管脚写入数据。Section 10.1 GPIO寄存器结构描述了固件函数库所使用的数据结构，Section 10.2 固件库函数介绍了函数库里的所有函数。10.1 GPIO寄存器结构GPIO寄存器结构，GPIO_TypeDef和AFIO_TypeDef，在文件“stm32f10x_map.h”中定义如下：typedef struct vu32 CRL; vu32 CRH; vu32 IDR; vu32 ODR; vu32 BSRR; vu32 BRR; vu32 LCKR; GPIO_TypeDefTypedef structvu32 EVCR; vu32 MAPR; vu32 EXTICR4; AFIO_TypeDef;Table 178.例举了GP