feat: 实现 Vivado 创建工程功能

- 添加 createVivadoProject 工具 - 实现 Vivado 自动检测（支持所有盘符和版本） - 添加 TCL 脚本生成器 - 添加配置管理模块 - 添加测试命令
2026-03-16 17:46:25 +08:00
parent aa80088abc
commit fa5c2cdafd
7 changed files with 850 additions and 1625 deletions
--- a/docs/EDA联动功能需求文档.md
+++ b/docs/EDA联动功能需求文档.md
@ -37,38 +37,47 @@ IC Coder Plugin 目前支持：

 ### 2.1 核心目标

- **前端工具封装**：在插件前端实现 Vivado 调用的完整逻辑
- **后端简化调用**：后端只需调用一个工具接口
- **文件自动导入**：Vivado 执行完成后，自动将产出文件导入到项目
- **流程可视化**：执行进度、日志实时显示
+- **前端提供原子工具**：前端只提供独立的 Vivado 命令工具，不控制流程
+- **后端AI控制流程**：所有执行顺序、依赖检查由后端AI决策
+- **工具职责单一**：每个工具只负责执行一个具体命令
+- **结果透明返回**：执行结果完整返回给后端，由后端决定下一步

-### 2.2 非功能目标
+### 2.2 设计原则

- 配置简单，用户友好
- 执行过程可视化（进度、日志）
- 错误处理完善，提示清晰
+- 前端不做流程判断，只执行命令
+- 前端不检查依赖关系，由后端保证顺序
+- 前端返回详细的执行结果，包括成功/失败、输出、报告等
+- 后端AI根据结果智能决策是否继续

 ## 3. 功能详细需求

-### 3.1 Vivado 支持的操作
+### 3.1 前端提供的工具

-#### 3.1.1 综合（Synthesis）
+前端提供 4 个独立的工具，每个工具只负责执行一个命令：

- **输入**：Verilog/VHDL 源文件、约束文件（.xdc）
- **输出**：设计检查点（.dcp）、综合报告（.rpt）
- **用途**：将 RTL 代码转换为门级网表，检查资源使用情况
+#### 3.1.1 createVivadoProject - 创建工程

-#### 3.1.2 实现（Implementation）
+- **输入**：项目名称、芯片型号、源文件列表、约束文件（可选）
+- **输出**：工程文件（.xpr）
+- **说明**：创建 Vivado 工程，不执行任何构建操作

- **输入**：综合后的 .dcp 文件
- **输出**：实现后的 .dcp 文件、时序报告、布局布线报告
- **用途**：完成布局布线，检查时序是否满足要求
+#### 3.1.2 runVivadoSynthesis - 综合

-#### 3.1.3 生成比特流（Generate Bitstream）
+- **输入**：工程路径或源文件、芯片型号、顶层模块
+- **输出**：.dcp 文件、综合报告
+- **说明**：执行综合，前端不检查工程是否存在

- **输入**：实现后的 .dcp 文件
- **输出**：比特流文件（.bit）
- **用途**：生成可烧录到 FPGA 的配置文件
+#### 3.1.3 runVivadoImplementation - 实现
+
+- **输入**：综合后的 .dcp 文件路径
+- **输出**：实现后的 .dcp 文件、时序报告
+- **说明**：执行实现，前端不检查 .dcp 是否存在
+
+#### 3.1.4 runVivadoBitstream - 生成比特流
+
+- **输入**：实现后的 .dcp 文件路径
+- **输出**：.bit 文件
+- **说明**：生成比特流，前端不检查 .dcp 是否存在

 ### 3.2 配置管理

@ -102,90 +111,110 @@ IC Coder Plugin 目前支持：

 ### 3.3 工具调用接口

-#### 3.3.1 接口定义
+#### 3.3.1 通用响应格式
+
+所有工具返回统一的响应格式：

 ```typescript
-interface VivadoToolRequest {
-  command: string; // 命令类型：synthesis | implementation | bitstream
-  parameters?: {
-    topModule?: string; // 顶层模块名
-    files?: string[]; // 输入文件列表
-    part?: string; // FPGA 型号（可选，使用配置中的默认值）
-    constraints?: string; // 约束文件路径（.xdc）
-    outputDir?: string; // 输出目录
-  };
-  importOutput?: {
-    enabled: boolean; // 是否自动导入
-    targetDir: string; // 目标目录
-  };
-}
-
 interface VivadoToolResponse {
-  success: boolean;
-  command: string;
-  executionTime: number; // 执行时间（毫秒）
-  output: string; // 标准输出
-  error?: string; // 错误信息
-  importedFiles?: string[]; // 已导入的文件列表
+  success: boolean;           // 是否成功
+  command: string;            // 执行的命令
+  executionTime: number;      // 执行时间（毫秒）
+  output: string;             // 完整输出日志
+  error?: string;             // 错误信息（如果失败）
+  outputFiles?: string[];     // 产出文件路径列表
  reports?: {
-    // 报告摘要
-    resources?: string; // 资源使用情况
-    timing?: string; // 时序信息
+    resources?: string;       // 资源使用摘要
+    timing?: string;          // 时序信息摘要
  };
 }
 ```

-### 3.4 执行流程
+#### 3.3.2 各工具的参数定义

-#### 3.4.1 参数验证
-
- 检查 Vivado 是否已配置
- 检查可执行文件是否存在
- 检查输入文件是否存在
- 检查工作目录是否存在
-
-#### 3.4.2 TCL 脚本生成
-
-根据命令类型自动生成 TCL 脚本：
-
-**综合脚本示例（synth.tcl）**：
-
-```tcl
-# 读取源文件
-read_verilog counter.v
-read_xdc constraints.xdc
-
-# 设置顶层模块
-set_property top counter [current_fileset]
-
-# 综合
-synth_design -part xc7a35tcpg236-1 -top counter
-
-# 生成报告
-report_utilization -file utilization_synth.rpt
-report_timing -file timing_synth.rpt
-
-# 保存检查点
-write_checkpoint -force counter_synth.dcp
+**createVivadoProject**
+```typescript
+{
+  projectName: string;        // 项目名称
+  part: string;               // 芯片型号
+  topModule: string;          // 顶层模块
+  files: string[];            // 源文件列表
+  constraints?: string;       // 约束文件（可选）
+  mode: 'gui' | 'batch';      // 执行模式
+}
 ```

-#### 3.4.3 命令执行
+**runVivadoSynthesis**
+```typescript
+{
+  projectPath?: string;       // 工程路径（可选，如果有工程）
+  part: string;               // 芯片型号
+  topModule: string;          // 顶层模块
+  files?: string[];           // 源文件（如果没有工程）
+  constraints?: string;       // 约束文件（可选）
+  mode: 'gui' | 'batch';      // 执行模式
+}
+```

- 启动子进程执行 Vivado 命令
- 实时捕获标准输出和错误输出
- 向前端推送进度信息（解析日志中的进度标记）
+**runVivadoImplementation**
+```typescript
+{
+  dcpFile: string;            // 综合后的 .dcp 文件路径
+  mode: 'gui' | 'batch';      // 执行模式
+}
+```

-#### 3.4.4 结果处理
+**runVivadoBitstream**
+```typescript
+{
+  dcpFile: string;            // 实现后的 .dcp 文件路径
+  mode: 'gui' | 'batch';      // 执行模式
+}
+```

- 检查执行结果（退出码）
- 解析报告文件，提取关键信息（资源使用、时序）
- 查找产出文件
+### 3.4 后端AI的职责

-#### 3.4.5 文件导入
+后端AI负责：
+1. 询问用户必要参数（芯片型号、执行模式等）
+2. 理解用户意图，决定调用哪些工具
+3. 按正确顺序调用工具（遵循依赖关系）
+4. 检查每步执行结果，决定是否继续
+5. 汇总结果并展示给用户

- 根据配置的文件模式查找产出文件
- 复制文件到目标目录
- 通知用户导入结果
+#### 3.4.1 询问用户参数
+
+后端必须询问：
+- **芯片型号**（必需）："请提供 FPGA 芯片型号（例如：xc7a35tcpg236-1）"
+- **执行模式**（必需）："选择执行模式：1) 图形化 2) 后端执行"
+- **约束文件**（可选）："是否有约束文件（.xdc）？"
+
+#### 3.4.2 理解依赖关系
+
+后端AI需要理解：
+```
+创建工程 → 综合 → 实现 → 生成比特流
+```
+
+如果用户说"做实现"，后端应该：
+1. 先调用 `createVivadoProject` 创建工程
+2. 再调用 `runVivadoSynthesis` 执行综合
+3. 最后调用 `runVivadoImplementation` 执行实现
+
+#### 3.4.3 逐步调用工具
+
+```
+步骤1: 调用 createVivadoProject
+       检查 response.success
+       如果失败 → 停止并报错
+
+步骤2: 调用 runVivadoSynthesis
+       检查 response.success
+       如果失败 → 停止并报错
+
+步骤3: 调用 runVivadoImplementation
+       检查 response.success
+       返回最终结果
+```

 ### 3.5 UI 交互

@ -212,90 +241,186 @@ write_checkpoint -force counter_synth.dcp

 #### 3.6.1 工具定义

-后端在工具列表中添加 Vivado 工具：
+后端注册 4 个独立工具：

 ```json
 {
-  "name": "runVivado",
-  "description": "调用 Vivado 执行综合、实现或生成比特流。使用前必须先询问用户芯片型号等必要参数。",
+  "name": "createVivadoProject",
+  "description": "创建 Vivado 工程。需要先询问用户芯片型号和执行模式。",
  "parameters": {
-    "command": "命令类型（synthesis/implementation/bitstream）",
+    "projectName": "项目名称",
+    "part": "芯片型号（必须从用户获取）",
    "topModule": "顶层模块名",
-    "files": "输入文件列表",
-    "part": "FPGA 芯片型号（必须从用户获取）",
-    "constraints": "约束文件路径（可选）"
+    "files": "源文件列表",
+    "constraints": "约束文件（可选）",
+    "mode": "执行模式（gui/batch）"
+  }
+},
+{
+  "name": "runVivadoSynthesis",
+  "description": "执行 Vivado 综合。前端不检查依赖，后端需确保工程已创建。",
+  "parameters": {
+    "projectPath": "工程路径（可选）",
+    "part": "芯片型号",
+    "topModule": "顶层模块",
+    "files": "源文件（如果没有工程）",
+    "constraints": "约束文件（可选）",
+    "mode": "执行模式（gui/batch）"
+  }
+},
+{
+  "name": "runVivadoImplementation",
+  "description": "执行 Vivado 实现。前端不检查依赖，后端需确保综合已完成。",
+  "parameters": {
+    "dcpFile": "综合后的 .dcp 文件路径",
+    "mode": "执行模式（gui/batch）"
+  }
+},
+{
+  "name": "runVivadoBitstream",
+  "description": "生成比特流。前端不检查依赖，后端需确保实现已完成。",
+  "parameters": {
+    "dcpFile": "实现后的 .dcp 文件路径",
+    "mode": "执行模式（gui/batch）"
  }
 }
 ```

-#### 3.6.2 后端交互流程
+#### 3.6.2 后端调用示例

-**关键点**：后端必须先收集必要参数，再调用工具
-
-1. **用户发起请求**："打开 Vivado" 或 "用 Vivado 综合"
-2. **后端识别意图**：需要调用 runVivado 工具
-3. **后端询问参数**：
-   - FPGA 芯片型号（必须）
-   - 约束文件（可选）
-   - 确认顶层模块名
-4. **用户提供参数**
-5. **后端调用工具**：传递完整参数给前端
-6. **前端执行**：VivadoRunner 执行命令
-7. **返回结果**：后端接收结果并展示给用户
-
-#### 3.6.3 调用示例（完整交互）
+**场景：用户要求完整流程**

 ```
-用户：帮我用 Vivado 综合一下 counter.v
+用户: 用 Vivado 跑完整流程

-AI：好的，我将使用 Vivado 进行综合。请提供以下信息：
-    1. FPGA 芯片型号（例如：xc7a35tcpg236-1）
-    2. 是否有约束文件（.xdc）？
+AI: 请提供芯片型号和执行模式
+用户: xc7a35tcpg236-1，后端执行

-用户：xc7a35tcpg236-1，没有约束文件
+AI 执行:
+1. [调用] createVivadoProject({ projectName: "counter", part: "xc7a35tcpg236-1", ... })
+   [结果] { success: true, outputFiles: ["counter.xpr"] }

-AI：收到，开始综合...
-    [调用工具] runVivado
-    参数：
-    - command: synthesis
-    - topModule: counter
-    - files: ["counter.v"]
-    - part: "xc7a35tcpg236-1"
+2. [调用] runVivadoSynthesis({ projectPath: "counter.xpr", ... })
+   [结果] { success: true, outputFiles: ["counter_synth.dcp"], reports: {...} }

-    [执行中...]
-    Vivado 综合完成！
-    - 芯片型号：xc7a35tcpg236-1
-    - 执行时间：45 秒
-    - 资源使用：LUT: 32/20800 (0.15%), FF: 8/41600 (0.02%)
-    - 产出文件：counter_synth.dcp, utilization_synth.rpt
-    - 已自动导入到：vivado_output/
+3. [调用] runVivadoImplementation({ dcpFile: "counter_synth.dcp", ... })
+   [结果] { success: true, outputFiles: ["counter_impl.dcp"], reports: {...} }
+
+4. [调用] runVivadoBitstream({ dcpFile: "counter_impl.dcp", ... })
+   [结果] { success: true, outputFiles: ["counter.bit"] }
+
+AI 回复: 完成！已生成 counter.bit 文件
 ```

 ## 4. 用户场景

-### 4.1 场景一：单步综合
+### 4.1 场景一：完整流程执行

-1. 用户编写完 Verilog 代码
-2. 在聊天中输入："用 Vivado 综合一下 counter.v"
-3. AI 调用 `runVivado` 工具
-4. 插件执行 Vivado 综合
-5. 综合完成后，显示资源使用情况，自动导入报告文件
+**用户输入**："用 Vivado 跑完整个 FPGA 流程"

-### 4.2 场景二：完整流程
+**AI 交互**：
+```
+AI: 好的，我将使用 Vivado 执行完整的 FPGA 开发流程。请提供以下信息：

-1. 用户输入："用 Vivado 跑完整个流程"
-2. AI 依次调用：
+1. FPGA 芯片型号（例如：xc7a35tcpg236-1）
+2. 请选择要执行的步骤（可多选）：
   - 综合（Synthesis）
   - 实现（Implementation）
   - 生成比特流（Bitstream）
-3. 每个步骤完成后显示结果
-4. 最终生成 .bit 文件，用户可以烧录到 FPGA
+3. 执行模式：
+   - 图形化模式：打开 Vivado GUI
+   - 后端执行：自动在后台执行
+4. 是否有约束文件（.xdc）？

-### 4.3 场景三：查看报告
+用户: xc7a35tcpg236-1，全部步骤，后端执行，没有约束文件

-1. Vivado 执行完成后
-2. 用户点击导入的报告文件
-3. 在编辑器中查看资源使用、时序分析等信息
+AI: 收到！执行计划：
+1. 创建工程
+2. 综合
+3. 实现
+4. 生成比特流
+
+开始执行...
+
+[步骤 1/4] 创建工程...
+✓ 工程创建成功（耗时 2s）
+
+[步骤 2/4] 综合中...
+✓ 综合完成（耗时 45s）
+  资源使用：LUT 32/20800 (0.15%), FF 8/41600 (0.02%)
+
+[步骤 3/4] 实现中...
+✓ 实现完成（耗时 120s）
+  时序：WNS 5.234ns, TNS 0.000ns（满足要求）
+
+[步骤 4/4] 生成比特流...
+✓ 比特流生成完成（耗时 15s）
+
+所有步骤执行完毕！产出文件已导入到 vivado_output/ 目录。
+```
+
+### 4.2 场景二：只执行实现（自动补充依赖）
+
+**用户输入**："用 Vivado 做实现"
+
+**AI 交互**：
+```
+AI: 请提供以下信息：
+1. FPGA 芯片型号
+2. 执行模式（图形化/后端执行）
+
+用户: xc7a35tcpg236-1，后端执行
+
+AI: 注意：实现依赖综合，我将自动执行以下步骤：
+1. 创建工程
+2. 综合（前置依赖）
+3. 实现（您选择的步骤）
+
+是否继续？
+
+用户: 是
+
+AI: 开始执行...
+[自动执行创建工程 → 综合 → 实现]
+```
+
+### 4.3 场景三：图形化模式
+
+**用户输入**："打开 Vivado 图形界面做综合"
+
+**AI 交互**：
+```
+AI: 请提供芯片型号：
+用户: xc7a35tcpg236-1
+
+AI: 正在创建工程并打开 Vivado GUI...
+✓ 工程已创建
+✓ Vivado 图形界面已启动
+
+您现在可以在 Vivado 中手动操作。完成后，产出文件将保存在工程目录中。
+```
+
+### 4.4 场景四：执行中断处理
+
+**执行过程**：
+```
+[步骤 1/3] 创建工程...
+✓ 成功
+
+[步骤 2/3] 综合中...
+✗ 综合失败
+错误：ERROR: [Synth 8-439] module 'counter' not found
+
+AI: 综合失败，发现以下问题：
+- 找不到模块 'counter'
+
+建议检查：
+1. 模块名是否正确
+2. 文件中是否定义了该模块
+3. 是否有语法错误
+
+执行已停止，请修复错误后重试。
+```

 ## 5. 技术约束