Start adding some documentation for steps. Don't expose for now as interfaces need fixing for boards, sim etc

Author: robtaylor

chipflow_lib/steps/__init__.py

@@ -0,0 +1,17 @@
+"""
+Steps provide an extensible way to modify the `chipflow` command behavior for a given design
+"""
+
+from abc import ABC
+
+class StepBase(ABC):
+    def __init__(self, config={}):
+        ...
+
+    def build_cli_parser(self, parser):
+        "Build the cli parser for this step"
+        ...
+
+    def run_cli(self, args):
+        "Called when this step's is used from `chipflow` command"
+        self.build()

chipflow_lib/steps/board.py

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: BSD-2-Clause
+from . import StepBase
 
-class BoardStep:
+class BoardStep(StepBase):
     """Build the design for a board."""
 
     def __init__(self, config, platform):
@@ -13,4 +14,5 @@ def run_cli(self, args):
         self.build()
 
     def build(self):
+        "Build for the given platform"
         self.platform.build()

chipflow_lib/steps/silicon.py

@@ -13,14 +13,15 @@
 import dotenv
 from amaranth import *
 
+from . import StepBase
 from .. import ChipFlowError
 from ..platforms import SiliconPlatform, top_interfaces, load_pinlock
 
 
 logger = logging.getLogger(__name__)
 
 
-class SiliconTop(Elaboratable):
+class SiliconTop(StepBase, Elaboratable):
     def __init__(self, config={}):
         self._config = config
 
@@ -53,7 +54,7 @@ def elaborate(self, platform: SiliconPlatform):
 
 
 class SiliconStep:
-    """Prepare and submit the design for an ASIC."""
+    """Step to Prepare and submit the design for an ASIC."""
     def __init__(self, config):
         self.config = config
 

chipflow_lib/steps/sim.py

@@ -3,8 +3,9 @@
 from doit.cmd_base import ModuleTaskLoader
 from doit.doit_cmd import DoitMain
 
+from . import StepBase
 
-class SimStep:
+class SimStep(StepBase):
     """Simulate the design."""
 
     doit_build_module = None

chipflow_lib/steps/software.py

@@ -3,9 +3,10 @@
 from doit.cmd_base import ModuleTaskLoader
 from doit.doit_cmd import DoitMain
 
+from . import StepBase
 
-class SoftwareStep:
-    """Build the software."""
+class SoftwareStep(StepBase):
+    """Base step to build the software."""
 
     doit_build_module = None
 
@@ -19,7 +20,9 @@ def run_cli(self, args):
         self.build()
 
     def doit_build(self):
+        "Run the overridden doit_build_module"
         DoitMain(ModuleTaskLoader(self.doit_build_module)).run(["build_software"])
 
     def build(self):
+        "Build the software for your design"
         self.doit_build()