src/busio.py

   1 """
   2 `busio` - Bus protocol support like I2C and SPI
   3 =================================================
   4
   5 See `CircuitPython:busio` in CircuitPython for more details.
   6
   7 * Author(s): cefn
   8 """
   9
  10 import threading
  11
  12 from adafruit_blinka import Enum, Lockable, agnostic
  13 from adafruit_blinka.agnostic import board_id, detector
  14 import adafruit_platformdetect.board as ap_board
  15
  16 class I2C(Lockable):
  17     def __init__(self, scl, sda, frequency=400000):
  18         self.init(scl, sda, frequency)
  19
  20     def init(self, scl, sda, frequency):
  21         self.deinit()
  22         if detector.board.ftdi_ft232h:
  23             from adafruit_blinka.microcontroller.ft232h.i2c import I2C
  24             self._i2c = I2C()
  25             return
  26         elif detector.board.binho_nova:
  27             from adafruit_blinka.microcontroller.nova.i2c import I2C
  28             self._i2c = I2C()
  29             return
  30         elif detector.board.any_embedded_linux:
  31             from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
  32         else:
  33             from machine import I2C as _I2C
  34         from microcontroller.pin import i2cPorts
  35         for portId, portScl, portSda in i2cPorts:
  36             if scl == portScl and sda == portSda:
  37                 self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
  38                 break
  39         else:
  40             raise ValueError(
  41                 "No Hardware I2C on (scl,sda)={}\nValid I2C ports: {}".format((scl, sda), i2cPorts)
  42             )
  43
  44         self._lock = threading.RLock()
  45
  46     def deinit(self):
  47         try:
  48             del self._i2c
  49         except AttributeError:
  50             pass
  51
  52     def __enter__(self):
  53         self._lock.acquire()
  54         return self
  55
  56     def __exit__(self, exc_type, exc_value, traceback):
  57         self._lock.release()
  58         self.deinit()
  59
  60     def scan(self):
  61         return self._i2c.scan()
  62
  63     def readfrom_into(self, address, buffer, *, start=0, end=None):
  64         if start is not 0 or end is not None:
  65             if end is None:
  66                 end = len(buffer)
  67             buffer = memoryview(buffer)[start:end]
  68         stop = True  # remove for efficiency later
  69         return self._i2c.readfrom_into(address, buffer, stop=stop)
  70
  71     def writeto(self, address, buffer, *, start=0, end=None, stop=True):
  72         if isinstance(buffer, str):
  73             buffer = bytes([ord(x) for x in buffer])
  74         if start is not 0 or end is not None:
  75             if end is None:
  76                 return self._i2c.writeto(address, memoryview(buffer)[start:], stop=stop)
  77             else:
  78                 return self._i2c.writeto(address, memoryview(buffer)[start:end], stop=stop)
  79         return self._i2c.writeto(address, buffer, stop=stop)
  80
  81     def writeto_then_readfrom(self, address, buffer_out, buffer_in, *, out_start=0, out_end=None, in_start=0, in_end=None, stop=False):
  82         return self._i2c.writeto_then_readfrom(address, buffer_out, buffer_in,
  83                                                out_start=out_start, out_end=out_end,
  84                                                in_start=in_start, in_end=in_end, stop=stop)
  85
  86 class SPI(Lockable):
  87     def __init__(self, clock, MOSI=None, MISO=None):
  88         self.deinit()
  89         if detector.board.ftdi_ft232h:
  90             from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
  91             from adafruit_blinka.microcontroller.ft232h.pin import SCK, MOSI, MISO
  92             self._spi = _SPI()
  93             self._pins = (SCK, MOSI, MISO)
  94             return
  95         elif detector.board.binho_nova:
  96             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
  97             from adafruit_blinka.microcontroller.nova.pin import SCK, MOSI, MISO
  98             self._spi = _SPI(clock)
  99             self._pins = (SCK, MOSI, MISO)
 100             return
 101         elif detector.board.any_embedded_linux:
 102             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 103         else:
 104             from machine import SPI as _SPI
 105         from microcontroller.pin import spiPorts
 106         for portId, portSck, portMosi, portMiso in spiPorts:
 107             if ((clock == portSck) and                   # Clock is required!
 108                 (MOSI == portMosi or MOSI == None) and   # But can do with just output
 109                 (MISO == portMiso or MISO == None)):      # Or just input
 110                 self._spi = _SPI(portId)
 111                 self._pins = (portSck, portMosi, portMiso)
 112                 break
 113         else:
 114             raise ValueError(
 115                 "No Hardware SPI on (SCLK, MOSI, MISO)={}\nValid SPI ports:{}".
 116                 format((clock, MOSI, MISO), spiPorts))
 117
 118     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
 119         if detector.board.any_raspberry_pi or detector.board.any_raspberry_pi_40_pin:
 120             from adafruit_blinka.microcontroller.bcm283x.pin import Pin
 121             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 122         elif detector.board.any_beaglebone:
 123             from adafruit_blinka.microcontroller.am335x.pin import Pin
 124             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 125         elif board_id == ap_board.ORANGE_PI_PC or board_id == ap_board.ORANGE_PI_R1 or board_id == ap_board.ORANGE_PI_ZERO:
 126             from adafruit_blinka.microcontroller.allwinner_h3.pin import Pin
 127             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 128         elif board_id == ap_board.GIANT_BOARD:
 129             from adafruit_blinka.microcontroller.sama5.pin import Pin
 130             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 131         elif board_id == ap_board.CORAL_EDGE_TPU_DEV:
 132             from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
 133             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 134         elif board_id == ap_board.ODROID_C2:
 135             from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
 136             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 137         elif board_id == ap_board.DRAGONBOARD_410C:
 138             from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
 139             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 140         elif board_id == ap_board.JETSON_NANO:
 141             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 142             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
 143         elif board_id == ap_board.JETSON_TX1:
 144             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 145             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
 146         elif board_id == ap_board.JETSON_TX2:
 147             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 148             from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
 149         elif board_id == ap_board.JETSON_XAVIER:
 150             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 151             from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
 152         elif detector.board.ftdi_ft232h:
 153             from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
 154             from adafruit_blinka.microcontroller.ft232h.pin import Pin
 155         elif detector.board.binho_nova:
 156             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
 157             from adafruit_blinka.microcontroller.nova.pin import Pin
 158         else:
 159             from machine import SPI as _SPI
 160             from machine import Pin
 161
 162         if self._locked:
 163             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
 164             self._spi.init(
 165                 baudrate=baudrate,
 166                 polarity=polarity,
 167                 phase=phase,
 168                 bits=bits,
 169                 firstbit=_SPI.MSB,
 170                 sck=Pin(self._pins[0].id),
 171                 mosi=Pin(self._pins[1].id),
 172                 miso=Pin(self._pins[2].id)
 173             )
 174         else:
 175             raise RuntimeError("First call try_lock()")
 176
 177     def deinit(self):
 178         self._spi = None
 179         self._pinIds = None
 180
 181     @property
 182     def frequency(self):
 183         try:
 184             return self._spi.frequency
 185         except AttributeError:
 186             raise NotImplementedError("Frequency attribute not implemented for this platform")
 187
 188     def write(self, buf, start=0, end=None):
 189         return self._spi.write(buf, start, end)
 190
 191     def readinto(self, buf, start=0, end=None, write_value=0):
 192         return self._spi.readinto(buf, start, end, write_value=write_value)
 193
 194     def write_readinto(self, buffer_out, buffer_in,  out_start=0, out_end=None, in_start=0, in_end=None):
 195         return self._spi.write_readinto(buffer_out, buffer_in, out_start, out_end, in_start, in_end)
 196
 197
 198 class UART(Lockable):
 199     class Parity(Enum):
 200         pass
 201
 202     Parity.ODD = Parity()
 203     Parity.EVEN = Parity()
 204
 205     def __init__(self,
 206                  tx,
 207                  rx,
 208                  baudrate=9600,
 209                  bits=8,
 210                  parity=None,
 211                  stop=1,
 212                  timeout=1000,
 213                  receiver_buffer_size=64,
 214                  flow=None):
 215         if detector.board.any_embedded_linux:
 216             raise RuntimeError('busio.UART not supported on this platform. Please use pyserial instead.')
 217         elif detector.board.binho_nova:
 218             from adafruit_blinka.microcontroller.nova.uart import UART as _UART
 219         else:
 220             from machine import UART as _UART
 221
 222         if detector.board.binho_nova:
 223             from adafruit_blinka.microcontroller.nova.pin import uartPorts
 224         else:
 225             from microcontroller.pin import uartPorts
 226
 227         self.baudrate = baudrate
 228
 229         if flow is not None:  # default 0
 230             raise NotImplementedError(
 231                 "Parameter '{}' unsupported on {}".format(
 232                     "flow", agnostic.board_id))
 233
 234         # translate parity flag for Micropython
 235         if parity is UART.Parity.ODD:
 236             parity = 1
 237         elif parity is UART.Parity.EVEN:
 238             parity = 0
 239         elif parity is None:
 240             pass
 241         else:
 242             raise ValueError("Invalid parity")
 243
 244         # check tx and rx have hardware support
 245         for portId, portTx, portRx in uartPorts:  #
 246             if portTx == tx and portRx == rx:
 247                 self._uart = _UART(
 248                     portId,
 249                     baudrate,
 250                     bits=bits,
 251                     parity=parity,
 252                     stop=stop,
 253                     timeout=timeout,
 254                     read_buf_len=receiver_buffer_size
 255                 )
 256                 break
 257         else:
 258             raise ValueError(
 259                 "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format((tx, rx), uartPorts)
 260             )
 261
 262     def deinit(self):
 263         if detector.board.binho_nova:
 264             self._uart.deinit()
 265         self._uart = None
 266
 267     def read(self, nbytes=None):
 268         return self._uart.read(nbytes)
 269
 270     def readinto(self, buf, nbytes=None):
 271         return self._uart.readinto(buf, nbytes)
 272
 273     def readline(self):
 274         return self._uart.readline()
 275
 276     def write(self, buf):
 277         return self._uart.write(buf)