rust-embedded / rust-embedded/cortex-m
Ship a 1.0 release
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1k
- Forks
- 202
- Avg merge
- 6d 2h
- Merged PRs (30d)
- 2
Description
Part of https://github.com/rust-embedded/wg/issues/383
Might also involve https://github.com/rust-lang/rust/issues/27731 so we can get rid of (some) of the inline asm / pre-compiled objects.
- Consider getting rid of aligned dependency subtree (https://github.com/rust-embedded/cortex-m/issues/184)
- Remove the
const-fnfeature - Remove all currently
#[deprecated]APIs - Land #181
- Audit the crate for other things that should be
#[cfg]d out depending on the target
- Audit the crate for other things that should be
- Make all types
#[non_exhaustive]where it makes sense - Use an svd2rust PAC instead of doing register access by hand
- Improve documentation of the
Peripherals::steal()API, or redesign that API (https://github.com/rust-embedded/cortex-m/issues/186) - Make usage from multi-core chips sound
- Document that the
inline-asmfeature is completely unstable and semver-exempt - Document availability of target-specific APIs (using
#[doc(cfg(X))]where possible) - Fix soundness bug in cache maintenance API https://github.com/rust-embedded/cortex-m/issues/188
- Fix soundness bugs around MMIO in general (https://github.com/rust-embedded/wg/pull/387)
- Review against API guidelines
- Update to
bare-metal1.0 (one released) - ...
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the remaining checklist in issue #183 and review the linked issues for multi-core support, Peripherals::steal(), MMIO soundness, and the working-group release context. Compare the crate against the Rust API Guidelines and the listed bare-metal update requirements. Done means the unresolved release checklist items are addressed and the crate is ready for a 1.0 release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- embedded-iot
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100