Merge pull request #1072 from minuteos/feat/stlink-swo

SWO support when using ST-LINK GDB server

Author: haneefdm

CHANGELOG.md

@@ -10,6 +10,7 @@
     * It is not clear what (should) happens when you use the `Restart` button when multiple debuggers are active at the same time. For instance in a multi-core session. It may work, but we have not tested it.
   * This is the reason why we implemented the `Reset` button a while ago because VSCode `Restart` meant different (undocumented) behaviors at different times.
   * As a result, all the Restart related launch.json properties no longer apply. But, for compatibility reasons, they still exist and used by the `Reset` functionality when a `Reset` specific property does not exist. This is what used to happen in the previous releases.
+* ST-LINK GDB server (*not* st-util) now supports SWO functionality, using standard configuration options.
 
 # V1.12.1
 * Fix for [#923: Local variables with same name between functions not tracking or updating context](https://github.com/Marus/cortex-debug/issues/923)
@@ -27,9 +28,9 @@ This is a major release. It has been in pre-release for quite a while and some o
   * [RTOS Views](https://marketplace.visualstudio.com/items?itemName=mcu-debug.rtos-views)
   * [Memory View](https://marketplace.visualstudio.com/items?itemName=mcu-debug.memory-view)
   * [Peripheral Viewer](https://marketplace.visualstudio.com/items?itemName=mcu-debug.peripheral-viewer)
- 
+
  *Note: Please install this extension using VSCode with a working internet connection. Do not try to install it manually. If you install it manually, then also make sure all the other dependent extensions are installed.*
-  
+
 # V1.11.3
 * Issue #861: Potential fix
 * Issue #867: STLink make it so that user has to enable `-shared` if needed. Before it was automatically added to the command-line and there was no (good) way to remove it

README.md

@@ -5,7 +5,7 @@
 Debugging support for ARM Cortex-M Microcontrollers with the following features:
 
 * Highly configurable. See https://github.com/Marus/cortex-debug/blob/master/debug_attributes.md
-* Support J-Link, OpenOCD GDB Server, STMicroelectronic's ST-LINK GDB server (no SWO support yet), pyOCD
+* Support J-Link, OpenOCD GDB Server, STMicroelectronic's ST-LINK GDB server, pyOCD
 * Initial support for the Black Magic Probe (This has not been as heavily tested; SWO can only be captured via a serial port)
 * Partial support textane/stlink (st-util) GDB Servers (SWO can only be captured via a serial port)
 * Multi-core and multi-session debugging. See https://github.com/Marus/cortex-debug/wiki/Multi-core-debugging

src/frontend/configprovider.ts

@@ -589,12 +589,6 @@ export class CortexDebugConfigurationProvider implements vscode.DebugConfigurati
             return 'The ST-Link GDB Server does not have support for the rtos option.';
         }
 
-        if (config.swoConfig.enabled && config.swoConfig.source === 'probe') {
-            vscode.window.showWarningMessage('SWO support is not available from the probe when using the ST-Link GDB server. Disabling SWO.');
-            config.swoConfig = { enabled: false, ports: [], cpuFrequency: 0, swoFrequency: 0 };
-            config.graphConfig = [];
-        }
-
         return null;
     }
 

src/frontend/swo/core.ts

@@ -289,9 +289,14 @@ export class SWOCore extends SWORTTCoreBase {
         }, (error) => {
             this.functionSymbols = [];
         });
-        
-        if (this.source.connected) { this.connected = true; }
-        else { this.source.on('connected', () => { this.connected = true; }); }
+
+        const onConnected = () => {
+            this.connected = true;
+            session.customRequest('swo-connected');
+        };
+
+        if (this.source.connected) { onConnected(); }
+        else { this.source.on('connected', onConnected); }
         this.source.on('data', this.handleData.bind(this));
         this.source.on('disconnected', this.handleDisconnected.bind(this));
 

src/gdb.ts

@@ -15,7 +15,8 @@ import { extractBits, hexFormat } from './frontend/utils';
 import { Variable, VariableObject, MIError, OurDataBreakpoint, OurInstructionBreakpoint, OurSourceBreakpoint } from './backend/backend';
 import {
     TelemetryEvent, ConfigurationArguments, StoppedEvent, GDBServerController, SymbolFile,
-    createPortName, GenericCustomEvent, quoteShellCmdLine, toStringDecHexOctBin, ADAPTER_DEBUG_MODE, defSymbolFile, CTIAction, getPathRelative
+    createPortName, GenericCustomEvent, quoteShellCmdLine, toStringDecHexOctBin, ADAPTER_DEBUG_MODE, defSymbolFile, CTIAction, getPathRelative,
+    SWOConfigureEvent
 } from './common';
 import { GDBServer, ServerConsoleLog } from './backend/server';
 import { MINode } from './backend/mi_parse';
@@ -267,6 +268,9 @@ export class GDBDebugSession extends LoggingDebugSession {
 
     protected tcpPortAllocatedListner = this.tcpPortsAllocated.bind(this);
 
+    private swoLaunchPromise = Promise.resolve();
+    private swoLaunched?: () => void;
+
     public constructor(debuggerLinesStartAt1: boolean, public readonly isServer: boolean = false, threadID: number = 1) {
         super(undefined, debuggerLinesStartAt1, isServer);     // Use if deriving from LogDebugSession
         // super(debuggerLinesStartAt1, isServer);  // Use if deriving from DebugSession
@@ -660,6 +664,9 @@ export class GDBDebugSession extends LoggingDebugSession {
                         if (showTimes) { this.handleMsg('log', 'Debug Time: objdump and nm done...\n'); }
                         if (showTimes) { this.handleMsg('log', 'Debug Time: All pending items done, proceed to gdb connect...\n'); }
 
+                        // if SWO launch was requested by the server controller, we wait for it to connect before starting actual debug
+                        await this.swoLaunchPromise;
+
                         // This is the last of the place where ports are allocated
                         this.sendEvent(new GenericCustomEvent('post-start-server', this.args));
                         commands.push(...this.serverController.initCommands());
@@ -1211,6 +1218,11 @@ export class GDBDebugSession extends LoggingDebugSession {
                 }
                 break;
             }
+            case 'swo-connected': {
+                this.swoLaunched?.();
+                this.swoLaunched = undefined;
+                break;
+            }
             default:
                 response.body = { error: 'Invalid command.' };
                 this.sendResponse(response);
@@ -1674,6 +1686,16 @@ export class GDBDebugSession extends LoggingDebugSession {
     }
 
     private serverControllerEvent(event: DebugProtocol.Event) {
+        if (event instanceof SWOConfigureEvent) {
+            this.swoLaunchPromise = new Promise((resolve, reject) => {
+                const timeout = setTimeout(() => reject(new Error('Timeout waiting for SWV connection')), 1000);
+                this.swoLaunched = () => {
+                    clearTimeout(timeout);
+                    resolve();
+                };
+            });
+        }
+
         this.sendEvent(event);
     }
 

src/stlink.ts

@@ -134,8 +134,34 @@ export class STLinkServerController extends EventEmitter implements GDBServerCon
         return commands;
     }
 
-    public swoAndRTTCommands(): string[] {
-        return [];
+    public swoAndRTTCommands(): string[]{
+        const commands = [];
+        if (this.args.swoConfig.enabled) {
+            const swocommands = this.SWOConfigurationCommands();
+            commands.push(...swocommands);
+        }
+        return commands;
+    }
+
+    private SWOConfigurationCommands(): string[] {
+        const { decoders, swoFrequency, cpuFrequency } = this.args.swoConfig;
+        const portMask = '0x' + calculatePortMask(decoders).toString(16);
+        const ratio = Math.floor(cpuFrequency / swoFrequency) - 1;
+
+        const commands = [
+            'EnableITMAccess',
+            `BaseSWOSetup ${ratio}`,
+            'SetITMId 1',
+            'ITMDWTTransferEnable',
+            'DisableITMPorts 0xFFFFFFFF',
+            `EnableITMPorts ${portMask}`,
+            'EnableDWTSync',
+            this.args.swoConfig.profile ? 'EnablePCSample' : 'DisablePCSample',
+            'ITMSyncEnable',
+            'ITMGlobalEnable'
+        ];
+
+        return commands.map((c) => `interpreter-exec console "${c}"`);
     }
 
     public serverExecutable(): string {
@@ -176,6 +202,17 @@ export class STLinkServerController extends EventEmitter implements GDBServerCon
             serverargs.push('--swd');
         }
 
+        if (this.args.swoConfig.enabled)
+        {
+            const swoport = this.ports['swoPort'];
+            serverargs.push('--swo-port', swoport.toString());
+
+            const { cpuFrequency, swoFrequency } = this.args.swoConfig;
+
+            serverargs.push('--cpu-clock', cpuFrequency.toString());
+            serverargs.push('--swo-clock-div', Math.floor(cpuFrequency / swoFrequency).toString());
+        }
+
         if (this.args.serialNumber) {
             serverargs.push('--serial-number', this.args.serialNumber);
         }
@@ -196,8 +233,16 @@ export class STLinkServerController extends EventEmitter implements GDBServerCon
     }
 
     public serverLaunchStarted(): void {}
-    public serverLaunchCompleted(): void {}
-    
+    public serverLaunchCompleted(): void {
+        if (this.args.swoConfig.enabled) {
+            this.emit('event', new SWOConfigureEvent({
+                type: 'socket',
+                args: this.args,
+                port: this.ports['swoPort'].toString()
+            }));
+        }
+    }
+
     public debuggerLaunchStarted(): void {}
     public debuggerLaunchCompleted(): void {}
 }