max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #1751 from oro-os/add-pin-drop-docs

Browse Source 
stm32: add note about Output/OutputOpenDrain drop behavior
This commit is contained in:
xoviat
2023-08-08 23:05:12 +00:00
committed by GitHub
parent 47b8e04b1c 7b3d7a3826
commit d375c46590
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
embassy-stm32/src/gpio.rs
View File

@@ -351,6 +351,10 @@ impl From<Level> for bool {
} }
/// GPIO output driver. /// GPIO output driver.
///
/// Note that pins will **return to their floating state** when `Output` is dropped.
/// If pins should retain their state indefinitely, either keep ownership of the
/// `Output`, or pass it to [`core::mem::forget`].
pub struct Output<'d, T: Pin> { pub struct Output<'d, T: Pin> {
pub(crate) pin: Flex<'d, T>, pub(crate) pin: Flex<'d, T>,
} }
@@ -418,6 +422,10 @@ impl<'d, T: Pin> Output<'d, T> {
} }
/// GPIO output open-drain driver. /// GPIO output open-drain driver.
///
/// Note that pins will **return to their floating state** when `OutputOpenDrain` is dropped.
/// If pins should retain their state indefinitely, either keep ownership of the
/// `OutputOpenDrain`, or pass it to [`core::mem::forget`].
pub struct OutputOpenDrain<'d, T: Pin> { pub struct OutputOpenDrain<'d, T: Pin> {
pub(crate) pin: Flex<'d, T>, pub(crate) pin: Flex<'d, T>,
} }