VHDL関数マスター:効率的な設計のための実践ガイド
関数はVHDLのサブプログラムで、頻繁に使用されるアルゴリズムの実装に用います。関数はゼロ以上の入力値を取り、常に値を返します。プロシージャと異なる点は、Wait文を含められないため、関数は常にゼロシミュレーション時間で完了することです。
他言語の関数やメソッドに慣れていれば、VHDL関数は容易に理解できるでしょう。VHDLでは戻り値を省略したりvoidを返したりできません。関数は常に何かを返し、その戻り値は何かに代入しなければなりません。
このブログ記事はBasic VHDL Tutorialsシリーズの一部です。
VHDLには純粋(pure)と不純(impure)の2種類の関数があります。関数が純粋であるとは、外部信号を読み書きできないことを意味します。純粋関数を特定の引数で呼び出せば、常に同じ値を返すことが保証されます。これを副作用がないと言います。
VHDLでの関数宣言構文:
[pure|impure] function <function_name> (<parameter1_name> : <parameter1_type> := <default_value>; ... ) return <return_type> is
<constant_or_variable_declaration>
begin
<code_performed_by_the_function>
return <value>
end function;
pure/impureキーワードは省略可能(省略時はpure)。すべてのパラメータは関数内で定数として扱われ変更不可。デフォルト値は省略可能。関数は必ずreturn文で終了しなければなりません。
関数独自の宣言領域はisとbeginの間にあります。ここで宣言された定数、シグナル、変数は関数内でのみ有効で、後続の呼び出しで値を保持しません。
演習
このチュートリアルでは純粋関数に焦点を当てます。不純関数はシリーズの後半で扱います。
前回のチュートリアルで、有限ステートマシン(FSM)を用いた信号機コントローラモジュールを作成しました。タイマー計算の行を各状態にコピペし、定数だけ少し変更していました。
関数を使ってステートマシンコードを簡素化する方法を見つけましょう:
関数テストベンチの最終コード
library ieee;
use ieee.std_logic_1164.all;
use ieee.numeric_std.all;
entity T21_FunctionTb is
end entity;
architecture sim of T21_FunctionTb is
-- シミュレーション高速化のため低クロック周波数
constant ClockFrequencyHz : integer := 100; -- 100 Hz
constant ClockPeriod : time := 1000 ms / ClockFrequencyHz;
signal Clk : std_logic := '1';
signal nRst : std_logic := '0';
signal NorthRed : std_logic;
signal NorthYellow : std_logic;
signal NorthGreen : std_logic;
signal WestRed : std_logic;
signal WestYellow : std_logic;
signal WestGreen : std_logic;
begin
-- Device Under Test (DUT)
i_TrafficLights : entity work.T21_TrafficLights(rtl)
generic map(ClockFrequencyHz => ClockFrequencyHz)
port map (
Clk => Clk,
nRst => nRst,
NorthRed => NorthRed,
NorthYellow => NorthYellow,
NorthGreen => NorthGreen,
WestRed => WestRed,
WestYellow => WestYellow,
WestGreen => WestGreen
);
-- クロック生成プロセス
Clk <= not Clk after ClockPeriod / 2;
-- テストベンチシーケンス
process is
begin
wait until rising_edge(Clk);
wait until rising_edge(Clk);
-- DUTをリセットから解放
nRst <= '1';
wait;
end process;
end architecture;
信号機モジュールの最終コード
library ieee;
use ieee.std_logic_1164.all;
use ieee.numeric_std.all;
entity T21_TrafficLights is
generic(ClockFrequencyHz : natural);
port(
Clk : in std_logic;
nRst : in std_logic; -- 負論理リセット
NorthRed : out std_logic;
NorthYellow : out std_logic;
NorthGreen : out std_logic;
WestRed : out std_logic;
WestYellow : out std_logic;
WestGreen : out std_logic
);
end entity;
architecture rtl of T21_TrafficLights is
-- 列挙型宣言と状態信号宣言
type t_State is (NorthNext, StartNorth, North, StopNorth, WestNext, StartWest, West, StopWest);
signal State : t_State;
-- 分/秒でクロックサイクル数を計算する関数
function CounterVal(Minutes : integer := 0; Seconds : integer := 0) return integer is
variable TotalSeconds : integer;
begin
TotalSeconds := Seconds + Minutes * 60;
return TotalSeconds * ClockFrequencyHz - 1;
end function;
-- クロック周期カウンタ、最大1分
signal Counter : integer range 0 to CounterVal(Minutes => 1) + 1;
begin
process(Clk) is
begin
if rising_edge(Clk) then
if nRst = '0' then
-- リセット値
NorthRed <= '1'; NorthYellow <= '0'; NorthGreen <= '0';
WestRed <= '1'; WestYellow <= '0'; WestGreen <= '0';
State <= NorthNext;
Counter <= 0;
else
-- デフォルト値
NorthRed <= '0'; NorthYellow <= '0'; NorthGreen <= '0';
WestRed <= '0'; WestYellow <= '0'; WestGreen <= '0';
Counter <= Counter + 1;
case State is
-- 全方向赤信号
when NorthNext =>
NorthRed <= '1'; WestRed <= '1';
-- 5秒経過なら
if Counter = CounterVal(Seconds => 5) then
Counter <= 0;
State <= StartNorth;
end if;
-- 南北方向黄信号
when StartNorth =>
NorthRed <= '1'; NorthYellow <= '1'; WestRed <= '1';
if Counter = CounterVal(Seconds => 5) then
Counter <= 0;
State <= North;
end if;
-- 南北方向青信号
when North =>
NorthGreen <= '1'; WestRed <= '1';
if Counter = CounterVal(Minutes => 1) then
Counter <= 0;
State <= StopNorth;
end if;
-- 南北方向赤黄信号
when StopNorth =>
NorthYellow <= '1'; WestRed <= '1';
if Counter = CounterVal(Seconds => 5) then
Counter <= 0;
State <= WestNext;
end if;
-- 全方向赤信号
when WestNext =>
NorthRed <= '1'; WestRed <= '1';
if Counter = CounterVal(Seconds => 5) then
Counter <= 0;
State <= StartWest;
end if;
-- 東西方向黄信号
when StartWest =>
NorthRed <= '1'; WestRed <= '1'; WestYellow <= '1';
if Counter = CounterVal(Seconds => 5) then
Counter <= 0;
State <= West;
end if;
-- 東西方向青信号
when West =>
NorthRed <= '1'; WestGreen <= '1';
if Counter = CounterVal(Minutes => 1) then
Counter <= 0;
State <= StopWest;
end if;
-- 東西方向赤黄信号
when StopWest =>
NorthRed <= '1'; WestYellow <= '1';
if Counter = CounterVal(Seconds => 5) then
Counter <= 0;
State <= NorthNext;
end if;
end case;
end if;
end if;
end process;
end architecture;
ModelSimコンソールでrun 5 minコマンド入力後の波形:

StartNorth状態への遷移前後にカーソルを置いた波形:

分析
前回のチュートリアルのタイマー計算if Counter = ClockFrequencyHz * 5 -1 thenを、新しく作成したCounterVal関数呼び出しif Counter = CounterVal(Seconds => 5) thenに置き換えました。
最初の波形スクリーンショットから、モジュールの機能は変わっていないことがわかります。繰り返しタスクに関数を使用するのは良い設計プラクティスです。特に計算をMinutesやSecondsといった読みやすい用語を含む行に置き換えられる場合に有効です。
関数を使うもう一つの利点は、すべてのタイマー実装を一度に変更できることです。例えばCounterVal関数でreturn TotalSeconds * ClockFrequencyHz;と書いていた場合、すべてのタイマーが1クロック長くなります。これをreturn TotalSeconds * ClockFrequencyHz -1;に変更すれば、すべてのタイマーが一度に修正されます。
最後の波形スクリーンショットを見ると、CounterVal関数から返されるタイマー値から1を引く理由がわかります。この波形はStartNorth状態の継続時間を調べており、正確に5秒であるべきです。State信号がStartNorthに変化するとき、Counter値は0で、次のクロックサイクルでしか変化しません。500クロックサイクルまでカウントしていた場合、StartNorth状態は実際には501サイクル続きます。テストベンチが100Hzで動作しているため、500クロックサイクルはちょうど5秒です。

まとめ
- 関数はゼロ以上のパラメータを取るが、常に値を返す
- 関数は
wait文を含められない - 純粋関数は副作用を持たず、不純関数は副作用を持てる
次のチュートリアルへ »
VHDL
- カッターグラインダー技術の習得:実践ガイド
- モリブデンが現代産業を形作る仕組み:用途、利点、需給動向
- C言語のrealloc()活用ガイド:構文、ベストプラクティス、実例
- C言語free()関数完全マスター:実践ガイドと例
- VHDLで文字列リストを作成する: ベスト・プラクティスと実装例
- VHDLテストベンチ・シミュレーションを優雅に終了させる方法
- VHDLでPWMコントローラを実装: 設計、シミュレーション、FPGAデモ
- VHDLで乱数生成: 一様分布からOSVVMまで
- プロセス内プロシージャでVHDLステートマシンをクリーンに設計
- VHDLにおける不純関数の活用:FSMの可読性と保守性向上
- VHDLで有限ステートマシンを設計:信号機の実践例