@micro-os-plus/platform-stm32f4discovery

A source xPack with the µOS++ STM32F4DISCOVERY board support

Usage no npm install needed!

<script type="module">
  import microOsPlusPlatformStm32f4discovery from 'https://cdn.skypack.dev/@micro-os-plus/platform-stm32f4discovery';
</script>

README

license CI on Push

A source xPack with the µOS++ STM32F4DISCOVERY board support files

The STM32F4DISCOVERY board is a development board from ST MIcroelectronics with the STM32F407VG MCU.

This project provides the initialization code generated by CubeMX.

It is intended to be included in unit tests, which generally do not need peripherals.

Maintainer info

This page is addressed to developers who plan to include this package into their own projects.

For maintainer infos, please see the README-MAINTAINER file.

Install

As a source xPacks, the easiest way to add it to a project is via xpm, but it can also be used as any Git project, for example as a submodule.

Prerequisites

A recent xpm, which is a portable Node.js command line application.

For details please follow the instructions in the install page.

xpm

Note: the package will be available from npmjs.com at a later date.

For now, it can be installed from GitHub:

cd my-project
xpm init # Unless a package.json is already present

xpm install github:micro-os-plus/platform-stm32f4discovery-xpack

When ready, this package will be available as @micro-os-plus/platform-stm32f4discovery from the npmjs.com registry:

cd my-project
xpm init # Unless a package.json is already present

xpm install @micro-os-plus/platform-stm32f4discovery@latest

Git submodule

If, for any reason, xpm is not available, the next recommended solution is to link it as a Git submodule below an xpacks folder.

cd my-project
git init # Unless already a Git project
mkdir -p xpacks

git submodule add https://github.com/micro-os-plus/platform-stm32f4discovery-xpack.git \
  xpacks/micro-os-plus-platform-stm32f4discovery

Branches

Apart from the unused master branch, there are two active branches:

  • xpack, with the latest stable version (default)
  • xpack-develop, with the current development version

All development is done in the xpack-develop branch, and contributions via Pull Requests should be directed to this branch.

When new releases are published, the xpack-develop branch is merged into xpack.

User info

This project can be used as-is for simple tests or blinky projects.

It can also be copied into the user project, the configuration updated, and content regenerated, at any time.

Status

The STM32F4DISCOVERY core support is fully functional.

Limitations

Currently only the GPIO drivers are enabled.

Build & integration info

To integrate this package into user projects, consider the following details:

Source folders

  • stm32cubemx/Core/Src
  • stm32cubemx/Drivers/STM32F4xx_HAL_Driver/Src
Include folders
  • stm32cubemx/Core/Inc
  • stm32cubemx/Drivers/CMSIS/Device/ST/STM32F4xx/Include
  • stm32cubemx/Drivers/CMSIS/Include
  • stm32cubemx/Drivers/STM32F4xx_HAL_Driver/Inc

The header file to be included in user project is:

#include <stm32f4xx.h>

Preprocessor definitions

  • MICRO_OS_PLUS_INCLUDE_MICRO_OS_PLUS_DIAG_TRACE to enable the trace_printf() calls in Error_Handler() and assert_failed().

Compiler options

  • -std=c++17 or higher for C++ sources
  • -std=c11 for C sources

Interrupt handlers

The CubeMX configuration explicitly disabled the generation of the interrupt handlers, such that the more elaborated handlers available with µOS++ be used.

For a correct integration with the rest of the HAL, the SysTick_Handler should also call some HAL specific functions.

TBD

Namespaces

  • none

Classes

  • none

Examples

TBD

Known problems

  • none

Tests

TBD

License

The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.

The HAL code generated by CubeMX is distributed under the BSD-3-Clause license.