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