Skip to content

Commit

Permalink
feat: introduce compile error if using atomic
Browse files Browse the repository at this point in the history
This change introduce a compile error if the toolchain is using a target
with atomics. It looks like at least on the the QingKe V4 atomics are
suspiciously broken.

There is also a feature you can enable
`i-understand-that-atomics-are-likely-broken` you can enable to remove
this compile error

See issue: ch32-rs/ch32-hal#59
  • Loading branch information
Codetector1374 committed Nov 3, 2024
1 parent 83fc3b7 commit bd48f68
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 3 deletions.
3 changes: 2 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ documentation = "https://docs.rs/qingke"
homepage = "https://github.com/ch32-rs/qingke"
categories = ["embedded", "no-std", "hardware-support"]
license = "MIT/Apache-2.0"
version = "0.4.0" # for rt and macros
version = "0.5.0" # for rt and macros
edition = "2021"

[package]
Expand Down Expand Up @@ -37,6 +37,7 @@ defmt = { version = "0.3.8", optional = true }
critical-section-impl = ["dep:critical-section"]
defmt = ["dep:defmt"]
v3 = []
unsafe-trust-wch-atomics = []

[package.metadata.docs.rs]
targets = ["riscv32imac-unknown-none-elf"]
4 changes: 2 additions & 2 deletions qingke-rt/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ u-mode = []
highcode = []

[dependencies]
qingke-rt-macros = { path = "./macros", version = "0.4" }
qingke = { path = "../", version = "0.4", features = ["critical-section-impl"] }
qingke-rt-macros = { path = "./macros" }
qingke = { path = "../", features = ["critical-section-impl"] }

[package.metadata.docs.rs]
targets = ["riscv32imac-unknown-none-elf"]
17 changes: 17 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,22 @@ pub mod register;
// re-export
pub use riscv;

#[cfg(all(
any(
target_has_atomic = "8",
// target_has_atomic = "16",
// target_has_atomic = "32",
// target_has_atomic = "64",
// target_has_atomic = "128",
// target_has_atomic = "ptr"
),
not(feature = "unsafe-trust-wch-atomics")
))]
compile_error!(
"As tested on QingKe V4, most likely the atomics are broken,
please validate the atomic instruction on the hardware using
something like litmus test suite before trusting them."
);

#[cfg(feature = "critical-section-impl")]
mod critical_section_impl;

0 comments on commit bd48f68

Please sign in to comment.