SimplHDL 0.2.2__tar.gz → 0.3.0__tar.gz

{simplhdl-0.2.2 → simplhdl-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: SimplHDL
-Version: 0.2.2
+Version: 0.3.0
 Summary: A framework for simulating and implementing HDL designs
 Author-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>
 Maintainer-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>

simplhdl-0.3.0/examples/hdl/adder/sim/testbench.yml

@@ -0,0 +1,14 @@
+#%SimplAPI=1.0
+
+library: work
+top: testbench
+
+dependencies:
+  - ../adder.yml
+
+files:
+  - testbench.sv
+
+targets:
+    questasim: questasim --vopt-args "-suppress vopt-2685"
+    vcs: vcs --vcs-args +warn=noTFIPC

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/SimplHDL.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: SimplHDL
-Version: 0.2.2
+Version: 0.3.0
 Summary: A framework for simulating and implementing HDL designs
 Author-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>
 Maintainer-email: Rasmus Grøndahl Olsen <simplhdl@gmail.com>

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/SimplHDL.egg-info/SOURCES.txt

@@ -94,6 +94,7 @@ src/simplhdl/info.py
 src/simplhdl/parser.py
 src/simplhdl/plugins.py
 src/simplhdl/repo.py
+src/simplhdl/run.py
 src/simplhdl/simplhdl.py
 src/simplhdl/tools.py
 src/simplhdl/utils.py
@@ -134,6 +135,7 @@ src/simplhdl/pyedaa/design.py
 src/simplhdl/pyedaa/fileset.py
 src/simplhdl/pyedaa/filetypes.py
 src/simplhdl/pyedaa/project.py
+src/simplhdl/pyedaa/target.py
 src/simplhdl/pyedaa/vhdllibrary.py
 src/simplhdl/resources/__init__.py
 src/simplhdl/resources/templates/__init__.py

simplhdl-0.3.0/src/simplhdl/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.0"

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/__main__.py

@@ -4,6 +4,8 @@ import argcomplete
 import logging
 import traceback
 
+from typing import Sequence
+
 from pathlib import Path
 from . import __version__
 from .simplhdl import Simplhdl
@@ -16,7 +18,7 @@ from .utils import CalledShError
 logger = logging.getLogger(__name__)
 
 
-def parse_arguments():
+def parse_arguments(args: Sequence[str] = None, namespace: None = None) -> argparse.Namespace:
 
     parser = argparse.ArgumentParser(
         prog="simpl",
@@ -56,7 +58,7 @@ def parse_arguments():
         flow_class.parse_args(subparsers)
 
     argcomplete.autocomplete(parser)
-    return parser.parse_args()
+    return parser.parse_args(args=args, namespace=namespace)
 
 
 def main():

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/flows/quartusflow.py

@@ -35,7 +35,7 @@ class QuartusFlow(ImplementationFlow):
             '-s',
             '--step',
             action='store',
-            choices=['project', 'synthesis', 'implement', 'finalize', 'compile'],
+            choices=['project', 'elaborate', 'implement', 'finalize', 'compile'],
             default='compile',
             help="flow step to run"
         )

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/flows/questasim/questasimflow.py

@@ -168,11 +168,11 @@ class QuestaSimFlow(SimulationFlow):
             args.add(f"-g{name}={escape(value)}")
         for name, value in self.project.Parameters.items():
             args.add(f"-g{name}={escape(value)}")
-        if self.args.debug:
+        if self.args.gui or self.args.debug:
             args.add('+acc')
             args.add('-debugdb')
             args.add('-fsmdebug')
-        elif self.args.gui or self.args.do or self.args.wavedump or self.cocotb.enabled:
+        elif self.args.do or self.args.wavedump or self.cocotb.enabled:
             args.add('+acc=npr')
         return ' '.join(list(args) + [self.args.vopt_args])
 
@@ -259,6 +259,9 @@ class QuestaSimFlow(SimulationFlow):
                 command.append('-visualizer')
             command.append('-gui')
         elif self.args.step:
+            if step == "elaborate":
+                command.append('-optimize')
+                return command
             command.append(f'-{step}')
 
         if self.args.do:

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/flows/vivadoflow.py

@@ -31,6 +31,8 @@ class VivadoFlow(FlowBase):
             '--step',
             action='store',
             choices=[
+                'lint',
+                'elaborate',
                 'synthesis',
                 'opt',
                 'power_opt',
@@ -83,6 +85,15 @@ class VivadoFlow(FlowBase):
         sh(command, cwd=self.builddir, output=True)
         raise SystemExit
 
+    def get_files(self):
+        files = []
+        seen = []
+        for f in self.project.DefaultDesign.Files():
+            if 'implementation' in f[UsedIn] and f.Path not in seen:
+                seen.append(f.Path)
+                files.append(f)
+        return files
+
     def setup(self):
         self.is_tool_setup()
         os.makedirs(self.builddir, exist_ok=True)
@@ -94,6 +105,7 @@ class VivadoFlow(FlowBase):
             trim_blocks=True)
         template = environment.get_template('project.tcl.j2')
         generate_from_template(template, self.builddir,
+                               files=self.get_files(),
                                dict2str=dict2str,
                                VerilogIncludeFile=VerilogIncludeFile,
                                VerilogSourceFile=VerilogSourceFile,
@@ -119,12 +131,6 @@ class VivadoFlow(FlowBase):
         name = self.project.Name
         command = f"vivado {name}.xpr -mode batch -notrace -source run.tcl -tclargs {step}".split()
         sh(command, cwd=self.builddir, output=True)
-        # jsonfile = self.builddir.joinpath('runs.json')
-        # with jsonfile.open() as f:
-        #     runs: Dict[str, List[str]] = json.load(f)
-        # for name, run in runs.items():
-        #     for script in run:
-        #         sh(['bash', 'launch_run.sh', script], output=True, cwd=self.builddir)
 
     def run(self) -> None:
         if self.args.archive:

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/flows/xsim/xsimflow.py

@@ -133,6 +133,8 @@ class XsimFlow(SimulationFlow):
         args.add(f"-v {self.args.verbose if self.args.verbose < 2 else 2}")
         for name, value in self.project.Defines.items():
             args.add(f"-d {name}={escape(value)}")
+        if self.is_uvm():
+            args.add('-L uvm')
         return ' '.join(list(args) + [self.args.xvlog_args]).strip()
 
     def xvhdl_args(self) -> str:
@@ -150,6 +152,8 @@ class XsimFlow(SimulationFlow):
             args.add(f"--generic_top {name}={escape(value)}")
         for name, value in self.project.Parameters.items():
             args.add(f"--generic_top {name}={escape(value)}")
+        if self.args.wave or self.args.gui:
+            args.add('-debug all')
         return ' '.join(list(args) + [self.args.xelab_args])
 
     def xsim_args(self) -> str:

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/parser.py

@@ -62,8 +62,7 @@ class ParserFactory:
             if parser.is_valid_format(filename):
                 return parser
         if filename is None:
-            logger.info("No project specification found, continue with empty project")
-            return NoParser()
+            raise ParserError("Couldn't find any project specification in current directory")
         else:
             raise ParserError(f"Couldn't find Parser for parsing '{filename}'")
 

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/parsers/simplhdlparser.py

@@ -1,9 +1,12 @@
 import yaml
 
-from typing import Dict, List, Optional
+from typing import Dict, Optional
 from pathlib import Path
 from argparse import Namespace
+from shlex import split
+from simplhdl.__main__ import parse_arguments
 from simplhdl.pyedaa.project import Project
+from simplhdl.pyedaa.target import Target
 from simplhdl.pyedaa.fileset import FileSet  # type: ignore
 from simplhdl.pyedaa.vhdllibrary import VHDLLibrary
 from simplhdl.pyedaa import (
@@ -18,11 +21,11 @@ from ..parser import ParserFactory, ParserBase
 class SimplHdlParser(ParserBase):
 
     _format_id: str = "#%SimplAPI=1.0"
-    _core_stack: List[Path] = list()
-    _core_visited: List[Path] = list()
 
     def __init__(self):
         super().__init__()
+        self._core_stack = list()
+        self._core_visited = list()
 
     def is_valid_format(self, filename: Optional[Path]) -> bool:
         if filename is None:
@@ -62,6 +65,9 @@ class SimplHdlParser(ParserBase):
         if 'top' in spec:
             fileset.TopLevel = spec.get('top')
 
+        for name, value in spec.get('targets', dict()).items():
+            target = Target(name=name, args=parse_arguments(split(value)), cwd=self._core_stack[-1].parent)
+            project.AddTarget(target)
         for name, value in spec.get('defines', dict()).items():
             project.AddDefine(name, value)
         for name, value in spec.get('parameters', dict()).items():

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/plugins.py

@@ -23,6 +23,7 @@ def load_builtin_plugins() -> None:
     Loads builtin plugins.
     """
     import_module('simplhdl.info')
+    import_module('simplhdl.run')
     import_module('simplhdl.flows.vcs.vcsflow')
     import_module('simplhdl.flows.questasim.questasimflow')
     import_module('simplhdl.flows.modelsim.modelsimflow')

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/pyedaa/fileset.py

@@ -85,5 +85,5 @@ class FileSet(pm.FileSet):
             if isinstance(item, VerilogIncludeFile):
                 dirs.append(VerilogIncludeSearchPath(item.Path.parent.absolute()))
             elif isinstance(item, HDLSearchPath):
-                dirs.append(HDLSearchPath(item.Path.parent.absolute()))
+                dirs.append(HDLSearchPath(item.Path.absolute()))
         return dirs

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/pyedaa/project.py

@@ -5,6 +5,7 @@ from typing import Dict, List, Optional
 from pathlib import Path
 from ..repo import Repo
 from .design import Design
+from .target import Target
 from . import (
     IPSpecificationFile, TCLSourceFile, CocotbPythonFile, SettingFile, HDLIncludeFile,
     ConstraintFile, VHDLSourceFile, VerilogSourceFile, SystemVerilogSourceFile)
@@ -22,6 +23,7 @@ class Project(pm.Project):
     _hooks: Dict[str, List[str]]
     _repos: Dict[str, Repo]
     _reposdir: Optional[Path]
+    _targets: Dict[str, Target]
 
     def __init__(
         self,
@@ -40,6 +42,28 @@ class Project(pm.Project):
         self._repos = dict()
         self._reposdir = None
         self._part = None
+        self._targets = dict()
+
+    def GetTarget(self, name: str) -> Target:
+        try:
+            target = self._targets[name]
+        except KeyError:
+            raise FileNotFoundError(f"Target with name '{name}' doesn't exists")
+        return target
+
+    def AddTarget(self, target: Target) -> None:
+        if target.name in self._targets:
+            logger.warning(f"Ignore '{target.name}', target already exists")
+        else:
+            self._targets[target.name] = target
+
+    @property
+    def DefaultTarget(self) -> Target:
+        try:
+            target = next(iter(self._targets.values()))
+        except StopIteration:
+            raise FileNotFoundError("No targets defined")
+        return target
 
     @property
     def ReposDir(self) -> Optional[Path]:

simplhdl-0.3.0/src/simplhdl/pyedaa/target.py

@@ -0,0 +1,31 @@
+from typing import Optional
+from pathlib import Path
+
+from argparse import Namespace
+
+
+class Target:
+    def __init__(self, name: str, args: Optional[Namespace] = None, cwd: Path = None) -> None:
+        self.name = name
+        self._args = args
+        self._cwd = cwd or Path('.')
+
+    @property
+    def args(self) -> Namespace:
+        if self._args is None:
+            raise FileNotFoundError(f"Target '{self.name}' has no arguments defined")
+        return self._args
+
+    @args.setter
+    def args(self, args: Namespace) -> None:
+        self._args = args
+
+    @property
+    def cwd(self) -> Path:
+        if self._cwd is None:
+            raise FileNotFoundError(f"Target '{self.name}' has no cwd defined")
+        return self._cwd
+
+    @cwd.setter
+    def cwd(self, path: Path) -> None:
+        self._cwd = path

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/resources/templates/quartus/run.tcl.j2

@@ -18,7 +18,7 @@ switch $step {
       	puts "\nINFO: Compilation was successful.\n"
       }
    }
-   synthesis {
+   elaborate {
       if {[catch {execute_flow -analysis_and_elaboration} result]} {
       	puts "\nResult: $result\n"
       	puts "ERROR: Analysis and Elaboraion failed. See report files.\n"

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/resources/templates/vivado/project.tcl.j2

@@ -76,7 +76,7 @@ foreach fileset [get_filesets -filter {FILESET_TYPE =~ *Srcs}] {
     set_property verilog_define "{{dict2str(project.Defines)}}" $fileset
 }
 {% endif %}
-{% for file in project.DefaultDesign.Files() if 'implementation' in file[UsedIn] %}
+{% for file in files %}
 {% if file.FileType == VerilogIncludeFile %}
 add_files "{{file.Path|replace('\\', '/')}}"
 {% elif file.FileType == SystemVerilogSourceFile %}

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/resources/templates/vivado/run.tcl.j2

@@ -35,8 +35,21 @@ switch $step {
 
 }
 
-set runs [list [current_run -synthesis] [current_run -implementation]]
-launch_runs [current_run] {*}[split $launch_args]
+if {$step == "lint"} {
+    set runs [list [current_run -synthesis]]
+    synth_design -top [get_property TOP [current_fileset]] -part [get_property PART [current_project]] -lint
+    exit
+} elseif {$step == "elaborate"} {
+    set runs [list [current_run -synthesis]]
+    synth_design -rtl -rtl_skip_mlo
+    exit
+} elseif {$step == "synthesis"} {
+    set runs [list [current_run -synthesis]]
+    launch_runs [current_run -synthesis]
+} else {
+    set runs [list [current_run -synthesis] [current_run -implementation]]
+    launch_runs [current_run] {*}[split $launch_args]
+}
 
 # wait_on_run renamed to wait_on_runs from Vivado 2022.1
 if {[package vsatisfies 1.[version -s] 1.2022.1]} {

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/resources/templates/xsim/Makefile.j2

@@ -19,7 +19,7 @@ simulate: elaborate
 
 
 gui: elaborate
-	$(XSIM) $(XSIM_FLAGS) $(TOPLEVELS)
+	$(XSIM) $(XSIM_FLAGS) $(TOPLEVELS) -gui
 
 
 elaborate: compile

simplhdl-0.3.0/src/simplhdl/run.py

@@ -0,0 +1,51 @@
+from pprint import pprint
+from simplhdl.simplhdl import Simplhdl
+from simplhdl.flow import FlowBase, FlowFactory, FlowError
+from simplhdl.utils import chdir
+
+
+@FlowFactory.register('run')
+class Run(FlowBase):
+
+    @classmethod
+    def parse_args(self, subparsers) -> None:
+        parser = subparsers.add_parser('run', help='Run project targets')
+        parser.add_argument(
+            '-l',
+            '--list',
+            nargs='?',
+            const='text',
+            choices=['text', 'json'],
+            help="List project targets"
+        )
+        parser.add_argument(
+            '-t',
+            '--target',
+            help="Project target to run"
+        )
+
+    def run(self) -> None:
+        if self.args.list:
+            self._show_list(self.args.list)
+        else:
+            self._run_target()
+
+    def _show_list(self, format) -> None:
+        if format == 'json':
+            targets = list(self.project._targets.keys())
+            pprint(targets)
+        else:
+            print("TARGETS:")
+            for target in self.project._targets.keys():
+                print(f"  - {target}")
+
+    def _run_target(self) -> None:
+        if self.args.target:
+            target = self.project.GetTarget(self.args.target)
+        else:
+            target = self.project.DefaultTarget
+        if target.args.flow == 'run':
+            raise FlowError("Target flow can't be 'run'")
+        with chdir(target.cwd):
+            simplhdl = Simplhdl(target.args)
+            simplhdl.run()

{simplhdl-0.2.2 → simplhdl-0.3.0}/src/simplhdl/utils.py

@@ -140,3 +140,13 @@ def lock(directory: Path) -> Generator[Path, None, None]:
         yield directory
     finally:
         directory.rmdir()
+
+
+@contextmanager
+def chdir(directory: Path) -> Generator[Path, None, None]:
+    old = Path.cwd()
+    os.chdir(directory)
+    try:
+        yield directory
+    finally:
+        os.chdir(old)

simplhdl-0.2.2/examples/hdl/adder/sim/testbench.yml

@@ -1,10 +0,0 @@
-#%SimplAPI=1.0
-
-library: work
-top: testbench
-
-dependencies:
-  - ../adder.yml
-
-files:
-  - testbench.sv

simplhdl-0.2.2/src/simplhdl/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.2.2"