Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show features required for AtomicDevice in docs #645

Merged
merged 1 commit into from
Jan 26, 2025
Merged

Show features required for AtomicDevice in docs #645

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions embedded-hal-bus/src/spi/atomic.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ use crate::util::AtomicCell;
///
/// This primitive is particularly well-suited for applications that have external arbitration
/// rules that prevent `Busy` errors in the first place, such as the RTIC framework.
#[cfg_attr(
docsrs,
doc(cfg(any(feature = "portable-atomic", target_has_atomic = "8")))
)]
pub struct AtomicDevice<'a, BUS, CS, D> {
bus: &'a AtomicCell<BUS>,
cs: CS,
Expand All @@ -34,6 +38,10 @@ pub struct AtomicDevice<'a, BUS, CS, D> {

#[derive(Debug, Copy, Clone)]
/// Wrapper type for errors returned by [`AtomicDevice`].
#[cfg_attr(
docsrs,
doc(cfg(any(feature = "portable-atomic", target_has_atomic = "8")))
)]
pub enum AtomicError<T: Error> {
/// This error is returned if the SPI bus was already in use when an operation was attempted,
/// which indicates that the driver requirements are not being met with regard to
Expand Down
Loading