refactoring resources to automatically add unused pull up/down pins

Author: Oron Port

compiler/ir/src/main/scala/dfhdl/compiler/ir/annotation.scala

@@ -185,7 +185,8 @@ object constraints:
       slewRate: ConfigN[IO.SlewRate] = None,
       driveStrength: ConfigN[Int] = None,
       pullMode: ConfigN[IO.PullMode] = None,
-      dualPurposeGroups: ConfigN[String] = None
+      dualPurposeGroups: ConfigN[String] = None,
+      unusedPullMode: ConfigN[IO.PullMode] = None
   ) extends SigConstraint derives CanEqual, ReadWriter:
     protected def `prot_=~`(that: HWAnnotation)(using MemberGetSet): Boolean = this == that
     lazy val getRefs: List[DFRef.TwoWayAny] = Nil
@@ -202,7 +203,8 @@ object constraints:
               slewRate = slewRate.merge(that.slewRate),
               driveStrength = driveStrength.merge(that.driveStrength),
               pullMode = pullMode.merge(that.pullMode),
-              dualPurposeGroups = dualPurposeGroups.merge(that.dualPurposeGroups)
+              dualPurposeGroups = dualPurposeGroups.merge(that.dualPurposeGroups),
+              unusedPullMode = unusedPullMode.merge(that.unusedPullMode)
             )
           )
         case _ => None
@@ -217,7 +219,8 @@ object constraints:
         csParam("slewRate", slewRate),
         csParam("driveStrength", driveStrength),
         csParam("pullMode", pullMode),
-        csParam("dualPurposeGroups", dualPurposeGroups)
+        csParam("dualPurposeGroups", dualPurposeGroups),
+        csParam("unusedPullMode", unusedPullMode)
       ).filter(_.nonEmpty).mkString(", ")
       s"""@io($params)"""
     end codeString

core/src/main/scala/dfhdl/core/DFEnum.scala

@@ -51,7 +51,7 @@ object DFEncoding:
     final def encode(idx: Int): BigInt = bigIntValue
   end Manual
 
-  abstract class Toggle extends Default, ExplicitWidth[1]:
+  abstract class Toggle extends Default, ExplicitWidth[1] derives CanEqual:
     val width: 1 = 1
 
 end DFEncoding

core/src/main/scala/dfhdl/core/Design.scala

@@ -42,11 +42,47 @@ trait Design extends Container, HasClsMetaArgs:
   private var hasStartedLate: Boolean = false
   final override def onCreateStartLate: Unit =
     hasStartedLate = true
+    import dfc.getSet
+    if (
+      dfc.owner.asIR.getThisOrOwnerDesign.dclMeta.annotations.exists(
+        _.isInstanceOf[ir.constraints.DeviceID]
+      )
+    )
+      handleResourceConstraints()
     dfc.exitOwner()
     dfc.enterLate()
   private[dfhdl] def skipChecks: Boolean = false
 
   def customTopChecks(): Unit = {}
+  private def handleResourceConstraints(): Unit =
+    import dfhdl.{<>, OUT, NOTHING}
+    import ir.constraints.{IO, SigConstraint}
+    import dfhdl.platforms.resources.*
+    import dfhdl.platforms.devices.Pin
+    def addUnusedPinPort(pinID: String, constraints: List[SigConstraint]): Unit =
+      val port =
+        DFBit.<>(OUT)(using dfc.setName(s"Pin_${pinID}_unused").setAnnotations(constraints))
+      port <> NOTHING(DFBit)(using dfc.anonymize)
+    val usedPinIDs: Set[String] =
+      dfc.mutableDB.ResourceOwnershipContext
+        .getConnectedResourceMap.values.flatten
+        .flatMap(_._2.allSigConstraints)
+        .collect { case IO(loc = pinID: String) => pinID }.toSet
+    def addUnusedPinPorts(resourceOwner: ResourceOwner): Unit =
+      resourceOwner.getChildren.foreach(addUnusedPinPorts)
+      resourceOwner.getResources.foreach {
+        case pin: Pin if (!usedPinIDs.contains(pin.id)) =>
+          val hasUnusedPullMode = pin.allSigConstraints.exists {
+            case IO(unusedPullMode = unusedPullMode: IO.PullMode) => true
+            case _                                                => false
+          }
+          if (hasUnusedPullMode)
+            addUnusedPinPort(pin.id, pin.allSigConstraints)
+        case _ =>
+      }
+    dfc.mutableDB.ResourceOwnershipContext.getTopResourceOwners.foreach(addUnusedPinPorts)
+  end handleResourceConstraints
+
   final override def onCreateEnd(thisOwner: Option[This]): Unit =
     if (hasStartedLate)
       dfc.exitLate()

core/src/main/scala/dfhdl/core/MutableDB.scala

@@ -316,6 +316,8 @@ final class MutableDB():
     private var topResourceOwners: List[ResourceOwner] = Nil
     private var stack: List[ResourceOwner] = Nil
     private val connectedResourceMap = mutable.Map.empty[DFVal.Dcl, List[(Range, Resource)]]
+    def getConnectedResourceMap: Map[DFVal.Dcl, List[(Range, Resource)]] =
+      connectedResourceMap.toMap
     def connectResource(dcl: DFVal.Dcl, range: Range, resource: Resource): Unit =
       connectedResourceMap.updateWith(dcl) {
         case Some(connections) => Some((range, resource) :: connections)

core/src/main/scala/dfhdl/hw/annotation.scala

@@ -100,11 +100,13 @@ object constraints:
       slewRate: ir.ConfigN[io.SlewRate] = None,
       driveStrength: ir.ConfigN[Int] = None,
       pullMode: ir.ConfigN[io.PullMode] = None,
-      dualPurposeGroups: ir.ConfigN[String] = None
+      dualPurposeGroups: ir.ConfigN[String] = None,
+      unusedPullMode: ir.ConfigN[io.PullMode] = None
   ) extends SigConstraint:
     val asIR: ir.constraints.IO =
       ir.constraints.IO(
-        bitIdx, loc, levelVolt, standard, slewRate, driveStrength, pullMode, dualPurposeGroups
+        bitIdx, loc, levelVolt, standard, slewRate, driveStrength, pullMode, dualPurposeGroups,
+        unusedPullMode
       )
   end io
   object io:

lib/src/main/scala/dfhdl/platforms/Platfrom.scala renamed to core/src/main/scala/dfhdl/platforms/Platfrom.scala

@@ -0,0 +1,7 @@
+package dfhdl.platforms.devices
+import dfhdl.platforms.resources.*
+import Resource.CanConnect
+
+abstract class Bank extends ResourceGroup:
+  type This <: Bank
+  protected given Bank: This = this.asInstanceOf[This]