はじめに
MicroBlaze V上でZephyrを動作させた時に発生した、割り込み制御の問題と解決策について記述します。
対象バージョン
今回確認したのはv2025.1用の環境です。しかし問題のあるソースコードがmasterブランチの物と一緒でしたので、他のバージョンでも発生します。
URL: https://github.com/Xilinx/zephyr-amd/tree/xilinx_v2025.1
問題
Zephyr(mbv32)でシリアルコンソールを使っていると、たまに出力が止まる現象が起きていました。この現象は主に大量のメッセージを出力している時に発生します。
出力が停止した状態でキー入力を行うと出力処理が再開します。
シリアルコンソールにはAXI UART Liteを利用しており、このデバイスの割り込み信号はEdge Triggerです。
Zephyrの割り込み処理概要
Zephyr(mbv32)ではAXI Interrupt Controllerを利用しています。このドライバはソースツリー内のdrivers/interrupt_controller/intc_xlnx.cです。
割り込み処理はxlnx_irq_handler()で実行しています。この関数の処理概要は以下の通りです。
- xlnx_intc_irq_pending()より割り込み発生状態を取得
- 取得した値から対応する割り込みハンドラを1つだけ実行
- xlnx_intc_irq_acknowledge()で割り込み発生状態をクリア
1 で取得した値は各ビットが割り込み要因に対応しており、割り込み発生状態にある要因について1が設定されます。この値で1が設定されているビットの内、最下位ビットに対応する割り込みのハンドラが実行されます。
原因
原因は最後に実行している割り込み状態のクリア処理です。この処理ではxlnx_intc_irq_acknowledge()を呼び出していますが、この時の引数に誤りがあります。
/* When IRQ is handled and solved by driver, irq should be ACK to interrupt controller */
xlnx_intc_irq_acknowledge(irq_mask);
irq_maskには全ての割り込み発生状態が代入されていますので、上記処理では発生している全ての割り込み状態がクリアされます。
割り込みが複数発生している状況でこの関数を呼ぶと、ハンドラが実行されていない割り込み状態もクリアしてしまい、今回のUART Liteの様に永遠に割り込みハンドラが実行されない形になります。
問題が発生していた環境での割り込みは以下の様に設定していました。
IRQ#0 - Timer
IRQ#1 - UART Lite
今の実装ではTimerとUART Liteで同時に割り込みが発生した場合、Timerの割り込み処理だけ実行した後、TimerとUART Lite双方の割り込み状態がクリアされます。これが原因でシリアルコンソールの出力処理が停止しています。
文字を入力すると出力処理が再開していたのは、受信割り込みが発生する事で割り込みハンドラが実行される為です。
この様な問題は割り込み信号がEdge Triggerのデバイスに対してのみ影響します。Level Triggerの場合は割り込み状態を不用意にクリアされても、デバイスが割り込み信号をアサートし続ける為、再度割り込み処理が実行されます。
調査して気になった点
割り込み状態のクリア処理にはタイミングに関しても問題があります。一般的なタイミングは以下の通りです。
Edge Trigger - 割り込みハンドラ実行前にクリア
Level Trigger - 割り込みハンドラ実行後にクリア
Edge Triggerの割り込み処理では、割り込み状態をハンドラ実行後にクリアすると、ハンドラ実行中に新たな割り込み要因が発生した時に、その割り込みイベントを取りこぼす事があります。この状況を避ける為、割り込み状態をクリアしてからハンドラを実行します。
Level Triggerは割り込みの原因が存在する限り割り込み信号をアサートし続けますので、先にハンドラを実行して割り込み発生の原因を解消してから、割り込み状態をクリアします。
古い割り込みコントローラーを利用している場合は、この様にEdge/Levelを意識した制御を行う必要があります。しかし最近はハード側でうまく対応してくれてEdge/Levelを意識する必要が無い場合があります。
対応方法
割り込み信号のトリガー種別(Edge or Level)を取得
AXI Interrupt ControllerのDevicetreeにはxlnx,kind-of-intrプロパティが定義されており、これが割り込み要因毎のトリガー種別を定義しています。各ビットが割り込み要因に対応しており、0 - Level Trigger, 1 - Edge Triggerと定義されます。
プロパティの設定値は以下の形で取得します。
static uint32_t edge_mask = DT_PROP(DT_INST(0, DT_DRV_COMPAT), xlnx_kind_of_intr);
複数の割り込みコントローラが実装される事もあるので、本来であればデバイス毎に情報管理するのがお行儀の良い実装方法です。しかし現状のソースコードを見ると、実装される割り込みコントローラーは1つという前提で作られている様なので、この様な形にしてあります。
割り込み状態クリア処理を修正
発生した割り込みのトリガー種別を判別して、割り込み状態クリア処理のタイミングを変更します。
修正済したソースコードは下記URLに置いてます。
修正ファイル:drivers/interrupt_controller/intc_xlnx.c
以下は修正イメージの差分です。
static void xlnx_irq_handler(const void *arg)
{
+ static const uint32_t edge_mask = DT_PROP(DT_INST(0, DT_DRV_COMPAT), xlnx_kind_of_intr);
+
uint32_t irq, irq_mask;
struct _isr_table_entry *ite;
uint32_t level = POINTER_TO_UINT(arg);
@@ -207,6 +209,7 @@ static void xlnx_irq_handler(const void *arg)
* needs to be found and _sw_isr_table starting from 0 not 1.
*/
irq -= 1;
+ irq_mask = 1UL << irq;
/* Apply level offset from registration as primary or secondary controller */
irq += level;
@@ -214,11 +217,17 @@ static void xlnx_irq_handler(const void *arg)
/* Call the corresponding IRQ handler in _sw_isr_table */
ite = (struct _isr_table_entry *)&_sw_isr_table[irq];
+ if (irq_mask % edge_mask) {
+ xlnx_intc_irq_acknowledge(irq_mask);
+ }
+
/* Table is already filled by z_irq_spurious calls that's why likely save to call it */
ite->isr(ite->arg);
/* When IRQ is handled and solved by driver, irq should be ACK to interrupt controller */
- xlnx_intc_irq_acknowledge(irq_mask);
+ if (!(irq_mask % edge_mask)) {
+ xlnx_intc_irq_acknowledge(irq_mask);
+ }
}