src/adafruit_blinka/microcontroller/rp2040_u2if/spi.py

   1 # SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
   2 #
   3 # SPDX-License-Identifier: MIT
   4 """SPI Classes for RP2040s with u2if firmware"""
   5 from .rp2040_u2if import rp2040_u2if
   6
   7 # pylint: disable=protected-access, no-self-use
   8 class SPI:
   9     """SPI Base Class for RP2040 u2if"""
  10
  11     MSB = 0
  12
  13     def __init__(self, index, *, baudrate=100000):
  14         self._index = index
  15         self._frequency = baudrate
  16         rp2040_u2if.spi_set_port(self._index)
  17         rp2040_u2if.spi_configure(self._frequency)
  18
  19     # pylint: disable=too-many-arguments,unused-argument
  20     def init(
  21         self,
  22         baudrate=1000000,
  23         polarity=0,
  24         phase=0,
  25         bits=8,
  26         firstbit=MSB,
  27         sck=None,
  28         mosi=None,
  29         miso=None,
  30     ):
  31         """Initialize the Port"""
  32         self._frequency = baudrate
  33         rp2040_u2if.spi_set_port(self._index)
  34         rp2040_u2if.spi_configure(self._frequency)
  35
  36     # pylint: enable=too-many-arguments
  37
  38     @property
  39     def frequency(self):
  40         """Return the current frequency"""
  41         return self._frequency
  42
  43     def write(self, buf, start=0, end=None):
  44         """Write data from the buffer to SPI"""
  45         rp2040_u2if.spi_write(buf, start=start, end=end)
  46
  47     def readinto(self, buf, start=0, end=None, write_value=0):
  48         """Read data from SPI and into the buffer"""
  49         rp2040_u2if.spi_readinto(buf, start=start, end=end, write_value=write_value)
  50
  51     # pylint: disable=too-many-arguments
  52     def write_readinto(
  53         self, buffer_out, buffer_in, out_start=0, out_end=None, in_start=0, in_end=None
  54     ):
  55         """Perform a half-duplex write from buffer_out and then
  56         read data into buffer_in
  57         """
  58         rp2040_u2if.spi_write_readinto(
  59             buffer_out,
  60             buffer_in,
  61             out_start=out_start,
  62             out_end=out_end,
  63             in_start=in_start,
  64             in_end=in_end,
  65         )
  66
  67     # pylint: enable=too-many-arguments
  68
  69
  70 class SPI_Pico(SPI):
  71     """SPI Class for Pico u2if"""
  72
  73     def __init__(self, clock, *, baudrate=100000):
  74         index = None
  75         if clock.id == 18:
  76             index = 0
  77         if clock.id == 10:
  78             index = 1
  79         if index is None:
  80             raise ValueError("No SPI port on specified pin.")
  81         super().__init__(index, baudrate=baudrate)
  82
  83
  84 class SPI_Feather(SPI):
  85     """SPI Class for Feather u2if"""
  86
  87     def __init__(self, clock, *, baudrate=100000):
  88         index = None
  89         if clock.id == 18:
  90             index = 0
  91         if index is None:
  92             raise ValueError("No SPI port on specified pin.")
  93         super().__init__(index, baudrate=baudrate)
  94
  95
  96 class SPI_QTPY(SPI):
  97     """SPI Class for QT Py u2if"""
  98
  99     def __init__(self, clock, *, baudrate=100000):
 100         index = None
 101         if clock.id == 6:
 102             index = 0
 103         if index is None:
 104             raise ValueError("No SPI port on specified pin.")
 105         super().__init__(index, baudrate=baudrate)
 106
 107
 108 class SPI_ItsyBitsy(SPI):
 109     """SPI Class for ItsyBitsy u2if"""
 110
 111     def __init__(self, clock, *, baudrate=100000):
 112         index = None
 113         if clock.id == 18:
 114             index = 0
 115         if index is None:
 116             raise ValueError("No SPI port on specified pin.")
 117         super().__init__(index, baudrate=baudrate)
 118
 119
 120 class SPI_MacroPad(SPI):
 121     """SPI Class for MacroPad u2if"""
 122
 123     def __init__(self, clock, *, baudrate=100000):
 124         index = None
 125         if clock.id == 26:
 126             index = 1
 127         if index is None:
 128             raise ValueError("No SPI port on specified pin.")
 129         super().__init__(index, baudrate=baudrate)