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