HLS General Options - HLS General Options - 2026.1 English - UG1399

Vitis High-Level Synthesis User Guide (UG1399)

Document ID
UG1399
Release Date
2026-06-23
Version
2026.1 English

Description

These top-level keys appear directly under the [hls] header — not under a syn.* prefix.

Syntax

Table 1. Configuration Table
Option Config File Key Default Description
clock clock=<value> 10ns Target clock period. Use ns suffix for nanoseconds or MHz suffix for frequency. E.g. clock=8ns, clock=250MHz.
clock_uncertainty clock_uncertainty=<value> 27% Timing uncertainty/margin. Accepts percentage (`15%`) or nanoseconds (`1.5ns`).
relative_roots relative_roots=<path_list> Ordered list of absolute paths used to resolve relative file paths in syn.file / tb.file.

Tcl Equivalents

create_clock -period <value> → clock; set_clock_uncertainty -uncertainty <val> → clock_uncertainty.

Example

[hls]
clock=8ns
clock_uncertainty=15%
default_axi=1
relative_roots=/proj/hls/src:/proj/hls/tb