| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
CLaSH.Netlist.Types
Description
Type and instance definitions for Netlist modules
- newtype NetlistMonad a = NetlistMonad {
- runNetlist :: WriterT [(Identifier, HWType)] (StateT NetlistState (FreshMT IO)) a
- type VHDLState = (HashSet HWType, Int, HashMap HWType Doc)
- data NetlistState = NetlistState {}
- type Identifier = Text
- data Component = Component {
- componentName :: Identifier
- hiddenPorts :: [(Identifier, HWType)]
- inputs :: [(Identifier, HWType)]
- output :: (Identifier, HWType)
- declarations :: [Declaration]
- type Size = Int
- data HWType
- = Void
- | Bit
- | Bool
- | Integer
- | Signed Size
- | Unsigned Size
- | Vector Size HWType
- | Sum Identifier [Identifier]
- | Product Identifier [HWType]
- | SP Identifier [(Identifier, [HWType])]
- | Clock Int
- | Reset Int
- data Declaration
- = Assignment Identifier Expr
- | CondAssignment Identifier Expr [(Maybe Expr, Expr)]
- | InstDecl Identifier Identifier [(Identifier, Expr)]
- | BlackBoxD Text
- | NetDecl Identifier HWType (Maybe Expr)
- data Modifier
- data Expr
- data Literal
- data Bit
- vhdlMState :: Lens' NetlistState VHDLState
- varEnv :: Lens' NetlistState Gamma
- varCount :: Lens' NetlistState Int
- typeTranslator :: Lens' NetlistState (HashMap TyConName TyCon -> Type -> Maybe (Either String HWType))
- tcCache :: Lens' NetlistState (HashMap TyConName TyCon)
- primitives :: Lens' NetlistState PrimMap
- components :: Lens' NetlistState (HashMap TmName Component)
- cmpCount :: Lens' NetlistState Int
- bindings :: Lens' NetlistState (HashMap TmName (Type, Term))
Documentation
newtype NetlistMonad a Source
Monad that caches generated components (StateT) and remembers hidden inputs of components that are being generated (WriterT)
Constructors
| NetlistMonad | |
Fields
| |
type VHDLState = (HashSet HWType, Int, HashMap HWType Doc) Source
State for the VHDLM monad:
- Previously encountered HWTypes
- Product type counter
- Cache for previously generated product type names
data NetlistState Source
State of the NetlistMonad
Constructors
| NetlistState | |
Fields
| |
Instances
type Identifier = Text Source
Signal reference
Component: base unit of a Netlist
Constructors
| Component | |
Fields
| |
Representable hardware types
Constructors
| Void | Empty type |
| Bit | Bit type |
| Bool | Boolean type |
| Integer | Integer type |
| Signed Size | Signed integer of a specified size |
| Unsigned Size | Unsigned integer of a specified size |
| Vector Size HWType | Vector type |
| Sum Identifier [Identifier] | Sum type: Name and Constructor names |
| Product Identifier [HWType] | Product type: Name and field types |
| SP Identifier [(Identifier, [HWType])] | Sum-of-Product type: Name and Constructor names + field types |
| Clock Int | Clock type with specified period |
| Reset Int | Reset type corresponding to clock with a specified period |
Instances
data Declaration Source
Internals of a Component
Constructors
| Assignment Identifier Expr | Signal assignment:
|
| CondAssignment Identifier Expr [(Maybe Expr, Expr)] | Conditional signal assignment:
|
| InstDecl Identifier Identifier [(Identifier, Expr)] | Instantiation of another component |
| BlackBoxD Text | Instantiation of blackbox declaration |
| NetDecl Identifier HWType (Maybe Expr) | Signal declaration |
Instances
Expression Modifier
Expression used in RHS of a declaration
Constructors
| Literal (Maybe Size) Literal | Literal expression |
| DataCon HWType (Maybe Modifier) [Expr] | DataCon application |
| Identifier Identifier (Maybe Modifier) | Signal reference |
| DataTag HWType (Either Expr Expr) |
|
| BlackBoxE Text (Maybe Modifier) | Instantiation of a BlackBox expression |
Literals used in an expression