Add typing information to micropython

[Adafruit_Blinka-hackapet.git] / src / busio.py

diff --git a/src/busio.py b/src/busio.py
old mode 100755 (executable)
new mode 100644 (file)
index 34b1214..dd748a5
--- a/src/busio.py
+++ b/src/busio.py
@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT

 """
 `busio` - Bus protocol support like I2C and SPI
 =================================================
 """
 `busio` - Bus protocol support like I2C and SPI
 =================================================


@@ -12,13 +15,14 @@ try:
 except ImportError:
     threading = None
 
 except ImportError:
     threading = None
 

+# pylint: disable=unused-import

 import adafruit_platformdetect.constants.boards as ap_board
 import adafruit_platformdetect.constants.chips as ap_chip
 from adafruit_blinka import Enum, Lockable, agnostic
 from adafruit_blinka.agnostic import board_id, detector
 
 # pylint: disable=import-outside-toplevel,too-many-branches,too-many-statements
 import adafruit_platformdetect.constants.boards as ap_board
 import adafruit_platformdetect.constants.chips as ap_chip
 from adafruit_blinka import Enum, Lockable, agnostic
 from adafruit_blinka.agnostic import board_id, detector
 
 # pylint: disable=import-outside-toplevel,too-many-branches,too-many-statements

-# pylint: disable=too-many-arguments,too-many-function-args
+# pylint: disable=too-many-arguments,too-many-function-args,too-many-return-statements

 
 
 class I2C(Lockable):
 
 
 class I2C(Lockable):


@@ -34,7 +38,7 @@ class I2C(Lockable):
         """Initialization"""
         self.deinit()
         if detector.board.ftdi_ft232h:
         """Initialization"""
         self.deinit()
         if detector.board.ftdi_ft232h:

-            from adafruit_blinka.microcontroller.ft232h.i2c import I2C as _I2C
+            from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.i2c import I2C as _I2C

 
             self._i2c = _I2C(frequency=frequency)
             return
 
             self._i2c = _I2C(frequency=frequency)
             return


@@ -53,17 +57,66 @@ class I2C(Lockable):
 
             self._i2c = _I2C(frequency=frequency)
             return
 
             self._i2c = _I2C(frequency=frequency)
             return

+        if detector.board.pico_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.i2c import I2C_Pico as _I2C
+
+            self._i2c = _I2C(scl, sda, frequency=frequency)
+            return
+        if detector.board.feather_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
+                I2C_Feather as _I2C,
+            )
+
+            self._i2c = _I2C(scl, sda, frequency=frequency)
+            return
+        if detector.board.qtpy_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.i2c import I2C_QTPY as _I2C
+
+            self._i2c = _I2C(scl, sda, frequency=frequency)
+            return
+        if detector.board.itsybitsy_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
+                I2C_ItsyBitsy as _I2C,
+            )
+
+            self._i2c = _I2C(scl, sda, frequency=frequency)
+            return
+        if detector.board.macropad_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
+                I2C_MacroPad as _I2C,
+            )
+
+            self._i2c = _I2C(scl, sda, frequency=frequency)
+            return
+        if detector.board.qt2040_trinkey_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
+                I2C_QT2040_Trinkey as _I2C,
+            )
+
+            self._i2c = _I2C(scl, sda, frequency=frequency)
+            return
+        if detector.chip.id == ap_chip.RP2040:
+            from adafruit_blinka.microcontroller.rp2040.i2c import I2C as _I2C
+
+            self._i2c = _I2C(scl, sda, frequency=frequency)
+            return

         if detector.board.any_embedded_linux:
             from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
         if detector.board.any_embedded_linux:
             from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C

+        elif detector.board.ftdi_ft2232h:
+            from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.i2c import I2C as _I2C

         else:
         else:

-            from machine import I2C as _I2C
+            from adafruit_blinka.microcontroller.generic_micropython.i2c import (
+                I2C as _I2C,
+            )

         from microcontroller.pin import i2cPorts
 
         for portId, portScl, portSda in i2cPorts:
             try:
         from microcontroller.pin import i2cPorts
 
         for portId, portScl, portSda in i2cPorts:
             try:

+                # pylint: disable=unexpected-keyword-arg

                 if scl == portScl and sda == portSda:
                     self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
                     break
                 if scl == portScl and sda == portSda:
                     self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
                     break

+                # pylint: enable=unexpected-keyword-arg

             except RuntimeError:
                 pass
         else:
             except RuntimeError:
                 pass
         else:


@@ -125,7 +178,7 @@ class I2C(Lockable):
         out_end=None,
         in_start=0,
         in_end=None,
         out_end=None,
         in_start=0,
         in_end=None,

-        stop=False
+        stop=False,

     ):
         """ "Write to a device at specified address from a buffer then read
         from a device at specified address into a buffer
     ):
         """ "Write to a device at specified address from a buffer then read
         from a device at specified address into a buffer


@@ -151,8 +204,12 @@ class SPI(Lockable):
     def __init__(self, clock, MOSI=None, MISO=None):
         self.deinit()
         if detector.board.ftdi_ft232h:
     def __init__(self, clock, MOSI=None, MISO=None):
         self.deinit()
         if detector.board.ftdi_ft232h:

-            from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
-            from adafruit_blinka.microcontroller.ft232h.pin import SCK, MOSI, MISO
+            from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import SPI as _SPI
+            from adafruit_blinka.microcontroller.ftdi_mpsse.ft232h.pin import (
+                SCK,
+                MOSI,
+                MISO,
+            )

 
             self._spi = _SPI()
             self._pins = (SCK, MOSI, MISO)
 
             self._spi = _SPI()
             self._pins = (SCK, MOSI, MISO)


@@ -171,10 +228,56 @@ class SPI(Lockable):
             self._spi = _SPI()
             self._pins = (SCK, MOSI, MISO)
             return
             self._spi = _SPI()
             self._pins = (SCK, MOSI, MISO)
             return

+        if detector.board.pico_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_Pico as _SPI
+
+            self._spi = _SPI(clock)  # this is really all that's needed
+            self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
+            return
+        if detector.board.feather_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
+                SPI_Feather as _SPI,
+            )
+
+            self._spi = _SPI(clock)  # this is really all that's needed
+            self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
+            return
+        if detector.board.itsybitsy_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
+                SPI_ItsyBitsy as _SPI,
+            )
+
+            self._spi = _SPI(clock)  # this is really all that's needed
+            self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
+            return
+        if detector.board.macropad_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
+                SPI_MacroPad as _SPI,
+            )
+
+            self._spi = _SPI(clock)  # this is really all that's needed
+            self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
+            return
+        if detector.board.qtpy_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_QTPY as _SPI
+
+            self._spi = _SPI(clock)  # this is really all that's needed
+            self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
+            return
+        if detector.chip.id == ap_chip.RP2040:
+            from adafruit_blinka.microcontroller.rp2040.spi import SPI as _SPI
+
+            self._spi = _SPI(clock, MOSI, MISO)  # Pins configured on instantiation
+            self._pins = (clock, clock, clock)  # These don't matter, they're discarded
+            return

         if detector.board.any_embedded_linux:
             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
         if detector.board.any_embedded_linux:
             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI

+        elif detector.board.ftdi_ft2232h:
+            from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import SPI as _SPI

         else:
         else:

-            from machine import SPI as _SPI
+            from adafruit_blinka.microcontroller.generic_micropython.spi import (
+                SPI as _SPI,
+            )

         from microcontroller.pin import spiPorts
 
         for portId, portSck, portMosi, portMiso in spiPorts:
         from microcontroller.pin import spiPorts
 
         for portId, portSck, portMosi, portMiso in spiPorts:


@@ -195,89 +298,46 @@ class SPI(Lockable):
 
     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
         """Update the configuration"""
 
     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
         """Update the configuration"""

-        if detector.board.any_raspberry_pi or detector.board.any_raspberry_pi_40_pin:
-            from adafruit_blinka.microcontroller.bcm283x.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif detector.board.BEAGLEBONE_AI:
-            from adafruit_blinka.microcontroller.dra74x.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif detector.board.any_beaglebone:
-            from adafruit_blinka.microcontroller.am335x.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif detector.board.any_orange_pi and detector.chip.id == ap_chip.SUN8I:
-            from adafruit_blinka.microcontroller.allwinner.h3.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif board_id == ap_board.GIANT_BOARD:
-            from adafruit_blinka.microcontroller.sama5.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif board_id == ap_board.CORAL_EDGE_TPU_DEV:
-            from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif board_id == ap_board.CORAL_EDGE_TPU_DEV_MINI:
-            from adafruit_blinka.microcontroller.mt8167.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif board_id == ap_board.ODROID_C2:
-            from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif board_id == ap_board.ODROID_C4:
-            from adafruit_blinka.microcontroller.amlogic.s905x3.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif board_id == ap_board.ODROID_XU4:
-            from adafruit_blinka.microcontroller.samsung.exynos5422.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif board_id == ap_board.DRAGONBOARD_410C:
-            from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
+        if detector.board.any_nanopi and detector.chip.id == ap_chip.SUN8I:

             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI

-        elif board_id == ap_board.JETSON_NANO:
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-            from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
-        elif board_id == ap_board.JETSON_TX1:
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-            from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
-        elif board_id == ap_board.JETSON_TX2:
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-            from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
-        elif board_id == ap_board.JETSON_XAVIER:
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-            from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
-        elif board_id == ap_board.JETSON_NX:
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-            from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
-        elif detector.board.ROCK_PI_S:
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-            from adafruit_blinka.microcontroller.rockchip.rk3308.pin import Pin
-        elif detector.board.SIFIVE_UNLEASHED:
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-            from adafruit_blinka.microcontroller.hfu540.pin import Pin

         elif detector.board.ftdi_ft232h:
         elif detector.board.ftdi_ft232h:

-            from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
-            from adafruit_blinka.microcontroller.ft232h.pin import Pin
+            from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import (
+                SPI as _SPI,
+            )
+        elif detector.board.ftdi_ft2232h:
+            from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import (
+                SPI as _SPI,
+            )

         elif detector.board.binho_nova:
             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
         elif detector.board.binho_nova:
             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI

-            from adafruit_blinka.microcontroller.nova.pin import Pin

         elif detector.board.greatfet_one:
             from adafruit_blinka.microcontroller.nxp_lpc4330.spi import SPI as _SPI
         elif detector.board.greatfet_one:
             from adafruit_blinka.microcontroller.nxp_lpc4330.spi import SPI as _SPI

-            from adafruit_blinka.microcontroller.nxp_lpc4330.pin import Pin
-        elif board_id in (
-            ap_board.PINE64,
-            ap_board.PINEBOOK,
-            ap_board.PINEPHONE,
-            ap_board.SOPINE,
-        ):
-            from adafruit_blinka.microcontroller.allwinner.a64.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif board_id == ap_board.CLOCKWORK_CPI3:
-            from adafruit_blinka.microcontroller.allwinner.a33.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
-        elif board_id == ap_board.ONION_OMEGA2:
-            from adafruit_blinka.microcontroller.mips24kec.pin import Pin
-            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI

         elif detector.board.any_lubancat and detector.chip.id == ap_chip.IMX6ULL:
         elif detector.board.any_lubancat and detector.chip.id == ap_chip.IMX6ULL:

-            from adafruit_blinka.microcontroller.nxp_imx6ull.pin import Pin
+            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
+        elif detector.board.pico_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_Pico as _SPI
+        elif detector.board.feather_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
+                SPI_Feather as _SPI,
+            )
+        elif detector.board.itsybitsy_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
+                SPI_ItsyBitsy as _SPI,
+            )
+        elif detector.board.macropad_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
+                SPI_MacroPad as _SPI,
+            )
+        elif detector.board.qtpy_u2if:
+            from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_QTPY as _SPI
+        elif detector.chip.id == ap_chip.RP2040:
+            from adafruit_blinka.microcontroller.rp2040.spi import SPI as _SPI
+        elif detector.board.any_embedded_linux:

             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
         else:
             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
         else:

-            from machine import SPI as _SPI
-            from machine import Pin
+            from adafruit_blinka.microcontroller.generic_micropython.spi import (
+                SPI as _SPI,
+            )

 
         if self._locked:
             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
 
         if self._locked:
             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute


@@ -287,9 +347,6 @@ class SPI(Lockable):
                 phase=phase,
                 bits=bits,
                 firstbit=_SPI.MSB,
                 phase=phase,
                 bits=bits,
                 firstbit=_SPI.MSB,

-                sck=Pin(self._pins[0].id),
-                mosi=Pin(self._pins[1].id),
-                miso=Pin(self._pins[2].id),

             )
         else:
             raise RuntimeError("First call try_lock()")
             )
         else:
             raise RuntimeError("First call try_lock()")


@@ -304,10 +361,10 @@ class SPI(Lockable):
         """Return the baud rate if implemented"""
         try:
             return self._spi.frequency
         """Return the baud rate if implemented"""
         try:
             return self._spi.frequency

-        except AttributeError:
+        except AttributeError as error:

             raise NotImplementedError(
                 "Frequency attribute not implemented for this platform"
             raise NotImplementedError(
                 "Frequency attribute not implemented for this platform"

-            ) from AttributeError
+            ) from error

 
     def write(self, buf, start=0, end=None):
         """Write to the SPI device"""
 
     def write(self, buf, start=0, end=None):
         """Write to the SPI device"""


@@ -360,13 +417,12 @@ class UART(Lockable):
             from adafruit_blinka.microcontroller.nova.uart import UART as _UART
         elif detector.board.greatfet_one:
             from adafruit_blinka.microcontroller.nxp_lpc4330.uart import UART as _UART
             from adafruit_blinka.microcontroller.nova.uart import UART as _UART
         elif detector.board.greatfet_one:
             from adafruit_blinka.microcontroller.nxp_lpc4330.uart import UART as _UART

+        elif detector.chip.id == ap_chip.RP2040:
+            from adafruit_blinka.microcontroller.rp2040.uart import UART as _UART

         else:
             from machine import UART as _UART
 
         else:
             from machine import UART as _UART
 

-        if detector.board.binho_nova:
-            from adafruit_blinka.microcontroller.nova.pin import uartPorts
-        else:
-            from microcontroller.pin import uartPorts
+        from microcontroller.pin import uartPorts

 
         self.baudrate = baudrate
 
 
         self.baudrate = baudrate
 


@@ -385,25 +441,35 @@ class UART(Lockable):
         else:
             raise ValueError("Invalid parity")
 
         else:
             raise ValueError("Invalid parity")
 

-        # check tx and rx have hardware support
-        for portId, portTx, portRx in uartPorts:  #
-            if portTx == tx and portRx == rx:
-                self._uart = _UART(
-                    portId,
-                    baudrate,
-                    bits=bits,
-                    parity=parity,
-                    stop=stop,
-                    timeout=timeout,
-                    read_buf_len=receiver_buffer_size,
-                )
-                break
+        if detector.chip.id == ap_chip.RP2040:
+            self._uart = _UART(
+                tx,
+                rx,
+                baudrate=baudrate,
+                bits=bits,
+                parity=parity,
+                stop=stop,
+            )

         else:
         else:

-            raise ValueError(
-                "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format(
-                    (tx, rx), uartPorts
+            # check tx and rx have hardware support
+            for portId, portTx, portRx in uartPorts:  #
+                if portTx == tx and portRx == rx:
+                    self._uart = _UART(
+                        portId,
+                        baudrate,
+                        bits=bits,
+                        parity=parity,
+                        stop=stop,
+                        timeout=timeout,
+                        read_buf_len=receiver_buffer_size,
+                    )
+                    break
+            else:
+                raise ValueError(
+                    "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format(
+                        (tx, rx), uartPorts
+                    )

                 )
                 )

-            )

 
     def deinit(self):
         """Deinitialization"""
 
     def deinit(self):
         """Deinitialization"""


@@ -426,36 +492,3 @@ class UART(Lockable):
     def write(self, buf):
         """Write to the UART from a buffer"""
         return self._uart.write(buf)
     def write(self, buf):
         """Write to the UART from a buffer"""
         return self._uart.write(buf)

-
-
-class OneWire:
-    """
-    Stub class for OneWire, which is currently not implemented
-    """
-
-    def __init__(self, pin):
-        raise NotImplementedError("OneWire has not been implemented")
-
-    def deinit(self):
-        """
-        Deinitialize the OneWire bus and release any hardware resources for reuse.
-        """
-        raise NotImplementedError("OneWire has not been implemented")
-
-    def reset(self):
-        """
-        Reset the OneWire bus and read presence
-        """
-        raise NotImplementedError("OneWire has not been implemented")
-
-    def read_bit(self):
-        """
-        Read in a bit
-        """
-        raise NotImplementedError("OneWire has not been implemented")
-
-    def write_bit(self, value):
-        """
-        Write out a bit based on value.
-        """
-        raise NotImplementedError("OneWire has not been implemented")