🏠

Vitis-Tutorials 快速上手指南（15分钟）

本教程将帮助新接触 Vitis-Tutorials 项目的开发者在15分钟内完成环境准备、仓库克隆，并运行一个完整的 Vitis HLS 示例。

1. 前置条件

在开始之前，请确保满足以下要求：

类别 要求
操作系统 支持的 Linux 发行版（Ubuntu 20.04/22.04, RHEL 8.x）
工具链 AMD Vitis 2024.2 核心开发套件
硬件 (可选) 兼容的 Alveo 加速卡或嵌入式平台（用于硬件运行）
环境 BASH shell, Git, Make
网络 可访问 GitHub

2. 安装与环境配置

请按照以下步骤操作，每步都包含命令、预期输出和常见错误修复。

2.1 克隆仓库

git clone https://github.com/Xilinx/Vitis-Tutorials.git
cd Vitis-Tutorials

预期输出：

Cloning into 'Vitis-Tutorials'...
remote: Enumerating objects: ...
Receiving objects: 100% ...
Resolving deltas: 100% ...

常见错误与修复：

  • 错误：git: command not found
    • 修复：安装 Git (sudo apt install git 或 sudo yum install git)
  • 错误：fatal: unable to access 'https://github.com/...'
    • 修复：检查网络连接或配置 Git 代理

2.2 配置工具链环境

# 替换为你的 Vitis 安装路径
source <Vitis_install_path>/Vitis/2024.2/settings64.sh
source /opt/xilinx/xrt/setup.sh

# (可选) 设置平台仓库路径
export PLATFORM_REPO_PATHS=<path_to_platforms>

# (Ubuntu 特定) 可能需要设置库路径
export LIBRARY_PATH=/usr/lib/x86_64-linux-gnu

预期输出： 运行成功后无返回值（或极少量路径信息）。

验证命令：

vitis -version

预期验证输出：

Vitis Unified IDE
Version 2024.2

常见错误与修复：

  • 错误：bash: <Vitis_install_path>/...: No such file or directory
    • 修复：检查 Vitis 安装路径是否正确
  • 错误：vitis: command not found
    • 修复：确认 settings64.sh 脚本已成功执行

3. 首次运行：Vitis HLS 入门示例

我们将运行 Getting_Started/Vitis_HLS 目录下的示例，这是一个使用 Vitis Unified IDE 的自包含项目。

3.1 导航到示例目录

cd Getting_Started/Vitis_HLS/reference-files

3.2 (可选) 使用 Makefile 运行 CLI 流程

为了快速验证环境，你可以使用提供的 Makefile。

# 查看可用目标
make help

# 运行 C 仿真和综合（示例目标，请根据实际 Makefile 调整）
make all

3.3 使用 Vitis Unified IDE 打开项目

对于完整的可视化体验，请启动 IDE：

# 在 reference-files 目录下启动 IDE，指定工作区
vitis -w ./workspace

预期输出： Vitis Unified IDE 界面将打开。

在 IDE 中的操作（简要）：

  1. 导入 reference-files 中的现有组件。
  2. 运行 C Simulation。
  3. 运行 C Synthesis 并查看资源使用报告。
  4. 运行 C/RTL Co-Simulation。

4. 安装流程与首次运行图示

4.1 安装流程图

flowchart TD A[开始] --> B{检查前置条件} B -->|满足| C[克隆 Vitis-Tutorials 仓库] C --> D[配置 Vitis 2024.2 环境] D --> E[导航到 Getting_Started/Vitis_HLS] E --> F[运行示例] B -->|不满足| G[安装缺失的工具/库] G --> B style A fill:#e1f5e1,stroke:#2e7d32 style F fill:#fff3e0,stroke:#ef6c00

4.2 首次运行序列图

sequenceDiagram participant User participant CLI as 终端 (Shell) participant IDE as Vitis Unified IDE participant HLS as HLS 引擎 User->>CLI: git clone... CLI-->>User: 仓库克隆完成 User->>CLI: source settings64.sh User->>CLI: vitis -w workspace CLI->>IDE: 启动 IDE User->>IDE: 导入并运行 C Simulation IDE->>HLS: 执行仿真 HLS-->>IDE: 仿真通过 User->>IDE: 运行 Synthesis HLS-->>IDE: 生成 RTL 和资源报告 IDE-->>User: 流程完成

5. 关键配置项

以下是运行本入门教程时涉及的关键环境变量：

名称 是否必需 默认值 描述
XILINX_VITIS 是 由脚本设置 Vitis 安装根目录（通过 settings64.sh 自动设置）
XILINX_XRT 否 由脚本设置 Xilinx 运行时 (XRT) 根目录
PLATFORM_REPO_PATHS 否 空 平台文件搜索路径
LIBRARY_PATH 否 (Ubuntu) 系统默认 用于修复某些 Ubuntu 版本的链接问题

6. 常见错误与快速修复

错误现象 快速修复方案
Command 'vitis' not found 确保运行了 source <Vitis>/2024.2/settings64.sh
Git clone 连接超时 检查网络或配置 Git 代理 (git config --global http.proxy ...)
HLS 综合失败：找不到器件 确认 Vitis 安装时包含了所需的器件支持包
Ubuntu: 启动 IDE 时缺少库文件 执行 export LIBRARY_PATH=/usr/lib/x86_64-linux-gnu

7. 后续步骤

恭喜你完成了首次运行！请通过以下链接深入学习：

  1. 初学者完整指南：Getting Started Pathway
  2. Vitis HLS 深度解析：Vitis HLS Analysis and Optimization
  3. Vitis 库入门：Vitis Libraries Introduction
  4. 构建与代码组织：请查看仓库根目录下的 FAQs
  5. 模块文档索引：README 首页

注意：本教程基于 Vitis 2024.2 版本编写。如果你使用的是其他版本，请在克隆仓库后使用 git checkout <version> 切换到对应的分支（例如 git checkout 2023.2）。

On this page