新闻  |   论坛  |   博客  |   在线研讨会
STM32固件库中代码规范和约定
我就是我lxw | 2012-08-09 14:15:55    阅读:3044   发布文章
缩写 外设/单元

  ADC = Analog/digital converter

  BKP = Backup registers

  CAN=Controller area network

  CEC=Consumer Electronics Control

  CRC=CRC calculation unit

  DAC=Digital to analog converter

  DBGMCU=Debug MCU

  DMA=DMA controller

  EXTI=External interrupt/event controller

  FSMC=Flexible static memory controller 可变静态存储控制器,是STM32系列中内部集成256 KB以上FlaSh,后缀为xC、xD和xE的高存储密度微控制器特有的存储控制机制。之所以称为“可变”,是由于通过对特殊功能寄存器的设置,FSMC能够根据不同的外部存储器类型,发出相应的数据/地址/控制信号类型以匹配信号的速度,从而使得STM32系列微控制器不仅能够应用各种不同类型、不同速度的外部静态存储器,而且能够在不增加外部器件的情况下同时扩展多种不同类型的静态存储器,满足系统设计对存储容量、产品体积以及成本的综合要求。 

  FLASH=Flash memory

  GPIO=General purpose I/O

  I2C=Inter-integrated circuit

  I2S=Inter-integrated sound

  IWDG=Independent watchdog

  NVIC=Nested vectored interrupt controller

  PWR=Power controller

  RCC=Reset and clock controller

  RTC(Real-Time Clock):实时时钟。它的主要作用就是提供稳定的时钟信号给后续电路用。主要功能有:时钟,日历,闹钟,周期性中断输出,32KHz时钟输出。

  SDIO=SDIO interface SDIO在SD标准上定义了一种外设接口。

  SPI=Serial peripheral interface

  SysTick=System tick timer

  TIM=Advanced-control, general-purpose or basic timer

  USART=Universal synchronous asynchronous receiver transmitter

  WWDG=Window watchdog

  

  命名约定

  STM32F10x 标准外设库使用下列命名规则:

  PPP表示任一外设缩写,如ADC。

  系统文件名和源/头文件名以前缀'stm32f10x_'开头。

  在单一文件中使用的常量在该文件中定义,多个文件中使用的常量定义在头文件中。所有常量都以大写字母表示。

  寄存器当作常量看待,同样以大写字母表示。多数情况下,与STM32F10x参考手册中使用相同的缩写。

  外设函数名字有相应外设模块缩写加下划线这样的前缀。每个单词的首字母要大写,如USART_SendData。在一个函数名中只允许有一条下划线用来区分外设模块缩写和剩下的函数名。

  使用PPP_InitTypeDef中指定的参数初始化PPP外设函数被命名为PPP_Init,如TIM_Init。

  复位PPP外设模块寄存器为默认值的函数命名为了PPP_DeInit,如TIM_DeInit。

  将PPP_InitTypeDef结构体每个成员设置为复位值的函数命名为PPP_StructInit,如USART_StructInit。

  用来使能或禁止指定PPP外设的函数命名为PPP_Cmd,例如USART_Cmd。

  用来使能或禁止指定PPP模块的某个中断资源的函数命名为PPP_ITConfig,如RCC_ITConfig。

  用来使能或禁止指定PPP外设模块DMA接口的函数命名为PPP_DMAConfig。如TIM_DMAConfig。

  用来设置外设模块的函数总是以字符串'Config'结尾,如GPIO_PinRemapConfig。

  用来检验指定PPP的标志是否被置位或清零的函数命名为PPP_GetFlagStatus,如I2C_GetFlagStatus。

  用来清除某个PPP标志的函数命名为PPP_ClearFlag,如I2C_ClearFlag。

  用来检验指定PPP的中断是否发生的函数命名为PPP_GetITStatus,如I2C_GetITStatus。

  用来清除某个PPP中断挂起位的函数命名为PPP_ClearITPendingBit,如I2C_ClearITPendingBit。

参与讨论
登录后参与讨论
推荐文章
最近访客