ddevmem 0.4.0

Safe, ergonomic access to physical memory via /dev/mem with volatile MMIO semantics, declarative register maps, and an optional web UI.
Documentation 
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

//! Example: two instances of the same register-map type at different base
//! addresses, served on a single web page. Also demonstrates typed bitfields
//! (bool, u8, enum).
//!
//! Run with:
//!   cargo run --example web_same_map --no-default-features --features "emulator,web"
//!
//! Then open http://localhost:3000/hw/ and verify:
//!   - Two `TimerRegs` sections appear with different base addresses.
//!   - Enum fields show dropdown selectors.
//!   - Bool fields show true/false dropdowns.

use std::sync::Arc;

use ddevmem::{register_map, DevMem};
use tokio::sync::Mutex;

register_map! {
    /// Timer controller.
    pub unsafe map TimerRegs (u32) {
        0x00 =>
            /// Timer control register.
            rw cr: u32 {
                /// Timer enable flag.
                enable: 0 as bool,
                /// One-pulse mode.
                one_pulse: 1 as bool,
                /// Clock prescaler (0–15).
                psc: 2..=5 as u8,
                /// Operating mode.
                mode: 6..=7 as enum TimerMode {
                    Stopped  = 0,
                    OneShot  = 1,
                    FreeRun  = 2,
                    External = 3,
                }
            },
        0x04 =>
            /// Timer status register.
            ro sr: u32 {
                /// Counter active flag.
                active: 0 as bool,
                /// Overflow flag.
                overflow: 1 as bool
            },
        0x08 =>
            /// Counter value.
            rw cnt: u32
    }
}

#[tokio::main(flavor = "current_thread")]
async fn main() {
    // Two timer peripherals at different physical addresses.
    let tim1_mem = unsafe { DevMem::new(0x4000_0000, Some(256)).unwrap() };
    let tim2_mem = unsafe { DevMem::new(0x4000_1000, Some(256)).unwrap() };

    let mut tim1 = unsafe { TimerRegs::new(Arc::new(tim1_mem)).unwrap() };
    let mut tim2 = unsafe { TimerRegs::new(Arc::new(tim2_mem)).unwrap() };

    // Give them different initial values.
    tim1.set_cr_enable(true);
    tim1.set_cr_mode(TimerMode::FreeRun);
    tim1.set_cnt(1000);

    tim2.set_cr_enable(false);
    tim2.set_cr_mode(TimerMode::External);
    tim2.set_cnt(42);

    let app = axum::Router::new().nest(
        "/hw",
        ddevmem::web::WebUi::new()
            .add("timer1", Arc::new(Mutex::new(tim1)))
            .add("timer2", Arc::new(Mutex::new(tim2)))
            .build(),
    );

    let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
    println!("Web UI at http://localhost:3000/hw/");
    println!("  timer1 @ 0x4000_0000, timer2 @ 0x4000_1000");
    axum::serve(listener, app).await.unwrap();
}