Clean API further and add/tidy docs

Author: robtaylor

chipflow_digital_ip/base/__init__.py

@@ -1,4 +1,4 @@
-from .platform_timer import PlatformTimer
-from .soc_id import SoCID
+from ._platform_timer import PlatformTimer
+from ._soc_id import SoCID
 
 __all__ = ['PlatformTimer', 'SoCID']

chipflow_digital_ip/base/platform_timer.py renamed to chipflow_digital_ip/base/_platform_timer.py

@@ -1,7 +1,7 @@
-from .gpio import GPIOPeripheral
-from .uart import UARTPeripheral
-from .i2c import I2CPeripheral, I2CSignature
-from .spi import SPIPeripheral, SPISignature
+from ._gpio import GPIOPeripheral
+from ._uart import UARTPeripheral
+from ._i2c import I2CPeripheral, I2CSignature
+from ._spi import SPIPeripheral, SPISignature
 
 __all__ = ['GPIOPeripheral', 'UARTPeripheral', 'I2CPeripheral', 'SPIPeripheral',
            'I2CSignature', 'SPISignature']

chipflow_digital_ip/base/soc_id.py renamed to chipflow_digital_ip/base/_soc_id.py

@@ -7,7 +7,7 @@
 
 from chipflow_lib.platforms import OutputIOSignature, InputIOSignature
 
-from . import rfc_uart
+from . import _rfc_uart
 
 __all__ = ["UARTPeripheral"]
 
@@ -150,7 +150,7 @@ def __init__(self):
 
     def __init__(self, *, addr_width=5, data_width=8, init_divisor=0):
         phy_config_shape = data.StructLayout({"divisor": unsigned(24)})
-        self._uart = rfc_uart.Peripheral(
+        self._uart = _rfc_uart.Peripheral(
             addr_width=addr_width,
             data_width=data_width,
             phy_config_shape=phy_config_shape,

chipflow_digital_ip/io/__init__.py

@@ -1,5 +1,5 @@
-from .hyperram import HyperRAM
-from .sram import SRAMPeripheral
-from .qspi_flash import QSPIFlash
+from ._hyperram import HyperRAM
+from ._sram import SRAMPeripheral
+from ._qspi_flash import QSPIFlash
 
 __all__ = ['HyperRAM', 'SRAMPeripheral', 'QSPIFlash']