Documentation

Fields

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

Fields

• opt_inlineLimit :: Int
   
• opt_specLimit :: Int
   
• opt_inlineFunctionLimit :: Word
   
• opt_inlineConstantLimit :: Word
   
• opt_dbgLevel :: DebugLevel
   
• opt_dbgTransformations :: Set String
   
• opt_dbgTransformationsFrom :: Int

  Only output debug information from (applied) transformation n

• opt_dbgTransformationsLimit :: Int

  Only output debug information for n (applied) transformations. If this limit is exceeded, Clash will stop normalizing.

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

Fields

• manifestHash :: (Int, Maybe Int)

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

• successFlags :: (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).