工程搭建

约 3083 字大约 10 分钟

2025-01-08

工程管理主要需要实现以下几个任务:

工程搭建

Library Manager (IP & BD)
Project Manager (PS & PL)

仿真搭建

Instances & AI for Generate tb file
Fast simulate & Generate simulation script

设计辅助

Tree Structure
Code-Document
Netlist-View
Wave-View

DIDE 项目配置

标准文件结构

DIDE 项目的配置核心在于 property.json 这个文件。一个名为 PROJECT_NAME 的项目的标准结构如下：

PROJECT_NAME
- .vscode
  - property.json 工程配置文件用户自定义 (或者存放于工作区的根目录也可)
- prj 用于存放工程文件
  - simulation 用于存放第三方仿真工具运行时的中间文件
    - …
  - factory 用于存放原厂的工程文件 (如：xilinx，efinlix)
    - …
- user 用于存放用户设计的源文件用户自定义
  - ip 用于存放工程ip代码 (厂商工具管理，但由插件搬移至src同级目录)
    - …
  - bd 用于存放工程block design源码 (厂商工具管理，但由插件搬移至src同级目录)
    - …
  - data 主要存放数据文件，以及约束文件
    - …
  - sim 用于存放用户仿真代码
    - …
  - src 用于存放用户的设计源码
    - lib 用于存放用户的硬件库源码
      - …
  - sdk 用于存放软件设计，对应xilinx的sdk的设计
    - …

注

在此去除 Hardware 和 Software 的分开设计并进行合并；在 soc 的开发模式下只会在 user 下新增 sdk 的文件夹，从而简化整体工程管理设计。当插件检索不到对应工作区下有 property.json 文件时，则认为是无配置文件结构，工程管理系统内则做以下定义(即所有的检测都会到工作区下去寻找，此操作会导致插件运行卡顿，慎用)：

"arch" : {
    "structure" : "null", // 内部配置，或者用户设置该字段在规定之外则默认设置为此
    "prjPath": "${workspace}/prj",
    "hardware" : {
        "src"  : "${workspace}", 
        "sim"  : "${workspace}",  
        "data" : "${workspace}" 
    },
    "software" : {
        "src"  : "${workspace}",
        "data" : "${workspace}" 
    }
},

自定义文件结构

用户自定义文件结构由用户自行配置的arch属性来配置（具体配置方式见下一小节），并且此时structure类型必须要配置为custom。

注

当structure配置为非custom时其余属性均忽略，只使用指定的模式。若在三种模式之外的进行报错被认为使用的是用户模式，此时若无定义则将整个工作区进行解析。

忽略文件设计 dideignore

为了更好的进行工程的自定义化在原有的管理系统上新增ignore设计。文件名定义为 .dideignore 该文件所包含的设计同 .gitignore 由文件或者文件夹带正则的相对路径或绝对路径组成；其中包含的HDL文件均忽略，不参与解析、渲染以及监控。参考书写如下：

# 忽略 user/src 文件夹下所有的文件，等同于 user/src/* 以及 user/src/
user/src

# 忽略 user/src 文件夹下所有的 .v 后缀的文件
user/src/*.v

相关信息

ignore文件的优先级大于定义的文件路径，如果ignore中包含src的路径，那整个src都不会被添加到工程中进行解析、渲染以及监控等操作。

配置文件定义

// porperty.json 所有属性解说
{
    // 当前使用的第三方工具链
    "toolChain": "xilinx", 
    "toolVersion" : "2023.2.307",

    // 工程命名 
    // PL : 编程逻辑设计部分即之前的FPGA
    // PS : 处理系统设计部分即之前的SOC
    "prjName": {
        "PL": "template",
        "PS": "template"
    },

    // 自定义工程结构，若无该属性则认为是标准文件结构（详见下文说明）
    "arch" : {
        "structure" : "", // standard | xilinx | custom
        "prjPath" : "",   // 放置工程运行时的中间文件
        "hardware" : {    
            "src"  : "",  // 放置设计源文件，注: src上一级为IP&bd
            "sim"  : "",  // 放置仿真文件，会直接反应在树状结构上
            "data" : ""   // 放置约束、数据文件，约束会自动添加进vivado工程
        },
        "software" : {
            "src"  : "",  // 放置软件设计文件
            "data" : ""   // 放置软件相关数据文件
        }
    },

    // 代码库管理，支持远程和本地两种调用方式（详见下文库管理）
    // 使用UI来进行配置，不建议用户直接更改
    "library" : {
        "state": "", // local | remote
        "hardware" : {
            "common": [], // 插件提供的常见库
            "custom": []  // 用户自己的设计库
        }
    },

    // xilinx的IP仓库，直接添加到vivado的IP repo中
    // 目前支持ADI和ARM提供的IP repo （adi | arm）
    "IP_REPO" : [],

    // 当设计时用到PL+PS即为SOC开发
    // 当其中core不为none的时候即为混合开发
    "soc": {
        "core": "none",
        "bd": "",
        "os": "",
        "app": ""
    },
    
    "device": "none"
}

于工程路径配置需支持如下功能：

所有属性均支持${workspace}、${plname}、${psname}

${workspace} ：当前工作区的路径
${plname}、${psname} ：PL或PS的工程的名字

支持相对路径的写法，如：./user/src
支持路径字符的正则匹配

相关信息

配置文件格式要做到后续版本一直兼容。同时去除更改配置文件从而更改文件结构的设计。

标准功能入口

为了更好的兼容三方EDA的综合工具，目前定义通用设计接口如下：

Launch ------ 启动整个工程，如果没有工程则创建，有的话则直接打开
Refresh ----- 刷新整个工程，更新整个工程的设计
Simulate ---- 仿真整个工程，默认不打开GUI界面 （使用的是TOOL_CHAIN里的仿真器）
1. SimGUI ----- 仿真成功后打开GUI界面
2. SimCLI ----- 仿真成功后不打开GUI界面
Build ------- 构建整个工程，并最后输出bit流文件
1. Synth ------ 进行工程的综合
2. Impl ------- 进行工程的实现
3. Bitstream -- 输出工程的bit流文件
Program ----- 比特流文件下载 （下载烧写，但不固化）
GUI --------- 打开工具链的GUI界面
Exit -------- 关闭工程。
- 在点击Exit之后插件会将你的IP和bd设计移动user/src/目录下