stm32-common

This repository contains code for STM32-based boards that I'm using in some of my projects.

It is intended to be used as a git submodules by a top-level project.

See https://github.com/PhischDotOrg/stm32f4-minimal for an example.

How to check out

This project makes use of git's submodules feature. This repository is therefore more of a front-end for other code parts. In order to obtain all the needed code, please check out with the --recursive flag.

Example:

$ git clone git@github.com:PhischDotOrg/stm32f4-common.git --recursive

How to build

These instructions apply to all top-level projects that use this repository as a sub-module.

Pre-requisites

In order to build the code, you need these packages installed on your computer:

• CMake
• GNU Arm Embedded Toolchain
  • Other C++11 capable compilers might work, too, but I haven't tested them.
• Optional: OpenOCD
  • If OpenOCD is found, the make flash target will allow you to flash the firmware onto the embedded device.
• Optional: Doxygen
  • If Doxygen is found, the make doxygen target will allow you to create the Doxygen documentation.

Building in Visual Studio Code

The easiest way to build this project is to load the top-level project as a Folder or Workspace in Visual Studio Code

This is especially true if the top-level has included https://github.com/PhischDotOrg/stm32-vscode as a sub-module in .vscode.

The Workspace should set up the CMake Kits to offer Generic STM32 and Generic STM32 (Windows). Please chose the one that is suitable for you.

Building via Command Line

The code can be built via Command Line, e.g. like this:

$ mkdir build
$ cd build
$ cmake -DCMAKE_TOOLCHAIN_FILE=../common/Generic_Cortex_M4.ctools -DSTM32F4_BOARD=STM32F4_Discovery ..
$ make

Please note: CMake apparently uses Ninja as the default Build Tool on some platforms (e.g. recent Ubuntu). In that case, the make command should be ninja instead.

How to flash

The CMake build files include a flash target which uses OpenOCD to flash the binary to the controller. This is probably the most convenient way to flash:

$ make flash

Build Types

The CMakeLists.txt file uses the CMAKE_BUILD_TYPE variable as follows:

• Debug: Compile with -O0 -g.
• Release: Compile with -O3.
• RelWithDebInfo: Compile with -O2 -Og -g.
• MinSizeRel: Compile with -Os -g.

Supported Architectures

The CMakeLists.txt file uses CMAKE_SYSTEM_NAME variable to determine whether the code is being built for the Host computer or for an embedded Target Device:

• Generic: Code is being cross-compiled for an Embedded Target. In this case, the CMAKE_SYSTEM_PROCESSOR variable is used to select one of the supported CPUs (currently Cortex-M3 or -M4).
• Otherwise, it is assumed that the Code is compiled for the Host computer. This is useful for Unit Tests. In that case, the HOSTBUILD macro is added, so C/C++ code can use the preprocessor to check whether the code is being built for a non-embedded system (e.g. like #if defined(HOSTBUILD)).

Supported Embedded Boards

The CMake Variable STM32_BOARD variable is also evaluated in the CMakeLists.txt file. It is used to look up CPU/Board-specific files in a boards subdirectory. As of now, the following Boards are supported:

• STM32F1 BluePill: Set STM32_BOARD=STM32F1_BluePill to build for the STM32F4 Discovery Board.
• STM32F4 Discovery: Set STM32_BOARD=STM32F4_Discovery to build for the STM32F4 Discovery Board.
• STM32 Nucleo F411RE: Set STM32_BOARD=STM32_Nucleo_F411RE to build for the STM32 Nucleo F411RE Board.
• STM32 Nucleo L432KC: Set STM32_BOARD=STM32_Nucleo_L432KC to build for the STM32 Nucleo L432KC Board.

Build Targets

• all: Default pseudo-target building all executables, most notably firmware.elf
• flash: Build the binary and flash it to the controller using OpenOCD.
• doxygen: Build the Doxygen documentation for the C++ Code.
• bin: Build a .bin, .s19and .hex file from the .elf file. Also generate an ASCII dump from the .bin file.
  • This may be useful if you need to flash using other tools. The ASCII dump may come in handy if you need to compare binary changes between two builds.

Supported APIs

System APIs

CPU	Flash	MCO	NVIC	PLL	RCC	SCB
STM32F103	[x]	[x]	[x]	[x]	[x]	[x]
STM32F407	[x]	[x]	[x]	[x]	[x]	[x]
STM32F411	[x]	[x]	[x]	[x]	[x]	[x]
STM32L432	[x]	[x]	[x]	[x]	[x]	[x]

Peripheral APIs

CPU	ADC	DMA	GPIO	I2C	SPI	Timer	UART	USB
STM32F103	[ ]	[ ]	[ ]	[ ]	[x]	[ ]	[x]	[x]
STM32F407	[ ]	[x]	[x]	[ ]	[x]	[ ]	[x]	[x]
STM32F411	[ ]	[x]	[x]	[ ]	[x]	[ ]	[x]	[x]
STM32L432	[ ]	[ ]	[ ]	[ ]	[ ]	[ ]	[x]	[x]