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