1 # SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
3 # SPDX-License-Identifier: MIT
5 `busio` - Bus protocol support like I2C and SPI
6 =================================================
8 See `CircuitPython:busio` in CircuitPython for more details.
17 # pylint: disable=unused-import
18 import adafruit_platformdetect.constants.boards as ap_board
19 import adafruit_platformdetect.constants.chips as ap_chip
20 from adafruit_blinka import Enum, Lockable, agnostic
21 from adafruit_blinka.agnostic import board_id, detector
23 # pylint: disable=import-outside-toplevel,too-many-branches,too-many-statements
24 # pylint: disable=too-many-arguments,too-many-function-args,too-many-return-statements
29 Busio I2C Class for CircuitPython Compatibility. Used
30 for both MicroPython and Linux.
32 NOTE: Frequency has no effect on Linux systems. The argument is only there for compatibility.
35 def __init__(self, scl, sda, frequency=100000):
36 self.init(scl, sda, frequency)
38 def init(self, scl, sda, frequency):
41 if detector.board.ftdi_ft232h:
42 from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.i2c import I2C as _I2C
44 self._i2c = _I2C(frequency=frequency)
46 if detector.board.binho_nova:
47 from adafruit_blinka.microcontroller.nova.i2c import I2C as _I2C
49 self._i2c = _I2C(frequency=frequency)
51 if detector.board.microchip_mcp2221:
52 from adafruit_blinka.microcontroller.mcp2221.i2c import I2C as _I2C
54 self._i2c = _I2C(frequency=frequency)
57 if detector.board.OS_AGNOSTIC_BOARD:
58 from adafruit_blinka.microcontroller.generic_agnostic_board.i2c import (
62 self._i2c = _I2C(frequency=frequency)
65 if detector.board.greatfet_one:
66 from adafruit_blinka.microcontroller.nxp_lpc4330.i2c import I2C as _I2C
68 self._i2c = _I2C(frequency=frequency)
70 if detector.board.pico_u2if:
71 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import I2C_Pico as _I2C
73 self._i2c = _I2C(scl, sda, frequency=frequency)
75 if detector.board.feather_u2if:
76 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
80 self._i2c = _I2C(scl, sda, frequency=frequency)
82 if detector.board.feather_can_u2if:
83 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
84 I2C_Feather_CAN as _I2C,
87 self._i2c = _I2C(scl, sda, frequency=frequency)
89 if detector.board.feather_epd_u2if:
90 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
91 I2C_Feather_EPD as _I2C,
94 self._i2c = _I2C(scl, sda, frequency=frequency)
96 if detector.board.feather_rfm_u2if:
97 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
98 I2C_Feather_RFM as _I2C,
101 self._i2c = _I2C(scl, sda, frequency=frequency)
103 if detector.board.qtpy_u2if:
104 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import I2C_QTPY as _I2C
106 self._i2c = _I2C(scl, sda, frequency=frequency)
108 if detector.board.itsybitsy_u2if:
109 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
110 I2C_ItsyBitsy as _I2C,
113 self._i2c = _I2C(scl, sda, frequency=frequency)
115 if detector.board.macropad_u2if:
116 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
117 I2C_MacroPad as _I2C,
120 self._i2c = _I2C(scl, sda, frequency=frequency)
122 if detector.board.qt2040_trinkey_u2if:
123 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
124 I2C_QT2040_Trinkey as _I2C,
127 self._i2c = _I2C(scl, sda, frequency=frequency)
129 if detector.board.kb2040_u2if:
130 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
134 self._i2c = _I2C(scl, sda, frequency=frequency)
136 if detector.board.radxa_x4_u2if:
137 from adafruit_blinka.microcontroller.rp2040_u2if.i2c import (
138 I2C_Radxa_X4 as _I2C,
141 self._i2c = _I2C(scl, sda, frequency=frequency)
143 if detector.chip.id == ap_chip.RP2040:
144 from adafruit_blinka.microcontroller.rp2040.i2c import I2C as _I2C
146 self._i2c = _I2C(scl, sda, frequency=frequency)
148 if detector.board.any_siemens_iot2000:
149 from adafruit_blinka.microcontroller.am65xx.i2c import I2C as _I2C
151 self._i2c = _I2C(frequency=frequency)
154 if detector.board.any_embedded_linux:
155 from adafruit_blinka.microcontroller.generic_linux.i2c import I2C as _I2C
157 if frequency == 100000:
158 frequency = None # Set to None if default to avoid triggering warning
159 elif detector.board.ftdi_ft2232h:
160 from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.i2c import I2C as _I2C
161 elif detector.board.ftdi_ft4232h:
162 from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.i2c import I2C as _I2C
164 from adafruit_blinka.microcontroller.generic_micropython.i2c import (
167 from microcontroller.pin import i2cPorts
169 for portId, portScl, portSda in i2cPorts:
171 # pylint: disable=unexpected-keyword-arg
172 if scl == portScl and sda == portSda:
173 self._i2c = _I2C(portId, mode=_I2C.MASTER, baudrate=frequency)
175 # pylint: enable=unexpected-keyword-arg
180 "No Hardware I2C on (scl,sda)={}\nValid I2C ports: {}".format(
184 if threading is not None:
185 self._lock = threading.RLock()
188 """Deinitialization"""
191 except AttributeError:
195 if threading is not None:
199 def __exit__(self, exc_type, exc_value, traceback):
200 if threading is not None:
205 """Scan for attached devices"""
206 return self._i2c.scan()
208 def readfrom_into(self, address, buffer, *, start=0, end=None):
209 """Read from a device at specified address into a buffer"""
210 if start != 0 or end is not None:
213 buffer = memoryview(buffer)[start:end]
214 return self._i2c.readfrom_into(address, buffer, stop=True)
216 def writeto(self, address, buffer, *, start=0, end=None):
217 """Write to a device at specified address from a buffer"""
218 if isinstance(buffer, str):
219 buffer = bytes([ord(x) for x in buffer])
220 if start != 0 or end is not None:
222 return self._i2c.writeto(address, memoryview(buffer)[start:], stop=True)
223 return self._i2c.writeto(address, memoryview(buffer)[start:end], stop=True)
224 return self._i2c.writeto(address, buffer, stop=True)
226 def writeto_then_readfrom(
238 """ "Write to a device at specified address from a buffer then read
239 from a device at specified address into a buffer
241 return self._i2c.writeto_then_readfrom(
255 Busio SPI Class for CircuitPython Compatibility. Used
256 for both MicroPython and Linux.
259 def __init__(self, clock, MOSI=None, MISO=None):
261 if detector.board.ftdi_ft232h:
262 from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import SPI as _SPI
263 from adafruit_blinka.microcontroller.ftdi_mpsse.ft232h.pin import (
270 self._pins = (SCK, MOSI, MISO)
272 if detector.board.binho_nova:
273 from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
274 from adafruit_blinka.microcontroller.nova.pin import SCK, MOSI, MISO
276 self._spi = _SPI(clock)
277 self._pins = (SCK, MOSI, MISO)
279 if detector.board.greatfet_one:
280 from adafruit_blinka.microcontroller.nxp_lpc4330.spi import SPI as _SPI
281 from adafruit_blinka.microcontroller.nxp_lpc4330.pin import SCK, MOSI, MISO
284 self._pins = (SCK, MOSI, MISO)
286 if detector.board.pico_u2if:
287 from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_Pico as _SPI
289 self._spi = _SPI(clock) # this is really all that's needed
290 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
292 if detector.board.feather_u2if:
293 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
297 self._spi = _SPI(clock) # this is really all that's needed
298 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
300 if detector.board.feather_can_u2if:
301 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
302 SPI_Feather_CAN as _SPI,
305 self._spi = _SPI(clock) # this is really all that's needed
306 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
308 if detector.board.feather_epd_u2if:
309 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
310 SPI_Feather_EPD as _SPI,
313 self._spi = _SPI(clock) # this is really all that's needed
314 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
316 if detector.board.feather_rfm_u2if:
317 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
318 SPI_Feather_RFM as _SPI,
321 self._spi = _SPI(clock) # this is really all that's needed
322 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
324 if detector.board.itsybitsy_u2if:
325 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
326 SPI_ItsyBitsy as _SPI,
329 self._spi = _SPI(clock) # this is really all that's needed
330 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
332 if detector.board.macropad_u2if:
333 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
334 SPI_MacroPad as _SPI,
337 self._spi = _SPI(clock) # this is really all that's needed
338 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
340 if detector.board.qtpy_u2if:
341 from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_QTPY as _SPI
343 self._spi = _SPI(clock) # this is really all that's needed
344 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
346 if detector.board.kb2040_u2if:
347 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
351 self._spi = _SPI(clock) # this is really all that's needed
352 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
354 if detector.board.radxa_x4_u2if:
355 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
356 SPI_Radxa_X4 as _SPI,
359 self._spi = _SPI(clock) # this is really all that's needed
360 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
362 if detector.chip.id == ap_chip.RP2040:
363 from adafruit_blinka.microcontroller.rp2040.spi import SPI as _SPI
365 self._spi = _SPI(clock, MOSI, MISO) # Pins configured on instantiation
366 self._pins = (clock, clock, clock) # These don't matter, they're discarded
368 if detector.board.any_siemens_iot2000:
369 from adafruit_blinka.microcontroller.am65xx.spi import SPI as _SPI
371 self._spi = _SPI(clock) # this is really all that's needed
372 self._pins = (clock, clock, clock) # will determine MOSI/MISO from clock
374 if detector.board.any_embedded_linux:
375 from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
376 elif detector.board.ftdi_ft2232h:
377 from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import SPI as _SPI
378 elif detector.board.ftdi_ft4232h:
379 from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import SPI as _SPI
380 elif detector.board.OS_AGNOSTIC_BOARD:
381 from adafruit_blinka.microcontroller.generic_agnostic_board.spi import (
385 from adafruit_blinka.microcontroller.generic_micropython.spi import (
388 from microcontroller.pin import spiPorts
390 for portId, portSck, portMosi, portMiso in spiPorts:
393 and MOSI in (portMosi, None) # Clock is required!
394 and MISO in (portMiso, None) # But can do with just output
396 self._spi = _SPI(portId)
397 self._pins = (portSck, portMosi, portMiso)
401 "No Hardware SPI on (SCLK, MOSI, MISO)={}\nValid SPI ports:{}".format(
402 (clock, MOSI, MISO), spiPorts
406 def configure(self, baudrate=100000, polarity=0, phase=0, bits=8):
407 """Update the configuration"""
408 if detector.board.any_nanopi and detector.chip.id == ap_chip.SUN8I:
409 from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
410 elif detector.board.ftdi_ft232h:
411 from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import (
414 elif detector.board.ftdi_ft2232h:
415 from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import (
418 elif detector.board.ftdi_ft4232h:
419 from adafruit_blinka.microcontroller.ftdi_mpsse.mpsse.spi import (
422 elif detector.board.binho_nova:
423 from adafruit_blinka.microcontroller.nova.spi import SPI as _SPI
424 elif detector.board.greatfet_one:
425 from adafruit_blinka.microcontroller.nxp_lpc4330.spi import SPI as _SPI
426 elif detector.board.any_lubancat and detector.chip.id == ap_chip.IMX6ULL:
427 from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
428 elif detector.board.pico_u2if:
429 from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_Pico as _SPI
430 elif detector.board.feather_u2if:
431 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
434 elif detector.board.feather_can_u2if:
435 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
436 SPI_Feather_CAN as _SPI,
438 elif detector.board.feather_epd_u2if:
439 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
440 SPI_Feather_EPD as _SPI,
442 elif detector.board.feather_rfm_u2if:
443 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
444 SPI_Feather_RFM as _SPI,
446 elif detector.board.itsybitsy_u2if:
447 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
448 SPI_ItsyBitsy as _SPI,
450 elif detector.board.macropad_u2if:
451 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
452 SPI_MacroPad as _SPI,
454 elif detector.board.kb2040_u2if:
455 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
458 elif detector.board.qtpy_u2if:
459 from adafruit_blinka.microcontroller.rp2040_u2if.spi import SPI_QTPY as _SPI
460 elif detector.board.radxa_x4_u2if:
461 from adafruit_blinka.microcontroller.rp2040_u2if.spi import (
462 SPI_Radxa_X4 as _SPI,
464 elif detector.chip.id == ap_chip.RP2040:
465 from adafruit_blinka.microcontroller.rp2040.spi import SPI as _SPI
466 elif detector.board.any_siemens_iot2000:
467 from adafruit_blinka.microcontroller.am65xx.spi import SPI as _SPI
468 from adafruit_blinka.microcontroller.am65xx.pin import Pin
469 elif detector.board.any_embedded_linux:
470 from adafruit_blinka.microcontroller.generic_linux.spi import SPI as _SPI
471 elif detector.board.OS_AGNOSTIC_BOARD:
472 from adafruit_blinka.microcontroller.generic_agnostic_board.spi import (
476 from adafruit_blinka.microcontroller.generic_micropython.spi import (
481 # TODO check if #init ignores MOSI=None rather than unsetting, to save _pinIds attribute
490 raise RuntimeError("First call try_lock()")
493 """Deinitialization"""
499 """Return the baud rate if implemented"""
501 return self._spi.frequency
502 except AttributeError as error:
503 raise NotImplementedError(
504 "Frequency attribute not implemented for this platform"
507 def write(self, buf, start=0, end=None):
508 """Write to the SPI device"""
509 return self._spi.write(buf, start, end)
511 def readinto(self, buf, start=0, end=None, write_value=0):
512 """Read from the SPI device into a buffer"""
513 return self._spi.readinto(buf, start, end, write_value=write_value)
516 self, buffer_out, buffer_in, out_start=0, out_end=None, in_start=0, in_end=None
518 """Write to the SPI device and read from the SPI device into a buffer"""
519 return self._spi.write_readinto(
520 buffer_out, buffer_in, out_start, out_end, in_start, in_end
524 class UART(Lockable):
526 Busio UART Class for CircuitPython Compatibility. Used
527 for MicroPython and a few other non-Linux boards.
531 """Parity Enumeration"""
533 pass # pylint: disable=unnecessary-pass
535 Parity.ODD = Parity()
536 Parity.EVEN = Parity()
547 receiver_buffer_size=64,
550 if detector.board.any_embedded_linux:
552 "busio.UART not supported on this platform. Please use pyserial instead."
554 if detector.board.binho_nova:
555 from adafruit_blinka.microcontroller.nova.uart import UART as _UART
556 elif detector.board.greatfet_one:
557 from adafruit_blinka.microcontroller.nxp_lpc4330.uart import UART as _UART
558 elif detector.chip.id == ap_chip.RP2040:
559 from adafruit_blinka.microcontroller.rp2040.uart import UART as _UART
561 from machine import UART as _UART
563 from microcontroller.pin import uartPorts
565 self.baudrate = baudrate
567 if flow is not None: # default 0
568 raise NotImplementedError(
569 "Parameter '{}' unsupported on {}".format("flow", agnostic.board_id)
572 # translate parity flag for Micropython
573 if parity is UART.Parity.ODD:
575 elif parity is UART.Parity.EVEN:
580 raise ValueError("Invalid parity")
582 if detector.chip.id == ap_chip.RP2040:
592 # check tx and rx have hardware support
593 for portId, portTx, portRx in uartPorts: #
594 if portTx == tx and portRx == rx:
602 read_buf_len=receiver_buffer_size,
607 "No Hardware UART on (tx,rx)={}\nValid UART ports: {}".format(
613 """Deinitialization"""
614 if detector.board.binho_nova:
618 def read(self, nbytes=None):
619 """Read from the UART"""
620 return self._uart.read(nbytes)
622 def readinto(self, buf, nbytes=None):
623 """Read from the UART into a buffer"""
624 return self._uart.readinto(buf, nbytes)
627 """Read a line of characters up to a newline character from the UART"""
628 return self._uart.readline()
630 def write(self, buf):
631 """Write to the UART from a buffer"""
632 return self._uart.write(buf)