xpla3: generate database

Cargo.toml

@@ -53,7 +53,7 @@ members = [
 	"prjcombine_xilinx_cpld",
 	"prjcombine_xilinx_recpld",
 	"prjcombine_sdf",
-	"prjcombine_xc9500",
+	"prjcombine_xc9500", "prjcombine_xpla3",
 ]
 resolver = "2"
 
@@ -109,6 +109,7 @@ prjcombine_xilinx_cpld = { path = "prjcombine_xilinx_cpld" }
 prjcombine_ise_dump = { path = "prjcombine_ise_dump" }
 prjcombine_sdf = { path = "prjcombine_sdf" }
 prjcombine_xc9500 = { path = "prjcombine_xc9500" }
+prjcombine_xpla3 = { path = "prjcombine_xpla3" }
 unnamed_entity = { version = "0.1", features = ["bitvec", "map", "serde"] }
 assert_matches = "1.5"
 serde = { version = "1.0", features = ["derive"] }

docs/Makefile

@@ -16,10 +16,13 @@ help:
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-html: Makefile generated-xc9500
+html: Makefile generated-xc9500 generated-xpla3
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 generated-xc9500: gen_xc9500.py ../databases/xc9500.json ../databases/xc9500xl.json ../databases/xc9500xv.json
 	python gen_xc9500.py
 
-.PHONY: generated-xc9500
+generated-xpla3: gen_xpla3.py ../databases/xpla3.json
+	python gen_xpla3.py
+
+.PHONY: generated-xc9500 generated-xpla3

docs/gen_xc9500.py

@@ -215,7 +215,6 @@ def gen_tile_fb(f, tname, tile, sortflip, multi=False):
                         pins = {}
                         io_special = {**device["io_special"], **db["bonds"][bond]["io_special_override"]}
                         io_special_rev = {f"IOB_{v[0]}_{v[1]}": k for k, v in io_special.items()}
-                        # TODO io_special
                         for k, v in db["bonds"][bond]["pins"].items():
                             if v not in pins:
                                 pins[v] = ([], io_special_rev.get(v))

docs/gen_xpla3.py

@@ -0,0 +1,270 @@
+import json
+
+with open("../databases/xpla3.json") as f:
+    db = json.load(f)
+
+with open("xpla3/gen-devices.inc", "w") as f:
+    f.write(".. list-table::\n")
+    f.write("   :header-rows: 1\n")
+    f.write("\n")
+    f.write("   - - Device\n")
+    f.write("     - IDCODE\n")
+    f.write("     - Function Blocks\n")
+    for part in db["parts"]:
+        device = db["devices"][part["device"]]
+        f.write(f"   - - {part['name']}\n")
+        f.write(f"     - ``0xX{device['idcode_part']:04x}XXX``\n")
+        f.write(f"     - {device['fb_rows'] * len(device['fb_cols']) * 2}\n")
+
+packages = []
+for part in db["parts"]:
+    for pkg in part["packages"]:
+        if pkg not in packages:
+            packages.append(pkg)
+
+with open("xpla3/gen-devices-pkg.inc", "w") as f:
+    f.write(".. list-table::\n")
+    f.write("   :header-rows: 1\n")
+    f.write("\n")
+    f.write("   - - Device\n")
+    for pkg in packages:
+        f.write(f"     - {pkg}\n")
+    for part in db["parts"]:
+        f.write(f"   - - {part['name']}\n")
+        for pkg in packages:
+            if pkg in part["packages"]:
+                f.write(f"     - X\n")
+            else:
+                f.write(f"     - \\-\n")
+
+def gen_tile_items(f, tname, tile):
+    for name, item in sorted(tile.items(), key=lambda x: x[1]["bits"]):
+        f.write(f"<table class=\"docutils align-default prjcombine-enum\" id=\"bits-{tname}-{name}\">\n")
+        f.write(f"<tr><th>{name}</th>")
+        for bit in reversed(item["bits"]):
+            f.write(f"<th>{bit}</th>")
+        f.write("</tr>\n")
+        if "values" in item:
+            for vname, val in sorted(item["values"].items(), key=lambda x: x[1][::-1]):
+                f.write(f"<tr><td>{vname}</td>")
+                for v in reversed(val):
+                    f.write(f"<td>{int(v)}</td>")
+                f.write(f"</tr>\n")
+        else:
+            if item["invert"]:
+                f.write("<tr><td>Inverted</td>")
+                inv = "~"
+            else:
+                f.write("<tr><td>Non-inverted</td>")
+                inv = ""
+            for i in reversed(range(len(item["bits"]))):
+                f.write(f"<td>{inv}[{i}]</td>")
+            f.write("</tr>\n")
+        f.write("</table>\n")
+
+def gen_tile(f, tname, tile):
+    f.write("<table class=\"docutils align-default prjcombine-tile\">\n")
+    rev = {}
+    rows = set()
+    columns = set()
+    for item in tile.values():
+        for bit in item["bits"]:
+            rows.add((bit[0], bit[1]))
+            columns.add(bit[2])
+    for name, item in tile.items():
+        for j, bit in enumerate(item["bits"]):
+            key = tuple(bit)
+            if key not in rev:
+                rev[key] = []
+            rev[key].append((name, item, None if len(item["bits"]) == 1 else j))
+    f.write(f"<tr><th rowspan=\"2\">Row</th><th rowspan=\"2\">Plane</th><th colspan=\"{len(columns)}\">Column</th></tr>")
+    f.write("<tr>")
+    for col in sorted(columns):
+        f.write(f"<th>{col}</th>")
+    f.write("</tr>\n")
+    for (row, plane) in sorted(rows):
+        f.write(f"<tr><td>{row}</td><td>{plane}</td>\n")
+        for col in sorted(columns):
+            f.write("<td>")
+            crd = (row, plane, col)
+            if crd in rev:
+                for name, item, bidx in rev[crd]:
+                    title = name
+                    if bidx is not None:
+                        title = f"{name}[{bidx}]"
+                    if item.get("invert", False):
+                        title = f"~{title}"
+                    f.write(f"<a href=\"#bits-{tname}-{name}\" title=\"{title}\">X</a>")
+            else:
+                f.write("-")
+            f.write("</td>")
+        f.write("</tr>\n")
+    f.write("</table>\n")
+
+    gen_tile_items(f, tname, tile)
+
+def gen_jed(f, tname, tile, bits):
+    f.write("<table class=\"docutils align-default prjcombine-tile\">\n")
+    f.write("<tr><th>JED offset</th><th>Bit</th></tr>\n")
+    for i, (name, idx) in enumerate(bits):
+        if len(tile[name]["bits"]) == 1:
+            bname = name
+        else:
+            bname = f"{name}[{idx}]"
+        f.write(f"<tr><td>{i}</td><td><a href=\"#bits-{tname}-{name}\">{bname}</a></td></tr>\n")
+    f.write("</table>\n")
+
+with open("xpla3/gen-tile-mc.html", "w") as f:
+    gen_tile(f, "mc", db["mc_bits"])
+
+with open("xpla3/gen-jed-mc-iob.html", "w") as f:
+    gen_jed(f, "mc", db["mc_bits"], db["jed_mc_bits_iob"])
+
+with open("xpla3/gen-jed-mc-buried.html", "w") as f:
+    gen_jed(f, "mc", db["mc_bits"], db["jed_mc_bits_buried"])
+
+with open("xpla3/gen-tile-fb.html", "w") as f:
+    gen_tile(f, "fb", db["fb_bits"])
+
+with open("xpla3/gen-jed-fb.html", "w") as f:
+    gen_jed(f, "fb", db["fb_bits"], db["jed_fb_bits"])
+
+with open("xpla3/db-devices.rst", "w") as f:
+    f.write("Database — devices\n")
+    f.write("##################\n")
+    f.write("\n")
+    f.write(".. toctree::\n")
+    f.write("   :caption: Contents:\n")
+    f.write("\n")
+    devs_done = set()
+    for part in db["parts"]:
+        if part["device"] not in devs_done:
+            devs_done.add(part["device"])
+            f.write(f"   db-device-{part['name']}\n")
+
+for i, device in enumerate(db["devices"]):
+    parts = []
+    bonds = {}
+    for part in db["parts"]:
+        if part["device"] == i:
+            parts.append(part)
+            for pkg, bond in part["packages"].items():
+                if bond not in bonds:
+                    pins = {}
+                    for k, v in db["bonds"][bond]["pins"].items():
+                        if v not in pins:
+                            pins[v] = []
+                        pins[v].append(k)
+                    bonds[bond] = ([], pins)
+                bonds[bond][0].append(f"{part['name']}-{pkg}")
+    bonds = {
+        k: bonds[k]
+        for k in sorted(bonds)
+    }
+    dev_packages = [pkg for pkg in packages if any(pkg in part["packages"] for part in parts)]
+    with open(f"xpla3/db-device-{parts[0]['name']}.rst", "w") as f:
+        names = ", ".join(part["name"].upper() for part in parts)
+        fbs = device['fb_rows'] * len(device['fb_cols']) * 2
+        io_special_rev = {f"IOB_{v[0]}_{v[1]}": k for k, v in device["io_special"].items()}
+        f.write(f"{names}\n")
+        l = "#" * len(names)
+        f.write(f"{l}\n")
+        f.write(f"\n")
+        f.write(f"IDCODE part: {device['idcode_part']:#06x}\n")
+        f.write(f"\n")
+        f.write(f"FB count: {device['fb_rows'] * len(device['fb_cols']) * 2}\n")
+        f.write(f"\n")
+        f.write(f"BS cols: {device['bs_cols']}\n")
+        f.write(f"\n")
+        f.write(f"IMUX width: {device['imux_width']}\n")
+        f.write(f"\n")
+        f.write(f"FB rows: {device['fb_rows']}\n")
+        f.write(f"\n")
+        f.write(f"FB cols: {len(device['fb_cols'])}\n")
+        f.write(f"\n")
+        f.write(f"I/O pins\n")
+        f.write(f"========\n")
+        f.write(f"\n")
+        f.write(f".. list-table::\n")
+        f.write(f"   :header-rows: 1\n")
+        f.write(f"\n")
+        f.write(f"   - - Function\n")
+        for names, _ in bonds.values():
+            f.write(f"     - {', '.join(names)}\n")
+        f.write(f"   - - IDCODE part\n")
+        for bond in bonds:
+            bond = db["bonds"][bond]
+            f.write(f"     - {bond['idcode_part']:#06x}\n")
+        for fb in range(fbs):
+            for mc in device['io_mcs']:
+                io = f"IOB_{fb}_{mc}"
+                if io in io_special_rev:
+                    spec = io_special_rev[io]
+                    f.write(f"   - - {io} ({spec})\n")
+                else:
+                    f.write(f"   - - {io}\n")
+                for _, pins in bonds.values():
+                    if io in pins:
+                        f.write(f"     - {pins[io][0]}\n")
+                    else:
+                        f.write(f"     - \\-\n")
+        for i in range(4):
+            pad = f"GCLK{i}"
+            f.write(f"   - - {pad}\n")
+            for _, pins in bonds.values():
+                f.write(f"     - {pins[pad][0]}\n")
+        specs = ["PORT_EN", "GND", "VCC", "NC"]
+        for spec in specs:
+            f.write(f"   - - {spec}\n")
+            for _, pins in bonds.values():
+                if spec in pins:
+                    pins = pins[spec]
+                    f.write(f"     - {pins[0]}\n")
+                    for pin in pins[1:]:
+                        f.write(f"\n")
+                        f.write(f"       {pin}\n")
+                else:
+                    f.write(f"     - \\-\n")
+        f.write(f"\n")
+        f.write(f"Speed data\n")
+        f.write(f"==========\n")
+        f.write(f"\n")
+        f.write(f".. list-table::\n")
+        f.write(f"   :header-rows: 1\n")
+        f.write(f"\n")
+        f.write(f"   - - Timing parameter\n")
+        for part in parts:
+            speeds = sorted(part["speeds"], key=lambda s: int(s[1:]))
+            for speed in speeds:
+                f.write(f"     - {part['name']}{speed}\n")
+        for key in db["speeds"][0]["timing"]:
+            f.write(f"   - - {key}\n")
+            for part in parts:
+                speeds = sorted(part["speeds"], key=lambda s: int(s[1:]))
+                for speed in speeds:
+                    val = db["speeds"][part["speeds"][speed]]["timing"][key]
+                    f.write(f"     - {val}\n")
+        f.write(f"\n")
+        f.write(f"IMUX bits\n")
+        f.write(f"=========\n")
+        f.write(f"\n")
+        f.write(f".. raw:: html\n")
+        f.write(f"   :file: gen-tile-{parts[0]['name']}-imux.html\n")
+        with open(f"xpla3/gen-tile-{parts[0]['name']}-imux.html", "w") as tf:
+            gen_tile(tf, "imux", device["imux_bits"])
+        f.write(f"\n")
+        f.write(f"Global bits\n")
+        f.write(f"===========\n")
+        f.write(f"\n")
+        f.write(f".. raw:: html\n")
+        f.write(f"   :file: gen-tile-{parts[0]['name']}-global.html\n")
+        with open(f"xpla3/gen-tile-{parts[0]['name']}-global.html", "w") as tf:
+            gen_tile(tf, "global", device["global_bits"])
+        f.write(f"\n")
+        f.write(f"JED mapping\n")
+        f.write(f"-----------\n")
+        f.write(f"\n")
+        f.write(f".. raw:: html\n")
+        f.write(f"   :file: gen-jed-{parts[0]['name']}-global.html\n")
+        with open(f"xpla3/gen-jed-{parts[0]['name']}-global.html", "w") as tf:
+            gen_jed(tf, "global", device["global_bits"], device["jed_global_bits"])

docs/xpla3/.gitignore

@@ -0,0 +1,3 @@
+/db-*.rst
+/gen-*.inc
+/gen-*.html

docs/xpla3/bitstream.rst

@@ -2,3 +2,37 @@ Bitstream structure
 ###################
 
 .. todo:: write me
+
+Fuses — macrocells
+==================
+
+.. raw:: html
+   :file: gen-tile-mc.html
+
+JED mapping — macrocells with IOB
+---------------------------------
+
+.. raw:: html
+   :file: gen-jed-mc-iob.html
+
+
+JED mapping — macrocells without IOB
+------------------------------------
+
+.. raw:: html
+   :file: gen-jed-mc-buried.html
+
+
+Fuses — FBs
+===========
+
+.. raw:: html
+   :file: gen-tile-fb.html
+
+
+JED mapping
+-----------
+
+.. raw:: html
+   :file: gen-jed-fb.html
+

docs/xpla3/index.rst

@@ -8,4 +8,5 @@ Xilinx XPLA3 CPLDs
    intro
    structure
    bitstream
+   db-devices
    jtag