SimplHDL 0.2.3__tar.gz → 0.4.0__tar.gz

{simplhdl-0.2.3 → simplhdl-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: SimplHDL
-Version: 0.2.3
+Version: 0.4.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.4.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.3 → simplhdl-0.4.0}/src/SimplHDL.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: SimplHDL
-Version: 0.2.3
+Version: 0.4.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.3 → simplhdl-0.4.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
@@ -102,6 +103,8 @@ src/simplhdl/flows/implementationflow.py
 src/simplhdl/flows/quartusflow.py
 src/simplhdl/flows/simulationflow.py
 src/simplhdl/flows/vivadoflow.py
+src/simplhdl/flows/encrypt/__init__.py
+src/simplhdl/flows/encrypt/encryptflow.py
 src/simplhdl/flows/flake8/flake8flow.py
 src/simplhdl/flows/lint/lintflow.py
 src/simplhdl/flows/modelsim/__init__.py
@@ -134,6 +137,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.4.0/src/simplhdl/__init__.py

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

{simplhdl-0.2.3 → simplhdl-0.4.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.3 → simplhdl-0.4.0}/src/simplhdl/cocotb.py

@@ -64,9 +64,12 @@ class Cocotb:
         return ' '.join(tops)
 
     def get_dut(self) -> str:
-        for top in self.project.DefaultDesign._topLevel.split():
-            if top != self.top:
-                return top
+        try:
+            for top in self.project.DefaultDesign._topLevel.split():
+                if top != self.top:
+                    return top
+        except AttributeError:
+            raise FlowError("No top levels found")
 
     def hdltype(self):  # noqa: C901
         logger.debug(f"Cocotb hdl dut '{self.dut}'")

simplhdl-0.4.0/src/simplhdl/flows/encrypt/encryptflow.py

@@ -0,0 +1,129 @@
+import shutil
+import logging
+
+from typing import List
+from argparse import Namespace
+from pathlib import Path
+
+from simplhdl.flow import FlowFactory, FlowTools, FlowError
+from simplhdl.flows.implementationflow import ImplementationFlow
+from simplhdl.utils import sh
+from simplhdl.pyedaa.project import Project
+from simplhdl.pyedaa import SystemVerilogSourceFile, VerilogSourceFile, VHDLSourceFile, VerilogIncludeFile
+
+logger = logging.getLogger(__name__)
+
+
+VENDORS = ["cadence", "mentor", "synopsys", "spyglass", "dsim", "veloce", "dcfcf"]
+
+
+@FlowFactory.register('encrypt')
+class EncryptFlow(ImplementationFlow):
+
+    @classmethod
+    def parse_args(self, subparsers) -> None:
+        parser = subparsers.add_parser('encrypt', help='Encrypt HDL source for diffent tool vendors')
+        parser.add_argument(
+            '--inplace',
+            action='store_true',
+            help="Place the encrypted file next to the source file"
+        )
+        parser.add_argument(
+            '--no-encrypt',
+            action='store_true',
+            help="Disable encryption"
+        )
+        parser.add_argument(
+            '--vendors',
+            action='store',
+            nargs='+',
+            choices=VENDORS,
+            help="Vendor list to support"
+        )
+        parser.add_argument(
+            '--outputdir',
+            type=Path,
+            dest='outdir',
+            action='store',
+            help='Output directory'
+        )
+
+    def __init__(self, name, args: Namespace, project: Project, builddir: Path):
+        super().__init__(name, args, project, builddir)
+        self.tools.add(FlowTools.QUARTUS)
+        if self.args.inplace and self.args.no_encrypt:
+            raise FlowError("Both --inplace and --no-encrypt options are enabled.")
+
+    def run(self) -> None:
+        self.configure()
+        self.execute()
+
+    def configure(self) -> None:
+        self.is_tool_setup()
+
+    def execute(self):
+        outputdir = self.args.outdir or self.builddir
+        outputdir.mkdir(parents=True, exist_ok=True)
+
+        for file in self.project.DefaultDesign.Files():
+            if file.FileType in [SystemVerilogSourceFile, VerilogIncludeFile]:
+                language = "systemverilog"
+            elif file.FileType == VerilogSourceFile:
+                language = "verilog"
+            elif file.FileType == VHDLSourceFile:
+                language = "vhdl"
+            else:
+                continue
+
+            if self.args.no_encrypt:
+                destFile = outputdir.joinpath(file.Path.name)
+            elif self.args.inplace:
+                destFile = file.Path.with_suffix(f"{file.Path.suffix}p")
+            else:
+                destFile = outputdir.joinpath(file.Path.name).with_suffix(f"{file.Path.suffix}p")
+
+            if self.args.vendors:
+                vendors = self.args.vendors
+            else:
+                vendors = VENDORS
+
+            if self.args.no_encrypt:
+                shutil.copyfile(file.Path.absolute(), destFile.absolute())
+            else:
+                encrypt(file.Path, destFile, language, vendors)
+
+    def is_tool_setup(self) -> None:
+        exit: bool = False
+        if shutil.which('encrypt_1735') is None:
+            logger.error('encrypt_1735: not found in PATH')
+            exit = True
+        if exit:
+            raise FileNotFoundError("Quartus is not setup correctly")
+
+
+def encrypt(src: Path, dst: Path, language: str, vendors: List[str]) -> Path:
+    """
+    Encrypt a HDL source file using the 'encrypt_1735' tool.
+
+    Parameters:
+        src (Path): The source file path of the HDL file to be encrypted.
+        dst (Path): The destination file path or directory for the encrypted file.
+                    If dst is a directory, the source file name is appended.
+        language (str): The language type of the HDL file (e.g., "systemverilog", "verilog", "vhdl").
+        vendors (List[str]): A list of vendor names used to set up the simulation options.
+
+    Returns:
+        Path: The absolute path to the encrypted file.
+
+    Example:
+        encrypted_path = encrypt(Path("/path/to/source.v"), Path("/path/to/output"), "verilog", ["cadence", "mentor"])
+    """
+    destFile = dst.joinpath(src.name) if dst.is_dir() else dst
+    command = [
+        "encrypt_1735", str(src.absolute()),
+        "--language", language,
+        "--quartus",
+        f"--simulation={','.join(vendors)}",
+        "-of", f"{destFile.absolute()}"
+    ]
+    sh(command, output=True)

{simplhdl-0.2.3 → simplhdl-0.4.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.3 → simplhdl-0.4.0}/src/simplhdl/flows/vivadoflow.py

@@ -31,6 +31,8 @@ class VivadoFlow(FlowBase):
             '--step',
             action='store',
             choices=[
+                'lint',
+                'elaborate',
                 'synthesis',
                 'opt',
                 'power_opt',

{simplhdl-0.2.3 → simplhdl-0.4.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.3 → simplhdl-0.4.0}/src/simplhdl/plugins.py

@@ -23,12 +23,14 @@ 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')
     import_module('simplhdl.flows.xsim.xsimflow')
     import_module('simplhdl.flows.rivierapro.rivieraproflow')
     import_module('simplhdl.flows.quartusdse.quartusdseflow')
+    import_module('simplhdl.flows.encrypt.encryptflow')
     import_module('simplhdl.flows.vsg.vsgflow')
     import_module('simplhdl.flows.verible.veribleflow')
     import_module('simplhdl.flows.lint.lintflow')

{simplhdl-0.2.3 → simplhdl-0.4.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.3 → simplhdl-0.4.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.4.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.3 → simplhdl-0.4.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.3 → simplhdl-0.4.0}/src/simplhdl/resources/templates/questasim/project.qrun.j2

@@ -1,5 +1,7 @@
 -vlog.options {{vlog_args}} -end
+-vlog.ext=+.vo
 -vcom.options {{vcom_args}} -end
+-vlog.ext=+.vho
 -vopt.options {{vopt_args}} -end
 -vsim.options {{vsim_args}} -end
 {% for arg in qrun_args %}

{simplhdl-0.2.3 → simplhdl-0.4.0}/src/simplhdl/resources/templates/vivado/run.tcl.j2

@@ -35,7 +35,15 @@ switch $step {
 
 }
 
-if {$step == "synthesis"} {
+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 {

simplhdl-0.4.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.3 → simplhdl-0.4.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.3/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.3/src/simplhdl/__init__.py

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