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