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