Skip to content

Commit

Permalink
corrections to sequences
Browse files Browse the repository at this point in the history
  • Loading branch information
ReinhardKeil committed Jan 17, 2025
1 parent ab3e862 commit 4e85da3
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/Experimental-Features.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,32 +245,34 @@ The start of [debug sequences](https://open-cmsis-pack.github.io/Open-CMSIS-Pack
:---------------------------------------------------------|--------------|:------------------------------------
`- name:` | **Required** | Name of the sequence.
    `info:` | Optional | Descriptive text to display for example for error diagnostics.
    `blocks:` | Optional | Contains commands or blocks
    `execute:` | Optional | commands for execution
    `execute_atomic:` | Optional | commands for atomic execution
    `blocks:` | Optional | A list of command blocks in order of execution.
    `pname:` | Optional | Executes sequence only for connection to processor; Default is executed for all connections.

`blocks:` | | Content
:---------------------------------------------------------|--------------|:------------------------------------
`- info:` | Optional | Descriptive text to display for example for error diagnostics.
    `blocks:` | Optional | Contains commands or blocks
    `execute:` | Optional | commands for execution
    `execute_atomic:` | Optional | commands for atomic execution
    `blocks:` | see Note | A list of command blocks in order of execution.
    `execute:` | see Note | commands for execution.
    `execute_atomic:` | see Note | commands for atomic execution.
    `if:` | Optional | only executed when expression is true
    `while:` | Optional | executed in loop until while expression is true
    `timeout:` | Optional | timeout in milliseconds for while loop

!!! Note
- There must be only of these keys in a list node: `blocks:`, `execute:`, or `execute_atomic:`. The list order defines the order of execution.

Example: [debugPortSetup](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/debug_description.html#debugPortSetup)

```yml
sequences:
- name: DebugPortSetup
execute: |
__var isSWJ = ((__protocol & 0x00010000) != 0);
__var hasDormant = __protocol & 0x00020000;
__var protType = __protocol & 0x0000FFFF;
blocks:
- execute: |
__var isSWJ = ((__protocol & 0x00010000) != 0);
__var hasDormant = __protocol & 0x00020000;
__var protType = __protocol & 0x0000FFFF;
- if: protType == 1
blocks:
- if: isSWJ
Expand Down

0 comments on commit 4e85da3

Please sign in to comment.