Clash.Driver.Types

Type definitions used by the Driver module

Documentation

data Binding

Constructors

Binding

Fields

• bindingId :: Id
• bindingLoc :: SrcSpan
• bindingSpec :: InlineSpec
• bindingTerm :: Term

Instances

Show Binding

Defined in Clash.Driver.Types

Methods

showsPrec :: Int -> Binding -> ShowS

show :: Binding -> String

showList :: [Binding] -> ShowS

Generic Binding

Defined in Clash.Driver.Types

Associated Types

type Rep Binding :: Type -> Type

Methods

from :: Binding -> Rep Binding x

to :: Rep Binding x -> Binding

Binary Binding

Defined in Clash.Driver.Types

Methods

put :: Binding -> Put

get :: Get Binding

putList :: [Binding] -> Put

NFData Binding

Defined in Clash.Driver.Types

Methods

rnf :: Binding -> ()

type Rep Binding

Defined in Clash.Driver.Types

type Rep Binding = D1 ('MetaData "Binding" "Clash.Driver.Types" "clash-lib-1.1.0-inplace" 'False) (C1 ('MetaCons "Binding" 'PrefixI 'True) ((S1 ('MetaSel ('Just "bindingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Id) :*: S1 ('MetaSel ('Just "bindingLoc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SrcSpan)) :*: (S1 ('MetaSel ('Just "bindingSpec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InlineSpec) :*: S1 ('MetaSel ('Just "bindingTerm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Term))))

type BindingMap = VarEnv Binding

Global function binders

Global functions cannot be mutually recursive, only self-recursive.

data DebugLevel

Debug Message Verbosity

Constructors

DebugNone

Don't show debug messages

DebugSilent

Run invariant checks and err if violated (enabled by any debug flag)

DebugFinal

Show completely normalized expressions

DebugName

Show names of applied transformations

DebugTry

Show names of tried AND applied transformations

DebugApplied

Show sub-expressions after a successful rewrite

DebugAll

Show all sub-expressions on which a rewrite is attempted

Instances

Enum DebugLevel

Defined in Clash.Driver.Types

Methods

succ :: DebugLevel -> DebugLevel

pred :: DebugLevel -> DebugLevel

toEnum :: Int -> DebugLevel

fromEnum :: DebugLevel -> Int

enumFrom :: DebugLevel -> [DebugLevel]

enumFromThen :: DebugLevel -> DebugLevel -> [DebugLevel]

enumFromTo :: DebugLevel -> DebugLevel -> [DebugLevel]

enumFromThenTo :: DebugLevel -> DebugLevel -> DebugLevel -> [DebugLevel]

Eq DebugLevel

Defined in Clash.Driver.Types

Methods

(==) :: DebugLevel -> DebugLevel -> Bool

(/=) :: DebugLevel -> DebugLevel -> Bool

Ord DebugLevel

Defined in Clash.Driver.Types

Methods

compare :: DebugLevel -> DebugLevel -> Ordering

(<) :: DebugLevel -> DebugLevel -> Bool

(<=) :: DebugLevel -> DebugLevel -> Bool

(>) :: DebugLevel -> DebugLevel -> Bool

(>=) :: DebugLevel -> DebugLevel -> Bool

max :: DebugLevel -> DebugLevel -> DebugLevel

min :: DebugLevel -> DebugLevel -> DebugLevel

Read DebugLevel

Defined in Clash.Driver.Types

Methods

readsPrec :: Int -> ReadS DebugLevel

readList :: ReadS [DebugLevel]

readPrec :: ReadPrec DebugLevel

readListPrec :: ReadPrec [DebugLevel]

Generic DebugLevel

Defined in Clash.Driver.Types

Associated Types

type Rep DebugLevel :: Type -> Type

Methods

from :: DebugLevel -> Rep DebugLevel x

to :: Rep DebugLevel x -> DebugLevel

Hashable DebugLevel

Defined in Clash.Driver.Types

Methods

hashWithSalt :: Int -> DebugLevel -> Int

hash :: DebugLevel -> Int

type Rep DebugLevel

Defined in Clash.Driver.Types

type Rep DebugLevel = D1 ('MetaData "DebugLevel" "Clash.Driver.Types" "clash-lib-1.1.0-inplace" 'False) ((C1 ('MetaCons "DebugNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "DebugSilent" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DebugFinal" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "DebugName" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DebugTry" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "DebugApplied" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DebugAll" 'PrefixI 'False) (U1 :: Type -> Type))))

data ClashOpts

Constructors

ClashOpts

Fields

• opt_inlineLimit :: Int
• opt_specLimit :: Int
• opt_inlineFunctionLimit :: Word
• opt_inlineConstantLimit :: Word
• opt_dbgLevel :: DebugLevel
• opt_dbgTransformations :: Set String
• opt_cachehdl :: Bool
• opt_cleanhdl :: Bool
• opt_primWarn :: Bool
• opt_color :: OverridingBool
• opt_intWidth :: Int
• opt_hdlDir :: Maybe String

  Directory to store temporary files in. Will be cleaned after Clash has finished executing.

• opt_hdlSyn :: HdlSyn
• opt_errorExtra :: Bool
• opt_floatSupport :: Bool
• opt_importPaths :: [FilePath]
• opt_componentPrefix :: Maybe String
• opt_newInlineStrat :: Bool
• opt_escapedIds :: Bool
• opt_ultra :: Bool

  Perform a high-effort compile, trading improved performance for potentially much longer compile times.

  Name inspired by Design Compiler's compile_ultra flag.

• opt_forceUndefined :: Maybe (Maybe Int)
  • Nothing: generate undefined's in the HDL
  • Just Nothing: replace undefined's by a constant in the HDL; the compiler decides what's best
  • Just (Just x): replace undefined's by x in the HDL
• opt_checkIDir :: Bool
• opt_aggressiveXOpt :: Bool

  Enable aggressive X optimization, which may remove undefineds from generated HDL by replaced with defined alternatives.

• opt_inlineWFCacheLimit :: Word

  At what size do we cache normalized work-free top-level binders.

Instances

Hashable ClashOpts

Defined in Clash.Driver.Types

Methods

hashWithSalt :: Int -> ClashOpts -> Int

hash :: ClashOpts -> Int

defClashOpts :: ClashOpts

data Manifest

Information about the generated HDL between (sub)runs of the compiler

Constructors

Manifest

Fields

• manifestHash :: (Int, Maybe Int)

  Hash of the TopEntity and all its dependencies + (maybe) Hash of the TestBench and all its dependencies

• succesFlags :: (Int, Int, Bool)

  Compiler flags used to achieve successful compilation:

  • opt_inlineLimit
  • opt_specLimit
  • opt_floatSupport
• portInNames :: [Text]
• portInTypes :: [Text]

  The rendered versions of the types of the input ports of the TopEntity

  Used when dealing with multiple TopEntitys who have different names for types which are structurally equal

• portOutNames :: [Text]
• portOutTypes :: [Text]

  The rendered versions of the types of the output ports of the TopEntity

  Used when dealing with multiple TopEntitys who have different names for types which are structurally equal

• componentNames :: [Text]

  Names of all the generated components for the TopEntity (does not include the names of the components of the TestBench accompanying the TopEntity).

Instances

Read Manifest

Defined in Clash.Driver.Types

Methods

readsPrec :: Int -> ReadS Manifest

readList :: ReadS [Manifest]

readPrec :: ReadPrec Manifest

readListPrec :: ReadPrec [Manifest]

Show Manifest

Defined in Clash.Driver.Types

Methods

showsPrec :: Int -> Manifest -> ShowS

show :: Manifest -> String

showList :: [Manifest] -> ShowS