Embedded systems design and programming using STM32F4x1 MCU and C++

This repository contains peripherals library for STM32F4 BlackPill boards, which are based on STM32F401CC and STM32F411CE microcontrollers. Besides the peripherals library, there are libraries for few external devices, such as OLED and TFT-LCD displays, touch controller, shift-registers, ultrasonic sensor and much more. The code is written in C++, following the C++17 standard. The Arm GNU Toolchain is used with CMake for creating Ninja build system. Visual Studio Code is the code editor of preference and debug configurations are included for it. There is support for JLink, ST-link V2 (including Chinese dongles) debuggers and CMSIS DAPLink debug probes, which can be used for flashing and debugging the code via SWD.

The main purpose of this project is to learn how to use modern C++ in bare-metal programming.

Prerequisites

Arm GNU Toolchain
CMake (minimum version 3.18)
Ninja
Visual Studio Code, with the following extensions:
- C/C++ Extension Pack
- Cortex-Debug

For flashing and debugging, the following options are currently provided:

JLink
ST-link V2. On Linux, stlink toolset can be used.
CMSIS-DAPLink debug probe, with OpenOCD as software interface for the probe. The probe used in the project can easily be bought from China, very cheaply. For Linux, udev rules file is provided under templates/udev-rules directory, which can be adjusted based on the USB VID and PID of the debug probe. Additional modifications on the openocd.cfg file may also be needed, found inside cmake/stm32 directory.

The development was done on Linux, other platforms are not tested, but there shouldn't be difficulties when using other platforms.

Current state of the project

STM32 peripherals:

GPIO (manipulation and configuration, including alternate function names based on the peripherals, per pin, and external interrupts)
General purpose timers
I2C master asynchronous driver
SPI master asynchronous driver
Serial USB
Cycle counter
Real time clock (missing subsecond precision)

External devices:

SSD1306 OLED display
24Cxxx Serial EEPROM
74HC595 (SIPO) and 74HC165 (PISO) shift registers
Two digit seven-segment display
TFT LCDs based on ILI9486(parallel) and ILI9488(SPI)
Resistive touch based on XPT2046

There are few basic examples that are using the developed interfaces for testing purposes.

Project structure

.
├── .vscode                       # debug configurations for VS Code
├── build                         # build artifacts
├── cmake                         # CMake related scripts
├── docs                          # currently contains useful drawings
├── lib                           # library dependencies for the examples
    ├── external-devices          # interfaces for devices like displays, sensors, etc.
    ├── stm32f4x1-devices         # interfaces for internal STM32F401/F411 peripherals
    └── usb                       # interfaces based on usb stack
├── reading-materials             # useful reading materials for C++, CMake, Embedded programming, ARM and STM32
├── src                           # source code for the example projects
├── svd                           # SVD files for debugging
├── templates                     # project templates
    ├── makefile-template         # makefile based project
    ├── project-template-cross    # STM32 CMake project template
    └── project-template-native   # CMake project template for PC
├── CMakeLists.txt                # Top-level CMakeLists.txt
├── CMakePresets.json             # Configuration and build CMake presets 
└── readme.md

Future development

Interfaces for other peripherals, including:
- ADC
- DMA
Improving communication class hierarchy, including:
- interface for half-duplex communication protocols
- interface for full-duplex communication protocols
Incorporating DMA in other peripheral drivers, like SPI, I2C, ADC, etc.
Code optimizations and improvements for the peripherals drivers and external devices, most notably for TFT LCD drivers
Proper testing of the code

Resources and related projects

The following resources are great inspiration for this project: