Mengintegrasikan Pustaka IP Quartus Prime ke VUnit: Panduan Langkah demi Langkah
Apakah Anda pernah ingin menjalani simulasi VHDL yang mencakup inti IP Quartus melalui kerangka verifikasi VUnit?
Itulah yang dimaksud oleh insinyur FPGA Konstantinos Paraskevopoulos, tetapi dia tidak dapat menemukan tutorial yang sesuai untuk itu. Untungnya, dia menggunakan bakatnya untuk mencarinya dan cukup baik untuk membagikannya kepada VHDLwhiz melalui tamu artikel ini.
Berikanlah kata kepada Konstantinos!
Seringkali diinginkan untuk menyisipkan IP yang telah ditentukan dari Katalog IP Quartus ke dalam desain Anda saat mensimulasikan sistem Anda dengan VUnit. Tutorial ini menyediakan pengetahuan yang diperlukan untuk menghasilkan, menyisipkan, dan menghubungkan pustaka IP Quartus eksternal ke lingkungan VUnit.
Baru di VUnit? Lihat tutorial ini: Memulai dengan VUnit
Ringkasan
Tutorial ini terdiri dari tiga bagian utama:
Deskripsi singkat IP yang dipilih
Langkah yang diperlukan untuk menghasilkan dan menghubungkan pustaka yang tepat
Verifikasi dengan memanfaatkan VUnit dan Modelsim
Persyaratan
Quartus
Unduh Quartus Prime
QSYS harus ada di PATH Anda untuk LANGKAH 2 (opsi CMD)
Intel Modelsim
Silakan lihat artikel ini untuk cara menginstal ModelSim secara gratis
ModelSim harus ada di PATH Anda
VUnit
Silakan lihat artikel ini untuk cara menginstal VUnit secara gratis
Python 3.6 atau lebih tinggi
Unduh Python
Python harus ada di path Anda
Ini juga mengasumsikan pengetahuan dasar VHDL dan keterampilan ModelSim.
Desain yang diuji
Untuk skenario kami, kami menggunakan Parallel Adder IP dari daftar IP Aritmatika Integer Quartus.
Desain kami menerima tiga vektor input 16-bit dan menghasilkan hasil penambahan dalam vektor 17-bit.
Langkah 1 : Generate IP
Kami menghasilkan pengumpan kami di jendela katalog IP dengan double-klik komponen parallel adder di bawah Library/Basic functions/Arithmetic.
Setelah kita memberikan nama dan menyesuaikan komponen kami berdasarkan kebutuhan, kita klik tombol Generate HDL di kanan bawah.
Pada titik ini, jendela akan muncul, seperti digambarkan dalam gambar berikut.
Catatan: Kami harus mengatur Create simulation model di bawah bagian Simulation ke VHDL atau Verilog untuk menghasilkan file simulasi karena opsi default adalah none. Jika kita tidak memilih salah satunya, file given_ip_name.spd tidak akan dihasilkan, menyebabkan langkah berikutnya gagal.
Proses di atas menghasilkan file dan folder di bawah direktori quartus kami:
File: given_ip_name.ip
Folder: given_ip_name
Folder berisi file .vhd dan .v yang perlu ditambahkan nanti dalam skrip run.py kami.
Langkah 2 : Generate file simulasi IP
GUI: Pilih Tools ➤ Generate Simulator Setup Script for IP dan tentukan direktori keluaran di jendela prompt,
CMD: Dengan memanfaatkan perintah Qsys, kami dapat menghasilkan file yang sama dengan mengetik di terminal perintah berikut:
Dengan salah satu dari dua metode di atas, kami meminta Quartus untuk menghasilkan direktori untuk setiap simulator yang didukung yang menyimpan skrip untuk membuat dan mengompilasi pustaka IP.
Langkah 3: Generate dan kompilasi pustaka IP untuk Modelsim
Langkah berikutnya adalah menemukan skrip msim_setup.tcl di folder mentor yang dibuat oleh langkah sebelumnya dan menyalinnya dengan nama setup.tcl. Kemudian, dalam file setup.tcl, komentarkan perintah yang diilustrasikan dan atur variabel $QSYS_SIMDIR.
# # QSYS_SIMDIR is used in the Quartus-generated IP simulation script to # # construct paths to the files required to simulate the IP in your Quartus # # project. By default, the IP script assumes that you are launching the # # simulator from the IP script location. If launching from another # # location, set QSYS_SIMDIR to the output directory you specified when you # # generated the IP script, relative to the directory from which you launch # # the simulator. # set QSYS_SIMDIR <script generation output directory> # # # Source the generated IP simulation script. source $QSYS_SIMDIR/mentor/msim_setup.tcl # # # Set any compilation options you require (this is unusual). # set USER_DEFINED_COMPILE_OPTIONS <compilation options> # set USER_DEFINED_VHDL_COMPILE_OPTIONS <compilation options for VHDL> # set USER_DEFINED_VERILOG_COMPILE_OPTIONS <compilation options for Verilog> # # # Call command to compile the Quartus EDA simulation library. dev_com # # # Call command to compile the Quartus-generated IP simulation files. com #
Setelah mengubah dan menyimpan setup.tcl, kami dapat dengan aman menjalankan file Tcl menggunakan perintah vsim.
vsim -c -do "do setup.tcl; quit"
Itu menghasilkan pustaka yang dikompilasi di folder mentor.
Langkah 4: VUnit link
Sekarang setelah pustaka IP telah dihasilkan, kami harus menghubungkannya dengan menggunakan skrip python run.py.
Lihat gambar di bawah ini untuk memahami struktur direktori contoh kami dengan lebih baik. Topologi awal terdiri dari folder root demo, folder tb, vunit, dan quartus. Semua subfolder dan file di bawah folder quartus dihasilkan melalui kerangka Quartus setelah membuat proyek dan menyelesaikan langkah 1 hingga 3.
Catatan: Quartus menghasilkan lebih banyak file dan folder, tetapi gambar di bawah ini menunjukkan yang relevan bagi kami.
Dengan pandangan topologi yang jelas ini sebagai referensi, kami dapat menentukan jalur ROOT kami dan jalur ke pustaka yang dihasilkan, seperti ditunjukkan di bawah.
Perhatikan bahwa sim_files adalah direktori yang ditentukan pada langkah 2 di mana folder mentor telah disimpan.
from vunit import VUnit from os.path import join, dirname, abspath # ROOT root = join(dirname(__file__), '../') # Path to generated libraries path_2_lib = '/quartus/sim_files/mentor/libraries/' # ROOT
Setelah membuat instance VUnit yang disebut vu, kami dapat menentukan pustaka desain untuk kode VHDL kami dan menghubungkan pustaka eksternal yang diperlukan:
# Create VUnit instance by parsing command line arguments vu = VUnit.from_argv() # create design's library my_lib = vu.add_library('my_lib') # Link external library vu.add_external_library("parallel_adder", root + path_2_lib + "parallel_adder")
Dan akhirnya, tambahkan file sumber kami. File-file ini terletak di tiga subfolder di bawah direktori given_ip_name:
parallel_add_191
synth
sim
Folder synth dan sim berisi informasi yang sama, yaitu desain tingkat atas IP kami. Namun, pemformatan file-file ini dalam kasus kami adalah VHDL. File-file ini dapat berupa Verilog, dan ini tergantung pada bahasa yang dipilih pada langkah 1.
Jika desain tingkat atas kami melibatkan sub-komponen, kami juga harus menyertakan file sumber mereka. File-file ini terletak di bawah subfolder di direktori given_ip_name, seperti komponen parallel_add_191 dalam kasus kami.
Untuk memulai, Anda dapat melihat tautan ini untuk mempelajari dasar-dasar pembentukan testbench VUnit.
Kembali ke testbench kami, kami menambahkan pustaka VUnit yang diperlukan beserta pustaka lain yang ingin kami gunakan dan mendefinisikan sinyal kami.
Catatan: Eksekusi proses dalam contoh kami berurutan. Jadi, sinyal kontrol (yang disebut flags) digunakan untuk memberi tahu proses apakah harus memulai atau mengakhiri.
library IEEE; use IEEE.std_logic_1164.all; use ieee.numeric_std.all; library vunit_lib; context vunit_lib.vunit_context; entity tb_demo is generic ( runner_cfg : string:= runner_cfg_default); end tb_demo; architecture sim of tb_demo is constant clk_period : time := 10 ns; signal clk : std_logic := '0'; signal rst : std_logic := '0'; -- INPUTS signal data_a : std_logic_vector(0 to 15):= (others => '0'); signal data_b : std_logic_vector(0 to 15):= (others => '0'); signal data_c : std_logic_vector(0 to 15):= (others => '0'); -- OUTPUTS signal result : std_logic_vector(0 to 16); -- CONTROL FLAGS signal reset_done :boolean := false; signal sim_done :boolean := false; signal start_sim :boolean := false;
Selanjutnya, kami membuat instance UUT kami. Quartus menyediakan contoh instantiasi komponen untuk VHDL dan Verilog di bawah konvensi nama file ip_name_inst.vhd dan ip_name_inst.v.
begin -- Unit Under Test UUT : entity work.parallel_adder port map ( data0x => data_a, -- parallel_add_input.data0x data1x => data_b, -- .data1x data2x => data_c, -- .data2x result => result -- parallel_add_output.result );
Dua proses pertama yang dimulai adalah clk_process dan reset_rel. Sementara yang terakhir ditangguhkan setelah mereset dan mendorong flag reset_done ke true, clk_process beroperasi selama waktu simulasi.
clk_process : process begin clk <= '1'; wait for clk_period/2; clk <= '0'; wait for clk_period/2; end process clk_process; reset_rel : process begin rst <= '1'; wait for clk_period*2; wait until rising_edge(clk); rst <= not rst; reset_done <= true; wait; end process reset_rel;
Sekarang setelah reset selesai, kami dapat memanggil proses test_runner untuk menjalankan tes kami. Selain itu, test runner tetap aktif sampai flag sim_done dipindahkan ke true, yang terjadi dalam proses terakhir.
test_runner : process begin test_runner_setup(runner, runner_cfg); wait until reset_done and rising_edge(clk); iterate : while test_suite loop start_sim <= true; if run("test_case_1") then info ("Start"); info (running_test_case); wait until sim_done; end if; end loop; test_runner_cleanup(runner); end process test_runner;
Terakhir, proses data_generator mengeksekusi beberapa penambahan dengan menetapkan nilai ke tiga input pengumpan paralel kami dengan menggunakan loop for.
Catatan: Proses ini dipicu ketika proses test_runner menginstruksikan dengan mengatur flag start_sim. Sementara di akhir proses ini, itu mengangkat flag sim_done, memerintahkan test runner untuk menjeda simulasi.
data_generator : process constant tag2 : log_level_t := new_log_level("INFO", fg => blue, bg => black, style => bright); variable a,b,c,d : integer; begin wait until start_sim; wait until rising_edge(clk); show(display_handler, tag2); if running_test_case = "test_case_1" then for i in 0 to 10 loop data_a <= std_logic_vector(to_unsigned(i+10,data_a'length)); data_b <= std_logic_vector(to_unsigned(i+20,data_a'length)); data_c <= std_logic_vector(to_unsigned(i+30,data_a'length)); wait until rising_edge(clk); a := to_integer(unsigned(data_a)); b := to_integer(unsigned(data_b)); c := to_integer(unsigned(data_c)); d := to_integer(unsigned(result)); log( integer'image(a) &" + & integer'image(b) &" + & integer'image(c) &" = & integer'image(d), tag2); end loop; end if; sim_done <= true; end process data_generator;
Verifikasi
Untuk menjalani kasus uji dan memverifikasi bahwa semuanya berfungsi seperti yang diharapkan, kami dapat menjalankan skrip run.py dari direktori tempat berada dengan mengetik di terminal perintah berikut.
python ./run.py -v
Catatan: Sebuah logger kustom telah digunakan untuk ilustrasi yang lebih baik di output kami yang terlihat dengan memberikan opsi verbose -v. Selain itu, karena hanya satu kasus uji yang didefinisikan, kami tidak perlu menyediakan opsi untuk menentukannya.
Terakhir, untuk memverifikasi hasil kami di ModelSim, kami dapat mengetik perintah berikut:
python ./run.py --gui
(Klik gambar untuk memperbesar)
Kesimpulan
Untuk menyimpulkan, kami telah mempelajari cara menyisipkan dan menguji IP Quartus yang berada dalam katalog IP dalam lingkungan VUnit. Sementara tutorial ini menggunakan IP yang telah ditentukan, proses yang sama berlaku untuk IP paket kustom.
Lihat tutorial VUnit ini jika Anda belum melakukannya: Memulai dengan VUnit