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