STM32固件库使用手册的中文翻译文档格式.docx

STM32固件库使用手册的中文翻译文档格式.docx

《STM32固件库使用手册的中文翻译文档格式.docx》由会员分享，可在线阅读，更多相关《STM32固件库使用手册的中文翻译文档格式.docx（91页珍藏版）》请在冰豆网上搜索。

想要了解更多细节，请参阅Section2.5。

因为该固件库是通用的，并且包括了所有外设的功能，所以应用程序代码的大小和执行速度可能不是最优的。

对大多数应用程序来说，用户可以直接使用之，对于那些在代码大小和执行速度方面有严格要求的应用程序，该固件库驱动程序可以作为如何设置外设的一份参考资料，根据实际需求对其进行调整。

此份固件库用户手册的整体架构如下：

定义，文档约定和固态函数库规则。

固态函数库概述（包的内容，库的架构），安装指南，库使用实例。

固件库具体描述：

设置架构和每个外设的函数。

STM32F101xx和STM32F103xx在整个文档中被写作STM32F101x。

1.文档和库规范

本用户手册和固态函数库按照以下章节所描述的规范编写。

1.1缩写

Table1.本文档所有缩写定义

缩写

外设/单元

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中我们定义了这些变量：

typedefsignedlongs32;

typedefsignedshorts16;

typedefsignedchars8;

typedefsignedlongconstsc32;

/*ReadOnly*/

typedefsignedshortconstsc16;

typedefsignedcharconstsc8;

typedefvolatilesignedlongvs32;

typedefvolatilesignedshortvs16;

typedefvolatilesignedcharvs8;

typedefvolatilesignedlongconstvsc32;

typedefvolatilesignedshortconstvsc16;

typedefvolatilesignedcharconstvsc8;

typedefunsignedlongu32;

typedefunsignedshortu16;

typedefunsignedcharu8;

typedefunsignedlongconstuc32;

typedefunsignedshortconstuc16;

typedefunsignedcharconstuc8;

typedefvolatileunsignedlongvu32;

typedefvolatileunsignedshortvu16;

typedefvolatileunsignedcharvu8;

typedefvolatileunsignedlongconstvuc32;

typedefvolatileunsignedshortconstvuc16;

typedefvolatileunsignedcharconstvuc8;

1.3.2布尔型

在文件stm32f10x_type.h中，布尔形变量被定义如下：

Typedefenum

{

FALSE=0,

TRUE=!

FALSE

}bool;

1.3.3标志位状态类型

在文件stm32f10x_type.h中，我们定义标志位类型（FlagStatustype）的2个可能值为“设置”与“重置”（SETorRESET）。

typedefenum

RESET=0,

SET=!

RESET

}FlagStatus;

1.3.4功能状态类型

在文件stm32f10x_type.h中，我们定义功能状态类型（FunctionalStatetype）的2个可能值为“使能”与“失能”（ENABLEorDISABLE）。

DISABLE=0,

ENABLE=!

DISABLE

}FunctionalState;

1.3.5错误状态类型

在文件stm32f10x_type.h中，我们错误状态类型类型（ErrorStatustype）的2个可能值为“成功”与“出错”（SUCCESSorERROR）。

Typedefenum

ERROR=0,

SUCCESS=!

ERROR

}ErrorStatus;

1.3.6外设

用户可以通过指向各个外设的指针访问各外设的控制寄存器。

这些指针所指向的数据结构与各个外设的控制寄存器布局一一对应。

外设控制寄存器结构

文件stm32f10x_map.h包含了所有外设控制寄存器的结构，下例为SPI寄存器结构的声明：

/*--------------------------------SerialPeripheralInterface-----------------------------*/

typedefstruct

vu16CR1;

u16RESERVED0;

vu16CR2;

u16RESERVED1;

vu16SR;

u16RESERVED2;

vu16DR;

u16RESERVED3;

vu16CRCPR;

u16RESERVED4;

vu16RXCRCR;

u16RESERVED5;

vu16TXCRCR;

u16RESERVED6;

}SPI_TypeDef;

寄存器命名遵循上节的寄存器缩写命名规则。

RESERVEDi（i为一个整数索引值）表示被保留区域。

外设声明

文件stm32f10x_map.h包含了所有外设的声明，下例为SPI外设的声明：

#ifndefEXT

#DefineEXTextern

#endif

......

#definePERIPH_BASE（（u32）0x40000000）

#defineAPB1PERIPH_BASEPERIPH_BASE

#defineAPB2PERIPH_BASE（PERIPH_BASE+0x10000）

/*SPI2BaseAddressdefinition*/

#defineSPI2_BASE（APB1PERIPH_BASE+0x3800）

/*SPI2peripheraldeclaration*/

#ifndefDEBUG

#ifdef_SPI2#defineSPI2（（SPI_TypeDef*）SPI2_BASE）

#endif/*_SPI2*