clash-lib-1.4.6: Clash: a functional hardware description language - As a library
Copyright(C) 2020 QBayLogic
LicenseBSD2 (see the file LICENSE)
MaintainerQBayLogic B.V. <devops@qbaylogic.com>
Safe HaskellSafe-Inferred
LanguageHaskell2010

Clash.Edalize.Edam

Description

Data types and rendering for Edalize Metadata files (EDAM).

Synopsis

Documentation

data Edam Source #

EDAM data structure to be given to an Edalize backend. This contains all information needed to generate a project scaffolding. Note that hooks and VPI modules are currently not specified by clash.

data EdamFile Source #

Information about each file in the project. This does not include is_include_file or include_path, as these are not currently used by Clash.

Constructors

EdamFile 

data EdamFileType Source #

A subset of the file types recognized by Edalize. The supported formats are largely from IP-XACT 2014 (IEEE 1685-2014), although Edalize extends this with other types, e.g. QSYS.

Only file types which are generated by Clash are listed.

Constructors

Unknown

Unknown file type.

VhdlSource

VHDL source.

VerilogSource

Verilog source.

SystemVerilogSource

SystemVerilog source.

TclSource

Tool Command Language source.

QSYS

QSys system source.

SDC

Synopsys Design Constraints source.

Instances

Instances details
Eq EdamFileType Source # 
Instance details

Defined in Clash.Edalize.Edam

Show EdamFileType Source # 
Instance details

Defined in Clash.Edalize.Edam

data EdamTools Source #

Tool-specific configuration used by Edalize. Currently only tools which are supported by Clash are provided.

Instances

Instances details
Default EdamTools Source # 
Instance details

Defined in Clash.Edalize.Edam

Methods

def :: EdamTools #

data GhdlOptions Source #

Constructors

GhdlOptions 

Instances

Instances details
Default GhdlOptions Source # 
Instance details

Defined in Clash.Edalize.Edam

Methods

def :: GhdlOptions #

data IcarusOptions Source #

Constructors

IcarusOptions 

Instances

Instances details
Default IcarusOptions Source # 
Instance details

Defined in Clash.Edalize.Edam

Methods

def :: IcarusOptions #

data ModelsimOptions Source #

Constructors

ModelsimOptions 

Fields

Instances

Instances details
Default ModelsimOptions Source # 
Instance details

Defined in Clash.Edalize.Edam

data QuartusOptions Source #

Instances

Instances details
Default QuartusOptions Source # 
Instance details

Defined in Clash.Edalize.Edam

Methods

def :: QuartusOptions #

data VivadoOptions Source #

Constructors

VivadoOptions 

Fields

Instances

Instances details
Default VivadoOptions Source # 
Instance details

Defined in Clash.Edalize.Edam

Methods

def :: VivadoOptions #

pprEdam :: Edam -> Doc ann Source #