fayalite 0.2.0

Hardware Description Language embedded in Rust, using FIRRTL's semantics
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
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

// SPDX-License-Identifier: LGPL-3.0-or-later
// See Notices.txt for copyright information
use crate::{
    expr::{Expr, Flow, ToExpr},
    intern::Interned,
    module::{IncompleteDeclaration, NameId, ScopedNameId, StmtDeclaration, StmtWire},
    source_location::SourceLocation,
    ty::{CanonicalType, Type},
};
use std::{cell::RefCell, fmt, rc::Rc};

#[derive(Copy, Clone, Eq, PartialEq, Hash)]
pub struct Wire<T: Type> {
    name: ScopedNameId,
    source_location: SourceLocation,
    ty: T,
}

impl<T: Type + fmt::Debug> fmt::Debug for Wire<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Wire({:?}: ", self.name)?;
        self.ty.fmt(f)?;
        f.write_str(")")
    }
}

impl<T: Type> Wire<T> {
    pub fn canonical(&self) -> Wire<CanonicalType> {
        let Self {
            name,
            source_location,
            ref ty,
        } = *self;
        Wire {
            name,
            source_location,
            ty: ty.canonical(),
        }
    }
    pub fn ty(&self) -> T {
        self.ty
    }
    pub fn new_unchecked(
        scoped_name: ScopedNameId,
        source_location: SourceLocation,
        ty: T,
    ) -> Self {
        Self {
            name: scoped_name,
            source_location,
            ty,
        }
    }
    pub fn source_location(&self) -> SourceLocation {
        self.source_location
    }
    pub fn containing_module_name(&self) -> Interned<str> {
        self.containing_module_name_id().0
    }
    pub fn containing_module_name_id(&self) -> NameId {
        self.name.0
    }
    pub fn name(&self) -> Interned<str> {
        self.name_id().0
    }
    pub fn name_id(&self) -> NameId {
        self.name.1
    }
    pub fn scoped_name(&self) -> ScopedNameId {
        self.name
    }
    pub fn flow(&self) -> Flow {
        Flow::Duplex
    }
    pub fn must_connect_to(&self) -> bool {
        true
    }
}

#[derive(Clone)]
pub struct IncompleteWire {
    pub(crate) declaration: Rc<RefCell<IncompleteDeclaration>>,
}

impl IncompleteWire {
    #[track_caller]
    pub fn complete<T: Type>(&mut self, ty: T) -> Expr<T> {
        let canonical_type = ty.canonical();
        let mut declaration = self.declaration.borrow_mut();
        if let IncompleteDeclaration::Incomplete {
            name,
            source_location,
        } = *declaration
        {
            *declaration = IncompleteDeclaration::Complete(
                StmtWire {
                    annotations: (),
                    wire: Wire {
                        name,
                        source_location,
                        ty: canonical_type,
                    },
                }
                .into(),
            );
        }
        match *declaration {
            IncompleteDeclaration::Complete(StmtDeclaration::Wire(StmtWire {
                wire:
                    Wire {
                        name,
                        source_location,
                        ty: wire_ty,
                    },
                ..
            })) => {
                drop(declaration);
                assert_eq!(wire_ty, canonical_type, "type mismatch");
                Wire {
                    name,
                    source_location,
                    ty,
                }
                .to_expr()
            }
            IncompleteDeclaration::Taken => panic!("can't use wire outside of containing module"),
            IncompleteDeclaration::Complete(_) | IncompleteDeclaration::Incomplete { .. } => {
                unreachable!()
            }
        }
    }
}