Skip to content

Commit b0a2647

Browse files
committed
Document critical-section-single-core feature.
1 parent 336bfc6 commit b0a2647

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/lib.rs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@
99
//!
1010
//! # Optional features
1111
//!
12+
//! ## `critical-section-single-core`
13+
//!
14+
//! This feature enables a [`critical-section`](https://github.com/rust-embedded/critical-section)
15+
//! implementation suitable for single-core targets, based on disabling interrupt globally.
16+
//!
17+
//! It is **unsound** to enable it on multi-core targets. You should use a target-specific
18+
//! implementation that synchronizes all cores instead, typically provided by the HAL crate.
19+
//!
1220
//! ## `cm7-r0p1`
1321
//!
1422
//! This feature enables workarounds for errata found on Cortex-M7 chips with revision r0p1. Some

0 commit comments

Comments
 (0)