diff --git a/components/driver/i2s/include/driver/i2s_std.h b/components/driver/i2s/include/driver/i2s_std.h index 2dd2c393c8..263b69b7d4 100644 --- a/components/driver/i2s/include/driver/i2s_std.h +++ b/components/driver/i2s/include/driver/i2s_std.h @@ -256,13 +256,13 @@ typedef struct { * @brief I2S standard mode GPIO pins configuration */ typedef struct { - gpio_num_t MCLK; /*!< MCK pin, output by default, input if the clock source is selected to `I2S_CLK_SRC_EXTERNAL` */ - gpio_num_t BCLK; /*!< BCK pin, input in slave role, output in master role */ - gpio_num_t WS; /*!< WS pin, input in slave role, output in master role */ + gpio_num_t mclk; /*!< MCK pin, output by default, input if the clock source is selected to `I2S_CLK_SRC_EXTERNAL` */ + gpio_num_t bclk; /*!< BCK pin, input in slave role, output in master role */ + gpio_num_t ws; /*!< WS pin, input in slave role, output in master role */ gpio_num_t dout; /*!< DATA pin, output */ gpio_num_t din; /*!< DATA pin, input */ struct { - uint32_t mclk_inv: 1; /*!< Set 1 to invert the MCLK output */ + uint32_t mclk_inv: 1; /*!< Set 1 to invert the MCLK input/output */ uint32_t bclk_inv: 1; /*!< Set 1 to invert the BCLK input/output */ uint32_t ws_inv: 1; /*!< Set 1 to invert the WS input/output */ } invert_flags; /*!< GPIO pin invert flags */ diff --git a/components/driver/i2s/include/driver/i2s_tdm.h b/components/driver/i2s/include/driver/i2s_tdm.h index 9ceed48356..b71f3be79d 100644 --- a/components/driver/i2s/include/driver/i2s_tdm.h +++ b/components/driver/i2s/include/driver/i2s_tdm.h @@ -171,13 +171,13 @@ typedef struct { * @brief I2S TDM mode GPIO pins configuration */ typedef struct { - gpio_num_t MCLK; /*!< MCK pin, output by default, input if the clock source is selected to `I2S_CLK_SRC_EXTERNAL` */ - gpio_num_t BCLK; /*!< BCK pin, input in slave role, output in master role */ - gpio_num_t WS; /*!< WS pin, input in slave role, output in master role */ + gpio_num_t mclk; /*!< MCK pin, output by default, input if the clock source is selected to `I2S_CLK_SRC_EXTERNAL` */ + gpio_num_t bclk; /*!< BCK pin, input in slave role, output in master role */ + gpio_num_t ws; /*!< WS pin, input in slave role, output in master role */ gpio_num_t dout; /*!< DATA pin, output */ gpio_num_t din; /*!< DATA pin, input */ struct { - uint32_t mclk_inv: 1; /*!< Set 1 to invert the MCLK output */ + uint32_t mclk_inv: 1; /*!< Set 1 to invert the MCLK input/output */ uint32_t bclk_inv: 1; /*!< Set 1 to invert the BCLK input/output */ uint32_t ws_inv: 1; /*!< Set 1 to invert the WS input/output */ } invert_flags; /*!< GPIO pin invert flags */ diff --git a/docs/en/api-reference/peripherals/i2s.rst b/docs/en/api-reference/peripherals/i2s.rst index b09f843d83..a6eac202d4 100644 --- a/docs/en/api-reference/peripherals/i2s.rst +++ b/docs/en/api-reference/peripherals/i2s.rst @@ -252,7 +252,7 @@ Both :cpp:func:`i2s_channel_write` and :cpp:func:`i2s_channel_read` are blocking Configuration ^^^^^^^^^^^^^ -Users can initialize a channel by calling corresponding functions (i.e., :func:`i2s_channel_init_std_mode`, :func:`i2s_channel_init_pdm_rx_mode`, :func:`i2s_channel_init_pdm_tx_mode`, or :func:`i2s_channel_init_tdm_mode`) to a specific mode. If the configurations need to be updated after initialization, users have to first call :cpp:func:`i2s_channel_disable` to ensure that the channel has stopped, and then call corresponding `reconfig` functions, like :cpp:func:`i2s_channel_reconfig_std_slot`, :cpp:func:`i2s_channel_reconfig_std_clock`, and :cpp:func:`i2s_channel_reconfig_std_gpio`. +Users can initialize a channel by calling corresponding functions (i.e., :func:`i2s_channel_init_std_mode`, :func:`i2s_channel_init_pdm_rx_mode`, :func:`i2s_channel_init_pdm_tx_mode`, or :func:`i2s_channel_init_tdm_mode`) to a specific mode. If the configurations need to be updated after initialization, users have to first call :cpp:func:`i2s_channel_disable` to ensure that the channel has stopped, and then call corresponding ``reconfig`` functions, like :cpp:func:`i2s_channel_reconfig_std_slot`, :cpp:func:`i2s_channel_reconfig_std_clock`, and :cpp:func:`i2s_channel_reconfig_std_gpio`. IRAM Safe ^^^^^^^^^ diff --git a/tools/ci/check_public_headers_exceptions.txt b/tools/ci/check_public_headers_exceptions.txt index 320d66e77e..2167932fe2 100644 --- a/tools/ci/check_public_headers_exceptions.txt +++ b/tools/ci/check_public_headers_exceptions.txt @@ -22,7 +22,9 @@ components/esp_rom/include/esp32s2/rom/rsa_pss.h # LWIP: sockets.h uses #include_next<>, which doesn't work correctly with the checker # memp_std.h is supposed to be included multiple times with different settings +components/lwip/lwip/src/include/lwip/priv/memp_std.h components/lwip/include/lwip/sockets.h +components/lwip/lwip/src/include/lwip/prot/nd6.h ## Header produced non-zero object: components/esp_phy/esp32/include/phy_init_data.h @@ -66,9 +68,13 @@ components/json/cJSON/ components/spiffs/include/spiffs_config.h +components/unity/unity/src/unity_internals.h +components/unity/unity/extras/ components/unity/include/unity_config.h components/unity/include/unity_test_runner.h +components/cmock/CMock/src/cmock.h +components/cmock/CMock/src/cmock_internals.h components/openthread/openthread/