You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Changes
Documentation CMSIS-Toolbox update for version 2.12.0
## Checklist
<!-- Put an `x` in the boxes. All tasks must be completed and boxes
checked before merging. -->
- [x] 🤖 This change is covered by unit tests (if applicable).
- [x] 🤹 Manual testing has been performed (if necessary).
- [x] 🛡️ Security impacts have been considered (if relevant).
- [x] 📖 Documentation updates are complete (if required).
- [x] 🧠 Third-party dependencies and TPIP updated (if required).
---------
authored-by: Reinhard Keil <ReinhardKeil@users.noreply.github.com>
Copy file name to clipboardExpand all lines: docs/Troubleshooting.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -124,6 +124,9 @@ project:
124
124
125
125
When a `type: hex` file is generated for AC6, the CMSIS-Toolbox configures this file in the `*.cbuild-run.yml` file with `load: image` and the `type: elf` file with `load: symbols`. This bypasses the GDB loader issue.
126
126
127
+
!!! Note
128
+
The HEX file should be generated using the Arm Compiler 6 `fromelf` tool during the build process of the application. Using a HEX conversation tool for a different toolchain may generate unpredictable results.
129
+
127
130
## Layer Search Fails
128
131
129
132
The `cbuild setup` command does not find compatible layers.
Copy file name to clipboardExpand all lines: docs/YML-CBuild-Format.md
+34-5Lines changed: 34 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,7 @@ A typical directory structure of a `csolution` based application that uses commo
52
52
┣ ┣ 📂 mypro2\Target\Debug
53
53
┣ ┣ ┣ mypro2.cbuild.Debug+Target.yml # file references are relative to directory out\mypro2\Target\Debug
54
54
55
-
```
55
+
```
56
56
57
57
## Lock Pack Versions
58
58
@@ -121,7 +121,7 @@ The `<solution-name>.cbuild-idx.yml` file is generated for the *csolution projec
121
121
`csolution:` | Relative path and name of the [`*.csolution.yml`](YML-Input-Format.md#solution) input file used to generate this application.
122
122
[`configurations:`](#configurations) | For reference applications with undefined layers: list of potential project configurations for a reference application with undefined layers
123
123
[`cprojects:`](#cprojects) | List of `*.cproject.yml` and `*.clayer.yml` input files used to generate this application.
124
-
[`cbuilds:`](#cbuilds) | List of `*.cbuild.yml` output files that are generated for this application.
124
+
[`cbuilds:`](#cbuilds) | List of `*.cbuild.yml` output files that are generated by `*.cproject.yml` files for this application.
125
125
[`select-compiler:`](#select-compiler) | For projects with unspecified compiler: list of available compilers for selection
`board:` | **Required** | Board name used for west build invocation.
654
+
`device:` | Optional | Specify the processor core for execution of the generated image (used in `*.cbuild-run.yml`).
655
+
`west-defs:` | Optional | Defines in `CMake` format. The `west-defs:` from build and target-type are added.
656
+
`west-opt:` | Optional | Options for the `west` tool (default: empty).
657
+
658
+
**Example:**
659
+
660
+
```yml
661
+
west:
662
+
project-id: hello_world
663
+
app-path: ../../../../hello_world
664
+
board: stm32h7b3i_dk
665
+
west-defs:
666
+
- CONFIG_BUILD_OUTPUT_HEX=y
667
+
```
668
+
640
669
## Generator Information Files
641
670
642
671
The `csolution run` command generates the following build information files in the [`intdir:`](YML-Input-Format.md#output-dirs) of the related `context`. These files are the input to a generator and provide information about the *csolution project* to the generator. The files are generated in the [`tmp` directory](build-overview.md#output-directory-structure) of the project and contain absolute paths.
@@ -710,7 +739,7 @@ The `*.cgen.yml` file lists the generated *csolution project* part and starts wi
710
739
711
740
## Run and Debug Management
712
741
713
-
The CMSIS-Toolbox build system manages software packs that contain information about device, board, and software components. It controls the build output (typically ELF/DWARF files), and has provisions for HEX, BIN and post-processing. The [`target-set:`](build-overview.md#run-and-debug-configuration) node configures the application images and the debugger for a [target-type](build-overview.md#project-setup-for-related-projects).
742
+
The CMSIS-Toolbox build system manages software packs that contain information about device, board, and software components. It controls the build output (typically ELF/DWARF files), and has provisions for HEX, BIN and post-processing. The [`target-set:`](build-overview.md#run-and-debug-configuration) node configures the application images and the debugger for a [target-type](build-overview.md#configure-related-projects).
714
743
715
744
The software packs contain information that is the basis for debug and run settings:
716
745
@@ -810,8 +839,8 @@ The following describes the overall structure of the `*.cbuild-run.yml` file. W
810
839
811
840
#### `output:`
812
841
813
-
This node contains information about the images that should be loaded. The images that are generated by the *csolution project* are typically configured [using a context set](build-overview.md#working-with-context-set).
814
-
Use the [`images:`](YML-Input-Format.md#images) node in the `*.csolution.yml` file to add other output files.
842
+
This node contains information about the images that should be loaded. The images that are generated by the *csolution project* are typically configured [using a target-set](build-overview.md#working-with-target-set). The `output:` node includes also image files that are generated with a [West Build](YML-Input-Format.md#west-build) specification.
843
+
The `output:` node also contains other required files that are added with [`images:`](YML-Input-Format.md#images) in the `*.csolution.yml` file.
0 commit comments