Forráskód Böngészése

spi_docs: Fixed the default value of max_transfer_sz.

(cherry picked from commit e89fabb963e5af1f71067a32f06c9a740f497e54)
Michael (XIAO Xufeng) 4 éve
szülő
commit
0e36a7e3c0
1 módosított fájl, 1 hozzáadás és 1 törlés
  1. 1 1
      components/driver/include/driver/spi_common.h

+ 1 - 1
components/driver/include/driver/spi_common.h

@@ -87,7 +87,7 @@ typedef struct {
     int sclk_io_num;                ///< GPIO pin for Spi CLocK signal, or -1 if not used.
     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.
     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.
-    int max_transfer_sz;            ///< Maximum transfer size, in bytes. Defaults to 4094 if 0.
+    int max_transfer_sz;            ///< Maximum transfer size, in bytes. Defaults to 4092 if 0 when DMA enabled, or to `SOC_SPI_MAXIMUM_BUFFER_SIZE` if DMA is disabled.
     uint32_t flags;                 ///< Abilities of bus to be checked by the driver. Or-ed value of ``SPICOMMON_BUSFLAG_*`` flags.
     int intr_flags;    /**< Interrupt flag for the bus to set the priority, and IRAM attribute, see
                          *  ``esp_intr_alloc.h``. Note that the EDGE, INTRDISABLED attribute are ignored