Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 10.8 KB

README.md

File metadata and controls

107 lines (72 loc) · 10.8 KB
Raw

CMSIS-Toolbox

Thank you for using the CMSIS-Toolbox that provides command-line tools for:

  • Project creation and build of embedded applications that utilize software packs. Various compilation tools are supported.
  • Pack creation, maintenance, and distribution of software packs in Open-CMSIS-Pack format.

Manual Chapters

  • Overview of the CMSIS-Toolbox (this chapter).

  • Installation explains the setup of the CMSIS-Toolbox along with a build environment for embedded applications that are based on Arm Cortex-M processors.

  • Build Overview describes the overall concept, outlines the csolution project files that describes the software application, and contains references to examples and project templates.

  • Build Tools contains command line descriptions for cbuild (build projects), csolution (transform csolution project files), and cpackget (manage software packs).

  • CMSIS Solution Project File Format is a detailed description of the csolution project files that define the software application in YAML format.

  • Create Applications explains how to start projects using software packs. It covers also linker script creation, software pack structure, and project maintenance with pack upgrades.

  • Reference Applications explains how to use and create examples that show middleware usage on on many different evaluation boards including custom hardware.

  • Configure STM32 Devices with CubeMX explains how to use STM32CubeMX to manage device and board configuration.

  • Build Information Files details the build information generated by the csolution tool.

  • Build Operation contains for advanced users further details about build process, CMake backend configuration, and generator integration.

  • Pack Creation describes how to create software packs and explains the pack creation tools packchk (software pack verification) and svdconv (SVD file converter).

Content of Overview Chapter

Target Audience

This user's guide assumes basic knowledge about Cortex-M software development. It is written for embedded software developers that work with C/C++ compiler toolchains and utilize microcontroller devices with Cortex-M processors and Ethos-U NPUs. The CMSIS-Toolbox supports currently:

Overall Workflow

The CMSIS-Toolbox uses software packs for device/board support and access reusable software components. The operation is controlled via intuitive csolution project files in YAML format. The overall application is defined in the *.csolution.yml file and contains one or more projects that can utilize pre-configured software layers. The build engine CMake/Ninja calls the C/C++ compiler toolchain that generates the Build Output.

The cbuild: Build Invocation command orchestrates the overall build steps. This command calls individual command line tools to generate the application as outlined in the following diagram.

cbuild workflow

The build steps are:

  1. cpackget downloads Software Packs that are required for *.csolution.yml when using the option --pack.
  2. csolution processes the User Input and the Software Packs to generate the overall Build Information. Refer to Overview of Operation for details.
  3. cbuild2cmake converts this Build Information into CMake format.
  4. CMake/Ninja call the C/C++ compiler toolchain to translate the source files into the application image.

Note:

The CMSIS-Toolbox build system does not use the CMake compiler and linker flags specified by environment variables CFLAGS, LDFLAGS. Refer to the chapter Build Operation for further details of the build process.

Command Line and IDE Usage

The CMSIS-Toolbox is a set of command line tools that are designed for stand-alone usage and integration into IDEs or DevOps systems for Continuous Integration (CI) workflows.

Operation of csolution tool

The VS Code IDE integration available from Arm is a viewer to the csolution project files and provides graphical ways to modify the content. Refer to DevOps Usage for more information on integration into CI workflows.

Benefits

The overall benefits of the CMSIS-Toolbox are:

  • Flexible command line tools that can be used stand-alone or integrated into VS Code or DevOps systems for Continuous Integration (CI).
  • Stand-alone tools are available for all host platforms (Windows, Mac, Linux) for flexible deployment.
  • Software packs simplify tool setup with device: or board: selection and project creation with access to reusable software components.
  • Organize solutions with projects that are independently managed simplifies a wide range of use cases including multi-processor applications or unit testing.
  • Integrates with domain specific generators (i.e. CubeMX) that support configuration of devices/boards and complex software stacks such as motor control.
  • Provisions for product lifecycle management (PLM) with versioned software packs that ease update and management for configuration files.
  • Software layers enable code reuse across similar applications with a pre-configured set of source files and software components.
  • Target types allow application deployment to different hardware (test board, production hardware, virtual simulation models, etc.).
  • Build types support software testing and verification (debug build, test build, release build, ect.).
  • Support for multiple toolchains, even within the same set of project files and command line options to select different toolchains during verification.
  • Linker Script Management utilizes device and board information of software packs to define available memory and allows flexible control of linker operation.
  • Uses a CMake backend for the build process that integrates with other tools such as VS Code intellisense.

Revision History

Version Description
2.6.0 CMSIS-Toolbox 2.6.0; extends pack: version specifier and C language support to C17 and C23. Improved is regions header file generation for linker scripts. It adds trustzone: secure-only for projects without secure entries, apis, messages, and PLM status for config files to cbuild.yml information, and fixes several minor issues. It is no longer possible to specify compiler in the cdefault.yml file.
2.5.0 CMSIS-Toolbox 2.5.0; direct CMake interface is now default, tmpdir: controls location of interim files, adds add-path-asm:, adds define-asm, adds regular expression search to for-context:/not-for-context, and contains several corrections.
2.4.0 CMSIS-Toolbox 2.4.0; adds CubeMX integration, pre/post-build steps, simplifies the generator integration, and contains several corrections.
2.3.0 CMSIS-Toolbox 2.3.0 adds in the csolution project files component instances and optimize: debug. Tools are extended with cbuild setup command, --frozen-pack option. Refer to release information for more details.
2.2.0 CMSIS-Toolbox 2.2.0 adds generator integration, extends translation controls, adds context set, adds pack locking, and improves linker script management. Refer to release information for more details.
2.0.0 Initial release for CMSIS-Toolbox 2.0.0