Remove backward compatibility shims from chipflow package

.gitignore

@@ -19,4 +19,5 @@ __pycache__/
 
 docs/_build
 docs/autoapi
+docs/chipflow-lib
 .cache

chipflow/cli.py

@@ -24,9 +24,9 @@ class UnexpectedError(ChipFlowError):
 
 
 DEFAULT_STEPS = {
-    "silicon": "chipflow.steps.silicon:SiliconStep",
-    "sim": "chipflow.steps.sim:SimStep",
-    "software": "chipflow.steps.software:SoftwareStep"
+    "silicon": "chipflow.platform.silicon_step:SiliconStep",
+    "sim": "chipflow.platform.sim_step:SimStep",
+    "software": "chipflow.platform.software_step:SoftwareStep"
 }
 
 

chipflow/common/__init__.py

@@ -0,0 +1,4 @@
+# SPDX-License-Identifier: BSD-2-Clause
+"""
+Common utilities for ChipFlow.
+"""

chipflow/platforms/_packages.py → chipflow/packages.py

@@ -1,4 +1,11 @@
-from ..packaging import QuadPackageDef, BareDiePackageDef, GAPackageDef, Package, OpenframePackageDef
+# SPDX-License-Identifier: BSD-2-Clause
+"""
+Package definitions for ChipFlow platforms.
+
+This module contains package type definitions for supported IC packages.
+"""
+
+from .packaging import QuadPackageDef, BareDiePackageDef, GAPackageDef, Package, OpenframePackageDef
 
 # Add any new package types to both PACKAGE_DEFINITIONS and the PackageDef union
 PACKAGE_DEFINITIONS = {

chipflow/packaging/base.py

@@ -22,7 +22,7 @@
 from .allocation import _linear_allocate_components
 
 if TYPE_CHECKING:
-    from ..config_models import Config, Process
+    from ..config import Config, Process
 
 # Type variable for pin types (int for linear allocation, GAPin for grid arrays, etc.)
 PinType = TypeVar('PinType')

chipflow/packaging/lockfile.py

@@ -19,7 +19,7 @@
     from .openframe import OpenframePackageDef
 
 # Import Process directly for pydantic to work properly
-from ..config_models import Process
+from ..config import Process
 
 
 # Union of all package definition types

chipflow/packaging/openframe.py

@@ -10,7 +10,7 @@
 
 from .base import LinearAllocPackageDef
 from .pins import PowerPins, BringupPins
-from ..config_models import Voltage
+from ..config import Voltage
 
 
 class OFPin(NamedTuple):

chipflow/packaging/pins.py

@@ -10,7 +10,7 @@
 from enum import StrEnum, auto
 from typing import Set, List, Union, Optional, TypeVar, Generic
 
-from ..config_models import Voltage, VoltageRange
+from ..config import Voltage, VoltageRange
 
 
 # Type aliases for pin collections

chipflow/packaging/utils.py

@@ -60,7 +60,7 @@ def lock_pins(config: Optional['Config'] = None) -> None:
         ChipFlowError: If configuration is invalid or pin allocation fails
     """
     # Import here to avoid circular dependency
-    from ..platforms._packages import PACKAGE_DEFINITIONS
+    from ..packages import PACKAGE_DEFINITIONS
     from ..utils import top_components
 
     if config is None:

chipflow/platform/sim_step.py

@@ -158,7 +158,7 @@ def check(self, *args):
 
         self.run(args)
         # Import here to avoid circular import
-        from ..steps._json_compare import compare_events
+        from ..common._json_compare import compare_events
         compare_events(self._config.chipflow.test.event_reference, self.sim_dir / "events.json")
         print("Integration test passed sucessfully")
 

chipflow_lib/platforms/__init__.py

@@ -2,23 +2,23 @@
 """
 Backward compatibility module for chipflow_lib.platforms.
 
-This module has been renamed to 'chipflow.platforms'. This compatibility layer
+This module has been renamed to 'chipflow.platform'. This compatibility layer
 will be maintained for some time but is deprecated. Please update your imports.
 """
 
 import warnings
 
 # Issue deprecation warning
 warnings.warn(
-    "The 'chipflow_lib.platforms' module has been renamed to 'chipflow.platforms'. "
-    "Please update your imports to use 'chipflow.platforms' instead. "
+    "The 'chipflow_lib.platforms' module has been renamed to 'chipflow.platform'. "
+    "Please update your imports to use 'chipflow.platform' instead. "
     "This compatibility shim will be removed in a future version.",
     DeprecationWarning,
     stacklevel=2
 )
 
 # Re-export symbols used by chipflow-digital-ip and chipflow-examples
-from chipflow.platforms import (  # noqa: F401, E402
+from chipflow.platform import (  # noqa: F401, E402
     # Pin signatures (used by both repos)
     BidirIOSignature,
     GPIOSignature,
@@ -40,3 +40,6 @@
     attach_data,
     SoftwareBuild,
 )
+
+# Package definitions
+from chipflow.packages import PACKAGE_DEFINITIONS  # noqa: F401, E402

chipflow_lib/steps/__init__.py

@@ -2,7 +2,7 @@
 """
 Backward compatibility module for chipflow_lib.steps.
 
-This module has been renamed to 'chipflow.steps'. This compatibility layer
+This module has been renamed to 'chipflow.platform'. This compatibility layer
 will be maintained for some time but is deprecated. Please update your imports.
 """