espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-06 14:14:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'doc/calarify_transmitted_symbols' into 'master'

Browse Source 
rmt: clarify num_symbols in the tx done event data

Closes IDFGH-9026

See merge request espressif/esp-idf!21807
This commit is contained in:
morris
2023-01-04 14:50:37 +08:00
parent 8fe13d53b1 26467f63cd
commit 781eb0c2ce
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
components/driver/include/driver/rmt_types.h
View File

@@ -34,7 +34,8 @@ typedef struct rmt_encoder_t *rmt_encoder_handle_t;
* @brief Type of RMT TX done event data * @brief Type of RMT TX done event data
*/ */
typedef struct { typedef struct {
size_t num_symbols; /*!< The number of transmitted RMT symbols (only one round is counted if it's a loop transmission) */ size_t num_symbols; /*!< The number of transmitted RMT symbols, including one EOF symbol, which is appended by the driver to mark the end of a transmission.
For a loop transmission, this value only counts for one round. */
} rmt_tx_done_event_data_t; } rmt_tx_done_event_data_t;
/** /**

2
docs/en/api-reference/peripherals/rmt.rst
View File

@@ -187,7 +187,7 @@ In the callback function, users can fetch the event specific data that is filled
The TX done event data is defined in :cpp:type:`rmt_tx_done_event_data_t`: The TX done event data is defined in :cpp:type:`rmt_tx_done_event_data_t`:
- :cpp:member:`rmt_tx_done_event_data_t::num_symbols` tells the number of transmitted RMT symbols. This also reflects the size of encoding artifacts. - :cpp:member:`rmt_tx_done_event_data_t::num_symbols` tells the number of transmitted RMT symbols. This also reflects the size of encoding artifacts. Please note, this value will count in the EOF symbol as well, which is appended by the driver, to mark the end of one transaction.
The RX complete event data is defined in :cpp:type:`rmt_rx_done_event_data_t`: The RX complete event data is defined in :cpp:type:`rmt_rx_done_event_data_t`: