final class Workspace extends AnyRef
- Alphabetic
- By Inheritance
- Workspace
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Workspace(path: String, workingDirectoryPrefix: String = "workdir")
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Workspace, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val absolutePath: String
- def addPrimarySourceFromResource(klass: Class[_], name: String): Unit
A helper method which copies the specified resource into the primary sources directory.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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.
- def elaborate(moduleInfo: ModuleInfo): Unit
svsimelaboration simply stores the providedModuleInfofor use by thecompilemethod.svsimelaboration simply stores the providedModuleInfofor use by thecompilemethod. 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 appropriateModuleInfo. - def ensuring(cond: (Workspace) => Boolean, msg: => Any): Workspace
- def ensuring(cond: (Workspace) => Boolean): Workspace
- def ensuring(cond: Boolean, msg: => Any): Workspace
- def ensuring(cond: Boolean): Workspace
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def generateAdditionalSources(timescale: Option[Timescale]): Unit
Generate additional sources necessary for simulating the module.
- val generatedSourcesPath: String
The directory containing code generated when calling
generateAdditionalSources - final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val primarySourcesPath: String
The directory containing user-provided source files used to compile the simulation when
compileis called. - def reset(): Unit
- def shallowCopy(newPath: String, workingDirectoryPrefix: String = this.workingDirectoryPrefix): Workspace
Shallow copy the sources from this workspace to a new one.
Shallow copy the sources from this workspace to a new one. Primary sources are symlinked to the new directory; nothing else is copied.
- 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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- val workingDirectoryPrefix: String
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from Workspace toStringFormat[Workspace] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- def →[B](y: B): (Workspace, B)
- Implicit
- This member is added by an implicit conversion from Workspace toArrowAssoc[Workspace] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
This is the documentation for Chisel.
Package structure
The chisel3 package presents the public API of Chisel. It contains the concrete core types
UInt,SInt,Bool,Clock, andReg, the abstract typesBits,Aggregate, andData, and the aggregate typesBundleandVec.The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.
Utility objects and methods are found in the
utilpackage.The
testerspackage defines the basic interface for chisel testers.