cyclone-v 0.1.0

Cyclone V FPGA programming library for 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

#[macro_export]
macro_rules! declare_field_accessors {
    ($(#[$fattr:meta])* $fname: ident, $ftype: ty [padding]) => {};
    ($(#[$fattr:meta])* $fname: ident, $ftype: ty [readonly]) => {
        $(#[$fattr])*
        #[inline]
        pub fn $fname(&self) -> $ftype {
            unsafe { core::ptr::read_volatile(core::ptr::addr_of!(self.$fname)) }
        }
    };
    ($(#[$fattr:meta])* $fname: ident, $ftype: ty [writeonly]) => {
        paste::paste! {
            $(#[$fattr])*
            #[inline]
            pub fn [<set_ $fname>](&mut self, value: $ftype) {
                unsafe {
                    core::ptr::write_volatile(core::ptr::addr_of_mut!(self.$fname), value);
                }
            }
        }
    };
    ($(#[$fattr:meta])* $fname: ident, $ftype: ty []) => {
        paste::paste! {
            $(#[$fattr])*
            #[inline]
            pub fn $fname(&self) -> $ftype {
                unsafe { core::ptr::read_volatile(core::ptr::addr_of!(self.$fname)) }
            }

            $(#[$fattr])*
            #[inline]
            pub fn [<set_ $fname>](&mut self, value: $ftype) {
                unsafe {
                    core::ptr::write_volatile(core::ptr::addr_of_mut!(self.$fname), value);
                }
            }

            paste::paste! {
                $(#[$fattr])*
                #[inline]
                pub fn [<update_ $fname>](&mut self, f: impl FnOnce(&mut $ftype)) {
                    let mut value = self.$fname();
                    f(&mut value);
                    self.[<set_ $fname>](value);
                }
            }
        }
    };
}

#[macro_export]
macro_rules! declare_volatile_struct {
    (
        $(#[$sattr:meta])*
        pub struct $sname: ident {
            $(
                $(#[$fattr:meta])*
                $([$($tags: ident)*])? $fname: ident: $ftype: ty,
            )*
        }
    ) => {
        $(#[$sattr])*
        pub struct $sname {
            $(
                $(#[$fattr])*
                $fname: $ftype,
            )*
        }

        impl $sname {
            $(
                $crate::declare_field_accessors!($(#[$fattr])* $fname, $ftype [$($($tags)*)?]);
            )*
        }
    };
}