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
use super::{
Access, BuildError, EmptyToNone, Field, ModifiedWriteValues, RegisterProperties, SvdError,
ValidateLevel, WriteConstraint,
};
#[derive(Clone, Debug, PartialEq, Eq, thiserror::Error)]
pub enum Error {
#[error("Register have `fields` tag, but it is empty")]
EmptyFields,
}
#[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 RegisterInfo {
pub name: String,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub display_name: Option<String>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub description: Option<String>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub alternate_group: Option<String>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub alternate_register: Option<String>,
pub address_offset: u32,
#[cfg_attr(feature = "serde", serde(flatten))]
pub properties: RegisterProperties,
#[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 fields: Option<Vec<Field>>,
#[cfg_attr(
feature = "serde",
serde(default, skip_serializing_if = "Option::is_none")
)]
pub derived_from: Option<String>,
}
#[derive(Clone, Debug, Default, PartialEq)]
pub struct RegisterInfoBuilder {
name: Option<String>,
display_name: Option<String>,
description: Option<String>,
alternate_group: Option<String>,
alternate_register: Option<String>,
address_offset: Option<u32>,
properties: RegisterProperties,
modified_write_values: Option<ModifiedWriteValues>,
write_constraint: Option<WriteConstraint>,
fields: Option<Vec<Field>>,
derived_from: Option<String>,
}
impl From<RegisterInfo> for RegisterInfoBuilder {
fn from(r: RegisterInfo) -> Self {
Self {
name: Some(r.name),
display_name: r.display_name,
description: r.description,
alternate_group: r.alternate_group,
alternate_register: r.alternate_register,
address_offset: Some(r.address_offset),
properties: r.properties,
modified_write_values: r.modified_write_values,
write_constraint: r.write_constraint,
fields: r.fields,
derived_from: r.derived_from,
}
}
}
impl RegisterInfoBuilder {
pub fn name(mut self, value: String) -> Self {
self.name = Some(value);
self
}
pub fn display_name(mut self, value: Option<String>) -> Self {
self.display_name = value;
self
}
pub fn description(mut self, value: Option<String>) -> Self {
self.description = value;
self
}
pub fn alternate_group(mut self, value: Option<String>) -> Self {
self.alternate_group = value;
self
}
pub fn alternate_register(mut self, value: Option<String>) -> Self {
self.alternate_register = value;
self
}
pub fn address_offset(mut self, value: u32) -> Self {
self.address_offset = Some(value);
self
}
pub fn properties(mut self, value: RegisterProperties) -> Self {
self.properties = value;
self
}
pub fn size(mut self, value: Option<u32>) -> Self {
self.properties.size = value;
self
}
pub fn access(mut self, value: Option<Access>) -> Self {
self.properties.access = value;
self
}
pub fn reset_value(mut self, value: Option<u64>) -> Self {
self.properties.reset_value = value;
self
}
pub fn reset_mask(mut self, value: Option<u64>) -> Self {
self.properties.reset_mask = 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 fields(mut self, value: Option<Vec<Field>>) -> Self {
self.fields = value;
self
}
pub fn derived_from(mut self, value: Option<String>) -> Self {
self.derived_from = value;
self
}
pub fn build(self, lvl: ValidateLevel) -> Result<RegisterInfo, SvdError> {
let mut reg = RegisterInfo {
name: self
.name
.ok_or_else(|| BuildError::Uninitialized("name".to_string()))?,
display_name: self.display_name,
description: self.description,
alternate_group: self.alternate_group,
alternate_register: self.alternate_register,
address_offset: self
.address_offset
.ok_or_else(|| BuildError::Uninitialized("address_offset".to_string()))?,
properties: self.properties.build(lvl)?,
modified_write_values: self.modified_write_values,
write_constraint: self.write_constraint,
fields: self.fields,
derived_from: self.derived_from,
};
if !lvl.is_disabled() {
reg.validate(lvl)?;
}
Ok(reg)
}
}
impl RegisterInfo {
pub fn builder() -> RegisterInfoBuilder {
RegisterInfoBuilder::default()
}
pub fn modify_from(
&mut self,
builder: RegisterInfoBuilder,
lvl: ValidateLevel,
) -> Result<(), SvdError> {
if let Some(name) = builder.name {
self.name = name;
}
if builder.display_name.is_some() {
self.display_name = builder.display_name.empty_to_none();
}
if builder.description.is_some() {
self.description = builder.description.empty_to_none();
}
if builder.alternate_group.is_some() {
self.alternate_group = builder.alternate_group.empty_to_none();
}
if builder.alternate_register.is_some() {
self.alternate_register = builder.alternate_register.empty_to_none();
}
if let Some(address_offset) = builder.address_offset {
self.address_offset = address_offset;
}
if builder.derived_from.is_some() {
self.derived_from = builder.derived_from;
self.fields = None;
self.properties = RegisterProperties::default();
self.modified_write_values = None;
self.write_constraint = None;
} else {
self.properties.modify_from(builder.properties, lvl)?;
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.fields.is_some() {
self.fields = builder.fields.empty_to_none();
}
}
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.alternate_group.as_ref() {
super::check_name(name, "alternateGroup")?;
}
if let Some(name) = self.alternate_register.as_ref() {
super::check_dimable_name(name, "alternateRegister")?;
}
}
if let Some(name) = self.derived_from.as_ref() {
if lvl.is_strict() {
super::check_derived_name(name, "derivedFrom")?;
}
} else if let Some(fields) = self.fields.as_ref() {
if fields.is_empty() && lvl.is_strict() {
return Err(Error::EmptyFields.into());
}
}
Ok(())
}
}