Verilog TF子程序

2023-02-28 09:53 更新

功能特性

TF (task/function) 子程序主要用于 Verilog 與用戶 C 程序邊界的兩個(gè)方向上的數(shù)據(jù)傳輸。

TF 子程序總是以 ?tf_? 為前綴,定義在頭文件 veriuser.h 中。所以用 C 語言寫系統(tǒng)任務(wù)或函數(shù)時(shí),都需要在 C 文件中添加 ?#include "veriuser.h"? 。

TF 子程序用途可劃分為:

  • 獲取系統(tǒng)任務(wù)的信息
  • 獲取參數(shù)列表信息
  • 獲取參數(shù)值
  • 把參數(shù)值回傳給系統(tǒng)任務(wù)
  • 監(jiān)視參數(shù)值的改變
  • 獲取仿真時(shí)間和調(diào)度事件的信息
  • 算數(shù)運(yùn)算
  • 顯示信息
  • 管理維護(hù)任務(wù)
  • 掛起、終止、保存、恢復(fù)等其他任務(wù)

完整的 TF 子程序及其簡單用法說明參考下一節(jié)《Verilog TF 子程序列表》。

TF 子程序舉例

PLI 子程序庫函數(shù)數(shù)量繁多,如果一一舉例說明需要大量的篇幅去總結(jié)。所以建議有需求時(shí)再去仔細(xì)研究個(gè)別子程序。下面只對 TF 中的一些子程序進(jìn)行舉例,主要說明使用 TF 子程序設(shè)計(jì) Verilog 系統(tǒng)任務(wù)的基本流程。

設(shè)計(jì)需求

有時(shí)候?yàn)闇p小 C 語言文件編譯后目的文件的大小,或按一定格式輸出調(diào)試信息,軟件中的打印函數(shù)可能不會使用 C 語言自帶的 printf 函數(shù),也不使用 TF 子程序里的 io_printf 函數(shù),而是借助 PLI 接口并使用 Verilog 中的系統(tǒng)顯示函數(shù) (?$display? 或 ?$write?) 完成用戶自定義的軟件打印函數(shù)。

本次設(shè)計(jì)一個(gè)軟件打印函數(shù),命名為 print_my,輸出格式為"字符串+整形"。

設(shè)計(jì)分析

用戶自定義的軟件打印函數(shù) print_my 只是一個(gè)不好看的皮囊,用來將打印信息傳遞給軟件形參變量。為將打印信息傳遞到 Verilog 中,還需要一個(gè) TF 子程序組建的系統(tǒng)任務(wù),命名為 ?$send_my()?。

需要說明的是,用 TF 子程序完成的系統(tǒng)任務(wù)一般要在 Verilog 代碼中調(diào)用。軟件直接調(diào)用該"系統(tǒng)任務(wù)"就相當(dāng)于調(diào)用了一個(gè)軟件函數(shù),和 Verilog 代碼中的相關(guān)變量的描述沒有直接聯(lián)系。所以在軟件函數(shù) print_my 中直接調(diào)用"軟件函數(shù)" send_my 是沒有意義的,就需要在 print_my 中加入一些特定的軟件行為去觸發(fā)系統(tǒng)任務(wù) ?$send_my? 被 Verilog 調(diào)用。

如果數(shù)字系統(tǒng)包含有 CPU,可以使用軟件寫總線或?qū)?nbsp;memory 然后 testbench 中監(jiān)測相關(guān)信號變量的方法。本次設(shè)計(jì)規(guī)模較小,可采用另一種方法,即 Verilog 里一直執(zhí)行系統(tǒng)任務(wù) ?$send_my?,在軟件函數(shù) print_my 中置全局變量來控制是否進(jìn)行信息傳輸并打印的操作。


軟件設(shè)計(jì)

軟件設(shè)計(jì)代碼如下,細(xì)節(jié)在注釋中說明,保存到文件 print_gyc.c 中。

#include "veriuser.h"

//打印的字符串、整型數(shù)據(jù)、軟件開始打印標(biāo)志
char            *str_mes ;  
unsigned int    int_mes ;
int             flags = 0;

//===== define print_my() used in C ======
void print_my(char * str_send, unsigned int int_send){
    str_mes  = str_send ;
    int_mes  = int_send ;
    flags    = 1 ;
}


//打印的字符串對應(yīng)的ASCII碼的字符型數(shù)據(jù),原始字符型長度限制為100
//例如字符"1"對應(yīng)的ASCII碼0x31的字符型數(shù)據(jù)為0x33、0x31
char            str_mes_format[200] ;
//TF 子程序傳遞字符串類型的數(shù)據(jù)時(shí),只能傳遞相關(guān)進(jìn)制格式的數(shù)據(jù)
//例如能傳遞"0xc0de1234",卻不能傳遞 "m.hgci.cn"
//所以需要將原始的字符串?dāng)?shù)據(jù)轉(zhuǎn)換為對應(yīng)的ASCII碼的字符型數(shù)據(jù)
void byte2hexstr(char* str, char* dest, int len)
{
    char tmp;
    int  i ;
    char stb[16] = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F' };
    for (i = 0; i < len; i++){
        tmp = str[i];
        dest[i * 2] = stb[tmp >> 4];
        dest[i * 2 + 1] = stb[tmp & 15];
    }
    return;
}

//===== define PLI: send_my() =======
void send_my(){
    int i = 0 ;
    //檢測到軟件打印開始標(biāo)志flags
    //且系統(tǒng)任務(wù) $send_my 被 Verilog 調(diào)用時(shí)傳入了 3 個(gè)參數(shù)
    if (flags && tf_nump()==3) {
        //將打印的字符串?dāng)?shù)據(jù)轉(zhuǎn)為ASCII對應(yīng)的字符串類型
        byte2hexstr(str_mes, str_mes_format, 100);
        //將16進(jìn)制的字符型數(shù)據(jù)傳遞給系統(tǒng)任務(wù) send_my 中的第2個(gè)參數(shù)
        //長度為1600bits,對應(yīng)100個(gè)char、200個(gè)ASCII字符型數(shù)據(jù)
        tf_strdelputp(2, 1600, 'H', str_mes_format, 0, 0);
        //將整型數(shù)據(jù)傳遞給第3個(gè)參數(shù)
        tf_putp(3, int_mes);
        //將硬件打印開始標(biāo)志傳遞給第一個(gè)參數(shù)
        tf_putp(1, 1) ;
        flags = 0 ;
    }
}

硬件設(shè)計(jì)

根據(jù)仿真測試可知,軟件傳遞到 Verilog 中的數(shù)據(jù),在位寬為 1600bit 寄存器中的存儲方式如下圖所示。


當(dāng)寄存器中存有正常數(shù)據(jù)時(shí),該寄存器從第 799bit(寄存器位寬的一半)開始存儲正常的字符數(shù)據(jù)。低位剩余位寬存儲"NULL"(對應(yīng)數(shù)據(jù) 0)和系統(tǒng)默認(rèn)的數(shù)據(jù)。這兩部分?jǐn)?shù)據(jù)長度根據(jù)存儲的正常數(shù)據(jù)長度的變化而變化。

當(dāng)寄存器中沒有正常數(shù)據(jù)時(shí),該寄存器會用超過 800bit 的寄存器長度去存儲"NULL"(對應(yīng)數(shù)據(jù) 0)。剩余位寬存儲系統(tǒng)默認(rèn)的數(shù)據(jù)。

可以根據(jù)以上特性,檢測正常的字符串?dāng)?shù)據(jù),而不用將寄存器中的數(shù)據(jù)全部打印,以避免打印信息中出現(xiàn)大量的空格信息,影響美觀。

硬件 Verilog 代碼設(shè)計(jì)如下,具體細(xì)節(jié)在注釋中說明,保存到文件 test.v 中。

`timescale 1ns/1ps
module test ;
   reg [1599:0]         str_my ;
   reg [31:0]           int_my ;
   reg                  flag_my ;

   //時(shí)刻檢測硬件打印標(biāo)志 flagh 確定是否打印
   integer              i = 1599;
   integer              j = 1599;
   reg [7:0]            str_tmp ; //字符串?dāng)?shù)據(jù)存儲寄存器
   initial begin
      flagh = 0 ;
      forever begin
         #20 ;
         //調(diào)用系統(tǒng)任務(wù),并將數(shù)據(jù)從軟件傳遞到硬件(Verilog)中
         $send_my(flagh, str_my, int_my);
         if (flagh) begin  //開始打印信息
            #1 ;
            //寄存器位寬有冗余,全部打印會出現(xiàn)大量空格
            //這里對未使用到的寄存器進(jìn)行檢測并屏蔽打印顯示
            for(i=1599; i>=0; i= i-8) begin
               if (str_my[i -: 8] != 0)
                 break ;
            end
            //一般會用寄存器一半位寬對字符串?dāng)?shù)據(jù)進(jìn)行存儲
            //所以字符串傳輸正確時(shí),從 str_my[799] 開始有數(shù)據(jù)
            $display("--DEBUG--- Valid data number: %d", i);

            //如果沒有字符串?dāng)?shù)據(jù),str_my也不會全為空
            //但是str_my[799 -: 8]不會有數(shù)據(jù)
            if (i<=791) begin
               $display("--ERR--- PLEASE INPUT VALID STRING INFO!!!");
               $display("--ERR--- Default data number: %d", i);
               $display("--ERR--- String data structure: %h", str_my);
            end
            else begin
               $write("---YYY---");
               for(j=i; j>=0; j= j-8) begin
                  str_tmp = str_my[j -: 8] ;
                  //再次檢測到空字符時(shí)停止打印顯示    
                  if (str_tmp == "") begin  
                     break ;
                  end
                  //逐個(gè)字符打印
                  else begin
                     $write("%s", str_tmp);
                  end
               end
               //打印整型數(shù)據(jù)
               $write("%h \n", int_my);
            end

            /* $display 不支持寄存器向量域中帶變量訪問
            //所以下列描述是不正確的,只能逐次使用 $write 打印
            else begin
               $display("--YYY--- %s%h", str_my[i : j], int_my);
            end
             */

            flagh = 0 ;
         end
      end
   end

   //停止仿真
   initial begin
      forever begin
         #10000;
         if ($time >= 300)  $finish ;
      end
   end
endmodule

軟件調(diào)用

由于本次設(shè)計(jì)軟件部分不能主動執(zhí)行,所以再增加一個(gè)用 TF 子程序設(shè)計(jì)的 Verilog 系統(tǒng)任務(wù)。該系統(tǒng)任務(wù)在 testbench 中執(zhí)行時(shí),可以調(diào)用軟件程序中的函數(shù) print_my。

在文件 print_gyc.c 中增加如下 C 代碼:

void call_c_print(){
    if (tf_getp(1) == 1)   //如果系統(tǒng)函數(shù)第一個(gè)參數(shù)值為 1
        print_my("It's the first successfull print: ", 0x20170714);
    else if (tf_getp(1) == 2) //如果系統(tǒng)函數(shù)第二個(gè)參數(shù)值為 2
        print_my("2nd: ", 0x09070602);
    else
        print_my("", 0x1); //不傳輸字符串?dāng)?shù)據(jù),則報(bào)錯(cuò)
}

在文件 test.v 中增加如下 Verilog 代碼:

   //c print
   initial begin
      #100 ;
      $call_c_print(1);
      #100 ;
      $call_c_print(2);
      #100 ;
      $call_c_print(3);
   end

編譯仿真

Linux 下用如下命令對 print_gyc.c 進(jìn)行編譯,輸出 print_gyc.o 文件,注意相對路徑。

gcc -I ${VCS_HOME}/include -c ../tb/print_gyc.c

使用 VCS 編譯,需要創(chuàng)建 VCS 可識別的鏈接 table 文件,文件命名為 pli_gyc.tab, 內(nèi)容如下。

?$send_my?, ?$call_c_print? 是 Verilog 調(diào)用的系統(tǒng)任務(wù)名字;

call=my_monitor, call=call_c_print 等表示調(diào)用軟件 C 程序中的函數(shù);

$send_my call=send_my
$call_c_print call=call_c_print

VCS 編譯時(shí)增加如下參數(shù)行。

-P ../tb/pli_gyc.tab

仿真結(jié)果如下。

由圖可知,打印輸出正常,沒有多余的空格信息。

當(dāng)打印信息中沒有字符串?dāng)?shù)據(jù)時(shí),會報(bào) Error,并輸出一些調(diào)試信息。

可以修改 testbench 中的一些參數(shù),來進(jìn)行數(shù)據(jù)存儲格式上的調(diào)試學(xué)習(xí)。


點(diǎn)擊這里下載源碼


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號