-
Notifications
You must be signed in to change notification settings - Fork 155
/
Copy pathregister.rs
1671 lines (1556 loc) · 61.5 KB
/
register.rs
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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use crate::svd::{
self, Access, BitRange, DimElement, EnumeratedValue, EnumeratedValues, Field, MaybeArray,
ModifiedWriteValues, ReadAction, Register, RegisterProperties, Usage, WriteConstraint,
WriteConstraintRange,
};
use log::warn;
use proc_macro2::{Delimiter, Group, Ident, Span, TokenStream};
use quote::quote;
use std::collections::HashSet;
use std::fmt::Write;
use std::{borrow::Cow, collections::BTreeMap};
use svd_parser::expand::{
derive_enumerated_values, derive_field, BlockPath, EnumPath, FieldPath, Index, RegisterPath,
};
use crate::config::Config;
use crate::util::{
self, ident, ident_to_path, path_segment, type_path, unsuffixed, DimSuffix, FullName, U32Ext,
};
use anyhow::{anyhow, Result};
use syn::punctuated::Punctuated;
fn regspec(name: &str, config: &Config, span: Span) -> Ident {
ident(name, config, "register_spec", span)
}
fn field_accessor(name: &str, config: &Config, span: Span) -> Ident {
const INTERNALS: [&str; 2] = ["bits", "set"];
let sc = config
.ident_formats
.get("field_accessor")
.unwrap()
.sanitize(name);
Ident::new(
&(if INTERNALS.contains(&sc.as_ref()) {
sc + "_"
} else {
sc
}),
span,
)
}
pub fn render(
register: &Register,
path: &BlockPath,
dpath: Option<RegisterPath>,
index: &Index,
config: &Config,
) -> Result<TokenStream> {
let mut name = util::name_of(register, config.ignore_groups);
// Rename if this is a derived array
if dpath.is_some() {
if let MaybeArray::Array(info, array_info) = register {
if let Some(dim_index) = &array_info.dim_index {
let index: Cow<str> = dim_index.first().unwrap().into();
name = info
.fullname(config.ignore_groups)
.expand_dim(&index)
.into()
}
}
}
let span = Span::call_site();
let reg_ty = ident(&name, config, "register", span);
let doc_alias = (reg_ty.to_string().as_str() != name).then(|| quote!(#[doc(alias = #name)]));
let mod_ty = ident(&name, config, "register_mod", span);
let description = util::respace(register.description.as_deref().unwrap_or_else(|| {
warn!("Missing description for register {}", register.name);
""
}));
let description = util::escape_special_chars(&description);
if let Some(dpath) = dpath.as_ref() {
let mut derived = if &dpath.block == path {
type_path(Punctuated::new())
} else {
util::block_path_to_ty(&dpath.block, config, span)
};
let dname = util::name_of(index.registers.get(dpath).unwrap(), config.ignore_groups);
let mut mod_derived = derived.clone();
derived
.path
.segments
.push(path_segment(ident(&dname, config, "register", span)));
mod_derived
.path
.segments
.push(path_segment(ident(&dname, config, "register_mod", span)));
Ok(quote! {
pub use #derived as #reg_ty;
pub use #mod_derived as #mod_ty;
})
} else {
let regspec_ty = regspec(&name, config, span);
let access = util::access_of(®ister.properties, register.fields.as_deref());
let accs = if access.can_read() && access.can_write() {
"rw"
} else if access.can_write() {
"w"
} else if access.can_read() {
"r"
} else {
return Err(anyhow!("Incorrect access of register {}", register.name));
};
let rpath = path.new_register(®ister.name);
let mut alias_doc = format!(
"{name} ({accs}) register accessor: {description}{}{}",
api_docs(
access.can_read(),
access.can_write(),
register.properties.reset_value.is_some(),
&mod_ty,
false,
register,
&rpath,
config,
)?,
read_action_docs(access.can_read(), register.read_action),
);
alias_doc +=
format!("\n\nFor information about available fields see [`mod@{mod_ty}`] module")
.as_str();
let mut out = TokenStream::new();
out.extend(quote! {
#[doc = #alias_doc]
#doc_alias
pub type #reg_ty = crate::Reg<#mod_ty::#regspec_ty>;
});
let mod_items = render_register_mod(register, access, &rpath, index, config)?;
out.extend(quote! {
#[doc = #description]
pub mod #mod_ty {
#mod_items
}
});
Ok(out)
}
}
fn read_action_docs(can_read: bool, read_action: Option<ReadAction>) -> String {
let mut doc = String::new();
if can_read {
if let Some(action) = read_action {
doc.push_str("\n\n<div class=\"warning\">");
doc.push_str(match action {
ReadAction::Clear => "The register is <b>cleared</b> (set to zero) following a read operation.",
ReadAction::Set => "The register is <b>set</b> (set to ones) following a read operation.",
ReadAction::Modify => "The register is <b>modified</b> in some way after a read operation.",
ReadAction::ModifyExternal => "One or more dependent resources other than the current register are immediately affected by a read operation.",
});
doc.push_str("</div>");
}
}
doc
}
#[allow(clippy::too_many_arguments)]
fn api_docs(
can_read: bool,
can_write: bool,
can_reset: bool,
module: &Ident,
inmodule: bool,
register: &Register,
rpath: &RegisterPath,
config: &Config,
) -> Result<String, std::fmt::Error> {
fn method(s: &str) -> String {
format!("[`{s}`](crate::Reg::{s})")
}
let mut doc = String::from("\n\n");
if can_read {
write!(
doc,
"You can {} this register and get [`{module}::R`]{}. ",
method("read"),
if inmodule { "(R)" } else { "" },
)?;
}
if can_write {
let mut methods = Vec::new();
if can_reset {
methods.push("reset");
methods.push("write");
}
methods.push("write_with_zero");
write!(
doc,
"You can {} this register using [`{module}::W`]{}. ",
methods
.iter()
.map(|m| method(m))
.collect::<Vec<_>>()
.join(", "),
if inmodule { "(W)" } else { "" },
)?;
}
if can_read && can_write {
write!(doc, "You can also {} this register. ", method("modify"))?;
}
doc.push_str("See [API](https://docs.rs/svd2rust/#read--modify--write-api).");
if let Some(url) = config.settings.html_url.as_ref() {
let first_idx = if let Register::Array(_, dim) = ®ister {
dim.indexes().next()
} else {
None
};
let rname = if let Some(idx) = first_idx {
let idx = format!("[{idx}]");
rpath.name.replace("[%s]", &idx).replace("%s", &idx)
} else {
rpath.name.clone()
};
// TODO: support html_urls for registers in cluster
if rpath.block.path.is_empty() {
doc.push_str(&format!(
"\n\nSee register [structure]({url}#{}:{})",
rpath.peripheral(),
rname
));
}
}
Ok(doc)
}
pub fn render_register_mod(
register: &Register,
access: Access,
rpath: &RegisterPath,
index: &Index,
config: &Config,
) -> Result<TokenStream> {
let properties = ®ister.properties;
let name = util::name_of(register, config.ignore_groups);
let rname = ®ister.name;
let span = Span::call_site();
let regspec_ty = regspec(&name, config, span);
let mod_ty = ident(&name, config, "register_mod", span);
let rsize = properties
.size
.ok_or_else(|| anyhow!("Register {rname} has no `size` field"))?;
let rsize = if rsize < 8 {
8
} else if rsize.is_power_of_two() {
rsize
} else {
rsize.next_power_of_two()
};
let rty = rsize.to_ty()?;
let description = util::respace(register.description.as_deref().unwrap_or_else(|| {
warn!("Missing description for register {rname}");
""
}));
let description = util::escape_special_chars(&description);
let mut mod_items = TokenStream::new();
let can_read = access.can_read();
let can_write = access.can_write();
let can_reset = properties.reset_value.is_some();
if can_read {
let desc = format!("Register `{rname}` reader");
mod_items.extend(quote! {
#[doc = #desc]
pub type R = crate::R<#regspec_ty>;
});
}
if can_write {
let desc = format!("Register `{rname}` writer");
mod_items.extend(quote! {
#[doc = #desc]
pub type W = crate::W<#regspec_ty>;
});
}
let mut r_impl_items = TokenStream::new();
let mut r_debug_impl = TokenStream::new();
let mut w_impl_items = TokenStream::new();
let mut zero_to_modify_fields_bitmap = 0;
let mut one_to_modify_fields_bitmap = 0;
let debug_feature = config
.impl_debug_feature
.as_ref()
.map(|feature| quote!(#[cfg(feature=#feature)]));
if let Some(cur_fields) = register.fields.as_ref() {
// filter out all reserved fields, as we should not generate code for
// them
let cur_fields: Vec<&Field> = cur_fields
.iter()
.filter(|field| field.name.to_lowercase() != "reserved")
.collect();
if !cur_fields.is_empty() {
if config.impl_debug {
r_debug_impl.extend(render_register_mod_debug(
register,
&access,
&cur_fields,
config,
))
}
(
r_impl_items,
w_impl_items,
zero_to_modify_fields_bitmap,
one_to_modify_fields_bitmap,
) = fields(
cur_fields,
®spec_ty,
register.modified_write_values,
access,
properties,
&mut mod_items,
rpath,
index,
config,
)?;
}
} else if !access.can_read() || register.read_action.is_some() {
r_debug_impl.extend(quote! {
#debug_feature
impl core::fmt::Debug for crate::generic::Reg<#regspec_ty> {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "(not readable)")
}
}
});
} else {
// no register fields are defined so implement Debug to get entire register value
r_debug_impl.extend(quote! {
#debug_feature
impl core::fmt::Debug for R {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
write!(f, "{}", self.bits())
}
}
});
}
if can_read && !r_impl_items.is_empty() {
mod_items.extend(quote! { impl R { #r_impl_items }});
}
if !r_debug_impl.is_empty() {
mod_items.extend(quote! { #r_debug_impl });
}
if can_write {
mod_items.extend(quote! {
impl W { #w_impl_items }
});
}
let doc = format!(
"{description}{}{}",
api_docs(can_read, can_write, can_reset, &mod_ty, true, register, rpath, config)?,
read_action_docs(access.can_read(), register.read_action),
);
mod_items.extend(quote! {
#[doc = #doc]
pub struct #regspec_ty;
impl crate::RegisterSpec for #regspec_ty {
type Ux = #rty;
}
});
if can_read {
let doc = format!("`read()` method returns [`{mod_ty}::R`](R) reader structure",);
mod_items.extend(quote! {
#[doc = #doc]
impl crate::Readable for #regspec_ty {
type Reader = R;
}
});
}
if can_write {
// the writer can be safe if:
// * there is a single field that covers the entire register
// * that field can represent all values
// * the write constraints of the register allow full range of values
let safe_ty = if let Safety::Safe = Safety::get(
register
.fields
.as_ref()
.and_then(|fields| fields.first())
.and_then(|field| field.write_constraint)
.as_ref(),
rsize,
) {
Safety::Safe
} else if let Safety::Safe = Safety::get(register.write_constraint.as_ref(), rsize) {
Safety::Safe
} else {
Safety::Unsafe
};
let safe_ty = safe_ty.ident(rsize);
let doc = format!("`write(|w| ..)` method takes [`{mod_ty}::W`](W) writer structure",);
let zero_to_modify_fields_bitmap = util::hex_nonzero(zero_to_modify_fields_bitmap)
.map(|bm| quote!(const ZERO_TO_MODIFY_FIELDS_BITMAP: #rty = #bm;));
let one_to_modify_fields_bitmap = util::hex_nonzero(one_to_modify_fields_bitmap)
.map(|bm| quote!(const ONE_TO_MODIFY_FIELDS_BITMAP: #rty = #bm;));
mod_items.extend(quote! {
#[doc = #doc]
impl crate::Writable for #regspec_ty {
type Writer = W;
type Safety = crate::#safe_ty;
#zero_to_modify_fields_bitmap
#one_to_modify_fields_bitmap
}
});
}
if let Some(rv) = properties.reset_value.map(util::hex_nonzero) {
let doc = if let Some(rv) = &rv {
format!("`reset()` method sets {} to value {rv}", register.name)
} else {
format!("`reset()` method sets {} to value 0", register.name)
};
let rv = rv.map(|rv| quote!(const RESET_VALUE: #rty = #rv;));
mod_items.extend(quote! {
#[doc = #doc]
impl crate::Resettable for #regspec_ty {
#rv
}
});
}
Ok(mod_items)
}
fn render_register_mod_debug(
register: &Register,
access: &Access,
cur_fields: &[&Field],
config: &Config,
) -> Result<TokenStream> {
let name = util::name_of(register, config.ignore_groups);
let span = Span::call_site();
let regspec_ty = regspec(&name, config, span);
let mut r_debug_impl = TokenStream::new();
let debug_feature = config
.impl_debug_feature
.as_ref()
.map(|feature| quote!(#[cfg(feature=#feature)]));
// implement Debug for register readable fields that have no read side effects
if access.can_read() && register.read_action.is_none() {
r_debug_impl.extend(quote! {
#debug_feature
impl core::fmt::Debug for R
});
let mut fmt_outer_impl = TokenStream::new();
fmt_outer_impl.extend(quote! {
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result
});
let mut fmt_inner_impl = TokenStream::new();
fmt_inner_impl.extend(quote! {
f.debug_struct(#name)
});
for &f in cur_fields.iter() {
let field_access = match &f.access {
Some(a) => a,
None => access,
};
log::debug!("register={} field={}", name, f.name);
if field_access.can_read() && f.read_action.is_none() {
if let Field::Array(_, de) = &f {
for suffix in de.indexes() {
let f_name_n = field_accessor(&f.name.expand_dim(&suffix), config, span);
let f_name_n_s = format!("{f_name_n}");
fmt_inner_impl.extend(quote! {
.field(#f_name_n_s, &self.#f_name_n())
});
}
} else {
let f_name = f.name.remove_dim();
let f_name = field_accessor(&f_name, config, span);
let f_name_s = format!("{f_name}");
fmt_inner_impl.extend(quote! {
.field(#f_name_s, &self.#f_name())
});
}
}
}
fmt_inner_impl.extend(quote! {
.finish()
});
let fmt_inner_group = Group::new(Delimiter::Brace, fmt_inner_impl);
fmt_outer_impl.extend(quote! { #fmt_inner_group });
let fmt_outer_group = Group::new(Delimiter::Brace, fmt_outer_impl);
r_debug_impl.extend(quote! { #fmt_outer_group });
} else if !access.can_read() || register.read_action.is_some() {
r_debug_impl.extend(quote! {
#debug_feature
impl core::fmt::Debug for crate::generic::Reg<#regspec_ty> {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
write!(f, "(not readable)")
}
}
});
} else {
warn!("not implementing debug for {name}");
}
Ok(r_debug_impl)
}
#[derive(Clone, Copy, Debug)]
pub enum EV<'a> {
New(&'a EnumeratedValues),
Derived(&'a EnumeratedValues, &'a EnumPath),
}
impl EV<'_> {
fn values(&self) -> &EnumeratedValues {
match self {
Self::New(e) | Self::Derived(e, _) => e,
}
}
}
impl<'a> From<&'a (EnumeratedValues, Option<EnumPath>)> for EV<'a> {
fn from(value: &'a (EnumeratedValues, Option<EnumPath>)) -> Self {
match value.1.as_ref() {
Some(base) => Self::Derived(&value.0, base),
None => Self::New(&value.0),
}
}
}
#[derive(Clone, Copy, Debug)]
pub enum RWEnum<'a> {
ReadWriteCommon(EV<'a>),
ReadWrite(ReadEnum<'a>, WriteEnum<'a>),
Read(ReadEnum<'a>),
Write(WriteEnum<'a>),
}
#[derive(Clone, Copy, Debug)]
pub enum ReadEnum<'a> {
Enum(EV<'a>),
Raw,
}
#[derive(Clone, Copy, Debug)]
pub enum WriteEnum<'a> {
Enum(EV<'a>),
Raw,
}
impl<'a> RWEnum<'a> {
pub fn different_enums(&self) -> bool {
matches!(self, Self::ReadWrite(ReadEnum::Enum(_), WriteEnum::Enum(_)))
}
pub fn read_write(&self) -> bool {
matches!(self, Self::ReadWriteCommon(_) | Self::ReadWrite(_, _))
}
pub fn read_only(&self) -> bool {
matches!(self, Self::Read(_))
}
pub fn can_read(&self) -> bool {
self.read_write() || self.read_only()
}
pub fn write_only(&self) -> bool {
matches!(self, Self::Write(_))
}
pub fn can_write(&self) -> bool {
self.read_write() || self.write_only()
}
pub fn read_enum(&self) -> Option<EV<'a>> {
match self {
Self::ReadWriteCommon(e)
| Self::ReadWrite(ReadEnum::Enum(e), _)
| Self::Read(ReadEnum::Enum(e)) => Some(*e),
_ => None,
}
}
pub fn write_enum(&self) -> Option<EV<'a>> {
match self {
Self::ReadWriteCommon(e)
| Self::ReadWrite(_, WriteEnum::Enum(e))
| Self::Write(WriteEnum::Enum(e)) => Some(*e),
_ => None,
}
}
pub fn generate_write_enum(&self) -> bool {
matches!(
self,
Self::ReadWrite(_, WriteEnum::Enum(_)) | Self::Write(WriteEnum::Enum(_))
)
}
}
#[allow(clippy::too_many_arguments)]
pub fn fields(
mut fields: Vec<&Field>,
regspec_ty: &Ident,
rmwv: Option<ModifiedWriteValues>,
access: Access,
properties: &RegisterProperties,
mod_items: &mut TokenStream,
rpath: &RegisterPath,
index: &Index,
config: &Config,
) -> Result<(TokenStream, TokenStream, u64, u64)> {
let mut r_impl_items = TokenStream::new();
let mut w_impl_items = TokenStream::new();
let mut zero_to_modify_fields_bitmap = 0u64;
let mut one_to_modify_fields_bitmap = 0u64;
let span = Span::call_site();
let can_read = access.can_read();
let can_write = access.can_write();
fields.sort_by_key(|f| f.bit_offset());
// Hack for #625
let mut enum_derives = HashSet::new();
let mut read_enum_derives = HashSet::new();
let mut write_enum_derives = HashSet::new();
let mut reader_derives = HashSet::new();
let mut writer_derives = HashSet::new();
// TODO enumeratedValues
let inline = quote! { #[inline(always)] };
for &f in fields.iter() {
let mut f = f.clone();
let mut fdpath = None;
if let Some(dpath) = f.derived_from.take() {
fdpath = derive_field(&mut f, &dpath, rpath, index)?;
}
let fpath = rpath.new_field(&f.name);
// TODO(AJM) - do we need to do anything with this range type?
let BitRange { offset, width, .. } = f.bit_range;
if f.is_single() && f.name.contains("%s") {
return Err(anyhow!("incorrect field {}", f.name));
}
let name = f.name.remove_dim();
let name_snake_case = field_accessor(
if let Field::Array(
_,
DimElement {
dim_name: Some(dim_name),
..
},
) = &f
{
dim_name
} else {
&name
},
config,
span,
);
let description_raw = f.description.as_deref().unwrap_or(""); // raw description, if absent using empty string
let description = util::respace(&util::escape_special_chars(description_raw));
let can_read = can_read
&& (f.access != Some(Access::WriteOnly))
&& (f.access != Some(Access::WriteOnce));
let can_write = can_write && (f.access != Some(Access::ReadOnly));
let mask = u64::MAX >> (64 - width);
let hexmask = &util::digit_or_hex(mask);
let offset = u64::from(offset);
let rv = properties.reset_value.map(|rv| (rv >> offset) & mask);
let fty = width.to_ty()?;
let (use_cast, use_mask) = if let Some(size) = properties.size {
let size = size.to_ty_width()?;
(size != width.to_ty_width()?, size != width)
} else {
(true, true)
};
let mut lookup_results = Vec::new();
for mut ev in f.enumerated_values.clone().into_iter() {
let mut epath = None;
let dpath = ev.derived_from.take();
if let Some(dpath) = dpath {
epath = Some(derive_enumerated_values(&mut ev, &dpath, &fpath, index)?);
// TODO: remove this hack
if let Some(epath) = epath.as_ref() {
ev = (*index.evs.get(epath).unwrap()).clone();
}
} else if let Some(path) = fdpath.as_ref() {
epath = Some(
path.new_enum(
ev.name
.clone()
.unwrap_or_else(|| path.name.remove_dim().into()),
),
);
}
lookup_results.push((ev, epath));
}
let rwenum = match (
can_read,
lookup_filter(&lookup_results, Usage::Read),
can_write,
lookup_filter(&lookup_results, Usage::Write),
) {
(true, Some(e1), true, Some(e2)) if e1.0 == e2.0 => RWEnum::ReadWriteCommon(e1.into()),
(true, Some(e1), true, Some(e2)) => {
RWEnum::ReadWrite(ReadEnum::Enum(e1.into()), WriteEnum::Enum(e2.into()))
}
(true, Some(e), true, None) => {
RWEnum::ReadWrite(ReadEnum::Enum(e.into()), WriteEnum::Raw)
}
(true, None, true, Some(e)) => {
RWEnum::ReadWrite(ReadEnum::Raw, WriteEnum::Enum(e.into()))
}
(true, Some(e), false, _) => RWEnum::Read(ReadEnum::Enum(e.into())),
(true, None, false, _) => RWEnum::Read(ReadEnum::Raw),
(false, _, true, Some(e)) => RWEnum::Write(WriteEnum::Enum(e.into())),
(false, _, true, None) => RWEnum::Write(WriteEnum::Raw),
(true, None, true, None) => RWEnum::ReadWrite(ReadEnum::Raw, WriteEnum::Raw),
(false, _, false, _) => {
return Err(anyhow!("Field {fpath} is not writtable or readable"))
}
};
let brief_suffix = if let Field::Array(_, de) = &f {
if let Some(range) = de.indexes_as_range() {
let (start, end) = range.into_inner();
format!("({start}-{end})")
} else {
let suffixes: Vec<_> = de.indexes().collect();
format!("({})", suffixes.join(","))
}
} else {
String::new()
};
// If this field can be read, generate read proxy structure and value structure.
if can_read {
// collect information on items in enumeration to generate it later.
let mut enum_items = TokenStream::new();
// if this is an enumeratedValues not derived from base, generate the enum structure
// and implement functions for each value in enumeration.
let value_read_ty = if let Some(ev) = rwenum.read_enum() {
let derives;
let fmt;
if rwenum.different_enums() {
derives = &mut read_enum_derives;
fmt = "enum_read_name";
} else {
derives = &mut enum_derives;
fmt = "enum_name";
};
// get the type of value structure. It can be generated from either name field
// in enumeratedValues if it's an enumeration, or from field name directly if it's not.
let value_read_ty = ident(
if config.field_names_for_enums {
&name
} else {
ev.values().name.as_deref().unwrap_or(&name)
},
config,
fmt,
span,
);
match ev {
EV::New(evs) => {
// parse enum variants from enumeratedValues svd record
let mut variants = Variant::from_enumerated_values(evs, config)?;
let map = enums_to_map(evs);
let mut def = evs
.default_value()
.and_then(|def| {
minimal_hole(&map, width)
.map(|v| Variant::from_value(v, def, config))
})
.transpose()?;
if variants.len() == 1 << width {
def = None;
} else if variants.len() == (1 << width) - 1 {
if let Some(def) = def.take() {
variants.push(def);
}
}
// if there's no variant defined in enumeratedValues, generate enumeratedValues with new-type
// wrapper struct, and generate From conversation only.
// else, generate enumeratedValues into a Rust enum with functions for each variant.
if variants.is_empty() && def.is_none() {
// generate struct VALUE_READ_TY_A(fty) and From<fty> for VALUE_READ_TY_A.
add_with_no_variants(
mod_items,
&value_read_ty,
&fty,
&description,
rv,
config,
);
} else {
// do we have finite definition of this enumeration in svd? If not, the later code would
// return an Option when the value read from field does not match any defined values.
let has_reserved_variant;
// generate enum VALUE_READ_TY_A { ... each variants ... } and and From<fty> for VALUE_READ_TY_A.
if let Some(def) = def.as_ref() {
add_from_variants(
mod_items,
variants.iter().chain(std::iter::once(def)),
&value_read_ty,
&fty,
&description,
rv,
config,
);
has_reserved_variant = false;
} else {
add_from_variants(
mod_items,
variants.iter(),
&value_read_ty,
&fty,
&description,
rv,
config,
);
has_reserved_variant = evs.values.len() != (1 << width);
}
// prepare code for each match arm. If we have reserved variant, the match operation would
// return an Option, thus we wrap the return value with Some.
let mut arms = TokenStream::new();
for v in variants.iter().map(|v| {
let i = util::unsuffixed_or_bool(v.value, width);
let pc = &v.pc;
if has_reserved_variant {
quote! { #i => Some(#value_read_ty::#pc), }
} else {
quote! { #i => #value_read_ty::#pc, }
}
}) {
arms.extend(v);
}
// if we have reserved variant, for all values other than defined we return None.
// if svd suggests it only would return defined variants but FieldReader has
// other values, it's regarded as unreachable and we enter unreachable! macro.
// This situation is rare and only exists if unsafe code casts any illegal value
// into a FieldReader structure.
if has_reserved_variant {
arms.extend(quote! {
_ => None,
});
} else if let Some(v) = def.as_ref() {
let pc = &v.pc;
arms.extend(quote! {
_ => #value_read_ty::#pc,
});
} else if 1 << width.to_ty_width()? != variants.len() {
arms.extend(quote! {
_ => unreachable!(),
});
}
// prepare the `variant` function. This function would return field value in
// Rust structure; if we have reserved variant we return by Option.
let ret_ty = if has_reserved_variant {
quote!(Option<#value_read_ty>)
} else {
quote!(#value_read_ty)
};
enum_items.extend(quote! {
#[doc = "Get enumerated values variant"]
#inline
pub const fn variant(&self) -> #ret_ty {
match self.bits {
#arms
}
}
});
// for each variant defined, we generate an `is_variant` function.
for v in &variants {
let pc = &v.pc;
let is_variant = &v.is_sc;
let doc = util::respace(&v.doc);
let doc = util::escape_special_chars(&doc);
enum_items.extend(quote! {
#[doc = #doc]
#inline
pub fn #is_variant(&self) -> bool {
*self == #value_read_ty::#pc
}
});
}
if let Some(v) = def.as_ref() {
let pc = &v.pc;
let is_variant = &v.is_sc;
let doc = util::respace(&v.doc);
let doc = util::escape_special_chars(&doc);
enum_items.extend(quote! {
#[doc = #doc]
#inline
pub fn #is_variant(&self) -> bool {
matches!(self.variant(), #value_read_ty::#pc)
}
});
}
}
}
EV::Derived(_, base) => {
let base_ident = if config.field_names_for_enums {
ident(&base.field().name.remove_dim(), config, fmt, span)
} else {
ident(&base.name, config, fmt, span)
};
if !derives.contains(&value_read_ty) {
let base_path = base_syn_path(base, &fpath, &base_ident, config)?;
mod_items.extend(quote! {
#[doc = #description]
pub use #base_path as #value_read_ty;
});
}
}
}
derives.insert(value_read_ty.clone());
value_read_ty
} else {
// raw_field_value_read_ty
fty.clone()
};
// get a brief description for this field
// the suffix string from field name is removed in brief description.
let field_reader_brief = format!("Field `{name}{brief_suffix}` reader - {description}");
// name of read proxy type
let reader_ty = ident(&name, config, "field_reader", span);
match rwenum.read_enum() {
Some(EV::New(_)) | None => {
// Generate the read proxy structure if necessary.
let reader = if width == 1 {
if value_read_ty == "bool" {
quote! { crate::BitReader }
} else {
quote! { crate::BitReader<#value_read_ty> }
}
} else if value_read_ty == "u8" {
quote! { crate::FieldReader }
} else {
quote! { crate::FieldReader<#value_read_ty> }
};
let mut readerdoc = field_reader_brief.clone();
if let Some(action) = f.read_action {
readerdoc.push_str("\n\n<div class=\"warning\">");
readerdoc.push_str(match action {
ReadAction::Clear => "The field is <b>cleared</b> (set to zero) following a read operation.",
ReadAction::Set => "The field is <b>set</b> (set to ones) following a read operation.",
ReadAction::Modify => "The field is <b>modified</b> in some way after a read operation.",
ReadAction::ModifyExternal => "One or more dependent resources other than the current field are immediately affected by a read operation.",
});
readerdoc.push_str("</div>");
}
mod_items.extend(quote! {
#[doc = #readerdoc]
pub type #reader_ty = #reader;
});
}
Some(EV::Derived(_, base)) => {
// if this value is derived from a base, generate `pub use` code for each read proxy
// and value if necessary.
// generate pub use field_1 reader as field_2 reader
let base_field = base.field.name.remove_dim();
let base_r = ident(&base_field, config, "field_reader", span);
if !reader_derives.contains(&reader_ty) {