nordic-dev.net/embassy
2
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2024-11-22 06:42:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a comment to the pio rx fifo pull function

Browse Source
This commit is contained in:
Jan Niehusmann 2024-04-21 21:24:15 +00:00
parent da86c08651
commit 3f8736e872
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
embassy-rp/src/pio/mod.rs
View File

@ -324,6 +324,10 @@ impl<'d, PIO: Instance, const SM: usize> StateMachineRx<'d, PIO, SM> {
} }
/// Pull data from RX FIFO. /// Pull data from RX FIFO.
///
/// This function doesn't check if there is data available to be read.
/// If the rx FIFO is empty, an undefined value is returned. If you only
/// want to pull if data is available, use `try_pull` instead.
pub fn pull(&mut self) -> u32 { pub fn pull(&mut self) -> u32 {
PIO::PIO.rxf(SM).read() PIO::PIO.rxf(SM).read()
} }