Skip to content

Commit 239133a

Browse files
authored
Update Documentation (#479)
## Fixes: - Open-CMSIS-Pack/devtools#2265 - #303 - https://github.com/Open-CMSIS-Pack/cmsis-toolbox/issues/611 ## Added: - pyOCD Telnet option for file-in and file-out
1 parent 70f3f31 commit 239133a

File tree

4 files changed

+24
-11
lines changed

4 files changed

+24
-11
lines changed

docs/YML-Input-Format.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1421,7 +1421,7 @@ The `images:` node under `target-set:` specifies the projects with build-type an
14211421
    [`load:`](#load) | Optional | Load mode of the image file for programmers and debug tools.
14221422
    `info:` | Optional | Brief description of the image file.
14231423
    [`type:`](#type) | Optional | Specifies an explicit file of the image type.
1424-
    `load-offset:` | Optional | Offset applied to the binary content when loading the image file.
1424+
    `load-offset:` | Optional | Offset applied when loading a image file with `type: bin` (pyOCD only).
14251425
    [`device:`](#device) | Optional | For image files a pname can be specified to denote the processor that runs the image.
14261426

14271427
!!! Notes
@@ -2465,7 +2465,7 @@ debugger: | | Description
24652465
    [`reset:`](pyOCD-Debugger.md#reset) | Optional | Extended Option: Reset type configuration for various cores.
24662466
    [`load-setup:`](pyOCD-Debugger.md#load-setup) | Optional | Extended Option: Reset type and Halt configuration for Load command.
24672467

2468-
*Examples:**
2468+
**Examples:**
24692469

24702470
```yml
24712471
debugger:
@@ -2498,12 +2498,13 @@ The `telnet:` node configures:
24982498
`- mode:` |**Required** | Redirect output: `off`, `server`, `file`, `console`, `monitor`.
24992499
    `pname:` | Optional | Identifies the processor (not requried for single core system).
25002500
    `port:` | Optional | Set TCP/IP port number of Telnet Server (default: 4444, 4445, ... incremented for each processor).
2501-
&nbsp;&nbsp;&nbsp; `file:` | Optional | Explicit path and name of the telnet output file (default: ./out/\<solution-name\>+\<target-type\>.\<pname\>.out).
2501+
&nbsp;&nbsp;&nbsp; `file-in:` | Optional | Explicit path and name of the telnet input file. Default: ./out/\<solution-name\>+\<target-type\>.\<pname\>.in
2502+
&nbsp;&nbsp;&nbsp; `file-out:` | Optional | Explicit path and name of the telnet output file. Default: ./out/\<solution-name\>+\<target-type\>.\<pname\>.out
25022503

25032504
Telnet Mode | Description
25042505
:-------------|:--------------------------------------
25052506
`server` | Serial I/O to Telnet server port
2506-
`file` | Serial output to text file (default: ./out/\<solution-name\>+\<target-type\>.\<pname\>.out).
2507+
`file` | Serial I/O to text files. Default: `./out/\<solution-name\>+\<target-type\>.\<pname\>.{in \| out}`
25072508
`console` | Serial output to console (Debug console in VS Code).
25082509
`monitor` | Serial I/O via TCP/IP port to VS Code Serial Monitor.
25092510
`off` | Serial I/O disabled.
@@ -2541,9 +2542,9 @@ debugger:
25412542
- pname: Core0 # enable Telnet service with default settings
25422543
port: 4444
25432544
- pname: Core1
2544-
mode: console # route Telnet output to console
2545+
mode: console # route Telnet input/output to console
25452546
- pname: Core2
2546-
mode: file # log Telnet output
2547+
mode: file # route Telnet input/output to files
25472548
```
25482549

25492550
### Arm Debugger
@@ -2651,7 +2652,7 @@ debugger: | | Description
26512652
```yml
26522653
debugger:
26532654
name: J-Link Server
2654-
clock: 4000 # 4000 kHz
2655+
clock: 4000000 # 4000 kHz
26552656
protocol: swd
26562657
```
26572658

docs/build-tools.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ There are several ways to configure the CMSIS-Pack repository:
2222
Orchestrate the overall build steps utilizing the various tools of the CMSIS-Toolbox and a CMake-based compilation process.
2323

2424
```txt
25-
cbuild: Build Invocation 2.11.0 (C) 2022-2025 Arm Ltd. and Contributors
25+
cbuild: Build Invocation 2.12.0 (C) 2022-2025 Arm Ltd. and Contributors
2626
2727
Usage:
2828
cbuild [command] <name>.csolution.yml [options]
@@ -48,8 +48,16 @@ Options:
4848
-n, --no-schema-check Skip schema check
4949
-O, --output arg Base folder for output files, 'outdir' and 'tmpdir' (default "Same as '*.csolution.yml'")
5050
-p, --packs Download missing software packs with cpackget
51+
-j, --jobs int Number of job slots for parallel execution (default 8)
52+
-l, --load arg Set policy for packs loading [latest | all | required] (default "required")
53+
--log arg Save output messages in a log file
54+
-n, --no-schema-check Skip schema check
55+
-O, --output arg Base folder for output files, 'outdir' and 'tmpdir' (default "Same as '*.csolution.yml'")
56+
-p, --packs Download missing software packs with cpackget
5157
-q, --quiet Suppress output messages except build invocations
5258
-r, --rebuild Remove intermediate and output directories and rebuild
59+
-s, --schema Validate project input file(s) against schema [deprecated]
60+
--skip-convert Skip csolution convert step
5361
-t, --target arg Optional CMake target name
5462
--toolchain arg Input toolchain to be used
5563
--update-rte Update the RTE directory and files

docs/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ Thank you for using the **CMSIS-Toolbox** that provides command-line tools for:
2424

2525
- [**Build Information Files**](YML-CBuild-Format.md) details the build information generated by the `csolution` tool. It includes license information for components and configuration for download and debug.
2626

27-
- [**pyOCD Debugger**](pyOCD-Debugger.md) explains the usage of the [pyOCD](https://pyocd.io/) Debugger in combination with the CMSIS-Toolbox configuration features.
28-
2927
- [**Theory of Operation**](build-operation.md) contains further details about the build process including CMake, West, generator (device configurators), and debugger integration for advanced users.
3028

3129
- [**Pack Creation**](pack-tools.md) describes how to create software packs that optionally include examples and explains the pack creation tools `packchk` (software pack verification) and `svdconv` (SVD file verification and header file generator).
@@ -34,6 +32,10 @@ Thank you for using the **CMSIS-Toolbox** that provides command-line tools for:
3432

3533
- [**Experimental Features**](Experimental-Features.md) for resource management of multi-project linker scripts, run and debug management.
3634

35+
- **Debugger Support**
36+
- [**pyOCD Debugger**](pyOCD-Debugger.md) explains the usage of the [pyOCD](https://pyocd.io/) Debugger in combination with the CMSIS-Toolbox configuration features.
37+
- [**J-Link Debugger**](pyOCD-Debugger.md) explains the usage of the [J-Link GDB Server](https://www.segger.com/products/debug-probes/j-link/tools/j-link-gdb-server/about-j-link-gdb-server/) in combination with the CMSIS-Toolbox configuration features.
38+
3739
- **Device Configuration Tools**
3840
- [**MCUXpresso for NXP Devices**](./MCUXpressoConfig.md) shows how to use [MCUXpresso Config Tools](https://www.nxp.com/configtools) to manage device and board configuration.
3941
- [**STM32CubeMX for STM32**](CubeMX.md) explains how to use [STM32CubeMX](https://www.st.com/en/development-tools/stm32cubemx.html) to manage device and board configuration.

mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ nav:
1313
- Create Applications: CreateApplications.md
1414
- Reference Applications: ReferenceApplications.md
1515
- Build Information Files: YML-CBuild-Format.md
16-
- pyOCD Debugger: pyOCD-Debugger.md
1716
- Theory of Operation: build-operation.md
1817
- Pack Creation: pack-tools.md
1918
- Troubleshooting: Troubleshooting.md
2019
- Experimental Features: Experimental-Features.md
20+
- Debugger Support:
21+
- pyOCD Debugger: pyOCD-Debugger.md
22+
- J-Link Debugger: JLink-Debugger.md
2123
- Device Configuration Tools:
2224
- MCUXpresso for NXP Devices: MCUXpressoConfig.md
2325
- STM32CubeMX for STM32 Devices: CubeMX.md

0 commit comments

Comments
 (0)