MLE additions and changes

.gitignore

@@ -3,4 +3,7 @@
 *.pyc
 *.vvp
 *.kate-swp
-
+python/xfcp.egg-info
+python/build/
+python/venv/
+python/.eggs/

python/Makefile

@@ -0,0 +1,37 @@
+MKFILE_DIR := $(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
+VENVDIR = venv
+VENVACTIVATE = $(VENVDIR)/bin/activate
+XFCP_DIR = $(MKFILE_DIR)/
+PYTHON_VERSION=$(shell python3 -c "import sys; v = list(sys.version_info[:2]); print(f'{int(v[0])}.{int(v[1])}')")
+ifeq ($(PYTHON_VERSION), 3.6)
+$(info Python Version supported)
+else ifeq ($(PYTHON_VERSION), 3.10)
+$(info Python Version supported)
+else
+$(error Python Version not supported, the supported versions are 3.6 and 3.10)
+endif
+
+.PHONY: xfcp
+
+venv: $(VENVACTIVATE)
+
+xfcp: venv
+	. $(VENVACTIVATE) && \
+	if [ $(PYTHON_VERSION) = "3.6" ]; then \
+		python setup.py install; \
+	else \
+		pip install $(XFCP_DIR); \
+	fi \
+
+$(VENVACTIVATE): requirements.txt
+	test -d $(VENVDIR) || python3 -m venv $(VENVDIR) --copies
+	. $(VENVACTIVATE) && \
+	pip3 install wheel && \
+	pip3 install -r requirements.txt && \
+	touch $(VENVACTIVATE)
+
+clean:
+	rm -rf __pycache__
+
+mrproper: clean
+	rm -rf $(VENVDIR)

python/pyproject.toml

@@ -0,0 +1,39 @@
+##Copyright (c) 2023 Jakob Arndt Missing Link Electronics, Inc.
+##
+##Permission is hereby granted, free of charge, to any person obtaining a copy
+##of this software and associated documentation files (the "Software"), to deal
+##in the Software without restriction, including without limitation the rights
+##to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+##copies of the Software, and to permit persons to whom the Software is
+##furnished to do so, subject to the following conditions:
+##
+##The above copyright notice and this permission notice shall be included in
+##all copies or substantial portions of the Software.
+##
+##THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+##IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY
+##FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+##AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+##LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+##OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+##THE SOFTWARE.
+
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xfcp"
+authors = [{name="Alex Forencich", email="jforenci@eng.ucsd.edu"}]
+description="This python package enables the use of xfcp as a library for your python implementation."
+version = "1.0"
+requires-python = ">=3.6"
+dependencies = [
+    "pyserial"
+]
+
+[tool.setuptools]
+packages = ['xfcp']
+
+[tool.setuptools.package-dir]
+"xfcp" = "xfcp"

python/requirements.txt

@@ -0,0 +1 @@
+pyserial

python/setup.py

@@ -0,0 +1,38 @@
+##Copyright (c) 2023 Jakob Arndt Missing Link Electronics, Inc.
+##
+##Permission is hereby granted, free of charge, to any person obtaining a copy
+##of this software and associated documentation files (the "Software"), to deal
+##in the Software without restriction, including without limitation the rights
+##to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+##copies of the Software, and to permit persons to whom the Software is
+##furnished to do so, subject to the following conditions:
+##
+##The above copyright notice and this permission notice shall be included in
+##all copies or substantial portions of the Software.
+##
+##THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+##IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY
+##FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+##AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+##LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+##OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+##THE SOFTWARE.
+
+from setuptools import setup
+
+setup(
+    name="xfcp",
+    version="1.0.0",
+    description="This python package enables you to control the NPAP Test FPGA",
+    author="Alex Forencich",
+    author_email="jforenci@eng.ucsd.edu",
+    packages=[
+        'xfcp'],
+    package_dir={
+        "xfcp": "xfcp"
+    },
+    setup_requires=['setuptools_scm'],
+    install_requires=[
+        'pyserial',
+    ]
+)

python/xfcp/interface.py

@@ -108,12 +108,20 @@ def get_root(self):
 
 
 class SerialInterface(Interface):
-    def __init__(self, port='/dev/ttyUSB0', baud=115200, timeout=10):
+    def __init__(self, port='/dev/ttyUSB0', baud=115200, timeout=10, driver=None):
+        """
+        driver is expected to be a SerialDriver class from the labgrid module
+        """
         super().__init__()
 
         self.port = port
         self.baud = baud
-        self.serial_port = serial.Serial(port, baud, timeout=timeout)
+
+        # if labgrid driver is given, use labgrid driver
+        if driver is None:
+            self.serial_port = serial.Serial(port, baud, timeout=timeout)
+        else:
+            self.serial_port = driver.serial
 
     @property
     def timeout(self):