キーワード: defparam、パラメータ、インスタンス化、ram

あるモジュールが別のモジュールによって参照され、インスタンス化される場合、上位モジュールは下位モジュールのパラメータ値を書き換えることができます。これにより、コンパイル時に異なるパラメータを同じ名前の複数のモジュールに渡すことができ、パラメータだけが異なる複数のモジュールのためにわざわざ新しいファイルを作成する必要はありません。

パラメータの上書きには2つの方法があります:1)キーワード defparam を使用する、2)パラメータ値付きでモジュールをインスタンス化する。

defparam 文

キーワード defparam を使用すると、モジュール階層を介した呼び出しの方法で、下位モジュールのパラメータ値を書き換えることができます。

例えば、シングルポートでアドレス線とデータ線がともに4bit幅の ram モジュールの MASK パラメータを書き換えます:

例

//instantiation
defparam     u_ram_4x4.MASK = 7 ;
ram_4x4    u_ram_4x4
    (
        .CLK    (clk),
        .A      (a[4-1:0]),
        .D      (d),
        .EN     (en),
        .WR     (wr),    //1 for write and 0 for read
        .Q      (q)    );

ram_4x4 のモデルは次のとおりです:

例

module  ram_4x4
    (
     input               CLK ,
     input [4-1:0]       A ,
     input [4-1:0]       D ,
     input               EN ,
     input               WR ,    //1 for write and 0 for read
     output reg [4-1:0]  Q    );
 
    parameter        MASK = 3 ;
 
    reg [4-1:0]     mem [0:(1<<4)-1] ;
    always @(posedge CLK) begin
        if (EN && WR) begin
            mem[A]  <= D & MASK;
        end
        else if (EN && !WR) begin
            Q       <= mem[A] & MASK;
        end
    end
 
endmodule

これに対して簡単なシミュレーションを行います。testbench は次のように記述します:

例

`timescale 1ns/1ns
 
module test ;
    parameter    AW = 4 ;
    parameter    DW = 4 ;
 
    reg                  clk ;
    reg [AW:0]           a ;
    reg [DW-1:0]         d ;
    reg                  en ;
    reg                  wr ;
    wire [DW-1:0]        q ;
 
    //clock generating
    always begin
        #15 ;     clk = 0 ;
        #15 ;     clk = 1 ;
    end
 
    initial begin
        a         = 10 ;
        d         = 2 ;
        en        = 'b0 ;
        wr        = 'b0 ;
        repeat(10) begin
            @(negedge clk) ;
            en     = 1'b1;
            a      = a + 1 ;
            wr     = 1'b1 ;  //write command
            d      = d + 1 ;
        end
        a         = 10 ;
        repeat(10) begin
            @(negedge clk) ;
            a      = a + 1 ;
            wr     = 1'b0 ;  //read command
        end
    end // initial begin
 
    //instantiation
    defparam     u_ram_4x4.MASK = 7 ;
    ram_4x4    u_ram_4x4
    (
        .CLK    (clk),
        .A      (a[AW-1:0]),
        .D      (d),
        .EN     (en),
        .WR     (wr),    //1 for write and 0 for read
        .Q      (q)
     );
 
    //stop simulation
    initial begin
        forever begin
            #100;
            if ($time >= 1000)  $finish ;
        end
    end
 
endmodule // test

シミュレーション結果は次のとおりです:

図中の黄色い部分では、アドレスが最初に c のときにデータ 4 が書き込まれ、2回目にアドレスが c のときに読み出されるデータは 4 です。このとき ram の動作は正しく、MASK が 3 ではないことがわかります。ram の Q 端子の bit2 がマスクされていないためです。

最初にアドレスが 1 のときに書き込まれたデータは 9 ですが、2回目にアドレスが 1 のときに読み出されたデータは 1 です。これは、このとき MASK が 7 であり、ram の Q 端子の信号 bit3 がマスクされているためです。これにより、MASK パラメータが正しく書き換えられたことがわかります。

パラメータ付きモジュールインスタンス化

2つ目の方法は、モジュールをインスタンス化するときに、新しいパラメータ値をモジュールのインスタンス化文に記述し、これにより元の module のパラメータ値を書き換える方法です。

例えば、アドレスとデータのビット幅がどちらも可変の ram モジュールに対して、パラメータ付きのモジュールインスタンス化を行います:

例

ram #(.AW(4), .DW(4))
    u_ram
    (
        .CLK    (clk),
        .A      (a[AW-1:0]),
        .D      (d),
        .EN     (en),
        .WR     (wr),    //1 for write and 0 for read
        .Q      (q)
     );

ram モデルは次のとおりです:

例

module  ram
    #(  parameter       AW = 2 ,
        parameter       DW = 3 )
    (
        input                   CLK ,
        input [AW-1:0]          A ,
        input [DW-1:0]          D ,
        input                   EN ,
        input                   WR ,    //1 for write and 0 for read
        output reg [DW-1:0]     Q
     );
 
    reg [DW-1:0]         mem [0:(1<<AW)-1] ;
    always @(posedge CLK) begin
        if (EN && WR) begin
            mem[A]  <= D ;
        end
        else if (EN && !WR) begin
            Q       <= mem[A] ;
        end
    end
 
endmodule

シミュレーション時は、前の例の testbench で、今回インスタンス化したモジュール u_ram を u_ram_4x4 の代わりに置き換えるか、あるいは新しく追加するだけでよいです。

シミュレーション結果は次のとおりです。図からわかるように、ram モジュールのパラメータ AW と DW はどちらも 4 に書き換えられており、ram の動作も正しいです。

違いと提案

(1) モジュールポートのインスタンス化と同様に、パラメータ付きインスタンス化では、元のパラメータ名を指定せずに順番にパラメータをインスタンス化することもできます。例えば、u_ram のインスタンス化は次のように記述できます:

ram #(4, 4)   u_ram (......) ;

(2) もちろん、defparam を利用すれば、モジュールがポート宣言で宣言したパラメータも書き換えることができ、パラメータ付きインスタンス化を利用すれば、モジュール本体で宣言されたパラメータも書き換えることができます。例えば、u_ram と u_ram_4x4 のインスタンス化は、それぞれ次のように記述できます:

例

defparam     u_ram.AW = 4 ;
defparam     u_ram.DW = 4 ;
ram   u_ram(......);
ram_4x4  #(.MASK(7))    u_ram_4x4(......);

(3) では、この2つのモジュールパラメータ書き換え方法を混在して使用できるでしょうか?もちろんできます!前提は、すべてのパラメータがモジュールのポート宣言時に宣言されたパラメータであるか、またはすべてのパラメータがモジュール本体で宣言されたパラメータであることです。例えば、u_ram の宣言は次のようにも表せます(モジュール本体のパラメータは自分で実験して検証できます):

例

defparam     u_ram.AW = 4 ;
ram #(.DW(4)) u_ram (......);  //こんな書き方を実験するのは、私のように退屈な人間だけだろう

(4) では、あるモジュールに、ポート宣言時に宣言されたパラメータとモジュール本体内で宣言されたパラメータの両方がある場合、これらの2種類のパラメータを同時に書き換えることはできるでしょうか?例えば、ram モジュールに MASK パラメータを追加した場合、モデルは次のとおりです:

例

module  ram
    #(  parameter       AW = 2 ,
        parameter       DW = 3 )
    (
        input                   CLK ,
        input [AW-1:0]          A ,
        input [DW-1:0]          D ,
        input                   EN ,
        input                   WR ,    //1 for write and 0 for read
        output reg [DW-1:0]     Q    );
 
    parameter            MASK = 3 ;
 
    reg [DW-1:0]         mem [0:(1<<AW)-1] ;
    always @(posedge CLK) begin
        if (EN && WR) begin
            mem[A]  <= D ;
        end
        else if (EN && !WR) begin
            Q       <= mem[A] ;
        end
    end
 
endmodule

このとき、defparam でパラメータ MASK の値を書き換えようとすると、コンパイル時に Error が発生します:

例

//すべて defparam を使用すると Error が発生します
defparam     u_ram.AW = 4 ;
defparam     u_ram.DW = 4 ;
defparam     u_ram.MASK = 7 ;
ram   u_ram  (......);
 
//モジュール本体の parameter を defparam で書き換えようとしても Error が発生します
defparam     u_ram.MASK = 7 ;
ram #(.AW(4), .DW(4))   u_ram (......);

ここが重要です!!!パラメータ付きモジュールインスタンス化の方法でパラメータ MASK の値を書き換えれば、コンパイルエラーは発生せず、MASK も正しく書き換えられます!

ram #(.AW(4), .DW(4), .MASK(7)) u_ram (......);

考えられる説明としては、コンパイラの観点から見ると、モジュールにポート宣言時のパラメータがある場合、モジュール本体のパラメータは localparam 型とみなされ、defparam を使用してもモジュール本体で宣言されたパラメータを書き換えることはできません。

コンパイラにも関係している可能性があるため、皆さんも他のコンパイラで実験してみてください。

(5)推奨事項:既存のモジュールをインスタンス化し、その関連パラメータを書き換える場合は、defparam の方法を採用しないでください。上記の欠点に加えて、defparam は通常、合成もできません。

(6)さらに、モジュールを作成する際に、将来インスタンス化されることが予め分かっており、書き換えが必要なパラメータがある場合は、それらのパラメータをすべてモジュールのポート宣言より前の場所に記述することをお勧めします(キーワードのシャープ記号(#)を使用して#表します)。このようなコード形式は、可読性が高いだけでなく、デバッグも容易です。

ソースコードのダウンロード

Download

段階のまとめ

実は、ここまで紹介してきた時点で、皆さんはこれまでに学んだ Verilog 言語の知識を使って、ハードウェア回路の小さな茅葺き小屋を建てることが十分にできます。そうです、小さな茅葺き小屋です。ハードウェア記述言語が実際のハードウェア回路に対応するという特殊性があるため、Verilog でさまざまなモデルを構築する際には、実際に生成される回路がどのようなものになるか、実際の要求に合っているかを必ず考慮しなければなりません。rtl シミュレーションが通ることもありますが、最終的に生成された実際の回路が異常に動作する可能性があります。

そのため、あなたの小さな茅葺き小屋にレンガや瓦を加えるには、さらに発展編を学ぶ必要があります。もちろん、発展編でできるのは、小さな茅葺き小屋を頑丈なレンガ造りの家にして、風雪に耐えられるようにすることだけです。地震に遭えば、やはり崩れ落ちてしまうかもしれません。

レンガ造りの家をさらに頑丈にして、一軒の別荘を建てたい場合は、Verilog 上級編の知識を学ぶ必要があります。例えば、PLI(プログラミング言語インターフェース)、UDP(ユーザー定義プリミティブ)、タイミング制約やタイミング解析などです。また、プロジェクトに多く参加して経験を積む必要があり、低消費電力設計や非同期設計などの設計テクニックに特に注意する必要があります。もちろん、SystemVerilog を使って全面的な検証を行えるようになれば、あなたの建物にもう一枚の防御シールドが加わります。

しかし、デジタル回路や Verilog のすべての知識を学び終えて、砲弾を防ぐ大統領府を築こうと思うなら、それは本当にお力になれません。なぜなら、学問の海に果てはなく、振り返っても岸はないのですから。

紙面の都合上、ここでは発展編のみを紹介します。機会があれば、上級編やテクニック編もまとめて追加します。