引言
有兩種方法可以使用 Modelsim 對 Vivado 工程進行仿真，即級聯仿真和獨立仿真，
級聯仿真就是通過設定使 Vivado 調出 Modelsim 仿真界面并啟動仿真，這種方法的好處是當使用 IP 時不用自己添加 Xilinx 的 IP 庫；缺點是仿真效率極低，每次修改代碼后需要綜合，然后在 Vivado 中調出 Modelsim 進行仿真，并且考慮到 Vivado 的優化問題，其綜合速度遠沒有 Modelsim 編譯快，
獨立仿真是在 Modelsim 中建立工程，擺脫 Vivado 速度慢的困擾，這種方法的優點是完全使用 Modelsim 操作，速度很快；缺點是需要添加各種檔案和作業區，非常復雜，一不小心就會報錯，
所以我們可以采取一種更方便又迅速的方法來讓 Modelsim 能夠獨立仿真 Vivado 工程而又不會產生上面的困擾，
軟體版本：Vivado 2019.2
Modelsim 2019.2
Pycharm 2020.3.3（Python 3.7）
參考手冊：UG835（Vivado Design Suite Tcl Command Reference Guide）
一、級聯仿真程序分析
我們先來看一下使用 Vivado 級聯 Modelsim 仿真的程序中都會發生些什么，
首先在Vivado 的 Setting->Simulation 中設定 Xilinx 編譯庫的路徑，如果還沒有編譯庫檔案，請看 芯王國寫的 https://blog.csdn.net/weixin_40377195/article/details/89038414 這篇文章，
然后在 Setting->3rd Party Simulators 中設定 Modelsim 的啟動路徑和前面的編譯庫路徑，
設定完成后點擊左側的 Run Simulation->Run Behavioral Simulation 啟動 Modelsim 仿真，啟動完成后回到 Vivado 中，查看下方的 Tcl Console ，可以看到這樣一條描述資訊：“Command:launch_simulation” 這說明當 Vivado 呼叫 Modelsim 時使用了 launch_simulation 這個 Tcl 命令，
查閱 UG835 手冊可以發現存在 launch_simulation 這個命令，
跳轉到定義后可以發現，此命令使用 -mode 選項來選擇仿真型別，我們進行的是行為級仿真，所以使用 behavioral ，因為我們之前是點擊 Run simulation 而直接進入仿真，如果想要讓仿真更快更方便就不能讓 Vivado 直接啟動仿真，所以使用 -scripts_only 選項來指定 Vivado 只生成相關仿真腳本，而不啟動仿真，
由上面的分析可知， 最后在 Vivado 的 Tcl 控制臺輸入的命令應該是 “launch_simulation -mode behavioral -scripts_only”，但這個命令太長了，不容易記住也不容易輸入，故把這條命令寫到一個 tcl 檔案中再在 Vivado 控制臺執行，
建立一個名為 sim.tcl 的檔案，并在檔案中輸入：
launch_simulation -mode behavioral -scripts_only然后將 sim.tcl 檔案放在工程的根目錄下（和.xpr檔案一個目錄），在 Vivado 控制臺輸入命令 source sim.tcl 即可將相關仿真腳本匯入工程目錄下：
仿真相關的腳本檔案夾路徑為：xxxxx\xxxxx.sim\sim_1\behav\modelsim （xxxxx為自己起的工程名），目錄結構如下圖所示，包含了兩個批處理(.bat)檔案和三個 Tcl 檔案(.do)
由 source sim.tcl 命令生成的批處理檔案 simulate.bat 中的內容如下：
@echo off
REM ****************************************************************************
REM Vivado (TM) v2019.2 (64-bit)
REM
REM Filename : simulate.bat
REM Simulator : Mentor Graphics ModelSim Simulator
REM Description : Script for simulating the design by launching the simulator
REM
REM Generated by Vivado on Wed Feb 10 19:45:01 +0800 2021
REM SW Build 2708876 on Wed Nov 6 21:40:23 MST 2019
REM
REM Copyright 1986-2019 Xilinx, Inc. All Rights Reserved.
REM
REM usage: simulate.bat
REM
REM ****************************************************************************
set bin_path=D:\\modeltech64_2019.2\\win64
call %bin_path%/vsim -c -do "do {pll_test_tb_simulate.do}" -l simulate.log
if "%errorlevel%"=="1" goto END
if "%errorlevel%"=="0" goto SUCCESS
:END
exit 1
:SUCCESS
exit 0
而由 Vivado 啟動仿真按鈕生成的 simulate.bat 檔案中內容則如下：
@echo off
REM ****************************************************************************
REM Vivado (TM) v2019.2 (64-bit)
REM
REM Filename : simulate.bat
REM Simulator : Mentor Graphics ModelSim Simulator
REM Description : Script for simulating the design by launching the simulator
REM
REM Generated by Vivado on Wed Feb 10 19:43:53 +0800 2021
REM SW Build 2708876 on Wed Nov 6 21:40:23 MST 2019
REM
REM Copyright 1986-2019 Xilinx, Inc. All Rights Reserved.
REM
REM usage: simulate.bat
REM
REM ****************************************************************************
set bin_path=D:\\modeltech64_2019.2\\win64
call %bin_path%/vsim -do "do {pll_test_tb_simulate.do}" -l simulate.log
if "%errorlevel%"=="1" goto END
if "%errorlevel%"=="0" goto SUCCESS
:END
exit 1
:SUCCESS
exit 0
由上面兩個 simulate.bat 檔案的對比可見，區別在于 由 source sim.tcl 命令生成的 simulate.bat 中多了一個 -c 選項 ，查詢 Modelsim 手冊可知， -c 選項是以命令列模式執行 vsim 命令，而不會打開軟體，所以需要將 -c 選項洗掉，
從 simulate.bat 的內容中可以看出，此腳本啟動了 Modelsim 后執行了 xxxxx_simulate.do 腳本，我們打開 xxxxx_simulate.do 內容如下，可見 xxxxx_simulate.do 設定了仿真啟動選項、啟動仿真器、加入波形檔案 xxxxx_wave.do 等操作，我們可以在工程的根目錄下創建一個自定義波形檔案 wave.do 來記錄想要查看的波形和顯示格式，然后把它覆寫到 xxxxx_wave.do 中，這樣可以避免當仿真檔案夾更新時自定義波形檔案丟失，
其中最后一句的 quit -force 會導致執行完do檔案后退出程式，所以需要洗掉它，前一句 run 1000ns 是指定仿真時長，因為我們對每個工程的仿真時長需求都不一定一致，所以不需要提前指定仿真時長，故洗掉它，由于我們常常在仿真啟動后需要查看某些沒被加入到波形串列中的波形，導致加入這些波形后沒有被提前記錄，所以需要加入命令 log -r ./* ，讓仿真器記錄全部波形（*為通配符，指代全部信號名），
######################################################################
#
# File name : pll_test_tb_simulate.do
# Created on: Wed Feb 10 19:45:01 +0800 2021
#
# Auto generated by Vivado for 'behavioral' simulation
#
######################################################################
vsim -voptargs="+acc" -L xil_defaultlib -L unisims_ver -L unimacro_ver -L secureip -L xpm -lib xil_defaultlib xil_defaultlib.pll_test_tb xil_defaultlib.glbl
set NumericStdNoWarnings 1
set StdArithNoWarnings 1
do {pll_test_tb_wave.do}
view wave
view structure
view signals
do {pll_test_tb.udo}
run 1000ns
quit -force
但有一個問題，xxxxx_simulate.do 檔案并沒有編譯源檔案，在目錄中我們還可以發現一個叫做 compile.bat 的檔案，從名字看應該是和編譯相關的，內容如下，可見這個 compile.bat 打開了 Modelsim 并執行了 xxxxx_compile.do 檔案，當然，和 simulate.bat 一樣，vsim 命令中需要洗掉 -c 選項，
@echo off
REM ****************************************************************************
REM Vivado (TM) v2019.2 (64-bit)
REM
REM Filename : compile.bat
REM Simulator : Mentor Graphics ModelSim Simulator
REM Description : Script for compiling the simulation design source files
REM
REM Generated by Vivado on Wed Feb 10 19:45:01 +0800 2021
REM SW Build 2708876 on Wed Nov 6 21:40:23 MST 2019
REM
REM Copyright 1986-2019 Xilinx, Inc. All Rights Reserved.
REM
REM usage: compile.bat
REM
REM ****************************************************************************
set bin_path=D:\\modeltech64_2019.2\\win64
call %bin_path%/vsim -c -do "do {pll_test_tb_compile.do}" -l compile.log
if "%errorlevel%"=="1" goto END
if "%errorlevel%"=="0" goto SUCCESS
:END
exit 1
:SUCCESS
exit 0
xxxxx_compile.do 檔案內容如下所示，可見此腳本建立了作業區 work、msim 和 xil_defaultlib ，編譯了源檔案和IP核檔案，同 xxxxx_simulate.do 檔案相同，需要洗掉 quite -force 命令，同時為了編譯結束后可以直接啟動仿真器，需要在 xxxxx_compile.do 檔案中呼叫 xxxxx_simulate.do 檔案，故在本檔案尾部添加命令 “do xxxxx_simulate.do” ，
######################################################################
#
# File name : pll_test_tb_compile.do
# Created on: Wed Feb 10 19:45:01 +0800 2021
#
# Auto generated by Vivado for 'behavioral' simulation
#
######################################################################
vlib modelsim_lib/work
vlib modelsim_lib/msim
vlib modelsim_lib/msim/xil_defaultlib
vmap xil_defaultlib modelsim_lib/msim/xil_defaultlib
vlog -64 -incr -work xil_defaultlib "+incdir+../../../../pll_test.srcs/sources_1/ip/clk_wiz_0" \
"../../../../pll_test.srcs/sources_1/ip/clk_wiz_0/clk_wiz_0_clk_wiz.v" \
"../../../../pll_test.srcs/sources_1/ip/clk_wiz_0/clk_wiz_0.v" \
"../../../../pll_test.srcs/sources_1/new/pll_test.v" \
"../../../../pll_test.srcs/sim_1/new/pll_test_tb.v" \
# compile glbl module
vlog -work xil_defaultlib "glbl.v"
quit -force
總結一下，步驟是：
1、在 Vivado 的 Tcl Console 中輸入 source sim.tcl ，匯出仿真腳本檔案，
2、洗掉 simulate.dat 和 compile.bat 中的 -c 選項，
3、洗掉 xxxxx_simulate.do 檔案中的 quit -force 和 run 1000ns ，并且加入 log -r/* ，
4、洗掉 xxxxx_compile.do 檔案中的 quit -force ，并且加入 do xxxxx_simulate.do ，
5、執行 compile.bat 腳本，
二、Python腳本撰寫
我們撰寫 Python 腳本，以便上面的步驟可以自動地執行，在此基礎之上，還添加了 仿真腳本檔案所在路徑的自動識別 和 頂層tb檔案名的自動識別 ，
這樣將 Python 腳本扔在 Vivado 工程根目錄下就可以自動完成路徑和名稱的識別從而不用進行任何設定直接更改好相關檔案并啟動 Modelsim 和仿真器，
Python 代碼如下：
import os
import pathlib
# 先在Vivado Tcl中執行 ” launch_simulation -mode behavioral -scripts_only “
# 或者
# 在工程路徑下加入sim.tcl腳本，再在Vivado Tcl中執行 ” source sim.tcl “
########################################################################################################################
##-------------------- 默認設定，Vivado 仿真無特殊設定無需更改此處 --------------------##
# 仿真檔案夾 默認后續路徑
FollowPath = '/sim_1/behav/modelsim/'
# compile 批處理腳本名稱
CompileBatName = 'compile.bat'
# simulate 批處理腳本名稱
SimulateBatName = 'simulate.bat'
# 自定義信號檔案名稱
WaveFileName = 'wave.do'
########################################################################################################################
# 標志位，防止同一陳述句多次寫入
sim_flag = True
comp_flag = True
# 仿真目錄路徑自動識別
usrpath = pathlib.Path() # 宣告工程所在路徑為根路徑
search_xpr = usrpath.glob('*.sim') # 查找 sim 檔案夾
for item in search_xpr:
SimName = str(item)
SimDirPath = SimName + FollowPath # 合成本工程仿真目錄路徑
# 待仿真tb檔案名稱自動識別
usrpath = pathlib.Path(SimDirPath) # 進入仿真腳本所在檔案夾
search_xpr = usrpath.glob('*_compile.do') # 搜索以 _compile.do 結尾的檔案絕對路徑
for item in search_xpr:
TbName = str(item)
TbName = TbName.replace('\\','/') # Windows 路徑格式轉換為 Python 路徑格式
TbFileName = TbName.replace(SimDirPath,'') # 掐頭去尾，只保留待仿真tb檔案名稱
TbFileName = TbFileName.replace('_compile.do','')
# 洗掉 simulate.bat 腳本的-c選項
print('***** 正在修改檔案 simulate.bat...... *****\n')
SimulateBatFile = open(SimDirPath + SimulateBatName, 'r')
SimulateBatFileAllLines = SimulateBatFile.readlines()
SimulateBatFile.close()
SimulateBatFile = open(SimDirPath + SimulateBatName, 'w')
for EachLine in SimulateBatFileAllLines:
if EachLine.find('%bin_path%/vsim -c -do') != -1:
EachLine = EachLine.replace('%bin_path%/vsim -c -do', '%bin_path%/vsim -do')
SimulateBatFile.writelines(EachLine)
SimulateBatFile.close()
print('***** simulate.bat ，修改完畢！ *****\n')
# 洗掉 compile.bat 腳本的-c選項
print('***** 正在修改檔案 compile.bat...... *****\n')
CompileBatFile = open(SimDirPath + CompileBatName, 'r')
CompileBatFileAllLines = CompileBatFile.readlines()
CompileBatFile.close()
CompileBatFile = open(SimDirPath + CompileBatName, 'w')
for EachLine in CompileBatFileAllLines:
if EachLine.find('%bin_path%/vsim -c -do') != -1:
EachLine = EachLine.replace('%bin_path%/vsim -c -do', '%bin_path%/vsim -do')
CompileBatFile.writelines(EachLine)
CompileBatFile.close()
print('***** compile.bat ，修改完畢！ *****\n')
# 修改 simulate.do 腳本
print('***** 正在修改檔案 simulate.do...... *****\n')
SimulateDoFile = open(SimDirPath + TbFileName +'_simulate.do', 'r')
SimulateDoFileAllLines = SimulateDoFile.readlines()
SimulateDoFile.close()
SimulateDoFile = open(SimDirPath + TbFileName +'_simulate.do', 'w')
for EachLine in SimulateDoFileAllLines:
if EachLine.find('run 1000ns') == -1 and EachLine.find('quit -force') == -1:
SimulateDoFile.writelines(EachLine)
if EachLine.find('log -r ./*') != -1:
sim_flag = False
if sim_flag == True:
SimulateDoFile.writelines('\nlog -r ./*\n')
SimulateDoFile.close()
print('***** simulate.do ，修改完畢！ *****\n')
# 修改 compile.do 腳本
print('***** 正在修改檔案 compile.do...... *****\n')
CompileDoFile = open(SimDirPath + TbFileName +'_compile.do', 'r')
CompileDoFileAllLines = CompileDoFile.readlines()
CompileDoFile.close()
CompileDoFile = open(SimDirPath + TbFileName +'_compile.do', 'w')
for EachLine in CompileDoFileAllLines:
if EachLine.find('quit -force') == -1:
CompileDoFile.writelines(EachLine)
if EachLine.find('do ' + TbFileName + '_simulate.do') != -1:
comp_flag = False
if comp_flag == True:
CompileDoFile.writelines('\ndo ' + TbFileName + '_simulate.do\n')
CompileDoFile.close()
print('***** compile.do ，修改完畢！ *****\n')
# 將當前目錄下自定義信號檔案 wave.do 中的內容覆寫到仿真目錄下自動生成的波形檔案中
print('***** 正在添加自定義波形檔案...... *****\n')
SimWaveDoFile = open(WaveFileName,'r')
SimWaveDoFileAllLines = SimWaveDoFile.readlines()
SimWaveDoFile.close()
SimWaveDoFile = open(SimDirPath + TbFileName + '_wave.do','w')
SimWaveDoFile.writelines(SimWaveDoFileAllLines)
SimWaveDoFile.close()
print('***** 自定義波形檔案添加完畢！ *****\n')
# 執行 compile.bat 腳本,啟動 Modelsim
print('***** 編譯工程檔案，啟動 Modelsim！*****\n')
os.system('cd ' + SimDirPath + ' && ' + 'call ' + CompileBatName)
三、使用步驟
1、在 Vivado 的工程目錄下放入 Python 腳本、 Tcl 腳本 sim.tcl 和自己定義好的波形檔案 wave.do ，
2、在 Vivado 的 Tcl Console 中輸入命令 source sim.tcl ，
3、 雙擊 Python 腳本，等待自動啟動完成，
4、輸入想仿真的時長，啟動仿真
因為執行 Python 腳本會再次打開 Modelsim ，所以如果后續修改工程時沒有增減IP核，只需要在 Modelsim 的控制臺中執行命令 do xxxxx_compile.do 即可重新開始自動編譯并仿真，如果后續增減了IP核，則重復上述四個步驟即可，
轉載請註明出處，本文鏈接：https://www.uj5u.com/qita/258844.html
標籤：其他
上一篇：Linux中修改登錄提示檔案