STM32F1xx micro-controller C firmware template
Go to file
King Kévin 9da8708bca updated libopencm3 submodule 2018-06-08 10:46:33 +02:00
lib USB: improve comments and a fix of code 2018-06-08 10:45:01 +02:00
libopencm3@6e65170390 updated libopencm3 submodule 2018-06-08 10:46:33 +02:00
.gitignore cherry-pick from busvoodoo branch, part 2 2018-02-18 15:20:01 +01:00
.gitmodules remove STM32duino-bootloader 2016-08-14 19:03:17 +02:00
Doxyfile add changes from spark abacus project 2016-10-23 17:42:27 +02:00
LICENSE.txt add GPLv3 license file 2018-02-13 15:14:10 +01:00 README: replace make with rake 2017-10-04 14:00:34 +02:00
Rakefile Rakefile: remove reset functionnality 2018-06-08 10:45:01 +02:00
application.c application: integrate terminal and menu 2018-04-06 17:37:17 +02:00
application.ld ld: improve flash size enforcing description 2018-04-06 19:55:52 +02:00
bootloader.c bootloader: fix SRAM comment 2018-06-08 10:45:01 +02:00
bootloader.ld ld: improve flash size enforcing description 2018-04-06 19:55:52 +02:00
global.c global: re-enable sleep in sleep_ms 2018-04-06 16:54:48 +02:00
global.h flash internal: check enforced flash size 2018-04-06 19:56:57 +02:00

This firmware template is designed for development boards based around STM32 F1 series micro-controller.



describe project purpose


described electronic details


The current implementation uses a core board.

The underlying template also supports following board:

Which board is used is defined in the Makefile. This is required to map the user LED and button provided on the board


Connect the peripherals the following way (STM32F10X signal; STM32F10X pin; peripheral pin; peripheral signal; comment):

  • list board to preipheral pin connections

All pins are configured using defines in the corresponding source code.



The source code uses the libopencm3 library. The projects is already a git submodules. It will be initialized when compiling the firmware. Alternatively you can run once: git submodule init and git submodule update.


To compile the firmware run rake.


To generate doxygen documentation run rake doc.


There are two firmware images: bootloader and application. The bootloader image allows to flash the application over USB using the DFU protocol. The bootloader is started first and immediately jumps to the application if it is valid and the DFU mode is not forced (i.e. by pressing the user button on the board or requesting a DFU detach in the application). The application image is the main application and is implemented in application.c. It is up to the application to advertise USB DFU support (i.e. as does the provided USB CDC ACM example).

The bootlaoder image will be flashed using SWD (Serial Wire Debug). For that you need an SWD adapter. The Makefile uses a Black Magic Probe (per default), or a ST-Link V2 along OpenOCD software. To flash the booltoader using SWD run rake flash_booloader.

Once the bootloader is flashed it is possible to flash the application over USB using the DFU protocol by running rake flash. To force the bootloader to start the DFU mode press the user button or short a pin, depending on the board. It is also possible to flash the application image using SWD by running rake flash_application.


SWD also allows to debug the code running on the micro-controller using GDB. To start the debugging session run rake debug.


The firmware offers serial communication over USART1 and USB (using the CDC ACM device class).

You can also reset the board by setting the serial width to 5 bits over USB. To reset the board run rake reset. This only works if provided USB CDC ACM is running correctly and the micro-controller isn't stuck.