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 class SPI_Pico(SPI):
  70     """SPI Class for Pico u2if"""
  71
  72     def __init__(self, clock, *, baudrate=100000):
  73         index = None
  74         if clock.id == 18:
  75             index = 0
  76         if clock.id == 10:
  77             index = 1
  78         if index is None:
  79             raise ValueError("No SPI port on specified pin.")
  80         super().__init__(index, baudrate=baudrate)
  81
  82
  83 class SPI_Feather(SPI):
  84     """SPI Class for Feather u2if"""
  85
  86     def __init__(self, clock, *, baudrate=100000):
  87         index = None
  88         if clock.id == 18:
  89             index = 0
  90         if index is None:
  91             raise ValueError("No SPI port on specified pin.")
  92         super().__init__(index, baudrate=baudrate)
  93
  94 class SPI_Feather_CAN(SPI):
  95     """SPI Class for Feather EPD u2if"""
  96
  97     def __init__(self, clock, *, baudrate=100000):
  98         index = None
  99         if clock.id == 14:
 100             index = 1
 101         if index is None:
 102             raise ValueError("No SPI port on specified pin.")
 103         super().__init__(index, baudrate=baudrate)
 104
 105 class SPI_Feather_EPD(SPI):
 106     """SPI Class for Feather EPD u2if"""
 107
 108     def __init__(self, clock, *, baudrate=100000):
 109         index = None
 110         if clock.id == 22:
 111             index = 0
 112         if clock.id == 14:
 113             index = 1
 114         if index is None:
 115             raise ValueError("No SPI port on specified pin.")
 116         super().__init__(index, baudrate=baudrate)
 117
 118 class SPI_Feather_RFM(SPI):
 119     """SPI Class for Feather EPD u2if"""
 120
 121     def __init__(self, clock, *, baudrate=100000):
 122         index = None
 123         if clock.id == 14:
 124             index = 1
 125         if index is None:
 126             raise ValueError("No SPI port on specified pin.")
 127         super().__init__(index, baudrate=baudrate)
 128
 129 class SPI_QTPY(SPI):
 130     """SPI Class for QT Py u2if"""
 131
 132     def __init__(self, clock, *, baudrate=100000):
 133         index = None
 134         if clock.id == 6:
 135             index = 0
 136         if index is None:
 137             raise ValueError("No SPI port on specified pin.")
 138         super().__init__(index, baudrate=baudrate)
 139
 140
 141 class SPI_ItsyBitsy(SPI):
 142     """SPI Class for ItsyBitsy u2if"""
 143
 144     def __init__(self, clock, *, baudrate=100000):
 145         index = None
 146         if clock.id == 18:
 147             index = 0
 148         if index is None:
 149             raise ValueError("No SPI port on specified pin.")
 150         super().__init__(index, baudrate=baudrate)
 151
 152
 153 class SPI_MacroPad(SPI):
 154     """SPI Class for MacroPad u2if"""
 155
 156     def __init__(self, clock, *, baudrate=100000):
 157         index = None
 158         if clock.id == 26:
 159             index = 1
 160         if index is None:
 161             raise ValueError("No SPI port on specified pin.")
 162         super().__init__(index, baudrate=baudrate)