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