Xilinx Vivado | DocNav 工具简介、SDK 工程编译及开发工具重装注本文为“Xilinx Vivado”相关合辑。略作重排如有内容异常请看原文。本文档保留操作说明供历史项目参考。1. DocNav 工具使用简介Vivado 安装完成后桌面上会出现两个快捷方式Vivado 软件和 DocNav 文档导航工具。Vivado 是主要开发工具DocNav 是文档导航工具两者配合使用。打开 DocNav 后看到如下界面DocNav 主要包含两个视图界面左侧为目录视图右侧为设计中心视图。左侧还提供过滤器功能可通过设置过滤器隐藏不需要的文档。点击 “Update Catalog” 按钮可自动更新文档库右侧显示更新后的库文件列表。进行 ZC706 开发时在左侧选择 “ZC706 EVALUATION Kit”页面栏将显示该设备的所有文档。点击 “Zynq-7000 All Programmable SoC ZC706 Evaluation Kit - Product Page” 可进入资源页面查看各类文档和软硬件介绍。此外在 DocNav 中选择视频选项可查看所有可用的视频教程。点击任意视频即可播放。2. DocNav 文件导航文档命名规范Xilinx 开发软件附带安装的文件导航工具 DocNav 可用于查阅 Xilinx 技术文档。DocNav 中的文档数量众多且持续更新所有文档均以字母缩写 数字的方式命名相同字母缩写的文档属于同一类型。以下列出各类文档缩写的含义。2.1 AR (Answer Record, 回答记录)在 DocNav 中主要提供一个链接点击后跳转至 Xilinx 官网 Support 页面内容为相关技术问题的解答。2.2 CS (Chip Scale, 芯片规模)提供芯片的封装尺寸信息。目前仅有一篇 CS484属于 PK 系列文档的一部分。2.3 DH (Design Hub, 设计中心)设计中心于 2013.3 版本中引入用于查找涉及特定功能领域的文档及其他学习资料。2.4 DS (Data Sheet, 数据手册)在使用未知芯片时常用主要介绍 Xilinx IP 核及接口的概要信息亦可称为 Product Specification产品规格书。2.5 EN (Errata Notification, 勘误通知)对 Xilinx 此前发布的文档或相关资料中存在的错误进行修订与说明。2.6 RPT (Report, 报告)包括器件的 Characterization Report特性报告和 Qualification Report资质报告多涉及 Virtex-6、Virtex-5、Kintex-7、Spartan-6 系列高速接口相关内容。2.7 PB (Product Brief, 产品简介)主要对 Xilinx 相关 IP、接口进行简要介绍。2.8 PCN (Product/Process Change Notice, 产品/流程变更通知)主要涉及 Xilinx 硬件方面以及相关开发测试流程的变更。2.9 PG (Product Guide, 产品指南)主要对 Xilinx 相关 IP、接口进行介绍。2.10 PK (Package, 封装)提供焊接材料和器件的数据表以及芯片封装尺寸相关内容。2.11 SP (Specification, 规格)目前 DocNav 中仅有一篇 SP 开头文档即 SP002《Aurora 8B/10B Protocol Specification》主要介绍 Aurora 8B/10B 协议规范。2.12 UG (User Guide, 用户指南)Xilinx 技术文档中数量最多的一类内容涵盖 Xilinx 各方面内容描述详细。2.13 WP (White Paper, 白皮书)Xilinx 正式发表的以白色封面装帧的重要文件或报告属于官方规范性技术文件代表 Xilinx 立场。2.14 XAPP (Xilinx Application, Xilinx 应用示例)展示 Xilinx 所提供的 IP 核、开发工具等的示例用户可在此基础上进行修改提供工程参考。2.15 XCN (Xilinx Discontinuation Notice, Xilinx 停产通知)主要涉及器件、开发工具、IP 核、评估板及相关零件等 Xilinx 产品的停产通知亦包含部分产品变更通知。2.16 XMP (Xilinx Manual Product, Xilinx 产品手册)提供产品介绍以表格形式展示各系列器件的对比数据用于器件选型参考。2.17 XTP (Xilinx Tools Product, Xilinx 工具产品)主要介绍 Xilinx 开发的一些评估板和产品开发套件同时包含部分检查表。说明UG、XAPP、PG 三类文档常用可覆盖开发过程中的常见问题。许多文档末尾会列出所参考的文献资料可进一步查阅获取更多信息。3. Xilinx SDK 工程编译、链接与调试注意事项说明Xilinx SDK 已被 Vitis 开发环境取代自 2018 版本起。对于 Zynq/Ultrascale 平台建议使用 Vitis IDE 进行软件开发。3.1 添加工程启动 SDK 时选取 workspace如下图所示对应的 workspace 文件夹中会生成以下文件如果当前 workspace 是首次加载工程SDK 会进入启动界面。点击 Import Project 导入已有工程。点击 Browse 添加工程路径。一个完整的工程包含一个 bsp 文件夹、一个 HW 文件夹和一个 src 文件夹添加 C 功能函数。点击 Finish。3.2 编译与链接等待工程导入完成后在 SDK 操作界面按 CtrlB或 Project → Build All对已有工程进行编译。编译时注意以下设置正确点击 Project → Property。编译配置ARM gcc compile → Inferred Options → Software Platform设置编译时工程包含文件的路径。当前路径为 debug 下的 Makefile 文件路径每一个…/表示相对当前路径的上一级路径。为便于工程移植和拷贝建议设置相对路径。链接配置ARM gcc linker → Inferred Options → Software Platform 下为链接库的路径同上最好使用相对路径。如果功能代码不在 SDK 工程目录下可通过添加虚拟文件或者链接路径的方式在 SDK 工程中调用对应代码文件。右键 Project → New → Folder。点击 Advance选择Folder is not located in the file system (Virtual Folder)则在 project 目录下创建虚拟文件夹选择Link to alternate location (Linked Folder)则将对应代码文件链接到当前工程目录下。3.3 调试完成编译后点击 Run → Debug Configurations 配置调试参数。点击 Apply 然后 Debug 可执行调试操作。其中如果勾选Program FPGA则每次 debug 时都会烧写一次 bit 流文件。一般不建议勾选bit 流文件在 debug 前烧写一次即可。3.4 打印配置Xilinx SDK 自带多种打印函数xil_printf、printf 等所有打印函数实际调用 outbyte 函数xil_printf.c来打印信息outbyte 函数调用 PS 侧的 UART Send Byte 函数。如果 PS 侧有两个 UARToutbyte 如何选择输出通道该设置在 bsp 中配置双击 bsp 下面的 mss 文件选择Modify This BSP Settings然后设置 stdout 和 stdin。设置为psu_uart_0则通过 UART0 打印设置为psu_uart_1则通过 UART1 打印。另外如果 PL 侧有 UART IP如 uart16550也可选择 uart16550 进行打印。设置不同 UART 时bsp 中xparameters.h对STDOUT_BASEADDRESS的定义不同UART0 定义为 0xFF000000UART1 定义为 0xFF010000。这两个地址可在 UG1087 (Ultrascale Register Definition) 中查阅。另外使用不同打印函数时编译出来的可执行文件大小可能差异较大。printf 函数是标准 C 库中的重要函数支持浮点打印等但 FPGA 应用中通常不需要浮点打印仅需xil_printf执行打印即可。因此 printf 和xil_printf编译后的可执行文件 size 差异较大在资源受限的场景下建议使用xil_printf以减小代码体积。4. 开发工具重装如需重新安装或下载 Xilinx Vivado 设计工具DocNav、SDK、Vivado Design Suite 等可按以下步骤操作。本文以 DocNav 为例进行说明。打开 Vivado 软件在菜单栏中选择Help然后在下拉菜单中选择Add Design Tools or Devices点击后需等待一段时间。等待后出现工具选择界面勾选需要安装的 Vivado 设计工具如 DocNav然后点击Next连续操作等待安装完成。完成上述步骤即完成 Xilinx Vivado 工具的重新安装。注意事项如果在勾选过程中发现复选框呈灰色且已勾选状态无法再次操作说明软件检测到该工具已安装在系统中。即使之前已卸载残留文件仍可能被 Vivado 检测到导致无法重新安装。解决方法如下打开 Windows “控制面板”选择 “程序和功能”。在右上角搜索已卸载的 Vivado 工具如 DocNav搜索后点击卸载确保彻底清除残留文件。删除干净后重复上述步骤重新安装即可。通过此方法还可安装 Vivado 的其他设计工具及最初未安装的设备支持包。ReferenceXilinx 的 DocNav 文件导航中的文档开头字母缩写都是什么意思_vivado pg ug 的区别-CSDN 博客https://blog.csdn.net/qq_18239447/article/details/104879977想重新下载安装 xilinx 的 vivado 设计工具 DocNav、SDK、Vivado Design Suite 等。_vivado 卸载重新安装-CSDN 博客https://blog.csdn.net/qq_56016739/article/details/130757832Xilinx SDK 工程编译、链接、调试注意事项_xilinx sdk 导入已有工程-CSDN 博客https://blog.csdn.net/autumn_he/article/details/100119972【SDK 使用】sdk print 方式_xilinx sdk zcu102 打印-CSDN 博客https://blog.csdn.net/carlsun80/article/details/78045776 Xilinx Vivado | DocNav 工具简介、SDK 工程编译及开发工具重装
Xilinx Vivado | DocNav 工具简介、SDK 工程编译及开发工具重装注本文为“Xilinx Vivado”相关合辑。略作重排如有内容异常请看原文。本文档保留操作说明供历史项目参考。1. DocNav 工具使用简介Vivado 安装完成后桌面上会出现两个快捷方式Vivado 软件和 DocNav 文档导航工具。Vivado 是主要开发工具DocNav 是文档导航工具两者配合使用。打开 DocNav 后看到如下界面DocNav 主要包含两个视图界面左侧为目录视图右侧为设计中心视图。左侧还提供过滤器功能可通过设置过滤器隐藏不需要的文档。点击 “Update Catalog” 按钮可自动更新文档库右侧显示更新后的库文件列表。进行 ZC706 开发时在左侧选择 “ZC706 EVALUATION Kit”页面栏将显示该设备的所有文档。点击 “Zynq-7000 All Programmable SoC ZC706 Evaluation Kit - Product Page” 可进入资源页面查看各类文档和软硬件介绍。此外在 DocNav 中选择视频选项可查看所有可用的视频教程。点击任意视频即可播放。2. DocNav 文件导航文档命名规范Xilinx 开发软件附带安装的文件导航工具 DocNav 可用于查阅 Xilinx 技术文档。DocNav 中的文档数量众多且持续更新所有文档均以字母缩写 数字的方式命名相同字母缩写的文档属于同一类型。以下列出各类文档缩写的含义。2.1 AR (Answer Record, 回答记录)在 DocNav 中主要提供一个链接点击后跳转至 Xilinx 官网 Support 页面内容为相关技术问题的解答。2.2 CS (Chip Scale, 芯片规模)提供芯片的封装尺寸信息。目前仅有一篇 CS484属于 PK 系列文档的一部分。2.3 DH (Design Hub, 设计中心)设计中心于 2013.3 版本中引入用于查找涉及特定功能领域的文档及其他学习资料。2.4 DS (Data Sheet, 数据手册)在使用未知芯片时常用主要介绍 Xilinx IP 核及接口的概要信息亦可称为 Product Specification产品规格书。2.5 EN (Errata Notification, 勘误通知)对 Xilinx 此前发布的文档或相关资料中存在的错误进行修订与说明。2.6 RPT (Report, 报告)包括器件的 Characterization Report特性报告和 Qualification Report资质报告多涉及 Virtex-6、Virtex-5、Kintex-7、Spartan-6 系列高速接口相关内容。2.7 PB (Product Brief, 产品简介)主要对 Xilinx 相关 IP、接口进行简要介绍。2.8 PCN (Product/Process Change Notice, 产品/流程变更通知)主要涉及 Xilinx 硬件方面以及相关开发测试流程的变更。2.9 PG (Product Guide, 产品指南)主要对 Xilinx 相关 IP、接口进行介绍。2.10 PK (Package, 封装)提供焊接材料和器件的数据表以及芯片封装尺寸相关内容。2.11 SP (Specification, 规格)目前 DocNav 中仅有一篇 SP 开头文档即 SP002《Aurora 8B/10B Protocol Specification》主要介绍 Aurora 8B/10B 协议规范。2.12 UG (User Guide, 用户指南)Xilinx 技术文档中数量最多的一类内容涵盖 Xilinx 各方面内容描述详细。2.13 WP (White Paper, 白皮书)Xilinx 正式发表的以白色封面装帧的重要文件或报告属于官方规范性技术文件代表 Xilinx 立场。2.14 XAPP (Xilinx Application, Xilinx 应用示例)展示 Xilinx 所提供的 IP 核、开发工具等的示例用户可在此基础上进行修改提供工程参考。2.15 XCN (Xilinx Discontinuation Notice, Xilinx 停产通知)主要涉及器件、开发工具、IP 核、评估板及相关零件等 Xilinx 产品的停产通知亦包含部分产品变更通知。2.16 XMP (Xilinx Manual Product, Xilinx 产品手册)提供产品介绍以表格形式展示各系列器件的对比数据用于器件选型参考。2.17 XTP (Xilinx Tools Product, Xilinx 工具产品)主要介绍 Xilinx 开发的一些评估板和产品开发套件同时包含部分检查表。说明UG、XAPP、PG 三类文档常用可覆盖开发过程中的常见问题。许多文档末尾会列出所参考的文献资料可进一步查阅获取更多信息。3. Xilinx SDK 工程编译、链接与调试注意事项说明Xilinx SDK 已被 Vitis 开发环境取代自 2018 版本起。对于 Zynq/Ultrascale 平台建议使用 Vitis IDE 进行软件开发。3.1 添加工程启动 SDK 时选取 workspace如下图所示对应的 workspace 文件夹中会生成以下文件如果当前 workspace 是首次加载工程SDK 会进入启动界面。点击 Import Project 导入已有工程。点击 Browse 添加工程路径。一个完整的工程包含一个 bsp 文件夹、一个 HW 文件夹和一个 src 文件夹添加 C 功能函数。点击 Finish。3.2 编译与链接等待工程导入完成后在 SDK 操作界面按 CtrlB或 Project → Build All对已有工程进行编译。编译时注意以下设置正确点击 Project → Property。编译配置ARM gcc compile → Inferred Options → Software Platform设置编译时工程包含文件的路径。当前路径为 debug 下的 Makefile 文件路径每一个…/表示相对当前路径的上一级路径。为便于工程移植和拷贝建议设置相对路径。链接配置ARM gcc linker → Inferred Options → Software Platform 下为链接库的路径同上最好使用相对路径。如果功能代码不在 SDK 工程目录下可通过添加虚拟文件或者链接路径的方式在 SDK 工程中调用对应代码文件。右键 Project → New → Folder。点击 Advance选择Folder is not located in the file system (Virtual Folder)则在 project 目录下创建虚拟文件夹选择Link to alternate location (Linked Folder)则将对应代码文件链接到当前工程目录下。3.3 调试完成编译后点击 Run → Debug Configurations 配置调试参数。点击 Apply 然后 Debug 可执行调试操作。其中如果勾选Program FPGA则每次 debug 时都会烧写一次 bit 流文件。一般不建议勾选bit 流文件在 debug 前烧写一次即可。3.4 打印配置Xilinx SDK 自带多种打印函数xil_printf、printf 等所有打印函数实际调用 outbyte 函数xil_printf.c来打印信息outbyte 函数调用 PS 侧的 UART Send Byte 函数。如果 PS 侧有两个 UARToutbyte 如何选择输出通道该设置在 bsp 中配置双击 bsp 下面的 mss 文件选择Modify This BSP Settings然后设置 stdout 和 stdin。设置为psu_uart_0则通过 UART0 打印设置为psu_uart_1则通过 UART1 打印。另外如果 PL 侧有 UART IP如 uart16550也可选择 uart16550 进行打印。设置不同 UART 时bsp 中xparameters.h对STDOUT_BASEADDRESS的定义不同UART0 定义为 0xFF000000UART1 定义为 0xFF010000。这两个地址可在 UG1087 (Ultrascale Register Definition) 中查阅。另外使用不同打印函数时编译出来的可执行文件大小可能差异较大。printf 函数是标准 C 库中的重要函数支持浮点打印等但 FPGA 应用中通常不需要浮点打印仅需xil_printf执行打印即可。因此 printf 和xil_printf编译后的可执行文件 size 差异较大在资源受限的场景下建议使用xil_printf以减小代码体积。4. 开发工具重装如需重新安装或下载 Xilinx Vivado 设计工具DocNav、SDK、Vivado Design Suite 等可按以下步骤操作。本文以 DocNav 为例进行说明。打开 Vivado 软件在菜单栏中选择Help然后在下拉菜单中选择Add Design Tools or Devices点击后需等待一段时间。等待后出现工具选择界面勾选需要安装的 Vivado 设计工具如 DocNav然后点击Next连续操作等待安装完成。完成上述步骤即完成 Xilinx Vivado 工具的重新安装。注意事项如果在勾选过程中发现复选框呈灰色且已勾选状态无法再次操作说明软件检测到该工具已安装在系统中。即使之前已卸载残留文件仍可能被 Vivado 检测到导致无法重新安装。解决方法如下打开 Windows “控制面板”选择 “程序和功能”。在右上角搜索已卸载的 Vivado 工具如 DocNav搜索后点击卸载确保彻底清除残留文件。删除干净后重复上述步骤重新安装即可。通过此方法还可安装 Vivado 的其他设计工具及最初未安装的设备支持包。ReferenceXilinx 的 DocNav 文件导航中的文档开头字母缩写都是什么意思_vivado pg ug 的区别-CSDN 博客https://blog.csdn.net/qq_18239447/article/details/104879977想重新下载安装 xilinx 的 vivado 设计工具 DocNav、SDK、Vivado Design Suite 等。_vivado 卸载重新安装-CSDN 博客https://blog.csdn.net/qq_56016739/article/details/130757832Xilinx SDK 工程编译、链接、调试注意事项_xilinx sdk 导入已有工程-CSDN 博客https://blog.csdn.net/autumn_he/article/details/100119972【SDK 使用】sdk print 方式_xilinx sdk zcu102 打印-CSDN 博客https://blog.csdn.net/carlsun80/article/details/78045776