IDF master 8131d6f46

Jason2866 · Jason2866 · Feb 4, 2022 · Jul 20, 2021 · Jul 21, 2021 · Jul 25, 2021
commit c8a83137545dea06fb46740986b0d7fb894891e5
diff --git a/platform.txt b/platform.txt
diff --git a/tools/platformio-build-esp32.py b/tools/platformio-build-esp32.py
@@ -98,7 +98,7 @@
        "-u", "pthread_include_pthread_impl",
        "-u", "pthread_include_pthread_cond_impl",
        "-u", "pthread_include_pthread_local_storage_impl",
-        "-u", "ld_include_panic_highint_hdl",
+        "-u", "ld_include_highint_hdl",
        "-u", "start_app",
        "-u", "start_app_other_cores",
        "-u", "__ubsan_include",
@@ -135,8 +135,8 @@
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "hal", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "hal", "platform_port", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_rom", "include"),
-        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_rom", "esp32"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_rom", "include", "esp32"),
+        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_rom", "esp32"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_common", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_system", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_system", "port", "soc"),
@@ -158,9 +158,9 @@
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "tcpip_adapter", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_phy", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_phy", "esp32", "include"),
+        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_ipc", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "app_trace", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_timer", "include"),
-        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "esp_ipc", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "mbedtls", "port", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "mbedtls", "mbedtls", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32", "include", "mbedtls", "esp_crt_bundle", "include"),
@@ -295,7 +295,7 @@
        "UNITY_INCLUDE_CONFIG_H",
        "WITH_POSIX",
        "_GNU_SOURCE",
-        ("IDF_VER", '\\"v4.4-dev-2464-g606557b48\\"'),
+        ("IDF_VER", '\\"v4.4-dev-2487-g8131d6f46\\"'),
        "ESP_PLATFORM",
        "ARDUINO_ARCH_ESP32",
        "ESP32",

diff --git a/tools/platformio-build-esp32c3.py b/tools/platformio-build-esp32c3.py
@@ -162,8 +162,8 @@
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "hal", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "hal", "platform_port", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_rom", "include"),
-        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_rom", "esp32c3"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_rom", "include", "esp32c3"),
+        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_rom", "esp32c3"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_common", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_system", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_system", "port", "soc"),
@@ -184,9 +184,9 @@
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "tcpip_adapter", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_phy", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_phy", "esp32c3", "include"),
+        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_ipc", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "app_trace", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_timer", "include"),
-        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "esp_ipc", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "mbedtls", "port", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "mbedtls", "mbedtls", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32c3", "include", "mbedtls", "esp_crt_bundle", "include"),
@@ -281,7 +281,7 @@
        "UNITY_INCLUDE_CONFIG_H",
        "WITH_POSIX",
        "_GNU_SOURCE",
-        ("IDF_VER", '\\"v4.4-dev-2464-g606557b48\\"'),
+        ("IDF_VER", '\\"v4.4-dev-2487-g8131d6f46\\"'),
        "ESP_PLATFORM",
        "ARDUINO_ARCH_ESP32",
        "ESP32",

diff --git a/tools/platformio-build-esp32s2.py b/tools/platformio-build-esp32s2.py
@@ -94,7 +94,7 @@
        "-u", "pthread_include_pthread_impl",
        "-u", "pthread_include_pthread_cond_impl",
        "-u", "pthread_include_pthread_local_storage_impl",
-        "-u", "ld_include_panic_highint_hdl",
+        "-u", "ld_include_highint_hdl",
        "-u", "start_app",
        "-u", "__ubsan_include",
        "-u", "__assert_func",
@@ -131,8 +131,8 @@
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "hal", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "hal", "platform_port", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_rom", "include"),
-        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_rom", "esp32s2"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_rom", "include", "esp32s2"),
+        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_rom", "esp32s2"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_common", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_system", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_system", "port", "soc"),
@@ -153,9 +153,9 @@
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "tcpip_adapter", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_phy", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_phy", "esp32s2", "include"),
+        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_ipc", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "app_trace", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_timer", "include"),
-        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "esp_ipc", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "mbedtls", "port", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "mbedtls", "mbedtls", "include"),
        join(FRAMEWORK_DIR, "tools", "sdk", "esp32s2", "include", "mbedtls", "esp_crt_bundle", "include"),
@@ -281,7 +281,7 @@
        "UNITY_INCLUDE_CONFIG_H",
        "WITH_POSIX",
        "_GNU_SOURCE",
-        ("IDF_VER", '\\"v4.4-dev-2464-g606557b48\\"'),
+        ("IDF_VER", '\\"v4.4-dev-2487-g8131d6f46\\"'),
        "ESP_PLATFORM",
        "ARDUINO_ARCH_ESP32",
        "ESP32",

diff --git a/tools/sdk/esp32/include/config/sdkconfig.h b/tools/sdk/esp32/include/config/sdkconfig.h
@@ -254,6 +254,9 @@
 #define CONFIG_ESP_MAC_ADDR_UNIVERSE_ETH 1
 #define CONFIG_ESP32_UNIVERSAL_MAC_ADDRESSES_FOUR 1
 #define CONFIG_ESP32_UNIVERSAL_MAC_ADDRESSES 4
+#define CONFIG_ESP_IPC_TASK_STACK_SIZE 1024
+#define CONFIG_ESP_IPC_USES_CALLERS_PRIORITY 1
+#define CONFIG_ESP_IPC_ISR_ENABLE 1
 #define CONFIG_ESP_NETIF_IP_LOST_TIMER_INTERVAL 120
 #define CONFIG_ESP_NETIF_TCPIP_LWIP 1
 #define CONFIG_ESP_NETIF_TCPIP_ADAPTER_COMPATIBLE_LAYER 1
@@ -280,8 +283,6 @@
 #define CONFIG_ESP_TASK_WDT_PANIC 1
 #define CONFIG_ESP_TASK_WDT_TIMEOUT_S 5
 #define CONFIG_ESP_TASK_WDT_CHECK_IDLE_TASK_CPU0 1
-#define CONFIG_ESP_IPC_TASK_STACK_SIZE 1024
-#define CONFIG_ESP_IPC_USES_CALLERS_PRIORITY 1
 #define CONFIG_ESP_TIME_FUNCS_USE_RTC_TIMER 1
 #define CONFIG_ESP_TIME_FUNCS_USE_ESP_TIMER 1
 #define CONFIG_ESP_TIMER_TASK_STACK_SIZE 4096
@@ -690,5 +691,5 @@
 #define CONFIG_ULP_COPROC_ENABLED CONFIG_ESP32_ULP_COPROC_ENABLED
 #define CONFIG_ULP_COPROC_RESERVE_MEM CONFIG_ESP32_ULP_COPROC_RESERVE_MEM
 #define CONFIG_WARN_WRITE_STRINGS CONFIG_COMPILER_WARN_WRITE_STRINGS
-#define CONFIG_ARDUINO_IDF_COMMIT "606557b48"
+#define CONFIG_ARDUINO_IDF_COMMIT "8131d6f46"
 #define CONFIG_ARDUINO_IDF_BRANCH "master"
diff --git a/tools/sdk/esp32/include/driver/include/driver/i2s.h b/tools/sdk/esp32/include/driver/include/driver/i2s.h
@@ -13,7 +13,6 @@
 #include "soc/i2s_periph.h"
 #include "soc/rtc_periph.h"
 #include "soc/soc_caps.h"
-#include "hal/i2s_hal.h"
 #include "hal/i2s_types.h"
 #include "driver/periph_ctrl.h"
 #include "esp_intr_alloc.h"
@@ -28,7 +27,119 @@ extern "C" {

 #define I2S_PIN_NO_CHANGE (-1) /*!< Use in i2s_pin_config_t for pins which should not be changed */

-typedef intr_handle_t i2s_isr_handle_t;
+/**
+ * @brief I2S port number, the max port number is (I2S_NUM_MAX -1).
+ */
+typedef enum {
+    I2S_NUM_0 = 0,                 /*!< I2S port 0 */
+#if SOC_I2S_NUM > 1
+    I2S_NUM_1 = 1,                 /*!< I2S port 1 */
+#endif
+    I2S_NUM_MAX,                   /*!< I2S port max */
+} i2s_port_t;
+
+#if SOC_I2S_SUPPORTS_PCM
+/**
+ * @brief I2S PCM configuration
+ *
+ */
+typedef struct {
+    i2s_pcm_compress_t  pcm_type;       /*!< I2S PCM a/u-law decompress or compress type */
+} i2s_pcm_cfg_t;
+#endif
+
+#if SOC_I2S_SUPPORTS_PDM_TX
+/**
+ * @brief Default I2S PDM Up-Sampling Rate configuration
+ */
+#define I2S_PDM_DEFAULT_UPSAMPLE_CONFIG(rate) { \
+        .sample_rate = rate,                    \
+        .fp = 960,                              \
+        .fs = (rate) / 100,                     \
+    }
+
+/**
+ * @brief I2S PDM up-sample rate configuration
+ * @note  TX PDM can only be set to the following two upsampling rate configurations:
+ *        1: fp = 960, fs = sample_rate / 100, in this case, Fpdm = 128*48000
+ *        2: fp = 960, fs = 480, in this case, Fpdm = 128*Fpcm = 128*sample_rate
+ *        If the pdm receiver do not care the pdm serial clock, it's recommended set Fpdm = 128*48000.
+ *        Otherwise, the second configuration should be applied.
+ */
+typedef struct  {
+    int sample_rate;                    /*!< I2S PDM sample rate */
+    int fp;                             /*!< I2S PDM TX upsampling paramater. Normally it should be set to 960 */
+    int fs;                             /*!< I2S PDM TX upsampling paramater. When it is set to 480, the pdm clock frequency Fpdm = 128 * sample_rate, when it is set to sample_rate / 100， Fpdm will be fixed to 128*48000 */
+} i2s_pdm_tx_upsample_cfg_t;
+#endif
+
+/**
+ * @brief I2S pin number for i2s_set_pin
+ *
+ */
+typedef struct {
+    int mck_io_num;     /*!< MCK in out pin*/
+    int bck_io_num;     /*!< BCK in out pin*/
+    int ws_io_num;      /*!< WS in out pin*/
+    int data_out_num;   /*!< DATA out pin*/
+    int data_in_num;    /*!< DATA in pin*/
+} i2s_pin_config_t;
+
+/**
+ * @brief I2S driver configuration parameters
+ *
+ */
+typedef struct {
+
+    i2s_mode_t              mode;                       /*!< I2S work mode */
+    uint32_t                sample_rate;                /*!< I2S sample rate */
+    i2s_bits_per_sample_t   bits_per_sample;            /*!< I2S sample bits in one channel */
+    i2s_channel_fmt_t       channel_format;             /*!< I2S channel format.*/
+    i2s_comm_format_t       communication_format;       /*!< I2S communication format */
+    int                     intr_alloc_flags;           /*!< Flags used to allocate the interrupt. One or multiple (ORred) ESP_INTR_FLAG_* values. See esp_intr_alloc.h for more info */
+    int                     dma_buf_count;              /*!< I2S DMA Buffer Count */
+    int                     dma_buf_len;                /*!< I2S DMA Buffer Length */
+    bool                    use_apll;                   /*!< I2S using APLL as main I2S clock, enable it to get accurate clock */
+    bool                    tx_desc_auto_clear;         /*!< I2S auto clear tx descriptor if there is underflow condition (helps in avoiding noise in case of data unavailability) */
+    int                     fixed_mclk;                 /*!< I2S using fixed MCLK output. If use_apll = true and fixed_mclk > 0, then the clock output for i2s is fixed and equal to the fixed_mclk value. If fixed_mclk set, mclk_multiple won't take effect */
+    i2s_mclk_multiple_t     mclk_multiple;              /*!< The multiple of I2S master clock(MCLK) to sample rate */
+    i2s_bits_per_chan_t     bits_per_chan;              /*!< I2S total bits in one channel， only take effect when larger than 'bits_per_sample', default '0' means equal to 'bits_per_sample' */
+
+#if SOC_I2S_SUPPORTS_TDM
+    i2s_channel_t           chan_mask;                  /*!< I2S active channel bit mask, set value in `i2s_channel_t` to enable specific channel, the bit map of active channel can not exceed (0x1<<total_chan). */
+    uint32_t                total_chan;                 /*!< I2S Total number of channels. If it is smaller than the biggest active channel number, it will be set to this number automatically. */
+    bool                    left_align;                 /*!< Set to enable left alignment */
+    bool                    big_edin;                   /*!< Set to enable big edin */
+    bool                    bit_order_msb;              /*!< Set to enable msb order */
+    bool                    skip_msk;                   /*!< Set to enable skip mask. If it is enabled, only the data of the enabled channels will be sent, otherwise all data stored in DMA TX buffer will be sent */
+#endif // SOC_I2S_SUPPORTS_TDM
+
+} i2s_driver_config_t;
+
+typedef i2s_driver_config_t i2s_config_t;       // for backward compatible
+typedef intr_handle_t i2s_isr_handle_t;         // for backward compatible
+
+/**
+ * @brief I2S event queue types
+ *
+ */
+typedef enum {
+    I2S_EVENT_DMA_ERROR,
+    I2S_EVENT_TX_DONE,     /*!< I2S DMA finish sent 1 buffer*/
+    I2S_EVENT_RX_DONE,     /*!< I2S DMA finish received 1 buffer*/
+    I2S_EVENT_TX_Q_OVF,    /*!< I2S DMA sent queue overflow*/
+    I2S_EVENT_RX_Q_OVF,    /*!< I2S DMA receive queue overflow*/
+    I2S_EVENT_MAX,         /*!< I2S event max index*/
+} i2s_event_type_t;
+
+/**
+ * @brief Event structure used in I2S event queue
+ *
+ */
+typedef struct {
+    i2s_event_type_t    type;   /*!< I2S event type */
+    size_t              size;   /*!< I2S data size for I2S_DATA event*/
+} i2s_event_t;

 /**
 * @brief Set I2S pin number
@@ -54,15 +165,15 @@ typedef intr_handle_t i2s_isr_handle_t;
 */
 esp_err_t i2s_set_pin(i2s_port_t i2s_num, const i2s_pin_config_t *pin);

-#if SOC_I2S_SUPPORTS_PDM
+#if SOC_I2S_SUPPORTS_PDM_RX
 /**
 * @brief Set PDM mode down-sample rate
 *        In PDM RX mode, there would be 2 rounds of downsample process in hardware.
 *        In the first downsample process, the sampling number can be 16 or 8.
 *        In the second downsample process, the sampling number is fixed as 8.
 *        So the clock frequency in PDM RX mode would be (fpcm * 64) or (fpcm * 128) accordingly.
 * @param i2s_num I2S_NUM_0, I2S_NUM_1
- * @param dsr i2s RX down sample rate for PDM mode.
+ * @param downsample i2s RX down sample rate for PDM mode.
 *
 * @note After calling this function, it would call i2s_set_clk inside to update the clock frequency.
 *       Please call this function after I2S driver has been initialized.
@@ -72,7 +183,25 @@ esp_err_t i2s_set_pin(i2s_port_t i2s_num, const i2s_pin_config_t *pin);
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_ERR_NO_MEM      Out of memory
 */
-esp_err_t i2s_set_pdm_rx_down_sample(i2s_port_t i2s_num, i2s_pdm_dsr_t dsr);
+esp_err_t i2s_set_pdm_rx_down_sample(i2s_port_t i2s_num, i2s_pdm_dsr_t downsample);
+#endif
+
+#if SOC_I2S_SUPPORTS_PDM_TX
+/**
+ * @brief Set TX PDM mode up-sample rate
+ * @note  If you have set PDM mode while calling 'i2s_driver_install',
+ *        default PDM TX upsample parameters have already been set,
+ *        no need to call this function again if you don't have to change the default configuration
+ *
+ * @param i2s_num I2S_NUM_0, I2S_NUM_1
+ * @param upsample_cfg Set I2S PDM up-sample rate configuration
+ *
+ * @return
+ *     - ESP_OK              Success
+ *     - ESP_ERR_INVALID_ARG Parameter error
+ *     - ESP_ERR_NO_MEM      Out of memory
+ */
+esp_err_t i2s_set_pdm_tx_up_sample(i2s_port_t i2s_num, const i2s_pdm_tx_upsample_cfg_t *upsample_cfg);
 #endif

 /**
@@ -93,7 +222,7 @@ esp_err_t i2s_set_pdm_rx_down_sample(i2s_port_t i2s_num, i2s_pdm_dsr_t dsr);
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_ERR_NO_MEM      Out of memory
 */
-esp_err_t i2s_driver_install(i2s_port_t i2s_num, const i2s_config_t *i2s_config, int queue_size, void* i2s_queue);
+esp_err_t i2s_driver_install(i2s_port_t i2s_num, const i2s_config_t *i2s_config, int queue_size, void *i2s_queue);

 /**
 * @brief Uninstall I2S driver.
@@ -243,25 +372,51 @@ esp_err_t i2s_start(i2s_port_t i2s_num);
 */
 esp_err_t i2s_zero_dma_buffer(i2s_port_t i2s_num);

+#if SOC_I2S_SUPPORTS_PCM
+/**
+ * @brief Configure I2S a/u-law decompress or compress
+ *
+ * @note  This function should be called after i2s driver installed
+ *        Only take effecttive when the i2s 'communication_format' is set to 'I2S_COMM_FORMAT_STAND_PCM_SHORT' or 'I2S_COMM_FORMAT_STAND_PCM_LONG'
+ *
+ * @param i2s_num  I2S_NUM_0
+ *
+ * @param pcm_cfg  including mode selection and a/u-law decompress or compress configuration paramater
+ *
+ * @return
+ *     - ESP_OK              Success
+ *     - ESP_ERR_INVALID_ARG Parameter error
+ */
+esp_err_t i2s_pcm_config(i2s_port_t i2s_num, const i2s_pcm_cfg_t *pcm_cfg);
+#endif
+
 /**
 * @brief Set clock & bit width used for I2S RX and TX.
 *
 * Similar to i2s_set_sample_rates(), but also sets bit width.
 *
+ * 1. stop i2s;
+ * 2. calculate mclk, bck, bck_factor
+ * 3. malloc dma buffer;
+ * 4. start i2s
+ *
 * @param i2s_num  I2S_NUM_0, I2S_NUM_1
 *
 * @param rate I2S sample rate (ex: 8000, 44100...)
 *
- * @param bits I2S bit width (I2S_BITS_PER_SAMPLE_16BIT, I2S_BITS_PER_SAMPLE_24BIT, I2S_BITS_PER_SAMPLE_32BIT)
+ * @param bits_cfg I2S bits configuration
+ *             the low 16 bits is for data bits per sample in one channel (see 'i2s_bits_per_sample_t')
+ *             the high 16 bits is for total bits in one channel (see 'i2s_bits_per_chan_t')
+ *             high 16bits =0 means same as the bits per sample.
 *
- * @param ch I2S channel, (I2S_CHANNEL_MONO, I2S_CHANNEL_STEREO)
+ * @param ch I2S channel, (I2S_CHANNEL_MONO, I2S_CHANNEL_STEREO or specific channel in TDM mode)
 *
 * @return
 *     - ESP_OK              Success
 *     - ESP_ERR_INVALID_ARG Parameter error
 *     - ESP_ERR_NO_MEM      Out of memory
 */
-esp_err_t i2s_set_clk(i2s_port_t i2s_num, uint32_t rate, i2s_bits_per_sample_t bits, i2s_channel_t ch);
+esp_err_t i2s_set_clk(i2s_port_t i2s_num, uint32_t rate, uint32_t bits_cfg, i2s_channel_t ch);

 /**
 * @brief get clock set on particular port number.