drone-core 0.7.0

//! Memory-mapped registers.
//!
//! # Mappings and Tokens
//!
//! Most register should be already mapped by platform crates.
//!
//! ```
//! # #![feature(proc_macro)]
//! # use std as core;
//! use core::mem::size_of_val;
//! use drone_core::reg::{tokens, mappings};
//! use drone_core::reg::prelude::*;
//!
//! mappings! {
//!   /// SysTick timer.
//!   STK; // block name
//!
//!   /// SysTick control and status register.
//!   CTRL { // register name
//!     0xE000_E010 // memory address
//!     0x20 // bit size
//!     0x0000_0000 // reset value
//!     RReg WReg; // list of marker traits for the register
//!
//!     /// Counter enable.
//!     ENABLE { // field name
//!       0 // offset
//!       1 // width
//!       RRegField WRegField // list of marker traits for the field
//!     }
//!   }
//! }
//!
//! tokens! {
//!   /// Register tokens.
//!   RegIndex;
//!
//!   STK {
//!     /// SysTick control and status register.
//!     CTRL;
//!   }
//! }
//!
//! fn main() {
//!   let regs = unsafe { RegIndex::new() };
//!   assert_eq!(size_of_val(&regs.stk_ctrl.enable), 0);
//!   assert_eq!(size_of_val(&regs.stk_ctrl), 0);
//!   assert_eq!(size_of_val(&regs), 0);
//! }
//! ```

pub mod prelude;

mod field;
mod hold;
mod raw;
#[cfg_attr(feature = "clippy", allow(module_inception))]
mod reg;
mod tag;
mod tokens;
mod val;

pub use self::field::*;
pub use self::hold::*;
pub use self::raw::*;
pub use self::reg::*;
pub use self::tag::*;
pub use self::tokens::*;
pub use self::val::*;
pub use drone_core_macros::{reg_mappings as mappings, reg_tokens as tokens};

/// Forkable token.
pub trait RegFork {
  /// Returns a duplicate of the token.
  fn fork(&mut self) -> Self;
}