Packages

final class Workspace extends AnyRef

Source
Workspace.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Workspace
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Workspace(path: String, workingDirectoryPrefix: String = "workdir")

Value Members

  1. val absolutePath: String
  2. def addPrimarySourceFromResource(klass: Class[_], name: String): Unit

    A helper method which copies the specified resource into the primary sources directory.

  3. def compile[T <: Backend](backend: T)(workingDirectoryTag: String, commonSettings: CommonCompilationSettings, backendSpecificSettings: compile.T.CompilationSettings, customSimulationWorkingDirectory: Option[String], verbose: Boolean): Simulation

    Compiles the simulation using the specified backend.

  4. def elaborate(moduleInfo: ModuleInfo): Unit

    svsim elaboration simply stores the provided ModuleInfo for use by the compile method.

    svsim elaboration simply stores the provided ModuleInfo for use by the compile method. The idea is that packages that actually do elaboration (like Chisel) will add an overload of this method in an implicit class that then calls this method with the appropriate ModuleInfo.

  5. final def generateAdditionalSources(): Unit

    Generate additional sources necessary for simulating the module.

  6. val generatedSourcesPath: String

    The directory containing code generated when calling generateAdditionalSources

  7. val primarySourcesPath: String

    The directory containing user-provided source files used to compile the simulation when compile is called.

  8. def reset(): Unit
  9. val supportArtifactsPath: String

    A directory where the user can store additional artifacts which are relevant to the primary sources (for instance, artifacts related to the generation of primary sources).

    A directory where the user can store additional artifacts which are relevant to the primary sources (for instance, artifacts related to the generation of primary sources). These artifacts have no impact on the simulation, but it may be useful to group them with the other files generated by svsim for debugging purposes.

  10. val workingDirectoryPrefix: String