espressif/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-04-27 19:13:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: encoder's 'symbols' parameter may be a hw buffer

Browse Source
This commit is contained in:
Florian Loitsch
2025-12-08 09:57:20 +01:00
parent 487551888a
commit 9eb0f81517
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/esp_driver_rmt/include/driver/rmt_encoder.h
+1 -1
View File
@@ -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.