SimplHDL 0.1.1__tar.gz → 0.2.0__tar.gz

{simplhdl-0.1.1 → simplhdl-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: SimplHDL
-Version: 0.1.1
+Version: 0.2.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.1.1 → simplhdl-0.2.0}/src/SimplHDL.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: SimplHDL
-Version: 0.1.1
+Version: 0.2.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.1.1 → simplhdl-0.2.0}/src/SimplHDL.egg-info/SOURCES.txt

@@ -99,12 +99,13 @@ src/simplhdl/tools.py
 src/simplhdl/utils.py
 src/simplhdl/flows/__init__.py
 src/simplhdl/flows/implementationflow.py
-src/simplhdl/flows/modelsimflow.py
 src/simplhdl/flows/quartusflow.py
 src/simplhdl/flows/simulationflow.py
 src/simplhdl/flows/vivadoflow.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/questasim/__init__.py
@@ -138,18 +139,23 @@ src/simplhdl/resources/__init__.py
 src/simplhdl/resources/templates/__init__.py
 src/simplhdl/resources/templates/flake8/__init__.py
 src/simplhdl/resources/templates/flake8/setup.cfg.j2
+src/simplhdl/resources/templates/modelsim/Makefile.j2
+src/simplhdl/resources/templates/modelsim/__init__.py
+src/simplhdl/resources/templates/modelsim/cocotb.mk.j2
+src/simplhdl/resources/templates/modelsim/dependencies.mk.j2
+src/simplhdl/resources/templates/modelsim/files.j2
+src/simplhdl/resources/templates/modelsim/fileset.j2
+src/simplhdl/resources/templates/modelsim/modelsim.tcl.j2
+src/simplhdl/resources/templates/modelsim/project.mk.j2
+src/simplhdl/resources/templates/modelsim/run.do.j2
 src/simplhdl/resources/templates/quartus/__init__.py
 src/simplhdl/resources/templates/quartus/project.tcl.j2
 src/simplhdl/resources/templates/quartus/run.tcl.j2
-src/simplhdl/resources/templates/questasim/Makefile.j2
 src/simplhdl/resources/templates/questasim/__init__.py
-src/simplhdl/resources/templates/questasim/cocotb.mk.j2
-src/simplhdl/resources/templates/questasim/dependencies.mk.j2
-src/simplhdl/resources/templates/questasim/files.j2
-src/simplhdl/resources/templates/questasim/fileset.j2
-src/simplhdl/resources/templates/questasim/gui.do.j2
-src/simplhdl/resources/templates/questasim/project.mk.j2
-src/simplhdl/resources/templates/questasim/run.do.j2
+src/simplhdl/resources/templates/questasim/modelsim.tcl.j2
+src/simplhdl/resources/templates/questasim/project.qrun.j2
+src/simplhdl/resources/templates/questasim/visualizer.tcl.j2
+src/simplhdl/resources/templates/questasim/vsim-run.do.j2
 src/simplhdl/resources/templates/rivierapro/Makefile.j2
 src/simplhdl/resources/templates/rivierapro/__init__.py
 src/simplhdl/resources/templates/rivierapro/cocotb.mk.j2

simplhdl-0.2.0/src/simplhdl/__init__.py

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

{simplhdl-0.1.1 → simplhdl-0.2.0}/src/simplhdl/cocotb.py

@@ -1,8 +1,9 @@
 import logging
 import re
+import os
 
 from pathlib import Path
-from typing import Optional
+from typing import Optional, Dict
 
 from .utils import sh
 from .pyedaa.project import Project
@@ -28,7 +29,16 @@ class Cocotb:
             raise FileNotFoundError(f"{path}: not found")
         return path
 
+    def libpython(self) -> str:
+        output = sh(['cocotb-config', '--libpython'])
+        path = Path(output)
+        if not path.exists():
+            raise FileNotFoundError(f"{path}: not found")
+        return path
+
     def module(self) -> Optional[str]:
+        if not self.enabled:
+            return None
         set_ = set()
         try:
             modules = self.project.DefaultDesign._topLevel.split()
@@ -40,7 +50,7 @@ class Cocotb:
                 # TODO: What if more than one module match?
                 set_.add(module)
         if not set_:
-            return None
+            raise FlowError('CocoTB module not specified')
         elif len(set_) == 1:
             return next(iter(set_))
         else:
@@ -115,3 +125,29 @@ class Cocotb:
     def pythonpath(self) -> str:
         directories = {str(f.Path.parent.absolute()) for f in self.files()}
         return ':'.join(directories)
+
+    def args(self) -> str:
+        if self.duttype == VHDLSourceFile:
+            lib_name_path = self.lib_name_path("questa", "fli")
+            return f'-foreign "cocotb_init {lib_name_path}"'
+        elif self.duttype == VerilogSourceFile:
+            lib_name_path = self.lib_name_path("questa", "vpi")
+            return f'-pli {lib_name_path}'
+
+    def env(self) -> Dict[str, str]:
+        e = os.environ.copy()
+        e['MODULE'] = self.top
+        e['TOPLEVEL'] = self.dut
+        e['PYTHONPYCACHEPREFIX'] = './pycache'
+        e['LIBPYTHON_LOC'] = self.libpython()
+        if self.duttype == VHDLSourceFile:
+            lib_name_path = self.lib_name_path("questa", "vpi")
+            e['GPI_EXTRA'] = f"{lib_name_path}:cocotbvpi_entry_point"
+        elif self.duttype == VerilogSourceFile:
+            lib_name_path = self.lib_name_path("questa", "fli")
+            e['GPI_EXTRA'] = f"{lib_name_path}:cocotbfli_entry_point"
+        if 'PYTHONPATH' in e:
+            e['PYTHONPATH'] = self.pythonpath + os.pathsep + e.get('PYTHONPATH')
+        else:
+            e['PYTHONPATH'] = self.pythonpath
+        return e

simplhdl-0.1.1/src/simplhdl/flows/questasim/questasimflow.py → simplhdl-0.2.0/src/simplhdl/flows/modelsim/modelsimflow.py

@@ -10,18 +10,25 @@ from simplhdl.pyedaa.project import Project
 from simplhdl.pyedaa.fileset import FileSet
 from simplhdl.utils import sh, escape
 from simplhdl.flow import FlowFactory, FlowTools
-from simplhdl.resources.templates import questasim as questasimtemplates
+from simplhdl.resources.templates import modelsim as modelsimtemplates
 from simplhdl.flows.simulationflow import SimulationFlow
 
 logger = logging.getLogger(__name__)
 
 
-@FlowFactory.register('questasim')
-class QuestaSimFlow(SimulationFlow):
+class Flag(list):
+
+    def add(self, item):
+        if item not in self:
+            self.append(item)
+
+
+@FlowFactory.register('modelsim')
+class ModelSimFlow(SimulationFlow):
 
     @classmethod
     def parse_args(self, subparsers) -> None:
-        parser = subparsers.add_parser('questasim', help='QuestaSim HDL Simulation Flow')
+        parser = subparsers.add_parser('modelsim', help='ModelSim HDL Simulation Flow')
         parser.add_argument(
             '--step',
             action='store',
@@ -32,15 +39,10 @@ class QuestaSimFlow(SimulationFlow):
         parser.add_argument(
             '-w',
             '--wavedump',
-            action='store_true',
-            help="Dump waveforms"
-        )
-        parser.add_argument(
-            '--waveformat',
-            action='store',
+            nargs='?',
+            const='wlf',
             choices=['wlf', 'vcd', 'evcd'],
-            default='wlf',
-            help="Wave file format"
+            help="Dump waveforms using wlf, vcd or evcd format"
         )
         parser.add_argument(
             '--debug',
@@ -50,42 +52,42 @@ class QuestaSimFlow(SimulationFlow):
         parser.add_argument(
             '--gui',
             action='store_true',
-            help="Open project in QuestaSim GUI"
+            help="Open project in ModelSim GUI"
         )
         parser.add_argument(
             '--vsim-args',
             default='',
             action='store',
             metavar='ARGS',
-            help="Extra arguments for QuestaSim vsim command"
+            help="Extra arguments for ModelSim vsim command"
         )
         parser.add_argument(
             '--vopt-args',
             default='',
             action='store',
             metavar='ARGS',
-            help="Extra arguments for QuestaSim vopt command"
+            help="Extra arguments for ModelSim vopt command"
         )
         parser.add_argument(
             '--vmap-args',
             default='',
             action='store',
             metavar='ARGS',
-            help="Extra arguments for QuestaSim vmap command"
+            help="Extra arguments for ModelSim vmap command"
         )
         parser.add_argument(
             '--vcom-args',
             default='',
             action='store',
             metavar='ARGS',
-            help="Extra arguments for QuestaSim vcom command"
+            help="Extra arguments for ModelSim vcom command"
         )
         parser.add_argument(
             '--vlog-args',
             default='',
             action='store',
             metavar='ARGS',
-            help="Extra arguments for QuestaSim vlog command"
+            help="Extra arguments for ModelSim vlog command"
         )
         parser.add_argument(
             '--seed',
@@ -109,13 +111,13 @@ class QuestaSimFlow(SimulationFlow):
             '--timescale',
             default='1ns/1ps',
             action='store',
-            help="Set the simulator timescale for QuestaSim"
+            help="Set the simulator timescale for ModelSim"
         )
 
     def __init__(self, name, args: Namespace, project: Project, builddir: Path):
         super().__init__(name, args, project, builddir)
-        self.templates = questasimtemplates
-        self.tools.add(FlowTools.QUESTASIM)
+        self.templates = modelsimtemplates
+        self.tools.add(FlowTools.MODELSIM)
 
     def get_globals(self) -> Dict[str, Any]:
         globals = super().get_globals()
@@ -124,14 +126,13 @@ class QuestaSimFlow(SimulationFlow):
         globals['vopt_args'] = self.vopt_args()
         globals['vsim_args'] = self.vsim_args()
         globals['wavedump'] = self.args.wavedump
-        globals['waveformat'] = self.args.waveformat
         return globals
 
     def get_project_templates(self, environment) -> List[Template]:
         return [
             environment.get_template('Makefile.j2'),
             environment.get_template('project.mk.j2'),
-            environment.get_template('gui.do.j2'),
+            environment.get_template('modelsim.tcl.j2'),
             environment.get_template('run.do.j2')
         ]
 
@@ -156,7 +157,7 @@ class QuestaSimFlow(SimulationFlow):
         return f"-2008 -work {library.Name}"
 
     def vlog_args(self) -> str:
-        args = set()
+        args = Flag()
         if self.args.verbose == 0:
             args.add('-quiet')
         for name in self.get_libraries().keys():
@@ -166,17 +167,17 @@ class QuestaSimFlow(SimulationFlow):
         return ' '.join(list(args) + [self.args.vlog_args])
 
     def vcom_args(self) -> str:
-        args = set()
+        args = Flag()
         if self.args.verbose == 0:
             args.add('-quiet')
         return ' '.join(list(args) + [self.args.vcom_args])
 
     def vmap_args(self) -> str:
-        args = set()
+        args = Flag()
         return ' '.join(list(args) + [self.args.vmap_args])
 
     def vopt_args(self) -> str:
-        args = set()
+        args = Flag()
         if self.args.verbose == 0:
             args.add('-quiet')
         for name in self.get_libraries().keys():
@@ -196,7 +197,7 @@ class QuestaSimFlow(SimulationFlow):
         return ' '.join(list(args) + [self.args.vopt_args])
 
     def vsim_args(self) -> str:
-        args = set()
+        args = Flag()
         args.add(f"-sv_seed {self.args.seed}")
         timescale = self.timescale()
         if timescale:
@@ -273,17 +274,17 @@ class QuestaSimFlow(SimulationFlow):
                 shutil.which('vcom') is None or
                 shutil.which('vlib') is None or
                 shutil.which('vmap') is None):
-            raise Exception("QuestaSim is not setup correctly")
-        # NOTE: If questasim's bin directory is appended to the PATH variable,
+            raise Exception("ModelSim is not setup correctly")
+        # NOTE: If modelsim's bin directory is appended to the PATH variable,
         #       the vdir command is found in /bin/vdir which is not the
-        #       QuestaSim vdir command
+        #       ModelSim vdir command
         vdir = Path(shutil.which('vdir'))
         vsim = Path(shutil.which('vsim'))
         if vdir.parent != vsim.parent:
             logger.warning(
-                "QuestaSim is not setup correctly. "
+                "ModelSim is not setup correctly. "
                 f"The 'vdir' command is pointing to {vdir}, which "
-                "is not part of the QuestaSim installation. Try to "
-                "prepend Questa to the PATH environment variable."
+                "is not part of the ModelSim installation. Try to "
+                "prepend Modelsim to the PATH environment variable."
             )
             os.environ['PATH'] = f"{vsim.parent}:{os.environ['PATH']}"

simplhdl-0.2.0/src/simplhdl/flows/questasim/questasimflow.py

@@ -0,0 +1,360 @@
+try:
+    from importlib.resources import files as resources_files
+except ImportError:
+    from importlib_resources import files as resources_files
+
+import os
+import re
+import logging
+import shutil
+
+from jinja2 import Environment, FileSystemLoader
+from pathlib import Path
+from typing import Any, List, Dict, Optional
+from argparse import Namespace
+from jinja2 import Template
+from simplhdl.pyedaa.project import Project
+from simplhdl.utils import sh, escape
+from simplhdl.flow import FlowFactory, FlowTools
+from simplhdl.resources.templates import questasim as questasimtemplates
+from simplhdl.flows.simulationflow import SimulationFlow, FileSetWalker
+from simplhdl.utils import generate_from_template
+
+logger = logging.getLogger(__name__)
+
+qrunfile = "project.qrun"
+
+
+class Flag(list):
+
+    def add(self, item):
+        if item not in self:
+            self.append(item)
+
+
+@FlowFactory.register('questasim')
+class QuestaSimFlow(SimulationFlow):
+
+    @classmethod
+    def parse_args(self, subparsers) -> None:
+        parser = subparsers.add_parser('questasim', help='QuestaSim HDL Simulation Flow')
+        parser.add_argument(
+            '--step',
+            action='store',
+            choices=['generate', 'compile', 'elaborate', 'simulate'],
+            default='',
+            help="flow step to run"
+        )
+        parser.add_argument(
+            '-w',
+            '--wavedump',
+            nargs='?',
+            const='wlf',
+            choices=['wlf', 'vcd', 'evcd'],
+            help="Dump waveforms using wlf, vcd or evcd format"
+        )
+        parser.add_argument(
+            '--debug',
+            action='store_true',
+            help="Enable full debug capabilities"
+        )
+        parser.add_argument(
+            '--clean',
+            action='store_true',
+            help="Clean project"
+        )
+        parser.add_argument(
+            '--gui',
+            nargs='?',
+            const=os.getenv('SIMPLHDL_QUESTASIM_GUI', 'vsim'),
+            choices=['vsim', 'visualizer'],
+            help="Open project in QuestaSim GUI using vsim or visualizer"
+        )
+        parser.add_argument(
+            '--qrun-args',
+            default='',
+            action='store',
+            metavar='ARGS',
+            help="Extra arguments for QuestaSim qrun command"
+        )
+        parser.add_argument(
+            '--vsim-args',
+            default='',
+            action='store',
+            metavar='ARGS',
+            help="Extra arguments for QuestaSim vsim command"
+        )
+        parser.add_argument(
+            '--vopt-args',
+            default='',
+            action='store',
+            metavar='ARGS',
+            help="Extra arguments for QuestaSim vopt command"
+        )
+        parser.add_argument(
+            '--vcom-args',
+            default='',
+            action='store',
+            metavar='ARGS',
+            help="Extra arguments for QuestaSim vcom command"
+        )
+        parser.add_argument(
+            '--vlog-args',
+            default='',
+            action='store',
+            metavar='ARGS',
+            help="Extra arguments for QuestaSim vlog command"
+        )
+        parser.add_argument(
+            '--seed',
+            type=int,
+            default=1,
+            action='store',
+            help="Seed to initialize random generator"
+        )
+        parser.add_argument(
+            '--random-seed',
+            action='store_true',
+            help="Generate a random seed to initialize random generator"
+        )
+        parser.add_argument(
+            '--do',
+            metavar='COMMAND',
+            action='store',
+            help="Do command to start simulation"
+        )
+        parser.add_argument(
+            '--timescale',
+            default='1ns/1ps',
+            action='store',
+            help="Set the simulator timescale for QuestaSim"
+        )
+
+    def __init__(self, name, args: Namespace, project: Project, builddir: Path):
+        super().__init__(name, args, project, builddir)
+        self.templates = questasimtemplates
+        self.tools.add(FlowTools.QUESTASIM)
+
+    def get_globals(self) -> Dict[str, Any]:
+        globals = super().get_globals()
+        globals['qrunfile'] = qrunfile
+        globals['wavedump'] = self.args.wavedump
+        globals['filesets'] = self.get_filesets()
+        globals['vlog_args'] = self.vlog_args()
+        globals['vcom_args'] = self.vcom_args()
+        globals['vopt_args'] = self.vopt_args()
+        globals['vsim_args'] = self.vsim_args()
+        globals['qrun_args'] = self.qrun_args()
+        return globals
+
+    def vlog_args(self) -> str:
+        args = Flag()
+        args.add('-sv')
+        args.add('-suppress vlog-2720')
+        for name, value in self.project.Defines.items():
+            args.add(f"+define+{name}={escape(value)}")
+        return ' '.join(list(args) + [self.args.vlog_args])
+
+    def vcom_args(self) -> str:
+        args = Flag()
+        args.add('-2008')
+        return ' '.join(list(args) + [self.args.vcom_args])
+
+    def vopt_args(self) -> str:
+        args = Flag()
+        if self.args.timescale:
+            args.add(f"-timescale {self.args.timescale}")
+        for name, value in self.project.Generics.items():
+            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:
+            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:
+            args.add('+acc=npr')
+        return ' '.join(list(args) + [self.args.vopt_args])
+
+    def vsim_args(self) -> str:
+        args = Flag()
+        args.add(f"-sv_seed {self.args.seed}")
+        timescale = self.timescale()
+        if timescale:
+            args.add(timescale)
+        if self.args.verbose == 0:
+            args.add('-quiet')
+        for name, value in self.project.PlusArgs.items():
+            args.add(f"+{name}={escape(value)}")
+        if self.cocotb.enabled:
+            args.add(self.cocotb.args())
+        if self.args.gui:
+            args.add('-onfinish final')
+        else:
+            args.add('-onfinish exit')
+        return ' '.join(list(args) + [self.args.vsim_args])
+
+    def qrun_args(self) -> str:
+        args = Flag()
+        for top in self.cocotb.toplevels.split():
+            if self.args.verbose > 0:
+                args.add("-verbose")
+            if self.version > 2023.0:
+                args.add("-defaultHDLCompiler=vcom")
+                args.add("-noautoorder")
+            if self.is_uvm():
+                args.add("-uvm")
+            args.add(f"-top {top}")
+        return list(args) + [self.args.qrun_args]
+
+    def execute(self, step: str) -> None:
+        """
+        Execute the QuestaSim simulation flow.
+
+        Parameters
+        ----------
+        step : str
+            The step to execute. If not provided, the flow will execute
+            the 'simulate' step.
+
+        Returns
+        -------
+        None
+        """
+        if self.args.clean:
+            sh(['qrun', '-clean'], cwd=self.builddir, output=True)
+            return
+
+        self.run_hooks('pre')
+
+        if step == 'generate':
+            return
+
+        command = self.get_command(step)
+        env = self.get_environment(command)
+
+        sh(command, cwd=self.builddir, output=True, env=env)
+        if step in ['simulate', '']:
+            self.run_hooks('post')
+
+    def get_command(self, step: str) -> List[str]:
+
+        """
+        Construct the command list to run qrun based on the given step and any command line arguments.
+
+        Parameters
+        ----------
+        step : str
+            The step to run. If None or not given, the default step is used.
+
+        Returns
+        -------
+        command : List[str]
+            The command list to execute qrun with.
+        """
+        command = ['qrun', '-f', qrunfile]
+
+        if self.args.gui:
+            if self.use_visualizer():
+                command.append('-visualizer')
+            command.append('-gui')
+        elif self.args.step:
+            command.append(f'-{step}')
+
+        if self.args.do:
+            if Path(self.args.do).exists():
+                command += ['-do', str(Path(self.args.do).absolute())]
+            else:
+                command += ['-do', self.args.do]
+        elif not self.use_visualizer() and not self.args.gui:
+            command += ['-do', 'vsim-run.do']
+        return command
+
+    def get_environment(self, command: List[str]) -> Dict[str, str]:
+        """
+        Construct the environment for running qrun based on the given command and any
+        enabled cocotb features.
+
+        Parameters
+        ----------
+        command : List[str]
+            The command to run qrun with.
+
+        Returns
+        -------
+        env : Dict[str, str]
+            A dictionary of environment variables to run qrun with.
+        """
+        if self.cocotb.enabled:
+            env = self.cocotb.env()
+        else:
+            env = os.environ.copy()
+
+        # Add the command  as environment variables for use in the
+        # QuestaSim GUI and Tcl scripts
+        env['SIMPLHDL_QUESTASIM_VSIM_COMMAND'] = ' '.join(command)
+        return env
+
+    def run_hooks(self, name):
+        try:
+            for command in self.project.Hooks[name]:
+                logger.info(f"Running {name} hook: {command}")
+                sh(command.split(), cwd=self.builddir, output=True)
+        except KeyError:
+            # NOTE: Continue if no hook is registret
+            pass
+
+    def timescale(self) -> Optional[str]:
+        """
+        Sets the timescale for VHDL based on the Verilog timescale
+        resolution.
+        """
+        if self.args.timescale.endswith('ps'):
+            return "-t ps"
+        elif self.args.timescale.endswith('fs'):
+            return "-t fs"
+
+    def is_tool_setup(self) -> None:
+        if (shutil.which('qrun') is None):
+            raise Exception("QuestaSim is not setup correctly")
+        self.version = self.get_qrun_version()
+
+    def has_visualizer(self) -> bool:
+        if (shutil.which('visualizer') is None):
+            return False
+        else:
+            return True
+
+    def use_visualizer(self) -> bool:
+        if self.args.gui == 'visualizer':
+            if self.has_visualizer():
+                return True
+            else:
+                logger.warning("Visualizer is not setup correctly")
+        return False
+
+    def generate(self):
+        templatedir = resources_files(self.templates)
+        env = Environment(
+            loader=FileSystemLoader(templatedir),
+            trim_blocks=True)
+        templates: List[Template] = [
+            env.get_template(f'{qrunfile}.j2'),
+            env.get_template('vsim-run.do.j2'),
+            env.get_template('modelsim.tcl.j2'),
+            env.get_template('visualizer.tcl.j2')
+        ]
+        for template in templates:
+            generate_from_template(template, self.builddir, self.get_globals())
+
+    def get_qrun_version(self) -> float:
+        output = sh(['qrun', '-version'], self.builddir)
+        m = re.search(r'qrun\s+([\d.]+)', output)
+        return float(m.group(1))
+
+    def get_filesets(self):
+        walker = FileSetWalker()
+        filesets = list()
+        for fileset in walker.walk(self.project.DefaultDesign.DefaultFileSet, reverse=True):
+            filesets.append(fileset)
+        return filesets