Merge branch 'main' into filterEntriesSmart

Author: thorstendb-ARM

CHANGELOG.md

@@ -1,42 +1,35 @@
 # Change Log
 
-## 1.5.1
+## 1.6.0
 
-- Adds `Fault Reports` to the [Core Peripherals](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger?tab=readme-ov-file#core-peripherals) view.
-- Improves expand/collapse behavior with active filter in [Component Viewer](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger?tab=readme-ov-file#component-viewer) and
-[Core Peripherals](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger?tab=readme-ov-file#core-peripherals) views.
+- The extension now has a *pre-release channel* for early access to upcoming features.  
+As part of this, the versioning scheme has changed: stable releases use even minor versions (starting with 1.6.0), while odd minor versions are reserved for pre-releases.
+- Adds the [Core Peripherals](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger?tab=readme-ov-file#core-peripherals) view which gives insight into the programming of CPU specific core peripherals.
+- Adds commands to enable/disable [CPU Time](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger?tab=readme-ov-file#cpu-time) updates.
+- Fixes [Component Viewer](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger?tab=readme-ov-file#component-viewer) display and stability issues.
 - Includes updated pyOCD distribution ([pyOCD v0.44.0](https://github.com/pyocd/pyOCD/releases/tag/v0.44.0))
     - Uses default debug sequences as defined in the
     [Open-CMSIS-Pack specification](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/debug_description.html#autotoc_md2).
     - Adds missing sequence support for flash programming and holding hardware reset.
     - Changes strategy of programming multiple flash memories from multiple erase-program-verify sequences per flash memory to a single
-    erase-program-verify sequence spannig all targeted flash memories.
+    erase-program-verify sequence spanning all targeted flash memories.
     - Renames RTT channel mode `telnet` to `server`.
     - Adds Segger [SystemView](https://www.segger.com/products/development-tools/systemview/) server mode to support direct recording
     from pyOCD via IP (TCP/IP connection) for [`run`](https://open-cmsis-pack.github.io/cmsis-toolbox/pyOCD-Debugger/#command-line-invocation)
     subcommand.
     - Improves robustness and logging of [Segger RTT](https://www.segger.com/products/debug-probes/j-link/technology/about-real-time-transfer/)
     support.
-    - See [pyOCD v0.44.0](https://github.com/pyocd/pyOCD/releases/tag/v0.44.0) for a full list of ehancements and bug fixes.
-
-## 1.5.0
-
-- Pre-release with a preview of the new [Core Peripherals](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger?tab=readme-ov-file#core-peripherals) view that lives under
-  [Trace and Live View](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger?tab=readme-ov-file#trace-and-live-view).
-    - Early feedback is welcomed, please use [GitHub issues](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/new/choose) to raise enhancement requests or defects.
-- Fixes [Component Viewer](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger?tab=readme-ov-file#component-viewer) display and stability issues.
-- Included in this extension pre-release:
-    - [pyOCD v0.43.1](https://github.com/pyocd/pyOCD/releases/tag/v0.43.1)
+- Also included in this extension release:
     - [arm-none-eabi-gdb v14.3.1](https://artifacts.tools.arm.com/arm-none-eabi-gdb/14.3.1/)
-- Full list of required minimum versions for correct functionality of the CMSIS Debugger v1.5.0 pre-release:
+- Full list of required minimum versions for correct functionality of the CMSIS Debugger v1.6.0 release:
     - [Arm CMSIS Solution extension v1.66.0](https://marketplace.visualstudio.com/items?itemName=Arm.cmsis-csolution)
     - [CDT GDB Adapter extension v2.7.0](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.cdt-gdb-vscode)
     - [Memory Inspector v1.2.0](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.memory-inspector)
     - [Peripheral Inspector v1.9.0](https://marketplace.visualstudio.com/items?itemName=eclipse-cdt.peripheral-inspector)
     - [Serial Monitor v0.13.1](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-serial-monitor)
-    - [RTOS Views v0.0.14](https://marketplace.visualstudio.com/items?itemName=mcu-debug.rtos-views)
-- See [v1.4.1...v1.5.0](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/compare/v1.4.1...v1.5.0) for a full list
-of changes that went into this pre-release.
+    - [RTOS Views v0.0.15](https://marketplace.visualstudio.com/items?itemName=mcu-debug.rtos-views)
+- See [CMSIS Debugger 1.6.0 project board](https://github.com/orgs/Open-CMSIS-Pack/projects/21/views/10) for a full list
+of enhancement requests and defects addressed in this release.
 
 ## 1.4.1
 

README.md

@@ -316,6 +316,8 @@ The Core Peripherals view shows information about the following components if im
 - System Tick Timer
 - Fault Reports
 
+![Showing core peripheral contents in the COMPONENT PERIPHERALS view](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main/images/core-peripherals.png)
+
 ### PERIPHERALS
 
 The **PERIPHERALS** view shows the device peripheral registers and allows to change their values. It uses the CMSIS-SVD files that are provided by silicon vendors and distributed as part of the CMSIS Device Family Packs (DFP).

images/core-peripherals.png

@@ -2,7 +2,7 @@
   "name": "vscode-cmsis-debugger",
   "displayName": "Arm CMSIS Debugger",
   "description": "Run and debug embedded and Edge AI projects on Arm Cortex-M single or multi core devices. Connects via pyOCD to CMSIS-DAP or other GDB servers.",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "preview": false,
   "publisher": "Arm",
   "author": "Jens Reinecke <jens.reinecke@arm.com>",
@@ -96,6 +96,20 @@
         "category": "Run and Debug",
         "when": "inDebugMode"
       },
+      {
+        "title": "Enable CPU Time",
+        "command": "vscode-cmsis-debugger.enableCpuTimer",
+        "category": "Run and Debug",
+        "when": "inDebugMode",
+        "enablement": "!vscode-cmsis-debugger.cpuTimerEnabled"
+      },
+      {
+        "title": "Disable CPU Time",
+        "command": "vscode-cmsis-debugger.disableCpuTimer",
+        "category": "Run and Debug",
+        "when": "inDebugMode",
+        "enablement": "vscode-cmsis-debugger.cpuTimerEnabled"
+      },
       {
         "command": "vscode-cmsis-debugger.liveWatch.add",
         "title": "Add Expression",

package-lock.json

@@ -48,6 +48,8 @@ describe('CpuStatesCommands', () => {
         cpuStatesCommands.activate(context, cpuStatesMock);
         expect(vscode.commands.registerCommand as jest.Mock).toHaveBeenCalledWith(CpuStatesCommands.showCpuTimeHistoryID, expect.any(Function));
         expect(vscode.commands.registerCommand as jest.Mock).toHaveBeenCalledWith(CpuStatesCommands.resetCpuTimeHistoryID, expect.any(Function));
+        expect(vscode.commands.registerCommand as jest.Mock).toHaveBeenCalledWith(CpuStatesCommands.enableCpuTimer, expect.any(Function));
+        expect(vscode.commands.registerCommand as jest.Mock).toHaveBeenCalledWith(CpuStatesCommands.disableCpuTimer, expect.any(Function));
     });
 
     it('calls updateFrequyency and showStatesHistory for showCpuTimeHistory command', async () => {
@@ -71,4 +73,24 @@ describe('CpuStatesCommands', () => {
         expect(cpuStatesMock.resetStatesHistory).not.toHaveBeenCalled();
     });
 
+    it('calls enableCpuStates for enableCpuTimer command', async () => {
+        cpuStatesCommands.activate(context, cpuStatesMock);
+        await vscode.commands.executeCommand(CpuStatesCommands.enableCpuTimer);
+        expect(cpuStatesMock.enableCpuStates).toHaveBeenCalledTimes(1);
+    });
+
+    it('calls disableCpuStates for disableCpuTimer command', async () => {
+        cpuStatesCommands.activate(context, cpuStatesMock);
+        await vscode.commands.executeCommand(CpuStatesCommands.disableCpuTimer);
+        expect(cpuStatesMock.disableCpuStates).toHaveBeenCalledTimes(1);
+    });
+
+    it('should fail early if cpuStates is not set', async () => {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const commands: any = new CpuStatesCommands();
+        await expect(commands.handleShowHistory()).resolves.toBeUndefined();
+        await expect(commands.handleResetHistory()).resolves.toBeUndefined();
+        await expect(commands.handleEnableCpuTimer()).resolves.toBeUndefined();
+        await expect(commands.handleDisableCpuTimer()).resolves.toBeUndefined();
+    });
 });

package.json

@@ -21,13 +21,18 @@ import { CpuStates } from './cpu-states';
 export class CpuStatesCommands {
     public static readonly showCpuTimeHistoryID = `${EXTENSION_NAME}.showCpuTimeHistory`;
     public static readonly resetCpuTimeHistoryID = `${EXTENSION_NAME}.resetCpuTimeHistory`;
+    public static readonly enableCpuTimer = `${EXTENSION_NAME}.enableCpuTimer`;
+    public static readonly disableCpuTimer = `${EXTENSION_NAME}.disableCpuTimer`;
     private cpuStates?: CpuStates;
 
     public activate(context: vscode.ExtensionContext, cpuStates: CpuStates): void {
         // Register item and command
         context.subscriptions.push(
             vscode.commands.registerCommand(CpuStatesCommands.showCpuTimeHistoryID, () => this.handleShowHistory()),
-            vscode.commands.registerCommand(CpuStatesCommands.resetCpuTimeHistoryID, () => this.handleResetHistory())
+            vscode.commands.registerCommand(CpuStatesCommands.resetCpuTimeHistoryID, () => this.handleResetHistory()),
+            vscode.commands.registerCommand(CpuStatesCommands.enableCpuTimer, () => this.handleEnableCpuTimer()),
+            vscode.commands.registerCommand(CpuStatesCommands.disableCpuTimer, () => this.handleDisableCpuTimer())
+
         );
         this.cpuStates = cpuStates;
     }
@@ -46,4 +51,18 @@ export class CpuStatesCommands {
         }
         this.cpuStates.resetStatesHistory();
     }
+
+    protected async handleEnableCpuTimer(): Promise<void> {
+        if (!this.cpuStates) {
+            return;
+        }
+        this.cpuStates.enableCpuStates();
+    }
+
+    protected async handleDisableCpuTimer(): Promise<void> {
+        if (!this.cpuStates) {
+            return;
+        }
+        this.cpuStates.disableCpuStates();
+    }
 };

src/features/cpu-states/cpu-states-commands.test.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright 2025 Arm Limited
+ * Copyright 2025-2026 Arm Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -85,6 +85,23 @@ describe('CpuStates', () => {
             cpuStates.activate(tracker);
         });
 
+        it('returns early from showStatesHistory when there are no active cpu states', () => {
+            const warningMessageSpy = jest.spyOn(vscode.window, 'showWarningMessage');
+            // No session started => activeCpuStates is undefined
+            cpuStates.showStatesHistory();
+            expect(warningMessageSpy).not.toHaveBeenCalled();
+        });
+
+        it('returns early from resetStatesHistory when there are no active cpu states', () => {
+            const warningMessageSpy = jest.spyOn(vscode.window, 'showWarningMessage');
+            const refreshListener = jest.fn();
+            cpuStates.onRefresh(refreshListener);
+            // No session started => activeCpuStates is undefined
+            cpuStates.resetStatesHistory();
+            expect(warningMessageSpy).not.toHaveBeenCalled();
+            expect(refreshListener).not.toHaveBeenCalled();
+        });
+
         it('manages session lifecycles correctly', async () => {
             cpuStates.activate(tracker);
             // No active session yet
@@ -409,6 +426,31 @@ describe('CpuStates', () => {
             expect(debugConsoleOutput.find(line => line.includes('(PC=0x08000396 <myframe>, myfunction::2)'))).toBeDefined();
         });
 
+        it('enable cpu states command sets context key to true', async () => {
+            const executeCommandSpy = jest.spyOn(vscode.commands, 'executeCommand').mockResolvedValue(undefined);
+            cpuStates.activate(tracker);
+            await cpuStates.enableCpuStates();
+            expect(executeCommandSpy).toHaveBeenCalledWith('setContext', 'vscode-cmsis-debugger.cpuTimerEnabled', true);
+        });
+
+        it('disable cpu states command sets context key to false', async () => {
+            const executeCommandSpy = jest.spyOn(vscode.commands, 'executeCommand').mockResolvedValue(undefined);
+            cpuStates.activate(tracker);
+            await cpuStates.disableCpuStates();
+            expect(executeCommandSpy).toHaveBeenCalledWith('setContext', 'vscode-cmsis-debugger.cpuTimerEnabled', false);
+        });
+
+        it('enable cpu states sets enableCpuStates flag to true', async () => {
+            cpuStates.activate(tracker);
+            await cpuStates.enableCpuStates();
+            expect((cpuStates as unknown as { enableCpuStatesFlag: boolean }).enableCpuStatesFlag).toEqual(true);
+        });
+
+        it('disable cpu states sets enableCpuStates flag to false', async () => {
+            cpuStates.activate(tracker);
+            await cpuStates.disableCpuStates();
+            expect((cpuStates as unknown as { enableCpuStatesFlag: boolean }).enableCpuStatesFlag).toEqual(false);
+        });
     });
 
     describe('tests with established connection and CPU states not supported', () => {

src/features/cpu-states/cpu-states-commands.ts

@@ -52,6 +52,7 @@ export class CpuStates {
 
     public activeSession: GDBTargetDebugSession | undefined;
     private sessionCpuStates: Map<string, SessionCpuStates> = new Map();
+    private enableCpuStatesFlag: boolean = true;
 
     public get activeCpuStates(): SessionCpuStates|undefined {
         if (!this.activeSession) {
@@ -69,6 +70,7 @@ export class CpuStates {
         tracker.onContinued(event => this.handleContinuedEvent(event));
         tracker.onStopped(event => this.handleStoppedEvent(event));
         tracker.onStackTrace(stackTrace => this.handleStackTrace(stackTrace));
+        vscode.commands.executeCommand('setContext', 'vscode-cmsis-debugger.cpuTimerEnabled', true);
     }
 
     protected handleOnWillStartSession(session: GDBTargetDebugSession): void {
@@ -197,6 +199,9 @@ export class CpuStates {
         if (!states) {
             return;
         }
+        if (!this.enableCpuStatesFlag) {
+            return;
+        }
         const newCycles = await session.readMemoryU32(DWT_CYCCNT_ADDRESS);
         if (newCycles === undefined) {
             return;
@@ -320,4 +325,15 @@ export class CpuStates {
         states.skipFrequencyUpdate = false;
         this._onRefresh.fire(0);
     }
+
+    public async enableCpuStates(): Promise<void> {
+        this.enableCpuStatesFlag = true;
+        await vscode.commands.executeCommand('setContext', 'vscode-cmsis-debugger.cpuTimerEnabled', this.enableCpuStatesFlag);
+    }
+
+    public async disableCpuStates(): Promise<void> {
+        this.enableCpuStatesFlag = false;
+        await vscode.commands.executeCommand('setContext', 'vscode-cmsis-debugger.cpuTimerEnabled', this.enableCpuStatesFlag);
+    }
+
 };