|
| 1 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 2 | +# FORGE OF KOSCHEI — Bitstream Generator |
| 3 | +# φ² + 1/φ² = 3 = TRINITY | KOSCHEI IS THE FORGE |
| 4 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 5 | + |
| 6 | +name: forge_bitstream |
| 7 | +version: "1.0.0" |
| 8 | +language: zig |
| 9 | +module: forge.bitstream |
| 10 | + |
| 11 | +description: | |
| 12 | + Bitstream generator for FORGE toolchain. |
| 13 | + Converts placed-and-routed design (FASM) into binary bitstream |
| 14 | + that can be loaded onto the target FPGA. |
| 15 | + Primary target: Xilinx Artix-7 XC7A35T (.bit format) |
| 16 | + Secondary target: Lattice iCE40 (.bin format) |
| 17 | + Uses prjxray database for Artix-7 frame/bit mapping. |
| 18 | + Uses icestorm chipdb for iCE40 CRAM mapping. |
| 19 | + Includes OpenOCD/JTAG flash support. |
| 20 | + |
| 21 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 22 | +# TYPES |
| 23 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 24 | + |
| 25 | +types: |
| 26 | + BitstreamConfig: |
| 27 | + description: "Bitstream generation configuration" |
| 28 | + fields: |
| 29 | + target_family: String |
| 30 | + part_name: String |
| 31 | + output_format: String |
| 32 | + compress: Bool |
| 33 | + include_debug: Bool |
| 34 | + |
| 35 | + FASMFeature: |
| 36 | + description: "Single FASM feature to configure" |
| 37 | + fields: |
| 38 | + tile_name: String |
| 39 | + site_name: String |
| 40 | + feature_path: String |
| 41 | + value: Int |
| 42 | + width: Int |
| 43 | + |
| 44 | + ConfigFrame: |
| 45 | + description: "Xilinx configuration frame (101 words for Artix-7)" |
| 46 | + fields: |
| 47 | + frame_address: Int |
| 48 | + frame_data: List<Int> |
| 49 | + word_count: Int |
| 50 | + |
| 51 | + FrameAddress: |
| 52 | + description: "Xilinx frame address decomposition" |
| 53 | + fields: |
| 54 | + block_type: Int |
| 55 | + top_bottom: Int |
| 56 | + row: Int |
| 57 | + column: Int |
| 58 | + minor: Int |
| 59 | + |
| 60 | + BitstreamHeader: |
| 61 | + description: "Xilinx .bit file header" |
| 62 | + fields: |
| 63 | + design_name: String |
| 64 | + part_name: String |
| 65 | + date: String |
| 66 | + time: String |
| 67 | + bitstream_length: Int |
| 68 | + |
| 69 | + CRAMPage: |
| 70 | + description: "iCE40 CRAM configuration page" |
| 71 | + fields: |
| 72 | + bank: Int |
| 73 | + page: Int |
| 74 | + data: List<Int> |
| 75 | + |
| 76 | + BitstreamResult: |
| 77 | + description: "Bitstream generation result" |
| 78 | + fields: |
| 79 | + output_path: String |
| 80 | + size_bytes: Int |
| 81 | + frames_written: Int |
| 82 | + format: String |
| 83 | + crc32: Int |
| 84 | + target: String |
| 85 | + |
| 86 | + FlashConfig: |
| 87 | + description: "FPGA programming configuration" |
| 88 | + fields: |
| 89 | + method: String |
| 90 | + interface_config: String |
| 91 | + target_config: String |
| 92 | + verify: Bool |
| 93 | + speed_khz: Int |
| 94 | + |
| 95 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 96 | +# CONSTANTS |
| 97 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 98 | + |
| 99 | +constants: |
| 100 | + PHI: 1.618033988749895 |
| 101 | + TRINITY: 3.0 |
| 102 | + XILINX_SYNC_WORD: 0xAA995566 |
| 103 | + XILINX_NOOP: 0x20000000 |
| 104 | + XILINX_WRITE_CMD: 0x30008001 |
| 105 | + ARTIX7_FRAME_WORDS: 101 |
| 106 | + ARTIX7_FRAME_BYTES: 404 |
| 107 | + ARTIX7_IDCODE_XC7A35T: 0x0362D093 |
| 108 | + ICE40_CRAM_BANK_SIZE: 256 |
| 109 | + ICE40_MAGIC: 0x7EAA997E |
| 110 | + CRC32_POLYNOMIAL: 0xEDB88320 |
| 111 | + JTAG_TCK_DEFAULT_KHZ: 6000 |
| 112 | + OPENOCD_ARTIX7_CFG: "target/xilinx/artix7.cfg" |
| 113 | + OPENOCD_FTDI_CFG: "interface/ftdi/digilent-hs1.cfg" |
| 114 | + |
| 115 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 116 | +# BEHAVIORS |
| 117 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 118 | + |
| 119 | +behaviors: |
| 120 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 121 | + # FASM processing |
| 122 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 123 | + |
| 124 | + - name: parse_fasm |
| 125 | + given: "Path to FASM file" |
| 126 | + when: "Loading FASM features from routing output" |
| 127 | + then: "Parse each line as tile.site.feature = value. Return list of FASMFeature." |
| 128 | + |
| 129 | + - name: validate_fasm |
| 130 | + given: "List of FASMFeatures, device database" |
| 131 | + when: "Checking FASM correctness before bitstream generation" |
| 132 | + then: "Verify all features reference valid tiles/sites/BELs. Report unknown features." |
| 133 | + |
| 134 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 135 | + # Artix-7 bitstream generation |
| 136 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 137 | + |
| 138 | + - name: fasm_to_frames_artix7 |
| 139 | + given: "List of FASMFeatures, prjxray tile/segment database for xc7a35t" |
| 140 | + when: "Converting FASM to Artix-7 bitstream frames" |
| 141 | + then: "Map each FASM feature to frame_address + bit_offset using prjxray segbits database. Collect all frame modifications. Return list of ConfigFrames." |
| 142 | + |
| 143 | + - name: build_frame_address |
| 144 | + given: "Block type, top/bottom, row, column, minor frame" |
| 145 | + when: "Constructing Xilinx frame address" |
| 146 | + then: "Pack fields into 32-bit frame address: [25:23]=block_type, [22]=top_bottom, [21:17]=row, [16:7]=column, [6:0]=minor" |
| 147 | + |
| 148 | + - name: write_bitstream_xilinx |
| 149 | + given: "List of ConfigFrames, BitstreamConfig, BitstreamHeader" |
| 150 | + when: "Generating final .bit file" |
| 151 | + then: "Write Xilinx .bit format: (1) header section, (2) sync word 0xAA995566, (3) IDCODE check, (4) FDRI write with frame data, (5) CRC, (6) DESYNC command." |
| 152 | + |
| 153 | + - name: write_bitstream_bin |
| 154 | + given: "List of ConfigFrames, BitstreamConfig" |
| 155 | + when: "Generating raw .bin file (no header)" |
| 156 | + then: "Write raw configuration data without .bit header. Suitable for SPI flash." |
| 157 | + |
| 158 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 159 | + # iCE40 bitstream generation |
| 160 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 161 | + |
| 162 | + - name: fasm_to_cram_ice40 |
| 163 | + given: "List of FASMFeatures, icestorm chipdb" |
| 164 | + when: "Converting FASM to iCE40 CRAM data" |
| 165 | + then: "Map features to CRAM bank/page/bit using icestorm tile database. Return list of CRAMPages." |
| 166 | + |
| 167 | + - name: write_bitstream_ice40 |
| 168 | + given: "List of CRAMPages, BitstreamConfig" |
| 169 | + when: "Generating iCE40 .bin file" |
| 170 | + then: "Write icepack-compatible binary: magic, CRAM bank data, BRAM data, CRC." |
| 171 | + |
| 172 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 173 | + # Verification |
| 174 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 175 | + |
| 176 | + - name: compute_crc32 |
| 177 | + given: "Byte buffer" |
| 178 | + when: "Computing bitstream integrity checksum" |
| 179 | + then: "Calculate CRC32 using standard polynomial 0xEDB88320" |
| 180 | + |
| 181 | + - name: verify_bitstream |
| 182 | + given: "Path to bitstream file, expected CRC32" |
| 183 | + when: "Validating bitstream integrity" |
| 184 | + then: "Read bitstream, compute CRC32, compare against expected. Report pass/fail." |
| 185 | + |
| 186 | + - name: compare_with_reference |
| 187 | + given: "FORGE bitstream, reference bitstream (from Vivado or icepack)" |
| 188 | + when: "Validating FORGE output against known-good bitstream" |
| 189 | + then: "Compare frame-by-frame. Report differences with frame address and bit positions." |
| 190 | + |
| 191 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 192 | + # FPGA programming |
| 193 | + # ═══════════════════════════════════════════════════════════════════════════ |
| 194 | + |
| 195 | + - name: program_fpga_openocd |
| 196 | + given: "Bitstream path, FlashConfig with OpenOCD interface/target configs" |
| 197 | + when: "Flashing Arty A7 via JTAG (Platform Cable USB II)" |
| 198 | + then: "Execute OpenOCD: init, halt, pld load <bitstream>, verify, resume. Report success/failure." |
| 199 | + |
| 200 | + - name: program_fpga_iceprog |
| 201 | + given: "Bitstream path (.bin)" |
| 202 | + when: "Flashing iCE40 via iceprog" |
| 203 | + then: "Execute iceprog <bitstream.bin>. Verify CRC after flash." |
| 204 | + |
| 205 | + - name: report_bitstream |
| 206 | + given: "BitstreamResult" |
| 207 | + when: "User requests bitstream report" |
| 208 | + then: "Print target, size, frames, format, CRC, output path" |
| 209 | + |
| 210 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 211 | +# TESTING |
| 212 | +# ═══════════════════════════════════════════════════════════════════════════════ |
| 213 | + |
| 214 | +testing: |
| 215 | + - name: test_fasm_parse |
| 216 | + description: "Parse FASM file correctly" |
| 217 | + cases: |
| 218 | + - assert: "parse_fasm handles tile.site.feature = value format" |
| 219 | + - assert: "parse_fasm handles multi-bit features (INIT[63:0])" |
| 220 | + |
| 221 | + - name: test_frame_address |
| 222 | + description: "Frame address encoding correct" |
| 223 | + cases: |
| 224 | + - assert: "build_frame_address(0, 0, 0, 0, 0) == 0x00000000" |
| 225 | + - assert: "block_type field at bits [25:23]" |
| 226 | + |
| 227 | + - name: test_xilinx_bitstream_structure |
| 228 | + description: "Generated .bit file has valid structure" |
| 229 | + cases: |
| 230 | + - assert: "Bitstream starts with valid header" |
| 231 | + - assert: "Sync word 0xAA995566 present" |
| 232 | + - assert: "IDCODE matches XC7A35T (0x0362D093)" |
| 233 | + - assert: "CRC32 at end is correct" |
| 234 | + |
| 235 | + - name: test_crc32 |
| 236 | + description: "CRC32 computation correct" |
| 237 | + cases: |
| 238 | + - assert: "CRC32 of empty buffer == 0x00000000" |
| 239 | + - assert: "CRC32 of known test vector matches reference" |
| 240 | + |
| 241 | + - name: test_bitstream_size |
| 242 | + description: "Bitstream size matches device expectations" |
| 243 | + cases: |
| 244 | + - assert: "XC7A35T bitstream approximately 2MB" |
| 245 | + - assert: "iCE40-HX1K bitstream approximately 32KB" |
0 commit comments