コグノスケ

ZephyrのDevice Tree Overlay

目次: Zephyr

ZephyrはプロジェクトごとにDevice Treeを上書きできます。Device Tree Overlayと呼ばれたりもしますね。やり方は違いますがLinuxでも似たような仕組みがあります。

具体的にはsamples/hello_worldの下にboardsというディレクトリを作成し、ボード名.overlayというファイルを作成するだけです。Zephyrのビルドシステムが勝手に検知してくれます。便利ですね。

今回はqemu_riscv64向けに作りますからファイル名はqemu_riscv64.overlayになります。

samples/hello_world/
├──CMakeLists.txt
├──README.rst
├──boards
│   └──qemu_riscv64.overlay    ★これ★
├──prj.conf
├──sample.yaml
└──src
    └──main.c

/* samples/hello_world/boards/qemu_riscv64.overlay */

/ {
	resources {
		compatible = "test-overlay";
		value1 = <1>;
		value2 = <10>;
	};
};

Overlayが効いているかどうかはビルド後に生成されるzephyr/zephyr.dtsを見るとわかります。

/dts-v1/;

/ {
	#address-cells = < 0x1 >;
	#size-cells = < 0x1 >;
	compatible = "riscv-virtio";
	model = "riscv-virtio,qemu";
	flash@20000000 {
		bank-width = < 0x4 >;
		reg = < 0x20000000 0x2000000 0x22000000 0x2000000 >;
		compatible = "cfi-flash";
	};

/* (略) */

	chosen {
		zephyr,console = &uart0;
		zephyr,shell-uart = &uart0;
		zephyr,sram = &ram0;
	};
	resources {    /* ★追加された★ */
		compatible = "test-overlay";
		value1 = < 0x1 >;
		value2 = < 0xa >;
	};
};

Overlayのcompatibleとプロパティは適当です。当然compatibleに対応するコードはありませんが、今の段階ではエラーにはなりません。

Overlayの次は

デフォルトで無効化されているデバイスを有効にする（status = "okay"; を足したい）くらいであれば、Overlayファイルの追加だけでも十分に役立ちます。

しかしZephyrはもう少し複雑な機能も提供しています。次回は独自のcompatibleを扱う方法をご紹介したいと思います。