abawo/pico-sdk
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify multicore_fifo doxygen (#323)

Browse Source 
Based on my observations in #284
This commit is contained in:
Andrew Scheller 2021-04-18 23:10:24 +01:00 committed by GitHub
parent b8dbbcf0d7
commit b17fc76c8f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/rp2_common/pico_multicore/include/pico/multicore.h
View File

@ -119,7 +119,7 @@ uint32_t multicore_fifo_pop_blocking(void);
bool multicore_fifo_pop_timeout_us(uint64_t timeout_us, uint32_t *out); bool multicore_fifo_pop_timeout_us(uint64_t timeout_us, uint32_t *out);
/*! \brief Flush any data in the outgoing FIFO /*! \brief Flush any data in the incoming FIFO
* \ingroup multicore_fifo * \ingroup multicore_fifo
* *
*/ */
@ -130,9 +130,12 @@ static inline void multicore_fifo_drain(void) {
/*! \brief Clear FIFO interrupt /*! \brief Clear FIFO interrupt
* \ingroup multicore_fifo * \ingroup multicore_fifo
*
* Note that this only clears an interrupt that was caused by the ROE or WOF flags.
* To clear the VLD flag you need to use one of the 'pop' or 'drain' functions.
*/ */
static inline void multicore_fifo_clear_irq(void) { static inline void multicore_fifo_clear_irq(void) {
// Write any value to clear any interrupts // Write any value to clear the error flags
sio_hw->fifo_st = 0xff; sio_hw->fifo_st = 0xff;
} }