diff options
| author |  bors[bot] <26634292+bors[bot]@users.noreply.github.com>
| 2020-08-27 22:02:19 +0000 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2020-08-27 22:02:19 +0000 |
| commit | 36886f19b6ca0ac3b30ddf8543d330a445506057 (patch) | |
| tree | e2dd3d835c95d94781217e00229b1df94604cbe2 /src/lib.rs | |
| parent | bbf4a54a69631653c2bd1b66ce910b6869f240ec (diff) | |
| parent | 346cd48ad3daf8b1a5b9ae0913defccc5259fdc5 (diff) | |
| download | cortex-m-36886f19b6ca0ac3b30ddf8543d330a445506057.tar.gz cortex-m-36886f19b6ca0ac3b30ddf8543d330a445506057.tar.zst cortex-m-36886f19b6ca0ac3b30ddf8543d330a445506057.zip | |
Merge #259
259: Rust assembly stubs r=thalesfragoso a=jonas-schievink
Disclaimer: I have not tested any of this (help wanted, we have no tests in here).
Thanks to @therealprof for nerd-sniping me into oblivion.
Fixes https://github.com/rust-embedded/cortex-m/issues/254
Fixes https://github.com/rust-embedded/cortex-m/issues/194
Fixes https://github.com/rust-embedded/cortex-m/issues/139
# Summary
* Remove the assembly files in favor of a new `asm.rs`, which uses unstable inline assembly and provides a C ABI interface.
* Replace the shell scripts by a [`cargo-xtask`](https://github.com/matklad/cargo-xtask/).
* While we're at it, also pre-build artifacts that are compatible with linker-plugin LTO, fixing https://github.com/rust-embedded/cortex-m/issues/139 (again, not tested)
This means that contributors and maintainers just need ~~a nightly Rust compiler installed~~ to run `cargo xtask assemble`. No binutils, no assembler, no `ar`, no GCC/Clang, and especially nothing from the godawful Arm servers, fixing https://github.com/rust-embedded/cortex-m/issues/194. You don't even have to install the correct nightly Rust toolchain, `cargo xtask` does it for you (and installs all the thumb targets too).
Co-authored-by: Jonas Schievink <jonasschievink@gmail.com>
Diffstat (limited to 'src/lib.rs')
| -rw-r--r-- | src/lib.rs | 26 |
1 files changed, 26 insertions, 0 deletions
@@ -24,6 +24,32 @@ //! //! The disadvantage is that `inline-asm` requires a nightly toolchain. //! +//! ## `cm7-r0p1` +//! +//! This feature enables workarounds for errata found on Cortex-M7 chips with revision r0p1. Some +//! functions in this crate only work correctly on those chips if this Cargo feature is enabled +//! (the functions are documented accordingly). +//! +//! ## `linker-plugin-lto` +//! +//! This feature links against prebuilt assembly blobs that are compatible with [Linker-Plugin LTO]. +//! This allows inlining assembly routines into the caller, even without the `inline-asm` feature, +//! and works on stable Rust (but note the drawbacks below!). +//! +//! If you want to use this feature, you need to be aware of a few things: +//! +//! - You need to make sure that `-Clinker-plugin-lto` is passed to rustc. Please refer to the +//! [Linker-Plugin LTO] documentation for details. +//! +//! - You have to use a Rust version whose LLVM version is compatible with the toolchain in +//! `asm-toolchain`. +//! +//! - Due to a [Rust bug][rust-lang/rust#75940], this option does not work with optimization +//! levels `s` and `z`. +//! +//! [Linker-Plugin LTO]: https://doc.rust-lang.org/stable/rustc/linker-plugin-lto.html +//! [rust-lang/rust#75940]: https://github.com/rust-lang/rust/issues/75940 +//! //! # Minimum Supported Rust Version (MSRV) //! //! This crate is guaranteed to compile on stable Rust 1.31 and up. It *might* |