pepijndevos/apicula

Project Apicula镜像说明

镜像概述

Project Apicula镜像专注于高云（Gowin）FPGA比特流格式的研究与文档化，通过模糊测试和解析厂商数据文件，帮助开发者理解比特流中各比特的功能，推动高云FPGA开源工具链的完善。

核心功能

1. 比特流格式分析: 解析高云FPGA比特流结构，明确各比特的作用与含义。
2. 模糊测试工具: 提供tiled_fuzzer.py和fuzzer.py等工具，发现厂商数据文件中未公开的参数（如LUT、BRAM、PLL设置）。
3. 开源工具集成: 兼容yosys（逻辑综合）、nextpnr-gowin（布局布线）、openFPGALoader（烧录）等开源工具，支持完整FPGA开发流程。
4. 贡献者支持: 提供环境配置指南，助力开发者参与模糊测试、厂商文件解析或代码重构。

使用场景

• FPGA开发者: 利用开源工具链完成高云FPGA项目开发（如Blinky示例）。
• 研究人员: 深入探索高云FPGA的硬件架构与比特流机制。
• 项目贡献者: 参与完善比特流解析、模糊测试或工具链集成。

配置说明

基础依赖安装

需提前安装：

• 最新版git yosys
• nextpnr-gowin
• openFPGALoader
• Python 3.6及以上版本

安装apycula工具

bash
pip install apycula

环境变量配置（可选）

若二进制文件不在系统PATH中，添加路径：

bash
export PATH="/home/your_user/.local/bin:$PATH"

示例：Blinky项目编译与烧录（Trenz TEC0117板）

bash
cd examples
yosys -p "synth_gowin -json blinky.json" blinky.v
nextpnr-gowin --json blinky.json \
              --write pnrblinky.json \
              --device GW1NR-UV9QN881C6/I5 \
              --cst tec0117.cst
gowin_pack -d GW1NR-UV9QN881C6/I5 -o pack.fs pnrblinky.json
openFPGALoader -b tec0117 pack.fs

贡献者环境（Docker方式）

1. 克隆项目仓库：

bash
git clone https://github.com/pepijndevos/apicula.git && cd apicula

2. 构建Docker镜像：

bash
docker build -t apicula-fuzzer .

3. 运行容器（挂载厂商文件目录）：

bash
docker run -v ~/Documents/gowinsemi:/gowin/installation -it apicula-fuzzer

资源链接

• 项目文档：查看doc文件夹，了解FPGA架构、厂商文件结构和比特流格式。
• 实习报告：https://github.com/pepijndevos/internshipreport
• 演示视频：FPT2020（链接）、RC3（链接）
• 社区交流：Freenode #apicula频道