bare-metal-1.0.0/.cargo_vcs_info.json0000644000000001121367674341700131550ustar00{ "git": { "sha1": "271d17d67fb6e214b7c50f7d0ca30e24d4ab3ba9" } } bare-metal-1.0.0/.github/CODEOWNERS010066400017500001750000000001601367221323500147000ustar0000000000000000* rust-embedded/cortex-a rust-embedded/cortex-m rust-embedded/cortex-r rust-embedded/msp430 rust-embedded/riscv bare-metal-1.0.0/.github/bors.toml010066400017500001750000000002121367221323500151450ustar0000000000000000block_labels = ["needs-decision"] delete_merged_branches = true required_approvals = 1 status = ["continuous-integration/travis-ci/push"] bare-metal-1.0.0/.gitignore010066400017500001750000000000371360522226200137340ustar0000000000000000/target/ **/*.rs.bk Cargo.lock bare-metal-1.0.0/.travis.yml010066400017500001750000000007401367221323500140620ustar0000000000000000language: rust matrix: allow_failures: - rust: nightly include: - rust: stable if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master) - rust: nightly if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master) # MSRV - rust: 1.31.0 if: (branch = staging OR branch = trying) OR (type = pull_request AND branch = master) branches: only: - master - staging - trying bare-metal-1.0.0/CHANGELOG.md010066400017500001750000000046451367674340000136000ustar0000000000000000# Change Log All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] ## [v1.0.0] - 2020-06-23 ### Breaking Changes - Use `CriticalSection<'cs>` everywhere instead of `&'cs CriticalSection` (this makes it a zero-sized type). - Removed the `const-fn` feature. - Removed the `Peripheral` wrapper type. ## [v0.2.5] - 2019-08-29 ### Changed - The `const-fn` feature is now stable. ## [v0.2.4] - 2018-10-30 ### Added - Note in the documentation that `Mutex` is not memory safe in multi-core systems. ### Changed - The `const-fn` feature can now be used on 1.31-beta and will also work on stable 1.31. ## [v0.2.3] - 2018-08-17 ### Fixed - A compilation error when using a recent nightly while the "const-fn" feature was enabled. ## [v0.2.2] - 2018-08-17 - YANKED ### Fixed - A compilation error when using a recent nightly while the "const-fn" feature was enabled. ## [v0.2.1] - 2018-08-03 ### Fixed - Soundness issue where it was possible to borrow the contents of a Mutex for longer than the lifetime of the Mutex. ## [v0.2.0] - 2018-05-10 - YANKED YANKED due to a soundness issue: see v0.2.1 for details ### Changed - [breaking-change] `const-fn` is no longer a default feature (i.e. a feature that's enabled by default). The consequence is that this crate now compiles on 1.27 (beta) by default, and opting into `const-fn` requires nightly. ## [v0.1.2] - 2018-04-24 ### Added - An opt-out "const-fn" Cargo feature. When this feature is disabled this crate compiles on stable. ## [v0.1.1] - 2017-09-19 ### Fixed - Added feature gate to make this work on recent nightlies ## v0.1.0 - 2017-07-06 - Initial release [Unreleased]: https://github.com/japaric/bare-metal/compare/v1.0.0...HEAD [v1.0.0]: https://github.com/japaric/bare-metal/compare/v0.2.5...v1.0.0 [v0.2.5]: https://github.com/japaric/bare-metal/compare/v0.2.4...v0.2.5 [v0.2.4]: https://github.com/japaric/bare-metal/compare/v0.2.3...v0.2.4 [v0.2.3]: https://github.com/japaric/bare-metal/compare/v0.2.2...v0.2.3 [v0.2.2]: https://github.com/japaric/bare-metal/compare/v0.2.1...v0.2.2 [v0.2.1]: https://github.com/japaric/bare-metal/compare/v0.2.0...v0.2.1 [v0.2.0]: https://github.com/japaric/bare-metal/compare/v0.1.2...v0.2.0 [v0.1.2]: https://github.com/japaric/bare-metal/compare/v0.1.1...v0.1.2 [v0.1.1]: https://github.com/japaric/bare-metal/compare/v0.1.0...v0.1.1 bare-metal-1.0.0/CODE_OF_CONDUCT.md010066400017500001750000000110141367221323500145440ustar0000000000000000# The Rust Code of Conduct ## Conduct **Contact**: [Embedded WG][wg] * We are committed to providing a friendly, safe and welcoming environment for all, regardless of level of experience, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, nationality, or other similar characteristic. * On Matrix and IRC, please avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all. * Please be kind and courteous. There's no need to be mean or rude. * Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs. There is seldom a right answer. * Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works. * We will exclude you from interaction if you insult, demean or harass anyone. That is not welcome behavior. We interpret the term "harassment" as including the definition in the [Citizen Code of Conduct](http://citizencodeofconduct.org/); if you have any lack of clarity about what might be included in that concept, please read their definition. In particular, we don't tolerate behavior that excludes people in socially marginalized groups. * Private harassment is also unacceptable. No matter who you are, if you feel you have been or are being harassed or made uncomfortable by a community member, please contact one of the channel ops or any of the [Embedded WG][wg] immediately. Whether you're a regular contributor or a newcomer, we care about making this community a safe place for you and we've got your back. * Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome. ## Moderation These are the policies for upholding our community's standards of conduct. 1. Remarks that violate the Rust standards of conduct, including hateful, hurtful, oppressive, or exclusionary remarks, are not allowed. (Cursing is allowed, but never targeting another user, and never in a hateful manner.) 2. Remarks that moderators find inappropriate, whether listed in the code of conduct or not, are also not allowed. 3. Moderators will first respond to such remarks with a warning. 4. If the warning is unheeded, the user will be "kicked," i.e., kicked out of the communication channel to cool off. 5. If the user comes back and continues to make trouble, they will be banned, i.e., indefinitely excluded. 6. Moderators may choose at their discretion to un-ban the user if it was a first offense and they offer the offended party a genuine apology. 7. If a moderator bans someone and you think it was unjustified, please take it up with that moderator, or with a different moderator, **in private**. Complaints about bans in-channel are not allowed. 8. Moderators are held to a higher standard than other community members. If a moderator creates an inappropriate situation, they should expect less leeway than others. In the Rust community we strive to go the extra step to look out for each other. Don't just aim to be technically unimpeachable, try to be your best self. In particular, avoid flirting with offensive or sensitive issues, particularly if they're off-topic; this all too often leads to unnecessary fights, hurt feelings, and damaged trust; worse, it can drive people away from the community entirely. And if someone takes issue with something you said or did, resist the urge to be defensive. Just stop doing what it was they complained about and apologize. Even if you feel you were misinterpreted or unfairly accused, chances are good there was something you could've communicated better — remember that it's your responsibility to make your fellow Rustaceans comfortable. Everyone wants to get along and we are all here first and foremost because we want to talk about cool technology. You will find that people will be eager to assume good intent and forgive as long as you earn their trust. The enforcement policies listed above apply to all official embedded WG venues; including the official Matrix room (#rust-embedded:matrix.org) and linked IRC channels (#rust-embedded on Freenode); GitHub repositories under rust-embedded; and all forums under rust-embedded.org (forum.rust-embedded.org). *Adapted from the [Node.js Policy on Trolling](http://blog.izs.me/post/30036893703/policy-on-trolling) as well as the [Contributor Covenant v1.3.0](https://www.contributor-covenant.org/version/1/3/0/).* [wg]: https://github.com/rust-embedded/wg#organization bare-metal-1.0.0/Cargo.toml0000644000000016731367674341700111700ustar00# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies # # If you believe there's an error in this file please file an # issue against the rust-lang/cargo repository. If you're # editing this file be aware that the upstream Cargo.toml # will likely look very different (and much more reasonable) [package] name = "bare-metal" version = "1.0.0" authors = ["Jorge Aparicio "] description = "Abstractions common to bare metal systems" documentation = "https://docs.rs/bare-metal" readme = "README.md" keywords = ["bare-metal", "register", "peripheral", "interrupt"] categories = ["embedded", "hardware-support", "no-std"] license = "MIT OR Apache-2.0" repository = "https://github.com/rust-embedded/bare-metal" bare-metal-1.0.0/Cargo.toml.orig010066400017500001750000000006561367674340000146540ustar0000000000000000[package] authors = ["Jorge Aparicio "] categories = ["embedded", "hardware-support", "no-std"] description = "Abstractions common to bare metal systems" documentation = "https://docs.rs/bare-metal" keywords = ["bare-metal", "register", "peripheral", "interrupt"] license = "MIT OR Apache-2.0" name = "bare-metal" repository = "https://github.com/rust-embedded/bare-metal" version = "1.0.0" readme = "README.md" bare-metal-1.0.0/LICENSE-APACHE010066400017500001750000000251371360522226200137000ustar0000000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. bare-metal-1.0.0/LICENSE-MIT010066400017500001750000000020421360522226200133760ustar0000000000000000Copyright (c) 2017 Jorge Aparicio Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. bare-metal-1.0.0/README.md010066400017500001750000000023361367221413600132340ustar0000000000000000# `bare-metal` > Abstractions common to bare metal systems This project is developed and maintained by the [Cortex-A, Cortex-M, Cortex-R, MSP430, and RISCV teams][teams]. ## [Change log](CHANGELOG.md) ## Minimum Supported Rust Version (MSRV) This crate is guaranteed to compile on stable Rust 1.31.0 and up. It *might* compile with older versions but that may change in any new patch release. ## License Licensed under either of - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. ### Contribution Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. ## Code of Conduct Contribution to this crate is organized under the terms of the [Rust Code of Conduct][CoC], the maintainers of this crate, the [Cortex-A, Cortex-M, Cortex-R, MSP430, and RISCV teams][teams], promise to intervene to uphold that code of conduct. [CoC]: CODE_OF_CONDUCT.md [teams]: https://github.com/rust-embedded/wg#organization bare-metal-1.0.0/ci/install.sh010066400017500001750000000002031360522226200143340ustar0000000000000000set -euxo pipefail main() { if [ $TARGET != x86_64-unknown-linux-gnu ]; then rustup target add $TARGET fi } main bare-metal-1.0.0/ci/script.sh010066400017500001750000000002651367674340000142140ustar0000000000000000set -euxo pipefail export RUSTFLAGS="-D warnings" main() { cargo check --target $TARGET if [ $TARGET = x86_64-unknown-linux-gnu ]; then cargo test fi } main bare-metal-1.0.0/src/lib.rs010066400017500001750000000064331367674340000136670ustar0000000000000000//! Abstractions common to bare metal systems. #![deny(missing_docs)] #![no_std] #![doc(html_root_url="https://docs.rs/bare-metal/1.0")] use core::cell::UnsafeCell; use core::marker::PhantomData; /// Critical section token. /// /// An instance of this type indicates that the current core is executing code within a critical /// section. This means that no interrupts must be enabled that could preempt the currently running /// code. #[derive(Clone, Copy, Debug)] pub struct CriticalSection<'cs> { _0: PhantomData<&'cs ()>, } impl<'cs> CriticalSection<'cs> { /// Creates a critical section token. /// /// This method is meant to be used to create safe abstractions rather than being directly used /// in applications. /// /// # Safety /// /// This must only be called when the current core is in a critical section. The caller must /// ensure that the returned instance will not live beyond the end of the critical section. /// Moreover, the caller must use adequate fences to prevent the compiler from moving the /// instructions inside the critical section to the outside of it. Sequentially consistent fences are /// suggested immediately after entry and immediately before exit from the critical section. /// /// Note that the lifetime `'cs` of the returned instance is unconstrained. User code must not /// be able to influence the lifetime picked for this type, since that might cause it to be /// inferred to `'static`. #[inline(always)] pub unsafe fn new() -> Self { CriticalSection { _0: PhantomData } } } /// A "mutex" based on critical sections. /// /// # Safety /// /// **This Mutex is only safe on single-core systems.** /// /// On multi-core systems, a `CriticalSection` **is not sufficient** to ensure exclusive access. #[derive(Debug)] pub struct Mutex { inner: UnsafeCell, } impl Mutex { /// Creates a new mutex. pub const fn new(value: T) -> Self { Mutex { inner: UnsafeCell::new(value), } } /// Gets a mutable reference to the contained value when the mutex is already uniquely borrowed. /// /// This does not require locking or a critical section since it takes `&mut self`, which /// guarantees unique ownership already. Care must be taken when using this method to /// **unsafely** access `static mut` variables, appropriate fences must be used to prevent /// unwanted optimizations. pub fn get_mut(&mut self) -> &mut T { unsafe { &mut *self.inner.get() } } /// Unwraps the contained value, consuming the mutex. pub fn into_inner(self) -> T { self.inner.into_inner() } /// Borrows the data for the duration of the critical section. pub fn borrow<'cs>(&'cs self, _cs: CriticalSection<'cs>) -> &'cs T { unsafe { &*self.inner.get() } } } // NOTE A `Mutex` can be used as a channel so the protected data must be `Send` // to prevent sending non-Sendable stuff (e.g. access tokens) across different // execution contexts (e.g. interrupts) unsafe impl Sync for Mutex where T: Send {} /// ``` compile_fail /// fn bad(cs: bare_metal::CriticalSection) -> &u32 { /// let x = bare_metal::Mutex::new(42u32); /// x.borrow(cs) /// } /// ``` #[allow(dead_code)] #[doc(hidden)] const GH_6: () = (); bare-metal-1.0.0/triagebot.toml010066400017500001750000000000111367221323500146150ustar0000000000000000[assign]