Add GUI Decals API

Signed-off-by: Clifford Wolf <clifford@clifford.at>

3 files changed, 139 insertions, 100 deletions

diff --git a/ice40/arch.cc b/ice40/arch.cc
index 0b82914a..a25c3d87 100644
--- a/ice40/arch.cc
+++ b/ice40/arch.cc
@@ -400,128 +400,143 @@ delay_t Arch::estimateDelay(WireId src, WireId dst) const
 
 // -----------------------------------------------------------------------
 
-std::vector<GraphicElement> Arch::getFrameGraphics() const
+DecalXY Arch::getFrameDecal() const
 {
-    std::vector<GraphicElement> ret;
+    DecalXY decalxy;
+    decalxy.decal.type = 'f';
+    return decalxy;
+}
 
-    for (int x = 0; x <= chip_info->width; x++)
-        for (int y = 0; y <= chip_info->height; y++) {
-            GraphicElement el;
-            el.type = GraphicElement::G_LINE;
-            el.x1 = x - 0.05, el.x2 = x + 0.05, el.y1 = y, el.y2 = y, el.z = 0;
-            ret.push_back(el);
-            el.x1 = x, el.x2 = x, el.y1 = y - 0.05, el.y2 = y + 0.05, el.z = 0;
-            ret.push_back(el);
-        }
+DecalXY Arch::getBelDecal(BelId bel) const
+{
+    DecalXY decalxy;
+    decalxy.decal.type = 'b';
+    decalxy.decal.z = bel.index;
+    return decalxy;
+}
 
-    return ret;
+DecalXY Arch::getWireDecal(WireId wire) const
+{
+    DecalXY decalxy;
+    return decalxy;
 }
 
-std::vector<GraphicElement> Arch::getBelGraphics(BelId bel) const
+DecalXY Arch::getPipDecal(PipId pip) const
+{
+    DecalXY decalxy;
+    return decalxy;
+};
+
+std::vector<GraphicElement> Arch::getDecalGraphics(DecalId decal) const
 {
     std::vector<GraphicElement> ret;
 
-    auto bel_type = getBelType(bel);
-
-    if (bel_type == TYPE_ICESTORM_LC) {
-        GraphicElement el;
-        el.type = GraphicElement::G_BOX;
-        el.x1 = chip_info->bel_data[bel.index].x + logic_cell_x1;
-        el.x2 = chip_info->bel_data[bel.index].x + logic_cell_x2;
-        el.y1 = chip_info->bel_data[bel.index].y + logic_cell_y1 + (chip_info->bel_data[bel.index].z) * logic_cell_pitch;
-        el.y2 = chip_info->bel_data[bel.index].y + logic_cell_y2 + (chip_info->bel_data[bel.index].z) * logic_cell_pitch;
-        el.z = 0;
-        ret.push_back(el);
-
-        if (chip_info->bel_data[bel.index].z == 0) {
-            int tx = chip_info->bel_data[bel.index].x;
-            int ty = chip_info->bel_data[bel.index].y;
-
-            // Main switchbox
-            GraphicElement main_sw;
-            main_sw.type = GraphicElement::G_BOX;
-            main_sw.x1 = tx + main_swbox_x1;
-            main_sw.x2 = tx + main_swbox_x2;
-            main_sw.y1 = ty + main_swbox_y1;
-            main_sw.y2 = ty + main_swbox_y2;
-            ret.push_back(main_sw);
-
-            // Local tracks to LUT input switchbox
-            GraphicElement local_sw;
-            local_sw.type = GraphicElement::G_BOX;
-            local_sw.x1 = tx + local_swbox_x1;
-            local_sw.x2 = tx + local_swbox_x2;
-            local_sw.y1 = ty + local_swbox_y1;
-            local_sw.y2 = ty + local_swbox_y2;
-            local_sw.z = 0;
-            ret.push_back(local_sw);
-
-            // All the wires
-            for (int i = TILE_WIRE_GLB2LOCAL_0; i <= TILE_WIRE_SP12_H_L_23; i++)
-                gfxTileWire(ret, tx, ty, GfxTileWireId(i));
-        }
+    if (decal.type == 'f')
+    {
+        for (int x = 0; x <= chip_info->width; x++)
+            for (int y = 0; y <= chip_info->height; y++) {
+                GraphicElement el;
+                el.type = GraphicElement::G_LINE;
+                el.x1 = x - 0.05, el.x2 = x + 0.05, el.y1 = y, el.y2 = y, el.z = 0;
+                ret.push_back(el);
+                el.x1 = x, el.x2 = x, el.y1 = y - 0.05, el.y2 = y + 0.05, el.z = 0;
+                ret.push_back(el);
+            }
     }
 
-    if (bel_type == TYPE_SB_IO) {
-        if (chip_info->bel_data[bel.index].x == 0 || chip_info->bel_data[bel.index].x == chip_info->width - 1) {
+    if (decal.type == 'b')
+    {
+        BelId bel;
+        bel.index = decal.z;
+
+        auto bel_type = getBelType(bel);
+
+        if (bel_type == TYPE_ICESTORM_LC) {
             GraphicElement el;
             el.type = GraphicElement::G_BOX;
-            el.x1 = chip_info->bel_data[bel.index].x + 0.1;
-            el.x2 = chip_info->bel_data[bel.index].x + 0.9;
-            if (chip_info->bel_data[bel.index].z == 0) {
-                el.y1 = chip_info->bel_data[bel.index].y + 0.10;
-                el.y2 = chip_info->bel_data[bel.index].y + 0.45;
-            } else {
-                el.y1 = chip_info->bel_data[bel.index].y + 0.55;
-                el.y2 = chip_info->bel_data[bel.index].y + 0.90;
-            }
+            el.x1 = chip_info->bel_data[bel.index].x + logic_cell_x1;
+            el.x2 = chip_info->bel_data[bel.index].x + logic_cell_x2;
+            el.y1 = chip_info->bel_data[bel.index].y + logic_cell_y1 + (chip_info->bel_data[bel.index].z) * logic_cell_pitch;
+            el.y2 = chip_info->bel_data[bel.index].y + logic_cell_y2 + (chip_info->bel_data[bel.index].z) * logic_cell_pitch;
             el.z = 0;
             ret.push_back(el);
-        } else {
-            GraphicElement el;
-            el.type = GraphicElement::G_BOX;
+
             if (chip_info->bel_data[bel.index].z == 0) {
-                el.x1 = chip_info->bel_data[bel.index].x + 0.10;
-                el.x2 = chip_info->bel_data[bel.index].x + 0.45;
+                int tx = chip_info->bel_data[bel.index].x;
+                int ty = chip_info->bel_data[bel.index].y;
+
+                // Main switchbox
+                GraphicElement main_sw;
+                main_sw.type = GraphicElement::G_BOX;
+                main_sw.x1 = tx + main_swbox_x1;
+                main_sw.x2 = tx + main_swbox_x2;
+                main_sw.y1 = ty + main_swbox_y1;
+                main_sw.y2 = ty + main_swbox_y2;
+                ret.push_back(main_sw);
+
+                // Local tracks to LUT input switchbox
+                GraphicElement local_sw;
+                local_sw.type = GraphicElement::G_BOX;
+                local_sw.x1 = tx + local_swbox_x1;
+                local_sw.x2 = tx + local_swbox_x2;
+                local_sw.y1 = ty + local_swbox_y1;
+                local_sw.y2 = ty + local_swbox_y2;
+                local_sw.z = 0;
+                ret.push_back(local_sw);
+
+                // All the wires
+                for (int i = TILE_WIRE_GLB2LOCAL_0; i <= TILE_WIRE_SP12_H_L_23; i++)
+                    gfxTileWire(ret, tx, ty, GfxTileWireId(i));
+            }
+        }
+
+        if (bel_type == TYPE_SB_IO) {
+            if (chip_info->bel_data[bel.index].x == 0 || chip_info->bel_data[bel.index].x == chip_info->width - 1) {
+                GraphicElement el;
+                el.type = GraphicElement::G_BOX;
+                el.x1 = chip_info->bel_data[bel.index].x + 0.1;
+                el.x2 = chip_info->bel_data[bel.index].x + 0.9;
+                if (chip_info->bel_data[bel.index].z == 0) {
+                    el.y1 = chip_info->bel_data[bel.index].y + 0.10;
+                    el.y2 = chip_info->bel_data[bel.index].y + 0.45;
+                } else {
+                    el.y1 = chip_info->bel_data[bel.index].y + 0.55;
+                    el.y2 = chip_info->bel_data[bel.index].y + 0.90;
+                }
+                el.z = 0;
+                ret.push_back(el);
             } else {
-                el.x1 = chip_info->bel_data[bel.index].x + 0.55;
-                el.x2 = chip_info->bel_data[bel.index].x + 0.90;
+                GraphicElement el;
+                el.type = GraphicElement::G_BOX;
+                if (chip_info->bel_data[bel.index].z == 0) {
+                    el.x1 = chip_info->bel_data[bel.index].x + 0.10;
+                    el.x2 = chip_info->bel_data[bel.index].x + 0.45;
+                } else {
+                    el.x1 = chip_info->bel_data[bel.index].x + 0.55;
+                    el.x2 = chip_info->bel_data[bel.index].x + 0.90;
+                }
+                el.y1 = chip_info->bel_data[bel.index].y + 0.1;
+                el.y2 = chip_info->bel_data[bel.index].y + 0.9;
+                el.z = 0;
+                ret.push_back(el);
             }
+        }
+
+        if (bel_type == TYPE_ICESTORM_RAM) {
+            GraphicElement el;
+            el.type = GraphicElement::G_BOX;
+            el.x1 = chip_info->bel_data[bel.index].x + 0.1;
+            el.x2 = chip_info->bel_data[bel.index].x + 0.9;
             el.y1 = chip_info->bel_data[bel.index].y + 0.1;
-            el.y2 = chip_info->bel_data[bel.index].y + 0.9;
+            el.y2 = chip_info->bel_data[bel.index].y + 1.9;
             el.z = 0;
             ret.push_back(el);
         }
     }
 
-    if (bel_type == TYPE_ICESTORM_RAM) {
-        GraphicElement el;
-        el.type = GraphicElement::G_BOX;
-        el.x1 = chip_info->bel_data[bel.index].x + 0.1;
-        el.x2 = chip_info->bel_data[bel.index].x + 0.9;
-        el.y1 = chip_info->bel_data[bel.index].y + 0.1;
-        el.y2 = chip_info->bel_data[bel.index].y + 1.9;
-        el.z = 0;
-        ret.push_back(el);
-    }
-
-    return ret;
-}
-
-std::vector<GraphicElement> Arch::getWireGraphics(WireId wire) const
-{
-    std::vector<GraphicElement> ret;
-    // FIXME
     return ret;
 }
 
-std::vector<GraphicElement> Arch::getPipGraphics(PipId pip) const
-{
-    std::vector<GraphicElement> ret;
-    // FIXME
-    return ret;
-};
-
 // -----------------------------------------------------------------------
 
 bool Arch::getCellDelay(const CellInfo *cell, IdString fromPort, IdString toPort, delay_t &delay) const
diff --git a/ice40/arch.h b/ice40/arch.h
index 43aa0829..03685152 100644
--- a/ice40/arch.h
+++ b/ice40/arch.h
@@ -643,10 +643,12 @@ struct Arch : BaseCtx
 
     // -------------------------------------------------
 
-    std::vector<GraphicElement> getFrameGraphics() const;
-    std::vector<GraphicElement> getBelGraphics(BelId bel) const;
-    std::vector<GraphicElement> getWireGraphics(WireId wire) const;
-    std::vector<GraphicElement> getPipGraphics(PipId pip) const;
+    std::vector<GraphicElement> getDecalGraphics(DecalId decal) const;
+
+    DecalXY getFrameDecal() const;
+    DecalXY getBelDecal(BelId bel) const;
+    DecalXY getWireDecal(WireId wire) const;
+    DecalXY getPipDecal(PipId pip) const;
 
     bool allGraphicsReload = false;
     bool frameGraphicsReload = false;
diff --git a/ice40/archdefs.h b/ice40/archdefs.h
index be2e406d..061e9b44 100644
--- a/ice40/archdefs.h
+++ b/ice40/archdefs.h
@@ -21,6 +21,8 @@
 #error Include "archdefs.h" via "nextpnr.h" only.
 #endif
 
+#include <boost/functional/hash_fwd.hpp>
+
 NEXTPNR_NAMESPACE_BEGIN
 
 typedef int delay_t;
@@ -107,6 +109,13 @@ struct PipId
     bool operator!=(const PipId &other) const { return index != other.index; }
 };
 
+struct DecalId
+{
+    char type = 0; // Bel/Wire/Pip/Frame (b/w/p/f)
+    uint8_t x = 0, y = 0;
+    uint32_t z = 0;
+};
+
 NEXTPNR_NAMESPACE_END
 
 namespace std {
@@ -135,4 +144,17 @@ template <> struct hash<NEXTPNR_NAMESPACE_PREFIX BelType> : hash<int>
 template <> struct hash<NEXTPNR_NAMESPACE_PREFIX PortPin> : hash<int>
 {
 };
+
+template <> struct hash<NEXTPNR_NAMESPACE_PREFIX DecalId>
+{
+    std::size_t operator()(const NEXTPNR_NAMESPACE_PREFIX DecalId &decal) const noexcept {
+        std::size_t seed = 0;
+        boost::hash_combine(seed, hash<int>()(decal.type));
+        boost::hash_combine(seed, hash<int>()(decal.x));
+        boost::hash_combine(seed, hash<int>()(decal.y));
+        boost::hash_combine(seed, hash<int>()(decal.z));
+        return seed;
+    }
+};
+
 } // namespace std