diff --git a/components/esp_driver_rmt/include/esp_private/rmt.h b/components/esp_driver_rmt/include/esp_private/rmt.h index fa88b06f2a..1c86c2a487 100644 --- a/components/esp_driver_rmt/include/esp_private/rmt.h +++ b/components/esp_driver_rmt/include/esp_private/rmt.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -28,6 +28,18 @@ extern "C" { */ esp_err_t rmt_get_channel_id(rmt_channel_handle_t channel, int *ret_id); +/** + * @brief Get the RMT channel's real clock resolution + * + * @param[in] channel RMT generic channel that created by `rmt_new_tx_channel()` or `rmt_new_rx_channel()` + * @param[out] ret_resolution_hz The real clock resolution in Hz + * @return + * - ESP_OK: Get RMT channel resolution successfully + * - ESP_ERR_INVALID_ARG: Get RMT channel resolution failed because of invalid argument + * - ESP_FAIL: Get RMT channel resolution failed because of other reasons + */ +esp_err_t rmt_get_channel_resolution(rmt_channel_handle_t channel, uint32_t *ret_resolution_hz); + #ifdef __cplusplus } #endif diff --git a/components/esp_driver_rmt/src/rmt_common.c b/components/esp_driver_rmt/src/rmt_common.c index 51e4d54755..23d123d553 100644 --- a/components/esp_driver_rmt/src/rmt_common.c +++ b/components/esp_driver_rmt/src/rmt_common.c @@ -226,6 +226,13 @@ esp_err_t rmt_get_channel_id(rmt_channel_handle_t channel, int *ret_id) return ESP_OK; } +esp_err_t rmt_get_channel_resolution(rmt_channel_handle_t channel, uint32_t *ret_resolution_hz) +{ + ESP_RETURN_ON_FALSE(channel && ret_resolution_hz, ESP_ERR_INVALID_ARG, TAG, "invalid argument"); + *ret_resolution_hz = channel->resolution_hz; + return ESP_OK; +} + esp_err_t rmt_apply_carrier(rmt_channel_handle_t channel, const rmt_carrier_config_t *config) { // specially, we allow config to be NULL, means to disable the carrier submodule