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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
use super::{
bitrange, Access, BitRange, BuildError, DimElement, EmptyToNone, EnumeratedValues, MaybeArray,
ModifiedWriteValues, Name, ReadAction, SvdError, Usage, ValidateLevel, WriteConstraint,
};
pub type Field = MaybeArray<FieldInfo>;
#[derive(Clone, Debug, PartialEq, Eq, thiserror::Error)]
pub enum Error {
#[error("You can have 0, 1 or 2 enumeratedValues with different usage")]
IncompatibleEnumeratedValues,
}
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
#[derive(Clone, Debug, PartialEq)]
#[non_exhaustive]
pub struct FieldInfo {
pub name: String,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub description: Option<String>,
#[cfg_attr(feature = "serde", serde(flatten))]
pub bit_range: BitRange,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub access: Option<Access>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub modified_write_values: Option<ModifiedWriteValues>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub write_constraint: Option<WriteConstraint>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub read_action: Option<ReadAction>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Vec::is_empty")
)]
pub enumerated_values: Vec<EnumeratedValues>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub derived_from: Option<String>,
}
pub fn bit_offsets<'a>(info: &'a FieldInfo, dim: &'a DimElement) -> impl Iterator<Item = u32> + 'a {
(0..dim.dim).map(move |i| info.bit_offset() + i * dim.dim_increment)
}
#[derive(Clone, Debug, Default, PartialEq)]
pub struct FieldInfoBuilder {
name: Option<String>,
description: Option<String>,
bit_range: Option<BitRange>,
bit_offset: Option<u32>,
bit_width: Option<u32>,
access: Option<Access>,
modified_write_values: Option<ModifiedWriteValues>,
write_constraint: Option<WriteConstraint>,
read_action: Option<ReadAction>,
enumerated_values: Option<Vec<EnumeratedValues>>,
derived_from: Option<String>,
}
impl From<FieldInfo> for FieldInfoBuilder {
fn from(f: FieldInfo) -> Self {
Self {
name: Some(f.name),
description: f.description,
bit_range: Some(f.bit_range),
bit_offset: None,
bit_width: None,
access: f.access,
modified_write_values: f.modified_write_values,
write_constraint: f.write_constraint,
read_action: f.read_action,
enumerated_values: Some(f.enumerated_values),
derived_from: f.derived_from,
}
}
}
impl FieldInfoBuilder {
pub fn name(mut self, value: String) -> Self {
self.name = Some(value);
self
}
pub fn description(mut self, value: Option<String>) -> Self {
self.description = value;
self
}
pub fn bit_range(mut self, value: BitRange) -> Self {
self.bit_range = Some(value);
self.bit_offset = None;
self.bit_width = None;
self
}
pub fn bit_offset(mut self, value: u32) -> Self {
if let Some(bit_range) = self.bit_range.as_mut() {
bit_range.offset = value;
} else if let Some(width) = self.bit_offset {
self.bit_range = Some(BitRange::from_offset_width(value, width));
self.bit_width = None;
} else {
self.bit_offset = Some(value);
}
self
}
pub fn bit_width(mut self, value: u32) -> Self {
if let Some(bit_range) = self.bit_range.as_mut() {
bit_range.width = value;
} else if let Some(offset) = self.bit_offset {
self.bit_range = Some(BitRange::from_offset_width(offset, value));
self.bit_offset = None;
} else {
self.bit_width = Some(value);
}
self
}
pub fn access(mut self, value: Option<Access>) -> Self {
self.access = value;
self
}
pub fn modified_write_values(mut self, value: Option<ModifiedWriteValues>) -> Self {
self.modified_write_values = value;
self
}
pub fn write_constraint(mut self, value: Option<WriteConstraint>) -> Self {
self.write_constraint = value;
self
}
pub fn read_action(mut self, value: Option<ReadAction>) -> Self {
self.read_action = value;
self
}
pub fn enumerated_values(mut self, value: Vec<EnumeratedValues>) -> Self {
self.enumerated_values = Some(value);
self
}
pub fn derived_from(mut self, value: Option<String>) -> Self {
self.derived_from = value;
self
}
pub fn build(self, lvl: ValidateLevel) -> Result<FieldInfo, SvdError> {
let mut field = FieldInfo {
name: self
.name
.ok_or_else(|| BuildError::Uninitialized("name".to_string()))?,
description: self.description.empty_to_none(),
bit_range: self
.bit_range
.ok_or_else(|| BuildError::Uninitialized("bit_range".to_string()))?,
access: self.access,
modified_write_values: self.modified_write_values,
write_constraint: self.write_constraint,
read_action: self.read_action,
enumerated_values: self.enumerated_values.unwrap_or_default(),
derived_from: self.derived_from,
};
if !lvl.is_disabled() {
field.validate(lvl)?;
}
Ok(field)
}
}
impl FieldInfo {
pub fn builder() -> FieldInfoBuilder {
FieldInfoBuilder::default()
}
pub const fn single(self) -> Field {
Field::Single(self)
}
pub const fn array(self, dim: DimElement) -> Field {
Field::Array(self, dim)
}
pub fn modify_from(
&mut self,
builder: FieldInfoBuilder,
lvl: ValidateLevel,
) -> Result<(), SvdError> {
if let Some(name) = builder.name {
self.name = name;
}
if builder.description.is_some() {
self.description = builder.description.empty_to_none();
}
if let Some(bit_range) = builder.bit_range {
self.bit_range = bit_range;
}
if let Some(offset) = builder.bit_offset {
self.bit_range.offset = offset;
}
if let Some(width) = builder.bit_width {
self.bit_range.width = width;
}
if builder.access.is_some() {
self.access = builder.access;
}
if builder.derived_from.is_some() {
self.derived_from = builder.derived_from;
self.modified_write_values = None;
self.write_constraint = None;
self.enumerated_values = Vec::new();
} else {
if builder.modified_write_values.is_some() {
self.modified_write_values = builder.modified_write_values;
}
if builder.write_constraint.is_some() {
self.write_constraint = builder.write_constraint;
}
if builder.read_action.is_some() {
self.read_action = builder.read_action;
}
if let Some(enumerated_values) = builder.enumerated_values {
self.enumerated_values = enumerated_values;
}
}
if !lvl.is_disabled() {
self.validate(lvl)
} else {
Ok(())
}
}
pub fn validate(&mut self, lvl: ValidateLevel) -> Result<(), SvdError> {
if lvl.is_strict() {
super::check_dimable_name(&self.name, "name")?;
if let Some(name) = self.derived_from.as_ref() {
super::check_derived_name(name, "derivedFrom")?;
}
}
if self.bit_range.width == 0 {
return Err(bitrange::Error::ZeroWidth.into());
}
if self.bit_range.width < 64 {
for ev in &self.enumerated_values {
ev.check_range(0..2_u64.pow(self.bit_range.width))?;
}
}
if lvl.is_strict() {
match self.enumerated_values.as_slice() {
[] | [_] => {}
[ev1, ev2]
if matches!(ev1.usage(), None | Some(Usage::Read))
&& matches!(ev2.usage(), None | Some(Usage::Write)) => {}
[ev1, ev2]
if matches!(ev2.usage(), None | Some(Usage::Read))
&& matches!(ev1.usage(), None | Some(Usage::Write)) => {}
_ => return Err(Error::IncompatibleEnumeratedValues.into()),
}
}
Ok(())
}
pub fn bit_offset(&self) -> u32 {
self.bit_range.offset
}
pub fn bit_width(&self) -> u32 {
self.bit_range.width
}
pub fn lsb(&self) -> u32 {
self.bit_range.lsb()
}
pub fn msb(&self) -> u32 {
self.bit_range.msb()
}
pub fn get_enumerated_values(&self, usage: Usage) -> Option<&EnumeratedValues> {
match self.enumerated_values.len() {
1 | 2 => self
.enumerated_values
.iter()
.find(|ev| ev.usage() == Some(usage)),
_ => None,
}
}
pub fn get_mut_enumerated_values(&mut self, usage: Usage) -> Option<&mut EnumeratedValues> {
match self.enumerated_values.len() {
1 | 2 => self
.enumerated_values
.iter_mut()
.find(|ev| ev.usage() == Some(usage)),
_ => None,
}
}
}
impl Name for FieldInfo {
fn name(&self) -> &str {
&self.name
}
}