This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
products:sbc:common:configurations:device-tree-overlay [2022/08/05 03:04] felicia [Make Your Own DTBO Files] |
products:sbc:common:configurations:device-tree-overlay [2023/06/05 03:59] nick [Edit DT Overlays Configuration] |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== Device Tree Overlay ====== | ====== Device Tree Overlay ====== | ||
- | ===== Introduction ===== | + | We can use DT overlays to enable/ |
- | You can use Device Tree Overlay feature to enable or disable the peripherals without recompiling the kernel source code. | + | ===== DT collections |
- | ^ | + | https://github.com/khadas/khadas-linux-kernel-dt-overlays |
- | ^ VIM1 | + | |
- | ^ VIM2 | + | |
- | ^ VIM3 | + | |
- | ^ VIM3L | / | + | |
- | ^ VIM4 | + | |
- | ^ Edge1 | / | + | |
- | | ::: | + | |
- | <tabbox VIM1/ | + | ===== Device Reference Table ====== |
- | <WRAP tip > | + | ^ ^ DT overlays folder |
- | In this documentation will take VIM3 as an example, it can be different from yours but the structure is the same. | + | ^ VIM1 | / |
- | </WRAP> | + | ^ VIM2 | / |
+ | ^ | ||
+ | ^ VIM3L | ||
+ | ^ VIM1S | ||
+ | ^ VIM4 | / | ||
+ | ^ New VIM4 | / | ||
+ | ^ Edge2 | ||
+ | ^ Edge1 | ||
+ | | ::: | / | ||
+ | ===== Device Configurations ===== | ||
- | The dtbo files are stored in directory '' | + | <tabbox VIM1/2/3/3L/Edge1> |
- | ```txt | + | DT-overlays '' |
- | khadas@Khadas:~$ ll / | + | |
- | total 40 | + | |
- | drwxr-xr-x 2 root root 4096 Jan 29 11:13 ./ | + | |
- | drwxr-xr-x 6 root root 4096 Jan 29 11:13 ../ | + | |
- | -rw-r--r-- 1 root root 352 Jan 29 09:35 disable-ts050.dtbo | + | |
- | -rw-r--r-- 1 root root 223 Jan 29 09:35 i2c3.dtbo | + | |
- | -rw-r--r-- 1 root root 277 Jan 29 09:35 m2x-eth.dtbo | + | |
- | -rw-r--r-- 1 root root 472 Jan 29 09:35 onewire.dtbo | + | |
- | -rw-r--r-- 1 root root 1072 Jan 29 09:35 os08a10.dtbo | + | |
- | -rw-r--r-- 1 root root 345 Jan 29 09:35 pwm_f.dtbo | + | |
- | -rw-r--r-- 1 root root 447 Jan 29 09:35 spi1.dtbo | + | |
- | -rw-r--r-- 1 root root 225 Jan 29 09:35 uart3.dtbo | + | |
- | ``` | + | |
<WRAP important > | <WRAP important > | ||
- | **#BOARD#** should be '' | + | **BOARD** should be '' |
</ | </ | ||
- | The releated dtbo configuration file is ''/ | + | <WRAP tip > |
+ | Next example for VIM3 device, which can be different for other device, but the structure | ||
+ | </ | ||
```shell | ```shell | ||
+ | khadas@Khadas: | ||
+ | disable-ts050.dtbo | ||
+ | i2c3.dtbo | ||
+ | m2x-eth.dtbo | ||
+ | onewire.dtbo | ||
+ | os08a10.dtbo | ||
+ | pwm_f.dtbo | ||
+ | spi1.dtbo | ||
+ | uart3.dtbo | ||
+ | ``` | ||
+ | |||
+ | DT-overlays configuration file: | ||
+ | |||
+ | ```txt / | ||
# Device Tree Overlays | # Device Tree Overlays | ||
# | # | ||
Line 59: | Line 63: | ||
``` | ``` | ||
- | '' | + | * default '' |
+ | * If you want to disable '' | ||
+ | * If you want to enable '' | ||
- | * If you want to disable '' | + | <tabbox VIM4> |
- | * If you want to enable | + | DT-overlays |
- | <tabbox VIM4> | + | ```shell |
+ | khadas@Khadas: | ||
+ | ext_board.dtbo | ||
+ | i2cm_a.dtbo | ||
+ | i2cm_f.dtbo | ||
+ | pwm_f.dtbo | ||
+ | uart_e.dtbo | ||
+ | ``` | ||
- | The dtbo files are stored in directory | + | DT-overlays configuration file: ''/ |
+ | <tabbox VIM1S> | ||
+ | |||
+ | DT-overlays '' | ||
+ | |||
+ | ```shell | ||
+ | khadas@Khadas: | ||
+ | i2cm_b.dtbo | ||
+ | i2cm_e.dtbo | ||
+ | pwm_f.dtbo | ||
+ | uart_c.dtbo | ||
``` | ``` | ||
- | khadas@Khadas: | + | DT-overlays configuration file is '' |
- | total 28 | + | |
- | drwxr-xr-x 2 root root 4096 Jul 6 14:55 . | + | |
- | drwxr-xr-x 3 root root 4096 Jul 6 14:55 .. | + | |
- | -rwxr-xr-x 1 root root 462 Jul 6 14:55 ext_board.dtbo | + | |
- | -rwxr-xr-x 1 root root 223 Jul 6 14:55 i2cm_a.dtbo | + | |
- | -rwxr-xr-x 1 root root 223 Jul 6 14:55 i2cm_f.dtbo | + | |
- | -rwxr-xr-x 1 root root 225 Jul 6 14:55 pwm_f.dtbo | + | |
- | -rwxr-xr-x 1 root root 225 Jul 6 14:55 uart_e.dtbo | + | |
- | ``` | + | |
- | The releated | + | <tabbox Edge2> |
+ | |||
+ | DT-overlays '' | ||
+ | |||
+ | ```shell | ||
+ | khadas@Khadas: | ||
+ | mipi-panel.dtbo | ||
+ | ``` | ||
+ | DT-overlays configuration file: ''/ | ||
</ | </ | ||
- | ===== Configuration ===== | + | ===== Configuration |
- | If you want to enable the peripherals, | + | You need to edit the DT overlays |
+ | ===== Make custom DT Overlays ===== | ||
- | ===== Make Your Own DTBO Files ===== | + | There are some preparations steps for DT overlays '' |
- | There are some preparations using dtbo files, you can also add your own dtbos to enable or disable the peripherals. | + | ==== Write DT Overlay Source==== |
+ | Basic DT overlay source example: | ||
- | * Write your own Device Tree Overlay file, for example '' | + | ```dts example.dts |
/dts-v1/; | /dts-v1/; | ||
/plugin/; | /plugin/; | ||
Line 111: | Line 135: | ||
``` | ``` | ||
- | * Compile | + | ==== Compile |
- | khadas@Khadas: | + | |
- | khadas@Khadas: | + | ```sh |
- | example.dtbo | + | dtc -I dts -O dtb -o example.dtbo example.dts |
``` | ``` | ||
- | * Copy the dtbo file to dtbo directory | + | ==== Copy DT Overlays |
- | * VIM1/2/3/3L/Edge1 is ''/ | + | |
- | * VIM4 is ''/ | + | |
- | **#BOARD#** should be '' | + | * VIM1S is ''/ |
+ | * Edge2 is ''/ | ||
+ | * VIM1/2/ | ||
+ | |||
+ | <WRAP important > | ||
+ | **BOARD** should be '' | ||
</ | </ | ||
- | * Edit dtbo configuration file and add '' | + | ==== Edit DT Overlays Configuration ==== |
- | * VIM1/ | + | |
- | * VIM4 is ''/ | + | Edit list variable value inside DT overlay |
+ | |||
+ | * VIM1/ | ||
+ | * VIM4 is ''/ | ||
+ | * VIM1S is ''/ | ||
+ | * Edge2 is ''/ | ||
+ | |||
+ | ==== Reboot ==== | ||
- | * Reboot the board | + | Need reboot |