src/busio.py

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