From 4796c4acc40a686f29a390b774b6e98e095ec4f4 Mon Sep 17 00:00:00 2001 From: tmeissner Date: Tue, 6 Oct 2020 21:30:45 +0200 Subject: Synth doc: add infos about synth specific options, related to 667ab51 --- doc/using/Synthesis.rst | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) (limited to 'doc/using') diff --git a/doc/using/Synthesis.rst b/doc/using/Synthesis.rst index 3301d87d1..17adb0c9b 100644 --- a/doc/using/Synthesis.rst +++ b/doc/using/Synthesis.rst @@ -58,6 +58,50 @@ See :ghdlsharp:`1174` for on-going discussion about other output formats. .. TIP:: Files can be provided in any order. +.. _synthesis_options: + +Synthesis options +================== + +In addition to analyze options, there are some synthesis specific options. + +.. option:: -gNAME=VALUE + + Override top unit generic `NAME` with value `VALUE`. Similar to the run-time option :option:`-gGENERIC=VALUE`. + + Example:: + + $ ghdl --synth --std=08 -gDEPTH=12 my_unit + +.. option:: --vendor-library=NAME + + Any unit from library NAME is a black box. + + Example:: + + $ ghdl --synth --std=08 --vendor-library=vendorlib my_unit + +.. option:: --no-formal + + Neither synthesize assert nor PSL. + + Example:: + + $ ghdl --synth --std=08 --no-formal my_unit + +.. option:: --no-assert-cover + + Disable automatic cover PSL assertion activation. If this option isn't used, GHDL generates + `cover` directives for each `assert` directive automatically during synthesis. + + Example:: + + $ ghdl --synth --std=08 --no-assert-cover my_unit + +.. TIP:: + Furthermore there are lot of debug options available. Beware: These debug options should only used + for debugging purposes as they aren't guaranteed to be stable during development of GHDL's synthesis feature. You can find them in the file `src/ghdldrv/ghdlsynth.adb `_ in the procedure `Decode_Option()`. + .. _Synth:plugin: Yosys plugin -- cgit v1.2.3