CFU-Playground 项目使用指南

CFU-Playground 项目使用指南

1. 项目的目录结构及介绍

CFU-Playground 项目的目录结构如下：

CFU-Playground/
├── common/
├── conf/
├── docs/
├── prog/
├── proj/
│   └── proj_template/
├── python/
│   └── amaranth_cfu/
├── scripts/
├── soc/
├── third_party/
│   ├── clang-format/
│   ├── gitignore/
│   ├── gitmodules/
│   └── readthedocs.yml/
├── AUTHORS
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
└── README.md

目录介绍

• common/: 包含项目通用的代码和资源。
• conf/: 包含项目的配置文件。
• docs/: 包含项目的文档文件。
• prog/: 包含项目的程序文件。
• proj/: 包含项目的模板和示例项目，其中 proj_template/ 是默认的项目模板。
• python/: 包含与项目相关的 Python 代码，特别是 amaranth_cfu/ 目录，用于硬件描述。
• scripts/: 包含项目的脚本文件，用于自动化任务。
• soc/: 包含与系统级芯片（SoC）相关的代码和资源。
• third_party/: 包含第三方依赖和工具，如 clang-format、gitignore 等。
• AUTHORS: 项目作者列表。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 项目的贡献指南。
• LICENSE: 项目的开源许可证（Apache-2.0）。
• Makefile: 项目的构建文件。
• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件主要是 Makefile 和 README.md。

Makefile

Makefile 是项目的构建文件，包含了项目的编译、构建和运行命令。通过 make 命令可以执行不同的任务，例如：

• make prog: 构建并加载 SoC 到 FPGA 板。
• make load: 构建并加载 RISC-V 程序到 SoC。
• make renode: 使用 Renode 模拟器运行项目。
• make PLATFORM=sim load: 使用 Verilator 模拟器运行项目。

README.md

README.md 是项目的介绍和使用说明文件，包含了项目的概述、安装步骤、使用方法和贡献指南。首次使用项目时，应首先阅读此文件。

3. 项目的配置文件介绍

项目的配置文件主要位于 conf/ 目录下，包含项目的各种配置选项。

conf/

• gitignore: Git 忽略文件配置。
• gitmodules: Git 子模块配置。
• readthedocs.yml: ReadTheDocs 文档配置。

这些配置文件用于管理项目的版本控制、文档生成和其他自动化任务。

通过以上介绍，您可以更好地理解和使用 CFU-Playground 项目。