Port DEBUGGER - DEFAULT 🛈¶

Stimulation¶

This port has no stimulus capabilities.

Properties 🛈¶

Name	Default value	Type	Description
Port number	20000	int	UDP port of the Remote API that will be used to communicate with TRACE32 (see *.t32 configuration file)
Working directory	‘C:\T32’	string	Path to working directory (absolute or relative to path of host node)
Configuration file ❲*.t32❳	‘config.t32’	string	Path to the configuration file. Optionally, arguments may be supplied. Placeholders for ELF or HEX file can be provided as ${elf} or ${hex}. If more than one ELF file was defined, they will be given to the start script as separate arguments.
Startup script ❲*.cmm❳		string	Path to the PRACTICE startup script that will be executed during TRACE32 start. Optionally, arguments may be supplied. Placeholders for ELF or HEX file can be provided as ${elf} or ${hex}. If more than one ELF file was defined, they will be given to the start script as separate arguments.
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. A \| may be used to separate multiple ELF files.
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
ELF loading parameters	‘/NoClear /NOCODE /ForceLines /GlobTypes’	string	Parameters when loading ELF files (TRACE32 command Data.LOAD.Elf)
Control unit identifier		string	Control unit identifier of this port in the test configuration (will be filled out automatically)
Use ‘Run-time Memory Access’	☐	bool	Enables to read and write variables while the target is running. (Uses option “%e” for the VAR command. Only applicable for targets which support this option.)

Jobs 🛈¶

Attach¶

Connects to the TRACE32 device

Break¶

Break into target (or stop the realtime emulation asynchronously).

Cmd¶

Starts any PRACTICE command, e.g. ‘DO script.cmm’, but does not wait for it to finish. Error messages of the PRACTICE command are not evaluated by this job (see job ‘GetMessage’ or ‘CmdWithReturn’)

Parameter

Name	Available if	Default value	Valid values	Type	Description
command				string	PRACTICE command which should be executed

CmdWithReturn¶

Executes a PRACTICE command, e.g. ‘DO script.cmm’. The job waits until the command has finished and returns the result.

Parameter

Name	Available if	Default value	Valid values	Type	Description
command				string	PRACTICE command which should be executed
timeout				float	Timeout when waiting for the return value (in seconds)

Return value

Name	Available if	Default value	Valid values	Type	Description
returnValue				string	Return value of the executed command

CoreSelect¶

Sends the PRACTICE command CORE.select

Parameter

Name	Available if	Default value	Valid values	Type	Description
coreNumber		0		int	Number of the core to be selected

EvalGet¶

Some PRACTICE commands (e.g. ‘EVAL’) and other functions set a global variable to store return values, evaluation results or error conditions.

Return value

Name	Available if	Default value	Valid values	Type	Description
returnValue				int	Numeric representation of the return value

EvalGetString¶

Some PRACTICE commands (e.g. ‘EVAL’) and other functions set a global variable to store return values, evaluation results or error conditions.

Return value

Name	Available if	Default value	Valid values	Type	Description
returnString				string	String representation of the return value

GetApiRevision¶

Returns the revision of the Remote-API ecu.test uses to communicate with TRACE32. (Not the version of TRACE32)

Return value

Name	Available if	Default value	Valid values	Type	Description
returnValue				int	Revision number

GetBreakpointList¶

Reads breakpoint information

Parameter

Name	Available if	Default value	Valid values	Type	Description
maxBreakpoints		0		int	Max number of breakpoints

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				object	List of debugger breakpoints consisting of (start address, isEnabled, breakpoint type, auxType)

GetCpuInfo¶

This function gives information about the CPU type and family

Return value

Name	Available if	Default value	Valid values	Type	Description
resultTuple				object	Tuple with CPU information (cpu<string>, BigEndian<bool>)

GetMessage¶

Returns the content and type of messages from the AREA-window.

Return value

Name	Available if	Default value	Valid values	Type	Description
returnObject				object	Tupel: Messagetype<string>(General Information/ Error/Status Information/Error Information/ Temporary Display/Temporary Information),Content of the message<string>).

GetPracticeState¶

Returns the run-state of PRACTICE

Return value

Name	Available if	Default value	Valid values	Type	Description
returnString				string	‘Not Running’, ‘Running’ or ‘Dialog window open’

GetRam¶

Requests memory mapping information of the emulator.

Parameter

Name	Available if	Default value	Valid values	Type	Description
access		‘Data RAM’	[‘Data RAM’, ‘Program RAM’, ‘Default’]	string	Choose RAM
start		0		int	Start address

Return value

Name	Available if	Default value	Valid values	Type	Description
returnObject				object	Tuple with start and end address of the memory area (foundStartAddress<int>, foundEndAddress<int>). (-1,-1) if nothing was found

GetSource¶

Returns the corresponding source filename and source line for a given address

Parameter

Name	Available if	Default value	Valid values	Type	Description
address		0		int	Address of the file name and line number

Return value

Name	Available if	Default value	Valid values	Type	Description
returnString				string	String with the format “Filename:LineNumber”

GetState¶

Use this function to get the main state of the ICD

Return value

Name	Available if	Default value	Valid values	Type	Description
returnString				string	‘Debug system is down’, ‘Debug system is halted’, ‘Target execution is stopped’ or ‘Target execution is running’.

GetSymbol¶

Returns information of the symbol with the given name. In the name an ELF file name is replaced automatically, if it contains an ELF identifier from the test configuration in square brackets (e.g., [ELF-KEY-1])

Parameter

Name	Available if	Default value	Valid values	Type	Description
symbolName				string	Symbol name (‘[ELF-identifier]’ for automatic substitution)

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				object	Tupel (address<int>, size<int>, access<int>)

GetSymbolAccess¶

Returns the access parameter of the symbol with the given name. In the name an ELF file name is replaced automatically, if it contains an ELF identifier from the test configuration in square brackets (e.g., [ELF-KEY-1])

Parameter

Name	Available if	Default value	Valid values	Type	Description
symbolName				string	Symbol name (‘[ELF-identifier]’ for automatic substitution)

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				int	access<int>

GetSymbolAddress¶

Returns the address of the symbol with the given name. In the name an ELF file name is replaced automatically, if it contains an ELF identifier from the test configuration in square brackets (e.g., [ELF-KEY-1])

Parameter

Name	Available if	Default value	Valid values	Type	Description
symbolName				string	Symbol name (‘[ELF-identifier]’ for automatic substitution)

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				int	address<int>

GetSymbolFromAddress¶

Returns the name of the symbol at the given address

Parameter

Name	Available if	Default value	Valid values	Type	Description
symbolAddress		0		int	Address of symbol

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				string	Symbolname

GetSymbolSize¶

Returns the size of the symbol with the given name. In the name an ELF file name is replaced automatically, if it contains an ELF identifier from the test configuration in square brackets (e.g., [ELF-KEY-1])

Parameter

Name	Available if	Default value	Valid values	Type	Description
symbolName				string	Symbol name (‘[ELF-identifier]’ for automatic substitution)

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				int	size<int>

GetTraceInfo¶

Requests the buffersize and the minimum/maximum record number.

Parameter

Name	Available if	Default value	Valid values	Type	Description
tracetype		‘Trace’	[‘Trace’, ‘Trace (raw data)’, ‘Trace (funneled data)’, ‘PowerIntegrator’, ‘PowerProbe’, ‘Snooper’, ‘DTM’]	string	Select the trace

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				object	Tupel (buffersize<int>, minNumber<int>, maxNumber<int>)

GetTraceState¶

Requests the state of a specific trace.

Parameter

Name	Available if	Default value	Valid values	Type	Description
tracetype		‘Trace’	[‘Trace’, ‘Trace (raw data)’, ‘Trace (funneled data)’, ‘PowerIntegrator’, ‘PowerProbe’, ‘Snooper’, ‘DTM’]	string	Select the trace

Return value

Name	Available if	Default value	Valid values	Type	Description
resultString				object	‘analyzer is switched off’, ‘analyzer is armed’, ‘analyzer triggered’ or ‘analyzer recording broken’

GetTriggerMessage¶

When stopping on a read or write breakpoint (or equivalent), the trigger system generates an appropriate message.

Return value

Name	Available if	Default value	Valid values	Type	Description
returnString				string	Trigger message

GetWindowContent¶

Retrieves the content of a TRACE32 window

Parameter

Name	Default value	Valid values	Type	Description
command			string	PRACTICE command for opening the window, e.g. ‘List’
encoding	‘utf-8’	[‘ascii’, ‘iso-8859-1’, ‘cp1252’, ‘utf-8’]	string	Encoding to be applied to the result
format	‘XML’	[‘ASCII’, ‘ASCIIP’, ‘ASCIIE’, ‘CSV’, ‘XML’]	string	Target format

Go¶

Start target (or start real-time emulation).

Nop¶

Sends an empty message

Ping¶

Sends a ping message

QueryBreakpointObjCount¶

Returns the number of breakpoints

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				int	Number of breakpoints defined in TRACE32

ReadBreakpoint¶

Reads breakpoint information

Parameter

Name	Default value	Valid values	Type	Description
access	‘Data access’	[‘Data access’, ‘Program access’, ‘CP0’, ‘ICEbreaker’, ‘ETM’, ‘CP14’, ‘CP15’, ‘ARM logical’, ‘THUMB logical’, ‘ARM physical’, ‘THUMB physical’, ‘ETB’, ‘AD:’, ‘AP:’, ‘DAP:’, ‘USR:’, ‘VM:’, ‘Default’]	string	Choose memory access class
address	0		int
size	0		int	Number of addresses for reading

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				BitStream	Bitstream with breakpoint data (see RemoteApi documentation - “T32_ReadBreakpoint”)

ReadMemory¶

Read from memory

Parameter

Name	Default value	Valid values	Type	Description
access	‘Data access’	[‘Data access’, ‘Program access’, ‘CP0’, ‘ICEbreaker’, ‘ETM’, ‘CP14’, ‘CP15’, ‘ARM logical’, ‘THUMB logical’, ‘ARM physical’, ‘THUMB physical’, ‘ETB’, ‘AD:’, ‘AP:’, ‘DAP:’, ‘USR:’, ‘VM:’, ‘Default’]	string	Choose memory access class
byteAddress	0		int	Start address
byteSize	0		int	Number of bytes to read

Return value

Name	Available if	Default value	Valid values	Type	Description
returnObject				ByteStream	Content of the read memory

ReadPP¶

Returns the address of the program counter (Only possible if execution is paused).

Return value

Name	Available if	Default value	Valid values	Type	Description
returnValue				int	Value of the program pointer

ReadRegister¶

Read register values for specified masks

Parameter

Name	Available if	Default value	Valid values	Type	Description
mask1		0		int	Register address mask 1
mask2		0		int	Register address mask 2

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				object	List with 64 32-bit register values

ReadRegisterByName¶

Reads register values for a specific name

Parameter

Name	Available if	Default value	Valid values	Type	Description
registerName				string

Return value

Name	Available if	Default value	Valid values	Type	Description
resultObject				object	Tuple of low-order and high-order 32-bit register value

ResetCPU¶

Tries to reset the target CPU. This is done by executing the PRACTICE commands SYStem.UP and Register.RESet

SetMemoryAccessClass¶

Sets the class for subsequent memory access (e.g. via ReadMemory) whose access Parameters will then be ignored.

Parameter

Name	Available if	Default value	Valid values	Type	Description
access		‘Default’	[‘Program Space’, ‘Data Space’, ‘Access by the CPU’, ‘Direct access to emulation memory’, ‘Direct access to program memory’, ‘Direct access to data memory’, ‘Absolute, physical addressing’, ‘Absolute Data’, ‘Absolute Program’, ‘User Specific Access Mode’, ‘EEPROM Write Access’, ‘Default’]	string	Class for memory access. ‘Default’ reactivates the function-specific access parameters.

SetMode¶

Sets the display mode for Data.List windows.

Parameter

Name	Available if	Default value	Valid values	Type	Description
mode		‘ASM’	[‘ASM’, ‘HLL’, ‘Mixed’]	string	Displaymode to be set

Step¶

Executes one single step (on an emulator or target)

StepMode¶

Executes one step on an emulator or target in the specific mode. ‘Mixed step’ will do a assembler step with HLL display.

Parameter

Name	Available if	Default value	Valid values	Type	Description
mode		‘Assembler step’	[‘Assembler step’, ‘HLL step’, ‘Mixed step’]	string
type		‘Step into function call’	[‘Step into function call’, ‘Step over function call’]	string

Stop¶

If a PRACTICE script is currently running, it is stopped. For stopping the target program use ‘Break’

WriteBreakpoint¶

Write a breakpoint

Parameter

Name	Default value	Valid values	Type	Description
access	‘Data access’	[‘Data access’, ‘Program access’, ‘CP0’, ‘ICEbreaker’, ‘ETM’, ‘CP14’, ‘CP15’, ‘ARM logical’, ‘THUMB logical’, ‘ARM physical’, ‘THUMB physical’, ‘ETB’, ‘AD:’, ‘AP:’, ‘DAP:’, ‘USR:’, ‘VM:’, ‘Default’]	string	Choose memory access class
address	0		int
breakpoint	BitStream(0x0, 0)		BitStream	Breakpoint to set (see RemoteApi doc - “T32_WriteBreakpoint”)
size	0		int	Number of addresses to write

WriteMemory¶

Write to memory starting at the given address

Parameter

Name	Default value	Valid values	Type	Description
access	‘Data access’	[‘Data access’, ‘Program access’, ‘CP0’, ‘ICEbreaker’, ‘ETM’, ‘CP14’, ‘CP15’, ‘ARM logical’, ‘THUMB logical’, ‘ARM physical’, ‘THUMB physical’, ‘ETB’, ‘AD:’, ‘AP:’, ‘DAP:’, ‘USR:’, ‘VM:’, ‘Default’]	string	Choose memory access class
byteAddress	0		int	Start address
data	ByteStream()		ByteStream	Bytes to write

WriteMemoryPipe¶

Write parallel to memory starting at the given address

Parameter

Name	Default value	Valid values	Type	Description
access	‘Data access’	[‘Data access’, ‘Program access’, ‘CP0’, ‘ICEbreaker’, ‘ETM’, ‘CP14’, ‘CP15’, ‘ARM logical’, ‘THUMB logical’, ‘ARM physical’, ‘THUMB physical’, ‘ETB’, ‘AD:’, ‘AP:’, ‘DAP:’, ‘USR:’, ‘VM:’, ‘Default’]	string	Choose memory access class
byteAddress	0		int	Start address
data	ByteStream()		ByteStream	Bytes to write

WriteRegister¶

Write register values for specific mask

Parameter

Name	Default value	Type	Description
mask1	0	int	Register address mask 1
mask2	0	int	Register address mask 2
registerData	[]	object	List with 64 32-bit register values

WriteRegisterByName¶

Write register values for a specific name

Parameter

Name	Default value	Type	Description
hvalue	0	int	32-Bit value of the high register
registerName		string
value	0	int	32-Bit value of the low register