mirror of
https://github.com/espressif/esp-idf.git
synced 2025-07-29 18:27:20 +02:00
Merge branch 'feat/rmt_return_real_channel_resolution_v5.4' into 'release/v5.4'
feat(rmt): add API to return the real clock resolution of a channel (v5.4) See merge request espressif/esp-idf!35901
This commit is contained in:
@ -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
|
||||
|
@ -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
|
||||
|
Reference in New Issue
Block a user