FPGA版本管理（三）如何用GIT管理Vivado工程

GIT管理Vivado工程的流程及步骤：

1.创建VIVADO工程

1.1工程目录结构确定

按以下工程目录结构创建工程。

xxx_project
    -prj
    -src
    -xdc
    -ipcore
        -coe
        -ipcore
        -ipcore
    -tcl

---

Tips:
目录结构的确定，主要有两个目的：

• 明确哪些文件夹下的文件需要版本管理；
• 解决使用tcl脚本时，工程配置中相对路径的问题；

---

1.2创建工程

cd到prj目录下，打开VIVADO，并新建工程。

2.IP Core管理

按照Xilinx推荐的方式^[1]：在Manage IP中生成IP Core。如果IP Core在综合时使用Global模式，则只需要生成.xci和.xml文件即可。
如果IP Core在综合时使用OOC模式，则所有生成的文件都需要在版本管理中。

IP Core使用的coe、mif文件等，放在ipcore/coe目录下。

---

Tips:

• Global模式：版本管理中，只需要.xml和.xci文件，就可以完全重新生成IP Core；
• OOC模式：所有生成文件均需在版本管理中，如.dcp文件；虽然只.xml和.xci文件就可以完全重新生成IP Core，但为了节省综合的时间，将IP Core中的所有文件放在版本管理中，就无需再次综合；

---

3.生成tcl脚本

cd到prj/路径下，在vivado的tcl中输入：

write_project_tcl -force prj_gen.tcl

这样所有的工程配置都导出到了prj_gen.tcl这个tcl脚本中，后续通过这个tcl脚本，就可以完成重构工程。
将该prj_gen.tcl文件拷贝至tcl文件夹中。

---

Tips:
这里，我们将prj/这个路径作为当前工程路径，后续我们所有的文件都是相对于这个位置进行索引的。
所以，在使用write_project_tcl时，必须处于当前工程路径下。

---

4.GIT提交

在GIT中需要管理的文件如下，prj下面的所有工程文件都不需要，因为我们可以通过prj_gen.tcl完全重构工程。

xxx_project
    -prj
    -src
    -xdc
    -ipcore
        -coe
        -ipcore
        -ipcore
    -tcl

---

Tips:
我们只需要管理，源代码和工程配置文件（prj_gen.tcl）。

---

5.重构版本

运行以下命令，即可在prj下重新生成工程。

cd xxx_project/prj/
vivao -mode batch -source ../tcl/prj_gen.tcl

---

Tips:
tcl脚本管理，为后续实现Gitlab CI下自动编译版本做准备。

---

1.Xilinx,XAPP1165-Using Vivado Design Suite with Version Control Systems,August 5,2013
2.Xilinx,UG1198-Revision Control System(v2016.3),October 28,2016