Git進(jìn)行Vivado工程管理的教程分享

作者：貓叔

git有多好用我就不用多說了，可謂是程序員必備技能之一。對(duì)于一般的軟件代碼來說，只需把源文件進(jìn)行g(shù)it管理即可。但對(duì)于FPGA工程師來說，使用git多多少少有些蛋疼，主要有下面幾個(gè)問題：

① 有bd文件的工程中，只把bd文件加入git是不行的；

② 很多公司都會(huì)有一些積累下來的hdl文件，放到某個(gè)文件夾中，所有的工程目錄下都會(huì)有這個(gè)文件夾，因此這個(gè)文件中會(huì)有很多不是當(dāng)前工程的文件，因此git的文件中，必須包含當(dāng)前工程的files list，否則就得重新添加文件；

③ 如果把整個(gè)Vivado工程都放入git，非必要文件太多，既浪費(fèi)git服務(wù)器的空間，Push和Pull的速度也會(huì)很慢；

④ 很多FPGA工程師有自己的一套git管理Vivado的流程，但每次push前和Clone后都需要做很多操作。

最近我也一直在研究Vivado工程git的管理方式，查了網(wǎng)上很多方法，但有些操作略復(fù)雜，有些方法完全不起效，但好在最終綜合整理出了一種相對(duì)簡單的方式進(jìn)行，也許這種方式不是最合適的，如果你有更好的方法，希望能分享出來。

我們這篇文章只講Vivado的工程，不包括HLS或者Sdk工程，因?yàn)檫@這兩個(gè)工具都是純C/C++/TCL的，git管理起來比較簡單

1. 工程目錄

我們采用如下的目錄結(jié)構(gòu)，這種方式也是Xilinx官網(wǎng)某個(gè)教程上推薦的，

Work目錄：Vivado的工程全都放在Work目錄下，包括bd以及它的相關(guān)文件；

Src目錄：放hdl的源文件以及IP Core的源文件；

Doc目錄：放跟工程相關(guān)的文檔，如果沒有的話可以不加；

Mcs目錄：放工程生成的bit和mcs文件，這個(gè)文件也看個(gè)人用途，如果覺得bit文件太大不想放在git上也無所謂，但個(gè)人覺得在調(diào)試的時(shí)候經(jīng)常會(huì)用到之前測試好了某個(gè)bit；

Scripts目錄：也是進(jìn)行g(shù)it管理的關(guān)鍵，里面放各種Tcl腳本；

如果工程中有SDK/HLS/SsyGen，可以在該目錄下再增加文件夾專門放置對(duì)應(yīng)的工程文件。

2. 操作步驟

1. 在打開的Vivado工程中，通過Tcl Console將目錄切換到Work目錄：

cd [get_property directory [current_project ]]

2. 生成新建工程的Tcl腳本，執(zhí)行：

write_project_tcl {./Scripts/s1_recreate_project.tcl}

3. 依次生成bd文件的tcl腳本，比如工程中有兩個(gè)bd文件aa.bd和bb.bd，打開aa.bd，并執(zhí)行：

write_bd_tcl {./Scripts/s2_aa_bd.tcl}

打開bb.bd，并執(zhí)行：

write_bd_tcl {./Scripts/s3_bb_bd.tcl}

這樣，在Scripts文件夾中，就會(huì)多出三個(gè)文件：

4. 在.gitignore文件中，把整個(gè)Work目錄全部ignore掉，Src文件夾中根據(jù)實(shí)際情況進(jìn)行ignore即可，HDL文件都保留，IP Core只留.xci文件；Scripts目錄全部保留。

5. 到這一步，就可以進(jìn)行Commit和Push了。

6. 把程序Clone下來后，首先要修改s1_recreate_project.tcl，需要修改的地方有兩個(gè)：一個(gè)是新建工程時(shí)的路徑，原始文件為：

替換為：

第二處需要更改的是刪除files list中的bd文件信息，如下圖中框起來的部分，這部分內(nèi)容是將文件添加到工程中，但此時(shí)我們的bd文件還沒有生成，因此這兩個(gè)要?jiǎng)h掉。bd文件是我們通過后面的tcl腳本添加進(jìn)來的。

7. 切換到Scripts目錄

8. 依次執(zhí)行：

source ./s1_recreate_project.tcl
source ./s2_aa_bd.tcl
source ./s3_bb_bd.tcl

OK，到這里工程就Clone完成了?。?！

下面說一下我操作的過程中碰到的幾個(gè)問題：

1. 如果是DDR3的MIG IP Core，會(huì)有Configuration Files，如果我們修改了MIG，并重新生成后，就會(huì)經(jīng)常出現(xiàn)這個(gè)Configuration Files找不到的情況，像下面這樣：

這樣就要我們在導(dǎo)出s1_recreate_project.tcl前要先把這個(gè)文件替換成正確的文件。如果MIG是放在到bd中，那么在上述的第6步修改s1_recreate_project.tcl中，也要把mig_*.prj文件刪掉，因?yàn)檫@個(gè)文件是在新建MIG時(shí)自動(dòng)生成的。

2. 有些朋友用bd的時(shí)候喜歡用wrapper.v的文件來封一層，這個(gè)wrapper.v是Vivado自動(dòng)生成的，而且默認(rèn)目錄就是在Work的工程目錄下，我們可以不用管這個(gè)wrapper.v的文件，等bd文件添加進(jìn)去后，再手動(dòng)生成一下即可；也可以不使用wrapper.v，直接例化bd文件。

3. 上面這種方法是在Vivado2017.2上進(jìn)行的測試，如果是2017.4及以上的版本，write_project.tcl指令中需要增加-use_bd_files選項(xiàng)，也就是：

write_project_tcl -use_bd_files {./Scripts/s1_recreate_project.tcl}

如果不加這個(gè)選項(xiàng)，默認(rèn)會(huì)把bd文件信息也導(dǎo)出,這樣在運(yùn)行時(shí)會(huì)提示么有發(fā)現(xiàn)bd文件的錯(cuò)誤。

4. 如果是低版本的工程進(jìn)行g(shù)it后，要用高版本的Vivado打開，我們可以在導(dǎo)出bd時(shí)去掉IP的版本信息，也就是：

write_bd_tcl -no_ip_version {./Scripts/s2_aa_bd.tcl}

總結(jié)

我嘗試了網(wǎng)上很多方法基本都不能直接使用，但他們既然把方法放到網(wǎng)上，說明是經(jīng)過測試的，但可能測試的并不是特別全面，就是MIG的IP一樣，如果我的工程中沒有這個(gè)IP，那我也不知道在git時(shí)會(huì)出現(xiàn)這種問題。我也不能保證在使用別的IP時(shí)不會(huì)出現(xiàn)問題，但思路都是一樣的，就是把工程的tcl腳本和bd的tcl腳本分開，先新建工程把非bd文件的內(nèi)容加進(jìn)來，再把bd的文件內(nèi)容添加進(jìn)來。

編輯：hfy