1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! # shared-bus
//!
//! **shared-bus** is a crate to allow sharing bus peripherals
//! safely between multiple devices.
//!
//! To do so, **shared-bus** needs a mutex. Because each platform has its own
//! mutex type, **shared-bus** uses an abstraction: [`BusMutex`]. This type
//! needs to be implemented for your platforms mutex type to allow using this
//! crate.
//!
//! * If `std` is available, activate the `std` feature to enable the implementation
//!   of [`BusMutex`] for [`std::sync::Mutex`].
//! * If you platform is based on `cortex-m`, you can activate the `cortexm` feature
//!   to enable the implementation of [`BusMutex`] for [`cortex_m::interrupt::Mutex`]
//! * If neither is the case, take a look at the documentation of [`BusMutex`] for hints
//!   on how to implement it yourself.
//!
//! Typical usage of this crate might look like this:
//! ```
//! extern crate shared_bus;
//! # struct MyDevice;
//! # impl MyDevice {
//! #     pub fn new<T>(t: T) -> MyDevice { MyDevice }
//! # }
//!
//! # let i2c = ();
//! // Create your bus peripheral as usual:
//! // let i2c = I2c::i2c1(dp.I2C1, (scl, sda), 90.khz(), clocks, &mut rcc.apb1);
//!
//! let manager = shared_bus::BusManager::<std::sync::Mutex<_>, _>::new(i2c);
//!
//! // You can now acquire bus handles:
//! let mut handle = manager.acquire();
//! // handle implements `i2c::{Read, Write, WriteRead}`, depending on the
//! // implementations of the underlying peripheral
//! let mut mydevice = MyDevice::new(manager.acquire());
//! ```
#![doc(html_root_url = "https://docs.rs/shared-bus")]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(feature = "docsrs", feature(extern_prelude))]

extern crate embedded_hal as hal;
#[cfg(feature = "cortexm")]
extern crate cortex_m;

pub mod mutex;
pub mod proxy;

pub use mutex::BusMutex;
pub use proxy::BusManager;
pub use proxy::BusProxy;

/// Type alias for a bus manager using [`std::sync::Mutex`].
///
/// Only available if the `std` feature is active.
#[cfg(feature = "std")]
pub type StdBusManager<L, P> = BusManager<std::sync::Mutex<L>, P>;

/// Type alias for a bus manager using [`cortex_m::interrupt::Mutex`].
///
/// Only available if the `cortexm` feature is active.
#[cfg(feature = "cortexm")]
pub type CortexMBusManager<L, P> = BusManager<cortex_m::interrupt::Mutex<L>, P>;