Trait

firrtl.util

BackendCompilationUtilities

Related Doc: package util

Permalink

trait BackendCompilationUtilities extends AnyRef

Source
BackendCompilationUtilities.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BackendCompilationUtilities
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. lazy val TestDirectory: File

    Permalink

    Parent directory for tests

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  7. def copyResourceToFile(name: String, file: File): Unit

    Permalink

    Copy the contents of a resource to a destination file.

    Copy the contents of a resource to a destination file.

    name

    the name of the resource

    file

    the file to write it into

  8. def cppToExe(prefix: String, dir: File): ProcessBuilder

    Permalink
  9. def createTestDirectory(testName: String): File

    Permalink

    Create a test directory

    Create a test directory

    Will create outer directory called testName then inner directory based on the current time

  10. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  12. def executeExpectingFailure(prefix: String, dir: File, assertionMsg: String = ""): Boolean

    Permalink
  13. def executeExpectingSuccess(prefix: String, dir: File): Boolean

    Permalink
  14. def firrtlToVerilog(prefix: String, dir: File): ProcessBuilder

    Permalink

    compule chirrtl to verilog by using a separate process

    compule chirrtl to verilog by using a separate process

    prefix

    basename of the file

    dir

    directory where file lives

    returns

    true if compiler completed successfully

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def makeHarness(template: (String) ⇒ String, post: String)(f: File): File

    Permalink
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def timeStamp: String

    Permalink
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. def verilogToCpp(dutFile: String, dir: File, vSources: Seq[File], cppHarness: File, suppressVcd: Boolean = false, resourceFileName: String = ...): ProcessBuilder

    Permalink

    Generates a Verilator invocation to convert Verilog sources to C++ simulation sources.

    Generates a Verilator invocation to convert Verilog sources to C++ simulation sources.

    The Verilator prefix will be V$dutFile, and running this will generate C++ sources and headers as well as a makefile to compile them.

    Verilator will automatically locate the top-level module as the one among all the files which are not included elsewhere. If multiple ones exist, the compilation will fail.

    If the file BlackBoxSourceHelper.fileListName (or an overridden .f resource filename that is specified with the optional resourceFileName parameter) exists in the output directory, it contains a list of source files to be included. Filter out any files in the vSources sequence that are in this file so we don't include the same file multiple times. This complication is an attempt to work-around the fact that clients used to have to explicitly include additional Verilog sources. Now, more of that is automatic.

    dutFile

    name of the DUT .v without the .v extension

    dir

    output directory

    vSources

    list of additional Verilog sources to compile

    cppHarness

    C++ testharness to compile/link against

    suppressVcd

    specifies if VCD tracing should be suppressed

    resourceFileName

    specifies what filename to look for to find a .f file

  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def yosysExpectFailure(customTop: String, referenceTop: String, testDir: File, resets: Seq[(Int, String, Int)] = Seq.empty): Boolean

    Permalink

    Creates and runs a Yosys script that creates and runs SAT on a miter circuit.

    Creates and runs a Yosys script that creates and runs SAT on a miter circuit. Returns false if SAT succeeds, true otherwise

    The custom and reference Verilog files must not contain any modules with the same name otherwise Yosys will not be able to create a miter circuit

    customTop

    name of the DUT with custom transforms without the .v extension

    referenceTop

    name of the DUT without custom transforms without the .v extension

    testDir

    directory containing verilog files

    resets

    signals to set for SAT, format is (timestep, signal, value)

  30. def yosysExpectSuccess(customTop: String, referenceTop: String, testDir: File, resets: Seq[(Int, String, Int)] = Seq.empty): Boolean

    Permalink

    Creates and runs a Yosys script that creates and runs SAT on a miter circuit.

    Creates and runs a Yosys script that creates and runs SAT on a miter circuit. Returns true if SAT succeeds, false otherwise

    The custom and reference Verilog files must not contain any modules with the same name otherwise Yosys will not be able to create a miter circuit

    customTop

    name of the DUT with custom transforms without the .v extension

    referenceTop

    name of the DUT without custom transforms without the .v extension

    testDir

    directory containing verilog files

    resets

    signals to set for SAT, format is (timestep, signal, value)

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped