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