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