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