King Kévin
0a18d73197
|
||
|---|---|---|
| lib | ||
| libopencm3@2b603ff2af | ||
| .gitignore | ||
| .gitmodules | ||
| Doxyfile | ||
| LICENSE.txt | ||
| README.md | ||
| Rakefile | ||
| application.c | ||
| application.ld | ||
| bootloader.c | ||
| bootloader.ld | ||
| global.c | ||
| global.h | ||
README.md
This firmware template is designed for development boards based around STM32 F4 series micro-controller.
project
summary
describe project purpose
technology
described electronic details
board
The underlying template also supports following board:
- WeAct MiniF4, based on a STM32F401CCU6
Which board is used is defined in the Makefile. This is required to map the user LED and button provided on the board
connections
Connect the peripherals the following way (STM32F4xx signal; STM32F4xx pin; peripheral pin; peripheral signal; comment):
- list board to peripheral pin connections
All pins are configured using defines in the corresponding source code.
code
dependencies
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.
firmware
To compile the firmware run rake.
documentation
To generate doxygen documentation run rake doc.
flash
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 simplest way do flash the bootloader image is using the embedded bootloader.
By pressing the BOOT0 button (setting the pin low) while powering or resetting the device, the micro-controller boot its embedded UART/USB DFU bootloader.
Connect a USB cable and run rake dfu_bootloader.
Once the bootloader is flashed, it is possible to flash the application over USB using the DFU protocol by running rake flash (equivalent to rake dfu_application.
To force the bootloader to start the DFU mode press the user button or short a pin, depending on the board.
Note: I use my own DFU bootloader instead of the embedded bootloader because I was not able to start the embedded USB DFU bootloader from the application.
The images can also be flash using SWD (Serial Wire Debug) in case the firmware gets stuck and does not provide USB functionalities.
For that you need an SWD adapter.
The Makefile uses a ST-Link V2 programmer along OpenOCD software (default), or Black Magic Probe.
To flash the bootloader using SWD run rake swd_bootloader (this will also erase the application).
To flash the application using SWD run rake swd_application (or rake swd).
To erase all memory and unlock read/write protection, run rake remove_protection.
debug
SWD also allows to debug the code running on the micro-controller using GDB.
To start the debugging session run rake debug.
USB
The firmware offers serial communication over USART1 and USB (using the CDC ACM device class).