| Copyright | (C) 2020 QBayLogic |
|---|---|
| License | BSD2 (see the file LICENSE) |
| Maintainer | QBayLogic B.V. <devops@qbaylogic.com> |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Clash.Edalize.Edam
Description
Data types and rendering for Edalize Metadata files (EDAM).
Synopsis
- data Edam = Edam {}
- data EdamFile = EdamFile {}
- data EdamFileType
- data EdamTools = EdamTools {}
- data GhdlOptions = GhdlOptions {
- ghdlAnalyseOpts :: [Text]
- ghdlRunOpts :: [Text]
- data IcarusOptions = IcarusOptions {
- icarusOpts :: [Text]
- icarusTimeScale :: Text
- data ModelsimOptions = ModelsimOptions {
- msVlogOpts :: [Text]
- msVsimOpts :: [Text]
- data QuartusOptions = QuartusOptions {
- quartusBoardDevIndex :: Int
- quartusFamily :: Text
- quartusDevice :: Text
- quartusOpts :: [Text]
- quartusDseOpts :: [Text]
- data VivadoOptions = VivadoOptions {
- vivadoPart :: Text
- pprEdam :: Edam -> Doc ann
Documentation
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.
Constructors
| Edam | |
Fields
| |
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 | |
Fields
| |
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
| Eq EdamFileType Source # | |
Defined in Clash.Edalize.Edam | |
| Show EdamFileType Source # | |
Defined in Clash.Edalize.Edam Methods showsPrec :: Int -> EdamFileType -> ShowS # show :: EdamFileType -> String # showList :: [EdamFileType] -> ShowS # | |
Tool-specific configuration used by Edalize. Currently only tools which are supported by Clash are provided.
Constructors
| EdamTools | |
Fields | |
data GhdlOptions Source #
Constructors
| GhdlOptions | |
Fields
| |
Instances
| Default GhdlOptions Source # | |
Defined in Clash.Edalize.Edam Methods def :: GhdlOptions # | |
data IcarusOptions Source #
Constructors
| IcarusOptions | |
Fields
| |
Instances
| Default IcarusOptions Source # | |
Defined in Clash.Edalize.Edam Methods def :: IcarusOptions # | |
data ModelsimOptions Source #
Constructors
| ModelsimOptions | |
Fields
| |
Instances
| Default ModelsimOptions Source # | |
Defined in Clash.Edalize.Edam Methods def :: ModelsimOptions # | |
data QuartusOptions Source #
Constructors
| QuartusOptions | |
Fields
| |
Instances
| Default QuartusOptions Source # | |
Defined in Clash.Edalize.Edam Methods def :: QuartusOptions # | |
data VivadoOptions Source #
Constructors
| VivadoOptions | |
Fields
| |
Instances
| Default VivadoOptions Source # | |
Defined in Clash.Edalize.Edam Methods def :: VivadoOptions # | |