rumio 0.2.0

Control your MMIO and CPU registers without pain.
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

use rumio::cpu::{RegisterRead, RegisterWrite};
use std::sync::atomic::{AtomicU64, Ordering};

const DEFAULT_REG_VALUE: u64 = 0b101;

thread_local! {
    static REGISTER: AtomicU64 = AtomicU64::new(DEFAULT_REG_VALUE);
}

fn reset_register() {
    REGISTER.with(|reg| reg.store(DEFAULT_REG_VALUE, Ordering::SeqCst))
}

fn assert_reg_eq(val: u64) {
    REGISTER.with(|reg| assert_eq!(val, reg.load(Ordering::SeqCst)))
}

struct CpuRegister;

impl RegisterRead<u64> for CpuRegister {
    fn read() -> u64 {
        REGISTER.with(|reg| reg.load(Ordering::SeqCst))
    }
}

impl RegisterWrite<u64> for CpuRegister {
    fn write(val: u64) {
        REGISTER.with(|reg| reg.store(val, Ordering::SeqCst))
    }

    fn set(mask: u64) {
        rumio::impl_cpu_set!(Self, mask);
    }

    fn clear(mask: u64) {
        rumio::impl_cpu_clear!(Self, mask);
    }
}

rumio::define_cpu_register! { CpuRegister as u64 =>
    rw MODE: 0..1 = enum Mode [
        A = 0b00,
        B = 0b01,
        C = 0b10,
        D = 0b11,
    ],

    r FOO: 2,

    rw BAR: 3,
    rw BAZ: 4,

    rw FLAGS: 5..8 = flags Flags [
        A = 0b0001,
        B = 0b0010,
        C = 0b0100,
        D = 0b1000,
    ],

    w WRITE: 9,
}

#[test]
fn read_write_single_bit() {
    reset_register();
    assert_reg_eq(DEFAULT_REG_VALUE);

    assert!(FOO::get());

    assert!(!BAR::get());
    assert!(!BAZ::get());

    BAR::set(true);
    assert_reg_eq(0b1101);
    assert!(BAR::get());
    assert!(!BAZ::get());

    BAZ::set(true);
    assert_reg_eq(0b11101);
    assert!(BAZ::get());
}

#[test]
fn read_write_enum() {
    reset_register();
    assert_reg_eq(DEFAULT_REG_VALUE);

    assert_eq!(MODE::get(), Some(Mode::B));

    MODE::set(Mode::C);
    assert_reg_eq(0b110);
    assert_eq!(MODE::get(), Some(Mode::C));
}

#[test]
fn read_write_flags() {
    reset_register();
    assert_reg_eq(DEFAULT_REG_VALUE);

    assert_eq!(FLAGS::get(), Flags::empty());

    FLAGS::set(Flags::A | Flags::C);
    assert_reg_eq(0b10100101);
    assert_eq!(FLAGS::get(), Flags::A | Flags::C);

    FLAGS::set(Flags::B | Flags::C);
    assert_reg_eq(0b11000101);
    assert_eq!(FLAGS::get(), Flags::B | Flags::C);
}

#[test]
fn modify_values() {
    reset_register();
    assert_reg_eq(DEFAULT_REG_VALUE);

    let val = Mode::B | BAZ::SET | Flags::A | Flags::B;
    modify(val);

    assert_eq!(FLAGS::get(), Flags::A | Flags::B);
    assert_eq!(MODE::get(), Some(Mode::B));
    assert!(BAZ::get());
}

#[test]
fn read_fields() {
    reset_register();
    assert_reg_eq(DEFAULT_REG_VALUE);

    let x = read(FOO::FIELD | Mode::field() | BAZ::FIELD);
    assert_eq!(x, 0b101);
    assert_reg_eq(DEFAULT_REG_VALUE);

    BAZ::set(true);
    let x = read(FOO::FIELD | Mode::field() | BAZ::FIELD);
    assert_eq!(x, 0b10101);
}