Skip to content

Commit 31ee788

Browse files
authored
New links to CMSIS-Toolbox documentation
1 parent b65696d commit 31ee788

File tree

11 files changed

+44
-20
lines changed

11 files changed

+44
-20
lines changed

CubeMX/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# CubeMX Example
22

3-
This *csolution project* shows the usage of [STM32CubeMX](https://www.st.com/en/development-tools/stm32cubemx.html) which uses a [generator import file](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-CBuild-Format.md#generator-import-file) to obtain the device configuration and HAL driver source files.
3+
This *csolution project* shows the usage of [STM32CubeMX](https://www.st.com/en/development-tools/stm32cubemx.html) which uses a [generator import file](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-CBuild-Format#generator-import-file) to obtain the device configuration and HAL driver source files.
44

5-
This project uses two different target-types to configure execution from Flash ROM or execution from RAM. It uses a [variable](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md#variables) to define the regions header file for each target in the file [`CubeMX.csolution.yml`](./CubeMX.csolution.yml).
5+
This project uses two different target-types to configure execution from Flash ROM or execution from RAM. It uses a [variable](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format#variables) to define the regions header file for each target in the file [`CubeMX.csolution.yml`](./CubeMX.csolution.yml).
66

77
## Prerequisites
88

@@ -37,7 +37,7 @@ To change the device configuration, start STM32CubeMX using the following comman
3737
```
3838

3939
For using CubeMX refer to the documentation
40-
[**CMSIS-Toolbox > Configure STM32 Devices with CubeMX**](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/tree/main/docs/CubeMX.md).
40+
[**CMSIS-Toolbox > Configure STM32 Devices with CubeMX**](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/tree/main/docs/CubeMX).
4141

4242
The source code generated by CubeMX is imported using the file [STM32CubeMX\<target-type>\CubeMX.cgen.yml](./STM32CubeMX/MyBoard_ROM/CubeMX.cgen.yml). This allows you to create different settings for each target, for example evaluation board and custom hardware.
4343

@@ -55,13 +55,13 @@ By default this project is the Arm Compiler 6 (AC6). Using STM32CubeMX it can be
5555

5656
- In the file [`CubeMX.csolution.yml`](./CubeMX.csolution.yml) set `compiler: GCC`.
5757

58-
- Launch the STM32CubeMX generator with this CMSIS-Toolbox command: csolution <solution_name>.csolution.yml run -g CubeMX -c <context>
58+
- Launch the STM32CubeMX generator with this CMSIS-Toolbox command: `csolution <solution_name>.csolution.yml run -g CubeMX -c <context>`
5959

6060
- In STM32CubeMX:
61-
- Open from the menu Project Manager - Project - Toolchain/IDE:
62-
- Select STM32CubeIDE and disable Generate Under Root.
63-
- Click GENERATE CODE to recreate the CubeMX generated files for the GCC compiler.
61+
- Open from the menu Project Manager - Project - Toolchain/IDE:
62+
- Select STM32CubeIDE and disable Generate Under Root.
63+
- Click GENERATE CODE to recreate the CubeMX generated files for the GCC compiler.
6464

65-
In the file [CubeMX.cproject.yml](./CubeMX.cproject.yml), update `linker:` node configuration to reference appropriate [GCC linker script template](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/build-overview.md#linker-script-templates). You may customize this GCC linker script template file to your project's requirements.
65+
In the file [CubeMX.cproject.yml](./CubeMX.cproject.yml), update `linker:` node configuration to reference appropriate [GCC linker script template](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview#linker-script-templates). You may customize this GCC linker script template file to your project's requirements.
6666

6767
[Rebuild the project](#build-project) using the CMSIS-Toolbox command `cbuild` with the option `--rebuild`.

DualCore/HelloWorld.cbuild-set.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
cbuild-set:
2+
generated-by: vscode-cmsis-csolution version 1.46.0
3+
contexts:
4+
- context: HelloWorld_cm0plus.Debug+FRDM-K32L3A6
5+
- context: HelloWorld_cm4.Debug+FRDM-K32L3A6

DualCore/HelloWorld.csolution.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ solution:
66
select-compiler:
77
- compiler: AC6
88

9+
compiler: AC6
10+
911
packs:
1012
- pack: ARM::CMSIS@^6.1.0
1113
- pack: ARM::CMSIS-RTX@^5.9.0

DualCore/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,12 @@ This example generates **HelloWorld** executables for the **FRDM-K32L3A6** evalu
1616

1717
## Project Structure
1818

19-
The project is generated using the [CMSIS-Toolbox](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/build-overview.md) and is defined in [`csolution`](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md) format:
19+
The project is generated using the [CMSIS-Toolbox](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview) and is defined in [`csolution`](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format) format:
2020

2121
- [`HelloWorld.csolution.yml`](./HelloWorld.csolution.yml) lists the required packs, defines, hardware targets, and the build-types (along with the compiler).
2222
- [`./cm0plus/HelloWorld_cm0plus.cproject.yml`](./cm0plus/HelloWorld_cm0plus.cproject.yml) defines the source files and the software components for the **Cortex-M0plus** core.
2323
- [`./cm4/HelloWorld_cm4.cproject.yml`](./cm4/HelloWorld_cm4.cproject.yml) defines the source files and the software components for the **Cortex-M4** core.
2424

25-
2625
## Generate the project binaries
2726

2827
```txt

Hello/Hello.cproject.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,8 @@ project:
3030
- component: Device:Native Driver:SysTimer
3131
- component: Device:Native Driver:Timeout
3232
- component: Device:Definition
33+
34+
output: # generate output files
35+
type:
36+
- elf
37+
- hex

Hello/Hello.csolution.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@ solution:
33
description: Print Hello World and a counter value via UART
44
cdefault:
55

6-
select-compiler: # list of tested compilers
6+
select-compiler: # list of tested compilers
77
- compiler: AC6
88
- compiler: GCC
99

10+
compiler: GCC # selected compiler
11+
1012
# It is recommended to list the pack or packs that define the device or board used in the csolution.yml file
1113
packs:
1214
- pack: ARM::CMSIS

Hello/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This project prints "Hello World" and a counter value via the UART output. It is
1717

1818
## Project Structure
1919

20-
The project is generated using the [CMSIS-Toolbox](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/build-overview.md) and is defined in [`csolution`](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md) format:
20+
The project is generated using the [CMSIS-Toolbox](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview) and is defined in [`csolution`](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format) format:
2121

2222
- [`Hello.csolution.yml`](./Hello.csolution.yml) lists the required packs, defines,hardware targets, and thebuild-types (along with the compiler).
2323
- [`Hello.cproject.yml`](./Hello.cproject.yml) defines the source files and the software components.
@@ -55,7 +55,7 @@ The project is configured for execution on [**Arm Virtual Hardware**](https://de
5555
### Execute this project in [**Keil Studio Cloud**](https://studio.keil.arm.com/)
5656

5757
- Keil Studio Cloud integrates also the Arm Virtual Hardware for FVP_Corstone_SSE-300/_Ethos-U55/_Ethos-U65 models. The steps to use the example are:
58-
- Start [Keil Studio Cloud](https://studio.keil.arm.com/) and login to the system using your account.
59-
- Use **File - Clone** and enter the URL: (https://github.com/Open-CMSIS-Pack/csolution-examples).
60-
- Select from the drop-down *Target hardware*: **Corstone SSE-300 (Cortex-M55, Ethos-U55, Ethos-U65)**
61-
- Click **Run project** which executes the project build step and then starts running on Arm Virtual Hardware.
58+
- Start [Keil Studio Cloud](https://studio.keil.arm.com/) and login to the system using your account.
59+
- Use **File - Clone** and enter the URL: (https://github.com/Open-CMSIS-Pack/csolution-examples).
60+
- Select from the drop-down *Target hardware*: **Corstone SSE-300 (Cortex-M55, Ethos-U55, Ethos-U65)**
61+
- Click **Run project** which executes the project build step and then starts running on Arm Virtual Hardware.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
# CMSIS-Toolbox Examples in *csolution project format*
88

9-
This is a collection of [CMSIS-Toolbox](https://github.com/Open-CMSIS-Pack/cmsis-toolbox) project examples in [*csolution project format*](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md). The project examples are provided for experimentation, exploration and education purposes.
9+
This is a collection of [CMSIS-Toolbox](https://open-cmsis-pack.github.io/cmsis-toolbox) project examples in [*csolution project format*](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format). The project examples are provided for experimentation, exploration and education purposes.
1010

1111
## Tool Requirements
1212

1313
The examples use **CMSIS-Toolbox 2.6.0** or higher and require additional tools such as CMake, Ninja, Arm Compiler 6, GCC Compiler, and Arm Fixed Virtual Platforms (AVH-FVP).
1414

15-
Refer to [**Installation of the CMSIS-Toolbox**](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/installation.md) for information on the setup of a development environment with these tools.
15+
Refer to [**Installation of the CMSIS-Toolbox**](https://open-cmsis-pack.github.io/cmsis-toolbox/installation) for information on the setup of a development environment with these tools.
1616

1717
When using VS Code with the [Arm Environment Manager](https://marketplace.visualstudio.com/items?itemName=Arm.environment-manager) the required tools are installed based on the settings in the file [`vcpkg-configuration.json`](./vcpkg-configuration.json) using the [Arm Tools Artifactory](https://artifacts.tools.arm.com/).
1818

SimpleTrustZone/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818

1919
## Project Structure
2020

21-
The project is generated using the [CMSIS-Toolbox](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/build-overview.md) and is defined in [`csolution`](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/YML-Input-Format.md) format:
21+
The project is generated using the [CMSIS-Toolbox](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview) and is defined in [`csolution`](https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format) format:
22+
2223

2324
- [`SimpleTZ.csolution.yml`](./SimpleTZ.csolution.yml) lists the required packs, defines, hardware targets, and the build-types (along with the compiler).
2425
- [`CM33_s.cproject.yml`](./CM33_s/CM33_s.cproject.yml) defines the source files and the software components used for the secure part.
@@ -42,7 +43,8 @@ The project is generated using the [CMSIS-Toolbox](https://github.com/Open-CMSIS
4243

4344
## Generate the project binaries
4445

45-
Note that the file [SimpleTZ.cbuild-set.yml](./SimpleTZ.cbuild-set.yml) contains the selected [context set](https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/build-overview.md#working-with-context-set) for the application.
46+
Note that the file [SimpleTZ.cbuild-set.yml](./SimpleTZ.cbuild-set.yml) contains the selected [context set](https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview#working-with-context-set) for the application.
47+
4648

4749
```txt
4850
> cbuild SimpleTZ.csolution.yml --packs .Debug+AVH --toolchain AC6 --context-set

SimpleTrustZone/SimpleTZ.csolution.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ solution:
44
select-compiler:
55
- compiler: AC6
66

7+
compiler: AC6
8+
79
packs:
810
- pack: ARM::CMSIS
911
- pack: ARM::Cortex_DFP

0 commit comments

Comments
 (0)