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