SimplHDL 0.3.0__tar.gz → 0.5.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: SimplHDL
-Version: 0.3.0
+Version: 0.5.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>
@@ -37,6 +37,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent

{simplhdl-0.3.0 → simplhdl-0.5.0}/pyproject.toml

@@ -43,6 +43,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: SimplHDL
-Version: 0.3.0
+Version: 0.5.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>
@@ -37,6 +37,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent

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

@@ -103,12 +103,16 @@ 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
 src/simplhdl/flows/modelsim/modelsimflow.py
 src/simplhdl/flows/quartusdse/__init__.py
 src/simplhdl/flows/quartusdse/quartusdseflow.py
+src/simplhdl/flows/quartusexport/__init__.py
+src/simplhdl/flows/quartusexport/quartusexportflow.py
 src/simplhdl/flows/questasim/__init__.py
 src/simplhdl/flows/questasim/questasimflow.py
 src/simplhdl/flows/rivierapro/__init__.py

simplhdl-0.5.0/src/simplhdl/__init__.py

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

{simplhdl-0.3.0 → simplhdl-0.5.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.5.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.5.0/src/simplhdl/flows/quartusexport/quartusexportflow.py

@@ -0,0 +1,157 @@
+import shutil
+import logging
+import zipfile
+
+from argparse import Namespace
+from pathlib import Path
+
+from simplhdl.flow import FlowFactory, FlowTools
+from simplhdl.flows.implementationflow import ImplementationFlow
+from simplhdl.flows.quartusflow import QuartusFlow
+from simplhdl.resources.templates import quartus as templates
+from simplhdl.flows.encrypt.encryptflow import encrypt
+from simplhdl.pyedaa.project import Project
+from simplhdl.pyedaa.attributes import UsedIn
+from simplhdl.pyedaa import (
+    File,
+    HDLSearchPath,
+    HDLIncludeFile,
+    HDLSourceFile,
+    VerilogIncludeFile,
+    VerilogSourceFile,
+    SystemVerilogSourceFile,
+    VHDLSourceFile,
+    ConstraintFile,
+    QuartusQIPSpecificationFile,
+    QuartusIPSpecificationFile,
+    SettingFile
+)
+
+logger = logging.getLogger(__name__)
+
+
+@FlowFactory.register('quartus-export')
+class QuartusExportFlow(ImplementationFlow):
+
+    @classmethod
+    def parse_args(self, subparsers) -> None:
+        parser = subparsers.add_parser('quartus-export', help='Export Quartus project')
+        parser.add_argument(
+            '--encrypt',
+            action='store_true',
+            help="Encrypt HDL source files"
+        )
+        parser.add_argument(
+            '-o',
+            '--output',
+            action='store',
+            metavar='FILE',
+            dest='archivefile',
+            type=Path,
+            help="Output zip file"
+        )
+
+    def __init__(self, name, args: Namespace, project: Project, builddir: Path):
+        super().__init__(name, args, project, builddir)
+        self.vendors = ['mentor', 'synopsys']
+        self.templates = templates
+        self.tools.add(FlowTools.QUARTUS)
+
+    def copy_files(self):
+        seen = dict()
+        files = [f for f in self.project.DefaultDesign.Files() if 'implementation' in f[UsedIn]]
+        for file in files:
+            fileid = str(file.Path.resolve())
+            if fileid in seen:
+                file._path = seen.get(fileid)._path
+                continue
+            elif isinstance(file, SettingFile):
+                continue
+            elif isinstance(file, (ConstraintFile, QuartusQIPSpecificationFile)):
+                dest = self.builddir.joinpath('constraints', file.Path.name)
+                dest.parent.mkdir(parents=True, exist_ok=True)
+                shutil.copyfile(file.Path, dest)
+            elif isinstance(file, (HDLSearchPath, QuartusIPSpecificationFile)):
+                dest = file.Path
+            elif isinstance(file, (HDLSourceFile, HDLIncludeFile)):
+                if isinstance(file, HDLSourceFile):
+                    dest = self.builddir.joinpath('rtl', file.Path.name)
+                else:
+                    dest = self.builddir.joinpath('rtl', 'include', file.Path.name)
+                dest.parent.mkdir(parents=True, exist_ok=True)
+                if self.args.encrypt:
+                    encrypt(file.Path, dest, language=get_language(file), vendors=self.vendors)
+                else:
+                    shutil.copyfile(file.Path, dest)
+            else:
+                dest = self.builddir.joinpath('misc', file.Path.name)
+                dest.parent.mkdir(parents=True, exist_ok=True)
+                shutil.copyfile(file.Path, dest)
+                file._path = dest.absolute().relative_to(self.builddir.absolute())
+            # Convert to relative path
+            file._path = dest.absolute().relative_to(self.builddir.absolute())
+            seen[fileid] = file
+
+    def create_project(self) -> None:
+        args = Namespace(step='project', archive=False, gui=False)
+        quartus = QuartusFlow('quartus', args, self.project, self.builddir)
+        quartus.run()
+
+    def archive_project(self) -> None:
+        if self.args.archivefile:
+            archive(self.builddir, self.args.archivefile)
+        else:
+            output = self.builddir.parrent.joinpath(self.project.Name).with_suffix('.zip')
+            archive(self.builddir, output)
+            shutil.move(output, self.builddir)
+
+    def run(self) -> None:
+        self.copy_files()
+        self.create_project()
+        self.archive_project()
+
+    def is_tool_setup(self) -> None:
+        exit: bool = False
+        if shutil.which('quartus_sh') is None:
+            logger.error('quartus_sh: not found in PATH')
+            exit = True
+        if shutil.which('quartus') is None:
+            logger.error('quartus: not found in PATH')
+            exit = True
+        if exit:
+            raise FileNotFoundError("Quartus is not setup correctly")
+
+
+def get_language(file: File) -> str:
+    fileMap = {
+        SystemVerilogSourceFile: 'systemverilog',
+        VerilogSourceFile: 'verilog',
+        VerilogIncludeFile: 'systemverilog',
+        VHDLSourceFile: 'vhdl'
+    }
+    return fileMap[file.FileType]
+
+
+def archive(directory: Path, destination: Path) -> Path:
+    """
+    Recursively zip all contents of the given folder into a zip file.
+    The zip archive will contain a top-level folder with the same name
+    as the zip file (excluding the extension).
+
+    Parameters:
+        directory (Path): The folder whose contents will be zipped.
+        destination (Path): The path to the resulting zip file.
+                           Its stem will be used as the top-level folder name.
+
+    Returns:
+        Path: The path to the created zip archive.
+    """
+    top_folder = destination.stem  # top folder inside the archive
+    with zipfile.ZipFile(destination, 'w', zipfile.ZIP_DEFLATED) as zipf:
+        # Walk through all files in the directory
+        for file in directory.rglob('*'):
+            if file.is_file():
+                # Place each file under the top_folder
+                arcname = Path(top_folder) / file.relative_to(directory)
+                zipf.write(file, arcname=arcname)
+    return destination

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

@@ -18,7 +18,7 @@ from ..pyedaa import (QuartusIPSpecificationFile, VerilogIncludeFile, VerilogSou
                       SystemVerilogSourceFile, VHDLSourceFile, ConstraintFile,
                       EDIFNetlistFile, NetlistFile, SettingFile, QuartusSignalTapFile,
                       QuartusIniFile, QuartusQIPSpecificationFile, QuartusQSYSSpecificationFile,
-                      HDLSearchPath, VerilogIncludeSearchPath)
+                      HDLSearchPath, VerilogIncludeSearchPath, MemoryInitFile)
 from ..pyedaa.project import Project
 from ..pyedaa.attributes import UsedIn
 
@@ -62,10 +62,11 @@ class QuartusFlow(ImplementationFlow):
     def run(self) -> None:
         if self.args.archive:
             self.archive()
-        self.validate()
-        self.configure()
-        self.generate()
-        self.execute(self.args.step)
+        else:
+            self.validate()
+            self.configure()
+            self.generate()
+            self.execute(self.args.step)
 
     def archive(self) -> None:
         name = self.project.Name
@@ -79,7 +80,6 @@ class QuartusFlow(ImplementationFlow):
             raise Exception("Unknown value for argument --archive: {self.args.archive}")
         command = f"quartus_sh --archive -use_file_set {fileset} -revision {name} -no_discover -output {name}.qar {name}"  # noqa
         sh(command.split(), output=True, cwd=self.builddir)
-        raise SystemExit
 
     def validate(self):
         if self.project.DefaultDesign.DefaultFileSet.TopLevel is None:
@@ -113,6 +113,7 @@ class QuartusFlow(ImplementationFlow):
             QuartusQIPSpecificationFile=QuartusQIPSpecificationFile,
             QuartusQSYSSpecificationFile=QuartusQSYSSpecificationFile,
             QuartusIniFile=QuartusIniFile,
+            MemoryInitFile=MemoryInitFile,
             project=self.project,
             UsedIn=UsedIn)
         template = environment.get_template('run.tcl.j2')