- Last edited 2 years ago ago
This article explains some of the basics of STM32CubeIDE. It is an all-in-one multi-OS development tool, which is part of the STM32Cube software ecosystem.
For more information about STM32CubeIDE please refer to its user manual.
- 1 STM32CubeIDE purpose
- 2 How to install STM32CubeIDE
- 3 How to get started with STM32CubeIDE
- 4 Project structure
- 5 Arm® Cortex®-M debug on STM32 MPU device
- 6 OpenSTLinux project support - Cortex-A
- 7 FAQ
1 STM32CubeIDE purpose
STM32CubeIDE is an advanced C/C++ development platform with peripheral configuration, code generation, code compilation, and debug features for STM32 microcontrollers and microprocessors. It is based on the ECLIPSE™/CDT framework, GCC toolchain for the development and GDB for the debugging.
It allows the integration of the hundreds of existing plugins that complete the features of the Eclipse™ IDE. STM32CubeIDE integrates all STM32CubeMX functionalities to offer all-in-one tool experience and to save installation and development time.
With STM32CubeIDE, you can
- select the appropriate STM32 device corresponding to your needs,
- configure the device using STM32CubeMX,
- develop and debug applications on top on Arm® Cortex®-M
2 How to install STM32CubeIDE
It is available on Linux® and Windows® host PCs, but it is NOT on macOS®.
|STM32CubeIDE for Linux host PC||STM32CubeIDE for Windows® host PC|
|Detailed release note||
Minor releases may then be available from update site, please check chapter 10 in (UM2609) for more information on how to update STM32CubeIDE.
3 How to get started with STM32CubeIDE
This section links to two different how to articles depending on if you are moving from SW4STM32 to STM32CubeIDE or if you are starting a new project with STM32CubeIDE.
3.1 How to get started with STM32CubeIDE from scratch
How to get started with STM32CubeIDE from scratch.
3.2 How to move from SW4STM32 to STM32CubeIDE
How to move from SW4STM32 to STM32CubeIDE.
4 Project structure
A hierarchical project structure is created in same time as the creation of an STM32 MPU project.
The project structure for single-core projects is flat. On the contrary, in a multi-core project, the hierarchical project structure is used. When the user creates or imports an STM32 MPU project, its structure is made of one root project together with sub-projects, referred to STM32 MCU projects, for each core. A hierarchical structure example is shown below.
5 Arm® Cortex®-M debug on STM32 MPU device
Two modes are used to debug Arm® Cortex®-M firmware on STM32 MPU device.
5.1 Engineering mode
Very powerful to debug preliminary Arm® Cortex®-M, the engineering mode implies a specific boot mode: the Engineering Boot Mode where only Cortex-M is started. Firmware is loaded via JTAG/SWD into its dedicated RAM.
This mode is not the default one, it has to be set via the "Debug Configuration" menu, in "Debugger" tab , "thru JTGA/SWD link (Engineering mode)" option selected.
Debugging in Engineering Mode in STM32 MPU device is very similar to a standard STM32 MCU debug in term of functionality, expect that here Arm Cortex-M has only a dedicated memory, no flash memory type.
5.2 Production mode
Production mode targets a debug close to final product. It means to have an STM32 MPU board up and running on the Cortex-A (Linux) and a Cortex-M firmware to debug (usually an STM32CubeIDE project).
Board, aka named as "target", is booted in Production mode from flash memory (e.g. SD card) ; it is connected to the Host:
- via Ethernet network, using Ethernet cable or dedicated USB cable
- and via USB cable to ST-Link probe, giving access to JTAG/SWD and Linux Console.
ST-Link automatically brings support for Cortex-A Linux console via VCP (Virtual COM Port). This enables Target Status widget, visible on the bottom-right of STM32CubeIDE, allowing target IP address discovery. For Production Mode setup, it is recommended to get the target IP address discovered by Target Status widget before creating Debug Configuration. This principle is depicted in Debug Configuration screenshot below.
Network connection can be set up by 2 ways:
- managed network: IP address attributed by DHCP server
- unmanaged network: IP address to be manually configured
- using the dedicated USB OTG connection for Ethernet point to point.
Debug is performed thanks to the following workflow:
1. The firmware built binary is transferred to the target using the network (ssh protocol), more precisely to the Cortex-A Linux file system.
2. The firmware is loaded to Cortex-M core thanks to the “remoteproc” framework.
3. Finally the Debug session is started via JTAG/SWD connection
The production mode is the default one when you create a new debug configuration. It is automatically set via the "Debug Configuration" menu.
More information on how to use STM32CubeIDE Target Status are given in article How to use the STM32CubeIDE target status.
At debug launch, some specific pop-up appear:
- The SSH Password has to be completed: the default one is root.
- The RSA key has to be approved.
Defining an Arm Cortex-M project in an STM32 MPU context also means to define where are downloaded on Arm Cortex-A Linux file system:
- the Cortex-M Firmware: <ProjectName>.elf
- the load/unload script fw_cortex_m4.sh used by the STM32CubeIDE if present it can be customized
- and a README, informing a user having a direct connection onto the target.
This is the purpose of "Remote Path Setting" property which is linked to the project. Its default value at creation is /usr/local/project/<ProjectName>, but can also be changed thanks to the Remote Settings properties item.
Inside project structure,directory "<ProjectName>_CM4/Core/RemoteProc/" defines the tree downloaded when debugging in Production Mode.
5.3 ST-Link Server support
This is enable by checking "Shared ST-Link inside Debug Configuration > Debugger > ST-Link Client Setup". From STM32CubeIDE v1.2.0, it is possible to connect to ST-Link via 'ST-Link Server' just like on standard STM32 MCU.
6 OpenSTLinux project support - Cortex-A
From release 1.4.0 on Linux host ONLY, STM32CubeIDE supports OpenSTLinux projects and its associated Yocto SDK. Inside STM32CubeIDE, this support means two new Eclipse plugins (SDK & Sources) to be installed, directly from embedded CA7 project menu context:
- Setup OpenSTLinux
- Import an OpenSTLinux Project...
Those Eclipse plugins embed official packages from OpenSTLinux 2.0.
Note that a minimum disk space of 5GByte is needed under /tmp during the installation phase.
6.1 How to install Yocto SDK in STM32CubeIDE
We focus in the article How to install Yocto SDK in STM32CubeIDE on various ways to install Yocto SDK or point to an already existing SDK installation.
6.2 How to manage OpenSTLinux projects
All projects available from OpenSTLinux can be imported inside STM32CubeIDE for compilation with Yocto SDK.
Regarding Project Structure, those OpenSTLinux projects enrich the Cortex-A part as depicted hereafter. Note that this support is starting from OpenSTLinux v2.0.