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