allow no merge of SVD registers addresses

Author: haneefdm

CHANGELOG.md

@@ -4,6 +4,11 @@ ChangeLog
 * Store register/peripheral settings in the appropriate folder instead of the first folder
 * Kill gdb-server if the user kills/exits gdb without using the proper disconnect/Stop buttons/process/commands
 * VSCode was terminating Cortex-Debug before it was done. st-util exit behavior was also not clean as it did not exit on a disconnect.
+* Preliminary support for data watchpoints
+* svd now can allow no merge of consequtive addresses with a -1 specified for `svdAddrGapThreshold`
+* You can now save the output of a gdb-server into a text file by specifying `cortex-debug.dbgServerLogfile` in User/Workspace settings. This will save output from the servers from all sessions (not just the recent). This is primarily for debugging and for users when submitting issues.
+* Path names for gdb-servers can be OS specific. For instance `cortex-debug.openocdPath` can be suffixed with one of `.linux`, `.osx` or `.windows`. For instance `cortex-debug.openocdPath.windows` is used only on Windows and if that is missing, it will default looking for cortex-debug.openocdPath`.
+* SWO output can now be logged (saved) to a file just like RTT output
 
 #V0.4.7
 * Fixed a regression for STLink gdbserver. It was in fact accidentally working in prior releases. The real bug is now fixed. Issue #494

debug_attributes.md

@@ -31,9 +31,9 @@
 | serverArgs | Common | Additional arguments to pass to gdb-server command line
 | serverpath | Common | This setting can be used to override the gdb-server path user/workspace setting for a particular launch configuration. It is the full pathname to the executable or name of executable if it is in your PATH
 | servertype | Common | GDB Server type - supported types are jlink, openocd, pyocd, pe, stlink, stutil, qemu and external
-| showDevDebugOutput | Common | Prints all GDB responses to the console
-| showDevDebugTimestamps | Common | Show timestamps when 'showDevDebugOutput' is true
-| svdAddrGapThreshold | Common | If the gap between registers is less than this threshold (multiple of 8), combine into a single read from device
+| showDevDebugOutput | Common | Prints all GDB (parsed) responses to the console. Can also be a string 'raw' or 'raw-only'
+| showDevDebugTimestamps | Common | Show timestamps when 'showDevDebugOutput' is enabled
+| svdAddrGapThreshold | Common | If the gap between registers is less than this threshold (multiple of 8), combine into a single read from device. -1 means never combine registers and is very slow
 | svdFile | Common | Path to an SVD file describing the peripherals of the microcontroller; if not supplied then one may be selected based upon the 'device' entered.
 | swoConfig | Common | (unknown)
 | targetId | Common | On BMP this is the ID number that should be passed to the attach command (defaults to 1); for PyOCD this is the target identifier (only needed for custom hardware)

package.json

@@ -1,5 +1,5 @@
 {
-    "version": "0.4.8-pre3",
+    "version": "0.4.8-pre4",
     "activationEvents": [
         "onDebugResolve:cortex-debug"
     ],

src/frontend/svd.ts

@@ -88,7 +88,8 @@ export class SVDParser {
                     peripherials.sort(PeripheralNode.compare);
 
                     for (const p of peripherials) {
-                        p.markAddresses();
+                        // p.markAddresses();
+                        p.collectRanges([]);
                     }
 
                     resolve(peripherials);
@@ -212,16 +213,16 @@ export class SVDParser {
         return fields;
     }
 
-    private static parseRegisters(regInfo_: any[], parent: PeripheralNode | PeripheralClusterNode): PeripheralRegisterNode[] {
-        const regInfo = [...regInfo_];      // Make a shallow copy,. we will work on this
+    private static parseRegisters(regInfoOrig: any[], parent: PeripheralNode | PeripheralClusterNode): PeripheralRegisterNode[] {
+        const regInfo = [...regInfoOrig];      // Make a shallow copy,. we will work on this
         const registers: PeripheralRegisterNode[] = [];
 
         const localRegisterMap = {};
         for (const r of regInfo) {
             const nm = r.name[0];
             localRegisterMap[nm] = r;
             SVDParser.peripheralRegisterMap[parent.name + '.' + nm] = r;
-        };
+        }
 
         // It is wierd to iterate this way but it can handle forward references, are they legal? not sure
         // Or we could have done this work in the loop above. Not the best way, but it is more resilient to
@@ -386,7 +387,7 @@ export class SVDParser {
     }
 
     private static parsePeripheral(p: any, defaults: { accessType: AccessType, size: number, resetValue: number }): PeripheralNode {
-        let totalLength = 0
+        let totalLength = 0;
         if (p.addressBlock) {
             for (const ab of p.addressBlock) {
                 const offset = parseInteger(ab.offset[0]);

src/frontend/views/nodes/basenode.ts

@@ -1,6 +1,6 @@
 import { Command, TreeItem } from 'vscode';
 import { NumberFormat, NodeSetting } from '../../../common';
-import { AddressRangesInUse } from '../../addrranges';
+import { AddressRangesInUse, AddrRange } from '../../addrranges';
 
 export abstract class BaseNode {
     public expanded: boolean;
@@ -45,6 +45,7 @@ export abstract class PeripheralBaseNode extends BaseNode {
     public abstract getPeripheral(): PeripheralBaseNode;
 
     public abstract markAddresses(a: AddressRangesInUse): void;
+    public abstract collectRanges(ary: AddrRange[]): void;      // Append addr range(s) to array
 
     public abstract saveState(path?: string): NodeSetting[];
     public abstract findByPath(path: string[]): PeripheralBaseNode;

src/frontend/views/nodes/messagenode.ts

@@ -1,6 +1,6 @@
 import { PeripheralBaseNode, BaseNode } from './basenode';
 import { TreeItem, TreeItemCollapsibleState } from 'vscode';
-import { AddressRangesInUse } from '../../addrranges';
+import { AddressRangesInUse, AddrRange } from '../../addrranges';
 import { NodeSetting } from '../../../common';
 
 export class MessageNode extends PeripheralBaseNode {
@@ -38,6 +38,9 @@ export class MessageNode extends PeripheralBaseNode {
     public markAddresses(a: AddressRangesInUse): void {
     }
 
+    public collectRanges(ary: AddrRange[]): void {
+    }
+
     public saveState(path?: string): NodeSetting[] {
         return [];
     }

src/frontend/views/nodes/peripheralclusternode.ts

@@ -4,7 +4,7 @@ import { AccessType } from '../../svd';
 import { PeripheralRegisterNode } from './peripheralregisternode';
 import { PeripheralNode } from './peripheralnode';
 import { NodeSetting, NumberFormat } from '../../../common';
-import { AddressRangesInUse } from '../../addrranges';
+import { AddressRangesInUse, AddrRange } from '../../addrranges';
 import { hexFormat } from '../../utils';
 
 export interface ClusterOptions {
@@ -116,6 +116,10 @@ export class PeripheralClusterNode extends PeripheralBaseNode {
         this.children.map((r) => { r.markAddresses(addrs); });
     }
 
+    public collectRanges(ary: AddrRange[]): void {
+        this.children.map((r) => { r.collectRanges(ary); });
+    }
+    
     public getPeripheral(): PeripheralBaseNode {
         return this.parent.getPeripheral();
     }

src/frontend/views/nodes/peripheralfieldnode.ts

@@ -2,7 +2,7 @@ import { TreeItem, TreeItemCollapsibleState, window, debug, MarkdownString, Tree
 import { PeripheralBaseNode } from './basenode';
 import { AccessType } from '../../svd';
 import { PeripheralRegisterNode } from './peripheralregisternode';
-import { AddressRangesInUse } from '../../addrranges';
+import { AddressRangesInUse, AddrRange } from '../../addrranges';
 import { NumberFormat, NodeSetting } from '../../../common';
 import { parseInteger, binaryFormat, hexFormat } from '../../utils';
 
@@ -85,11 +85,11 @@ export class PeripheralFieldNode extends PeripheralBaseNode {
         const displayValue = this.getFormattedValue(this.getFormat());
         const labelItem: TreeItemLabel = {
             label: label + ' ' + displayValue
-        }
+        };
         if (displayValue !== this.prevValue) {
             labelItem.highlights = [[label.length + 1, labelItem.label.length]];
             this.prevValue = displayValue;
-        }        
+        }
         const item = new TreeItem(labelItem, TreeItemCollapsibleState.None);
 
         item.contextValue = context;
@@ -289,4 +289,8 @@ export class PeripheralFieldNode extends PeripheralBaseNode {
     public markAddresses(a: AddressRangesInUse): void {
         throw new Error('Method not implemented.');
     }
+
+    public collectRanges(a: AddrRange[]): void {
+        throw new Error('Method not implemented.');
+    }
 }

src/frontend/views/nodes/peripheralnode.ts

@@ -149,7 +149,7 @@ export class PeripheralNode extends PeripheralBaseNode {
         return MemReadUtils.readMemoryChunks(this.baseAddress, this.addrRanges, this.currentValue);
     }
 
-    public markAddresses(): void {
+    private pvt_markAddresses(): AddrRange[] {
         let ranges = [new AddrRange(this.baseAddress, this.totalLength)];   // Default range
         const skipAddressGaps = true;
 
@@ -161,12 +161,61 @@ export class PeripheralNode extends PeripheralBaseNode {
             ranges = addresses.getAddressRangesOptimized(this.baseAddress, false, this.gapThreshold);
         }
 
+        // OpenOCD has an issue where the max number of bytes readable are 8191 (instead of 8192)
+        // which causes unaligned reads (via gdb) and silent failures. There is patch for this in OpenOCD
+        // but in general, it is good to split the reads up. see http://openocd.zylin.com/#/c/5109/
+        // Another benefit, we can minimize gdb timeouts
+        const maxBytes = (4 * 1024); // Should be a multiple of 4 to be safe for MMIO reads
+        return AddressRangesInUse.splitIntoChunks(ranges, maxBytes, this.name, this.totalLength);
+    }
+
+    public markAddresses(): void {
+        this.addrRanges = this.pvt_markAddresses();
+    }
+
+    public collectRanges(): void {
+        const addresses: AddrRange[] = [];
+        this.children.map((child) => child.collectRanges(addresses));
+        addresses.sort((a, b) => (a.base < b.base) ? -1 : ((a.base > b.base) ? 1 : 0));
+        addresses.map((r) => r.base += this.baseAddress);
+
+        const maxGap = this.gapThreshold;
+        let ranges: AddrRange[] = [];
+        if (maxGap >= 0) {
+            let last: AddrRange = null;
+            for (const r of addresses) {
+                if (last && ((last.nxtAddr() + maxGap) >= r.base)) {
+                    const max = Math.max(last.nxtAddr(), r.nxtAddr());
+                    last.length = max - last.base;
+                } else {
+                    ranges.push(r);
+                    last = r;
+                }
+            }
+        } else {
+            ranges = addresses;
+        }
+
         // OpenOCD has an issue where the max number of bytes readable are 8191 (instead of 8192)
         // which causes unaligned reads (via gdb) and silent failures. There is patch for this in OpenOCD
         // but in general, it is good to split the reads up. see http://openocd.zylin.com/#/c/5109/
         // Another benefit, we can minimize gdb timeouts
         const maxBytes = (4 * 1024); // Should be a multiple of 4 to be safe for MMIO reads
         this.addrRanges = AddressRangesInUse.splitIntoChunks(ranges, maxBytes, this.name, this.totalLength);
+
+        const verify = true;        // TODO: turn this off
+        if (verify && (maxGap >= 0)) {
+            const msg = 'PeripheralNode.collectRanges: address-range verification failed. Please report this problem to Cortex-Debug repo';
+            const golden = this.pvt_markAddresses();
+            if (this.addrRanges.length !== golden.length) {
+                throw new Error('1. ' + msg);
+            }
+            this.addrRanges.map((r, ix) => {
+                if ((r.base !== golden[ix].base) || (r.length !== golden[ix].length)) {
+                    throw new Error('2. ' + msg);
+                }
+            });
+        }
     }
 
     public getPeripheralNode(): PeripheralNode {

src/frontend/views/nodes/peripheralregisternode.ts

@@ -6,7 +6,7 @@ import { PeripheralFieldNode } from './peripheralfieldnode';
 import { AccessType } from '../../svd';
 import { extractBits, createMask, hexFormat, binaryFormat } from '../../utils';
 import { NumberFormat, NodeSetting } from '../../../common';
-import { AddressRangesInUse } from '../../addrranges';
+import { AddressRangesInUse, AddrRange } from '../../addrranges';
 
 export interface PeripheralRegisterOptions {
     name: string;
@@ -85,7 +85,7 @@ export class PeripheralRegisterNode extends PeripheralBaseNode {
         const displayValue = this.getFormattedValue(this.getFormat());
         const labelItem: TreeItemLabel = {
             label: label + ' ' + displayValue
-        }
+        };
         if (displayValue !== this.prevValue) {
             labelItem.highlights = [[label.length + 1, labelItem.label.length]];
             this.prevValue = displayValue;
@@ -305,4 +305,8 @@ export class PeripheralRegisterNode extends PeripheralBaseNode {
         const finalOffset = this.parent.getOffset(this.offset);
         addrs.setAddrRange(finalOffset, this.size / 8);
     }
+    public collectRanges(addrs: AddrRange[]): void {
+        const finalOffset = this.parent.getOffset(this.offset);
+        addrs.push(new AddrRange(finalOffset, this.size / 8));
+    }
 }