NESTang 项目使用教程

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

NESTang 是一个使用 Sipeed Tang Primer 25K、Nano 20K 和 Primer 20K 板实现的 FPGA Nintendo Entertainment System 的开源项目。以下是项目的目录结构及其介绍：

nestang/
├── docs/
│   └── README.md
├── src/
│   ├── core/
│   ├── peripherals/
│   └── top/
├── scripts/
├── tests/
├── LICENSE
├── README.md
└── build_instructions.md

• docs/: 包含项目的文档文件，如 README.md。
• src/: 包含项目的主要源代码，分为 core/、peripherals/ 和 top/ 三个子目录。
  • core/: 包含核心逻辑代码。
  • peripherals/: 包含外设接口代码。
  • top/: 包含顶层模块代码。
• scripts/: 包含构建和测试脚本。
• tests/: 包含测试代码和测试数据。
• LICENSE: 项目的许可证文件。
• README.md: 项目的主 README 文件。
• build_instructions.md: 构建项目的详细说明。

2. 项目的启动文件介绍

项目的启动文件通常位于 src/top/ 目录下，负责初始化系统并启动核心逻辑。以下是一个典型的启动文件示例：

// src/top/top.v
module top (
    input clk,
    input reset_n,
    output [7:0] led
);
    // 系统初始化逻辑
    reg [7:0] led_reg;
    always @(posedge clk or negedge reset_n) begin
        if (!reset_n) begin
            led_reg <= 8'h00;
        end else begin
            led_reg <= 8'hFF;
        end
    end

    assign led = led_reg;
endmodule

该文件定义了一个顶层模块 top，负责初始化 LED 显示。

3. 项目的配置文件介绍

项目的配置文件通常位于项目的根目录或 src/ 目录下，用于配置项目的构建和运行参数。以下是一个典型的配置文件示例：

// config.json
{
    "board": "Sipeed_Tang_Primer_25K",
    "clock_frequency": 50000000,
    "sd_card_path": "/sdcard",
    "mapper_support": ["MMC5", "Namco"]
}

该文件使用 JSON 格式，配置了板子类型、时钟频率、SD 卡路径和映射器支持列表。

以上是 NESTang 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。