Port DEBUGGER - DEFAULT¶

Stimulation¶

This port has no stimulus capabilities.

Properties 🛈¶

Name	Default value	Type	Description
Core		string	Index or name of the core to be accessed. When empty the master core will be used.
ELF file		uri	Local path of the ELF file (relative to the workspace). If set to <auto>, the entry from the test configuration will be used
HEX-File		uri	Local path of the HEX file (relative to the workspace). If set to <auto>, the entry from the test configuration will be used
Flash HSM core	☐	bool	Specifies whether an available HSM core is to be flashed as well.

Jobs 🛈¶

Break¶

Breaks the execution

DumpMemoryToHex¶

Stores a memory range to a HEX file and transfers it to the ecu.test computer

Parameter

Name	Type	Description
Address	int	Memory start address where to read
Count	int	Number of bytes to be read
Filename	uri	Path where to save the HEX file on the ecu.test computer

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool	Saving successful

EraseChip¶

Executes the chip’s Erase function

EraseConfig¶

Erases the target’s configuration

EraseSector¶

Erases a sector

Parameter

Name	Available if	Default value	Valid values	Type	Description
sectorIndex				int	This sector (zero-based index) will be erased

FlashProgramFile¶

Flashing a program to the target

Parameter

Name	Default value	Type	Description
ElfFile		string	Local path to the ELF file which have to be loaded (relative to the workspace). If this option is empty, a HEX file must be stated.
ForceFlash	☐	bool	Program file is flashed without prior verification.
HexFile		string	Local path to the HEX file which have to be loaded (relative to the workspace). If this option is empty, an ELF file must be stated.
VerifyAfterFlash	☐	bool	After flashing, the program on the target will be verified

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool	Verification successful

GenerateCoverageReport¶

Starts the coverage analysis process from capture results of a configured trace stream and stores the results in a HTML report. This requires a trace configuration in the UDE workspace. After completion the generated HTML report will be found in the report directory.

Parameter

Name	Available if	Default value	Valid values	Type	Description
reportFileName				string	Name of the trace report html file (optional)
traceStreamNumber		0		int	Trace Stream item number

Return value

Name	Available if	Default value	Valid values	Type	Description
reportFileName				string	Filename of the transfered coverage report in the report folder

GetCallStack¶

Returns the current call stack.

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object	List of frames consisting of program counter and function name.

GetCoreFamily¶

Returns the family information of the referenced core.

Return value

Name	Available if	Default value	Valid values	Type	Description
familyInfo				string

GetCoreName¶

Returns the name of the specified core

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

GetCurrentFunctionName¶

Returns the name of the function within which the instruction pointer is located.

The execution on the target must be stopped.

Return value

Name	Available if	Default value	Valid values	Type	Description
functionName				string

GetDataType¶

Returns a variable’s data type

Parameter

Name	Available if	Default value	Valid values	Type	Description
Variable				string

Return value

Name	Available if	Default value	Valid values	Type	Description
result				string

GetMasterCoreIndex¶

Returns the index of the master core of the target

Return value

Name	Available if	Default value	Valid values	Type	Description
Core				int

GetNumberOfCores¶

Returns the number of cores on the target

Return value

Name	Available if	Default value	Valid values	Type	Description
result				int

IsConnected¶

Returns whether the target is connected

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

IsInBreakpoint¶

Returns True, if the program is stopped at any breakpoint. Otherwise returns False.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

IsRunning¶

Returns if a specific core is running. Without a specific core running status of the master core is returned.

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

ReadMemory¶

Read memory section

Parameter

Name	Available if	Default value	Valid values	Type	Description
Address				int	Memory start address where to read
Count				int	Number of bytes to be read

Return value

Name	Available if	Default value	Valid values	Type	Description
Data				ByteStream

ReadRegister¶

Evaluates a register on a specific core

Parameter

Name	Available if	Default value	Valid values	Type	Description
Register				string	Register to read

Return value

Name	Available if	Default value	Valid values	Type	Description
result				int

ReadVariable¶

Evaluate a variable on a certain core

Parameter

Name	Available if	Default value	Valid values	Type	Description
Variable				string	Variable to be read

Return value

Name	Available if	Default value	Valid values	Type	Description
result				object

RemoveBreakpoint¶

Removes a breakpoint from a specified location.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Identifier				string	A string that identifies a breakpoint location. E.g.: A function name, a hex address, or a file name with line number (“hellopcp.c 175”)

Reset¶

Resets a target

SetBreakpoint¶

Sets a breakpoint at a specified location.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Identifier				string	A string that identifies a breakpoint location. E.g.: A function name, a hex address, or a file name with line number (“hellopcp.c 175”)

SetBreakpointWithCondition¶

Sets a breakpoint in the specified location with the specified condition.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Condition				string	A C expression that decides whether the breakpoint triggers: if this expression evaluates to 0, the program continues to run, otherwise it gets stopped.
Identifier				string	A string that identifies a breakpoint location. E.g.: A function name, a hex address, or a file name with line number (“hellopcp.c 175”)

SetConnectState¶

Connects or disconnects the target from the debugger.

Parameter

Name	Available if	Default value	Valid values	Type	Description
State		☐		bool	True: Connect target. False: Disconnect target.

StartCyclicWriteVariable¶

Writes a value to a variable until StopCyclicWriteVariable is called

Parameter

Name	Available if	Default value	Valid values	Type	Description
Value				string	Value to cyclically write to the variable
Variable				string	Variable to be written

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

StartProgram¶

Starts the loaded programm

StartTraceRecording¶

Starts the capturing of the configured trace stream. Requires a trace configuration in the UDE workspace.

Parameter

Name	Available if	Default value	Valid values	Type	Description
traceStreamNumber		0		int	Trace Stream item number

Return value

Name	Available if	Default value	Valid values	Type	Description
traceStreamName				string	Name of the specified trace stream (recording)

StepInto¶

Single step. Steps into the subroutine, if executed from subroutine call.

StepOut¶

Single step. Returns from subroutine, if can be processed.

StepOver¶

Single step. Steps over the subroutine, if executed from subroutine call.

StopAllCyclicWriteVariables¶

Stops all cyclic write operations

StopCyclicWriteVariable¶

Stops cyclic writing of a variable

Parameter

Name	Available if	Default value	Valid values	Type	Description
Variable				string	Variable to be written

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

StopProgram¶

Stops the debugger

StopTraceRecording¶

Stops the capturing of the specified trace stream. Requires a trace configuration in the UDE workspace.

Parameter

Name	Available if	Default value	Valid values	Type	Description
traceStreamNumber		0		int	Trace Stream item number

WriteMemory¶

Write memory section

Parameter

Name	Available if	Default value	Valid values	Type	Description
Address				int	Memory start address where to write
Data				ByteStream	Data as Bytestream

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

WriteRegister¶

Writes the value to a specific register

Parameter

Name	Available if	Default value	Valid values	Type	Description
Register				string	Register to write
Value				int	Value to write to the register

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool

WriteVariable¶

Writes a variable on a certain core

Parameter

Name	Available if	Default value	Valid values	Type	Description
Value				object	The value that is to be written to the variable. If “Variable” is an array type, this has to be a list of the same length as the array. For two-dimensional arrays a list with nested lists has to be used. Elements, that should not be written, may be set to None.
Variable				string	Variable to be written

Return value

Name	Available if	Default value	Valid values	Type	Description
result			[False, True]	bool