Workspace

svsim.Workspace
See theWorkspace companion object
final class Workspace(path: String, val workingDirectoryPrefix: String = ...)

Attributes

Companion
object
Source
Workspace.scala
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def addPrimarySourceFromResource(klass: Class[_], name: String): Unit

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

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

Attributes

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

Compiles the simulation using the specified backend.

Compiles the simulation using the specified backend.

Value parameters

outputTag

A string which will be used to tag the output directory. This enables compiling and simulating the same workspace with multiple backends.

Attributes

Source
Workspace.scala
def elaborate(moduleInfo: ModuleInfo): Unit

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.

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.

Attributes

Source
Workspace.scala
final def generateAdditionalSources(timescale: Option[Timescale]): Unit

Generate additional sources necessary for simulating the module.

Generate additional sources necessary for simulating the module.

Attributes

Source
Workspace.scala
def reset(): Unit

Attributes

Source
Workspace.scala
def shallowCopy(newPath: String, workingDirectoryPrefix: String = ...): Workspace

Shallow copy the sources from this workspace to a new one. Primary sources are symlinked to the new directory; nothing else is copied.

Shallow copy the sources from this workspace to a new one. Primary sources are symlinked to the new directory; nothing else is copied.

Attributes

Source
Workspace.scala

Concrete fields

val absolutePath: String

Attributes

Source
Workspace.scala
val generatedSourcesPath: String

The directory containing code generated when calling generateAdditionalSources

The directory containing code generated when calling generateAdditionalSources

Attributes

Source
Workspace.scala
val primarySourcesPath: String

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

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

Attributes

Source
Workspace.scala
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). 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.

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.

Attributes

Source
Workspace.scala

Attributes

Source
Workspace.scala