Clash.Netlist.BlackBox

Functions to create BlackBox Contexts and fill in BlackBox templates

Documentation

warn :: ClashOpts -> String -> IO ()

Emits (colorized) warning to stderr

mkBlackBoxContext

Arguments

:: HasCallStack

=> Text

Blackbox function name

-> [Id]

Identifiers binding the primitive/blackbox application

-> [Either Term Type]

Arguments of the primitive/blackbox application

-> NetlistMonad (BlackBoxContext, [Declaration])

Generate the context for a BlackBox instantiation.

prepareBlackBox :: Text -> BlackBox -> BlackBoxContext -> NetlistMonad (BlackBox, [Declaration])

isLiteral :: Term -> Bool

Determine if a term represents a literal

mkArgument

Arguments

:: Text

Blackbox function name

-> Identifier

LHS of the original let-binder. Is used as a name hint to generate new names in case the argument is a declaration.

-> Int

Argument n (zero-indexed). Used for error message.

-> Term

-> NetlistMonad ((Expr, HWType, Bool), [Declaration])

extractPrimWarnOrFail

Arguments

:: HasCallStack

=> Text

Name of primitive

-> NetlistMonad CompiledPrimitive

Extract a compiled primitive from a guarded primitive. Emit a warning if the guard wants to, or fail entirely.

mkPrimitive

Arguments

:: Bool

Put BlackBox expression in parenthesis

-> Bool

Treat BlackBox expression as declaration

-> NetlistId

Id to assign the result to

-> PrimInfo

Primitive info

-> [Either Term Type]

Arguments

-> [Declaration]

Tick declarations

-> NetlistMonad (Expr, [Declaration])

collectMealy

Arguments

:: HasCallStack

=> Identifier

Identifier to assign the final result to

-> NetlistId

Id to assign the final result to

-> TyConMap

-> [Term]

The arguments to mealyIO

-> NetlistMonad [Declaration]

Turn a mealyIO expression into a two sequential processes, one "initial" process for the starting state, and one clocked sequential process.

collectBindIO :: NetlistId -> [Term] -> NetlistMonad (Expr, [Declaration])

Collect the sequential declarations for bindIO

collectAppIO :: NetlistId -> [Term] -> [Term] -> NetlistMonad (Expr, [Declaration])

Collect the sequential declarations for appIO

unSimIO :: TyConMap -> Term -> Term

Unwrap the new-type wrapper for things of type SimIO, this is needed to allow applications of the `State# World` token to the underlying IO type.

XXX: this is most likely needed because Ghc2Core that threw away the cast that this unwrapping; we should really start to support casts.

mkFunInput

Arguments

:: HasCallStack

=> Id

Identifier binding the encompassing primitive/blackbox application. Used as a name hint if mkFunInput needs intermediate signals.

-> Term

The function argument term

-> NetlistMonad ((Either BlackBox (Identifier, [Declaration]), WireOrReg, [BlackBoxTemplate], [BlackBoxTemplate], [((Text, Text), BlackBox)], BlackBoxContext), [Declaration])

Create an template instantiation text and a partial blackbox content for an argument term, given that the term is a function. Errors if the term is not a function