ST STM32F31xx User manual

October 2012
DocID023800 Rev 1
1/584
www.st.com
UM1581
User manual
Description of STM32F30xx/31xx Standard Peripheral Library
Introduction
The STM32F30xx and STM32F31xx Standard Peripheral Library covers 3 abstraction levels, and
includes:
A complete register address mapping with all bits, bitfields and registers declared in C. This avoids
a cumbersome task and more important, it brings the benefits of a bug free reference mapping file,
speeding up the early project phase.
A collection of routines and data structures covering all peripheral functions (drivers with common
API). It can directly be used as a reference framework, since it also includes macros for supporting
core-related intrinsic features, common constants, and definition of data types.
A set of examples covering all available peripherals with template projects for the most common
development tools. With the appropriate hardware evaluation board, this allows to get started with
a brand-new micro within few hours.󳘪
Each driver consists of a set of functions covering all peripheral features. The development of each
driver is driven by a common API (application programming interface) which standardizes the driver
structure, the functions and the parameter names.The driver source code is developed in „Strict ANSI-C‟
(relaxed ANSI-C for projects and example files). It is fully documented and is MISRA-C 2004 compliant.
Writing the whole library in „Strict ANSI-C‟ makes it independent from the development tools. Only the
start-up files depend on the development tools. Thanks to the Standard Peripheral Library, low-level
implementation details are transparent so that reusing code on a different MCU requires only to
reconfigure the compiler. As a result, developers can easily migrate designs across the STM32 series to
quickly bring product line extensions to market without any redesign. In addition, the library is built
around a modular architecture that makes it easy to tailor and run it on the same MCU using hardware
platforms different from ST evaluation boards.
The Standard Peripheral Library implements run-time failure detection by checking the input values for
all library functions. Such dynamic checking contributes towards enhancing the robustness of the
software. Run-time detection is suitable for user application development and debugging. It adds an
overhead which can be removed from the final application code to minimize code size and execution
speed. For more details refer to Section 1.1.5: "Run-time checking".󳘪
Since the Standard Peripheral Library is generic and covers all peripheral features, the size and/or
execution speed of the application code may not be optimized. For many applications, the library may
be used as is. 󳘪
The firmware library user manual is structured as follows:
Document conventions, rules, architecture and overview of the Library package.
How to use and customize the Library (step by step).
Detailed description of each peripheral driver: configuration structure, functions and how to use the
provided API to build your application.󳘪
The STM32F30xx and STM32F31xx Standard Peripheral Library will be referred to as STM32F30xx
Library throughout the document, unless otherwise specified.
Table 1: Applicable products
Type
Part numbers
Microcontrollers
STM32F30xx and STM32F31xx

STM32F30xx Standard Peripheral Library
UM1581
2/584
DocID023800 Rev 1
Contents
1STM32F30xx Standard Peripheral Library......................14
1.1 Coding rules and conventions .............................................14
1.1.1 Acronyms.......................................................................................14
1.1.2 Naming conventions......................................................................14
1.1.3 Coding rules ..................................................................................15
1.1.4 Bit-Banding....................................................................................18
1.1.5 Run-time checking.........................................................................19
1.1.6 MISRA-C 2004 compliance...........................................................21
1.2 Architecture .........................................................................23
1.3 Package description............................................................24
1.3.1 Library folder structure...................................................................24
1.3.2 Project folder .................................................................................27
1.3.3 Utilities folder.................................................................................29
1.4 Supported devices and development tools..........................31
1.4.1 Supported devices.........................................................................31
1.4.2 Supported development tools and compilers................................31
2How to use and customize the library ............................32
2.1 Library configuration parameters.........................................32
2.2 Library programming model.................................................34
2.3 Peripheral initialization and configuration............................35
2.4 How to run your first example..............................................36
2.4.1 Prerequisites..................................................................................36
2.4.2 Run your first example...................................................................37
2.4.3 Run a peripheral example .............................................................38
2.5 STM32F30/31xx programming model using the library.......39
2.6 How to develop your first application...................................41
2.6.1 Starting point .................................................................................41
2.6.2 Library configuration parameters...................................................42
2.6.3 system_stm32f30x.c......................................................................42
2.6.4 main.c............................................................................................43
2.6.5 stm32f30x_it.c ...............................................................................44
3Analog-to-digital converter (ADC)...................................46
3.1 ADC Firmware driver registers structures............................46
3.1.1 ADC_Common_TypeDef...............................................................46
3.1.2 ADC_CommonInitTypeDef............................................................46

UM1581
STM32F30xx Standard Peripheral Library
DocID023800 Rev 1
3/584
3.1.3 ADC_InitTypeDef...........................................................................47
3.1.4 ADC_InjectedInitTypeDef..............................................................48
3.1.5 ADC_TypeDef ...............................................................................48
3.2 ADC Firmware driver API description..................................51
3.2.1 How to use this driver....................................................................51
3.2.2 Initialization and Configuration functions.......................................51
3.2.3 Analog Watchdog configuration functions.....................................52
3.2.4 Temperature Sensor - Vrefint (Internal Reference Voltage) and
VBAT management functions..................................................................53
3.2.5 Regular Channels Configuration functions....................................53
3.2.6 Regular Channels DMA Configuration functions...........................54
3.2.7 Injected channels Configuration functions.....................................54
3.2.8 Interrupts and flags management functions..................................55
3.2.9 Initialization and Configuration functions.......................................57
3.2.10Analog Watchdog configuration functions.....................................65
3.2.11Temperature Sensor- Vrefint (Internal Reference Voltage) and
VBAT management function....................................................................69
3.2.12Regular Channels Configuration functions....................................71
3.2.13Regular Channels DMA Configuration functions...........................81
3.2.14Injected channels Configuration functions.....................................82
3.2.15Interrupts and flags management functions..................................84
3.3 ADC Firmware driver defines ..............................................90
3.3.1 ADC...............................................................................................90
4Controller area network (bxCAN) ..................................105
4.1 CAN Firmware driver registers structures..........................105
4.1.1 CAN_TypeDef .............................................................................105
4.1.2 CAN_FIFOMailBox_TypeDef......................................................106
4.1.3 CAN_TxMailBox_TypeDef ..........................................................107
4.1.4 CAN_FilterRegister_TypeDef......................................................107
4.1.5 CAN_InitTypeDef.........................................................................107
4.1.6 CAN_FilterInitTypeDef.................................................................109
4.1.7 CanRxMsg...................................................................................110
4.1.8 CanTxMsg...................................................................................110
4.2 CAN Firmware driver API description................................111
4.2.1 How to use this driver..................................................................111
4.2.2 Initialization and Configuration functions.....................................112
4.2.3 CAN Frames Transmission functions..........................................112
4.2.4 CAN Frames Reception functions...............................................112
4.2.5 CAN Operation modes functions.................................................112

STM32F30xx Standard Peripheral Library
UM1581
4/584
DocID023800 Rev 1
4.2.6 CAN Bus Error management functions.......................................113
4.2.7 Interrupts and flags management functions................................113
4.2.8 Initialization and Configuration functions.....................................115
4.2.9 CAN Frames Transmission functions..........................................118
4.2.10CAN Frames Reception functions...............................................119
4.2.11CAN Operating mode functions...................................................120
4.2.12CAN Bus Error management functions.......................................121
4.2.13Interrupts and flags management functions................................123
4.3 CAN Firmware driver defines ............................................126
4.3.1 CAN.............................................................................................126
5Comparators (COMP) .....................................................137
5.1 COMP Firmware driver registers structures ......................137
5.1.1 COMP_TypeDef..........................................................................137
5.1.2 COMP_InitTypeDef .....................................................................137
5.2 COMP Firmware driver API description.............................138
5.2.1 COMP Peripheral features ..........................................................138
5.2.2 How to use this driver..................................................................140
5.2.3 Initialization and Configuration functions.....................................140
5.2.4 Window mode control function....................................................140
5.2.5 Initialization and Configuration functions.....................................141
5.2.6 Write mode control functions.......................................................144
5.2.7 COMP configuration locking function..........................................144
5.3 COMP Firmware driver defines .........................................145
5.3.1 COMP..........................................................................................145
6CRC calculation unit (CRC)............................................152
6.1 CRC Firmware driver registers structures .........................152
6.1.1 CRC_TypeDef.............................................................................152
6.2 CRC Firmware driver API description................................152
6.2.1 How to use this driver..................................................................152
6.2.2 CRC configuration functions........................................................153
6.2.3 CRC computation functions.........................................................153
6.2.4 CRC Independent Register (IDR) access functions....................153
6.2.5 CRC Independent Register (IDR) access functions....................153
6.2.6 CRC computation of one/many 32-bit data functions..................156
6.2.7 CRC Independent Register (IDR) access functions....................158
6.3 CRC Firmware driver defines ............................................158
6.3.1 CRC.............................................................................................158

UM1581
STM32F30xx Standard Peripheral Library
DocID023800 Rev 1
5/584
7Digital-to-analog converter (DAC).................................160
7.1 DAC Firmware driver registers structures..........................160
7.1.1 DAC_TypeDef .............................................................................160
7.1.2 DAC_InitTypeDef.........................................................................161
7.2 DAC Firmware driver API description................................161
7.2.1 DAC Peripheral features .............................................................161
7.2.2 How to use this driver..................................................................162
7.2.3 DAC channels configuration: trigger, output buffer, data format.163
7.2.4 DMA management functions.......................................................163
7.2.5 Interrupts and flags management functions................................163
7.2.6 DAC channels configuration........................................................163
7.2.7 DAC management functions .......................................................168
7.2.8 Interrupts and flags management functions................................169
7.3 DAC Firmware driver defines ............................................171
7.3.1 DAC.............................................................................................171
8Debug support (DBGMCU).............................................176
8.1 DBGMCU Firmware driver registers structures .................176
8.1.1 DBGMCU_TypeDef.....................................................................176
8.2 DBGMCU Firmware driver API description........................176
8.2.1 Device and Revision ID management functions .........................176
8.2.2 Peripherals Configuration functions ............................................176
8.2.3 Device and Revision ID management functions .........................177
8.2.4 Peripherals Configuration functions ............................................177
8.3 DBGMCU Firmware driver defines....................................179
8.3.1 DBGMCU.....................................................................................179
9DMA controller (DMA).....................................................182
9.1 DMA Firmware driver registers structures.........................182
9.1.1 DMA_Channel_TypeDef..............................................................182
9.1.2 DMA_TypeDef.............................................................................182
9.1.3 DMA_InitTypeDef........................................................................182
9.2 DMA Firmware driver API description................................184
9.2.1 How to use this driver..................................................................184
9.2.2 Initialization and Configuration functions.....................................184
9.2.3 Data Counter functions................................................................185
9.2.4 Interrupts and flags management functions................................185
9.2.5 Initialization and Configuration functions.....................................186
9.2.6 Data counter functions.................................................................188

STM32F30xx Standard Peripheral Library
UM1581
6/584
DocID023800 Rev 1
9.2.7 Interrupts and flags management functions................................189
9.3 DMA Firmware driver defines............................................196
9.3.1 DMA.............................................................................................196
10 External interrupt/event controller (EXTI).....................207
10.1 EXTI Firmware driver registers structures.........................207
10.1.1EXTI_TypeDef.............................................................................207
10.1.2EXTI_InitTypeDef........................................................................208
10.2 EXTI Firmware driver API description................................208
10.2.1EXTI features...............................................................................208
10.2.2How to use this driver..................................................................209
10.2.3Initialization and Configuration functions.....................................209
10.2.4Interrupts and flags management functions................................209
10.2.5Initialization and Configuration functions.....................................210
10.2.6Interrupts and flags management functions................................211
10.3EXTI Firmware driver defines............................................212
10.3.1EXTI.............................................................................................212
11 FLASH Memory (FLASH)................................................216
11.1 FLASH Firmware driver registers structures......................216
11.1.1FLASH_TypeDef .........................................................................216
11.1.2OB_TypeDef................................................................................216
11.2 FLASH Firmware driver API description............................217
11.2.1How to use this driver..................................................................217
11.2.2FLASH Interface configuration functions.....................................218
11.2.3FLASH Memory Programming functions.....................................218
11.2.4Option Bytes Programming functions..........................................219
11.2.5Interrupts and flags management functions................................220
11.2.6FLASH Interface configuration functions.....................................220
11.2.7FLASH Memory Programming functions.....................................221
11.2.8Option Bytes Programming functions..........................................224
11.2.9Interrupts and flags management functions................................230
11.3 FLASH Firmware driver defines.........................................232
11.3.1FLASH.........................................................................................232
12 General-purpose I/Os (GPIO).........................................234
12.1 GPIO Firmware driver registers structures........................234
12.1.1GPIO_TypeDef............................................................................234
12.1.2GPIO_InitTypeDef.......................................................................235
12.2 GPIO Firmware driver API description...............................235

UM1581
STM32F30xx Standard Peripheral Library
DocID023800 Rev 1
7/584
12.2.1How to use this driver..................................................................235
12.2.2Initialization and Configuration....................................................236
12.2.3GPIO Read and Write..................................................................236
12.2.4GPIO Alternate functions configuration functions .......................236
12.2.5Initialization and Configuration....................................................237
12.2.6GPIO Read and Write functions..................................................238
12.2.7GPIO Alternate functions configuration functions .......................241
12.3 GPIO Firmware driver defines...........................................242
12.3.1GPIO............................................................................................242
13 Inter-integrated circuit interface (I2C)...........................247
13.1 I2C Firmware driver registers structures............................247
13.1.1I2C_TypeDef ...............................................................................247
13.1.2I2C_InitTypeDef...........................................................................248
13.2 I2C Firmware driver API description..................................248
13.2.1How to use this driver..................................................................248
13.2.2Initialization and Configuration functions.....................................249
13.2.3Communications handling functions............................................250
13.2.4SMBUS management functions..................................................250
13.2.5I2C registers management functions...........................................251
13.2.6Data transfers management functions ........................................251
13.2.7DMA transfers management functions........................................251
13.2.8Interrupts and flags management functions................................252
13.2.9Initialization and Configuration functions.....................................253
13.2.10 Communications handling functions.........................................259
13.2.11 SMBUS management functions ...............................................263
13.2.12 I2C registers management functions........................................267
13.2.13 Data transfers management functions......................................267
13.2.14 DMA transfers management functions.....................................268
13.2.15 Interrupts and flags management functions.............................268
13.3 I2C Firmware driver defines ..............................................271
13.3.1I2C...............................................................................................271
14 Independent watchdog (IWDG)......................................278
14.1 IWDG Firmware driver registers structures .......................278
14.1.1IWDG_TypeDef...........................................................................278
14.2 IWDG Firmware driver API description..............................278
14.2.1IWDG features.............................................................................278
14.2.2How to use this driver..................................................................279

STM32F30xx Standard Peripheral Library
UM1581
8/584
DocID023800 Rev 1
14.2.3Prescaler and Counter configuration functions...........................279
14.2.4IWDG activation function.............................................................279
14.2.5Flag management function..........................................................279
14.2.6Prescaler and counter configuration functions............................280
14.2.7IWDG activation function.............................................................282
14.2.8Flag management function..........................................................282
14.3 IWDG Firmware driver defines ..........................................282
14.3.1IWDG...........................................................................................282
15 Miscellaneous add-on to CMSIS functions(misc)........284
15.1 MISC Firmware driver registers structures ........................284
15.1.1NVIC_InitTypeDef........................................................................284
15.2 MISC Firmware driver API description...............................284
15.2.1How to configure Interrupts using driver......................................284
15.2.2MISC functions............................................................................285
15.3 MISC Firmware driver defines...........................................287
15.3.1MISC............................................................................................287
16 Operational amplifier (OPAMP) .....................................289
16.1 OPAMP Firmware driver registers structures ....................289
16.1.1OPAMP_TypeDef........................................................................289
16.1.2OPAMP_InitTypeDef...................................................................289
16.2 OPAMP Firmware driver API description...........................289
16.2.1OPAMP Peripheral Features.......................................................289
16.2.2How to use this driver..................................................................290
16.2.3Initialization and Configuration functions.....................................290
16.2.4Initialization and Configuration....................................................291
16.2.5OPAMP configuration locking function........................................297
16.3 OPAMP Firmware driver defines.......................................298
16.3.1OPAMP........................................................................................298
17 Power control (PWR) ......................................................301
17.1 PWR Firmware driver registers structures.........................301
17.1.1PWR_TypeDef.............................................................................301
17.2 PWR Firmware driver API description...............................301
17.2.1Backup Domain Access function.................................................301
17.2.2PVD configuration functions........................................................301
17.2.3WakeUp pins configuration functions..........................................302
17.2.4Low Power modes configuration functions..................................302
17.2.5Flags management functions......................................................303

UM1581
STM32F30xx Standard Peripheral Library
DocID023800 Rev 1
9/584
17.2.6Backup domain access function..................................................304
17.2.7PVD configuration function..........................................................304
17.2.8WakeUp pins configuration functions..........................................305
17.2.9Low power mode configuration functions....................................306
17.2.10 Flag management functions .....................................................307
17.3 PWR Firmware driver defines............................................308
17.3.1PWR ............................................................................................308
18 Reset and clock control (RCC) ......................................311
18.1 RCC Firmware driver registers structures .........................311
18.1.1RCC_TypeDef.............................................................................311
18.1.2RCC_ClocksTypeDef ..................................................................312
18.2 RCC Firmware driver API description................................313
18.2.1RCC specific features..................................................................313
18.2.2Internal-external clocks, PLL, CSS and MCO configuration
functions.................................................................................................313
18.2.3System, AHB, APB1 and APB2 busses clocks configuration
functions.................................................................................................314
18.2.4Peripheral clocks configuration functions....................................315
18.2.5Interrupts and flags management functions................................316
18.2.6Internal and external clocks, PLL, CSS and MCO configuration
functions.................................................................................................316
18.2.7System AHB, APB1 and APB2 busses clocks configuration
functions.................................................................................................322
18.2.8Peripheral clocks configuration functions....................................325
18.2.9Interrupts and flags management functions................................334
18.3 RCC Firmware driver defines ............................................337
18.3.1RCC.............................................................................................337
19 Real-time clock (RTC).....................................................354
19.1 RTC Firmware driver registers structures..........................354
19.1.1RTC_TypeDef..............................................................................354
19.1.2RTC_InitTypeDef.........................................................................356
19.1.3RTC_TimeTypeDef......................................................................356
19.1.4RTC_DateTypeDef......................................................................357
19.1.5RTC_AlarmTypeDef....................................................................358
19.2 RTC Firmware driver API description................................358
19.2.1RTC Operating Condition............................................................358
19.2.2Backup Domain Reset.................................................................359
19.2.3Backup Domain Access...............................................................359
19.2.4How to use this driver..................................................................359

STM32F30xx Standard Peripheral Library
UM1581
10/584
DocID023800 Rev 1
19.2.5RTC and low power modes.........................................................361
19.2.6Selection of RTC_AF alternate functions....................................361
19.2.7Initialization and Configuration functions.....................................362
19.2.8Backup Data Registers configuration functions ..........................362
19.2.9Output Type Config configuration functions................................362
19.2.10 Shift control synchronisation functions.....................................362
19.2.11 Interrupts and flags management functions.............................362
19.2.12 Time and Date configuration functions.....................................363
19.2.13 Alarms (Alarm A and Alarm B) configuration functions............363
19.2.14 WakeUp Timer configuration functions.....................................364
19.2.15 Daylight Saving configuration functions ...................................364
19.2.16 Output pin Configuration function.............................................364
19.2.17 Digital Calibration configuration functions ................................364
19.2.18 TimeStamp configuration functions..........................................364
19.2.19 Tampers configuration functions ..............................................364
19.2.20 Initialization and Configuration functions..................................365
19.2.21 Backup Data Registers configuration functions........................368
19.2.22 Output Type Config configuration functions.............................369
19.2.23 Shift control synchronisation functions.....................................370
19.2.24 Interrupts and flags management functions.............................370
19.2.25 Time and Date configuration functions.....................................373
19.2.26 Alarm configuration functions...................................................376
19.2.27 WakeUp timer configuration functions......................................379
19.2.28 Daylight saving configuration functions....................................381
19.2.29 Output pin configuration functions............................................382
19.2.30 Digital calibration configuration functions.................................383
19.2.31 Timestamp configuration functions...........................................384
19.2.32 Tamper configuration functions................................................385
19.3 RTC Firmware driver defines.............................................389
19.3.1RTC .............................................................................................389
20 Serial peripheral interface (SPI).....................................403
20.1 SPI Firmware driver registers structures ...........................403
20.1.1SPI_TypeDef...............................................................................403
20.1.2SPI_InitTypeDef ..........................................................................404
20.1.3I2S_InitTypeDef...........................................................................405
20.2 SPI Firmware driver API description..................................406
20.2.1How to use this driver..................................................................406
20.2.2Initialization and Configuration functions.....................................407

UM1581
STM32F30xx Standard Peripheral Library
DocID023800 Rev 1
11/584
20.2.3Data transfers functions...............................................................408
20.2.4Hardware CRC Calculation functions..........................................408
20.2.5DMA transfers management functions........................................409
20.2.6Interrupts and flags management functions................................409
20.2.7Initialization and configuration functions......................................411
20.2.8Data transfer functions ................................................................418
20.2.9Hardware CRC Calculation functions..........................................419
20.2.10 DMA transfers management functions.....................................421
20.2.11 Interrupts and flags management functions.............................422
20.3 SPI Firmware driver defines..............................................425
20.3.1SPI...............................................................................................425
21 System configuration controller (SYSCFG)..................433
21.1 SYSCFG Firmware driver registers structures ..................433
21.1.1SYSCFG_TypeDef......................................................................433
21.2 SYSCFG Firmware driver API description.........................433
21.2.1How to use this driver..................................................................433
21.2.2SYSCFG Initialization and Configuration functions.....................433
21.2.3SYSCFG initialization and configuration functions......................434
21.3 SYSCFG Firmware driver defines .....................................441
21.3.1SYSCFG......................................................................................441
22 General-purpose timers (TIM)........................................447
22.1 TIM Firmware driver registers structures...........................447
22.1.1TIM_TypeDef...............................................................................447
22.1.2TIM_TimeBaseInitTypeDef..........................................................449
22.1.3TIM_OCInitTypeDef.....................................................................449
22.1.4TIM_ICInitTypeDef ......................................................................450
22.1.5TIM_BDTRInitTypeDef................................................................451
22.2 TIM Firmware driver API description .................................452
22.2.1Output Compare management functions ....................................452
22.2.2How to use this driver..................................................................453
22.2.3TimeBase management functions...............................................455
22.2.4Input Capture management functions.........................................455
22.2.5Advanced-control timers (TIM1 and TIM8) specific features.......456
22.2.6Interrupts, DMA and flags management functions......................457
22.2.7Clocks management functions....................................................457
22.2.8Synchronization management functions .....................................457
22.2.9Specific interface management functions....................................458

STM32F30xx Standard Peripheral Library
UM1581
12/584
DocID023800 Rev 1
22.2.10 Specific remapping management function...............................458
22.2.11 TimeBase management functions............................................458
22.2.12 Output Compare management functions .................................465
22.2.13 Input Capture management functions ......................................487
22.2.14 Advanced-control timers (TIM1, TIM8) specific features..........492
22.2.15 Interrupts DMA and flags management functions....................495
22.2.16 Clock management functions...................................................501
22.2.17 Synchronization management functions...................................504
22.2.18 Specific interface management functions.................................507
22.2.19 Specific remapping management functions .............................508
22.3 TIM Firmware driver defines..............................................509
22.3.1TIM...............................................................................................509
23 Universal synchronous asynchronous receiver
transmitter (USART)................................................................533
23.1 USART Firmware driver registers structures.....................533
23.1.1USART_TypeDef.........................................................................533
23.1.2USART_InitTypeDef....................................................................534
23.1.3USART_ClockInitTypeDef...........................................................535
23.2 USART Firmware driver API description ...........................535
23.2.1How to use this driver..................................................................535
23.2.2Initialization and Configuration functions.....................................536
23.2.3RS485 mode functions................................................................537
23.2.4DMA transfers management functions........................................537
23.2.5Interrupts and flags management functions................................538
23.2.6STOP Mode functions .................................................................539
23.2.7AutoBaudRate functions..............................................................540
23.2.8Data transfers functions...............................................................540
23.2.9Multi-Processor Communication functions..................................540
23.2.10 LIN mode functions...................................................................541
23.2.11 Half-duplex mode function........................................................542
23.2.12 Smartcard mode functions........................................................542
23.2.13 IrDA mode functions.................................................................543
23.2.14 Initialization and Configuration functions..................................544
23.2.15 RS485 mode function...............................................................551
23.2.16 DMA transfers management functions.....................................553
23.2.17 Interrupts and flags management functions.............................554
23.2.18 STOP mode functions ..............................................................559
23.2.19 Data transfer functions .............................................................560

UM1581
STM32F30xx Standard Peripheral Library
DocID023800 Rev 1
13/584
23.2.20 AutoBaudRate functions...........................................................561
23.2.21 MultiProcessor Communication functions ................................562
23.2.22 LIN mode functions...................................................................564
23.2.23 Halfduplex mode function.........................................................565
23.2.24 Smartcard mode functions........................................................565
23.2.25 IrDA mode functions.................................................................567
23.3 USART Firmware driver defines........................................568
23.3.1USART ........................................................................................568
24 Window watchdog (WWDG)...........................................577
24.1 WWDG Firmware driver registers structures.....................577
24.1.1WWDG_TypeDef.........................................................................577
24.2 WWDG Firmware driver API description ...........................577
24.2.1WWDG features ..........................................................................577
24.2.2How to use this driver..................................................................578
24.2.3Prescaler, Refresh window and Counter configuration functions578
24.2.4WWDG activation function ..........................................................578
24.2.5Interrupts and flags management functions................................578
24.2.6Prescaler, Refresh window and Counter configuration functions578
24.2.7WWDG activation functions.........................................................580
24.2.8Interrupts and flags management functions................................581
24.3 WWDG Firmware driver defines........................................581
24.3.1WWDG ........................................................................................581
25 Revision history..............................................................583

STM32F30xx Standard Peripheral Library
UM1581
14/584
DocID023800 Rev 1
1 STM32F30xx Standard Peripheral Library
1.1 Coding rules and conventions
The conventions used in the present user manual and in the library are described in the
sections below.
1.1.1 Acronyms
The table below describes the acronyms used in this document.
Table 2: List of abbreviations
Acronym
Peripheral / unit
ADC
Analog-to-digital converter
CAN
Controller area network
COMP
Analog comparators
CRC
CRC calculation unit
DAC
Digital to analog converter
DBGMCU
Debug MCU
DMA
DMA controller
EXTI
External interrupt/event controller
FLASH
Flash memory
GPIO
General purpose I/O
I2C
Inter-integrated circuit
I2S
Inter-integrated sound
IWDG
Independent watchdog
NVIC
Nested vectored interrupt controller
OPAMP
Operational amplifier
PWR
Power control
RCC
Reset and clock controller
RTC
Real-time clock
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
1.1.2 Naming conventions
The following naming conventions are used in the library:
PPP refers to any peripheral acronym, for example ADC. See Section 1.1: "Coding
rules and conventions" for more information.

UM1581
STM32F30xx Standard Peripheral Library
DocID023800 Rev 1
15/584
System and source/header file names are preceded by „stm32f30x_‟, for example
stm32f30x_conf.h even if they are valid both for STM32F30xx and STM32F31xx
microcontrollers.
Constants used in one file are defined within this file. A constant used in more than
one file is defined in a header file. All constants are written in upper case, except for
peripheral driver function parameters.
typedef variable names should be suffixed with _TypeDef.
Registers are considered as constants. In most cases, their name is in upper case and
uses the same acronyms as in the STM32F30xx reference manual document.
Peripheral registers are declared in the PPP_TypeDef structure (e.g. ADC_TypeDef)
in stm32f30x.h file.
The peripheral function names are preceded by the corresponding peripheral acronym
in upper case followed by an underscore. The first letter in each word is in upper case,
for example USART_SendData. Only one underscore is allowed in a function name to
separate the peripheral acronym from the rest of the function name.
The structure containing the initialization parameters for the PPP peripheral are
named PPP_InitTypeDef (e.g. ADC_InitTypeDef).
The functions used to initialize the PPP peripheral according to parameters specified
in PPP_InitTypeDef are named PPP_Init, e.g. TIM_Init.
The functions used to reset the PPP peripheral registers to their default values are
named PPP_DeInit, e.g. TIM_DeInit.
The functions used to fill the PPP_InitTypeDef structure with the reset values of each
member are named PPP_StructInit, e.g. USART_StructInit.
The functions used to enable or disable the specified PPP peripheral are named
PPP_Cmd, for example USART_Cmd.
The functions used to enable or disable an interrupt source for the specified PPP
peripheral are named PPP_ITConfig, e.g. RCC_ITConfig.
The functions used to enable or disable the DMA interface for the specified PPP
peripheral are named PPP_DMAConfig, e.g. TIM_DMAConfig.
The functions used to configure a peripheral function always end with the string
„Config‟, for example GPIO_PinAFConfig.
The functions used to check whether the specified PPP flag is set or reset are named
PPP_GetFlagStatus, e.g. I2C_GetFlagStatus.
The functions used to clear a PPP flag are named PPP_ClearFlag, for example
I2C_ClearFlag.
The functions used to check whether the specified PPP interrupt has occurred or not
are named PPP_GetITStatus, e.g. I2C_GetITStatus.
The functions used to clear a PPP interrupt pending bit are named
PPP_ClearITPendingBit, e.g. I2C_ClearITPendingBit.
1.1.3 Coding rules
This section describes the coding rules used in the library.
General
All codes should comply with ANSI C standard and should compile without warning
under at least its main compiler. Any warnings that cannot be eliminated should be
commented in the code.
The library uses ANSI standard data types defined in the ANSI C header file
<stdint.h>.
The library has no blocking code and all required waiting loops (polling loops) are
controlled by an expiry programmed timeout.

STM32F30xx Standard Peripheral Library
UM1581
16/584
DocID023800 Rev 1
Variable types
Specific variable types are already defined with a fixed type and size. These types are
defined in the file stm32f30x.h
typedef enum {
RESET = 0,
SET = !RESET
}
FlagStatus, ITStatus;
typedef enum {
DISABLE = 0,
ENABLE = !DISABLE
}
FunctionalState;
typedef enum {
ERROR = 0,
SUCCESS = !ERROR
}
ErrorStatus;
Peripherals
Pointers to peripherals are used to access the peripheral control registers. They point to
data structures that represent the mapping of the peripheral control registers.
Peripheral registers structure
stm32f30x.h contains the definition of all peripheral register structures. The example below
illustrates the SPI register structure declaration:
"/*------------------ Serial Peripheral Interface ---------------*/
typedef struct
{
__IO uint16_t CR1; /*!< SPI control register 1 (not used in
I2S mode), Address offset: 0x00 */
uint16_t RESERVED0;/*!< Reserved, 0x02
*/
__IO uint16_t CR2; /*!< SPI control register 2, Address
offset: 0x04 */
uint16_t RESERVED1;/*!< Reserved, 0x06
*/
__IO uint16_t SR; /*!< SPI status register, Address offset:
0x08 */
uint16_t RESERVED2;/*!< Reserved, 0x0A
*/
__IO uint16_t DR; /*!< SPI data register,Address offset:
0x0C */
uint16_t RESERVED3;/*!< Reserved, 0x0E
*/
__IO uint16_t CRCPR; /*!< SPI CRC polynomial register (not
used in I2S mode), Address offset: 0x10 */
uint16_t RESERVED4;/*!< Reserved, 0x12
*/
__IO uint16_t RXCRCR; /*!< SPI RX CRC register (not used in I2S
mode),Address offset: 0x14 */
uint16_t RESERVED5;/*!< Reserved, 0x16 */

UM1581
STM32F30xx Standard Peripheral Library
DocID023800 Rev 1
17/584
__IO uint16_t TXCRCR; /*!< SPI TX CRC register (not used in I2S
mode),Address offset: 0x18 */
uint16_t RESERVED6;/*!< Reserved, 0x1A
*/
__IO uint16_t I2SCFGR; /*!< SPI_I2S configuration register,
Address offset: 0x1C */
uint16_t RESERVED7;/*!< Reserved, 0x1E
*/
__IO uint16_t I2SPR; /*!< SPI_I2S prescaler register, Address
offset: 0x20 */
uint16_t RESERVED8;/*!< Reserved, 0x22
*/
} SPI_TypeDef;
The register names are the register acronyms written in upper case for each peripheral.
RESERVEDi (I being an integer that indexes the reserved field) indicates a reserved field.
Each peripheral has several dedicated registers which contain different flags. Registers are
defined within a dedicated structure for each peripheral. Flags are defined as acronyms
written in upper case and preceded by „PPP_FLAG_‟. The flag definition is adapted to each
peripheral case and defined in stm32f30x_ppp.h.
Peripheral declaration
All peripherals are declared in stm32f30x.h. The following example shows the declaration
of the SPI peripheral:
...
/*!< Peripheral base address in the alias region */
#define PERIPH_BASE ((uint32_t)0x40000000)
...
/*!< Peripheral memory map */
#define APB1PERIPH_BASE PERIPH_BASE
#define APB2PERIPH_BASE (PERIPH_BASE + 0x00010000)
#define AHB1PERIPH_BASE (PERIPH_BASE + 0x00020000)
#define AHB2PERIPH_BASE (PERIPH_BASE + 0x08000000)
...
/*!< APB1 peripherals base address */
#define SPI2_BASE (APB1PERIPH_BASE + 0x3800)
#define SPI3_BASE (APB1PERIPH_BASE + 0x3C00)
...
/*!< APB2 peripherals base address */
#define SPI1_BASE (APB2PERIPH_BASE + 0x3000)
...
/*!< Peripheral Declaration */
...
#define SPI2 ((SPI_TypeDef *) SPI2_BASE)
#define SPI3 ((SPI_TypeDef *) SPI3_BASE)
...
#define SPI1 ((SPI_TypeDef *) SPI1_BASE)
SPIx_BASE is the base address of a specific SPI and SPIx is a pointer to a register
structure that refers to a specific SPI.
The peripheral registers are accessed as follows:
SPI1->CR1 = 0x0001;

STM32F30xx Standard Peripheral Library
UM1581
18/584
DocID023800 Rev 1
Peripheral registers bits
All the peripheral registers bits are defined as constants in the stm32f30x.h file. They are
defined as acronyms written in upper-case into the form:
PPP_<register_name>_<bit_name>
Example:
#define SPI_CR1_CPHA ((uint16_t)0x0001) /*!< Clock Phase */
#define SPI_CR1_CPOL ((uint16_t)0x0002) /*!< Clock Polarity */
#define SPI_CR1_MSTR ((uint16_t)0x0004) /*!< Master Selection */
#define SPI_CR1_BR ((uint16_t)0x0038) /*!< BR[2:0] bits (Baud
Rate Control) */
#define SPI_CR1_BR_0 ((uint16_t)0x0008) /*!< Bit 0 */
#define SPI_CR1_BR_1 ((uint16_t)0x0010) /*!< Bit 1 */
#define SPI_CR1_BR_2 ((uint16_t)0x0020) /*!< Bit 2 */
1.1.4 Bit-Banding
The Cortex-M4 memory map includes two bit-band memory regions. These regions map
each word in an alias region of memory to a bit in a bit-band region of memory. Writing to a
word in the alias region has the same effect as a read/modify/write operation on the
targeted bit in the bit-band region.
All the STM32F30/F31xx peripheral registers are mapped in a bit-band region. This feature
is consequently intensively used functions performing single bit set/reset in order to reduce
and optimize code size.
The sections below describe how the bit-band access is used in the Library.
Mapping formula
The mapping formula shows how to link each word in the alias region to a corresponding
target bit in the bit-band region. The mapping formula is given below:
bit_word_offset = (byte_offset x 32) + (bit_number × 4)
bit_word_addr = bit_band_base + bit_word_offset
where:
bit_word_offset is the position of the target bit in the bit-band memory region
bit_word_addr is the address of the word in the alias memory region that maps to the
targeted bit.
bit_band_base is the starting address of the alias region
byte_offset is the number of the byte in the bit-band region that contains the targeted
bit
bit_number is the bit position (0-7) of the targeted bit.
Example of implementation
The following example shows how to map the PLLON[24] bit of RCC_CR register in the
alias region:
...
/*!< Peripheral base address in the alias region */
#define PERIPH_BASE ((uint32_t)0x40000000)
...
/*!< Peripheral base address in the bit-band region */
#define PERIPH_BB_BASE ((uint32_t)0x42000000)
...

UM1581
STM32F30xx Standard Peripheral Library
DocID023800 Rev 1
19/584
/* ------------ 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))
To code a function which enables/disables the PLL, the usual method is the following:
...
void RCC_PLLCmd(FunctionalState NewState)
{
if (NewState != DISABLE)
{ /* Enable PLL */
RCC->CR |= RCC_CR_PLLON;
}
else
{ /* Disable PLL */
RCC->CR &= ~RCC_CR_PLLON;
}
}
Using bit-band access this function will be coded as follows:
void RCC_PLLCmd(FunctionalState NewState)
{
*(__IO uint32_t *) CR_PLLON_BB = (uint32_t)NewState;
}
1.1.5 Run-time checking
The library implements run-time failure detection by checking the input values of all library
functions. The run-time checking is achieved by using an assert_param macro. This
macro is used in all the library functions which have an input parameter. It allows checking
that the input value lies within the parameter allowed values.
To enable the run-time checking, use the assert_param macro, and leave the define
USE_FULL_ASSERT uncommented in stm32f30x_conf.h file.
Example:PWR_ClearFlag function
stm32f30x_pwr.c:
void PWR_ClearFlag(uint32_t PWR_FLAG)
{
/* Check the parameters */
assert_param(IS_PWR_CLEAR_FLAG(PWR_FLAG));
PWR->CR |= PWR_FLAG << 2;
}
stm32f30x_pwr.h:
/* PWR Flag */
#define PWR_FLAG_WU ((uint32_t)0x00000001)
#define PWR_FLAG_SB ((uint32_t)0x00000002)
#define PWR_FLAG_PVDO ((uint32_t)0x00000004)
#define PWR_FLAG_VREFINTRDY ((uint32_t)0x00000008)

STM32F30xx Standard Peripheral Library
UM1581
20/584
DocID023800 Rev 1
...
#define IS_PWR_CLEAR_FLAG(FLAG) (((FLAG) == PWR_FLAG_WU) || ((FLAG)
== PWR_FLAG_SB))
If the expression passed to the assert_param macro is false, the assert_failed function is
called and returns the name of the source file and the source line number of the call that
failed. If the expression is true, no value is returned.
The assert_param macro is implemented in stm32f30x_conf.h:
/* Exported macro -------------------------------------------------
-----------*/
#ifdef USE_FULL_ASSERT
/**
* @brief The assert_param macro is used for function's
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 */
The assert_failed function is implemented in the main.c file or in any other user C file:
#ifdef USE_FULL_ASSERT
/**
* @brief Reports the name of the source file and the source line
number
* where the assert_param error has occurred.
* @param file: pointer to the source file name
* @param line: assert_param error line source number
* @retval None
*/
void assert_failed(uint8_t* file, uint32_t line)
{
/* User can add his own implementation to report the file name
and line number */
printf("\n\r Wrong parameter value detected on\r\n");
printf(" file %s\r\n", file);
printf(" line %d\r\n", line);
/* Infinite loop */
while (1)
{
}
}
#endif /* USE_FULL_ASSERT */
Because of the overhead it introduces, it is recommended to use run-time checking during
application code development and debugging, and to remove it from the final application to
improve code size and speed.