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

:: Text

Blackbox function name

-> Id

Identifier binding the primitive/blackbox application

-> [Term]

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

:: Identifier

LHS of the original let-binder

-> Term

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

extractPrimWarnOrFail

Arguments

:: 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

-> Either Identifier Id

Id to assign the result to

-> Text

Name of primitive

-> [Either Term Type]

Arguments

-> Type

Result type

-> [Declaration]

Tick declarations

-> NetlistMonad (Expr, [Declaration])

mkFunInput

Arguments

:: HasCallStack

=> Id

Identifier binding the encompassing primitive/blackbox application

-> 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