apio upload refactoring

FPGAwars · Mar 17, 2024 · 161f204 · 161f204
1 parent 41538ba
commit 161f204
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 21 deletions.
diff --git a/apio/commands/upgrade.py b/apio/commands/upgrade.py
@@ -19,6 +19,7 @@
 # ------------------
 CMD = "upgrade"  # -- Comand name
 
+
 @click.command(CMD, context_settings=util.context_settings())
 @click.pass_context
 def cli(ctx):

diff --git a/apio/commands/upload.py b/apio/commands/upload.py
@@ -1,25 +1,41 @@
 # -*- coding: utf-8 -*-
 # -- This file is part of the Apio project
-# -- (C) 2016-2019 FPGAwars
-# -- Author Jesús Arroyo
+# -- (C) 2016-2024 FPGAwars
+# -- Authors
+# --  * Jesús Arroyo (2016-2019)
+# --  * Juan Gonzalez (obijuan) (2019-2024)
 # -- Licence GPLv2
 """Implement the apio upload command"""
 
 import click
-
 from apio.managers.scons import SCons
 from apio.managers.drivers import Drivers
 from apio import util
 
+# ------------------
+# -- CONSTANTS
+# ------------------
+CMD = "upload"  # -- Comand name
+BOARD = "board"  # -- Option
+PROJECT_DIR = "project_dir"  # -- Option
+SERIAL_PORT = "serial_port"  # -- Option
+FTDI_ID = "ftdi_id"  # -- Option
+SRAM = "sram"  # -- Option
+FLASH = "flash"  # -- Option
+VERBOSE = "verbose"  # -- Option
+VERBOSE_YOSYS = "verbose_yosys"  # -- Option
+VERBOSE_PNR = "verbose_pnr"  # -- Option
+TOP_MODULE = "top_module"  # -- Option
+
 
 # R0913: Too many arguments (6/5)
 # pylint: disable=R0913
 # R0914: Too many local variables (16/15) (too-many-locals)
 # pylint: disable=R0914
-@click.command("upload", context_settings=util.context_settings())
+@click.command(CMD, context_settings=util.context_settings())
 @click.pass_context
 @click.option(
-    "-b", "--board", type=str, metavar="board", help="Set the board."
+    "-b", f"--{BOARD}", type=str, metavar="board", help="Set the board."
 )
 @click.option(
     "--serial-port",
@@ -30,8 +46,12 @@
 @click.option(
     "--ftdi-id", type=str, metavar="ftdi-id", help="Set the FTDI id."
 )
-@click.option("-s", "--sram", is_flag=True, help="Perform SRAM programming.")
-@click.option("-f", "--flash", is_flag=True, help="Perform FLASH programming.")
+@click.option(
+    "-s", f"--{SRAM}", is_flag=True, help="Perform SRAM programming."
+)
+@click.option(
+    "-f", f"--{FLASH}", is_flag=True, help="Perform FLASH programming."
+)
 @click.option(
     "-p",
     "--project-dir",
@@ -41,7 +61,7 @@
 )
 @click.option(
     "-v",
-    "--verbose",
+    f"--{VERBOSE}",
     is_flag=True,
     help="Show the entire output of the command.",
 )
@@ -59,21 +79,34 @@
     metavar="top_module",
     help="Set the top level module (w/o .v ending) for build.",
 )
-def cli(
-    ctx,
-    board: str,  # -- Board name
-    serial_port: str,  # -- Serial port name
-    ftdi_id: str,  # -- ftdi id
-    sram: bool,  # -- Perform SRAM programming
-    flash: bool,  # -- Perform Flash programming
-    project_dir,
-    verbose,
-    verbose_yosys,
-    verbose_pnr,
-    top_module,
-):
+def cli(ctx, **kwargs):
+    # def cli(
+    #     ctx,
+    #     board: str,  # -- Board name
+    #     serial_port: str,  # -- Serial port name
+    #     ftdi_id: str,  # -- ftdi id
+    #     sram: bool,  # -- Perform SRAM programming
+    #     flash: bool,  # -- Perform Flash programming
+    #     project_dir,
+    #     verbose,
+    #     verbose_yosys,
+    #     verbose_pnr,
+    #     top_module,
+    # ):
     """Upload the bitstream to the FPGA."""
 
+    # -- Extract the arguments
+    project_dir = kwargs[PROJECT_DIR]
+    board = kwargs[BOARD]
+    verbose = kwargs[VERBOSE]
+    verbose_yosys = kwargs[VERBOSE_YOSYS]
+    verbose_pnr = kwargs[VERBOSE_PNR]
+    top_module = kwargs[TOP_MODULE]
+    serial_port = kwargs[SERIAL_PORT]
+    ftdi_id = kwargs[FTDI_ID]
+    sram = kwargs[SRAM]
+    flash = kwargs[FLASH]
+
     # -- Create a drivers object
     drivers = Drivers()