NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #2338 from eZioPan/note-on-circular-dma

Browse source 
docs: add a note about circular mode DMA
This commit is contained in:
Ulf Lilleengen 2023-12-21 09:36:38 +00:00 committed by GitHub
commit 8442e72589
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
embassy-stm32/src/dma/bdma.rs
View file

@ -23,6 +23,10 @@ use crate::pac::bdma::{regs, vals};
#[non_exhaustive] #[non_exhaustive]
pub struct TransferOptions { pub struct TransferOptions {
/// Enable circular DMA /// Enable circular DMA
///
/// Note:
/// If you enable circular mode manually, you may want to build and `.await` the `Transfer` in a separate task.
/// Since DMA in circular mode need manually stop, `.await` in current task would block the task forever.
pub circular: bool, pub circular: bool,
/// Enable half transfer interrupt /// Enable half transfer interrupt
pub half_transfer_ir: bool, pub half_transfer_ir: bool,

4
embassy-stm32/src/dma/dma.rs
View file

@ -30,6 +30,10 @@ pub struct TransferOptions {
/// FIFO threshold for DMA FIFO mode. If none, direct mode is used. /// FIFO threshold for DMA FIFO mode. If none, direct mode is used.
pub fifo_threshold: Option<FifoThreshold>, pub fifo_threshold: Option<FifoThreshold>,
/// Enable circular DMA /// Enable circular DMA
///
/// Note:
/// If you enable circular mode manually, you may want to build and `.await` the `Transfer` in a separate task.
/// Since DMA in circular mode need manually stop, `.await` in current task would block the task forever.
pub circular: bool, pub circular: bool,
/// Enable half transfer interrupt /// Enable half transfer interrupt
pub half_transfer_ir: bool, pub half_transfer_ir: bool,