Constant Function

by Jorge Franganillo

Verilog2001からconstant functionというものがサポートされています。
使い用によっては便利だなと思いつつ、使わなくてもなんとかなるものなのであまり気にしていませんでしたが、使いたくなったときに調べるのが面倒なのでメモしときます。

まずどういうときに使うのかというと、使いたい時というのは多分限られていて例えばFIFOなどのパラメータ化を考えたとき、昔のVerilog HDLではパラメータとしてデータのビット幅とFIFOの深さそれとFIFOのポインタのビット幅をという３つのパラメータを指定する必要がありました。

この中でFIFOのポインタのビット幅というのはFIFOの深さから導けるのですが、単純な四則演算などで計算することが出来ず、for文などを使う必要があるため別途パラメータとして渡してあげなければならなかったわけです。
例えば次のような感じです。

view plainprint?

1. module my_fifo (clk, rst_n, we, re, wdt, rdt, full, empty);  
2.   
3.   parameter DT_WIDTH = 8;  
4.   parameter FIFO_DEPTH = 16;  
5.   parameter PTR_WIDTH = 4;  
6.   
7.   input clk, rst_n, we, re;  
8.   input [DT_WIDTH-1:0] wdt;  
9.   output [DT_WIDTH-1:0] rdt;   
10.   output full, empty;  
11.   
12.   reg [DT_WIDTH-1:0] ram [0:FIFO_DEPTH-1];  
13.   reg [PTR_WIDTH-1:0] wr_ptr;  
14.   reg [PTR_WIDTH-1:0] rd_ptr;  
15.   
16.   ...;  
17.   
18. endmodule  

module my_fifo (clk, rst_n, we, re, wdt, rdt, full, empty);

  parameter DT_WIDTH = 8;
  parameter FIFO_DEPTH = 16;
  parameter PTR_WIDTH = 4;

  input clk, rst_n, we, re;
  input [DT_WIDTH-1:0] wdt;
  output [DT_WIDTH-1:0] rdt; 
  output full, empty;

  reg [DT_WIDTH-1:0] ram [0:FIFO_DEPTH-1];
  reg [PTR_WIDTH-1:0] wr_ptr;
  reg [PTR_WIDTH-1:0] rd_ptr;

  ...;

endmodule

それがVerilog2001からは演算結果が定数となる場合であれば、parameterの右辺にfunctionを使えるようになったため以下のように書けるので、パラメータの受け渡しの際にFIFO_DEPTHとPTR_WIDTHの間で不整合が起こるような危険を回避できます。

view plainprint?

1. module my_fifo (clk, rst_n, we, re, wdt, rdt, full, empty);  
2.   
3.   parameter DT_WIDTH = 8;  
4.   parameter FIFO_DEPTH = 16;  
5.   localparam PTR_WIDTH = log2(FIFO_DEPTH);  
6.   
7.   input clk, rst_n, we, re;  
8.   input [DT_WIDTH-1:0] wdt;  
9.   output [DT_WIDTH-1:0] rdt;   
10.   output full, empty;  
11.   
12.   reg [DT_WIDTH-1:0] ram [0:FIFO_DEPTH-1];  
13.   reg [PTR_WIDTH-1:0] wr_ptr;  
14.   reg [PTR_WIDTH-1:0] rd_ptr;  
15.   
16.   ...;  
17.   
18. endmodule  

module my_fifo (clk, rst_n, we, re, wdt, rdt, full, empty);

  parameter DT_WIDTH = 8;
  parameter FIFO_DEPTH = 16;
  localparam PTR_WIDTH = log2(FIFO_DEPTH);

  input clk, rst_n, we, re;
  input [DT_WIDTH-1:0] wdt;
  output [DT_WIDTH-1:0] rdt; 
  output full, empty;

  reg [DT_WIDTH-1:0] ram [0:FIFO_DEPTH-1];
  reg [PTR_WIDTH-1:0] wr_ptr;
  reg [PTR_WIDTH-1:0] rd_ptr;

  ...;

endmodule

ここでlog2()は2を底とする入力の対数を計算するfunctionとします。

で、この2を底とする入力の対数を求めるfunctionなんですがConstant Functionの例では必ずと行っていいほどこの例になっています。しかし、なかには間違えているコードもあるようなのでご注意ください。
例えばこちらの"3.0 LRM Errors"ではIEEE Verilog-2001 Standardで紹介されている次のコードに誤りがあると指摘しています。

view plainprint?

1. //define the clogb2 function   
2. function integer clogb2;   
3.   input depth;   
4.   integer i,result;   
5.   begin   
6.     for (i = 0; 2 ** i < depth; i = i + 1)   
7.       result = i + 1;   
8.     clogb2 = result;   
9.   end   
10. endfunction  

//define the clogb2 function 
function integer clogb2; 
  input depth; 
  integer i,result; 
  begin 
    for (i = 0; 2 ** i < depth; i = i + 1) 
      result = i + 1; 
    clogb2 = result; 
  end 
endfunction

どこが悪いのかわかりますか？

１つは入力のdepthが１ビットとなっていること。

そしてもうひとつはdepthが１だった場合にforループが実行されず、resultが初期化されないためにこのfunctionが不定値を返してしまうことです。

そこでこのfunctionは次のように置き換えるべきだと書いてあるのですが。。。

view plainprint?

1. function integer clogb2;   
2.   input [31:0] value;   
3.   for (clogb2=0; value>0; clogb2=clogb2+1)   
4.     value = value>>1;   
5. endfunction   

function integer clogb2; 
  input [31:0] value; 
  for (clogb2=0; value>0; clogb2=clogb2+1) 
    value = value>>1; 
endfunction 

これはこれで問題がある気がします。

入力が２の定数である場合、結果が正しくないですよね？
例えば入力value=2の時、１を返すのが正しい結果のはずですがforループが２回実行されるので結果2を返してしまいます。

こちらで紹介されている例のほうが良いでしょう。

view plainprint?

1. function integer log2;  
2.   input integer value;  
3.   begin  
4.     value = value-1;  
5.     for (log2=0; value>0; log2=log2+1)  
6.       value = value>>1;  
7.   end  
8. endfunction  

function integer log2;
  input integer value;
  begin
    value = value-1;
    for (log2=0; value>0; log2=log2+1)
      value = value>>1;
  end
endfunction

入力が０だと問題ですが、対数を求める関数なのでもともと入力は１以上であるはずです。

使う機会はそれほど多くないかもしれませんが覚えておいて損はないでしょう。