summaryrefslogtreecommitdiff
path: root/src/main/scala/chisel/util/Enum.scala
diff options
context:
space:
mode:
authorRichard Lin2016-06-08 17:12:42 -0700
committerRichard Lin2016-06-08 17:12:42 -0700
commit07fa5622ccc995f925d6d967d2a386540c9064cc (patch)
treefab4d62dba2ffb78e673ee54939d9088739a79f1 /src/main/scala/chisel/util/Enum.scala
parent53813f61b7dfe246d214ab966739d01c65c8ecb0 (diff)
parent68447044e8eba5c8f525639130f1a347677ff543 (diff)
Merge pull request #197 from ucb-bar/lowercaseChisel
Rename package Chisel to chisel, add Chisel package for compatibility
Diffstat (limited to 'src/main/scala/chisel/util/Enum.scala')
-rw-r--r--src/main/scala/chisel/util/Enum.scala23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/main/scala/chisel/util/Enum.scala b/src/main/scala/chisel/util/Enum.scala
new file mode 100644
index 00000000..8babcd23
--- /dev/null
+++ b/src/main/scala/chisel/util/Enum.scala
@@ -0,0 +1,23 @@
+// See LICENSE for license details.
+
+/** Enum generators, allowing circuit constants to have more meaningful names.
+ */
+
+package chisel.util
+
+import chisel._
+
+object Enum {
+ /** Returns a sequence of Bits subtypes with values from 0 until n. Helper method. */
+ private def createValues[T <: Bits](nodeType: T, n: Int): Seq[T] =
+ (0 until n).map(x => nodeType.fromInt(x, log2Up(n)))
+
+ /** create n enum values of given type */
+ def apply[T <: Bits](nodeType: T, n: Int): List[T] = createValues(nodeType, n).toList
+
+ /** create enum values of given type and names */
+ def apply[T <: Bits](nodeType: T, l: Symbol *): Map[Symbol, T] = (l zip createValues(nodeType, l.length)).toMap
+
+ /** create enum values of given type and names */
+ def apply[T <: Bits](nodeType: T, l: List[Symbol]): Map[Symbol, T] = (l zip createValues(nodeType, l.length)).toMap
+}