granicus.if.org Git - esp-idf/blob - components/driver/include/driver/spi_common.h

   1 // Copyright 2010-2017 Espressif Systems (Shanghai) PTE LTD
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15
  16 #ifndef _DRIVER_SPI_COMMON_H_
  17 #define _DRIVER_SPI_COMMON_H_
  18
  19 #include <stdint.h>
  20 #include <stdbool.h>
  21 #include "esp_err.h"
  22 #include "soc/spi_struct.h"
  23 #include "rom/lldesc.h"
  24
  25
  26 #ifdef __cplusplus
  27 extern "C"
  28 {
  29 #endif
  30
  31
  32 //Maximum amount of bytes that can be put in one DMA descriptor
  33 #define SPI_MAX_DMA_LEN (4096-4)
  34
  35
  36 /**
  37  * @brief Enum with the three SPI peripherals that are software-accessible in it
  38  */
  39 typedef enum {
  40     SPI_HOST=0,                     ///< SPI1, SPI
  41     HSPI_HOST=1,                    ///< SPI2, HSPI
  42     VSPI_HOST=2                     ///< SPI3, VSPI
  43 } spi_host_device_t;
  44
  45 /**
  46  * @brief This is a configuration structure for a SPI bus.
  47  *
  48  * You can use this structure to specify the GPIO pins of the bus. Normally, the driver will use the
  49  * GPIO matrix to route the signals. An exception is made when all signals either can be routed through
  50  * the IO_MUX or are -1. In that case, the IO_MUX is used, allowing for >40MHz speeds.
  51  */
  52 typedef struct {
  53     int mosi_io_num;                ///< GPIO pin for Master Out Slave In (=spi_d) signal, or -1 if not used.
  54     int miso_io_num;                ///< GPIO pin for Master In Slave Out (=spi_q) signal, or -1 if not used.
  55     int sclk_io_num;                ///< GPIO pin for Spi CLocK signal, or -1 if not used.
  56     int quadwp_io_num;              ///< GPIO pin for WP (Write Protect) signal which is used as D2 in 4-bit communication modes, or -1 if not used.
  57     int quadhd_io_num;              ///< GPIO pin for HD (HolD) signal which is used as D3 in 4-bit communication modes, or -1 if not used.
  58     int max_transfer_sz;            ///< Maximum transfer size, in bytes. Defaults to 4094 if 0.
  59 } spi_bus_config_t;
  60
  61
  62 /**
  63  * @brief Try to claim a SPI peripheral
  64  *
  65  * Call this if your driver wants to manage a SPI peripheral.
  66  *
  67  * @param host Peripheral to claim
  68  * @return True if peripheral is claimed successfully; false if peripheral already is claimed.
  69  */
  70 bool spicommon_periph_claim(spi_host_device_t host);
  71
  72 /**
  73  * @brief Return the SPI peripheral so another driver can claim it.
  74  *
  75  * @param host Peripheral to claim
  76  * @return True if peripheral is returned successfully; false if peripheral was free to claim already.
  77  */
  78 bool spicommon_periph_free(spi_host_device_t host);
  79
  80
  81 #define SPICOMMON_BUSFLAG_SLAVE  0          ///< Initialize I/O in slave mode
  82 #define SPICOMMON_BUSFLAG_MASTER (1<<0)     ///< Initialize I/O in master mode
  83 #define SPICOMMON_BUSFLAG_QUAD   (1<<1)     ///< Also initialize WP/HD pins, if specified
  84
  85 /**
  86  * @brief Connect a SPI peripheral to GPIO pins
  87  *
  88  * This routine is used to connect a SPI peripheral to the IO-pads and DMA channel given in
  89  * the arguments. Depending on the IO-pads requested, the routing is done either using the
  90  * IO_mux or using the GPIO matrix.
  91  *
  92  * @param host SPI peripheral to be routed
  93  * @param bus_config Pointer to a spi_bus_config struct detailing the GPIO pins
  94  * @param dma_chan DMA-channel (1 or 2) to use, or 0 for no DMA.
  95  * @param flags Combination of SPICOMMON_BUSFLAG_* flags
  96  * @param[out] is_native A value of 'true' will be written to this address if the GPIOs can be
  97  *                  routed using the IO_mux, 'false' if the GPIO matrix is used.
  98  * @return
  99  *         - ESP_ERR_INVALID_ARG   if parameter is invalid
 100  *         - ESP_OK                on success
 101  */
 102 esp_err_t spicommon_bus_initialize_io(spi_host_device_t host, const spi_bus_config_t *bus_config, int dma_chan, int flags, bool *is_native);
 103
 104 /**
 105  * @brief Free the IO used by a SPI peripheral
 106  *
 107  * @param host SPI peripheral to be freed
 108  * @return
 109  *         - ESP_ERR_INVALID_ARG   if parameter is invalid
 110  *         - ESP_OK                on success
 111  */
 112
 113 esp_err_t spicommon_bus_free_io(spi_host_device_t host);
 114
 115 /**
 116  * @brief Initialize a Chip Select pin for a specific SPI peripheral
 117  *
 118  *
 119  * @param host SPI peripheral
 120  * @param cs_io_num GPIO pin to route
 121  * @param cs_num CS id to route
 122  * @param force_gpio_matrix If true, CS will always be routed through the GPIO matrix. If false,
 123  *                          if the GPIO number allows it, the routing will happen through the IO_mux.
 124  */
 125
 126 void spicommon_cs_initialize(spi_host_device_t host, int cs_io_num, int cs_num, int force_gpio_matrix);
 127
 128 /**
 129  * @brief Free a chip select line
 130  *
 131  * @param host SPI peripheral
 132  * @param cs_num CS id to free
 133  */
 134 void spicommon_cs_free(spi_host_device_t host, int cs_num);
 135
 136
 137 /**
 138  * @brief Setup a DMA link chain
 139  *
 140  * This routine will set up a chain of linked DMA descriptors in the array pointed to by
 141  * ``dmadesc``. Enough DMA descriptors will be used to fit the buffer of ``len`` bytes in, and the
 142  * descriptors will point to the corresponding positions in ``buffer`` and linked together. The
 143  * end result is that feeding ``dmadesc[0]`` into DMA hardware results in the entirety ``len`` bytes
 144  * of ``data`` being read or written.
 145  *
 146  * @param dmadesc Pointer to array of DMA descriptors big enough to be able to convey ``len`` bytes
 147  * @param len Length of buffer
 148  * @param data Data buffer to use for DMA transfer
 149  * @param isrx True if data is to be written into ``data``, false if it's to be read from ``data``.
 150  */
 151 void spicommon_setup_dma_desc_links(lldesc_t *dmadesc, int len, const uint8_t *data, bool isrx);
 152
 153 /**
 154  * @brief Get the position of the hardware registers for a specific SPI host
 155  *
 156  * @param host The SPI host
 157  *
 158  * @return A register descriptor stuct pointer, pointed at the hardware registers
 159  */
 160 spi_dev_t *spicommon_hw_for_host(spi_host_device_t host);
 161
 162 /**
 163  * @brief Get the IRQ source for a specific SPI host
 164  *
 165  * @param host The SPI host
 166  *
 167  * @return The hosts IRQ source
 168  */
 169 int spicommon_irqsource_for_host(spi_host_device_t host);
 170
 171
 172
 173
 174 /**
 175  * Callback, to be called when a DMA engine reset is completed
 176 */
 177 typedef void(*dmaworkaround_cb_t)(void *arg);
 178
 179
 180 /**
 181  * @brief Request a reset for a certain DMA channel
 182  *
 183  * @note In some (well-defined) cases in the ESP32 (at least rev v.0 and v.1), a SPI DMA channel will get confused. This can be remedied
 184  * by resetting the SPI DMA hardware in case this happens. Unfortunately, the reset knob used for thsi will reset _both_ DMA channels, and
 185  * as such can only done safely when both DMA channels are idle. These functions coordinate this.
 186  *
 187  * Essentially, when a reset is needed, a driver can request this using spicommon_dmaworkaround_req_reset. This is supposed to be called
 188  * with an user-supplied function as an argument. If both DMA channels are idle, this call will reset the DMA subsystem and return true.
 189  * If the other DMA channel is still busy, it will return false; as soon as the other DMA channel is done, however, it will reset the
 190  * DMA subsystem and call the callback. The callback is then supposed to be used to continue the SPI drivers activity.
 191  *
 192  * @param dmachan DMA channel associated with the SPI host that needs a reset
 193  * @param cb Callback to call in case DMA channel cannot be reset immediately
 194  * @param arg Argument to the callback
 195  *
 196  * @return True when a DMA reset could be executed immediately. False when it could not; in this
 197  *         case the callback will be called with the specified argument when the logic can execute
 198  *         a reset, after that reset.
 199  */
 200 bool spicommon_dmaworkaround_req_reset(int dmachan, dmaworkaround_cb_t cb, void *arg);
 201
 202
 203 /**
 204  * @brief Check if a DMA reset is requested but has not completed yet
 205  *
 206  * @return True when a DMA reset is requested but hasn't completed yet. False otherwise.
 207  */
 208 bool spicommon_dmaworkaround_reset_in_progress();
 209
 210
 211 /**
 212  * @brief Mark a DMA channel as idle.
 213  *
 214  * A call to this function tells the workaround logic that this channel will
 215  * not be affected by a global SPI DMA reset.
 216  */
 217 void spicommon_dmaworkaround_idle(int dmachan);
 218
 219 /**
 220  * @brief Mark a DMA channel as active.
 221  *
 222  * A call to this function tells the workaround logic that this channel will
 223  * be affected by a global SPI DMA reset, and a reset like that should not be attempted.
 224  */
 225 void spicommon_dmaworkaround_transfer_active(int dmachan);
 226
 227
 228
 229 #ifdef __cplusplus
 230 }
 231 #endif
 232
 233 #endif