registers 0.0.1

A simple library for working with registers in Rust.
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
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171

use registers::register;

#[register(size = 32)]
struct HIF1 {
    #[field(lsb = 0, msb = 15)]
    lower: u,
    #[field(lsb = 16, msb = 31)]
    upper: u,
}

#[register(size = 32)]
struct Signed {
    #[field(lsb = 0, msb = 15)]
    lower: i,
    #[field(lsb = 16, msb = 31)]
    upper: u,
}

#[register(size = 32)]
struct NonStandardSigned {
    #[field(lsb = 0, msb = 3)]
    lower_four: i,
    #[field(lsb = 4, msb = 31)]
    reserved: u,
}

#[test]
pub fn test_get() {
    let reg = HIF1::from(0xDEADBEEF);
    let upper = reg.get_upper();
    let lower = reg.get_lower();

    assert_eq!(upper, 0xDEAD);
    assert_eq!(lower, 0xBEEF);
}

#[test]
fn test_set() -> registers::Result<()> {
    let mut reg = HIF1::new();
    assert_eq!(reg.get_upper(), 0);
    assert_eq!(reg.get_lower(), 0);

    reg.set_upper(0xDEAD)?;
    reg.set_lower(0xBEEF)?;

    assert_eq!(reg.get_upper(), 0xDEAD);
    assert_eq!(reg.get_lower(), 0xBEEF);

    assert_eq!(
        reg.set_upper(0x1_0000),
        Err(registers::Error::OutOfBoundsFieldWrite)
    );
    assert_eq!(
        reg.set_lower(0x1_0000),
        Err(registers::Error::OutOfBoundsFieldWrite)
    );

    assert_eq!(reg.get_upper(), 0xDEAD);
    assert_eq!(reg.get_lower(), 0xBEEF);

    Ok(())
}

#[test]
fn test_new() {
    let reg = HIF1::new();
    assert_eq!(reg, 0);
}

#[test]
fn test_from() {
    let reg: HIF1 = 0xDEADBEEF.into();

    assert_eq!(reg.get_upper(), 0xDEAD);
    assert_eq!(reg.get_lower(), 0xBEEF);

    let reg = HIF1::from(0xDEADBEEF);

    assert_eq!(reg.get_upper(), 0xDEAD);
    assert_eq!(reg.get_lower(), 0xBEEF);
}

#[test]
fn test_into() {
    let reg = HIF1::from(0xDEADBEEF);
    assert_eq!(<HIF1 as Into<u32>>::into(reg), 0xDEADBEEF);
}

#[test]
fn test_clear() {
    let mut reg = HIF1::from(0xDEADBEEF);
    reg.clear();
    assert_eq!(<HIF1 as Into<u32>>::into(reg), 0);
}

#[test]
fn test_eq() {
    let reg = HIF1::from(0xDEADBEEF);
    assert_eq!(reg, 0xDEADBEEF);
}

#[test]
fn test_clone() {
    let reg = HIF1::from(0xDEADBEEF);
    assert_eq!(reg.clone(), 0xDEADBEEF);
}

#[test]
fn test_signed() {
    let mut reg = Signed::new();
    assert!(reg.set_lower(i16::MIN.into()).is_ok());

    assert_eq!(reg.get_upper(), 0);
    assert_eq!(reg.get_lower(), i16::MIN.into());

    assert!(reg.set_upper(u16::MAX.into()).is_ok());
    assert_eq!(reg.get_upper(), u16::MAX.into());
    assert_eq!(reg.get_lower(), i16::MIN.into());
}

#[test]
fn test_nonstd_signed() {
    let mut reg = NonStandardSigned::new();

    assert!(reg.set_lower_four(-8).is_ok());
    assert_eq!(reg.get_lower_four(), -8);
    assert_eq!(reg.get_reserved(), 0);

    assert!(reg.set_lower_four(-5).is_ok());
    assert_eq!(reg.get_lower_four(), -5);
    assert_eq!(reg.get_reserved(), 0);

    assert!(reg.set_lower_four(7).is_ok());
    assert_eq!(reg.get_lower_four(), 7);
    assert_eq!(reg.get_reserved(), 0);
}

#[test]
fn test_read() {
    let some_value: u32 = 0xDEADBEEF;
    let addr = &some_value as *const u32;

    let mut reg = HIF1::new();
    unsafe {
        reg.read(addr);
    }

    assert_eq!(reg.get_upper(), 0xDEAD);
    assert_eq!(reg.get_lower(), 0xBEEF);
}

#[test]
fn test_write() {
    let mut some_value: u32 = 0;
    let addr = &mut some_value as *mut u32;

    let mut reg = HIF1::new();
    reg.set_upper(0xDEAD).expect("Could not fit into bounds");
    reg.set_lower(0xBEEF).expect("Could not fit into bounds");

    unsafe {
        reg.write(addr);
    }

    assert_eq!(some_value, 0xDEADBEEF);
}

#[test]
fn test_size() {
    assert_eq!(size_of::<HIF1>(), size_of::<u32>());
}