Clash.Netlist

Create Netlists out of normalized CoreHW Terms

Documentation

genNetlist

Arguments

:: Bool

Whether this we're compiling a testbench (suppresses certain warnings)

-> ClashOpts

Options Clash was called with

-> CustomReprs

Custom bit representations for certain types

-> BindingMap

Global binders

-> [(Id, Maybe TopEntity, Maybe Id)]

All the TopEntities

-> CompiledPrimMap

Primitive definitions

-> TyConMap

TyCon cache

-> (CustomReprs -> TyConMap -> Type -> State HWMap (Maybe (Either String FilteredHWType)))

Hardcoded Type -> HWType translator

-> Int

IntWordInteger bit-width

-> (IdType -> Identifier -> Identifier)

valid identifiers

-> (IdType -> Identifier -> Identifier -> Identifier)

extend valid identifiers

-> Bool

Whether the backend supports ifThenElse expressions

-> HashMap Identifier Word

Seen components

-> FilePath

HDL dir

-> (Maybe Identifier, Maybe Identifier)

Component name prefix

-> Id

Name of the topEntity

-> IO ([([Bool], SrcSpan, HashMap Identifier Word, Component)], HashMap Identifier Word)

Generate a hierarchical netlist out of a set of global binders with topEntity at the top.

runNetlistMonad

Arguments

:: Bool

Whether this we're compiling a testbench (suppresses certain warnings)

-> ClashOpts

Options Clash was called with

-> CustomReprs

Custom bit representations for certain types

-> BindingMap

Global binders

-> VarEnv (Type, Maybe TopEntity)

TopEntity annotations

-> CompiledPrimMap

Primitive Definitions

-> TyConMap

TyCon cache

-> (CustomReprs -> TyConMap -> Type -> State HWMap (Maybe (Either String FilteredHWType)))

Hardcode Type -> HWType translator

-> Int

IntWordInteger bit-width

-> (IdType -> Identifier -> Identifier)

valid identifiers

-> (IdType -> Identifier -> Identifier -> Identifier)

extend valid identifiers

-> Bool

Whether the backend supports ifThenElse expressions

-> HashMap Identifier Word

Seen components

-> FilePath

HDL dir

-> (Maybe Identifier, Maybe Identifier)

Component name prefix

-> NetlistMonad a

Action to run

-> IO (a, NetlistState)

Run a NetlistMonad action in a given environment

genNames :: Bool -> (IdType -> Identifier -> Identifier) -> (Maybe Identifier, Maybe Identifier) -> HashMap Identifier Word -> VarEnv Identifier -> BindingMap -> (HashMap Identifier Word, VarEnv Identifier)

genComponent

Arguments

:: HasCallStack

=> Id

Name of the function

-> NetlistMonad ([Bool], SrcSpan, HashMap Identifier Word, Component)

Generate a component for a given function (caching)

genComponentT

Arguments

:: HasCallStack

=> Id

Name of the function

-> Term

Corresponding term

-> NetlistMonad ([Bool], SrcSpan, HashMap Identifier Word, Component)

Generate a component for a given function

mkNetDecl :: (Id, Term) -> NetlistMonad (Maybe Declaration)

isWriteToBiSignalPrimitive :: Term -> Bool

mkDeclarations

Arguments

:: HasCallStack

=> Id

LHS of the let-binder

-> Term

RHS of the let-binder

-> NetlistMonad [Declaration]

Generate a list of Declarations for a let-binder, return an empty list if the bound expression is represented by 0 bits

mkDeclarations'

Arguments

:: HasCallStack

=> Id

LHS of the let-binder

-> Term

RHS of the let-binder

-> NetlistMonad [Declaration]

Generate a list of Declarations for a let-binder

mkSelection :: Either Identifier Id -> Term -> Type -> [Alt] -> [Declaration] -> NetlistMonad [Declaration]

Generate a declaration that selects an alternative based on the value of the scrutinee

reorderDefault :: [(Pat, Term)] -> [(Pat, Term)]

reorderCustom :: TyConMap -> CustomReprs -> Type -> [(Pat, Term)] -> [(Pat, Term)]

patPos :: CustomReprs -> Pat -> Int

mkFunApp

Arguments

:: HasCallStack

=> Identifier

LHS of the let-binder

-> Id

Name of the applied function

-> [Term]

Function arguments

-> [Declaration]

Tick declarations

-> NetlistMonad [Declaration]

Generate a list of Declarations for a let-binder where the RHS is a function application

toSimpleVar :: Identifier -> (Expr, Type) -> NetlistMonad (Expr, [Declaration])

mkExpr

Arguments

:: HasCallStack

=> Bool

Treat BlackBox expression as declaration

-> Either Identifier Id

Id to assign the result to

-> Type

Type of the LHS of the let-binder

-> Term

Term to convert to an expression

-> NetlistMonad (Expr, [Declaration])

Returned expression and a list of generate BlackBox declarations

Generate an expression for a term occurring on the RHS of a let-binder

mkProjection

Arguments

:: Bool

Projection must bind to a simple variable

-> Either Identifier Id

The signal to which the projection is (potentially) assigned

-> Term

The subject/scrutinee of the projection

-> Type

The type of the result

-> Alt

The field to be projected

-> NetlistMonad (Expr, [Declaration])

Generate an expression that projects a field out of a data-constructor.

Works for both product types, as sum-of-product types.

mkDcApplication

Arguments

:: HasCallStack

=> HWType

HWType of the LHS of the let-binder

-> Either Identifier Id

Id to assign the result to

-> DataCon

Applied DataCon

-> [Term]

DataCon Arguments

-> NetlistMonad (Expr, [Declaration])

Returned expression and a list of generate BlackBox declarations

Generate an expression for a DataCon application occurring on the RHS of a let-binder