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.board as ap_board
  15
  16 class I2C(Lockable):
  17     def __init__(self, scl, sda, frequency=400000):
  18         self.init(scl, sda, frequency)
  19
  20     def init(self, scl, sda, frequency):
  21         self.deinit()
  22         if detector.board.ftdi_ft232h:
  23             from adafruit_blinka.microcontroller.ft232h.i2c import I2C
  24             self._i2c = I2C()
  25             return
  26         elif detector.board.any_embedded_linux:
  27             from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
  28         else:
  29             from machine import I2C as _I2C
  30         from microcontroller.pin import i2cPorts
  31         busnum = None
  32         for portId, portScl, portSda in i2cPorts:
  33             try:
  34                 if scl == portScl and sda == portSda:
  35                     self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
  36                     busnum = portId
  37                     break
  38             except RuntimeError:
  39                 pass
  40         else:
  41             raise ValueError(
  42                 "No Hardware I2C on (scl,sda)={}\nValid I2C ports: {}".format((scl, sda), i2cPorts)
  43             )
  44
  45         self._lock = threading.RLock()
  46
  47     def deinit(self):
  48         try:
  49             del self._i2c
  50         except AttributeError:
  51             pass
  52
  53     def __enter__(self):
  54         self._lock.acquire()
  55         return self
  56
  57     def __exit__(self, exc_type, exc_value, traceback):
  58         self._lock.release()
  59         self.deinit()
  60
  61     def scan(self):
  62         return self._i2c.scan()
  63
  64     def readfrom_into(self, address, buffer, *, start=0, end=None):
  65         if start is not 0 or end is not None:
  66             if end is None:
  67                 end = len(buffer)
  68             buffer = memoryview(buffer)[start:end]
  69         stop = True  # remove for efficiency later
  70         return self._i2c.readfrom_into(address, buffer, stop=stop)
  71
  72     def writeto(self, address, buffer, *, start=0, end=None, stop=True):
  73         if isinstance(buffer, str):
  74             buffer = bytes([ord(x) for x in buffer])
  75         if start is not 0 or end is not None:
  76             if end is None:
  77                 return self._i2c.writeto(address, memoryview(buffer)[start:], stop=stop)
  78             else:
  79                 return self._i2c.writeto(address, memoryview(buffer)[start:end], stop=stop)
  80         return self._i2c.writeto(address, buffer, stop=stop)
  81
  82     def writeto_then_readfrom(self, address, buffer_out, buffer_in, *, out_start=0, out_end=None, in_start=0, in_end=None, stop=False):
  83         return self._i2c.writeto_then_readfrom(address, buffer_out, buffer_in,
  84                                                out_start=out_start, out_end=out_end,
  85                                                in_start=in_start, in_end=in_end, stop=stop)
  86
  87 class SPI(Lockable):
  88     def __init__(self, clock, MOSI=None, MISO=None):
  89         self.deinit()
  90         if detector.board.ftdi_ft232h:
  91             from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
  92             from adafruit_blinka.microcontroller.ft232h.pin import SCK, MOSI, MISO
  93             self._spi = _SPI()
  94             self._pins = (SCK, MOSI, MISO)
  95             return
  96         elif detector.board.any_embedded_linux:
  97             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
  98         else:
  99             from machine import SPI as _SPI
 100         from microcontroller.pin import spiPorts
 101         for portId, portSck, portMosi, portMiso in spiPorts:
 102             if ((clock == portSck) and                   # Clock is required!
 103                 (MOSI == portMosi or MOSI == None) and   # But can do with just output
 104                 (MISO == portMiso or MISO == None)):      # Or just input
 105                 self._spi = _SPI(portId)
 106                 self._pins = (portSck, portMosi, portMiso)
 107                 break
 108         else:
 109             raise ValueError(
 110                 "No Hardware SPI on (SCLK, MOSI, MISO)={}\nValid SPI ports:{}".
 111                 format((clock, MOSI, MISO), spiPorts))
 112
 113     def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
 114         if detector.board.any_raspberry_pi or detector.board.any_raspberry_pi_40_pin:
 115             from adafruit_blinka.microcontroller.bcm283x.pin import Pin
 116             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 117         elif detector.board.any_beaglebone:
 118             from adafruit_blinka.microcontroller.am335x.pin import Pin
 119             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 120         elif board_id == ap_board.ORANGE_PI_PC or board_id == ap_board.ORANGE_PI_R1 or board_id == ap_board.ORANGE_PI_ZERO:
 121             from adafruit_blinka.microcontroller.allwinner_h3.pin import Pin
 122             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 123         elif board_id == ap_board.GIANT_BOARD:
 124             from adafruit_blinka.microcontroller.sama5.pin import Pin
 125             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 126         elif board_id == ap_board.CORAL_EDGE_TPU_DEV:
 127             from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
 128             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 129         elif board_id == ap_board.ODROID_C2:
 130             from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
 131             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 132         elif board_id == ap_board.DRAGONBOARD_410C:
 133             from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
 134             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 135         elif board_id == ap_board.JETSON_NANO:
 136             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 137             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
 138         elif board_id == ap_board.JETSON_TX1:
 139             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 140             from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
 141         elif board_id == ap_board.JETSON_TX2:
 142             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 143             from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
 144         elif board_id == ap_board.JETSON_XAVIER:
 145             from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
 146             from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
 147         elif detector.board.ftdi_ft232h:
 148             from adafruit_blinka.microcontroller.ft232h.spi import SPI as _SPI
 149             from adafruit_blinka.microcontroller.ft232h.pin import Pin
 150         else:
 151             from machine import SPI as _SPI
 152             from machine import Pin
 153
 154         if self._locked:
 155             # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
 156             self._spi.init(
 157                 baudrate=baudrate,
 158                 polarity=polarity,
 159                 phase=phase,
 160                 bits=bits,
 161                 firstbit=_SPI.MSB,
 162                 sck=Pin(self._pins[0].id),
 163                 mosi=Pin(self._pins[1].id),
 164                 miso=Pin(self._pins[2].id)
 165             )
 166         else:
 167             raise RuntimeError("First call try_lock()")
 168
 169     def deinit(self):
 170         self._spi = None
 171         self._pinIds = None
 172
 173     @property
 174     def frequency(self):
 175         try:
 176             return self._spi.frequency
 177         except AttributeError:
 178             raise NotImplementedError("Frequency attribute not implemented for this platform")
 179
 180     def write(self, buf, start=0, end=None):
 181         return self._spi.write(buf, start, end)
 182
 183     def readinto(self, buf, start=0, end=None, write_value=0):
 184         return self._spi.readinto(buf, start, end, write_value=write_value)
 185
 186     def write_readinto(self, buffer_out, buffer_in,  out_start=0, out_end=None, in_start=0, in_end=None):
 187         return self._spi.write_readinto(buffer_out, buffer_in, out_start, out_end, in_start, in_end)
 188
 189
 190 class UART(Lockable):
 191     class Parity(Enum):
 192         pass
 193
 194     Parity.ODD = Parity()
 195     Parity.EVEN = Parity()
 196
 197     def __init__(self,
 198                  tx,
 199                  rx,
 200                  baudrate=9600,
 201                  bits=8,
 202                  parity=None,
 203                  stop=1,
 204                  timeout=1000,
 205                  receiver_buffer_size=64,
 206                  flow=None):
 207         if detector.board.any_embedded_linux:
 208             raise RuntimeError('busio.UART not supported on this platform. Please use pyserial instead.')
 209         else:
 210             from machine import UART as _UART
 211         from microcontroller.pin import uartPorts
 212
 213         self.baudrate = baudrate
 214
 215         if flow is not None:  # default 0
 216             raise NotImplementedError(
 217                 "Parameter '{}' unsupported on {}".format(
 218                     "flow", agnostic.board_id))
 219
 220         # translate parity flag for Micropython
 221         if parity is UART.Parity.ODD:
 222             parity = 1
 223         elif parity is UART.Parity.EVEN:
 224             parity = 0
 225         elif parity is None:
 226             pass
 227         else:
 228             raise ValueError("Invalid parity")
 229
 230         # check tx and rx have hardware support
 231         for portId, portTx, portRx in uartPorts:  #
 232             if portTx == tx and portRx == rx:
 233                 self._uart = _UART(
 234                     portId,
 235                     baudrate,
 236                     bits=bits,
 237                     parity=parity,
 238                     stop=stop,
 239                     timeout=timeout,
 240                     read_buf_len=receiver_buffer_size
 241                 )
 242                 break
 243         else:
 244             raise ValueError(
 245                 "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format((tx, rx), uartPorts)
 246             )
 247
 248     def deinit(self):
 249         self._uart = None
 250
 251     def read(self, nbytes=None):
 252         return self._uart.read(nbytes)
 253
 254     def readinto(self, buf, nbytes=None):
 255         return self._uart.readinto(buf, nbytes)
 256
 257     def readline(self):
 258         return self._uart.readline()
 259
 260     def write(self, buf):
 261         return self._uart.write(buf)