Summary of C-SPY command line options

Skip to main content

IAR Embedded Workbench for Arm 9.70.x

Summary of C-SPY command line options

In this section:

General cspybat options

`‑‑application_args`	Passes command line arguments to the debugged application.
`‑‑attach_to_running_target`	Makes the debugger attach to a running application at its current location, without resetting the target system.
`‑‑backend`	Marks the beginning of the parameters to be sent to the C-SPY driver (mandatory).
`‑‑code_coverage_file`	Enables the generation of code coverage information and places it in a specified file.
`‑‑cycles`	Specifies the maximum number of cycles to run.
`‑‑debug_file`	Specifies an alternative debug file.
`‑‑device_macro`	Specifies a C-SPY device macro file.
`‑‑download_only`	Downloads a code image without starting a debug session afterwards.
`-f`	Extends the command line.
`‑‑flash_loader`	Specifies a flash loader specification XML file.
`‑‑macro`	Specifies a macro file to be used.
`‑‑macro_param`	Assigns a value to a C-SPY macro parameter.
`‑‑plugin`	Specifies a plugin file to be used.
`‑‑rtc_enable`	Enables C-RUN runtime error checking in `cspybat`.
`‑‑rtc_output`	Specifies to `cspybat` a file for the C-RUN message output.
`‑‑rtc_raw_to_txt`	Makes `cspybat` act as a runtime checking message filter by reading a file as input.
`‑‑rtc_rules`	Specifies a file for the C-RUN rules to `cspybat`.
`‑‑silent`	Omits the sign-on message.
`‑‑sockets`	Makes the debugger use sockets instead of pipes for its internal communication.
`‑‑suppress_entrypoint_warning`	Disables the warning when the ELF entry point is at address `0x0`.
`‑‑timeout`	Limits the maximum allowed execution time.

Options available for all C-SPY drivers

`‑‑BE8`	Uses the big-endian format BE8. For reference information, see ‑‑BE8.
`‑‑BE32`	Uses the big-endian format BE32. For reference information, see ‑‑BE32.
`‑‑cpu`	Specifies a processor variant. For reference information, see ‑‑cpu.
`‑‑device`	Specifies the name of the device.
`‑‑drv_communication`	Specifies the communication link to be used.
`‑‑drv_exclude_from_verify`	Excludes memory ranges from being verified.
`‑‑drv_reset_to_cpu_start`	Omits setting the `PC` when resetting the application.
`‑‑drv_debugger_cache`	Disables memory caching and memory range checking in C-SPY.
`‑‑drv_restore_breakpoints`	Restores automatically any breakpoints that were destroyed during system startup.
`‑‑drv_suppress_download`	Suppresses download of the executable image. For reference information, see Download, specifically the option Suppress download.
`‑‑drv_vector_table_base`	Specifies the location of the Cortex-M reset vector and the initial stack pointer value.
`‑‑drv_verify_download`	Verifies the target program. For reference information, see Download, specifically the option Verify download. Available for all hardware drivers.
`‑‑endian`	Specifies the byte order of the generated code and data. For reference information, see ‑‑endian.
`‑‑fpu`	Selects the type of floating-point unit. For reference information, see ‑‑fpu.
`‑‑leave_target_running`	Starts the execution on the target and then exits but leaves the target running.
`-p`	Specifies the device description file to be used.
`‑‑proc_stack_stack`	Provides C-SPY with information about reserved stacks.
`‑‑semihosting`	Enables semihosted I/O.

Options available for the simulator driver

`‑‑disable_interrupts`	Disables the interrupt simulation. (Not available for all cores and devices.)
`‑‑function_profiling`	Analyzes your source code to find where the most time is spent during execution. (Not available for all cores and devices.)
`‑‑mapu`	Activates memory access checking. (Not available for all cores and devices.)
`‑‑multicore_nr_of_cores`	Specifies the number of cores on the device for multicore debugging. (Not available for all cores and devices.)

Options available for the C-SPY GDB Server driver

`‑‑drv_default_breakpoint`	Sets the type of breakpoint resource to be used when setting breakpoints.
`‑‑drv_enforce_mem_config`	Prevents the driver from accessing any memory ranges in the zone `Memory` that have not been defined in the Memory Configuration dialog box.
`‑‑gdbserv_exec_command`	Sends a command string to the GDB Server.

Options available for the C-SPY I-jet driver

`--board_file`	Provides C-SPY with information needed for setting flash breakpoints.
`‑‑debug_auth_enforce`	Specifies that the authentication procedure should be executed when automatic detection fails.
`‑‑debug_auth_settings`	Specifies the XML file that stores parameters required for the authentication.
`‑‑debug_auth_type`	Specifies the mechanism used for the debug authentication.
`‑‑drv_catch_exceptions`	Makes the application stop for certain exceptions.
`‑‑drv_default_breakpoint`	Sets the type of breakpoint resource to be used when setting breakpoints.
`‑‑drv_enforce_mem_config`	Prevents the driver from accessing any memory ranges in the zone `Memory` that have not been defined in the Memory Configuration dialog box.
`‑‑drv_interface`	Selects the communication interface.
`‑‑drv_interface_speed`	Specifies the JTAG and SWD interface speed.
`‑‑drv_mem_ap`	Enables Live Watch and Live Memory reads for Cortex-A and Cortex-R devices.
`‑‑drv_trace_settings`	Specifies the mechanism and interface for trace data collection.
`‑‑jet_board_cfg`	Specifies a probe configuration file.
`‑‑jet_board_did`	Selects which CPU to debug on a multicore system.
`‑‑jet_cpu_clock`	Specifies the frequency of the internal processor clock.
`‑‑jet_disable_pmu`	Disables the PMU event counting.
`‑‑jet_disable_pmu_dap`	Disables the PMU DAP channel and uses CP15 instructions for PMU event counting.
`‑‑jet_ir_length`	Specifies the number of IR bits preceding the Arm core to connect to.
`‑‑jet_power_from_probe`	Specifies the power supply from the I-jet or I-jet Trace probe.
`‑‑jet_probe`	Specifies which debug system the C-SPY I-jet driver is an interface to.
`‑‑jet_script_file`	Specifies the reset script file.
`‑‑jet_standard_reset`	Selects the reset strategy to be used when C-SPY starts.
`‑‑jet_startup_connection_timeout`	Prolongs the time that the C-SPY driver tries to connect to the target board.
`‑‑jet_swo_on_d0`	Specifies that SWO trace data is output on the trace data pin `D0`.
`‑‑jet_swo_prescaler`	Specifies the SWO prescaler for the CPU clock frequency.
`‑‑jet_swo_protocol`	Selects the SWO communication protocol.
`‑‑jet_tap_position`	Selects a specific device in the JTAG scan chain.
`‑‑reset_style`	Specifies the reset strategies that will be available when debugging.
`‑‑sdm_debug_architecture`	Specifies the debug architecture used for SDM debug authentication.
`‑‑sdm_library`	Specifies the library file used for SDM debug authentication.
`‑‑sdm_library_hint`	Specifies an alternate authentication method if the SDM library does not use the standard SDM API.
`‑‑sdm_manifest`	Specifies a manifest file that points out the SDM debug authentication library file.

Options available for the C-SPY CMSIS-DAP driver

`‑‑debug_auth_enforce`	Specifies that the authentication procedure should be executed when automatic detection fails.
`‑‑debug_auth_settings`	Specifies the XML file that stores parameters required for the authentication.
`‑‑debug_auth_type`	Specifies the mechanism used for the debug authentication.
`‑‑drv_catch_exceptions`	Makes the application stop for certain exceptions.
`‑‑drv_default_breakpoint`	Sets the type of breakpoint resource to be used when setting breakpoints.
`‑‑drv_enforce_mem_config`	Prevents the driver from accessing any memory ranges in the zone `Memory` that have not been defined in the Memory Configuration dialog box.
`‑‑drv_interface`	Selects the communication interface.
`‑‑drv_interface_speed`	Specifies the JTAG and SWD interface speed.
`‑‑jet_board_cfg`	Specifies a probe configuration file.
`‑‑jet_board_did`	Selects which CPU to debug on a multicore system.
`‑‑jet_probe`	Specifies which debug system the C-SPY driver is an interface to.
`‑‑jet_script_file`	Specifies the reset script file.
`‑‑jet_standard_reset`	Selects the reset strategy to be used when C-SPY starts.
`‑‑jet_startup_connection_timeout`	Prolongs the time that the C-SPY driver tries to connect to the target board.
`‑‑jet_tap_position`	Selects a specific device in the JTAG scan chain.
`‑‑reset_style`	Specifies the reset strategies that will be available when debugging.
`‑‑sdm_debug_architecture`	Specifies the debug architecture used for SDM debug authentication.
`‑‑sdm_library`	Specifies the library file used for SDM debug authentication.
`‑‑sdm_library_hint`	Specifies an alternate authentication method if the SDM library does not use the standard SDM API.
`‑‑sdm_manifest`	Specifies a manifest file that points out the SDM debug authentication library file.

Options available for the C-SPY J-Link/J-Trace driver

`‑‑drv_catch_exceptions`	Makes the application stop for certain exceptions.
`‑‑drv_default_breakpoint`	Sets the type of breakpoint resource to be used when setting breakpoints.
`‑‑drv_enforce_mem_config`	Prevents the driver from accessing any memory ranges in the zone `Memory` that have not been defined in the Memory Configuration dialog box.
`‑‑drv_interface`	Selects the communication interface.
`‑‑drv_interface_speed`	Specifies the JTAG and SWD interface speed.
`‑‑drv_swo_clock_setup`	Specifies the CPU clock and the wanted SWO speed.
`‑‑jlink_dcc_timeout`	Specifies the timeout for a pending request from C-SPY to the DCC agent on target.
`‑‑jlink_device_select`	Selects a specific device in the JTAG scan chain.
`‑‑jlink_exec_command`	Calls the `__jlinkExecCommand` macro after target connection has been established.
`‑‑jlink_initial_speed`	Sets the initial JTAG communication speed in kHz.
`‑‑jlink_ir_length`	Sets the number of IR bits preceding the Arm core to connect to.
`‑‑jlink_reset_strategy`	Selects the reset strategy to use at debugger startup.
`‑‑jlink_script_file`	Specifies the script file for setting up hardware.
`‑‑jlink_trace_source`	Selects either ETB or ETM as the trace source.

Options available for the C-SPY TI MSP-FET driver

`‑‑drv_enforce_mem_config`	Prevents the driver from accessing any memory ranges in the zone `Memory` that have not been defined in the Memory Configuration dialog box.
`‑‑mspfet_erase_flash`	Specifies which flash memory to erase before download.
`‑‑mspfet_interface_speed`	Specifies the interface communication speed.
`‑‑mspfet_reset_strategy`	Selects the reset strategy to use at debugger startup.
`‑‑mspfet_settlingtime`	Specifies a delay that will be used between switching on the target VCC and starting the identification of the Arm device.
`‑‑mspfet_vccvoltage`	Specifies the target VCC voltage.

Options available for the C-SPY TI Stellaris driver

`‑‑drv_enforce_mem_config`	Prevents the driver from accessing any memory ranges in the zone `Memory` that have not been defined in the Memory Configuration dialog box.
`‑‑drv_interface`	Selects the communication interface.
`‑‑drv_interface_speed`	Specifies the JTAG and SWD interface speed.
`‑‑lmiftdi_reset_strategy`	Selects the reset strategy to use at debugger startup.

Options available for the C-SPY TI XDS driver

`‑‑drv_catch_exceptions`	Makes the application stop for certain exceptions.
`‑‑drv_default_breakpoint`	Sets the type of breakpoint resource to be used when setting breakpoints.
`‑‑drv_enforce_mem_config`	Prevents the driver from accessing any memory ranges in the zone `Memory` that have not been defined in the Memory Configuration dialog box.
`‑‑drv_interface`	Selects the communication interface.
`‑‑drv_interface_speed`	Specifies the JTAG and SWD interface speed.
`‑‑drv_swo_clock_setup`	Specifies the CPU clock and the wanted SWO speed.
`‑‑xds_board_file`	Overrides the default board file.
`‑‑xds_reset_strategy`	Specifies the reset strategy to use.
`‑‑xds_rootdir`	Specifies the installation directory of the TI XDS driver package.

Options available for the C-SPY ST-LINK driver

`‑‑debug_auth_enforce`	Specifies that the authentication procedure should be executed when automatic detection fails.
`‑‑debug_auth_settings`	Specifies the XML file that stores parameters required for the authentication.
`‑‑debug_auth_type`	Specifies the mechanism used for the debug authentication.
`‑‑drv_catch_exceptions`	Makes the application stop for certain exceptions.
`‑‑drv_enforce_mem_config`	Prevents the driver from accessing any memory ranges in the zone `Memory` that have not been defined in the Memory Configuration dialog box.
`‑‑drv_interface`	Selects the communication interface.
`‑‑drv_interface_speed`	Specifies the JTAG and SWD interface speed.
`‑‑drv_swo_clock_setup`	Specifies the CPU clock and the wanted SWO speed.
`‑‑sdm_debug_architecture`	Specifies the debug architecture used for SDM debug authentication.
`‑‑sdm_library`	Specifies the library file used for SDM debug authentication.
`‑‑sdm_library_hint`	Specifies an alternate authentication method if the SDM library does not use the standard SDM API.
`‑‑sdm_manifest`	Specifies a manifest file that points out the SDM debug authentication library file.
`‑‑stlink_reset_strategy`	Specifies the reset strategy to use.

Options available for the C-SPY third-party drivers

For information about any options specific to the third-party driver you are using, see its documentation.