Merge branch 'feature/specify_rmt_intr_cpu_affinity' into 'master'

doc(rmt): clarification on payload memory management and isr latency impact

Closes IDFGH-10396 and IDFGH-12068

See merge request espressif/esp-idf!24755
This commit is contained in:
morris
2024-03-15 10:05:58 +08:00
3 changed files with 16 additions and 13 deletions
@@ -89,7 +89,8 @@ esp_err_t rmt_new_tx_channel(const rmt_tx_channel_config_t *config, rmt_channel_
* Based on the setting of `rmt_transmit_config_t::queue_nonblocking`,
* if there're too many transactions pending in the queue, this function can block until it has free slot,
* otherwise just return quickly.
* @note The data to be transmitted will be encoded into RMT symbols by the specific `encoder`.
* @note The payload data to be transmitted will be encoded into RMT symbols by the specific `encoder`.
* @note You CAN'T modify the `payload` during the transmission, it should be kept valid until the transmission is finished.
*
* @param[in] tx_channel RMT TX channel that created by `rmt_new_tx_channel()`
* @param[in] encoder RMT encoder that created by various factory APIs like `rmt_new_bytes_encoder()`