src/busio.py

   1 # SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
   2 #
   3 # SPDX-License-Identifier: MIT
   4 """
   5 `busio` - Bus protocol support like I2C and SPI
   6 =================================================
   7
   8 See `CircuitPython:busio` in CircuitPython for more details.
   9
  10 * Author(s): cefn
  11 """
  12
  13 try:
  14     import threading
  15 except ImportError:
  16     threading = None
  17
  18 # pylint: disable=unused-import
  19 import adafruit_platformdetect.constants.boards as ap_board
  20 import adafruit_platformdetect.constants.chips as ap_chip
  21 from adafruit_blinka import Enum, Lockable, agnostic
  22 from adafruit_blinka.agnostic import board_id, detector
  23
  24 # pylint: disable=import-outside-toplevel,too-many-branches,too-many-statements
  25 # pylint: disable=too-many-arguments,too-many-function-args,too-many-return-statements
  26
  27
  28 class I2C(Lockable):
  29     """
  30     Busio I2C Class for CircuitPython Compatibility. Used
  31     for both MicroPython and Linux.
  32     """
  33
  34     def __init__(self, scl, sda, frequency=100000):
  35         self.init(scl, sda, frequency)
  36
  37     def init(self, scl, sda, frequency):
  38         """Initialization"""
  39         self.deinit()
  40         if detector.board.ftdi_ft232h:
  41             from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.i2c import I2C as _I2C
  42
  43             self._i2c = _I2C(frequency=frequency)
  44             return
  45         if detector.board.binho_nova:
  46             from adafruit_blinka.microcontroller.nova.i2c import I2C as _I2C
  47
  48             self._i2c = _I2C(frequency=frequency)
  49             return
  50         if detector.board.microchip_mcp2221:
  51             from adafruit_blinka.microcontroller.mcp2221.i2c import I2C as _I2C
  52
  53             self._i2c = _I2C(frequency=frequency)
  54             return
  55         if detector.board.greatfet_one:
  56             from adafruit_blinka.microcontroller.nxp_lpc4330.i2c import I2C as _I2C
  57
  58             self._i2c = _I2C(frequency=frequency)
  59             return
  60         if detector.board.pico_u2if:
  61             from adafruit_blinka.microcontroller.rp2040_u2if.i2c import I2C_Pico as _I2C
  62
  63             self._i2c = _I2C(scl, sda, frequency=frequency)
  64             return
  65         if detector.board.feather_u2if:
  66             from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
  67                 I2C_Feather as _I2C,
  68             )
  69
  70             self._i2c = _I2C(scl, sda, frequency=frequency)
  71             return
  72         if detector.board.qtpy_u2if:
  73             from adafruit_blinka.microcontroller.rp2040_u2if.i2c import I2C_QTPY as _I2C
  74
  75             self._i2c = _I2C(scl, sda, frequency=frequency)
  76             return
  77         if detector.board.itsybitsy_u2if:
  78             from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
  79                 I2C_ItsyBitsy as _I2C,
  80             )
  81
  82             self._i2c = _I2C(scl, sda, frequency=frequency)
  83             return
  84         if detector.board.macropad_u2if:
  85             from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
  86                 I2C_MacroPad as _I2C,
  87             )
  88
  89             self._i2c = _I2C(scl, sda, frequency=frequency)
  90             return
  91         if detector.board.qt2040_trinkey_u2if:
  92             from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
  93                 I2C_QT2040_Trinkey as _I2C,
  94             )
  95
  96             self._i2c = _I2C(scl, sda, frequency=frequency)
  97             return
  98         if detector.chip.id == ap_chip.RP2040:
  99             from adafruit_blinka.microcontroller.rp2040.i2c import I2C as _I2C
 100
 101             self._i2c = _I2C(scl, sda, frequency=frequency)
 102             return
 103         if detector.board.any_siemens_iot2000:
 104             from adafruit_blinka.microcontroller.am65xx.i2c import I2C as _I2C
 105
 106             self._i2c = _I2C(frequency=frequency)
 107             return
 108
 109         if detector.board.any_embedded_linux:
 110             from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
 111         elif detector.board.ftdi_ft2232h:
 112             from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.i2c import I2C as _I2C
 113         else:
 114             from adafruit_blinka.microcontroller.generic_micropython.i2c import (
 115                 I2C as _I2C,
 116             )
 117         from microcontroller.pin import i2cPorts
 118
 119         for portId, portScl, portSda in i2cPorts:
 120             try:
 121                 # pylint: disable=unexpected-keyword-arg
 122                 if scl == portScl and sda == portSda:
 123                     self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
 124                     break
 125                 # pylint: enable=unexpected-keyword-arg
 126             except RuntimeError:
 127                 pass
 128         else:
 129             raise ValueError(
 130                 "No Hardware I2C on (scl,sda)={}\nValid I2C ports: {}".format(
 131                     (scl, sda), i2cPorts
 132                 )
 133             )
 134         if threading is not None:
 135             self._lock = threading.RLock()
 136
 137     def deinit(self):
 138         """Deinitialization"""
 139         try:
 140             del self._i2c
 141         except AttributeError:
 142             pass
 143
 144     def __enter__(self):
 145         if threading is not None:
 146             self._lock.acquire()
 147         return self
 148
 149     def __exit__(self, exc_type, exc_value, traceback):
 150         if threading is not None:
 151             self._lock.release()
 152         self.deinit()
 153
 154     def scan(self):
 155         """Scan for attached devices"""
 156         return self._i2c.scan()
 157
 158     def readfrom_into(self, address, buffer, *, start=0, end=None):
 159         """Read from a device at specified address into a buffer"""
 160         if start != 0 or end is not None:
 161             if end is None:
 162                 end = len(buffer)
 163             buffer = memoryview(buffer)[start:end]
 164         stop = True  # remove for efficiency later
 165         return self._i2c.readfrom_into(address, buffer, stop=stop)
 166
 167     def writeto(self, address, buffer, *, start=0, end=None, stop=True):
 168         """Write to a device at specified address from a buffer"""
 169         if isinstance(buffer, str):
 170             buffer = bytes([ord(x) for x in buffer])
 171         if start != 0 or end is not None:
 172             if end is None:
 173                 return self._i2c.writeto(address, memoryview(buffer)[start:], stop=stop)
 174             return self._i2c.writeto(address, memoryview(buffer)[start:end], stop=stop)
 175         return self._i2c.writeto(address, buffer, stop=stop)
 176
 177     def writeto_then_readfrom(
 178         self,
 179         address,
 180         buffer_out,
 181         buffer_in,
 182         *,
 183         out_start=0,
 184         out_end=None,
 185         in_start=0,
 186         in_end=None,
 187         stop=False,
 188     ):
 189         """ "Write to a device at specified address from a buffer then read
 190         from a device at specified address into a buffer
 191         """
 192         return self._i2c.writeto_then_readfrom(
 193             address,
 194             buffer_out,
 195             buffer_in,
 196             out_start=out_start,
 197             out_end=out_end,
 198             in_start=in_start,
 199             in_end=in_end,
 200             stop=stop,
 201         )
 202
 203
 204 class SPI(Lockable):
 205     """
 206     Busio SPI Class for CircuitPython Compatibility. Used
 207     for both MicroPython and Linux.
 208     """
 209
 210     def __init__(self, clock, MOSI=None, MISO=None):
 211         self.deinit()
 212         if detector.board.ftdi_ft232h:
 213             from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import SPI as _SPI
 214             from adafruit_blinka.microcontroller.ftdi_mpsse.ft232h.pin import (
 215                 SCK,
 216                 MOSI,
 217                 MISO,
 218             )
 219
 220             self._spi = _SPI()
 221             self._pins = (SCK, MOSI, MISO)
 222             return
 223         if detector.board.binho_nova:
 224             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
 225             from adafruit_blinka.microcontroller.nova.pin import SCK, MOSI, MISO
 226
 227             self._spi = _SPI(clock)
 228             self._pins = (SCK, MOSI, MISO)
 229             return
 230         if detector.board.greatfet_one:
 231             from adafruit_blinka.microcontroller.nxp_lpc4330.spi import SPI as _SPI
 232             from adafruit_blinka.microcontroller.nxp_lpc4330.pin import SCK, MOSI, MISO
 233
 234             self._spi = _SPI()
 235             self._pins = (SCK, MOSI, MISO)
 236             return
 237         if detector.board.pico_u2if:
 238             from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_Pico as _SPI
 239
 240             self._spi = _SPI(clock)  # this is really all that's needed
 241             self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
 242             return
 243         if detector.board.feather_u2if:
 244             from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
 245                 SPI_Feather as _SPI,
 246             )
 247
 248             self._spi = _SPI(clock)  # this is really all that's needed
 249             self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
 250             return
 251         if detector.board.itsybitsy_u2if:
 252             from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
 253                 SPI_ItsyBitsy as _SPI,
 254             )
 255
 256             self._spi = _SPI(clock)  # this is really all that's needed
 257             self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
 258             return
 259         if detector.board.macropad_u2if:
 260             from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
 261                 SPI_MacroPad as _SPI,
 262             )
 263
 264             self._spi = _SPI(clock)  # this is really all that's needed
 265             self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
 266             return
 267         if detector.board.qtpy_u2if:
 268             from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_QTPY as _SPI
 269
 270             self._spi = _SPI(clock)  # this is really all that's needed
 271             self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
 272             return
 273         if detector.chip.id == ap_chip.RP2040:
 274             from adafruit_blinka.microcontroller.rp2040.spi import SPI as _SPI
 275
 276             self._spi = _SPI(clock, MOSI, MISO)  # Pins configured on instantiation
 277             self._pins = (clock, clock, clock)  # These don't matter, they're discarded
 278             return
 279         if detector.board.any_siemens_iot2000:
 280             from adafruit_blinka.microcontroller.am65xx.spi import SPI as _SPI
 281
 282             self._spi = _SPI(clock)  # this is really all that's needed
 283             self._pins = (clock, clock, clock)  # will determine MOSI/MISO from clock
 284             return
 285         if detector.board.any_embedded_linux:
 286             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 287         elif detector.board.ftdi_ft2232h:
 288             from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import SPI as _SPI
 289         else:
 290             from adafruit_blinka.microcontroller.generic_micropython.spi import (
 291                 SPI as _SPI,
 292             )
 293         from microcontroller.pin import spiPorts
 294
 295         for portId, portSck, portMosi, portMiso in spiPorts:
 296             if (
 297                 (clock == portSck)
 298                 and MOSI in (portMosi, None)  # Clock is required!
 299                 and MISO in (portMiso, None)  # But can do with just output
 300             ):  # Or just input
 301                 self._spi = _SPI(portId)
 302                 self._pins = (portSck, portMosi, portMiso)
 303                 break
 304         else:
 305             raise ValueError(
 306                 "No Hardware SPI on (SCLK, MOSI, MISO)={}\nValid SPI ports:{}".format(
 307                     (clock, MOSI, MISO), spiPorts
 308                 )
 309             )
 310
 311     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
 312         """Update the configuration"""
 313         if detector.board.any_nanopi and detector.chip.id == ap_chip.SUN8I:
 314             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 315         elif detector.board.ftdi_ft232h:
 316             from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import (
 317                 SPI as _SPI,
 318             )
 319         elif detector.board.ftdi_ft2232h:
 320             from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import (
 321                 SPI as _SPI,
 322             )
 323         elif detector.board.binho_nova:
 324             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
 325         elif detector.board.greatfet_one:
 326             from adafruit_blinka.microcontroller.nxp_lpc4330.spi import SPI as _SPI
 327         elif detector.board.any_lubancat and detector.chip.id == ap_chip.IMX6ULL:
 328             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 329         elif detector.board.pico_u2if:
 330             from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_Pico as _SPI
 331         elif detector.board.feather_u2if:
 332             from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
 333                 SPI_Feather as _SPI,
 334             )
 335         elif detector.board.itsybitsy_u2if:
 336             from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
 337                 SPI_ItsyBitsy as _SPI,
 338             )
 339         elif detector.board.macropad_u2if:
 340             from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
 341                 SPI_MacroPad as _SPI,
 342             )
 343         elif detector.board.qtpy_u2if:
 344             from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_QTPY as _SPI
 345         elif detector.chip.id == ap_chip.RP2040:
 346             from adafruit_blinka.microcontroller.rp2040.spi import SPI as _SPI
 347         elif detector.board.any_siemens_iot2000:
 348             from adafruit_blinka.microcontroller.am65xx.spi import SPI as _SPI
 349             from adafruit_blinka.microcontroller.am65xx.pin import Pin
 350         elif detector.board.any_embedded_linux:
 351             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 352         else:
 353             from adafruit_blinka.microcontroller.generic_micropython.spi import (
 354                 SPI as _SPI,
 355             )
 356
 357         if self._locked:
 358             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
 359             self._spi.init(
 360                 baudrate=baudrate,
 361                 polarity=polarity,
 362                 phase=phase,
 363                 bits=bits,
 364                 firstbit=_SPI.MSB,
 365             )
 366         else:
 367             raise RuntimeError("First call try_lock()")
 368
 369     def deinit(self):
 370         """Deinitialization"""
 371         self._spi = None
 372         self._pinIds = None
 373
 374     @property
 375     def frequency(self):
 376         """Return the baud rate if implemented"""
 377         try:
 378             return self._spi.frequency
 379         except AttributeError as error:
 380             raise NotImplementedError(
 381                 "Frequency attribute not implemented for this platform"
 382             ) from error
 383
 384     def write(self, buf, start=0, end=None):
 385         """Write to the SPI device"""
 386         return self._spi.write(buf, start, end)
 387
 388     def readinto(self, buf, start=0, end=None, write_value=0):
 389         """Read from the SPI device into a buffer"""
 390         return self._spi.readinto(buf, start, end, write_value=write_value)
 391
 392     def write_readinto(
 393         self, buffer_out, buffer_in, out_start=0, out_end=None, in_start=0, in_end=None
 394     ):
 395         """Write to the SPI device and read from the SPI device into a buffer"""
 396         return self._spi.write_readinto(
 397             buffer_out, buffer_in, out_start, out_end, in_start, in_end
 398         )
 399
 400
 401 class UART(Lockable):
 402     """
 403     Busio UART Class for CircuitPython Compatibility. Used
 404     for MicroPython and a few other non-Linux boards.
 405     """
 406
 407     class Parity(Enum):
 408         """Parity Enumeration"""
 409
 410         pass  # pylint: disable=unnecessary-pass
 411
 412     Parity.ODD = Parity()
 413     Parity.EVEN = Parity()
 414
 415     def __init__(
 416         self,
 417         tx,
 418         rx,
 419         baudrate=9600,
 420         bits=8,
 421         parity=None,
 422         stop=1,
 423         timeout=1000,
 424         receiver_buffer_size=64,
 425         flow=None,
 426     ):
 427         if detector.board.any_embedded_linux:
 428             raise RuntimeError(
 429                 "busio.UART not supported on this platform. Please use pyserial instead."
 430             )
 431         if detector.board.binho_nova:
 432             from adafruit_blinka.microcontroller.nova.uart import UART as _UART
 433         elif detector.board.greatfet_one:
 434             from adafruit_blinka.microcontroller.nxp_lpc4330.uart import UART as _UART
 435         elif detector.chip.id == ap_chip.RP2040:
 436             from adafruit_blinka.microcontroller.rp2040.uart import UART as _UART
 437         else:
 438             from machine import UART as _UART
 439
 440         from microcontroller.pin import uartPorts
 441
 442         self.baudrate = baudrate
 443
 444         if flow is not None:  # default 0
 445             raise NotImplementedError(
 446                 "Parameter '{}' unsupported on {}".format("flow", agnostic.board_id)
 447             )
 448
 449         # translate parity flag for Micropython
 450         if parity is UART.Parity.ODD:
 451             parity = 1
 452         elif parity is UART.Parity.EVEN:
 453             parity = 0
 454         elif parity is None:
 455             pass
 456         else:
 457             raise ValueError("Invalid parity")
 458
 459         if detector.chip.id == ap_chip.RP2040:
 460             self._uart = _UART(
 461                 tx,
 462                 rx,
 463                 baudrate=baudrate,
 464                 bits=bits,
 465                 parity=parity,
 466                 stop=stop,
 467             )
 468         else:
 469             # check tx and rx have hardware support
 470             for portId, portTx, portRx in uartPorts:  #
 471                 if portTx == tx and portRx == rx:
 472                     self._uart = _UART(
 473                         portId,
 474                         baudrate,
 475                         bits=bits,
 476                         parity=parity,
 477                         stop=stop,
 478                         timeout=timeout,
 479                         read_buf_len=receiver_buffer_size,
 480                     )
 481                     break
 482             else:
 483                 raise ValueError(
 484                     "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format(
 485                         (tx, rx), uartPorts
 486                     )
 487                 )
 488
 489     def deinit(self):
 490         """Deinitialization"""
 491         if detector.board.binho_nova:
 492             self._uart.deinit()
 493         self._uart = None
 494
 495     def read(self, nbytes=None):
 496         """Read from the UART"""
 497         return self._uart.read(nbytes)
 498
 499     def readinto(self, buf, nbytes=None):
 500         """Read from the UART into a buffer"""
 501         return self._uart.readinto(buf, nbytes)
 502
 503     def readline(self):
 504         """Read a line of characters up to a newline character from the UART"""
 505         return self._uart.readline()
 506
 507     def write(self, buf):
 508         """Write to the UART from a buffer"""
 509         return self._uart.write(buf)