riscv/rocket-chip
1
0
Fork 0
Code Releases Activity

Merge pull request #783 from freechipsproject/plusarg_docstring

Browse Source 
plusarg_reader : Add the ability to add a documentation string.
This commit is contained in:
Megan Wachs 2017-06-05 18:21:07 -07:00 committed by GitHub
commit f0a59a81c8
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/main/scala/util/PlusArg.scala
View File

@ -3,7 +3,7 @@
package util package util
import Chisel._ import Chisel._
class plusarg_reader(format: String, default: Int) extends BlackBox(Map( class plusarg_reader(val format: String, val default: Int, val docstring: String) extends BlackBox(Map(
"FORMAT" -> chisel3.core.StringParam(format), "FORMAT" -> chisel3.core.StringParam(format),
"DEFAULT" -> chisel3.core.IntParam(default))) { "DEFAULT" -> chisel3.core.IntParam(default))) {
val io = new Bundle { val io = new Bundle {
@ -13,9 +13,12 @@ class plusarg_reader(format: String, default: Int) extends BlackBox(Map(
object PlusArg object PlusArg
{ {
// PlusArg("foo") will return 42 if the simulation is run with +foo=42 // PlusArg("foo") will return 42.U if the simulation is run with +foo=42
// Do not use this as an initial register value. The value is set in an // Do not use this as an initial register value. The value is set in an
// initial block and thus accessing it from another initial is racey. // initial block and thus accessing it from another initial is racey.
def apply(name: String, default: Int = 0): UInt = // Add a docstring to document the arg, which can be dumped in an elaboration
Module(new plusarg_reader(name + "=%d", default)).io.out // pass.
def apply(name: String, default: Int = 0, docstring: String = ""): UInt =
Module(new plusarg_reader(name + "=%d", default, docstring)).io.out
} }