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