Debugger

Property Description
Alternative LDR Disassembly
debug_alternative_ldr_dis – Boolean
Show alternative disassembly of ldr*/vldr instructions
CPU Register File
debug_cpu_registers_file – ProjFileName
The name of the file containing CPU register definitions.
Command Arguments
debug_command_arguments – String
The command arguments passed to the executable. This property will have macro expansion applied to it.
Debug Additional Configurations
debug_additional_configurations – StringList
The debugger will load and debug the specified additional configurations.
Debug Additional Projects
debug_dependent_projects – StringList
The debugger will load (if not already loaded by Load Additional Projects) and debug the specified additional projects.
Debug Project Name
debug_project_name – String
The name of the project used by the debugger when debugging multiple projects
Debug Symbols File[0]
external_debug_symbols_file_name – ProjFileName
The name of the debug symbols file. This property will have macro expansion applied to it. If it is not defined then the main load file is used.
Debug Symbols File[1]
external_debug_symbols_file_name1 – ProjFileName
The name of the debug symbols file. This property will have macro expansion applied to it. If it is not defined then the main load file is used.
Debug Symbols File[2]
external_debug_symbols_file_name2 – ProjFileName
The name of the debug symbols file. This property will have macro expansion applied to it. If it is not defined then the main load file is used.
Debug Symbols File[3]
external_debug_symbols_file_name3 – ProjFileName
The name of the debug symbols file. This property will have macro expansion applied to it. If it is not defined then the main load file is used.
Debug Symbols Load Address[0]
external_debug_symbols_load_address – String
The (code) address to be added to the debug symbol (code) addresses.
Debug Symbols Load Address[1]
external_debug_symbols_load_address1 – String
The (code) address to be added to the debug symbol (code) addresses.
Debug Symbols Load Address[2]
external_debug_symbols_load_address2 – String
The (code) address to be added to the debug symbol (code) addresses.
Debug Symbols Load Address[3]
external_debug_symbols_load_address3 – String
The (code) address to be added to the debug symbol (code) addresses.
Debug Terminal Log File
debug_terminal_log_file – Unknown
A file to write the output from the debug terminal to.
Default debugIO implementation
arm_debugIO_Implementation – Enumeration
The default debugIO implementation used by the debugger if symbols are unavailable.
Display DCC data
arm_display_DCC – Boolean
The debugger will display data that is written to the DCC when debugIO is not used.
Entry Point Symbol
debug_entry_point_symbol – String
Debugger will start execution at symbol if defined.
HTML Watch File
debug_html_watch – ProjFileName
The file used by the debugger's HTML Watch window.
Has Hypervisor Mode
arm_has_hypervisor_mode – Boolean
Show hypervisor mode registers
Has Monitor Mode
arm_has_monitor_mode – Boolean
Show monitor mode registers
Has Vector Catch
arm_has_vector_catch – Boolean
Vector catching is supported
ISA Extensions Debug
rv_debug_extensions – Enumeration
Specify ISA extensions supported by debugger.
Ignore .debug_aranges Section
debug_ignore_debug_aranges – Boolean
The debugger will not use the .debug_aranges section.
Ignore .debug_frame Section
debug_ignore_debug_frame – Boolean
The debugger will not use the .debug_frame section.
Load Additional Projects
debug_load_additional_projects – StringList
The debugger will load the outputs of the specified additional projects.
Memory Upload Page Size
debug_memory_upload_page_size – Integer
The aligned page size the debugger uses when uploading address ranges.
RTT Control Block Address
debug_RTTCB – String
The symbol or 0x prefixed address of the RTT control block.
RTT Enable
debug_enable_RTT – Boolean
If enabled the debugger will service RTT input/output in the debug terminal.
Register Definition File
debug_register_definition_file – ProjFileName
The name of the file containing register definitions.
Reserved Member Name
reservedMember_name – String
The struct reserved member name. Struct members that contain the (case insensitive) string will not be displayed.
Restrict Memory Access
debug_restrict_memory_access – Boolean
If enabled the debugger will only display variables and backtrace in the address ranges of the memory map or the sections in the elf file.
Run To
debug_initial_breakpoint – String
The initial breakpoint to set
Run To Control
debug_initial_breakpoint_set_option – Enumeration
Specify when the initial breakpoint should be set
Start Address
external_start_address – String
The address to start the externally built executable running from.
Start From Entry Point Symbol
debug_start_from_entry_point_symbol – Enumeration
If Yes the debugger will start execution from the entry point symbol. If No the debugger will start execution from the target specific location. If Don't the debugger will not start execution.
Starting Stack Pointer Value
debug_stack_pointer_start – String
The symbol or 0x prefixed value to set the stack pointer on start debugging.
Startup Completion Point
debug_startup_completion_point – StringList
Specifies the point in the program where startup is complete. Software breakpoints and debugIO will be enabled after this point has been reached.
Target Connection
debug_target_connection – Enumeration
Specifies the target to connect to for debugging actions.
Target Device [ARM]
arm_target_device_name – String
The name of the device to connect to.
Target Device [RISC-V]
target_device_name – String
The name of the device to connect to.
Thread Maximum
debug_threads_max – IntegerRange
The maximum number of threads to display.
Threads Script File
debug_threads_script – ProjFileName
The threads script used by the debugger.
Type Interpretation File
debug_type_file – FileName
Specifies the type interpretation file to use.
Working Directory
debug_working_directory – DirPath
The working directory for a debug session. This property will have macro expansion applied to it.

GDB Server

Property Description
Allow Memory Access During Execution
gdb_server_allow_memory_access_during_execution – Boolean
Specifies whether memory can be access while target is running. If set to No, target will be stopped each time memory is accessed.
Auto Start GDB Server
gdb_server_autostart_server – Boolean
Specifies whether a GDB server should be started on connect.
Breakpoint Types
gdb_breakpoint_types – Enumeration
Specifies the type of breakpoints to use.
CSR Registers [RISC-V]
gdb_server_csr_registers – StringList
Specifies mapping from CSR register numbers to GDB server register names, for example "2000=csr_mmisc_ctl".
Connect Timeout
gdb_server_connect_timeout – Integer
The length of time in seconds to attempt to connect to server before failing.
GDB Server Command Line
gdb_server_command_line – CommandLine
The command line to start the gdb server
Host
gdb_server_hostname – String
The hostname of the GDB server to connect to.
Ignore Checksum Errors
gdb_server_ignore_checksum_errors – Boolean
Specifies whether an incorrect GDB server checksum causes and error.
Log File
gdb_server_log_file – Unknown
Specifies a file to output a log of GDB server transactions to.
Port
gdb_server_port – Integer
The port number to use to connect to the GDB server.
Read Timeout
gdb_server_read_timeout – Integer
The length of time in seconds to attempt to read from server before failing.
Register Access
gdb_server_register_access – Enumeration
Specifies how registers are accessed
Reset and Stop Command
gdb_server_reset_command – String
The remote GDB server command to use to reset and stop the target.
Target XML File
gdb_server_target_xml_file – FileName
If specified, points to a target.xml file to use in place of file returned by the GDB server.
Type
gdb_server_type – Enumeration
Specifies the type of GDB server being connected to. J-Link, OpenOCD, ST-LINK and pyOCD gdb server implementations are currently supported.
Write Timeout
gdb_server_write_timeout – Integer
The length of time in seconds to attempt to write to server before failing.
Property Description
Additional J-Link Options
JLinkExecuteCommand – StringList
Specify additional J-Link options to allow enabling or disabling advanced features and fine tuning.
For more information see J-Link Command Strings
Enable Adaptive Clocking
adaptive – Enumeration
Adaptive clocking is enabled.
Erase All
target_loader_erase_all – Enumeration
If set to Yes, all of the FLASH memory on the target will be erased prior to downloading the application. If set to No, only the areas of FLASH containing the program being downloaded will be erased. If set to Default the behaviour is target specific.
Exclude Flash Cache Range
JLinkExcludeFlashCacheRange – String
Address range to exclude from flash cache.
This can be specified by either 'start_address-end_address' or 'address,size'.
For example: 0x08000000,0x10000.
Host Connection
Connection – Enumeration
Defines how to connect the host to the J-Link:
  • "USB": Connect to J-Link via USB
  • "USB S/N": Connect to J-Link with specified serial number via USB e.g. USB 174300001
  • "IP S/N": Connect to J-Link with specified serial number via IP e.g. IP 174300001
  • "IP n.n.n.n port": Connect to J-Link with specified IP address and optional port number e.g. IP 192.168.20.20 19020
JTAG Instruction Register Size Before Target
arm_linker_jtag_pad_post_ir – IntegerRange
Specifies the number of bits in the instruction register before the target (as seen from TDI), which is the number of bits to pad the JTAG instruction register with the BYPASS instruction after the target instruction.
JTAG Number Of Devices Before Target
arm_linker_jtag_pad_post_dr – IntegerRange
Specifies the number of devices before the target (as seen from TDI), which is the number of bits to pad the JTAG data register.
Log File
JLinkLogFileName – FileName
The file to output the J-Link log to.
Script File
JLinkScriptFileName – FileName
The file path of the optional J-Link script file to use.
Show Log Messages In Output Window
JLinkShowLog – Boolean
Display the J-Link log messages to the output window.
Speed
speed – IntegerRange
The required JTAG clock frequency in kHz (0 to auto-detect best possible).
Supply Power
supplyPower – Boolean
The J-Link supplies power to the target.
Target Has Cycle Counter [RISC-V]
riscv_has_cycle_counter – Boolean
The target device implements the mcycle CSR.
Target Interface Type [ARM]
arm_target_interface_type – Enumeration
Specifies the type of interface the target has. The options are:
  • JTAG - Use JTAG interface
  • SWD - Use SWD interface
  • cJTAG - Use cJTAG interface
Target Interface Type [RISC-V]
target_interface_type – Enumeration
Specifies the type of interface the target has. The options are:
  • JTAG - Use JTAG interface
  • SWD - Use SWD interface
  • cJTAG - Use cJTAG interface

Loader

Property Description
Additional Load File Address[0]
debug_additional_load_file_address – String
The address to load the additional load file.
Additional Load File Address[1]
debug_additional_load_file_address1 – String
The address to load the additional load file.
Additional Load File Address[2]
debug_additional_load_file_address2 – String
The address to load the additional load file.
Additional Load File Address[3]
debug_additional_load_file_address3 – String
The address to load the additional load file.
Additional Load File Type[0]
debug_additional_load_file_type – Enumeration
The file type of the additional load file. The options are Detect, elf, bin, ihex, hex, tihex, srec.
Additional Load File Type[1]
debug_additional_load_file_type1 – Enumeration
The file type of the additional load file. The options are Detect, elf, bin, ihex, hex, tihex, srec.
Additional Load File Type[2]
debug_additional_load_file_type2 – Enumeration
The file type of the additional load file. The options are Detect, elf, bin, ihex, hex, tihex, srec.
Additional Load File Type[3]
debug_additional_load_file_type3 – Enumeration
The file type of the additional load file. The options are Detect, elf, bin, ihex, hex, tihex, srec.
Additional Load File[0]
debug_additional_load_file – ProjFileName
Additional file to load on debug load. This property will have macro expansion applied to it.
Additional Load File[1]
debug_additional_load_file1 – ProjFileName
Additional file to load on debug load. This property will have macro expansion applied to it.
Additional Load File[2]
debug_additional_load_file2 – ProjFileName
Additional file to load on debug load. This property will have macro expansion applied to it.
Additional Load File[3]
debug_additional_load_file3 – ProjFileName
Additional file to load on debug load. This property will have macro expansion applied to it.
Check Load Sections Fit Target Description
target_check_load_sections_fit – Boolean
Specifies whether load sections in the program match the memory segments described in the memory map.
Load ELF Address Limit
debug_load_file_offset_limit – String
Restrict the Load ELF Offset.The Load ELF Offset will not be added to addresses greater than or equal to this address.
Load ELF Offset
debug_load_file_offset – String
The offset to add to the load addresses of the ELF programs.This offset is added to any absolute relocations of symbols (whose address is less than Load ELF Offset Limit) if the load file contains relocation sections.
Load ELF Sections
debug_load_sections – Enumeration
The debugger will load ELF sections rather than ELF programs.
Load File
external_build_file_name – ProjFileName
The name of the main load file. This property will have macro expansion applied to it. If it is not defined then the output filepath of the linker command is used.
Load File Address
external_load_address – String
The address to download the main load file to.
Load File Type
external_load_file_type – Enumeration
The file type of the main load file. The options are Detect, elf, bin, ihex, hex, tihex, srec.
No Load Sections
target_loader_no_load_sections – StringList
Names of (loadable) program sections or names of memory segments not to load.
Property Description
Connect With Reset
arm_target_connect_with_reset_stlink – Boolean
Hold the target in hardware reset on connect and stops the target. This requires the nSRST signal to be connected and the target debug hardware to work when in reset.
Host Connection
STLinkConnection – Enumeration
A number specifying the device to connect to.
Mass Erase
arm_target_mass_erase – Boolean
Use Mass Erase rather than sector erase on flash programming.
ST-Link Target Interface Type
arm_target_interface_type_stlink – Enumeration
Specifies the type of interface the target has. The options are:
  • JTAG - Use JTAG interface
  • SWD - Use SWD interface
STM32CubeProgrammer directory
arm_stm32cubeprogrammer_directory – DirPath
Specifies the installation directory of the STM32CubeProgrammer software.
Speed
arm_target_interface_speed_stlink – IntegerRange
The required JTAG/SWD clock frequency in kHz.

Simulator [ARM]

Property Description
Max Instructions
arm_simulator_max_instructions – String
Maximum number of instructions to execute before simulator is stopped.
Memory Simulation File
arm_simulator_memory_simulation_filename – ProjFileName
Specifies the dll that simulates the memory system. This property will have macro expansion applied to it. If not specified then the default memory simulation will be used.
Memory Simulation Half Words
arm_simulator_memory_half_words – StringList
Memory half words to simulate specified by a list of address=value e.g. 0xE0082002=0xface
Memory Simulation Parameter
arm_simulator_memory_simulation_parameter – String
Parameter passed to the memory simulation. This property will have macro expansion applied to it.The format of this is specific to the memory simulation. The default memory simulation takes a list of RX|RWX 'hex start address', 'hex size in bytes', 'default hex word value' for example RX 00000000, 10000000, FFFFFFFF;RWX 10000000, 10000000, CDCDCDCD.
Memory Simulation Parameter Macros
arm_simulator_memory_simulation_parameter_macros – StringList
Macros to apply to the parameter passed to the memory simulation on creation. If null then the macro MemorySegments is set to the value of the address ranges specified by the project.
Memory Simulation Words
arm_simulator_memory_words – StringList
Memory words to simulate specified by a list of address=value e.g. 0xE0082000=0xfeedface
SP Lower
arm_simulator_SP_lower – String
Stop when R13 value is less than the value of this expression.
SP Upper
arm_simulator_SP_upper – String
Stop when R13 value is greater than the value of this expression.
Stop On Branch .
arm_simulator_stop_on_branch_dot – Boolean
Stop when the simulator executes a b . instruction.
Stop On Memory Error
arm_simulator_stop_on_read_write – Enumeration
Specifies the simulator behaviour when a memory error occurs.
Trace Buffer Size
arm_simulator_num_trace_entries – Integer
The number of trace entries to store.

Simulator [RISC-V]

Property Description
32-bit Divide Instruction Cost
riscv_simulator_32bit_divide_cost – Integer
The number of cycles taken for a 32-bit divide instruction.
32-bit Multiply Instruction Cost
riscv_simulator_32bit_multiply_cost – Integer
The number of cycles taken for a 32-bit multiply instruction.
64-bit Divide Instruction Cost
riscv_simulator_64bit_divide_cost – Integer
The number of cycles taken for a 64-bit divide instruction.
64-bit Multiply Instruction Cost
riscv_simulator_64bit_multiply_cost – Integer
The number of cycles taken for a 64-bit multiply instruction.
Count Cycles
riscv_simulator_count_cycles – Boolean
Display cycle counts rather than instruction counts.
Enable Timer Support
riscv_simulator_support_mtime – Boolean
Enable simulation of mtime and mtimecmp memory mapped registers.
Max Instructions
riscv_simulator_max_instructions – String
Maximum number of instructions to execute before simulator is stopped.
SP Lower
riscv_simulator_SP_lower – String
Stop when x2 value is less than the value of this expression.
SP Upper
riscv_simulator_SP_upper – String
Stop when x2 value is greater than the value of this expression.
Software Interrupt Register Address
riscv_software_interrupt_address – IntegerHex
The address of the msip register
Stop On Jump .
riscv_simulator_stop_on_jump_dot – Boolean
Stop when the simulator executes a j . instruction.
Timer Comparator Register Address
riscv_simulator_timer_comparator_address – IntegerHex
The address of the mtimecmp register
Timer Register Address
riscv_simulator_timer_address – IntegerHex
The address of the mtime register
Trap On Unaligned Memory Access.
riscv_simulator_trap_on_unaligned – Boolean
Trap on unaligned memory access.

Target Script

Property Description
Attach Script
target_attach_script – JavaScript
The script that is executed when the target is attached to.
Debug Begin Script
target_debug_begin_script – JavaScript
The script that is executed when the debugger begins a debug session.
Debug End Script
target_debug_end_script – JavaScript
The script that is executed when the debugger ends a debug session.
Load Begin Script
target_load_begin_script – JavaScript
The script that is executed when the debugger begins a load.
Load End Script
target_load_end_script – JavaScript
The script that is executed when the debugger ends a load.
Reset Script
target_reset_script – JavaScript
The script that is executed when the target is reset.
Target Script File
target_script_file – FileName
The target script file, the contents of this file are prepended to script project properties before they are executed.

Target Trace

Property Description
ITM Stimulus Port To Display
arm_target_itm_stimulus_port_display – IntegerRange
Specifies the ITM Stimulus port to display in the debug terminal -1 disables this
ITM Stimulus Ports Enable
arm_target_itm_stimulus_port_enable – IntegerHex
Specifies the ITM Stimulus ports to enable.
ITM Stimulus Ports Privilege
arm_target_itm_stimulus_port_privilege – IntegerHex
Specifies the ITM Stimulus ports to enable.
ITM Timestamping
arm_target_itm_timestamping_enable – Enumeration
Specifies ITM timestamping. The options are:
  • Disable - disable timestamping
  • Local - use the local timestamp clock
  • Global - use the global timestamp clock
ITM/DWT Data Trace PC
arm_target_dwt_data_trace_PC – Boolean
Specifies whether to trace the PC on data trace.
ITM/DWT PC Sampling
arm_target_dwt_PC_sampling_enable – Enumeration
Specifies the DWT PC sampling rate.
ITM/DWT Trace Exceptions
arm_target_dwt_trace_exceptions – Boolean
Specifies whether to trace exception entry and return.
MTB RAM Address
arm_target_mtb_ram_address – IntegerHex
Specifies the MTB RAM Address - note that this must be aligned to the MTB RAM size.
MTB RAM Size
arm_target_mtb_ram_size – Enumeration
Specifies the MTB RAM size in bytes.
SWO Baud Rate
arm_target_trace_SWO_speed – IntegerRange
Specifies the baud rate of the SWO - zero selects auto detection.
Trace Clock Speed
arm_target_trace_clock_speed – IntegerRange
The speed of the trace clock. This is usually the same as the CPU clock and is used to program the prescaler for the SWO
Trace Interface Type
arm_target_trace_interface_type – Enumeration
Specifies the type of trace interface the target has. The options are:
  • SWO - Use asynchronous SWO trace interface.
  • TracePort - Use synchronous parallel trace interface.
  • ETB - Use on-chip embedded trace buffer.
  • MTB - Use on-chip MTB - Cortex-M0+ only.
  • None
Trace Port Size
arm_target_trace_port_size – Enumeration
Specifies the trace port size the target has. The options are:
  • 1-bit
  • 2-bit
  • 4-bit
  • 8-bit
  • 16-bit
  • 24-bit
  • 32-bit