From 9eb0f81517681712006bd3bbf3dbdb2f42f4ff71 Mon Sep 17 00:00:00 2001 From: Florian Loitsch Date: Mon, 8 Dec 2025 09:57:20 +0100 Subject: [PATCH] docs: encoder's 'symbols' parameter may be a hw buffer --- components/esp_driver_rmt/include/driver/rmt_encoder.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/esp_driver_rmt/include/driver/rmt_encoder.h b/components/esp_driver_rmt/include/driver/rmt_encoder.h index 0ed5255e81..69039eafb3 100644 --- a/components/esp_driver_rmt/include/driver/rmt_encoder.h +++ b/components/esp_driver_rmt/include/driver/rmt_encoder.h @@ -109,7 +109,7 @@ struct rmt_encoder_t { * @param[in] data_size Size of the data, as passed to rmt_transmit() * @param[in] symbols_written Current position in encoded stream, in symbols * @param[in] symbols_free The maximum amount of symbols that can be written into the `symbols` buffer - * @param[out] symbols Symbols to be sent to the RMT hardware + * @param[out] symbols Symbols to be sent to the RMT hardware. This may be a hardware buffer and can't be used with 'memcpy' * @param[out] done Setting this to true marks this transaction as finished * @param arg Opaque argument * @return Amount of symbols encoded in this callback round. 0 if more space is needed.