openflow: add configure.py

A class to configure the OCI engine, containers and tool names.

Author: rodrigomelo9

README.md

@@ -13,3 +13,33 @@ Currently, it is based on `GHDL`, `Yosys`, `ghdl-yosys-plugin`, `nextpnr`,
 
 > **NOTE:** it started as part of [PyFPGA](https://github.com/PyFPGA/pyfpga)
 > and will be used to solves the `openflow` **tool**.
+
+## Installation
+
+Openflow requires Python `>=3.6`. For now, it's only available as a git repository
+hosted on GitHub. It can be installed with pip:
+
+```
+pip install 'git+https://github.com/PyFPGA/pyfpga#egg=pyfpga'
+```
+
+> On GNU/Linux, installing pip packages on the system requires `sudo`.
+> Alternatively, use `--local` for installing PyFPGA in your HOME.
+
+You can get a copy of the repository either through git clone or downloading a
+tarball/zipfile:
+
+```
+git clone https://github.com/PyFPGA/openflow.git
+cd openflow
+```
+
+Then, use pip from the root of the repo:
+
+```
+pip install -e .
+```
+
+> With `-e` (`--editable`) your application is installed into site-packages via
+> a kind of symlink. That allows pulling changes through git or changing the
+> branch, without the need to reinstall the package.

openflow/__init__.py

@@ -3,3 +3,4 @@
 __version__ = '0.1.0'
 
 from openflow.openflow import Openflow
+from openflow.configure import ConfigureTools

openflow/configure.py

@@ -0,0 +1,106 @@
+#
+# Copyright (C) 2020-2021 Rodrigo A. Melo
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+"""openflow.configure
+
+A Class to configure the OCI engine, the containers and the name of the
+underlying FOSS tools.
+"""
+
+
+import os
+from yaml import safe_load, dump
+
+
+_DEFAULTS = {
+    'ecppack': 'hdlc/prjtrellis',
+    'ghdl': 'hdlc/ghdl:yosys',
+    'icepack': 'hdlc/icestorm',
+    'iceprog': '--device /dev/bus/usb hdlc/icestorm',
+    'icetime': 'hdlc/icestorm',
+    'nextpnr-ecp5': 'hdlc/nextpnr:ecp5',
+    'nextpnr-ice40': 'hdlc/nextpnr:ice40',
+    'openocd': '--device /dev/bus/usb hdlc/prog',
+    'yosys': 'hdlc/ghdl:yosys',
+}
+
+
+class ConfigureTools:
+    """Configure Tools."""
+
+    def __init__(self, filename=None):
+        """Class constructor."""
+        self.configs = {}
+        if filename is not None:
+            with open(filename, 'r') as file:
+                self.configs = safe_load(file)
+        else:
+            self.configs['engine'] = 'docker'
+            self.configs['volumes'] = ['$HOME:$HOME']
+            self.configs['work'] = '$PWD'
+            self.configs['containers'] = {}
+            self.configs['names'] = {}
+            for key, value in _DEFAULTS.items():
+                self.configs['containers'][key] = value
+                self.configs['names'][key] = key
+
+    def get_command(self, tool):
+        """Get the command-line needed to run a tool."""
+        oci = ''
+        container = ''
+        name = self.configs['names'][tool]
+        if self.configs['engine'] is not None:
+            oci = '{} run --rm {} {}'.format(
+                self.configs['engine'],
+                '-v ' + ('-v ').join(self.configs['volumes']),
+                '-w ' + self.configs['work']
+            )
+            container = self.configs['containers'][tool]
+            return '{} {} {}'.format(oci, container, name)
+        return name
+
+    def get_tools(self):
+        """Returns the list of configured tools."""
+        return sorted(list(self.configs['names'].keys()))
+
+    def dump(self):
+        """Dumps the configuration in YAML format (debug purpouses)."""
+        return dump(self.configs)
+
+    def set_engine(self, engine):
+        """Set the OCI engine."""
+        self.configs['engine'] = engine
+
+    def unset_engine(self):
+        """Disable the OCI engine. """
+        self.configs['engine'] = None
+
+    def set_volumes(self, volumes):
+        """Set the volumes of the OCI engine."""
+        self.configs['volumes'] = volumes
+
+    def set_work(self, work):
+        """Set the work of the OCI engine."""
+        self.configs['work'] = work
+
+    def set_container(self, tool, container):
+        """Set the container of the specified tool."""
+        self.configs['containers'][tool] = container
+
+    def set_name(self, tool, name):
+        """Set the name of the specified tool."""
+        self.configs['names'][tool] = name

openflow/helpers/configure.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2021 Rodrigo A. Melo
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+"""
+A CLI to get the full OCI command for the specified tool.
+"""
+
+import argparse
+
+from openflow import __version__ as version
+from openflow.configure import ConfigureTools
+
+
+def main():
+    """Solves the main functionality of this helper."""
+
+    cfg = ConfigureTools()
+
+    # Parsing the command-line.
+
+    parser = argparse.ArgumentParser(
+        description=__doc__,
+        formatter_class=argparse.RawDescriptionHelpFormatter
+    )
+
+    parser.add_argument(
+        '-v', '--version',
+        action='version',
+        version='v{}'.format(version)
+    )
+
+    parser.add_argument(
+        'tool',
+        metavar='TOOL',
+        choices=cfg.get_tools(),
+        help=', '.join(cfg.get_tools())
+    )
+
+    args = parser.parse_args()
+
+    # Solving the functionality
+
+    print(cfg.get_command(args.tool))
+
+
+if __name__ == "__main__":
+    main()

setup.py

@@ -20,7 +20,8 @@
         'console_scripts': [
             'openflow_syn = openflow.helpers.synthesis:main',
             'openflow_imp = openflow.helpers.implementation:main',
-            'openflow_bit = openflow.helpers.bitstream:main'
+            'openflow_bit = openflow.helpers.bitstream:main',
+            'openflow_cfg = openflow.helpers.configure:main'
         ],
     },
     classifiers=[