src/busio.py

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