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 import threading
  11
  12 from adafruit_blinka import Enum, Lockable, agnostic
  13 from adafruit_blinka.agnostic import board_id, detector
  14 import adafruit_platformdetect.constants.boards as ap_board
  15 import adafruit_platformdetect.constants.chips as ap_chip
  16
  17
  18 class I2C(Lockable):
  19     def __init__(self, scl, sda, frequency=400000):
  20         self.init(scl, sda, frequency)
  21
  22     def init(self, scl, sda, frequency):
  23         self.deinit()
  24         if detector.board.ftdi_ft232h:
  25             from adafruit_blinka.microcontroller.ft232h.i2c import I2C
  26
  27             self._i2c = I2C(frequency=frequency)
  28             return
  29         elif detector.board.binho_nova:
  30             from adafruit_blinka.microcontroller.nova.i2c import I2C
  31
  32             self._i2c = I2C(frequency=frequency)
  33             return
  34         elif detector.board.microchip_mcp2221:
  35             from adafruit_blinka.microcontroller.mcp2221.i2c import I2C
  36
  37             self._i2c = I2C(frequency=frequency)
  38             return
  39         elif detector.board.any_embedded_linux:
  40             from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
  41         else:
  42             from machine import I2C as _I2C
  43         from microcontroller.pin import i2cPorts
  44
  45         for portId, portScl, portSda in i2cPorts:
  46             try:
  47                 if scl == portScl and sda == portSda:
  48                     self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
  49                     break
  50             except RuntimeError:
  51                 pass
  52         else:
  53             raise ValueError(
  54                 "No Hardware I2C on (scl,sda)={}\nValid I2C ports: {}".format(
  55                     (scl, sda), i2cPorts
  56                 )
  57             )
  58
  59         self._lock = threading.RLock()
  60
  61     def deinit(self):
  62         try:
  63             del self._i2c
  64         except AttributeError:
  65             pass
  66
  67     def __enter__(self):
  68         self._lock.acquire()
  69         return self
  70
  71     def __exit__(self, exc_type, exc_value, traceback):
  72         self._lock.release()
  73         self.deinit()
  74
  75     def scan(self):
  76         return self._i2c.scan()
  77
  78     def readfrom_into(self, address, buffer, *, start=0, end=None):
  79         if start != 0 or end is not None:
  80             if end is None:
  81                 end = len(buffer)
  82             buffer = memoryview(buffer)[start:end]
  83         stop = True  # remove for efficiency later
  84         return self._i2c.readfrom_into(address, buffer, stop=stop)
  85
  86     def writeto(self, address, buffer, *, start=0, end=None, stop=True):
  87         if isinstance(buffer, str):
  88             buffer = bytes([ord(x) for x in buffer])
  89         if start != 0 or end is not None:
  90             if end is None:
  91                 return self._i2c.writeto(address, memoryview(buffer)[start:], stop=stop)
  92             else:
  93                 return self._i2c.writeto(
  94                     address, memoryview(buffer)[start:end], stop=stop
  95                 )
  96         return self._i2c.writeto(address, buffer, stop=stop)
  97
  98     def writeto_then_readfrom(
  99         self,
 100         address,
 101         buffer_out,
 102         buffer_in,
 103         *,
 104         out_start=0,
 105         out_end=None,
 106         in_start=0,
 107         in_end=None,
 108         stop=False
 109     ):
 110         return self._i2c.writeto_then_readfrom(
 111             address,
 112             buffer_out,
 113             buffer_in,
 114             out_start=out_start,
 115             out_end=out_end,
 116             in_start=in_start,
 117             in_end=in_end,
 118             stop=stop,
 119         )
 120
 121
 122 class SPI(Lockable):
 123     def __init__(self, clock, MOSI=None, MISO=None):
 124         self.deinit()
 125         if detector.board.ftdi_ft232h:
 126             from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
 127             from adafruit_blinka.microcontroller.ft232h.pin import SCK, MOSI, MISO
 128
 129             self._spi = _SPI()
 130             self._pins = (SCK, MOSI, MISO)
 131             return
 132         elif detector.board.binho_nova:
 133             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
 134             from adafruit_blinka.microcontroller.nova.pin import SCK, MOSI, MISO
 135
 136             self._spi = _SPI(clock)
 137             self._pins = (SCK, MOSI, MISO)
 138             return
 139         elif detector.board.any_embedded_linux:
 140             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 141         else:
 142             from machine import SPI as _SPI
 143         from microcontroller.pin import spiPorts
 144
 145         for portId, portSck, portMosi, portMiso in spiPorts:
 146             if (
 147                 (clock == portSck)
 148                 and (MOSI == portMosi or MOSI == None)  # Clock is required!
 149                 and (MISO == portMiso or MISO == None)  # But can do with just output
 150             ):  # Or just input
 151                 self._spi = _SPI(portId)
 152                 self._pins = (portSck, portMosi, portMiso)
 153                 break
 154         else:
 155             raise ValueError(
 156                 "No Hardware SPI on (SCLK, MOSI, MISO)={}\nValid SPI ports:{}".format(
 157                     (clock, MOSI, MISO), spiPorts
 158                 )
 159             )
 160
 161     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
 162         if detector.board.any_raspberry_pi or detector.board.any_raspberry_pi_40_pin:
 163             from adafruit_blinka.microcontroller.bcm283x.pin import Pin
 164             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 165         elif detector.board.any_beaglebone:
 166             from adafruit_blinka.microcontroller.am335x.pin import Pin
 167             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 168         elif detector.board.any_orange_pi and detector.chip.id == ap_chip.SUN8I:
 169             from adafruit_blinka.microcontroller.allwinner.h3.pin import Pin
 170             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 171         elif board_id == ap_board.GIANT_BOARD:
 172             from adafruit_blinka.microcontroller.sama5.pin import Pin
 173             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 174         elif board_id == ap_board.CORAL_EDGE_TPU_DEV:
 175             from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
 176             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 177         elif board_id == ap_board.ODROID_C2:
 178             from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
 179             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 180         elif board_id == ap_board.ODROID_C4:
 181             from adafruit_blinka.microcontroller.amlogic.s905x3.pin import Pin
 182             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 183         elif board_id == ap_board.DRAGONBOARD_410C:
 184             from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
 185             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 186         elif board_id == ap_board.JETSON_NANO:
 187             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 188             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
 189         elif board_id == ap_board.JETSON_TX1:
 190             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 191             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
 192         elif board_id == ap_board.JETSON_TX2:
 193             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 194             from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
 195         elif board_id == ap_board.JETSON_XAVIER:
 196             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 197             from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
 198         elif board_id == ap_board.JETSON_NX:
 199             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 200             from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
 201         elif detector.board.SIFIVE_UNLEASHED:
 202             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 203             from adafruit_blinka.microcontroller.hfu540.pin import Pin
 204         elif detector.board.ftdi_ft232h:
 205             from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
 206             from adafruit_blinka.microcontroller.ft232h.pin import Pin
 207         elif detector.board.binho_nova:
 208             from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
 209             from adafruit_blinka.microcontroller.nova.pin import Pin
 210         elif (
 211             board_id == ap_board.PINE64
 212             or board_id == ap_board.PINEBOOK
 213             or board_id == ap_board.PINEPHONE
 214         ):
 215             from adafruit_blinka.microcontroller.allwinner.a64.pin import Pin
 216             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 217         elif board_id == ap_board.CLOCKWORK_CPI3:
 218             from adafruit_blinka.microcontroller.allwinner.a33.pin import Pin
 219             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 220         elif board_id == ap_board.ONION_OMEGA2:
 221             from adafruit_blinka.microcontroller.mips24kec.pin import Pin
 222             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 223         else:
 224             from machine import SPI as _SPI
 225             from machine import Pin
 226
 227         if self._locked:
 228             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
 229             self._spi.init(
 230                 baudrate=baudrate,
 231                 polarity=polarity,
 232                 phase=phase,
 233                 bits=bits,
 234                 firstbit=_SPI.MSB,
 235                 sck=Pin(self._pins[0].id),
 236                 mosi=Pin(self._pins[1].id),
 237                 miso=Pin(self._pins[2].id),
 238             )
 239         else:
 240             raise RuntimeError("First call try_lock()")
 241
 242     def deinit(self):
 243         self._spi = None
 244         self._pinIds = None
 245
 246     @property
 247     def frequency(self):
 248         try:
 249             return self._spi.frequency
 250         except AttributeError:
 251             raise NotImplementedError(
 252                 "Frequency attribute not implemented for this platform"
 253             )
 254
 255     def write(self, buf, start=0, end=None):
 256         return self._spi.write(buf, start, end)
 257
 258     def readinto(self, buf, start=0, end=None, write_value=0):
 259         return self._spi.readinto(buf, start, end, write_value=write_value)
 260
 261     def write_readinto(
 262         self, buffer_out, buffer_in, out_start=0, out_end=None, in_start=0, in_end=None
 263     ):
 264         return self._spi.write_readinto(
 265             buffer_out, buffer_in, out_start, out_end, in_start, in_end
 266         )
 267
 268
 269 class UART(Lockable):
 270     class Parity(Enum):
 271         pass
 272
 273     Parity.ODD = Parity()
 274     Parity.EVEN = Parity()
 275
 276     def __init__(
 277         self,
 278         tx,
 279         rx,
 280         baudrate=9600,
 281         bits=8,
 282         parity=None,
 283         stop=1,
 284         timeout=1000,
 285         receiver_buffer_size=64,
 286         flow=None,
 287     ):
 288         if detector.board.any_embedded_linux:
 289             raise RuntimeError(
 290                 "busio.UART not supported on this platform. Please use pyserial instead."
 291             )
 292         elif detector.board.binho_nova:
 293             from adafruit_blinka.microcontroller.nova.uart import UART as _UART
 294         else:
 295             from machine import UART as _UART
 296
 297         if detector.board.binho_nova:
 298             from adafruit_blinka.microcontroller.nova.pin import uartPorts
 299         else:
 300             from microcontroller.pin import uartPorts
 301
 302         self.baudrate = baudrate
 303
 304         if flow is not None:  # default 0
 305             raise NotImplementedError(
 306                 "Parameter '{}' unsupported on {}".format("flow", agnostic.board_id)
 307             )
 308
 309         # translate parity flag for Micropython
 310         if parity is UART.Parity.ODD:
 311             parity = 1
 312         elif parity is UART.Parity.EVEN:
 313             parity = 0
 314         elif parity is None:
 315             pass
 316         else:
 317             raise ValueError("Invalid parity")
 318
 319         # check tx and rx have hardware support
 320         for portId, portTx, portRx in uartPorts:  #
 321             if portTx == tx and portRx == rx:
 322                 self._uart = _UART(
 323                     portId,
 324                     baudrate,
 325                     bits=bits,
 326                     parity=parity,
 327                     stop=stop,
 328                     timeout=timeout,
 329                     read_buf_len=receiver_buffer_size,
 330                 )
 331                 break
 332         else:
 333             raise ValueError(
 334                 "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format(
 335                     (tx, rx), uartPorts
 336                 )
 337             )
 338
 339     def deinit(self):
 340         if detector.board.binho_nova:
 341             self._uart.deinit()
 342         self._uart = None
 343
 344     def read(self, nbytes=None):
 345         return self._uart.read(nbytes)
 346
 347     def readinto(self, buf, nbytes=None):
 348         return self._uart.readinto(buf, nbytes)
 349
 350     def readline(self):
 351         return self._uart.readline()
 352
 353     def write(self, buf):
 354         return self._uart.write(buf)