clash-lib-1.8.1: Clash: a functional hardware description language - As a library

# clash-lib-1.8.1: Clash: a functional hardware description language - As a library

Clash is a functional hardware description language that borrows both its syntax and semantics from the functional programming language Haskell. The Clash compiler transforms these high-level descriptions to low-level synthesizable VHDL, Verilog, or SystemVerilog.

Features of Clash:

- Strongly typed, but with a very high degree of type inference, enabling both safe and fast prototyping using concise descriptions.
- Interactive REPL: load your designs in an interpreter and easily test all your component without needing to setup a test bench.
- Higher-order functions, with type inference, result in designs that are fully parametric by default.
- Synchronous sequential circuit design based on streams of values, called `Signal`s, lead to natural descriptions of feedback loops.
- Support for multiple clock domains, with type safe clock domain crossing.

This package provides:

- The CoreHW internal language: SystemF + Letrec + Case-decomposition
- The normalisation process that brings CoreHW in a normal form that can be converted to a netlist
- Blackbox/Primitive Handling

Front-ends (for: parsing, typecheck, etc.) are provided by separate packages:

- GHC/Haskell Frontend
- Idris Frontend

Prelude library: https://hackage.haskell.org/package/clash-prelude

Modules

clash-lib-1.8.1

- Clash
  Submodules
  - Annotations
    Submodules
    - BitRepresentation
      Submodules
      - Clash.Annotations.BitRepresentation.ClashLib
  - Clash.Backend
    Submodules
    - Clash.Backend.SystemVerilog
    - Clash.Backend.VHDL
    - Clash.Backend.Verilog
      Submodules
      - Clash.Backend.Verilog.Time
  - Core
    Submodules
    - Clash.Core.DataCon
    - Clash.Core.EqSolver
    - Evaluator
      Submodules
      - Clash.Core.Evaluator.Types
    - Clash.Core.FreeVars
    - Clash.Core.HasFreeVars
    - Clash.Core.HasType
    - Clash.Core.Literal
    - Clash.Core.Name
    - Clash.Core.PartialEval
      Submodules
      - Clash.Core.PartialEval.AsTerm
      - Clash.Core.PartialEval.Monad
      - Clash.Core.PartialEval.NormalForm
    - Clash.Core.Pretty
    - Clash.Core.Subst
    - Clash.Core.Term
    - Clash.Core.TermInfo
    - Clash.Core.TermLiteral
      Submodules
      - Clash.Core.TermLiteral.TH
    - Clash.Core.TyCon
    - Clash.Core.Type
    - Clash.Core.TysPrim
    - Clash.Core.Util
    - Clash.Core.Var
    - Clash.Core.VarEnv
  - Data
    Submodules
    - Clash.Data.UniqMap
  - Clash.DataFiles
  - Clash.Debug
  - Clash.Driver
    Submodules
    - Clash.Driver.Manifest
    - Clash.Driver.Types
  - Edalize
    Submodules
    - Clash.Edalize.Edam
  - Clash.Netlist
    Submodules
    - Clash.Netlist.BlackBox
      Submodules
      - Clash.Netlist.BlackBox.Parser
      - Clash.Netlist.BlackBox.Types
      - Clash.Netlist.BlackBox.Util
    - Clash.Netlist.Expr
    - Clash.Netlist.Id
      Submodules
      - Clash.Netlist.Id.Common
      - Clash.Netlist.Id.Internal
      - Clash.Netlist.Id.SystemVerilog
      - Clash.Netlist.Id.VHDL
      - Clash.Netlist.Id.Verilog
    - Clash.Netlist.Types
    - Clash.Netlist.Util
  - Clash.Normalize
    Submodules
    - Clash.Normalize.PrimitiveReductions
    - Clash.Normalize.Primitives
    - Clash.Normalize.Strategy
    - Clash.Normalize.Transformations
      Submodules
      - Clash.Normalize.Transformations.ANF
      - Clash.Normalize.Transformations.Case
      - Clash.Normalize.Transformations.Cast
      - Clash.Normalize.Transformations.DEC
      - Clash.Normalize.Transformations.EtaExpand
      - Clash.Normalize.Transformations.Inline
      - Clash.Normalize.Transformations.Letrec
      - Clash.Normalize.Transformations.MultiPrim
      - Clash.Normalize.Transformations.Reduce
      - Clash.Normalize.Transformations.SeparateArgs
      - Clash.Normalize.Transformations.Specialize
      - Clash.Normalize.Transformations.XOptimize
    - Clash.Normalize.Types
    - Clash.Normalize.Util
  - Clash.Pretty
  - Primitives
    Submodules
    - Annotations
      Submodules
      - Clash.Primitives.Annotations.SynthesisAttributes
    - Clash.Primitives.DSL
    - GHC
      Submodules
      - Clash.Primitives.GHC.Int
      - Clash.Primitives.GHC.Literal
      - Clash.Primitives.GHC.Word
    - Intel
      Submodules
      - Clash.Primitives.Intel.ClockGen
    - Clash.Primitives.Magic
    - Sized
      Submodules
      - Clash.Primitives.Sized.Signed
      - Clash.Primitives.Sized.ToInteger
      - Clash.Primitives.Sized.Vector
    - Clash.Primitives.Types
    - Clash.Primitives.Util
    - Clash.Primitives.Verification
    - Xilinx
      Submodules
      - Clash.Primitives.Xilinx.ClockGen
  - Rewrite
    Submodules
    - Clash.Rewrite.Combinators
    - Clash.Rewrite.Types
    - Clash.Rewrite.Util
    - Clash.Rewrite.WorkFree
  - Clash.Unique
  - Clash.Util
    Submodules
    - Clash.Util.Eq
    - Clash.Util.Graph
    - Clash.Util.Interpolate
  - Verification
    Submodules
    - Clash.Verification.Pretty
- Data
  Submodules
  - Text
    Submodules
    - Prettyprint
      Submodules
      - Doc
        Submodules
        - Data.Text.Prettyprint.Doc.Extra
- GHC
  Submodules
  - BasicTypes
    Submodules
    - GHC.BasicTypes.Extra