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=400000):
  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.any_beaglebone:
 202             from adafruit_blinka.microcontroller.am335x.pin import Pin
 203             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 204         elif detector.board.any_orange_pi and detector.chip.id == ap_chip.SUN8I:
 205             from adafruit_blinka.microcontroller.allwinner.h3.pin import Pin
 206             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 207         elif board_id == ap_board.GIANT_BOARD:
 208             from adafruit_blinka.microcontroller.sama5.pin import Pin
 209             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 210         elif board_id == ap_board.CORAL_EDGE_TPU_DEV:
 211             from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
 212             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 213         elif board_id == ap_board.ODROID_C2:
 214             from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
 215             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 216         elif board_id == ap_board.ODROID_C4:
 217             from adafruit_blinka.microcontroller.amlogic.s905x3.pin import Pin
 218             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 219         elif board_id == ap_board.ODROID_XU4:
 220             from adafruit_blinka.microcontroller.samsung.exynos5422.pin import Pin
 221             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 222         elif board_id == ap_board.DRAGONBOARD_410C:
 223             from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
 224             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 225         elif board_id == ap_board.JETSON_NANO:
 226             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 227             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
 228         elif board_id == ap_board.JETSON_TX1:
 229             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 230             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
 231         elif board_id == ap_board.JETSON_TX2:
 232             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 233             from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
 234         elif board_id == ap_board.JETSON_XAVIER:
 235             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 236             from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
 237         elif board_id == ap_board.JETSON_NX:
 238             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 239             from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
 240         elif detector.board.ROCK_PI_S:
 241             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 242             from adafruit_blinka.microcontroller.rockchip.rk3308.pin import Pin
 243         elif detector.board.SIFIVE_UNLEASHED:
 244             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 245             from adafruit_blinka.microcontroller.hfu540.pin import Pin
 246         elif detector.board.ftdi_ft232h:
 247             from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
 248             from adafruit_blinka.microcontroller.ft232h.pin import Pin
 249         elif detector.board.binho_nova:
 250             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
 251             from adafruit_blinka.microcontroller.nova.pin import Pin
 252         elif detector.board.greatfet_one:
 253             from adafruit_blinka.microcontroller.nxp_lpc4330.spi import SPI as _SPI
 254             from adafruit_blinka.microcontroller.nxp_lpc4330.pin import Pin
 255         elif board_id in (
 256             ap_board.PINE64,
 257             ap_board.PINEBOOK,
 258             ap_board.PINEPHONE,
 259             ap_board.SOPINE,
 260         ):
 261             from adafruit_blinka.microcontroller.allwinner.a64.pin import Pin
 262             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 263         elif board_id == ap_board.CLOCKWORK_CPI3:
 264             from adafruit_blinka.microcontroller.allwinner.a33.pin import Pin
 265             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 266         elif board_id == ap_board.ONION_OMEGA2:
 267             from adafruit_blinka.microcontroller.mips24kec.pin import Pin
 268             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 269         else:
 270             from machine import SPI as _SPI
 271             from machine import Pin
 272
 273         if self._locked:
 274             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
 275             self._spi.init(
 276                 baudrate=baudrate,
 277                 polarity=polarity,
 278                 phase=phase,
 279                 bits=bits,
 280                 firstbit=_SPI.MSB,
 281                 sck=Pin(self._pins[0].id),
 282                 mosi=Pin(self._pins[1].id),
 283                 miso=Pin(self._pins[2].id),
 284             )
 285         else:
 286             raise RuntimeError("First call try_lock()")
 287
 288     def deinit(self):
 289         """Deinitialization"""
 290         self._spi = None
 291         self._pinIds = None
 292
 293     @property
 294     def frequency(self):
 295         """Return the baud rate if implemented"""
 296         try:
 297             return self._spi.frequency
 298         except AttributeError:
 299             raise NotImplementedError(
 300                 "Frequency attribute not implemented for this platform"
 301             ) from AttributeError
 302
 303     def write(self, buf, start=0, end=None):
 304         """Write to the SPI device"""
 305         return self._spi.write(buf, start, end)
 306
 307     def readinto(self, buf, start=0, end=None, write_value=0):
 308         """Read from the SPI device into a buffer"""
 309         return self._spi.readinto(buf, start, end, write_value=write_value)
 310
 311     def write_readinto(
 312         self, buffer_out, buffer_in, out_start=0, out_end=None, in_start=0, in_end=None
 313     ):
 314         """Write to the SPI device and read from the SPI device into a buffer"""
 315         return self._spi.write_readinto(
 316             buffer_out, buffer_in, out_start, out_end, in_start, in_end
 317         )
 318
 319
 320 class UART(Lockable):
 321     """
 322     Busio UART Class for CircuitPython Compatibility. Used
 323     for MicroPython and a few other non-Linux boards.
 324     """
 325
 326     class Parity(Enum):
 327         """Parity Enumeration"""
 328
 329         pass  # pylint: disable=unnecessary-pass
 330
 331     Parity.ODD = Parity()
 332     Parity.EVEN = Parity()
 333
 334     def __init__(
 335         self,
 336         tx,
 337         rx,
 338         baudrate=9600,
 339         bits=8,
 340         parity=None,
 341         stop=1,
 342         timeout=1000,
 343         receiver_buffer_size=64,
 344         flow=None,
 345     ):
 346         if detector.board.any_embedded_linux:
 347             raise RuntimeError(
 348                 "busio.UART not supported on this platform. Please use pyserial instead."
 349             )
 350         if detector.board.binho_nova:
 351             from adafruit_blinka.microcontroller.nova.uart import UART as _UART
 352         elif detector.board.greatfet_one:
 353             from adafruit_blinka.microcontroller.nxp_lpc4330.uart import UART as _UART
 354         else:
 355             from machine import UART as _UART
 356
 357         if detector.board.binho_nova:
 358             from adafruit_blinka.microcontroller.nova.pin import uartPorts
 359         else:
 360             from microcontroller.pin import uartPorts
 361
 362         self.baudrate = baudrate
 363
 364         if flow is not None:  # default 0
 365             raise NotImplementedError(
 366                 "Parameter '{}' unsupported on {}".format("flow", agnostic.board_id)
 367             )
 368
 369         # translate parity flag for Micropython
 370         if parity is UART.Parity.ODD:
 371             parity = 1
 372         elif parity is UART.Parity.EVEN:
 373             parity = 0
 374         elif parity is None:
 375             pass
 376         else:
 377             raise ValueError("Invalid parity")
 378
 379         # check tx and rx have hardware support
 380         for portId, portTx, portRx in uartPorts:  #
 381             if portTx == tx and portRx == rx:
 382                 self._uart = _UART(
 383                     portId,
 384                     baudrate,
 385                     bits=bits,
 386                     parity=parity,
 387                     stop=stop,
 388                     timeout=timeout,
 389                     read_buf_len=receiver_buffer_size,
 390                 )
 391                 break
 392         else:
 393             raise ValueError(
 394                 "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format(
 395                     (tx, rx), uartPorts
 396                 )
 397             )
 398
 399     def deinit(self):
 400         """Deinitialization"""
 401         if detector.board.binho_nova:
 402             self._uart.deinit()
 403         self._uart = None
 404
 405     def read(self, nbytes=None):
 406         """Read from the UART"""
 407         return self._uart.read(nbytes)
 408
 409     def readinto(self, buf, nbytes=None):
 410         """Read from the UART into a buffer"""
 411         return self._uart.readinto(buf, nbytes)
 412
 413     def readline(self):
 414         """Read a line of characters up to a newline charater from the UART"""
 415         return self._uart.readline()
 416
 417     def write(self, buf):
 418         """Write to the UART from a buffer"""
 419         return self._uart.write(buf)
 420
 421
 422 class OneWire:
 423     """
 424     Stub class for OneWire, which is currently not implemented
 425     """
 426
 427     def __init__(self, pin):
 428         raise NotImplementedError("OneWire has not been implemented")
 429
 430     def deinit(self):
 431         """
 432         Deinitialize the OneWire bus and release any hardware resources for reuse.
 433         """
 434         raise NotImplementedError("OneWire has not been implemented")
 435
 436     def reset(self):
 437         """
 438         Reset the OneWire bus and read presence
 439         """
 440         raise NotImplementedError("OneWire has not been implemented")
 441
 442     def read_bit(self):
 443         """
 444         Read in a bit
 445         """
 446         raise NotImplementedError("OneWire has not been implemented")
 447
 448     def write_bit(self, value):
 449         """
 450         Write out a bit based on value.
 451         """
 452         raise NotImplementedError("OneWire has not been implemented")