1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
//! Nordic Semi nRFx peripheral mappings for Drone, an Embedded Operating //! System. //! //! This crate uses //! [CMSIS-SVD](https://arm-software.github.io/CMSIS_5/SVD/html/index.html) //! files provided by [Nordic Semiconductor](https://www.nordicsemi.com/) to //! automatically generate Drone register and interrupt bindings. However only //! the corresponding Product Specification is the single source of truth. A //! difference between this crate bindings and the Product Specification is //! considered a bug. Fixing such a bug is *not a breaking change*. //! //! This crate re-exports the contents of [`drone_cortex_m::map`] module and is //! a drop-in replacement for it. //! //! # Supported Devices //! //! | `nrf_mcu` | Core name | Product specification | //! |------------|-----------------------|-----------------------------------------------------------------------| //! | `nrf52810` | ARM® Cortex®-M4F r0p1 | [PS v1.3](https://infocenter.nordicsemi.com/pdf/nRF52810_PS_v1.3.pdf) | //! | `nrf52811` | ARM® Cortex®-M4F r0p1 | [PS v1.0](https://infocenter.nordicsemi.com/pdf/nRF52811_PS_v1.0.pdf) | //! | `nrf52832` | ARM® Cortex®-M4F r0p1 | [PS v1.4](https://infocenter.nordicsemi.com/pdf/nRF52832_PS_v1.4.pdf) | //! | `nrf52840` | ARM® Cortex®-M4F r0p1 | [PS v1.1](https://infocenter.nordicsemi.com/pdf/nRF52840_PS_v1.1.pdf) | //! //! `nrf_mcu` config flag should be set at the application level according to //! this table. //! //! # Documentation //! //! - [Drone Book](https://book.drone-os.com/) //! - [API documentation](https://api.drone-os.com/drone-nrf-map/0.11/) //! //! The API documentation intentionally skips auto-generated [`reg`] and [`thr`] //! bindings. Otherwise it would use several gigabytes of space and would be //! very slow to render in a browser. One should refer to the Product //! Specification instead. And to get an idea of what the API looks like on the //! Drone side, look at the [`drone_cortex_m::map`] module documentation. //! //! # Usage //! //! Place the following to the Cargo.toml: //! //! ```toml //! [dependencies] //! drone-nrf-map = { version = "0.11.0", features = [...] } //! ``` #![deny(elided_lifetimes_in_paths)] #![warn(missing_docs)] #![warn(clippy::pedantic)] #![allow(clippy::doc_markdown)] #![no_std] pub mod reg; pub mod thr; pub use drone_nrf_map_pieces::nrf_reg_tokens;