8.8.1.1.2.3.1. Types¶

8.8.1.1.2.3.1.1. Address¶

An address on the target. The debugger will accept non-negative integers or any hexadecimal or decimal string representation.

type Address = int | str¶

8.8.1.1.2.3.1.2. Page¶

A memory page on the target. Either the zero based index of the page, or its name. The program page is always index 0.

type Page = int | str¶

8.8.1.1.2.3.1.3. DSLocation¶

A memory location on the target. Specifies an address and, optionally, a memory page.

Any address is a valid location. To specify a page, the location must be a numeric string representing the address followed by @<page name>, @pa (physical access), or @ipa (intermediate physical access). If no page is specified, then the default memory page is assumed.

# The following are all valid DSLocations (assuming the existence of pages PROGRAM and DATA)
0x2400
9216
"0x2400"
"0x2400@PROGRAM"
"9216@PROGRAM"
"0x2400@DATA"

type DSLocation = Address | str¶

8.8.1.1.2.3.1.4. CoreList¶

class CoreList¶

cores: list[str]¶: The currently available debuggable cores.

nonDebugCores: list[str]¶: The currently available non-debuggable cores.

8.8.1.1.2.3.1.5. VersionResult¶

class VersionResult¶

version: str¶: The version string in the form "major.minor.revision.build"

major: int¶: The major version number

minor: int¶: The minor version number

revision: int¶: The revision number

build: int¶: The build number

8.8.1.1.2.3.1.6. NumericRange¶

class NumericRange¶

min: int¶: The lower bound of the range

max: int¶: The upper bound of the range

8.8.1.1.2.3.1.7. BigNumericRange¶

class BigNumericRange¶

min: int | str¶: The lower bound of the range

max: int | str¶: The upper bound of the range

8.8.1.1.2.3.1.8. BaseSetting¶

class BaseSetting¶

id: str¶: The unique identifier of the setting.

name: str¶: The name of the setting.

8.8.1.1.2.3.1.9. DebugSetting¶

A debugger setting for a particular target. The setting's type can be determined by inspecting the type field.

type DebugSetting = BoolSetting | NumericSetting | StringSetting¶

8.8.1.1.2.3.1.10. BoolSetting¶

A boolean setting.

class BoolSetting¶

id: str¶: The unique identifier of the setting.

name: str¶: The name of the setting.

type: Literal['bool']¶: Indicates this is a boolean setting.

value: bool¶: The value of the setting.

8.8.1.1.2.3.1.11. NumericSetting¶

A numeric setting, possibly restricted to a range.

class NumericSetting¶

id: str¶: The unique identifier of the setting.

name: str¶: The name of the setting.

type: Literal['numeric']¶: Indicates this is a numeric setting.

value: int¶: The value of the setting.

allowedRange: NumericRange, optional¶: If present, indicates that the value must not lie outside the range (both ends are in the range).

8.8.1.1.2.3.1.12. StringSetting¶

A string-valued setting, possibly restricted to a list of possible values.

class StringSetting¶

id: str¶: The unique identifier of the setting.

name: str¶: The name of the setting.

type: Literal['string']¶: Indicates this is a string-valued setting.

value: str¶: The value of the setting.

unresolvedValue: str, optional¶: The value of the property before any variable substitutions have been applied. Is only present if variable substitutions have occurred. For more details on variable substitution in settings see settingsVariableSubstitutions().

allowedValues: list[str], optional¶: If present, indicates that the setting's value must be one of these values.

8.8.1.1.2.3.1.13. BreakpointProperty¶

A property of a breakpoint. The property's exact value can be determined by inspecting the type field.

type BreakpointProperty = BoolBreakpointProperty | IntegerBreakpointProperty | LocationBreakpointProperty | StringBreakpointProperty¶

8.8.1.1.2.3.1.14. BaseBreakpointProperty¶

class BaseBreakpointProperty¶

id: str¶: The unique identifier for the property.

description: str¶: A description of the property.

8.8.1.1.2.3.1.15. BoolBreakpointProperty¶

class BoolBreakpointProperty¶

id: str¶: The unique identifier for the property.

description: str¶: A description of the property.

type: Literal['bool']¶: Indicates this is a boolean property.

value: bool¶: The property's value.

8.8.1.1.2.3.1.16. IntegerBreakpointProperty¶

class IntegerBreakpointProperty¶

id: str¶: The unique identifier for the property.

description: str¶: A description of the property.

type: Literal['int']¶: Indicates this is an integer property.

value: int | str¶: The property's value.

allowedValues: list[int | str], optional¶: If present, indicates that the value must be one of these values.

allowedRange: BigNumericRange, optional¶: If present, indicates that the value must not lie outside the range (both ends are in the range).

8.8.1.1.2.3.1.17. LocationBreakpointProperty¶

class LocationBreakpointProperty¶

id: str¶: The unique identifier for the property.

description: str¶: A description of the property.

type: Literal['location']¶: Indicates this is a location property.

value: int | str¶: The value the location is based on.

8.8.1.1.2.3.1.18. StringBreakpointProperty¶

class StringBreakpointProperty¶

id: str¶: The unique identifier for the property.

description: str¶: A description of the property.

type: Literal['string']¶: Indicates this is a string property.

value: str¶: The property's value.

allowedValues: list[str], optional¶: If present, indicates that the value must be one of these values.

8.8.1.1.2.3.1.19. ClockEvent¶

class ClockEvent¶

id: int¶: The event's identifier.

name: str¶: The event's name.

8.8.1.1.2.3.1.20. GroupInfo¶

class GroupInfo¶

id: str¶: The group's unique identifier.

name: str¶: The group's name.

8.8.1.1.2.3.1.21. RegisterInfo¶

class RegisterInfo¶

id: str¶: The register's unique identifier.

name: str¶: The register's name.

location: int | str, optional¶: The address in memory where this register exists. Undefined for core registers.

readable: bool¶: True if this register can be read. Note that the target must be in a state that allows access as well.

writable: bool¶: True if this register can be written. Note that the target must be in a state that allows access as well.

8.8.1.1.2.3.1.22. RegistersGroupsResult¶

class RegistersGroupsResult¶

registers: list[RegisterInfo]¶: The list of registers in the group.

groups: list[GroupInfo]¶: The list of register groups in the group.

8.8.1.1.2.3.1.23. RegisterBitfield¶

class RegisterBitfield¶

id: str¶: The bitfield's unique identifier.

name: str¶: The bitfield's name.

start: int¶: The bit within the containing register that this bitfield starts at.

stop: int¶: The bit within the containing register that this bitfield ends at.

readable: bool¶: True if this bitfield can be read.

writable: bool¶: True if this bitfield can be written.

8.8.1.1.2.3.1.24. SymbolsSourceLineResult¶

class SymbolsSourceLineResult¶

path: str¶: The path to the source file.

line: int¶: The line number.

column: int¶: The column number.

8.8.1.1.2.3.1.25. FrameResult¶

class FrameResult¶

functionName: str, optional¶: The function's name.

sourceLine: SymbolsSourceLineResult, optional¶: The source line of the frame.

pc: str¶: The program counter.

locals: list[str]¶: The local variables in this frame

8.8.1.1.2.3.1.26. CallstackResult¶

class CallstackResult¶

frames: list[FrameResult]¶: The frames in the callstack.

reasonUnwindHalted: str¶: The reason the callstack unwind was halted.

8.8.1.1.2.3.1.27. MemoryMapEntry¶

class MemoryMapEntry¶

start: DSLocation¶: The starting address (inclusive) of this region.

end: DSLocation¶: The ending address (inclusive) of this region.

attributes: list[str]¶: The string attributes of this region. These are the attributes passed to GEL_MapAddStr as a | separated list.

8.8.1.1.2.3.1.28. MemoryMapResult¶

class MemoryMapResult¶

entries: list[MemoryMapEntry]¶: The list of entries in the memory map.

enabled: bool¶: True if the memory map is enabled, false otherwise.

8.8.1.1.2.3.1.29. MemoryPageInfo¶

class MemoryPageInfo¶

name: str¶: The name of the memory page.

8.8.1.1.2.3.1.30. MemoryPages¶

class MemoryPages¶

pages: list[MemoryPageInfo]¶: The list of target's memory pages.

8.8.1.1.2.3.1.31. ArmAdvancedFeaturesAction¶

class ArmAdvancedFeaturesAction¶

action: str¶: The action's unique identifier.

description: str¶: A brief description of the action.

8.8.1.1.2.3.1.32. DisassemblyLine¶

class DisassemblyLine¶

address: int | str¶: The memory location associated with this disassembly line.

numOpCodes: int¶: The number of opcodes disassembled for this line.

text: str¶: The text of the disassembly line. This will include the address and the bytes of the opcode(s).

8.8.1.1.2.3.1.33. FunctionInfo¶

class FunctionInfo¶

name: str¶: The function's name.

file: str¶: Path to the function's source file.

8.8.1.1.2.3.1.34. SourceLineInfo¶

class SourceLineInfo¶

line: int¶: The source line's number.

file: str¶: The source file's path.

8.8.1.1.2.3.1.35. DisassemblyResult¶

class DisassemblyResult¶

disassembly: list[DisassemblyLine]¶: The list of disassembly lines.