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