opencos-eda 0.3.11__py3-none-any.whl → 0.3.13__py3-none-any.whl

opencos/eda_config_defaults.yml

@@ -74,6 +74,7 @@ deps_markup_supported: true  # Support DEPS.yml files (also .yaml, .toml, .json)
 deps_subprocess_shell: true  # Support subprocess commands using shell=True
 bare_plusarg_supported: true # Support for CLI, DEPS args or deps: +<string> that isn't +define or +incdirs
 deps_expandvars_enable : true # Support env $VAR replacement on targets or files in DEPS.yml
+show_tool_versions: true      # Set to false for tiny performance tweak if --tool arg not supplied
 
 dep_sub: [ ] # Legacy, no longer supported.
 vars: { }    # Legacy, no longer supported.
@@ -115,6 +116,7 @@ command_determines_tool:
 
 command_tool_is_optional:
   # eda commands that may not need to use a tool at all, will skip auto_tools_order if --tool=None (default)
+  - shell
   - flist
   - export
   - targets
@@ -125,11 +127,89 @@ command_has_subcommands:
   - tools-multi
   - sweep
 
+#
+# auto_tools_order
+# -- Is only used when arg --tool is not set, on command line or via -f, --input-file, or DEPS
+# -- This table should be modified when a new tool is added, if you'd like it to be chosen without
+#    --tool arg.
+# -- Is in-order for the handlers, so Verilator is the default simulator if
+#    verilator is installed and the eda command is "sim".
+# -- Each key: [list-of-strings] is a list so config changes use Strategy.REPLACE to replace it
+#    meaning if a user brings their own auto_tools_order for 'lint' they must define the complete
+#    auto order when --tool is not specified
+#
+auto_tools_order:
+  lint:
+    - slang
+    - surelog
+    - verilator
+    - vivado
+    - modelsim_ase
+    - questa_fse
+    - questa_fe
+    - questa
+    - riviera
+    - iverilog
+    - invio
+  elab:
+    - slang
+    - surelog
+    - verilator
+    - vivado
+    - modelsim_ase
+    - questa_fse
+    - questa_fe
+    - questa
+    - slang_yosys
+    - riviera
+    - iverilog
+    - invio
+    - invio_yosys
+  sim:
+    - verilator
+    - vivado
+    - modelsim_ase
+    - questa_fse
+    - questa_fe
+    - questa
+    - riviera
+    - iverilog
+  synth:
+    - slang_yosys
+    - vivado
+    - quartus
+    - tabbycad_yosys
+    - invio_yosys
+    - yosys
+  proj:
+    - vivado
+    - quartus
+  build:
+    - vivado
+    - quartus
+  open:
+    - vivado
+    - quartus
+  lec:
+    - slang_yosys
+    - yosys
 
 
 tools:
 
   # <tool-name>:
+  #   exe:                 <Array of strings, or single string, required exe>
+  #   requires_cmd:        <Array of shell commands that must complete with rc=0 for tool to work>
+  #   requires_py:         <Array of strings, python packages requires for tool to work>
+  #   requires_vscode_extension: <Array of strings, vscode extensions that must be present for
+  #                               tool to work>
+  #   requires_vsim_helper: <Bool, if True we will determine which vsim exe(s) are present in PATH
+  #                          for tool to work, such that Modelsim, Questa, Riviera can all be
+  #                          present in PATH and each tool can still be chosen>
+  #   handlers:            <Table of {command, python package class name}, for how this tool
+  #                         will run an eda command>
+  #   disable-auto:        <Bool, if True do not allow this to run `eda [command]` with --tool
+  #                         not set>
   #   defines:             <Table, macroName: <value|null|> >
   #   log-bad-strings:     <Array of strings>
   #   log-must-strings:    <Array of strings>
@@ -145,9 +225,37 @@ tools:
   #   simulate-waivers:    <Array of strings, no spaces>
   #   coverage-args:       <string space separated>
 
+
+  vaporview:
+    exe: code
+    requires_vscode_extension:
+      - lramseyer.vaporview
+    handlers:
+      waves: opencos.commands.waves.CommandWaves
+
+  surfer:
+    exe: code
+    requires_vscode_extension:
+      - surfer-project.surfer
+    handlers:
+      waves: opencos.commands.waves.CommandWaves
+
+  gtkwave:
+    exe: gtkwave
+    handlers:
+      waves: opencos.commands.waves.CommandWaves
+
   slang:
+    exe: slang
+    requires_cmd:
+      - slang --version
+    handlers:
+      lint: opencos.tools.slang.CommandLintSlang
+      elab: opencos.tools.slang.CommandElabSlang
+
     defines:
       OC_TOOL_SLANG: null
+      SLANG: 1
     log-bad-strings:
       - 'Build failed: '
     log-must-strings:
@@ -161,7 +269,14 @@ tools:
     compile-waivers: []
 
   verilator:
-    defines: { }
+    exe: verilator
+    handlers:
+      lint: opencos.tools.verilator.VerilatorLint
+      elab: opencos.tools.verilator.VerilatorElab
+      sim: opencos.tools.verilator.VerilatorSim
+
+    defines:
+      SIMULATION: 1
     log-warning-strings:
       - "%Warning"
     log-bad-strings:
@@ -232,6 +347,13 @@ tools:
 
 
   surelog:
+    exe: surelog
+    requires_cmd:
+      - surelog --version
+    handlers:
+      lint: opencos.tools.surelog.CommandLintSurelog
+      elab: opencos.tools.surelog.CommandElabSurelog
+
     defines:
       OC_TOOL_SURELOG: null
     compile-args: |
@@ -239,6 +361,15 @@ tools:
       -timescale=1ns/1ns
 
   invio:
+    exe: python3
+    requires_cmd:
+      - python -c "import invio"
+    requires_py:
+      - invio
+    handlers:
+      lint:  opencos.tools.invio.CommandLintInvio
+      elab:  opencos.tools.invio.CommandElabInvio
+
     defines:
       OC_TOOL_INVIO: null
       INVIO: null
@@ -246,18 +377,32 @@ tools:
 
 
   riviera:
+    exe: vsim
+    requires_cmd:
+      - which riviera  # Do not run it, make sure it's in PATH
+    requires_vsim_helper: True
+    handlers:
+      lint: opencos.tools.riviera.CommandLintRiviera
+      elab: opencos.tools.riviera.CommandElabRiviera
+      sim:  opencos.tools.riviera.CommandSimRiviera
+      flist: opencos.tools.riviera.CommandFListRiviera
+      waves:  opencos.commands.waves.CommandWaves
+
     defines:
       OC_TOOL_RIVIERA: 1
       RIVIERA: 1
+      # see oclib_defines.vh, this is to prevent type comparisons
+      OC_TOOL_BROKEN_TYPE_COMPARISON: 1
     log-warning-strings:
       - "Warning: "
     log-bad-strings:
       - "Error: "
       - "Fatal: "
+      - "You do not have a valid license to run"
     log-must-strings:
       - "VSIM: Simulation has finished"
     compile-args: |
-      -echo -sv -input_ports net -lcu -dbg +accb +accr +accs +dacc
+      -echo -sv -input_ports net -dbg +accb +accr +accs +dacc
     compile-coverage-args: |
       -coverage sbecam -coverage_options count
     # -uvm -ovm
@@ -271,9 +416,20 @@ tools:
 
 
   modelsim_ase:
+    exe: vsim
+    requires_vsim_helper: True
+    handlers:
+      lint: opencos.tools.modelsim_ase.CommandLintModelsimAse
+      elab: opencos.tools.modelsim_ase.CommandElabModelsimAse
+      sim:  opencos.tools.modelsim_ase.CommandSimModelsimAse
+      flist: opencos.tools.modelsim_ase.CommandFListModelsimAse
+      waves:  opencos.commands.waves.CommandWaves
+
     defines:
       OC_ASSERT_PROPERTY_NOT_SUPPORTED: 1
       OC_TOOL_MODELSIM_ASE: 1
+      # see oclib_defines.vh, this is to prevent type comparisons
+      OC_TOOL_BROKEN_TYPE_COMPARISON: 1
     log-warning-strings:
       - "Warning: "
     log-bad-strings:
@@ -299,7 +455,53 @@ tools:
       +acc
 
 
-  questa_fse:
+  questa_fe: # FPGA edition
+    exe: vsim
+    requires_vsim_helper: True
+    handlers:
+      lint: opencos.tools.questa_fe.CommandLintQuestaFe
+      elab: opencos.tools.questa_fe.CommandElabQuestaFe
+      sim: opencos.tools.questa_fe.CommandSimQuestaFe
+      flist: opencos.tools.questa_fe.CommandFListQuestaFe
+      waves:  opencos.commands.waves.CommandWaves
+
+    defines:
+      OC_TOOL_QUESTA_FE: 1
+    log-warning-strings:
+      - "Warning: "
+    log-bad-strings:
+      - "Error: "
+      - "Fatal: "
+    log-must-strings:
+      - " vsim "
+      - "Errors: 0"
+    compile-args: |
+      -sv -svinputport=net -lint
+    compile-waivers:
+      - 2275 # 2275 - Existing package 'myname_pkg' will be overwritten.
+      - 2555 # 2555 - assignment to input port myname
+      - 2583 # 2583 - [SVCHK] - Extra checking for conflicts with always_comb and
+             #        always_latch variables is done at vopt time.
+      - 13159 # 13159, 2685, 2718 are all related to module instance port default values.
+      - 2685
+      - 2718
+    simulate-waivers:
+      - 3009 # 3009: [TSCALE] - Module 'myname' does not have a timeunit/timeprecision
+             #       specification in effect, but other modules do.
+    simulate-waves-args: |
+      -voptargs=+acc=bcnprst
+
+
+  questa_fse: # FPGA starter edition
+    exe: vsim
+    requires_vsim_helper: True
+    handlers:
+      lint: opencos.tools.questa_fse.CommandLintQuestaFse
+      elab: opencos.tools.questa_fse.CommandElabQuestaFse
+      sim:  opencos.tools.questa_fse.CommandSimQuestaFse
+      flist: opencos.tools.questa_fse.CommandFListQuestaFse
+      waves:  opencos.commands.waves.CommandWaves
+
     defines:
       OC_TOOL_QUESTA_FSE: 1
     log-warning-strings:
@@ -327,7 +529,54 @@ tools:
       -voptargs=+acc=bcnprst
 
 
+  questa: # Questa
+    exe: vsim
+    requires_vsim_helper: True
+    handlers:
+      lint: opencos.tools.questa.CommandLintQuesta
+      elab: opencos.tools.questa.CommandElabQuesta
+      sim: opencos.tools.questa.CommandSimQuesta
+      flist: opencos.tools.questa.CommandFListQuesta
+      waves:  opencos.commands.waves.CommandWaves
+
+    defines:
+      OC_TOOL_QUESTA: 1
+    log-warning-strings:
+      - "Warning: "
+    log-bad-strings:
+      - "Error: "
+      - "Fatal: "
+    log-must-strings:
+      - " vsim "
+      - "Errors: 0"
+    compile-args: |
+      -sv -svinputport=net -lint
+    compile-waivers:
+      - 2275 # 2275 - Existing package 'myname_pkg' will be overwritten.
+      - 2555 # 2555 - assignment to input port myname
+      - 2583 # 2583 - [SVCHK] - Extra checking for conflicts with always_comb and
+             #        always_latch variables is done at vopt time.
+      - 13159 # 13159, 2685, 2718 are all related to module instance port default values.
+      - 2685
+      - 2718
+    simulate-waivers:
+      - 3009 # 3009: [TSCALE] - Module 'myname' does not have a timeunit/timeprecision
+             #       specification in effect, but other modules do.
+    simulate-waves-args: |
+      -voptargs=+acc=bcnprst
+
+
   iverilog:
+    exe: iverilog
+    handlers:
+      lint: opencos.tools.iverilog.CommandLintIverilog
+      elab: opencos.tools.iverilog.CommandElabIverilog
+      sim:  opencos.tools.iverilog.CommandSimIverilog
+    defines:
+      SIMULATION: 1
+      IVERILOG: 1
+      OC_ASSERT_PROPERTY_NOT_SUPPORTED: 1
+
     log-warning-strings:
       - "Warning:"
       - "WARNING:"
@@ -348,8 +597,19 @@ tools:
       +trace
 
   cocotb:
+    disable-auto: True # do not allow this to run `eda sim` with --tool not set
+    exe: python
+    requires_cmd:
+      - python -c "import cocotb; print(cocotb.__version__)"
+    requires_py:
+      - cocotb
+    handlers:
+      sim:  opencos.tools.cocotb.CommandSimCocotb
+
     defines:
       OC_TOOL_COCOTB: null
+      COCOTB: 1
+      SIMULATION: 1
     log-warning-strings:
       - "Warning:"
       - "WARNING:"
@@ -365,10 +625,32 @@ tools:
 
 
   quartus:
+    exe: quartus_sh
+    handlers:
+      synth: opencos.tools.quartus.CommandSynthQuartus
+      build: opencos.tools.quartus.CommandBuildQuartus
+      flist: opencos.tools.quartus.CommandFListQuartus
+      proj: opencos.tools.quartus.CommandProjQuartus
+      upload: opencos.tools.quartus.CommandUploadQuartus
+      open: opencos.tools.quartus.CommandOpenQuartus
+
     defines:
       OC_TOOL_QUARTUS: null
 
   vivado:
+    exe: vivado
+    handlers:
+      lint:   opencos.tools.vivado.CommandLintVivado
+      elab:   opencos.tools.vivado.CommandElabVivado
+      sim:    opencos.tools.vivado.CommandSimVivado
+      synth:  opencos.tools.vivado.CommandSynthVivado
+      proj:   opencos.tools.vivado.CommandProjVivado
+      upload: opencos.tools.vivado.CommandUploadVivado
+      open:   opencos.tools.vivado.CommandOpenVivado
+      flist:  opencos.tools.vivado.CommandFListVivado
+      build:  opencos.tools.vivado.CommandBuildVivado
+      waves:  opencos.commands.waves.CommandWaves
+
     log-warning-strings:
       - "WARNING: "
       - "Warning: "
@@ -394,196 +676,45 @@ tools:
     simulate-args: |
       snapshot --stats --onerror quit
 
+  slang_yosys:
+    exe: yosys
+    requires_cmd:
+      - yosys -m slang
+    handlers:
+      elab:  opencos.tools.slang_yosys.CommandElabSlangYosys
+      synth: opencos.tools.slang_yosys.CommandSynthSlangYosys
+      lec:   opencos.tools.slang_yosys.CommandLecSlangYosys
+    defines:
+      OC_TOOL_YOSYS: null
+      OC_TOOL_SLANG: null
+      SLANG: 1
+
+  tabbycad_yosys:
+    exe: yosys
+    requires_env:
+      - YOSYSHQ_LICENSE
+    handlers:
+      synth: opencos.tools.tabbycad_yosys.CommandSynthTabbyCadYosys
+    defines:
+      OC_TOOL_YOSYS: null
+      OC_TOOL_TABBYCAD: null
+
+  invio_yosys:
+    exe: yosys
+    requires_cmd:
+      - python -c "import invio"
+    requires_py:
+      - invio
+    handlers:
+      elab:  opencos.tools.invio_yosys.CommandElabInvioYosys
+      synth: opencos.tools.invio_yosys.CommandSynthInvioYosys
+      OC_TOOL_YOSYS: null
+      OC_TOOL_INVIO: null
 
-#
-# auto_tools_order
-# -- should be used when a new tool is added.
-# -- Is in-order for the handlers, so Verilator is the default simulator if
-#    verilator is installed and the eda command is "sim".
-#
-auto_tools_order:
-  - # This is a list so config changes use Strategy.REPLACE to replace it
-
-    slang:
-      exe: slang
-      requires_cmd:
-        - slang --version
-      handlers:
-        lint: opencos.tools.slang.CommandLintSlang
-        elab: opencos.tools.slang.CommandElabSlang
-
-    verilator:
-      exe: verilator
-      handlers:
-        lint: opencos.tools.verilator.VerilatorLint
-        elab: opencos.tools.verilator.VerilatorElab
-        sim: opencos.tools.verilator.VerilatorSim
-
-    # TODO(drew): surelog is disabled from `eda tools-multi`. It is still
-    # enabled for `eda [multi] elab --tool surelog`. It does not support
-    # type comparisons:
-    #   if type(myname) == type(othername)
-    # [ERR:UH0700] ... Unsupported expression
-    # modelsim_ase also doesn't, but it won't fail elab, whereas surelog does.
-    surelog:
-      disable-tools-multi: true # surelog doesn't support enough of IEEE-1800
-      exe: surelog
-      requires_cmd:
-        - surelog --version
-      handlers:
-        lint: opencos.tools.surelog.CommandLintSurelog
-        elab: opencos.tools.surelog.CommandElabSurelog
-
-    invio:
-      exe: python3
-      requires_cmd:
-        - python -c "import invio"
-      requires_py:
-        - invio
-      handlers:
-        lint:  opencos.tools.invio.CommandLintInvio
-        elab:  opencos.tools.invio.CommandElabInvio
-
-    vaporview:
-      exe: code
-      requires_vscode_extension:
-        - lramseyer.vaporview
-      handlers:
-        waves: opencos.commands.waves.CommandWaves
-
-    surfer:
-      exe: code
-      requires_vscode_extension:
-        - surfer-project.surfer
-      handlers:
-        waves: opencos.commands.waves.CommandWaves
-
-    gtkwave:
-      exe: gtkwave
-      handlers:
-        waves: opencos.commands.waves.CommandWaves
-
-    quartus:
-      exe: quartus_sh
-      handlers:
-        synth: opencos.tools.quartus.CommandSynthQuartus
-        build: opencos.tools.quartus.CommandBuildQuartus
-        flist: opencos.tools.quartus.CommandFListQuartus
-        proj: opencos.tools.quartus.CommandProjQuartus
-        upload: opencos.tools.quartus.CommandUploadQuartus
-        open: opencos.tools.quartus.CommandOpenQuartus
-
-    vivado:
-      exe: vivado
-      handlers:
-        lint:   opencos.tools.vivado.CommandLintVivado
-        elab:   opencos.tools.vivado.CommandElabVivado
-        sim:    opencos.tools.vivado.CommandSimVivado
-        synth:  opencos.tools.vivado.CommandSynthVivado
-        proj:   opencos.tools.vivado.CommandProjVivado
-        upload: opencos.tools.vivado.CommandUploadVivado
-        open:   opencos.tools.vivado.CommandOpenVivado
-        flist:  opencos.tools.vivado.CommandFListVivado
-        build:  opencos.tools.vivado.CommandBuildVivado
-        waves:  opencos.commands.waves.CommandWaves
-
-    slang_yosys:
-      exe: yosys
-      requires_cmd:
-        - yosys -m slang
-      handlers:
-        elab:  opencos.tools.slang_yosys.CommandElabSlangYosys
-        synth: opencos.tools.slang_yosys.CommandSynthSlangYosys
-        lec:   opencos.tools.slang_yosys.CommandLecSlangYosys
-
-    tabbycad_yosys:
-      exe: yosys
-      requires_env:
-        - YOSYSHQ_LICENSE
-      handlers:
-        synth: opencos.tools.tabbycad_yosys.CommandSynthTabbyCadYosys
-
-    invio_yosys:
-      exe: yosys
-      requires_cmd:
-        - python -c "import invio"
-      requires_py:
-        - invio
-      handlers:
-        elab:  opencos.tools.invio_yosys.CommandElabInvioYosys
-        synth: opencos.tools.invio_yosys.CommandSynthInvioYosys
-
-    yosys:
-      exe: yosys
-      requires_cmd:
-        - yosys
-      handlers:
-        synth: opencos.tools.slang_yosys.CommonSynthYosys
-        lec:   opencos.tools.slang_yosys.CommandLecYosys
-
-    questa:
-      exe: vsim
-      requires_vsim_helper: True
-      handlers:
-        lint: opencos.tools.questa.CommandLintQuesta
-        elab: opencos.tools.questa.CommandElabQuesta
-        sim: opencos.tools.questa.CommandSimQuesta
-        flist: opencos.tools.questa.CommandFListQuesta
-        waves:  opencos.commands.waves.CommandWaves
-
-    riviera:
-      exe: vsim
-      requires_cmd:
-        - which riviera  # Do not run it, make sure it's in PATH
-      requires_vsim_helper: True
-      handlers:
-        lint: opencos.tools.riviera.CommandLintRiviera
-        elab: opencos.tools.riviera.CommandElabRiviera
-        sim:  opencos.tools.riviera.CommandSimRiviera
-        waves:  opencos.commands.waves.CommandWaves
-
-    questa_fe:
-      exe: vsim
-      requires_vsim_helper: True
-      handlers:
-        lint: opencos.tools.questa_fe.CommandLintQuestaFe
-        elab: opencos.tools.questa_fe.CommandElabQuestaFe
-        sim: opencos.tools.questa_fe.CommandSimQuestaFe
-        flist: opencos.tools.questa_fe.CommandFListQuestaFe
-        waves:  opencos.commands.waves.CommandWaves
-
-    questa_fse:  # free student edition, works similar to modelsim_ase
-      exe: vsim
-      requires_vsim_helper: True
-      handlers:
-        lint: opencos.tools.questa_fse.CommandLintQuestaFse
-        elab: opencos.tools.questa_fse.CommandElabQuestaFse
-        sim:  opencos.tools.questa_fse.CommandSimQuestaFse
-        flist: opencos.tools.questa_fse.CommandFListQuestaFse
-        waves:  opencos.commands.waves.CommandWaves
-
-    modelsim_ase:
-      exe: vsim
-      requires_vsim_helper: True
-      handlers:
-        lint: opencos.tools.modelsim_ase.CommandLintModelsimAse
-        elab: opencos.tools.modelsim_ase.CommandElabModelsimAse
-        sim:  opencos.tools.modelsim_ase.CommandSimModelsimAse
-        waves:  opencos.commands.waves.CommandWaves
-
-    iverilog:
-      exe: iverilog
-      handlers:
-        lint: opencos.tools.iverilog.CommandLintIverilog
-        elab: opencos.tools.iverilog.CommandElabIverilog
-        sim:  opencos.tools.iverilog.CommandSimIverilog
-
-    cocotb:
-      disable-auto: True # do not allow this to run `eda sim` with --tool not set
-      exe: python
-      requires_cmd:
-        - python -c "import cocotb; print(cocotb.__version__)"
-      requires_py:
-        - cocotb
-      handlers:
-        sim:  opencos.tools.cocotb.CommandSimCocotb
+  yosys:
+    exe: yosys
+    requires_cmd:
+      - yosys
+    handlers:
+      synth: opencos.tools.slang_yosys.CommonSynthYosys
+      lec:   opencos.tools.slang_yosys.CommandLecYosys

opencos/eda_config_reduced.yml

@@ -14,6 +14,11 @@ deps_subprocess_shell: false
 
 tools:
   verilator:
+    exe: verilator
+    handlers:
+      lint: opencos.tools.verilator.VerilatorLint
+      elab: opencos.tools.verilator.VerilatorElab
+      sim: opencos.tools.verilator.VerilatorSim
     compile-waivers:
       - CASEINCOMPLETE
       - REALCVT  # Implicit conversion of real to integer
@@ -23,43 +28,18 @@ tools:
       - WIDTH
       - fatal
 
-auto_tools_order:
-  -
-    slang:
-      exe: slang
-      requires_cmd:
-        - slang --version
-      handlers:
-        elab: opencos.tools.slang.CommandElabSlang
-
-    verilator:
-      exe: verilator
-      handlers:
-        elab: opencos.tools.verilator.VerilatorElab
-        sim: opencos.tools.verilator.VerilatorSim
-
-    gtkwave:
-      exe: gtkwave
-      handlers: { }
+  # leave slang, modelsim_ase, iverilog, slang_yosys at defaults
 
-    slang_yosys:
-      exe: yosys
-      requires_cmd:
-        - yosys -m slang
-      handlers:
-        elab:  opencos.tools.slang_yosys.CommandElabSlangYosys
-        synth: opencos.tools.slang_yosys.CommandSynthSlangYosys
-
-    modelsim_ase:
-      exe: vsim
-      requires_cmd:
-        - vsim -version
-      handlers:
-        elab: opencos.tools.modelsim_ase.CommandElabModelsimAse
-        sim: opencos.tools.modelsim_ase.CommandSimModelsimAse
-
-    iverilog:
-      exe: iverilog
-      handlers:
-        elab: opencos.tools.iverilog.CommandElabIverilog
-        sim: opencos.tools.iverilog.CommandSimIverilog
+auto_tools_order:
+  lint:
+    - slang
+    - verilator
+  elab:
+    - slang
+    - verilator
+  sim:
+    - verilator
+    - modelsim_ase
+    - iverilog
+  synth:
+    - slang_yosys