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