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