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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
#![doc(html_root_url = "https://docs.rs/ruspiro-register/0.5.4")]
#![cfg_attr(not(any(test, doctest)), no_std)]
use core::cmp::PartialEq;
use core::ops::{BitAnd, BitOr, Not, Shl, Shr};
use core::fmt;
mod macros;
pub trait RegisterType:
Copy
+ Clone
+ PartialEq
+ BitOr<Output = Self>
+ BitAnd<Output = Self>
+ Not<Output = Self>
+ Shl<Self, Output = Self>
+ Shr<Self, Output = Self>
{
}
#[doc(hidden)]
macro_rules! registertype_impl {
($( $t:ty ),*) => ($(
impl RegisterType for $t { }
)*)
}
registertype_impl![u8, u16, u32, u64];
#[derive(Copy, Clone)]
pub struct RegisterField<T: RegisterType> {
mask: T,
shift: T,
}
#[derive(Copy, Clone)]
pub struct RegisterFieldValue<T: RegisterType> {
field: RegisterField<T>,
value: T,
}
#[doc(hidden)]
macro_rules! registerfield_impl {
($($t:ty),*) => ($(
impl RegisterField<$t> {
#[inline]
#[allow(dead_code)]
pub const fn new(mask: $t, shift: $t) -> RegisterField<$t> {
Self {
mask,
shift,
}
}
#[inline]
#[allow(dead_code)]
pub fn mask(&self) -> $t {
self.mask.checked_shl(self.shift as u32).unwrap_or(0)
}
#[allow(dead_code)]
#[inline]
pub fn shift(&self) -> $t {
self.shift
}
}
impl fmt::Debug for RegisterField<$t> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut high_bit = self.shift;
let mut mask = self.mask;
while mask > 0 {
high_bit += 1;
mask >>= 1;
};
high_bit -= 1;
write!(f, "RegisterField {{\n Bits: [{}:{}]\n Mask: {:#b}\n}}",
high_bit, self.shift, self.mask.checked_shl(self.shift as u32).unwrap_or(0))
}
}
impl RegisterFieldValue<$t> {
#[inline]
#[allow(dead_code)]
pub const fn new(field: RegisterField<$t>, value: $t) -> Self {
RegisterFieldValue {
field,
value: value & field.mask
}
}
#[inline]
#[allow(dead_code)]
pub const fn from_raw(field: RegisterField<$t>, raw_value: $t) -> Self {
RegisterFieldValue {
field,
value: (raw_value >> field.shift) & field.mask
}
}
#[inline]
#[allow(dead_code)]
pub fn value(&self) -> $t {
self.value
}
#[inline]
#[allow(dead_code)]
pub fn raw_value(&self) -> $t {
self.value.checked_shl(self.field.shift as u32).unwrap_or(0)
}
#[inline]
#[allow(dead_code)]
pub fn mask(&self) -> $t {
self.field.mask()
}
}
impl fmt::Debug for RegisterFieldValue<$t> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("RegisterFieldValue")
.field("field", &self.field)
.field("value", &self.value)
.field("raw_value", &self.raw_value())
.finish()
}
}
impl PartialEq for RegisterFieldValue<$t> {
fn eq(&self, other: &Self) -> bool {
self.value() == other.value()
}
}
impl BitOr for RegisterFieldValue<$t> {
type Output = RegisterFieldValue<$t>;
#[inline]
#[allow(dead_code)]
fn bitor(self, rhs: RegisterFieldValue<$t>) -> Self {
let field = RegisterField::<$t>::new( self.field.mask() | rhs.field.mask(), 0);
RegisterFieldValue {
field,
value: (self.raw_value() | rhs.raw_value()),
}
}
}
impl BitAnd for RegisterFieldValue<$t> {
type Output = RegisterFieldValue<$t>;
#[inline]
#[allow(dead_code)]
fn bitand(self, rhs: RegisterFieldValue<$t>) -> Self {
let field = RegisterField::<$t>::new( self.field.mask() & rhs.field.mask(), 0);
RegisterFieldValue {
field,
value: (self.raw_value() & rhs.raw_value()),
}
}
}
)*);
}
registerfield_impl![u8, u16, u32, u64];
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn register_field_mask() {
let field = RegisterField::<u32>::new(0x3, 6);
println!("{:?}", field);
assert_eq!(field.mask(), 0x3 << 6);
}
#[test]
fn register_field_shift() {
let field = RegisterField::<u16>::new(0x3, 3);
println!("{:?}", field);
assert_eq!(field.shift(), 3);
}
#[test]
fn register_field_value() {
let value = RegisterFieldValue::<u32>::new(RegisterField::<u32>::new(0x3, 6), 2);
println!("{:?}", value);
assert_eq!(value.value(), 2);
assert_eq!(value.raw_value(), 2 << 6);
}
#[test]
fn register_field_value_eq() {
let value1 = RegisterFieldValue::<u32>::new(
RegisterField::<u32>::new(3, 0), 7
);
let value2 = RegisterFieldValue::<u32>::new(
RegisterField::<u32>::new(3, 0), 7
);
println!("value1: {:?} =? value2: {:?}", value1, value2);
assert_eq!(value1, value2);
}
#[test]
fn register_field_value_or() {
let value1 = RegisterFieldValue::<u16>::new(RegisterField::<u16>::new(0xF, 0), 0xA);
let value2 = RegisterFieldValue::<u16>::new(RegisterField::<u16>::new(0x3, 4), 0x2);
let value_or = value1 | value2;
println!("{:?}", value_or);
assert_eq!(value_or.value(), 0xA | (0x2 << 4));
assert_eq!(value_or.raw_value(), 0xA | (0x2 << 4));
}
#[test]
fn register_field_value_and() {
let value1 = RegisterFieldValue::<u8>::new(RegisterField::<u8>::new(0xF, 0), 0xA);
let value2 = RegisterFieldValue::<u8>::new(RegisterField::<u8>::new(0x3, 2), 0x2);
let value_and = value1 & value2;
println!("{:?}", value_and);
assert_eq!(value_and.value(), 0xA & (0x2 << 2));
assert_eq!(value_and.raw_value(), 0xA & (0x2 << 2));
}
#[test]
fn register_value_update() {
let field_value = RegisterFieldValue::<u32>::new(RegisterField::<u32>::new(0x3, 8), 0b01);
let register_value: u32 = 0b1_1010_0011_0010;
let new_value: u32 = (register_value & !field_value.mask()) | field_value.raw_value();
assert_eq!(new_value, 0b1_1001_0011_0010);
}
}