Skip to content

Commit ccbdca8

Browse files
authored
Adjust image links (#491)
* image links and typos * md linter --------- Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>
1 parent 122a6e8 commit ccbdca8

1 file changed

Lines changed: 16 additions & 14 deletions

File tree

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -220,14 +220,15 @@ and/or hit count.
220220

221221
Most Arm Cortex-M processors (except Cortex-M0/M0+/M23) include a `DWT->CYCCNT` register that counts CPU states. In combination with the CMSIS variable [`SystemCoreClock`](https://arm-software.github.io/CMSIS_6/latest/Core/group__system__init__gr.html) the CMSIS Debugger calculates execution time and displays it along with the selected processor core in the CPU Time Status bar. A click on the CPU Time Status bar opens the related [VS Code command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
222222

223-
Command | Description
224-
:--------------|:-------------
225-
CPU Time | Print CPU execution time and history of past program stops.
226-
Reset CPU Time | Reset CPU execution time and history. Set new reference time (zero point).
223+
|Command | Description |
224+
|:--------------|:-------------|
225+
|CPU Time | Print CPU execution time and history of past program stops. |
226+
|Reset CPU Time | Reset CPU execution time and history. Set new reference time (zero point). |
227227

228-
![CPU Time](images/CPU_Time.png)
228+
![CPU Time](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/CPU_Time.png)
229229

230-
> 📝 **Notes:**
230+
> 📝 **Notes:**
231+
>
231232
> - The first program stop (typically at function `main`) is the initial reference time (zero point).
232233
> - `DWT->CYCCNT` is a 32-bit register incremented with [`SystemCoreClock`](https://arm-software.github.io/CMSIS_6/latest/Core/group__system__init__gr.html) frequency. The time calculation copes with one overflow between program stops. Multiple overflows between program stops deliver wrong time information.
233234
> - Each processor in a multi-processor system has and independent `DWT->CYCCNT` register.
@@ -248,17 +249,18 @@ A GDB server provides multiple connections to the processor cores (identified wi
248249
0007560 I Client connected to port 3333! [gdbserver]
249250
```
250251

251-
The `start-pname` indicates the processor that starts first and boots the system. A debug *launch* command connects to this processor. Use a debug *attach* command to connect to processors that are running. The picture below highlights the parts of the user interface that interact with processors.
252+
The `start-pname` indicates the processor that starts first and boots the system. A debug _launch_ command connects to this processor. Use a debug _attach_ command to connect to processors that are running. The picture below highlights the parts of the user interface that interact with processors.
252253

253254
1. Select a processor and **Start Debug**. This connects the debugger.
254255
2. **Select a Processor** in the debug toolbar, or
255256
3. Click in **CALL STACK** on a thread or function name to select a processor.
256-
4. The selected processor is also shown **CPU Time Status bar**. This processor context is used in the VARIABLES or WATCH view.
257+
4. The selected processor is also shown in the **CPU Time Status bar**. This processor context is used in the VARIABLES and WATCH view.
257258

258-
![Multicore Debug](images/multicore.png)
259+
![Multicore Debug](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/multicore.png)
259260

260-
> 📝 **Notes:**
261-
> - The SEGGER JLink GDB server uses a *launch* command to connect to a running processor whereas other GDB servers use a *attach* command.
261+
> 📝 **Notes:**
262+
>
263+
> - The SEGGER JLink GDB server uses a _launch_ command to connect to a running processor whereas other GDB servers use an _attach_ command.
262264
> - A [Disassembly View](#disassembly) opens only for a selected processor; otherwise the command is shown as disabled.
263265
264266
### Peripherals
@@ -296,7 +298,8 @@ The command **Open Disassembly View** (available from [command palette](https://
296298

297299
![Disassembly View](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/disassembly-view.png)
298300

299-
> 📝 **Note:**
301+
> 📝 **Note:**
302+
>
300303
> - Enable the [VS Code setting](https://code.visualstudio.com/docs/configure/settings) **Features > Debug > Disassembly View: Show Source Code** to show assembler instructions interleaved with source code.
301304
302305
### Debug Console
@@ -338,7 +341,7 @@ It depends on the actually used debug adapter type if this information is known
338341

339342
## Known Limitations and Workarounds
340343

341-
### Internal Errors on stepping thru code
344+
### Internal Errors on stepping through code
342345

343346
There is an [chip errata](https://developer.arm.com/documentation/SDEN1068427/latest/) that single stepping on Cortex-M7 r0p1 processors enters the pending exception handler incorrectly which may result in error messages. Check the processor revision that is shown at debug start in the DEBUG CONSOLE.
344347

@@ -512,4 +515,3 @@ Related open source projects are:
512515
- SEGGER and J-LINK are registered trademarks of SEGGER Microcontroller GmbH.
513516
- Node.js is a registered trademark of the OpenJS Foundation.
514517
- GDB and GCC are part of the GNU Project and are maintained by the Free Software Foundation.
515-

0 commit comments

Comments
 (0)