SatCat5 项目使用教程

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

SatCat5 项目是一个开源的 FPGA gateware 项目，它实现了一个低功耗的混合媒体以太网交换机。以下是项目的目录结构及各部分的简要介绍：

• doc: 存放项目文档和相关图片。所有文档都在此 README 中有链接。
• examples: 针对特定硬件平台的示例设计。
• project: 针对特定供应商工具的脚本和项目文件。
• libero: 在 Libero 中构建 Microsemi 设计的脚本（已测试版本 12.3）。
• modelsim: 在 ModelSim 中运行 VHDL 模拟的脚本（已测试版本 10.0a）。
• vivado: 在 Vivado 中打包 IP 核心组件、构建或模拟 Xilinx 设计的脚本（已测试版本 2019.1）。
• yosis: 使用 Yosis 构建 Lattice 设计的脚本。
• sim: 设计的模拟和验证。
• cpp: 针对嵌入式软件库的单元测试。
• matlab: 用于生成特定查找表的 MATLAB/Octave 脚本。
• test: 用于各种单元测试模拟的测试数据。
• vhdl: 针对独立功能块的 VHDL 单元测试。
• src: SatCat5 核心设计的源代码。
• cpp: 针对各种平台的 C/C++ 软件库。
• hal_devices: 针对特定硬件外设的抽象层。
• hal_pcap: 针对与 PCAP 或 NPCAP 接口的抽象层。
• hal_posix: 针对Linux 和 Windows PC 的抽象层。
• hal_test: 针对模拟和测试的抽象层。
• hal_ublaze: 针对 Xilinx Microblaze 软 CPU 的抽象层。
• satcat5: 跨平台库，用于连接和配置以太网。
• python: Python 库，用于连接原始以太网/通过 UART 的以太网端口和远程 ConfigBus 控制。
• vhdl: 功能块的 VHDL 实现。
• common: 大多数功能块的位置，适用于所有平台。
• lattice: 针对 lattice 平台特定的 VHDL。

2. 项目的启动文件介绍

项目的启动文件主要集中在 src 目录中，以下是几个关键的启动文件：

• Makefile: 构建项目的主要文件，定义了构建过程和依赖关系。
• README.md: 项目说明文件，包含了项目的简介、安装指南、配置和使用方法。
• start_docker.sh: 如果使用 Docker 容器进行开发，这个脚本可以用来启动 Docker 容器。

3. 项目的配置文件介绍

项目的配置文件主要用于设置项目的构建过程和运行环境，以下是主要的配置文件：

• .gitignore: 指定在 Git 仓库中应该忽略的文件和目录。
• CITATION.cff: 用于引用项目信息的 CITATION 文件。
• LICENSE.txt: 项目使用的许可证文件，本项目采用 CERN-OHL-W-2.0 许可证。
• config.h: 包含项目配置的定义和宏，用于在编译时配置项目特性。

在开始使用项目之前，您可能需要根据您的开发环境调整这些配置文件，以确保项目能够正确构建和运行。