espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-30 02:37:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat(rmt): add API to return the real clock resolution of a channel

Browse Source 
Closes https://github.com/espressif/esp-idf/pull/15074
This commit is contained in:
morris
2024-12-23 15:08:50 +08:00
parent 1408102f63
commit cf0dc7a202
2 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
components/driver/include/esp_private/rmt.h
View File

@ -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

7
components/driver/rmt/rmt_common.c
View File

@ -194,6 +194,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