Merge pull request #170 from hamishmb/fix-thread-safety

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

diff --git a/src/busio.py b/src/busio.py
old mode 100644 (file)
new mode 100755 (executable)
index a02eccf..f71871b
--- a/src/busio.py
+++ b/src/busio.py
@@ -1,4 +1,17 @@
+"""
+`busio` - Bus protocol support like I2C and SPI
+=================================================
+
+See `CircuitPython:busio` in CircuitPython for more details.
+
+* Author(s): cefn
+"""
+
+import threading
+

 from adafruit_blinka import Enum, Lockable, agnostic
 from adafruit_blinka import Enum, Lockable, agnostic

+from adafruit_blinka.agnostic import board_id, detector
+import adafruit_platformdetect.board as ap_board

 
 class I2C(Lockable):
     def __init__(self, scl, sda, frequency=400000):
 
 class I2C(Lockable):
     def __init__(self, scl, sda, frequency=400000):


@@ -6,15 +19,25 @@ class I2C(Lockable):
 
     def init(self, scl, sda, frequency):
         self.deinit()
 
     def init(self, scl, sda, frequency):
         self.deinit()

-        from machine import I2C as _I2C
+        if detector.board.ftdi_ft232h:
+            from adafruit_blinka.microcontroller.ft232h.i2c import I2C
+            self._i2c = I2C()
+            return
+        elif detector.board.any_embedded_linux:
+            from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
+        else:
+            from machine import I2C as _I2C

         from microcontroller.pin import i2cPorts
         for portId, portScl, portSda in i2cPorts:
             if scl == portScl and sda == portSda:
         from microcontroller.pin import i2cPorts
         for portId, portScl, portSda in i2cPorts:
             if scl == portScl and sda == portSda:

-                self._i2c = I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
+                self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)

                 break
         else:
                 break
         else:

-            raise NotImplementedError("No Hardware I2C on (scl,sda)={}\nValid UART ports".format(
-        (scl, sda), i2cPorts))
+            raise ValueError(
+                "No Hardware I2C on (scl,sda)={}\nValid I2C ports: {}".format((scl, sda), i2cPorts)
+            )
+
+        self._lock = threading.RLock()

 
     def deinit(self):
         try:
 
     def deinit(self):
         try:


@@ -23,54 +46,114 @@ class I2C(Lockable):
             pass
 
     def __enter__(self):
             pass
 
     def __enter__(self):

+        self._lock.acquire()

         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):

+        self._lock.release()

         self.deinit()
 
     def scan(self):
         return self._i2c.scan()
 
         self.deinit()
 
     def scan(self):
         return self._i2c.scan()
 

-    def readfrom_into(self, address, buffer, start=0, end=None):
+    def readfrom_into(self, address, buffer, *, start=0, end=None):

         if start is not 0 or end is not None:
             if end is None:
                 end = len(buffer)
             buffer = memoryview(buffer)[start:end]
         stop = True  # remove for efficiency later
         if start is not 0 or end is not None:
             if end is None:
                 end = len(buffer)
             buffer = memoryview(buffer)[start:end]
         stop = True  # remove for efficiency later

-        return self._i2c.readfrom_into(address, buffer, stop)
+        return self._i2c.readfrom_into(address, buffer, stop=stop)

 
 

-    def writeto(self, address, buffer, start=0, end=None, stop=True):
+    def writeto(self, address, buffer, *, start=0, end=None, stop=True):
+        if isinstance(buffer, str):
+            buffer = bytes([ord(x) for x in buffer])

         if start is not 0 or end is not None:
             if end is None:
         if start is not 0 or end is not None:
             if end is None:

-                return self._i2c.writeto(address, memoryview(buffer)[start:], stop)
+                return self._i2c.writeto(address, memoryview(buffer)[start:], stop=stop)

             else:
             else:

-                return self._i2c.writeto(address, memoryview(buffer)[start:end], stop)
-        return self._i2c.writeto(address, buffer, stop)
+                return self._i2c.writeto(address, memoryview(buffer)[start:end], stop=stop)
+        return self._i2c.writeto(address, buffer, stop=stop)

 
 

+    def writeto_then_readfrom(self, address, buffer_out, buffer_in, *, out_start=0, out_end=None, in_start=0, in_end=None, stop=False):
+        return self._i2c.writeto_then_readfrom(address, buffer_out, buffer_in,
+                                               out_start=out_start, out_end=out_end,
+                                               in_start=in_start, in_end=in_end, stop=stop)

 
 class SPI(Lockable):
     def __init__(self, clock, MOSI=None, MISO=None):
 
 class SPI(Lockable):
     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
+            self._spi = _SPI()
+            self._pins = (SCK, MOSI, MISO)
+            return
+        elif detector.board.any_embedded_linux:
+            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
+        else:
+            from machine 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:

-            if clock == portSck and MOSI == portMosi and MISO == portMiso:
-                self._spi = SPI(portId)
+            if ((clock == portSck) and                   # Clock is required!
+                (MOSI == portMosi or MOSI == None) and   # But can do with just output
+                (MISO == portMiso or MISO == None)):      # Or just input
+                self._spi = _SPI(portId)

                 self._pins = (portSck, portMosi, portMiso)
                 break
         else:
                 self._pins = (portSck, portMosi, portMiso)
                 break
         else:

-            raise NotImplementedError(
-                "No Hardware SPI on (clock, MOSI, MISO)={}\nValid SPI ports:{}".
+            raise ValueError(
+                "No Hardware SPI on (SCLK, MOSI, MISO)={}\nValid SPI ports:{}".

                 format((clock, MOSI, MISO), spiPorts))
 
     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
                 format((clock, MOSI, MISO), spiPorts))
 
     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):

-        if self._locked:
+        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.any_beaglebone:
+            from adafruit_blinka.microcontroller.am335x.pin import Pin
+            from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
+        elif board_id == ap_board.ORANGE_PI_PC or board_id == ap_board.ORANGE_PI_R1 or board_id == ap_board.ORANGE_PI_ZERO:
+            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.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.DRAGONBOARD_410C:
+            from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
+            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 detector.board.ftdi_ft232h:
+            from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
+            from adafruit_blinka.microcontroller.ft232h.pin import Pin
+        else:
+            from machine import SPI as _SPI

             from machine import Pin
             from machine import Pin

+
+        if self._locked:

             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
             self._spi.init(
                 baudrate=baudrate,
                 polarity=polarity,
                 phase=phase,
                 bits=bits,
             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
             self._spi.init(
                 baudrate=baudrate,
                 polarity=polarity,
                 phase=phase,
                 bits=bits,

-                firstbit=SPI.MSB,
+                firstbit=_SPI.MSB,

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


@@ -82,14 +165,21 @@ class SPI(Lockable):
         self._spi = None
         self._pinIds = None
 
         self._spi = None
         self._pinIds = None
 

-    def write(self, buf):
-        return self._spi.write(buf)
+    @property
+    def frequency(self):
+        try:
+            return self._spi.frequency
+        except AttributeError:
+            raise NotImplementedError("Frequency attribute not implemented for this platform")
+
+    def write(self, buf, start=0, end=None):
+        return self._spi.write(buf, start, end)

 
 

-    def readinto(self, buf):
-        return self.readinto(buf)
+    def readinto(self, buf, start=0, end=None, write_value=0):
+        return self._spi.readinto(buf, start, end, write_value=write_value)

 
 

-    def write_readinto(self, buffer_out, buffer_in):
-        return self.write_readinto(buffer_out, buffer_in)
+    def write_readinto(self, buffer_out, buffer_in,  out_start=0, out_end=None, in_start=0, in_end=None):
+        return self._spi.write_readinto(buffer_out, buffer_in, out_start, out_end, in_start, in_end)

 
 
 class UART(Lockable):
 
 
 class UART(Lockable):


@@ -99,7 +189,6 @@ class UART(Lockable):
     Parity.ODD = Parity()
     Parity.EVEN = Parity()
 
     Parity.ODD = Parity()
     Parity.EVEN = Parity()
 

-    # TODO investigate UART receiver_buffer_size as e.g. read_buf_len in https://github.com/micropython/micropython/blob/3eb0694b97c6a8f0e93b874549aac40d8b78b0e5/ports/stm32/uart.c

     def __init__(self,
                  tx,
                  rx,
     def __init__(self,
                  tx,
                  rx,


@@ -110,7 +199,10 @@ class UART(Lockable):
                  timeout=1000,
                  receiver_buffer_size=64,
                  flow=None):
                  timeout=1000,
                  receiver_buffer_size=64,
                  flow=None):

-        from machine import UART as _UART
+        if detector.board.any_embedded_linux:
+            raise RuntimeError('busio.UART not supported on this platform. Please use pyserial instead.')
+        else:
+            from machine import UART as _UART

         from microcontroller.pin import uartPorts
 
         self.baudrate = baudrate
         from microcontroller.pin import uartPorts
 
         self.baudrate = baudrate


@@ -118,7 +210,7 @@ class UART(Lockable):
         if flow is not None:  # default 0
             raise NotImplementedError(
                 "Parameter '{}' unsupported on {}".format(
         if flow is not None:  # default 0
             raise NotImplementedError(
                 "Parameter '{}' unsupported on {}".format(

-                    "flow", agnostic.board))
+                    "flow", agnostic.board_id))

 
         # translate parity flag for Micropython
         if parity is UART.Parity.ODD:
 
         # translate parity flag for Micropython
         if parity is UART.Parity.ODD:


@@ -144,9 +236,9 @@ class UART(Lockable):
                 )
                 break
         else:
                 )
                 break
         else:

-            raise NotImplementedError(
-                "No Hardware UART on (tx,rx)={}\nValid UART ports".format(
-                    (tx, rx), uartPorts))
+            raise ValueError(
+                "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format((tx, rx), uartPorts)
+            )

 
     def deinit(self):
         self._uart = None
 
     def deinit(self):
         self._uart = None