Khadas Docs

Amazing Khadas, always amazes you!

User Tools

Site Tools

Home / products / sbc / common / configurations / device-tree-overlay
products:sbc:common:configurations:device-tree-overlay

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
products:sbc:common:configurations:device-tree-overlay [2022/09/28 09:04]
nick [Make custom DT overlays] 		products:sbc:common:configurations:device-tree-overlay [2026/05/11 02:18] (current)
nick
Line 1: Line 1:
-====== Device Tree Overlay ======+====== Device tree overlay ======
  
 We can use DT overlays to enable/disable or change configuration for peripherals without recompiling the DT kernel source code. We can use DT overlays to enable/disable or change configuration for peripherals without recompiling the DT kernel source code.
  
-===== Device Reference Table ======+===== DT collections  =====
  
-^         ^  DT overlays folder                                 ^  DT overlays list variable  ^  DT overlays config file                           ^ +https://github.com/khadas/khadas-linux-kernel-dt-overlays
-^  VIM1   |  /boot/dtb/overlays/kvim                               |  overlays          |  /boot/env.txt                                            | +
-^  VIM2   |  /boot/dtb/overlays/kvim2                              | :::                | :::                                                       | +
-^  VIM3   |  /boot/dtb/overlays/kvim3                              | :::                | :::                                                       | +
-^  VIM3L  |  /boot/dtb/overlays/kvim3l                             | :::                | :::                                                       | +
-^  VIM1S  |  /boot/dtb/amlogic/kvim1s.dtb.overlays                 |  fdt_overlays      |  /boot/dtb/amlogic/kvim1s.dtb.overlay.env                 | +
-^  VIM4   |  /boot/dtb/amlogic/kvim4.dtb.overlays                  | :::                |  /boot/dtb/amlogic/kvim4.dtb.overlay.env                  | +
-^  Edge2  |  /boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlays  |  :::               |  /boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlay.env  | +
-^  Edge1  |  /boot/dtb/rockchip/overlays/caption                   |  overlays          |  /boot/env.txt                                            | +
-| :::     |  /boot/dtb/rockchip/overlays/edgev                     | :::                | :::                                                       |+
  
-===== Device Configurations =====+===== Device reference table ====== 
 + 
 +^         ^  Kernel Version  ^  DT overlays folder                                    ^  DT overlays list variable  ^  DT overlays config file                                  ^ 
 +^  VIM1   |  4.9/mainline    |  /boot/dtb/overlays/kvim                               |  overlays                   |  /boot/env.txt                                            | 
 +^  VIM2   |  4.9/mainline    |  /boot/dtb/overlays/kvim2                              | :::                         | :::                                                       | 
 +^  VIM3   |  4.9/mainline    |  /boot/dtb/overlays/kvim3                              | :::                         | :::                                                       | 
 +| :::     |  5.15            |  /boot/dtb/amlogic/kvim3.dtb.overlays                  |  fdt_overlays               |  /boot/dtb/amlogic/kvim3l.dtb.overlay.env                 | 
 +^  VIM3L  |  4.9/mainline    |  /boot/dtb/overlays/kvim3l                             |  overlays                   |  /boot/env.txt                                            | 
 +| :::     |  5.15            |  /boot/dtb/amlogic/kvim3l.dtb.overlays                 |  fdt_overlays               |  /boot/dtb/amlogic/kvim3l.dtb.overlay.env                 | 
 +^  VIM1S  |  5.4/5.15        |  /boot/dtb/amlogic/kvim1s.dtb.overlays                 | :::                         |  /boot/dtb/amlogic/kvim1s.dtb.overlay.env                 | 
 +^  VIM4   |  5.4/5.15        |  /boot/dtb/amlogic/kvim4.dtb.overlays                  | :::                         |  /boot/dtb/amlogic/kvim4.dtb.overlay.env                  | 
 +^  Edge2  |  5.10            |  /boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlays  | :::                         |  /boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlay.env  | 
 +^ Edge-2L |  6.1             |  /boot/dtb/rockchip/rk3576-khadas-edge-2l.dtb.overlays  | :::                         |  /boot/dtb/rockchip/rk3576-khadas-edge-2l.dtb.overlay.env  | 
 +^  Edge1  |  4.4             |  /boot/dtb/rockchip/overlays/captain                   |  overlays                   |  /boot/env.txt                                            | 
 +| :::     | :::              |  /boot/dtb/rockchip/overlays/edgev                     | :::                         | :::                                                       | 
 + 
 +===== Device configurations =====
  
 <tabbox VIM1/2/3/3L/Edge1> <tabbox VIM1/2/3/3L/Edge1>
Line 61: Line 68:
   * If you want to disable ''pwm_f'' you can remove ''pwm_f'' from ''overlays'' list variable   * If you want to disable ''pwm_f'' you can remove ''pwm_f'' from ''overlays'' list variable
   * If you want to enable ''onewire'', you can add ''onewire'' to ''overlays'' list variable   * If you want to enable ''onewire'', you can add ''onewire'' to ''overlays'' list variable
 +
 +<tabbox VIM3 with 5.15 kernel>
 +
 +DT-overlays ''dtbo'' directory: ''/boot/dtb/amlogic/kvim3.dtb.overlays''.
 +
 +```shell
 +khadas@Khadas:~$ ls -1 /boot/dtb/amlogic/kvim3.dtb.overlays/
 +uart3.dtbo
 +pwm_f.dtbo
 +i2c3.dtbo
 +spi1.dtbo
 +os08a10.dtbo
 +onewire.dtbo
 +disable-ts050.dtbo
 +m2x-eth.dtbo
 +otg-device.dtbo
 +```
 +
 +DT-overlays configuration file: ''/boot/dtb/amlogic/kvim3.dtb.overlay.env''.
 +
 +<tabbox VIM3L with 5.15 kernel>
 +
 +DT-overlays ''dtbo'' directory: ''/boot/dtb/amlogic/kvim3l.dtb.overlays''.
 +
 +```shell
 +khadas@Khadas:~$ ls -1 /boot/dtb/amlogic/kvim3.dtb.overlays/
 +uart3.dtbo
 +pwm_f.dtbo
 +i2c3.dtbo
 +spi1.dtbo
 +os08a10.dtbo
 +onewire.dtbo
 +disable-ts050.dtbo
 +m2x-eth.dtbo
 +otg-device.dtbo
 +```
 +
 +DT-overlays configuration file: ''/boot/dtb/amlogic/kvim3l.dtb.overlay.env''.
  
 <tabbox VIM4> <tabbox VIM4>
  
-DT-overlays ''dtbo'' directory: ''/boot/dtb/amlogic/kvim4.dtb.overlays''+DT-overlays ''dtbo'' directory: ''/boot/dtb/amlogic/kvim4.dtb.overlays''.
  
 ```shell ```shell
Line 100: Line 145:
  
 DT-overlays configuration file: ''/boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlay.env'' DT-overlays configuration file: ''/boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlay.env''
 +
 +<tabbox Edge-2L>
 +
 +DT-overlays ''dtbo'' directory: ''/boot/dtb/rockchip/rk3576-khadas-edge-2l.dtb.overlays''
 +
 +```shell
 +khadas@Khadas:~$ ls /boot/dtb/rockchip/rk3576-khadas-edge-2l.dtb.overlays
 +edge-2l-io-pwm.dtbo
 +edge-2l-io-spi.dtbo
 +```
 +
 +DT-overlays configuration file: ''/boot/dtb/rockchip/rk3576-khadas-edge-2l.dtb.overlay.env''
  
 </tabbox> </tabbox>
  
-===== Configuration DT Overlays =====+===== Configuration DT overlays =====
  
-Need edit the DT overlays configuration file and add custom DT overlays ''dtbo'' files to special folder.+You need to edit the DT overlays configuration file and add custom DT overlays ''dtbo'' files to special folder.
  
-===== Make custom DT Overlays =====+===== Make custom DT overlays =====
  
 There are some preparations steps for DT overlays ''dtbo'' files, you can also add custom DT overlays. There are some preparations steps for DT overlays ''dtbo'' files, you can also add custom DT overlays.
  
-==== Write DT Overlay Source====+==== Write DT overlay source====
  
 Basic  DT overlay source example: Basic  DT overlay source example:
Line 130: Line 187:
 ``` ```
  
-==== Compile DT Overlay Source ====+==== Compile DT overlay source ====
  
 ```sh ```sh
Line 136: Line 193:
 ``` ```
  
-==== Copy DT Overlays to Special Folder ====+==== Copy DT overlays to special folder ====
  
 +  * VIM3 with 5.15 kernel is ''/boot/dtb/amlogic/kvim3.dtb.overlays'' 
 +  * VIM3L with 5.15 kernel is ''/boot/dtb/amlogic/kvim3l.dtb.overlays'' 
   * VIM4 is ''/boot/dtb/amlogic/kvim4.dtb.overlays''    * VIM4 is ''/boot/dtb/amlogic/kvim4.dtb.overlays'' 
   * VIM1S is ''/boot/dtb/amlogic/kvim1s.dtb.overlays''   * VIM1S is ''/boot/dtb/amlogic/kvim1s.dtb.overlays''
   * Edge2 is ''/boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlays''   * Edge2 is ''/boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlays''
 +  * Edge-2L is ''/boot/dtb/rockchip/rk3576-khadas-edge-2l.dtb.overlays''
   * VIM1/2/3/3L/Edge1 is ''/boot/dtb/overlays/%%*%%*BOARD%%*%%*''    * VIM1/2/3/3L/Edge1 is ''/boot/dtb/overlays/%%*%%*BOARD%%*%%*'' 
  
Line 147: Line 207:
 </WRAP> </WRAP>
  
-==== Edit DT Overlays Configuration ====+==== Edit DT overlays configuration ====
  
 Edit list variable value inside DT overlay configuration file: Edit list variable value inside DT overlay configuration file:
    
   * VIM1/2/3/3L/Edge1 is ''/boot/env.txt''   * VIM1/2/3/3L/Edge1 is ''/boot/env.txt''
 +  * VIM3 with 5.15 kernel is ''/boot/dtb/amlogic/kvim3.dtb.overlay.env''
 +  * VIM3L with 5.15 kernel is ''/boot/dtb/amlogic/kvim3l.dtb.overlay.env''
   * VIM4 is ''/boot/dtb/amlogic/kvim4.dtb.overlay.env''   * VIM4 is ''/boot/dtb/amlogic/kvim4.dtb.overlay.env''
   * VIM1S is ''/boot/dtb/amlogic/kvim4.dtb.overlay.env''   * VIM1S is ''/boot/dtb/amlogic/kvim4.dtb.overlay.env''
   * Edge2 is ''/boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlay.env''   * Edge2 is ''/boot/dtb/rockchip/rk3588s-khadas-edge2.dtb.overlay.env''
 +  * Edge-2L is ''/boot/dtb/rockchip/rk3576-khadas-edge-2l.dtb.overlay.env''
  
 ==== Reboot ==== ==== Reboot ====
  
 Need reboot board to take effect. Need reboot board to take effect.
Last modified: 2022/09/28 09:04 by nick

Page Tools

Khadas Site

Khadas Community

Khadas GitHub

Khadas Downloads