aboutsummaryrefslogtreecommitdiff
path: root/src/main/scala/firrtl/passes/wiring/WiringTransform.scala
blob: 5c251d6d1bdbf712995ac7ecae803a6b8176a4a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// See LICENSE for license details.

package firrtl.passes
package wiring

import firrtl._
import firrtl.ir._
import firrtl.Utils._
import firrtl.Mappers._
import scala.collection.mutable
import firrtl.Annotations._
import WiringUtils._

/** A component, e.g. register etc. Must be declared only once under the TopAnnotation
  */
case class SourceAnnotation(target: ComponentName, pin: String) extends Annotation with Loose with Unstable {
  def transform = classOf[WiringTransform]
  def duplicate(n: Named) = n match {
    case n: ComponentName => this.copy(target = n)
    case _ => throwInternalError
  }
}

/** A module, e.g. ExtModule etc., that should add the input pin
  */
case class SinkAnnotation(target: ModuleName, pin: String) extends Annotation with Loose with Unstable {
  def transform = classOf[WiringTransform]
  def duplicate(n: Named) = n match {
    case n: ModuleName => this.copy(target = n)
    case _ => throwInternalError
  }
}

/** A module under which all sink module must be declared, and there is only
  * one source component
  */
case class TopAnnotation(target: ModuleName, pin: String) extends Annotation with Loose with Unstable {
  def transform = classOf[WiringTransform]
  def duplicate(n: Named) = n match {
    case n: ModuleName => this.copy(target = n)
    case _ => throwInternalError
  }
}

/** Add pins to modules and wires a signal to them, under the scope of a specified top module
  * Description:
  *   Adds a pin to each sink module
  *   Punches ports up from the source signal to the specified top module
  *   Punches ports down to each sink module
  *   Wires the source up and down, connecting to all sink modules
  * Restrictions:
  *   - Can only have one source module instance under scope of the specified top
  *   - All instances of each sink module must be under the scope of the specified top
  * Notes:
  *   - No module uniquification occurs (due to imposed restrictions)
  */
class WiringTransform extends Transform with SimpleRun {
  def inputForm = MidForm
  def outputForm = MidForm
  def passSeq(wis: Seq[WiringInfo]) =
    Seq(new Wiring(wis),
        InferTypes,
        ResolveKinds,
        ResolveGenders)
  def execute(state: CircuitState): CircuitState = getMyAnnotations(state) match {
    case Nil => CircuitState(state.circuit, state.form)
    case p =>
      // Pin to value
      val sinks = mutable.HashMap[String, Set[String]]()
      val sources = mutable.HashMap[String, String]()
      val tops = mutable.HashMap[String, String]()
      val comp = mutable.HashMap[String, String]()
      p.foreach { a =>
        a match {
          case SinkAnnotation(m, pin) => sinks(pin) = sinks.getOrElse(pin, Set.empty) + m.name
          case SourceAnnotation(c, pin) =>
            sources(pin) = c.module.name
            comp(pin) = c.name
          case TopAnnotation(m, pin) => tops(pin) = m.name
        }
      }
      (sources.size, tops.size, sinks.size, comp.size) match {
        case (0, 0, p, 0) => state.copy(annotations = None)
        case (s, t, p, c) if (p > 0) & (s == t) & (t == c) =>
          val wis = tops.foldLeft(Seq[WiringInfo]()) { case (seq, (pin, top)) =>
            seq :+ WiringInfo(sources(pin), comp(pin), sinks(pin), pin, top)
          }
          state.copy(circuit = runPasses(state.circuit, passSeq(wis)), annotations = None)
        case _ => error("Wrong number of sources, tops, or sinks!")
      }
  }
}