General Options

The following command line options are applicable to any sds++ invocation or your display information.

Table 1. General Options
Option Valid Values Description
-sds-pf <platform_name> <platform_name> Specify the target platform that defines the base system hardware and software, including operation system and boot files. The <platform_name> can be the name of a platform in the SDSoC environment installation or a file path to a folder containing platform files with the last component of the path matching the platform name.

The platform defines the base hardware and software, including operation system and boot files. Use this option when compiling accelerator source files and when linking the ELF file. Use the –sds-pf-list option to list available platforms.

-sds-pf-info <platform_name> <platform_name> Display general information about a platform. Use the –sds-pf-list option to list available platforms. The information displayed includes available system configurations that can be specified with the -sds-sys-config system_configuration option.

<platform_name> can be the name of a platform in the SDSoC environment installation or a file path to a folder containing platform files.

-sds-pf-list N/A Display a list of available platforms and exit (if no other options are specified). The information displayed includes available system configurations that can be specified with the -sds-sys-config system_configuration option.
-sds-sys-config <configuration_name> <configuration_name> Specify the system configuration that defines the software platform used, which includes the target operating system and other settings. The -sds-pf-list and -sds-pf-info options can be used to list the available system configurations for a platform.

When the -sds-sys-config option is used, do not specify the -target-os option. If the -sds-sys-config option is not specified, the default system configuration is used.

<configuration_name> can be any of the available system configurations for a platform.

-sds-proc <processor_name> <processor_name> Specify the processor name to use with the system configuration defined by the -sds-sys-config option. A system configuration normally specifies a target CPU and this option is not required.

<processor_name> specifies the target CPU to use.

-sds-pf-path <path> <path> Specify a search path for platforms. The specified path can contain one or more sub-folders, each of which is a platform folder.

<path> is a search path for platforms.

-sds-image <image_name> <image_name> Used with the -sds-sys-config option, this specifies the SD card image to use. If this option is not specified, the default image is used.

<image_name> specifies the SD card image to use.

-target-os <os_name> <linux | standalone | freertos> Specify the target operating system. The selected OS determines the compiler toolchain used and includes file and library paths added by sds++. For a list of valid os_name options, use the command sdscc -sds-pf-info <plat_name>.

If the -sds-sys-config system_configuration option is specified, do not specify the -target-os option, because a system configuration itself defines a target operating system.

If you do not specify the -sds-sys-config but do specify the -target-os option, SDSoC searches for a system configuration with an OS that matches the one specified by -target-os.

-debug-xrf N/A Create Vivado HLS debug cross reference information when compiling functions for hardware, adding the config_debug Tcl command.
-debug-xrf-cc <compiler> <compiler> Specify the compiler executable used to compile accelerator source files for debug cross reference symbols (defaults to xcpp if not specified). If the path to the executable is not defined, use the PATH from the environment. If used, specify -debug-xrf-cc for both compile and link command lines.
-verbose N/A Print verbose output to STDOUT.
-version N/A Print the sds++ version information to STDOUT.
--help N/A Print command line help information. Note that two consecutive hyphen or dash characters - are used.

The following command line options are applicable only to sds++ invocations used to compile a source file.