Skip to contentSkip to conversation

An effort to bring DT bindings compliance within U-Boot

PATCH Superseded Sumit Garg 9 participants 36 messages Jan 10, 2024 – Jan 31, 2024

Subsystems (4)

v4 of 6 Superseded Latest is v6 →

lore
Share & tools
lore

Sumit Garg

author
#0 lore raw

v4 cover An effort to bring DT bindings compliance within U-Boot

Changes in v4:
--------------
- Switched subtree to be imported as dts/upstream sub-directory rather than devicetree-rebasing sub-directory to better suite U-Boot directory structure.
- Since we now have v6.7-dts tag available now, so switch subtree to that from its beginning.
- Patch #2: Incorporate build fix to adjust Bindings Makefile rules to old U-Boot Kbuild infrastructure.
- Patch #3: Incorporate fix to resolve rk3399 migration issue reported by Simon.
- Patch #4: New patch to reuse upstream DT includes by U-Boot as per Brian's use-case for TI K3 SoCs.
- Patch #5: Added a note to OF_UPSTREAM Kconfig option.
- Patch #6: New patch to add script dts/update-dts-subtree.sh as per Rob's comments.
- Patch #7: Separate patch to align documentation to use Kconfig symbols instead.
- Patch #8: Clarify subtree uprev schedule as a separate documentation section. Also, fixed documentation typos.
- Patch #9: Added commit description.

Changes in v3:
--------------
- Patch #4: Minor commit message update
- Patch #5: Replace CONFIG_* with Kconfig options
- Patch #7: Dropped Makefile portion and enabled OF_UPSTREAM for SoC instead.
- Patch #1, #3, #6 and #8: Picked up review tags

Changes in v2:
--------------
- Patch #1: excluded gitab CI config check and added commit description.
- Patch #3: s/UBOOT_DTSI_LOC/u_boot_dtsi_loc/
- Patch #4: s/DEVICE_TREE_LOC/dt_dir/ and s/U-boot/U-Boot/
- Patch #5: s/U-boot/U-Boot/
- Patch #6 and #7: Picked up review tags

Prerequisite
------------

This patch series requires devicetree-rebasing git repo to be added as a subtree to the main U-Boot repo via:

$ git subtree add --prefix dts/upstream \
      git://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git \
      v6.7-dts --squash

Background
----------

This effort started while I was reviewing patch series corresponding to Qcom platforms [1] which was about to import modified devicetree source files from Linux kernel. I suppose keeping devicetree files sync with Linux kernel without any DT bindings schema validation has been a pain for U-Boot SoC/platform maintainers. There has been past discussions about a single DT repo but that hasn't come up and Linux kernel remained the place where DT source files as well as bindings are placed and maintained.

However, Linux kernel DT maintainers proposed [2] for U-Boot to rather use devicetree-rebasing repo [3] which is a forked copy from Linux kernel for DT source files as well as bindings. It is tagged at every Linux kernel major release or intermideate release candidates. So here I have tried to reuse that to bring DT bingings compliance as well as a standard way to maintain a regular sync of DT source files with Linux kernel.

In order to maintain devicetree files sync, U-Boot will maintains a Git subtree for devicetee-rebasing repo as dts/upstream sub-directory. U-Boot will regularly sync dts/upstream/ subtree whenever the next window opens with the next available kernel major release. dts/update-dts-subtree.sh script provides a wrapper around git subtree pull command, usage from the top level U-Boot source tree, run:

$ ./dts/update-dts-subtree.sh <devicetree-rebasing-release-tag>

The RFC/prototype for this series has been discussed with Linux DT maintainers as well as U-Boot maintainers here [4]. Now we would like to reach out to wider U-Boot community to seek feedback.

[1] https://lore.kernel.org/all/CAFA6WYMLUD9cnkr=R0Uur+1UeTMkKjM2zDdMJtXb3nmrLk+pDg@mail.gmail.com/
[2] https://lore.kernel.org/all/CAL_JsqKEjv2tSGmT+0ZiO7_qbBfhTycbGnhJhYpKDFzfO9jzDg@mail.gmail.com/
[3] https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/
[4] https://github.com/u-boot/u-boot/pull/451

Changes
-------

Traditionally, U-Boot placed copies of devicetree source files from Linux kernel into arch/<arch>/dts/<name>.dts which can be selected via setting "<name>" when prompted for DEFAULT_DEVICE_TREE by Kconfig.

SoC/board maintainers are encouraged to migrate to use synced copies from dts/upstream/src/<arch>/<vendor>. To do that enable OF_UPSTREAM for the SoC being used via Kconfig and set up "<vendor>/<name>" when prompted for DEFAULT_DEVICE_TREE by Kconfig.

An example have been shown for Amlogic meson-gxbb SoC and corresponding derived boards via patch #10 and #11.

Devicetree bindings schema checks
---------------------------------

With devicetee-rebasing Git subtree, the devicetree bindings are also regularly synced with Linux kernel as dts/upstream/Bindings/ sub-directory. This allows U-Boot to run devicetree bindings schema checks which will bring compliance to U-Boot core/drivers regarding usage of devicetree.

Dependencies
------------

The DT schema project must be installed in order to validate the DT schema binding documents and validate DTS files using the DT schema. The DT schema project can be installed with pip:

$ pip3 install dtschema

Note that 'dtschema' installation requires 'swig' and Python development files installed first. On Debian/Ubuntu systems:

$ apt install swig python3-dev

Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be installed. Ensure they are in your PATH (~/.local/bin by default).

Recommended is also to install yamllint (used by dtschema when present).

$ apt install yamllint

Running checks
--------------

In order to perform validation of DTB files, use the ``dtbs_check`` target:

$ make dtbs_check

It is also possible to run checks with a subset of matching schema files by setting the ``DT_SCHEMA_FILES`` variable to 1 or more specific schema files or patterns (partial match of a fixed string). Each file or pattern should be separated by ':'.

$ make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml:rtc.yaml
$ make dtbs_check DT_SCHEMA_FILES=/gpio/
$ make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml

Sumit Garg (11):
CI: Exclude devicetree-rebasing subtree for CONFIG checks
Makefile: Add support for DT bindings schema checks scripts/Makefile.lib: Statically define *-u-boot.dtsi files location
Makefile: Allow upstream DT subtree to provide DT includes
dts: Add alternative location for upstream DTB builds
dts: Add script to uprev dts/upstream subtree
doc: devicetree: Align documentation to use Kconfig options
doc: devicetree: Updates for devicetree-rebasing subtree
MAINTAINERS: Add myself as devicetree-rebasing maintainer
dts: meson-gxbb: Switch to using upstream DT
dts: meson-gxbb: Drop redundant devicetree files

 .azure-pipelines.yml                    |   3 +-
 .gitlab-ci.yml                          |   3 +-
 MAINTAINERS                             |   5 +
 Makefile                                |  23 +-
 arch/arm/dts/Makefile                   |   8 -
 arch/arm/dts/meson-gxbb-kii-pro.dts     | 140 ----
 arch/arm/dts/meson-gxbb-nanopi-k2.dts   | 426 ------------
 arch/arm/dts/meson-gxbb-odroidc2.dts    | 414 -----------
 arch/arm/dts/meson-gxbb-p200.dts        | 100 ---
 arch/arm/dts/meson-gxbb-p201.dts        |  26 -
 arch/arm/dts/meson-gxbb-p20x.dtsi       | 250 -------
 arch/arm/dts/meson-gxbb-wetek-hub.dts   |  58 --
 arch/arm/dts/meson-gxbb-wetek-play2.dts | 119 ----
 arch/arm/dts/meson-gxbb-wetek.dtsi      | 292 --------
 arch/arm/dts/meson-gxbb.dtsi            | 870 ------------------------
 arch/arm/mach-meson/Kconfig             |   1 +
 configs/nanopi-k2_defconfig             |   2 +-
 configs/odroid-c2_defconfig             |   2 +-
 configs/p200_defconfig                  |   2 +-
 configs/p201_defconfig                  |   2 +-
 configs/videostrong-kii-pro_defconfig   |   2 +-
 configs/wetek-hub_defconfig             |   2 +-
 configs/wetek-play2_defconfig           |   2 +-
 doc/develop/devicetree/control.rst      | 158 +++--
 dts/Kconfig                             |  16 +
 dts/Makefile                            |  17 +-
 dts/update-dts-subtree.sh               |  24 +
 dts/upstream/Bindings/Makefile          |   6 +-
 dts/upstream/src/arm64/Makefile         |  14 +
 scripts/Makefile.lib                    |  49 +-
 30 files changed, 256 insertions(+), 2780 deletions(-)
 delete mode 100644 arch/arm/dts/meson-gxbb-kii-pro.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-nanopi-k2.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-odroidc2.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-p200.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-p201.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-p20x.dtsi
 delete mode 100644 arch/arm/dts/meson-gxbb-wetek-hub.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-wetek-play2.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-wetek.dtsi
 delete mode 100644 arch/arm/dts/meson-gxbb.dtsi
 create mode 100755 dts/update-dts-subtree.sh
 create mode 100644 dts/upstream/src/arm64/Makefile
Signature · 1 line
2.34.1
author
#1 lore raw

PATCH v4 1/11 CI: Exclude devicetree-rebasing subtree for CONFIG checks

Since devicetree-rebasing is an external repo with its own coding style, exclude it from Azure and gitlab CI CONFIG checks.

---

Changes in v4:
- Switched subtree to be imported as dts/upstream sub-directory rather than devicetree-rebasing sub-directory to better suite U-Boot directory structure.

Changes in v3:
- Picked up review tags

Changes in v2:
- excluded gitab CI config check and added commit description.

 .azure-pipelines.yml | 3 ++-
 .gitlab-ci.yml       | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)
.azure-pipelines.yml +2 -1
index b9d6aa98a0b..97c88bc2a5e 100644
@@ -65,7 +65,8 @@ stages:
       # have no matches.
       - script: git grep -E '^#[[:blank:]]*(define|undef)[[:blank:]]*CONFIG_'
                   :^doc/ :^arch/arm/dts/ :^scripts/kconfig/lkc.h
-                  :^include/linux/kconfig.h :^tools/ && exit 1 || exit 0
+                  :^include/linux/kconfig.h :^tools/ :^dts/upstream/ &&
+                  exit 1 || exit 0
 
   - job: docs
     displayName: 'Build documentation'
.gitlab-ci.yml +2 -1
index fbf99f0322a..6362f2857c5 100644
@@ -161,7 +161,8 @@ check for new CONFIG symbols outside Kconfig:
     # have no matches.
     - git grep -E '^#[[:blank:]]*(define|undef)[[:blank:]]*CONFIG_'
         :^doc/ :^arch/arm/dts/ :^scripts/kconfig/lkc.h
-        :^include/linux/kconfig.h :^tools/ && exit 1 || exit 0
+        :^include/linux/kconfig.h :^tools/ :^dts/upstream/ &&
+        exit 1 || exit 0
 
 # build documentation
 docs:
Signature · 1 line
2.34.1
author
#2 lore raw

PATCH v4 2/11 Makefile: Add support for DT bindings schema checks

In reply to Sumit Garg

This adds the build infrastructure for checking DT binding schema documents and validating dtb files using the binding schema. Here we use devicetree-rebasing subtree to provide the DT bindings. Along with that adapt dts/upstream/Bindings/Makefile to align with old U-Boot Kbuild infrastructure.

Dependency:
-----------

The DT schema project must be installed in order to validate the DT schema binding documents and validate DTS files using the DT schema. The DT schema project can be installed with pip::

pip3 install dtschema

Note that 'dtschema' installation requires 'swig' and Python development files installed first. On Debian/Ubuntu systems::

apt install swig python3-dev

Testing:
--------

Build dts files and check using DT binding schema:

$ make dtbs_check

Optionally, DT_SCHEMA_FILES can be passed in with a schema file(s) to use for validation. This makes it easier to find and fix errors generated by a specific schema.

Note, at this point dtbs_check is an optional build target as there are many warnings generated due to custom DT properties used by many platforms in u-boot. It is expected with these checks that compliance with DT bindings to take place. Once that's done it can be added to CI builds to remain compliant with DT bindings.

---

Changes in v4:
- Switched subtree to be imported as dts/upstream sub-directory rather than devicetree-rebasing sub-directory to better suite U-Boot directory structure.
- Incorporate build fix to adjust Bindings Makefile rules to old U-Boot Kbuild infrastructure.

Changes in v3:
- None

Changes in v2:
- None

 Makefile                       | 20 ++++++++++++++++++--
 dts/upstream/Bindings/Makefile |  6 +++---
 scripts/Makefile.lib           | 17 +++++++++++++++--
 3 files changed, 36 insertions(+), 7 deletions(-)
Makefile +18 -2
index a519397ef71..69cffb16ee2 100644
@@ -1158,12 +1158,28 @@ endif
 	@# disabling OF_BOARD.
 	$(call cmd,ofcheck,$(KCONFIG_CONFIG))
 
-PHONY += dtbs
+PHONY += dtbs dtbs_check
 dtbs: dts/dt.dtb
 	@:
-dts/dt.dtb: u-boot
+dts/dt.dtb: dtbs_prepare u-boot
 	$(Q)$(MAKE) $(build)=dts dtbs
 
+dtbs_prepare: prepare3
+
+ifneq ($(filter dtbs_check, $(MAKECMDGOALS)),)
+export CHECK_DTBS=y
+endif
+
+ifneq ($(CHECK_DTBS),)
+dtbs_prepare: dt_binding_check
+endif
+
+dtbs_check: dt_binding_check dtbs
+
+DT_BINDING_DIR := dts/upstream/Bindings
+dt_binding_check: scripts_dtc
+	$(Q)$(MAKE) $(build)=$(DT_BINDING_DIR) $(DT_BINDING_DIR)/processed-schema.json
+
 quiet_cmd_copy = COPY    $@
       cmd_copy = cp $< $@
 
dts/upstream/Bindings/Makefile +3 -3
index 3e886194b04..e799963a599 100644
@@ -47,9 +47,9 @@ quiet_cmd_mk_schema = SCHEMA  $@
 		      rm -f $$f
 
 define rule_chkdt
-	$(if $(DT_SCHEMA_LINT),$(call cmd,yamllint),)
-	$(call cmd,chk_bindings)
-	$(call cmd,mk_schema)
+	$(if $(DT_SCHEMA_LINT),$(call echo-cmd,yamllint) $(cmd_yamllint),); \
+	$(call echo-cmd,chk_bindings) $(cmd_chk_bindings); \
+	$(call echo-cmd,mk_schema) $(cmd_mk_schema)
 endef
 
 DT_DOCS = $(patsubst $(srctree)/%,%,$(shell $(find_all_cmd)))
scripts/Makefile.lib +15 -2
index 1ca84195c99..f82b3169e87 100644
@@ -356,8 +356,21 @@ endif
 
 dtsi_include_list_deps = $(addprefix $(obj)/,$(subst $(quote),,$(dtsi_include_list)))
 
-$(obj)/%.dtb: $(src)/%.dts $(DTC) $(dtsi_include_list_deps) FORCE
-	$(call if_changed_dep,dtc)
+ifneq ($(CHECK_DTBS),)
+DT_CHECKER ?= dt-validate
+DT_CHECKER_FLAGS ?= $(if $(DT_SCHEMA_FILES),-l $(DT_SCHEMA_FILES),-m)
+DT_BINDING_DIR := dts/upstream/Bindings
+DT_TMP_SCHEMA := $(objtree)/$(DT_BINDING_DIR)/processed-schema.json
+
+quiet_cmd_dtb = DTC_CHK $@
+      cmd_dtb = $(cmd_dtc) ; $(DT_CHECKER) $(DT_CHECKER_FLAGS) -u $(srctree)/$(DT_BINDING_DIR) -p $(DT_TMP_SCHEMA) $@ || true
+else
+quiet_cmd_dtb = $(quiet_cmd_dtc)
+      cmd_dtb = $(cmd_dtc)
+endif
+
+$(obj)/%.dtb: $(src)/%.dts $(DTC) $(dtsi_include_list_deps) $(DT_TMP_SCHEMA) FORCE
+	$(call if_changed_dep,dtb)
 
 pre-tmp = $(subst $(comma),_,$(dot-target).pre.tmp)
 dtc-tmp = $(subst $(comma),_,$(dot-target).dts.tmp)
Signature · 1 line
2.34.1
author
#3 lore raw

PATCH v4 3/11 scripts/Makefile.lib: Statically define *-u-boot.dtsi files location

In reply to Sumit Garg

Allow u-boot to build DTB from a different directory tree such that *-u-boot.dtsi files can be included from a common location. Currently that location is arch/$(ARCH)/dts/, so statically define that common location.

This is needed for platform owners to start building DTB files from devicetree-rebasing directory but still being able to include *-u-boot.dtsi files.

---

Changes in v4:
- Incorporate fix to resolve rk3399 migration issue reported by Simon.

Changes in v3:
- Picked up review tags

Changes in v2:
- s/UBOOT_DTSI_LOC/u_boot_dtsi_loc/

 scripts/Makefile.lib | 27 +++++++++++++++------------
 1 file changed, 15 insertions(+), 12 deletions(-)
scripts/Makefile.lib +15 -12
index f82b3169e87..fe2a0aadc41 100644
@@ -159,18 +159,20 @@ cpp_flags      = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(UBOOTINCLUDE)     \
 ld_flags       = $(KBUILD_LDFLAGS) $(ldflags-y) $(LDFLAGS_$(@F))
 
 # Try these files in order to find the U-Boot-specific .dtsi include file
-u_boot_dtsi_options = $(strip $(wildcard $(dir $<)$(basename $(notdir $<))-u-boot.dtsi) \
-	$(wildcard $(dir $<)$(subst $\",,$(CONFIG_SYS_SOC))-u-boot.dtsi) \
-	$(wildcard $(dir $<)$(subst $\",,$(CONFIG_SYS_CPU))-u-boot.dtsi) \
-	$(wildcard $(dir $<)$(subst $\",,$(CONFIG_SYS_VENDOR))-u-boot.dtsi) \
-	$(wildcard $(dir $<)u-boot.dtsi))
+u_boot_dtsi_loc = $(srctree)/arch/$(ARCH)/dts/
+
+u_boot_dtsi_options = $(strip $(wildcard $(u_boot_dtsi_loc)$(basename $(notdir $<))-u-boot.dtsi) \
+	$(wildcard $(u_boot_dtsi_loc)$(subst $\",,$(CONFIG_SYS_SOC))-u-boot.dtsi) \
+	$(wildcard $(u_boot_dtsi_loc)$(subst $\",,$(CONFIG_SYS_CPU))-u-boot.dtsi) \
+	$(wildcard $(u_boot_dtsi_loc)$(subst $\",,$(CONFIG_SYS_VENDOR))-u-boot.dtsi) \
+	$(wildcard $(u_boot_dtsi_loc)u-boot.dtsi))
 
 u_boot_dtsi_options_raw = $(warning Automatic .dtsi inclusion: options: \
-	$(dir $<)$(basename $(notdir $<))-u-boot.dtsi \
-	$(dir $<)$(subst $\",,$(CONFIG_SYS_SOC))-u-boot.dtsi \
-	$(dir $<)$(subst $\",,$(CONFIG_SYS_CPU))-u-boot.dtsi \
-	$(dir $<)$(subst $\",,$(CONFIG_SYS_VENDOR))-u-boot.dtsi \
-	$(dir $<)u-boot.dtsi ... \
+	$(u_boot_dtsi_loc)$(basename $(notdir $<))-u-boot.dtsi \
+	$(u_boot_dtsi_loc)$(subst $\",,$(CONFIG_SYS_SOC))-u-boot.dtsi \
+	$(u_boot_dtsi_loc)$(subst $\",,$(CONFIG_SYS_CPU))-u-boot.dtsi \
+	$(u_boot_dtsi_loc)$(subst $\",,$(CONFIG_SYS_VENDOR))-u-boot.dtsi \
+	$(u_boot_dtsi_loc)u-boot.dtsi ... \
 	found: $(if $(u_boot_dtsi_options),"$(u_boot_dtsi_options)",nothing!))
 
 # Uncomment for debugging
@@ -190,6 +192,7 @@ dtsi_include_list += $(CONFIG_DEVICE_TREE_INCLUDES)
 dtc_cpp_flags  = -Wp,-MD,$(depfile).pre.tmp -nostdinc                    \
 		 $(UBOOTINCLUDE)                                         \
 		 -I$(dir $<)                                             \
+		 -I$(u_boot_dtsi_loc)                                     \
 		 -I$(srctree)/arch/$(ARCH)/dts/include                   \
 		 -I$(srctree)/include                                    \
 		 -D__ASSEMBLY__                                          \
@@ -328,7 +331,7 @@ cmd_dtc = mkdir -p $(dir ${dtc-tmp}) ; \
 	  echo '$(pound)include "$(f)"' >> $(pre-tmp);) \
 	$(HOSTCC) -E $(dtc_cpp_flags) -x assembler-with-cpp -o $(dtc-tmp) $(pre-tmp) ; \
 	$(DTC) -O dtb -o $@ -b 0 \
-		-i $(dir $<) $(DTC_FLAGS) \
+		-i $(dir $<) -i $(u_boot_dtsi_loc) $(DTC_FLAGS) \
 		-d $(depfile).dtc.tmp $(dtc-tmp) || \
 		(echo "Check $(shell pwd)/$(pre-tmp) for errors" && false) \
 		; \
@@ -354,7 +357,7 @@ ifdef CONFIG_EFI_CAPSULE_AUTHENTICATE
 dtsi_include_list += $(capsule_esl_dtsi)
 endif
 
-dtsi_include_list_deps = $(addprefix $(obj)/,$(subst $(quote),,$(dtsi_include_list)))
+dtsi_include_list_deps = $(addprefix $(u_boot_dtsi_loc),$(subst $(quote),,$(dtsi_include_list)))
 
 ifneq ($(CHECK_DTBS),)
 DT_CHECKER ?= dt-validate
Signature · 1 line
2.34.1
author
#4 lore raw

PATCH v4 4/11 Makefile: Allow upstream DT subtree to provide DT includes

In reply to Sumit Garg

Allow platforms to reuse DT headers and dtsi includes directly form upstream DT subtree which will be frequently synced with Linux kernel. This will further allow us to drop corresponding DT includes copy from U-Boot tree.

Also, since the DT includes from upstream DT subtree are done after DT includes from U-Boot tree, so it shouldn't cause any conflicts.

---

Changes in v4:
- New patch to reuse upstream DT includes by U-Boot as per Brian's use-case for TI K3 SoCs.

 Makefile             | 3 ++-
 scripts/Makefile.lib | 5 +++++
 2 files changed, 7 insertions(+), 1 deletion(-)
Makefile +2 -1
index 69cffb16ee2..d4e65ffe49f 100644
@@ -835,7 +835,8 @@ UBOOTINCLUDE    := \
 				-I$(srctree)/arch/arm/thumb1/include), \
 			-I$(srctree)/arch/arm/thumb1/include)) \
 	-I$(srctree)/arch/$(ARCH)/include \
-	-include $(srctree)/include/linux/kconfig.h
+	-include $(srctree)/include/linux/kconfig.h \
+	-I$(srctree)/dts/upstream/include
 
 NOSTDINC_FLAGS += -nostdinc -isystem $(shell $(CC) -print-file-name=include)
 
scripts/Makefile.lib +5 -0
index fe2a0aadc41..fbcaf335f9a 100644
@@ -189,12 +189,17 @@ dtsi_include_list = $(strip $(u_boot_dtsi_options_debug) \
 dtsi_include_list += $(CONFIG_DEVICE_TREE_INCLUDES)
 
 # Modified for U-Boot
+upstream_dtsi_include = $(addprefix -I, $(srctree)/dts/upstream/src/ \
+	$(sort $(dir $(wildcard $(srctree)/dts/upstream/src/$(ARCH)/*/*))) \
+	$(if (CONFIG_ARM64), \
+		 $(sort $(dir $(wildcard $(srctree)/dts/upstream/src/arm64/*/*)))))
 dtc_cpp_flags  = -Wp,-MD,$(depfile).pre.tmp -nostdinc                    \
 		 $(UBOOTINCLUDE)                                         \
 		 -I$(dir $<)                                             \
 		 -I$(u_boot_dtsi_loc)                                     \
 		 -I$(srctree)/arch/$(ARCH)/dts/include                   \
 		 -I$(srctree)/include                                    \
+		 $(upstream_dtsi_include)                                \
 		 -D__ASSEMBLY__                                          \
 		 -undef -D__DTS__
 
Signature · 1 line
2.34.1
author
#5 lore raw

PATCH v4 5/11 dts: Add alternative location for upstream DTB builds

In reply to Sumit Garg

Allow platform owners to mirror devicetree files from devitree-rebasing directory into dts/upstream/src/$(ARCH) (special case for arm64). Then build then along with any *-u-boot.dtsi file present in arch/$(ARCH)/dts directory. Also add a new Makefile for arm64.

This will help easy migration for platforms which currently are compliant with upstream Linux kernel devicetree files.

---

Changes in v4:
- Switched subtree to be imported as dts/upstream sub-directory rather than devicetree-rebasing sub-directory to better suite U-Boot directory structure.
- Added a note to OF_UPSTREAM Kconfig option.

Changes in v3:
- Minor commit message update

Changes in v2:
- s/DEVICE_TREE_LOC/dt_dir/ and s/U-boot/U-Boot/

 dts/Kconfig                     | 16 ++++++++++++++++
 dts/Makefile                    | 17 ++++++++++++++---
 dts/upstream/src/arm64/Makefile | 14 ++++++++++++++
 3 files changed, 44 insertions(+), 3 deletions(-)
 create mode 100644 dts/upstream/src/arm64/Makefile
dts/Kconfig +16 -0
index 00c0aeff893..09789d3e18b 100644
@@ -85,6 +85,22 @@ config OF_LIVE
 	  enables a live tree which is available after relocation,
 	  and can be adjusted as needed.
 
+config OF_UPSTREAM
+	bool "Enable use of devicetree imported from Linux kernel release"
+	help
+	  Traditionally, U-Boot platforms used to have their custom devicetree
+	  files or copy devicetree files from Linux kernel which are hard to
+	  maintain and can usually get out-of-sync from Linux kernel. This
+	  option enables platforms to migrate to devicetree-rebasing repo where
+	  a regular sync will be maintained every major Linux kernel release
+	  cycle. However, platforms can still have some custom u-boot specific
+	  bits maintained as part of *-u-boot.dtsi files.
+
+	  Note: This option should be set in Kconfig, for the SoC as a whole.
+	  However, newer boards whose devicetree source files haven't landed in
+	  the dts/upstream subtree, they can override this option to have the
+	  DT build from existing U-Boot tree location instead.
+
 choice
 	prompt "Provider of DTB for DT control"
 	depends on OF_CONTROL
dts/Makefile +14 -3
index 3437e54033d..d6c2c9daf31 100644
@@ -10,10 +10,20 @@ ifeq ($(DEVICE_TREE),)
 DEVICE_TREE := unset
 endif
 
+ifeq ($(CONFIG_OF_UPSTREAM),y)
+ifeq ($(CONFIG_ARM64),y)
+dt_dir := dts/upstream/src/arm64
+else
+dt_dir := dts/upstream/src/$(ARCH)
+endif
+else
+dt_dir := arch/$(ARCH)/dts
+endif
+
 ifneq ($(EXT_DTB),)
 DTB := $(EXT_DTB)
 else
-DTB := arch/$(ARCH)/dts/$(DEVICE_TREE).dtb
+DTB := $(dt_dir)/$(DEVICE_TREE).dtb
 endif
 
 $(obj)/dt-$(SPL_NAME).dtb: dts/dt.dtb $(objtree)/tools/fdtgrep FORCE
@@ -41,7 +51,7 @@ $(DTB): arch-dtbs
 
 PHONY += arch-dtbs
 arch-dtbs:
-	$(Q)$(MAKE) $(build)=arch/$(ARCH)/dts dtbs
+	$(Q)$(MAKE) $(build)=$(dt_dir) dtbs
 
 ifeq ($(CONFIG_SPL_BUILD),y)
 obj-$(CONFIG_OF_EMBED) := dt-spl.dtb.o
@@ -65,4 +75,5 @@ clean-files := dt.dtb.S
 # Let clean descend into dts directories
 subdir- += ../arch/arc/dts ../arch/arm/dts ../arch/m68k/dts ../arch/microblaze/dts	\
 	   ../arch/mips/dts ../arch/nios2/dts ../arch/powerpc/dts ../arch/riscv/dts	\
-	   ../arch/sandbox/dts ../arch/sh/dts ../arch/x86/dts ../arch/xtensa/dts
+	   ../arch/sandbox/dts ../arch/sh/dts ../arch/x86/dts ../arch/xtensa/dts	\
+	   ./upstream/src/arm64 ./upstream/src/$(ARCH)
dts/upstream/src/arm64/Makefile new file +14 -0
new file mode 100644
index 00000000000..9a8f6aa3584
@@ -0,0 +1,14 @@
+# SPDX-License-Identifier: GPL-2.0+
+
+include $(srctree)/scripts/Makefile.dts
+
+targets += $(dtb-y)
+
+# Add any required device tree compiler flags here
+DTC_FLAGS += -a 0x8
+
+PHONY += dtbs
+dtbs: $(addprefix $(obj)/, $(dtb-y))
+	@:
+
+clean-files := */*.dtb */*.dtbo
Signature · 1 line
2.34.1
author
#6 lore raw

PATCH v4 6/11 dts: Add script to uprev dts/upstream subtree

In reply to Sumit Garg

dts/update-dts-subtree.sh is just a wrapper around git subtree pull command. Usage from the top level U-Boot source tree, run:

$ ./dts/update-dts-subtree.sh <release-tag>

---

Changes in v4:
- New patch to add script dts/update-dts-subtree.sh as per Rob's comments.

 dts/update-dts-subtree.sh | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100755 dts/update-dts-subtree.sh
dts/update-dts-subtree.sh new file +24 -0
new file mode 100755
index 00000000000..2077094d0d2
@@ -0,0 +1,24 @@
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0+
+#
+# Copyright 2024 Linaro Ltd.
+#
+# Usage: from the top level U-Boot source tree, run:
+# $ ./dts/update-dts-subtree.sh <release-tag>
+#
+# The script will pull changes from devicetree-rebasing repo into U-Boot
+# as a subtree located as <U-Boot>/dts/upstream sub-directory. It will
+# automatically create a squash/merge commit listing the commits imported.
+
+set -e
+
+merge_commit_msg=$(cat << EOF
+Subtree merge tag '$1' of devicetree-rebasing repo [1] into dts/upstream
+
+[1] https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/
+EOF
+)
+
+git subtree pull --prefix dts/upstream \
+    git://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git \
+    $1 --squash -m "${merge_commit_msg}"
Signature · 1 line
2.34.1
author
#7 lore raw

PATCH v4 7/11 doc: devicetree: Align documentation to use Kconfig options

In reply to Sumit Garg

Since U-Boot switched away from manual CONFIG_* defines to Kconfig options, align devicetree documentation accordingly.

---

Changes in v4:
- Separate patch to align documentation to use Kconfig symbols instead.

 doc/develop/devicetree/control.rst | 50 ++++++++++++++----------------
 1 file changed, 23 insertions(+), 27 deletions(-)
doc/develop/devicetree/control.rst +23 -27
index 11c92d440f4..75d5e02aaec 100644
@@ -29,7 +29,7 @@ a number of similar boards with different peripherals, you can describe
 the features of each board in the devicetree file, and have a single
 generic source base.
 
-To enable this feature, add CONFIG_OF_CONTROL to your board config file.
+To enable this feature, select `OF_CONTROL` via Kconfig.
 
 
 What is a Flattened Devicetree?
@@ -81,12 +81,8 @@ Failing that, you could write one from scratch yourself!
 Configuration
 -------------
 
-Use::
-
-   #define CONFIG_DEFAULT_DEVICE_TREE	"<name>"
-
-to set the filename of the devicetree source. Then put your devicetree
-file into::
+Set up "<name>" when prompted for `DEFAULT_DEVICE_TREE` by Kconfig. Then put
+your devicetree file into::
 
    arch/<arch>/dts/<name>.dts
 
@@ -94,24 +90,24 @@ This should include your CPU or SOC's devicetree file, placed in
 `arch/<arch>/dts`, and then make any adjustments required using a u-boot-dtsi
 file for your board.
 
-If CONFIG_OF_EMBED is defined, then it will be picked up and built into
+If `OF_EMBED` is selected by Kconfig, then it will be picked up and built into
 the U-Boot image (including u-boot.bin). This is suitable for debugging
 and development only and is not recommended for production devices.
 
-If CONFIG_OF_SEPARATE is defined, then it will be built and placed in
+If `OF_SEPARATE` is selected by Kconfig, then it will be built and placed in
 a u-boot.dtb file alongside u-boot-nodtb.bin with the combined result placed
-in u-boot.bin so you can still just flash u-boot.bin onto your board. If you are
-using CONFIG_SPL_FRAMEWORK, then u-boot.img will be built to include the device
-tree binary.
+in u-boot.bin so you can still just flash u-boot.bin onto your board. If Kconfig
+option `SPL_FRAMEWORK` is enabled, then u-boot.img will be built to include the
+device tree binary.
 
-If CONFIG_OF_BOARD is defined, a board-specific routine will provide the
+If `OF_BOARD` is selected by Kconfig, a board-specific routine will provide the
 devicetree at runtime, for example if an earlier bootloader stage creates
 it and passes it to U-Boot.
 
-If CONFIG_BLOBLIST is defined, the devicetree may come from a bloblist passed
-from a previous stage, if present.
+If `BLOBLIST` is selected by Kconfig, the devicetree may come from a bloblist
+passed from a previous stage, if present.
 
-If CONFIG_SANDBOX is defined, then it will be read from a file on
+If `SANDBOX` is selected by Kconfig, then it will be read from a file on
 startup. Use the -d flag to U-Boot to specify the file to read, -D for the
 default and -T for the test devicetree, used to run sandbox unit tests.
 
@@ -145,7 +141,7 @@ Build:
 After the board configuration is done, fdt supported u-boot can be built in two
 ways:
 
-#  build the default dts which is defined from CONFIG_DEFAULT_DEVICE_TREE::
+#  build the default dts which is selected by DEFAULT_DEVICE_TREE Kconfig::
 
     $ make
 
@@ -198,8 +194,8 @@ As mentioned above, the U-Boot build system automatically includes a
 `*-u-boot.dtsi` file, if found, containing U-Boot specific
 quirks. However, some data, such as the mentioned public keys, are not
 appropriate for upstream U-Boot but are better kept and maintained
-outside the U-Boot repository. You can use CONFIG_DEVICE_TREE_INCLUDES
-to specify a list of .dtsi files that will also be included when
+outside the U-Boot repository. You can use `DEVICE_TREE_INCLUDES` Kconfig
+option to specify a list of .dtsi files that will also be included when
 building .dtb files.
 
 
@@ -213,14 +209,14 @@ The full devicetree is available to U-Boot proper, but normally only a subset
 'SPL Support' in doc/driver-model/design.rst for more details.
 
 
-Using several DTBs in the SPL (CONFIG_SPL_MULTI_DTB)
-----------------------------------------------------
+Using several DTBs in the SPL (SPL_MULTI_DTB_FIT Kconfig option)
+----------------------------------------------------------------
 In some rare cases it is desirable to let SPL be able to select one DTB among
 many. This usually not very useful as the DTB for the SPL is small and usually
 fits several platforms. However the DTB sometimes include information that do
 work on several platforms (like IO tuning parameters).
-In this case it is possible to use CONFIG_SPL_MULTI_DTB. This option appends to
-the SPL a FIT image containing several DTBs listed in SPL_OF_LIST.
+In this case it is possible to use SPL_MULTI_DTB_FIT Kconfig option. This option
+appends to the SPL a FIT image containing several DTBs listed in SPL_OF_LIST.
 board_fit_config_name_match() is called to select the right DTB.
 
 If board_fit_config_name_match() relies on DM (DM driver to access an EEPROM
@@ -247,16 +243,16 @@ architectures.
 
 It is important to understand that the fdt only selects options
 available in the platform / drivers. It cannot add new drivers (yet). So
-you must still have the CONFIG option to enable the driver. For example,
-you need to define CONFIG_SYS_NS16550 to bring in the NS16550 driver,
+you must still have the Kconfig option to enable the driver. For example,
+you need to enable SYS_NS16550 Kconfig option to bring in the NS16550 driver,
 but can use the fdt to specific the UART clock, peripheral address, etc.
-In very broad terms, the CONFIG options in general control *what* driver
+In very broad terms, the Kconfig options in general control *what* driver
 files are pulled in, and the fdt controls *how* those files work.
 
 History
 -------
 
-U-Boot configuration was previous done using CONFIG options in the board
+U-Boot configuration was previous done using Kconfig options in the board
 config file. This eventually got out of hand with nearly 10,000 options.
 
 U-Boot adopted devicetrees around the same time as Linux and early boards
Signature · 1 line
2.34.1
#8 lore raw

Re: [PATCH v4 07/11] doc: devicetree: Align documentation to use Kconfig options

doc/develop/devicetree/control.rst architectures. · line 256

Quoted 6 lines · Sumit Garg

History
-------

doc/develop/devicetree/control.rst +1 -1
-U-Boot configuration was previous done using CONFIG options in the board
+U-Boot configuration was previous done using Kconfig options in the board
 config file. This eventually got out of hand with nearly 10,000 options.

It seems that the original text should be preserved here.

author
#9 lore raw

Re: [PATCH v4 07/11] doc: devicetree: Align documentation to use Kconfig options

Quoted 11 lines · Fabio Estevam

doc/develop/devicetree/control.rst architectures. · line 256

Quoted 6 lines · Sumit Garg

History
-------

doc/develop/devicetree/control.rst +1 -1
-U-Boot configuration was previous done using CONFIG options in the board
+U-Boot configuration was previous done using Kconfig options in the board
 config file. This eventually got out of hand with nearly 10,000 options.

It seems that the original text should be preserved here.

Ah, you are right. I can preserve that in the next spin if I receive further feedback otherwise I hope Tom can fix it up while applying.

-Sumit

author
#10 lore raw

PATCH v4 8/11 doc: devicetree: Updates for devicetree-rebasing subtree

In reply to Sumit Garg

Encourage SoC/board maintainers to migrate to using devicetree-rebasing subtree and maintain a regular sync with Linux kernel devicetree files and bindings.

Along with that add documentation regarding how to run DT bindings schema checks.

---

Changes in v4:
- Switched subtree to be imported as dts/upstream sub-directory rather than devicetree-rebasing sub-directory to better suite U-Boot directory structure.
- Since we now have v6.7-dts tag available now, so switch subtree to that from its beginning.
- Clarify subtree uprev schedule as a separate documentation section. Also, fixed documentation typos.

Changes in v3:
- Replace CONFIG_* with Kconfig options

Changes in v2:
- s/U-boot/U-Boot/

 doc/develop/devicetree/control.rst | 112 +++++++++++++++++++++++------
 1 file changed, 92 insertions(+), 20 deletions(-)
doc/develop/devicetree/control.rst +92 -20
index 75d5e02aaec..c8789ef7209 100644
@@ -1,5 +1,6 @@
 .. SPDX-License-Identifier: GPL-2.0+
 .. sectionauthor:: Copyright 2011 The Chromium OS Authors
+.. Copyright 2023-2024 Linaro Ltd.
 
 Devicetree Control in U-Boot
 ============================
@@ -22,12 +23,11 @@ for three reasons:
   hierarchical format
 - It is fairly efficient to read incrementally
 
-The arch/<arch>/dts directories contains a Makefile for building the devicetree
-blob and embedding it in the U-Boot image. This is useful since it allows
-U-Boot to configure itself according to what it finds there. If you have
-a number of similar boards with different peripherals, you can describe
-the features of each board in the devicetree file, and have a single
-generic source base.
+The U-Boot Makefile infrastructure allows for building the devicetree blob
+and embedding it in the U-Boot image. This is useful since it allows U-Boot
+to configure itself according to what it finds there. If you have a number
+of similar boards with different peripherals, you can describe the features
+of each board in the devicetree file, and have a single generic source base.
 
 To enable this feature, select `OF_CONTROL` via Kconfig.
 
@@ -68,8 +68,14 @@ a binary file. U-Boot adds its own `fdtgrep` for creating subsets of the file.
 Where do I get a devicetree file for my board?
 ----------------------------------------------
 
-You may find that the Linux kernel has a suitable file. Look in the
-kernel source in arch/<arch>/boot/dts.
+Linux kernel Git repository has been the place where devicetree files along
+with devicetree bindings are stored and maintained. There is devicetee-rebasing
+(dtrepo_) which maintains a forked copy of devicetree files along with bindings
+at every Linux kernel major release or intermediate release candidates.
+
+U-Boot maintains a Git subtree for devicetee-rebasing repo as `dts/upstream/`
+sub-directory. You may find that the `dts/upstream/` sub-directory has a
+suitable devicetree file for your board. Look in `dts/upstream/src/<arch>/`.
 
 If not you might find other boards with suitable files that you can
 modify to your needs. Look in the board directories for files with a
@@ -78,17 +84,33 @@ modify to your needs. Look in the board directories for files with a
 Failing that, you could write one from scratch yourself!
 
 
+Resyncing with devicetree-rebasing
+----------------------------------
+
+U-Boot regularly sync `dts/upstream/` subtree whenever the next window opens
+with the next available kernel major release. `dts/update-dts-subtree.sh` script
+provides a wrapper around git subtree pull command, usage from the top level
+U-Boot source tree, run::
+
+    ./dts/update-dts-subtree.sh <devicetree-rebasing-release-tag>
+
+
 Configuration
 -------------
 
-Set up "<name>" when prompted for `DEFAULT_DEVICE_TREE` by Kconfig. Then put
-your devicetree file into::
+Traditionally, U-Boot placed copies of devicetree source files from Linux
+kernel into `arch/<arch>/dts/<name>.dts` which can be selected via setting
+"<name>" when prompted for `DEFAULT_DEVICE_TREE` by Kconfig.
 
-   arch/<arch>/dts/<name>.dts
+However, it has become cumbersome over time for each SoC/board maintainer to
+keep devicetree files in sync with Linux kernel. Therefore, SoC/board
+maintainers are encouraged to migrate to use synced copies from
+`dts/upstream/src/<arch>/<vendor>`. To do that enable `OF_UPSTREAM` for the
+SoC being used via Kconfig and set up "<vendor>/<name>" when prompted for
+`DEFAULT_DEVICE_TREE` by Kconfig.
 
-This should include your CPU or SOC's devicetree file, placed in
-`arch/<arch>/dts`, and then make any adjustments required using a u-boot-dtsi
-file for your board.
+This should include your CPU or SOC's devicetree file. On top of that any U-Boot
+specific tweaks (see: dttweaks_) can be made for your board.
 
 If `OF_EMBED` is selected by Kconfig, then it will be picked up and built into
 the U-Boot image (including u-boot.bin). This is suitable for debugging
@@ -155,8 +177,9 @@ ways:
 Adding tweaks for U-Boot
 ------------------------
 
-It is strongly recommended that devicetree files in U-Boot are an exact copy of
-those in Linux, so that it is easy to sync them up from time to time.
+With `dts/upstream` Git subtree, it is ensured that devicetree files in U-Boot
+are an exact copy of those in Linux kernel available under
+`dts/upstream/src/<arch>/<vendor>`.
 
 U-Boot is of course a very different project from Linux, e.g. it operates under
 much more restrictive memory and code-size constraints. Where Linux may use a
@@ -169,8 +192,8 @@ constraints are even more extreme and the devicetree is shrunk to remove
 unwanted nodes, or even turned into C code to avoid access overhead.
 
 U-Boot automatically looks for and includes a file with updates to the standard
-devicetree for your board, searching for them in the same directory as the
-main file, in this order::
+devicetree for your board, searching for them in `arch/<arch>/dts/` in this
+order::
 
    <orig_filename>-u-boot.dtsi
    <CONFIG_SYS_SOC>-u-boot.dtsi
@@ -199,6 +222,54 @@ option to specify a list of .dtsi files that will also be included when
 building .dtb files.
 
 
+Devicetree bindings schema checks
+---------------------------------
+
+With devicetee-rebasing Git subtree, the devicetree bindings are also regularly
+synced with Linux kernel as `dts/upstream/Bindings/` sub-directory. This
+allows U-Boot to run devicetree bindings schema checks which will bring
+compliance to U-Boot core/drivers regarding usage of devicetree.
+
+Dependencies
+~~~~~~~~~~~~
+
+The DT schema project must be installed in order to validate the DT schema
+binding documents and validate DTS files using the DT schema. The DT schema
+project can be installed with pip::
+
+    pip3 install dtschema
+
+Note that 'dtschema' installation requires 'swig' and Python development files
+installed first. Please, refer to the GCC build documentation for installation
+instructions :doc:`../../build/gcc`.
+
+Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be
+installed. Ensure they are in your PATH (~/.local/bin by default).
+
+Recommended is also to install yamllint (used by dtschema when present). On
+Debian/Ubuntu systems::
+
+    apt install yamllint
+
+Running checks
+~~~~~~~~~~~~~~
+
+In order to perform validation of DTB files, use the ``dtbs_check`` target::
+
+    make dtbs_check
+
+It is also possible to run checks with a subset of matching schema files by
+setting the ``DT_SCHEMA_FILES`` variable to 1 or more specific schema files or
+patterns (partial match of a fixed string). Each file or pattern should be
+separated by ':'.
+
+::
+
+    make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml:rtc.yaml
+    make dtbs_check DT_SCHEMA_FILES=/gpio/
+    make dtbs_check DT_SCHEMA_FILES=trivial-devices.yaml
+
+
 Relocation, SPL and TPL
 -----------------------
 
@@ -260,8 +331,9 @@ used it before Linux (e.g. snow). The two projects developed in parallel
 and there are still some differences in the bindings for certain boards.
 While there has been discussion of having a separate repository for devicetree
 files, in practice the Linux kernel Git repository has become the place where
-these are stored, with U-Boot taking copies and adding tweaks with u-boot.dtsi
-files.
+these are stored, with U-Boot taking copies via devicetree-rebasing repo
+(see: dtrepo_) and adding tweaks with u-boot.dtsi files.
 
 .. _dtspec: https://www.devicetree.org/specifications/
 .. _dtlist: https://www.spinics.net/lists/devicetree-compiler/
+.. _dtrepo: https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git
Signature · 1 line
2.34.1
author
#11 lore raw

PATCH v4 9/11 MAINTAINERS: Add myself as devicetree-rebasing maintainer

In reply to Sumit Garg

Add myself as devicetree-rebasing maintainer.

---

Changes in v4:
- Switched subtree to be imported as dts/upstream sub-directory rather than devicetree-rebasing sub-directory to better suite U-Boot directory structure.
- Added commit description.

Changes in v3:
- Picked up review tags

Changes in v2:
- Picked up review tags

 MAINTAINERS | 5 +++++
 1 file changed, 5 insertions(+)
MAINTAINERS +5 -0
index 4fec063a242..39b5c01a5e0 100644
@@ -957,6 +957,11 @@ F:	cmd/cyclic.c
 F:	common/cyclic.c
 F:	include/cyclic.h
 
+DEVICETREE REBASING SUBTREE
+M:	Sumit Garg <[email protected]>
+S:	Maintained
+F:	dts/upstream/
+
 DFU
 M:	Lukasz Majewski <[email protected]>
 M:	Mattijs Korpershoek <[email protected]>
Signature · 1 line
2.34.1
author
#12 lore raw

PATCH v4 10/11 dts: meson-gxbb: Switch to using upstream DT

In reply to Sumit Garg

Although there were still some variations in board DTS files based on meson-gxbb SoC but I think those were minor differences from upstream and shouldn't impact boot on these devices.

So enable OF_UPSTREAM to use upstream DT and add amlogic/ prefix to the DEFAULT_DEVICE_TREE. And thereby directly build DTB from dts/upstream/src/ including *-u-boot.dtsi files from arch/$(ARCH)/dts/ directory.

---

Changes in v4:
- Picked up review tag

Changes in v3:
- Dropped Makefile portion and enabled OF_UPSTREAM for SoC instead.

Changes in v2:
- Picked up review tag

 arch/arm/mach-meson/Kconfig           | 1 +
 configs/nanopi-k2_defconfig           | 2 +-
 configs/odroid-c2_defconfig           | 2 +-
 configs/p200_defconfig                | 2 +-
 configs/p201_defconfig                | 2 +-
 configs/videostrong-kii-pro_defconfig | 2 +-
 configs/wetek-hub_defconfig           | 2 +-
 configs/wetek-play2_defconfig         | 2 +-
 8 files changed, 8 insertions(+), 7 deletions(-)
arch/arm/mach-meson/Kconfig +1 -0
index d6c89058061..8ddb59161a0 100644
@@ -25,6 +25,7 @@ choice
 config MESON_GXBB
 	bool "GXBB"
 	select MESON_GX
+	imply OF_UPSTREAM
 	help
 	  Select this if your SoC is an S905
 
configs/nanopi-k2_defconfig +1 -1
index 41dbf7981f8..2e1c756bf7a 100644
@@ -6,7 +6,7 @@ CONFIG_HAS_CUSTOM_SYS_INIT_SP_ADDR=y
 CONFIG_CUSTOM_SYS_INIT_SP_ADDR=0x20000000
 CONFIG_ENV_SIZE=0x2000
 CONFIG_DM_GPIO=y
-CONFIG_DEFAULT_DEVICE_TREE="meson-gxbb-nanopi-k2"
+CONFIG_DEFAULT_DEVICE_TREE="amlogic/meson-gxbb-nanopi-k2"
 CONFIG_OF_LIBFDT_OVERLAY=y
 CONFIG_DM_RESET=y
 CONFIG_DEBUG_UART_BASE=0xc81004c0
configs/odroid-c2_defconfig +1 -1
index 5f9f323e06e..ce5eaec3cd2 100644
@@ -6,7 +6,7 @@ CONFIG_HAS_CUSTOM_SYS_INIT_SP_ADDR=y
 CONFIG_CUSTOM_SYS_INIT_SP_ADDR=0x20000000
 CONFIG_ENV_SIZE=0x2000
 CONFIG_DM_GPIO=y
-CONFIG_DEFAULT_DEVICE_TREE="meson-gxbb-odroidc2"
+CONFIG_DEFAULT_DEVICE_TREE="amlogic/meson-gxbb-odroidc2"
 CONFIG_OF_LIBFDT_OVERLAY=y
 CONFIG_DM_RESET=y
 CONFIG_DEBUG_UART_BASE=0xc81004c0
configs/p200_defconfig +1 -1
index cd579ef5f14..b6946034795 100644
@@ -6,7 +6,7 @@ CONFIG_HAS_CUSTOM_SYS_INIT_SP_ADDR=y
 CONFIG_CUSTOM_SYS_INIT_SP_ADDR=0x20000000
 CONFIG_ENV_SIZE=0x2000
 CONFIG_DM_GPIO=y
-CONFIG_DEFAULT_DEVICE_TREE="meson-gxbb-p200"
+CONFIG_DEFAULT_DEVICE_TREE="amlogic/meson-gxbb-p200"
 CONFIG_OF_LIBFDT_OVERLAY=y
 CONFIG_DM_RESET=y
 CONFIG_DEBUG_UART_BASE=0xc81004c0
configs/p201_defconfig +1 -1
index b2f0a0ccdb4..dcc1454be16 100644
@@ -7,7 +7,7 @@ CONFIG_HAS_CUSTOM_SYS_INIT_SP_ADDR=y
 CONFIG_CUSTOM_SYS_INIT_SP_ADDR=0x20000000
 CONFIG_ENV_SIZE=0x2000
 CONFIG_DM_GPIO=y
-CONFIG_DEFAULT_DEVICE_TREE="meson-gxbb-p201"
+CONFIG_DEFAULT_DEVICE_TREE="amlogic/meson-gxbb-p201"
 CONFIG_OF_LIBFDT_OVERLAY=y
 CONFIG_DM_RESET=y
 CONFIG_DEBUG_UART_BASE=0xc81004c0
configs/videostrong-kii-pro_defconfig +1 -1
index 3eda8f14a21..7a5af234471 100644
@@ -6,7 +6,7 @@ CONFIG_HAS_CUSTOM_SYS_INIT_SP_ADDR=y
 CONFIG_CUSTOM_SYS_INIT_SP_ADDR=0x20000000
 CONFIG_ENV_SIZE=0x2000
 CONFIG_DM_GPIO=y
-CONFIG_DEFAULT_DEVICE_TREE="meson-gxbb-kii-pro"
+CONFIG_DEFAULT_DEVICE_TREE="amlogic/meson-gxbb-kii-pro"
 CONFIG_OF_LIBFDT_OVERLAY=y
 CONFIG_DM_RESET=y
 CONFIG_DEBUG_UART_BASE=0xc81004c0
configs/wetek-hub_defconfig +1 -1
index fd92b041e73..85cff73f50f 100644
@@ -6,7 +6,7 @@ CONFIG_HAS_CUSTOM_SYS_INIT_SP_ADDR=y
 CONFIG_CUSTOM_SYS_INIT_SP_ADDR=0x20000000
 CONFIG_ENV_SIZE=0x2000
 CONFIG_DM_GPIO=y
-CONFIG_DEFAULT_DEVICE_TREE="meson-gxbb-wetek-hub"
+CONFIG_DEFAULT_DEVICE_TREE="amlogic/meson-gxbb-wetek-hub"
 CONFIG_OF_LIBFDT_OVERLAY=y
 CONFIG_DM_RESET=y
 CONFIG_DEBUG_UART_BASE=0xc81004c0
configs/wetek-play2_defconfig +1 -1
index b887419a6ba..efdf820165b 100644
@@ -6,7 +6,7 @@ CONFIG_HAS_CUSTOM_SYS_INIT_SP_ADDR=y
 CONFIG_CUSTOM_SYS_INIT_SP_ADDR=0x20000000
 CONFIG_ENV_SIZE=0x2000
 CONFIG_DM_GPIO=y
-CONFIG_DEFAULT_DEVICE_TREE="meson-gxbb-wetek-play2"
+CONFIG_DEFAULT_DEVICE_TREE="amlogic/meson-gxbb-wetek-play2"
 CONFIG_OF_LIBFDT_OVERLAY=y
 CONFIG_DM_RESET=y
 CONFIG_DEBUG_UART_BASE=0xc81004c0
Signature · 1 line
2.34.1
author
#13 lore raw

PATCH v4 11/11 dts: meson-gxbb: Drop redundant devicetree files

In reply to Sumit Garg

Since meson-gxbb based boards switched to using upstream DT, so drop redundant files from arch/arm/dts directory. Only *-u-boot.dtsi files kept in arch/arm/dts directory for these boards.

---

Changes in v4:
- None

Changes in v3:
- Picked up review tag

Changes in v2:
- None

 arch/arm/dts/Makefile                   |   8 -
 arch/arm/dts/meson-gxbb-kii-pro.dts     | 140 ----
 arch/arm/dts/meson-gxbb-nanopi-k2.dts   | 426 ------------
 arch/arm/dts/meson-gxbb-odroidc2.dts    | 414 -----------
 arch/arm/dts/meson-gxbb-p200.dts        | 100 ---
 arch/arm/dts/meson-gxbb-p201.dts        |  26 -
 arch/arm/dts/meson-gxbb-p20x.dtsi       | 250 -------
 arch/arm/dts/meson-gxbb-wetek-hub.dts   |  58 --
 arch/arm/dts/meson-gxbb-wetek-play2.dts | 119 ----
 arch/arm/dts/meson-gxbb-wetek.dtsi      | 292 --------
 arch/arm/dts/meson-gxbb.dtsi            | 870 ------------------------
 11 files changed, 2703 deletions(-)
 delete mode 100644 arch/arm/dts/meson-gxbb-kii-pro.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-nanopi-k2.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-odroidc2.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-p200.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-p201.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-p20x.dtsi
 delete mode 100644 arch/arm/dts/meson-gxbb-wetek-hub.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-wetek-play2.dts
 delete mode 100644 arch/arm/dts/meson-gxbb-wetek.dtsi
 delete mode 100644 arch/arm/dts/meson-gxbb.dtsi
arch/arm/dts/Makefile +0 -8
index 773c2546131..19b6823975f 100644
@@ -212,14 +212,6 @@ dtb-$(CONFIG_ARCH_MESON) += \
 	meson-a1-ad401.dtb \
 	meson-axg-s400.dtb \
 	meson-axg-jethome-jethub-j100.dtb \
-	meson-gxbb-kii-pro.dtb \
-	meson-gxbb-nanopi-k2.dtb \
-	meson-gxbb-odroidc2.dtb \
-	meson-gxbb-nanopi-k2.dtb \
-	meson-gxbb-p200.dtb \
-	meson-gxbb-p201.dtb \
-	meson-gxbb-wetek-hub.dtb \
-	meson-gxbb-wetek-play2.dtb \
 	meson-gxl-s805x-libretech-ac.dtb \
 	meson-gxl-s905d-libretech-pc.dtb \
 	meson-gxl-s905w-jethome-jethub-j80.dtb \
arch/arm/dts/meson-gxbb-kii-pro.dts deleted +0 -140

140 lines not on this page · raw message

arch/arm/dts/meson-gxbb-nanopi-k2.dts deleted +0 -426

426 lines not on this page · raw message

arch/arm/dts/meson-gxbb-odroidc2.dts deleted +0 -414

414 lines not on this page · raw message

arch/arm/dts/meson-gxbb-p200.dts deleted +0 -100

100 lines not on this page · raw message

arch/arm/dts/meson-gxbb-p201.dts deleted +0 -26
deleted file mode 100644
index 150a82f3b2d..00000000000
@@ -1,26 +0,0 @@
-// SPDX-License-Identifier: (GPL-2.0+ OR MIT)
-/*
- * Copyright (c) 2016 Andreas Färber
- * Copyright (c) 2016 BayLibre, Inc.
- * Author: Kevin Hilman <[email protected]>
- */
-
-/dts-v1/;
-
-#include "meson-gxbb-p20x.dtsi"
-
-/ {
-	compatible = "amlogic,p201", "amlogic,meson-gxbb";
-	model = "Amlogic Meson GXBB P201 Development Board";
-};
-
-&ethmac {
-	status = "okay";
-	pinctrl-0 = <&eth_rmii_pins>;
-	pinctrl-names = "default";
-	phy-mode = "rmii";
-
-	snps,reset-gpio = <&gpio GPIOZ_14 0>;
-	snps,reset-delays-us = <0>, <10000>, <1000000>;
-	snps,reset-active-low;
-};
arch/arm/dts/meson-gxbb-p20x.dtsi deleted +0 -250

250 lines not on this page · raw message

arch/arm/dts/meson-gxbb-wetek-hub.dts deleted +0 -58

58 lines not on this page · raw message

arch/arm/dts/meson-gxbb-wetek-play2.dts deleted +0 -119

119 lines not on this page · raw message

arch/arm/dts/meson-gxbb-wetek.dtsi deleted +0 -292

292 lines not on this page · raw message

arch/arm/dts/meson-gxbb.dtsi deleted +0 -870

870 lines not on this page · raw message

Signature · 1 line
2.34.1
#14 lore raw
In reply to Sumit Garg

On 16:05-20240110, Sumit Garg wrote:
[...]

Quoted 8 lines

Prerequisite
------------

This patch series requires devicetree-rebasing git repo to be added as a subtree to the main U-Boot repo via:

$ git subtree add --prefix dts/upstream \
      git://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git \

Please use https://

also what is the baseline? didn't seem to apply on (fails at patch #2):
next f28a77589e75 Merge tag 'dm-next-7jan23' of https://source.denx.de/u-boot/custodians/u-boot-dm into next master f7cca7ccc511 Revert "test: hush: dollar: fix bugous behavior"

Signature · 3 lines
Regards,
Nishanth Menon
Key (0xDDB5849D1736249D) / Fingerprint: F8A2 8693 54EB 8232 17A3  1A34 DDB5 849D 1736 249D
author
#15 lore raw

Hi Nishanth,

Apologies for the delayed response as I was on a long weekend vacation.

Quoted 6 lines · Nishanth Menon

On 16:05-20240110, Sumit Garg wrote:
[...]

Quoted 3 lines

Prerequisite
------------

Quoted 7 lines
Quoted 5 lines

This patch series requires devicetree-rebasing git repo to be added as a subtree to the main U-Boot repo via:

$ git subtree add --prefix dts/upstream \
      git://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git \

Please use https://

Okay I can do that given the widespread use of https://

Quoted 4 lines

also what is the baseline? didn't seem to apply on (fails at patch #2):
next f28a77589e75 Merge tag 'dm-next-7jan23' of https://source.denx.de/u-boot/custodians/u-boot-dm into next master f7cca7ccc511 Revert "test: hush: dollar: fix bugous behavior"

Okay looks like recent merges caused conflicts, needs a rebase. However, for v4 you can use this branch [1] for testing.

[1] https://github.com/b49020/u-boot/tree/v4_dt

-Sumit

Quoted 5 lines

--
Regards,
Nishanth Menon
Key (0xDDB5849D1736249D) / Fingerprint: F8A2 8693 54EB 8232 17A3 1A34 DDB5 849D 1736 249D

#16 lore raw
In reply to Sumit Garg
Quoted 75 lines · Sumit Garg

Changes in v4:
--------------
- Switched subtree to be imported as dts/upstream sub-directory rather than devicetree-rebasing sub-directory to better suite U-Boot directory structure.
- Since we now have v6.7-dts tag available now, so switch subtree to that from its beginning.
- Patch #2: Incorporate build fix to adjust Bindings Makefile rules to old U-Boot Kbuild infrastructure.
- Patch #3: Incorporate fix to resolve rk3399 migration issue reported by Simon.
- Patch #4: New patch to reuse upstream DT includes by U-Boot as per Brian's use-case for TI K3 SoCs.
- Patch #5: Added a note to OF_UPSTREAM Kconfig option.
- Patch #6: New patch to add script dts/update-dts-subtree.sh as per Rob's comments.
- Patch #7: Separate patch to align documentation to use Kconfig symbols instead.
- Patch #8: Clarify subtree uprev schedule as a separate documentation section. Also, fixed documentation typos.
- Patch #9: Added commit description.

Changes in v3:
--------------
- Patch #4: Minor commit message update
- Patch #5: Replace CONFIG_* with Kconfig options
- Patch #7: Dropped Makefile portion and enabled OF_UPSTREAM for SoC instead.
- Patch #1, #3, #6 and #8: Picked up review tags

Changes in v2:
--------------
- Patch #1: excluded gitab CI config check and added commit description.
- Patch #3: s/UBOOT_DTSI_LOC/u_boot_dtsi_loc/
- Patch #4: s/DEVICE_TREE_LOC/dt_dir/ and s/U-boot/U-Boot/
- Patch #5: s/U-boot/U-Boot/
- Patch #6 and #7: Picked up review tags

Prerequisite
------------

This patch series requires devicetree-rebasing git repo to be added as a subtree to the main U-Boot repo via:

$ git subtree add --prefix dts/upstream \
       git://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git \
       v6.7-dts --squash

Background
----------

This effort started while I was reviewing patch series corresponding to Qcom platforms [1] which was about to import modified devicetree source files from Linux kernel. I suppose keeping devicetree files sync with Linux kernel without any DT bindings schema validation has been a pain for U-Boot SoC/platform maintainers. There has been past discussions about a single DT repo but that hasn't come up and Linux kernel remained the place where DT source files as well as bindings are placed and maintained.

However, Linux kernel DT maintainers proposed [2] for U-Boot to rather use devicetree-rebasing repo [3] which is a forked copy from Linux kernel for DT source files as well as bindings. It is tagged at every Linux kernel major release or intermideate release candidates. So here I have tried to reuse that to bring DT bingings compliance as well as a standard way to maintain a regular sync of DT source files with Linux kernel.

In order to maintain devicetree files sync, U-Boot will maintains a Git subtree for devicetee-rebasing repo as dts/upstream sub-directory. U-Boot will regularly sync dts/upstream/ subtree whenever the next window opens with the next available kernel major release. dts/update-dts-subtree.sh script provides a wrapper around git subtree pull command, usage from the top level U-Boot source tree, run:

Quoted 5 lines
$ ./dts/update-dts-subtree.sh <devicetree-rebasing-release-tag>

The RFC/prototype for this series has been discussed with Linux DT maintainers as well as U-Boot maintainers here [4]. Now we would like to reach out to wider U-Boot community to seek feedback.

I very much agree with the direction this is going in, but I do have two simple questions:

How do you propose to handle fixes to DTs which are applied to linux-stable releases ? For example, if Linux 6.6(.0) ships a DT which has some defect that is fixed in 6.6.1, how will that fix get into U-Boot DTs ?

Assume that there is some large breaking change in Linux 6.(n+1), something which would be problematic for specific U-Boot platform (e.g. i.MX) or would require a lot of work to sort out, will there be a way to temporarily pin DTs for specific platform to older DT version until that is resolved (e.g. pin to 6.n) ?

#17 lore raw
Quoted 79 lines · Marek Vasut
Quoted 78 lines · Sumit Garg

Changes in v4:
--------------
- Switched subtree to be imported as dts/upstream sub-directory rather than devicetree-rebasing sub-directory to better suite U-Boot directory structure.
- Since we now have v6.7-dts tag available now, so switch subtree to that from its beginning.
- Patch #2: Incorporate build fix to adjust Bindings Makefile rules to old U-Boot Kbuild infrastructure.
- Patch #3: Incorporate fix to resolve rk3399 migration issue reported by Simon.
- Patch #4: New patch to reuse upstream DT includes by U-Boot as per Brian's use-case for TI K3 SoCs.
- Patch #5: Added a note to OF_UPSTREAM Kconfig option.
- Patch #6: New patch to add script dts/update-dts-subtree.sh as per Rob's comments.
- Patch #7: Separate patch to align documentation to use Kconfig symbols instead.
- Patch #8: Clarify subtree uprev schedule as a separate documentation section. Also, fixed documentation typos.
- Patch #9: Added commit description.

Changes in v3:
--------------
- Patch #4: Minor commit message update
- Patch #5: Replace CONFIG_* with Kconfig options
- Patch #7: Dropped Makefile portion and enabled OF_UPSTREAM for SoC instead.
- Patch #1, #3, #6 and #8: Picked up review tags

Changes in v2:
--------------
- Patch #1: excluded gitab CI config check and added commit description.
- Patch #3: s/UBOOT_DTSI_LOC/u_boot_dtsi_loc/
- Patch #4: s/DEVICE_TREE_LOC/dt_dir/ and s/U-boot/U-Boot/
- Patch #5: s/U-boot/U-Boot/
- Patch #6 and #7: Picked up review tags

Prerequisite
------------

This patch series requires devicetree-rebasing git repo to be added as a subtree to the main U-Boot repo via:

$ git subtree add --prefix dts/upstream \

git://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git \
       v6.7-dts --squash

Background
----------

This effort started while I was reviewing patch series corresponding to Qcom platforms [1] which was about to import modified devicetree source files from Linux kernel. I suppose keeping devicetree files sync with Linux kernel without any DT bindings schema validation has been a pain for U-Boot SoC/platform maintainers. There has been past discussions about a single DT repo but that hasn't come up and Linux kernel remained the place where DT source files as well as bindings are placed and maintained.

However, Linux kernel DT maintainers proposed [2] for U-Boot to rather use devicetree-rebasing repo [3] which is a forked copy from Linux kernel for DT source files as well as bindings. It is tagged at every Linux kernel major release or intermideate release candidates. So here I have tried to reuse that to bring DT bingings compliance as well as a standard way to maintain a regular sync of DT source files with Linux kernel.

In order to maintain devicetree files sync, U-Boot will maintains a Git subtree for devicetee-rebasing repo as dts/upstream sub-directory. U-Boot will regularly sync dts/upstream/ subtree whenever the next window opens with the next available kernel major release. dts/update-dts-subtree.sh script provides a wrapper around git subtree pull command, usage from the top level U-Boot source tree, run:

$ ./dts/update-dts-subtree.sh <devicetree-rebasing-release-tag>
Quoted 7 lines
Quoted 3 lines

The RFC/prototype for this series has been discussed with Linux DT maintainers as well as U-Boot maintainers here [4]. Now we would like to reach out to wider U-Boot community to seek feedback.

I very much agree with the direction this is going in, but I do have two simple questions:

How do you propose to handle fixes to DTs which are applied to linux-stable releases ? For example, if Linux 6.6(.0) ships a DT which has some defect that is fixed in 6.6.1, how will that fix get into U-Boot DTs ?

This fix would also be in the latest Linux tags, so I think it would find its way here - as I understand it patches aren't accepted into Linux stable unless they land in torvalds tree.

Quoted 2 lines

Assume that there is some large breaking change in Linux 6.(n+1), something which would be problematic for specific U-Boot platform (e.g. i.MX) or would require a lot of work to sort out, will there be a way to temporarily pin DTs for specific platform to older DT version until that is resolved (e.g. pin to 6.n) ?

(Upstream) devicetree has to be forwards and backwards compatible, were such a breaking change to get merged without prior discussion with DT users (i.e. U-Boot) then I think the correct course of action would be to revert it.

On a tangential note: as I understand it, DTs built from dt-rebasing are still subject to U-Boot customisations via the "-u-boot.dtsi" include files, this allows for dealing with incompatibilities due to missing features in U-Boot.

Signature · 1 line
// Caleb (they/them)
#18 lore raw
Quoted 3 lines · Caleb Connolly

On 21/01/2024 15:33, Marek Vasut wrote:

[snip]

Quoted 9 lines
Quoted 5 lines

Assume that there is some large breaking change in Linux 6.(n+1), something which would be problematic for specific U-Boot platform (e.g. i.MX) or would require a lot of work to sort out, will there be a way to temporarily pin DTs for specific platform to older DT version until that is resolved (e.g. pin to 6.n) ?

(Upstream) devicetree has to be forwards and backwards compatible, were such a breaking change to get merged without prior discussion with DT users (i.e. U-Boot) then I think the correct course of action would be to revert it.

The caveat is "unless it was wrong before", which happens more often than is generally thought of I think. I'm not sure off-hand the best way to deal with that.

Signature · 1 line
Tom
author
#19 lore raw
Quoted 12 lines · Tom Rini
Quoted 3 lines · Caleb Connolly

On 21/01/2024 15:33, Marek Vasut wrote:

[snip]

Quoted 6 lines
Quoted 5 lines

Assume that there is some large breaking change in Linux 6.(n+1), something which would be problematic for specific U-Boot platform (e.g. i.MX) or would require a lot of work to sort out, will there be a way to temporarily pin DTs for specific platform to older DT version until that is resolved (e.g. pin to 6.n) ?

Quoted 7 lines
Quoted 3 lines

(Upstream) devicetree has to be forwards and backwards compatible, were such a breaking change to get merged without prior discussion with DT users (i.e. U-Boot) then I think the correct course of action would be to revert it.

The caveat is "unless it was wrong before", which happens more often than is generally thought of I think. I'm not sure off-hand the best way to deal with that.

I think that's the reason we just want to pull DT at once in the beginning of the next window and allow U-Boot developers/maintainers to detect and fix problems during the full U-Boot release cycle. However, we are open to discussions for a revert if there is a major DT ABI break among Linux major (.0) releases affecting many U-Boot platforms.

-Sumit

Quoted 3 lines

--
Tom

#20 lore raw
In reply to Caleb Connolly

On 1/21/24 23:41, Caleb Connolly wrote:

Hi,

[...]

Quoted 3 lines
Quoted 1 line

How do you propose to handle fixes to DTs which are applied to linux-stable releases ? For example, if Linux 6.6(.0) ships a DT which has some defect that is fixed in 6.6.1, how will that fix get into U-Boot DTs ?

This fix would also be in the latest Linux tags, so I think it would find its way here - as I understand it patches aren't accepted into Linux stable unless they land in torvalds tree.

See the devicetree-rebasing.git:

https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/refs/

That only contains refs for release versions (v6.6-dts, v6.7-dts etc), not any follow-up updates from linux-stable (like current 6.6.13 etc).

Would this require syncing in -rc versions of Linux DTs to get the latest fixes in ?

Quoted 3 lines
Quoted 1 line

Assume that there is some large breaking change in Linux 6.(n+1), something which would be problematic for specific U-Boot platform (e.g. i.MX) or would require a lot of work to sort out, will there be a way to temporarily pin DTs for specific platform to older DT version until that is resolved (e.g. pin to 6.n) ?

(Upstream) devicetree has to be forwards and backwards compatible, were such a breaking change to get merged without prior discussion with DT users (i.e. U-Boot) then I think the correct course of action would be to revert it.

Not really, this could be a perfectly valid change, and would work for Linux just fine, it might simply be pulling in something which is not supported by U-Boot just yet and therefore syncing the DTs into U-Boot would break U-Boot on that platform . Using older version of DTs for a platform could work as a stopgap measure until the functionality is implemented. Is this possible ?

Quoted 1 line

On a tangential note: as I understand it, DTs built from dt-rebasing are still subject to U-Boot customisations via the "-u-boot.dtsi" include files, this allows for dealing with incompatibilities due to missing features in U-Boot.

Would it be possible to auto-update those -u-boot.dtsi files during sync, to minimize the resulting DT blob delta before/after update, and thus also minimize the likelihood of causing breakage ?

author
#21 lore raw

Hi Marek,

Quoted 16 lines · Marek Vasut

On 1/21/24 23:41, Caleb Connolly wrote:

Hi,

[...]

Quoted 8 lines
Quoted 4 lines

How do you propose to handle fixes to DTs which are applied to linux-stable releases ? For example, if Linux 6.6(.0) ships a DT which has some defect that is fixed in 6.6.1, how will that fix get into U-Boot DTs ?

This fix would also be in the latest Linux tags, so I think it would find its way here - as I understand it patches aren't accepted into Linux stable unless they land in torvalds tree.

Quoted 7 lines

See the devicetree-rebasing.git:

https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/refs/

That only contains refs for release versions (v6.6-dts, v6.7-dts etc), not any follow-up updates from linux-stable (like current 6.6.13 etc).

Here we should only consider fixes which are critical to U-Boot. I think -u-boot.dtsi files would be suitable to carry those fixes until next uprev. However, if there is a fix affecting many platforms than we can consider pulling that standalone too.

Quoted 2 lines

Would this require syncing in -rc versions of Linux DTs to get the latest fixes in ?

Syncing -rc versions makes U-Boot more prone to DT ABI breakages. So its a chicken and egg problem as per your comments below. However, we can revisit our syncing strategy based on how the current one pans out.

Quoted 12 lines
Quoted 11 lines
Quoted 6 lines

Assume that there is some large breaking change in Linux 6.(n+1), something which would be problematic for specific U-Boot platform (e.g. i.MX) or would require a lot of work to sort out, will there be a way to temporarily pin DTs for specific platform to older DT version until that is resolved (e.g. pin to 6.n) ?

(Upstream) devicetree has to be forwards and backwards compatible, were such a breaking change to get merged without prior discussion with DT users (i.e. U-Boot) then I think the correct course of action would be to revert it.

Quoted 6 lines

Not really, this could be a perfectly valid change, and would work for Linux just fine, it might simply be pulling in something which is not supported by U-Boot just yet and therefore syncing the DTs into U-Boot would break U-Boot on that platform . Using older version of DTs for a platform could work as a stopgap measure until the functionality is implemented. Is this possible ?

For this particular reason we want to pull once during beginning on U-Boot next window and allow sufficient time for platform maintainers to adapt to it. However, OF_UPSTREAM=n can be an alternative for a stopgap solution.

Quoted 9 lines
Quoted 5 lines

On a tangential note: as I understand it, DTs built from dt-rebasing are still subject to U-Boot customisations via the "-u-boot.dtsi" include files, this allows for dealing with incompatibilities due to missing features in U-Boot.

Would it be possible to auto-update those -u-boot.dtsi files during sync, to minimize the resulting DT blob delta before/after update, and thus also minimize the likelihood of causing breakage ?

In the long run the DT community would like to avoid any DT ABI breakages at all. Rob is already working on a DT ABI check tool and seeking inputs for what could be an ABI break [1] from U-Boot perspective too. Feel free to provide your inputs.

Along with that we wouldn't need -u-boot.dtsi files once we make U-Boot fully compliant with DT bindings. Until that point U-Boot platform maintainers have to keep their -u-boot.dtsi files updated corresponding to latest DT rebasing releases.

[1] https://lore.kernel.org/all/CAL_JsqLo4nXrJ93dDsfp3UYLs08V02aMnbCCnsDj0MBBomc35w@mail.gmail.com/

-Sumit

#22 lore raw

On 1/24/24 09:16, Sumit Garg wrote:

Hi,

Quoted 13 lines
Quoted 13 lines
Quoted 8 lines
Quoted 4 lines

How do you propose to handle fixes to DTs which are applied to linux-stable releases ? For example, if Linux 6.6(.0) ships a DT which has some defect that is fixed in 6.6.1, how will that fix get into U-Boot DTs ?

This fix would also be in the latest Linux tags, so I think it would find its way here - as I understand it patches aren't accepted into Linux stable unless they land in torvalds tree.

See the devicetree-rebasing.git:

https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/refs/

Quoted 8 lines
Quoted 3 lines

That only contains refs for release versions (v6.6-dts, v6.7-dts etc), not any follow-up updates from linux-stable (like current 6.6.13 etc).

Here we should only consider fixes which are critical to U-Boot. I think -u-boot.dtsi files would be suitable to carry those fixes until next uprev. However, if there is a fix affecting many platforms than we can consider pulling that standalone too.

That would mean extra duplicate work -- the critical fixes have already been selected into linux-stable, that work is already done, I don't think it makes sense to re-do it again.

Furthermore, I do not like the new necessity to start porting those fixes from linux-stable and converting them to adjustments to *-u-boot.dtsi files, this is tedious and error prone, so it would have to be automated.

But I still think it is much better to simply take the fixes directly from linux-stable as-is instead.

Quoted 27 lines
Quoted 2 lines

Would this require syncing in -rc versions of Linux DTs to get the latest fixes in ?

Syncing -rc versions makes U-Boot more prone to DT ABI breakages. So its a chicken and egg problem as per your comments below. However, we can revisit our syncing strategy based on how the current one pans out.

Quoted 12 lines
Quoted 11 lines
Quoted 6 lines

Assume that there is some large breaking change in Linux 6.(n+1), something which would be problematic for specific U-Boot platform (e.g. i.MX) or would require a lot of work to sort out, will there be a way to temporarily pin DTs for specific platform to older DT version until that is resolved (e.g. pin to 6.n) ?

(Upstream) devicetree has to be forwards and backwards compatible, were such a breaking change to get merged without prior discussion with DT users (i.e. U-Boot) then I think the correct course of action would be to revert it.

Quoted 6 lines

Not really, this could be a perfectly valid change, and would work for Linux just fine, it might simply be pulling in something which is not supported by U-Boot just yet and therefore syncing the DTs into U-Boot would break U-Boot on that platform . Using older version of DTs for a platform could work as a stopgap measure until the functionality is implemented. Is this possible ?

Quoted 4 lines

For this particular reason we want to pull once during beginning on U-Boot next window and allow sufficient time for platform maintainers to adapt to it. However, OF_UPSTREAM=n can be an alternative for a stopgap solution.

That pull would break other peoples platforms. It would be no different than adding broken patch into the code base. What I think would be an option is that there is a pull (as in patch) and people should be able to test it before it is applied. If one platform is severely affected while other platforms are fine, the one platform should be able to use the current working version of DTs, while the other platforms should not be blocked by it. Is that what OF_UPSTREAM=n does ?

As far as I understand OF_UPSTREAM=n, it would require re-importing DTs into the codebase ?

Quoted 14 lines
Quoted 8 lines
Quoted 4 lines

On a tangential note: as I understand it, DTs built from dt-rebasing are still subject to U-Boot customisations via the "-u-boot.dtsi" include files, this allows for dealing with incompatibilities due to missing features in U-Boot.

Would it be possible to auto-update those -u-boot.dtsi files during sync, to minimize the resulting DT blob delta before/after update, and thus also minimize the likelihood of causing breakage ?

In the long run the DT community would like to avoid any DT ABI breakages at all. Rob is already working on a DT ABI check tool and seeking inputs for what could be an ABI break [1] from U-Boot perspective too. Feel free to provide your inputs.

Quoted 4 lines

Along with that we wouldn't need -u-boot.dtsi files once we make U-Boot fully compliant with DT bindings. Until that point U-Boot platform maintainers have to keep their -u-boot.dtsi files updated corresponding to latest DT rebasing releases.

I think upstreaming the bootph* properties would still take a while, but is not relevant to the aforementioned question.

Assume there is a sync, would the current in-tree -u-boot.dtsi files get updated to work correctly with the newly synced DTs ?

author
#23 lore raw
Quoted 31 lines · Marek Vasut

On 1/24/24 09:16, Sumit Garg wrote:

Hi,

Quoted 13 lines
Quoted 13 lines
Quoted 8 lines
Quoted 4 lines

How do you propose to handle fixes to DTs which are applied to linux-stable releases ? For example, if Linux 6.6(.0) ships a DT which has some defect that is fixed in 6.6.1, how will that fix get into U-Boot DTs ?

This fix would also be in the latest Linux tags, so I think it would find its way here - as I understand it patches aren't accepted into Linux stable unless they land in torvalds tree.

See the devicetree-rebasing.git:

https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/refs/

Quoted 8 lines
Quoted 3 lines

That only contains refs for release versions (v6.6-dts, v6.7-dts etc), not any follow-up updates from linux-stable (like current 6.6.13 etc).

Here we should only consider fixes which are critical to U-Boot. I think -u-boot.dtsi files would be suitable to carry those fixes until next uprev. However, if there is a fix affecting many platforms than we can consider pulling that standalone too.

That would mean extra duplicate work -- the critical fixes have already been selected into linux-stable, that work is already done, I don't think it makes sense to re-do it again.

Quoted 7 lines

Furthermore, I do not like the new necessity to start porting those fixes from linux-stable and converting them to adjustments to *-u-boot.dtsi files, this is tedious and error prone, so it would have to be automated.

But I still think it is much better to simply take the fixes directly from linux-stable as-is instead.

That's fair, it would essentially be a DT ABI breakage for U-Boot for which a fix has to be taken in U-Boot from Linux stable release. So I am fine with that.

But at this point we have to move away from apprehensions about DT ABI breakages and provide real examples of the DT ABI breakages in the past. Are you aware of any DT ABI breaking change backported to Linux stable releases? This is the sort of information we would like to make DT bindings maintainers aware about.

Quoted 28 lines
Quoted 28 lines
Quoted 3 lines

Would this require syncing in -rc versions of Linux DTs to get the latest fixes in ?

Syncing -rc versions makes U-Boot more prone to DT ABI breakages. So its a chicken and egg problem as per your comments below. However, we can revisit our syncing strategy based on how the current one pans out.

Quoted 18 lines
Quoted 11 lines
Quoted 6 lines

Assume that there is some large breaking change in Linux 6.(n+1), something which would be problematic for specific U-Boot platform (e.g. i.MX) or would require a lot of work to sort out, will there be a way to temporarily pin DTs for specific platform to older DT version until that is resolved (e.g. pin to 6.n) ?

(Upstream) devicetree has to be forwards and backwards compatible, were such a breaking change to get merged without prior discussion with DT users (i.e. U-Boot) then I think the correct course of action would be to revert it.

Not really, this could be a perfectly valid change, and would work for Linux just fine, it might simply be pulling in something which is not supported by U-Boot just yet and therefore syncing the DTs into U-Boot would break U-Boot on that platform . Using older version of DTs for a platform could work as a stopgap measure until the functionality is implemented. Is this possible ?

Quoted 7 lines
Quoted 4 lines

For this particular reason we want to pull once during beginning on U-Boot next window and allow sufficient time for platform maintainers to adapt to it. However, OF_UPSTREAM=n can be an alternative for a stopgap solution.

That pull would break other peoples platforms. It would be no different than adding broken patch into the code base.

The platforms which get converted to OF_UPSTREAM=y are the ones which would be compliant with upstream DT bindings. So any DT ABI change among major Linux .0 releases would be the reason for that breakage. And we are happy to accept a revert for that change and feed that information back to Linux DT bindings maintainers.

Also as above, are you aware of any past DT ABI breakages for U-Boot since people have already been doing DT syncing from Linux manually. This series allows to reduce that pain and try to bring DT bindings compliance in U-Boot.

Quoted 3 lines

What I think would be an
option is that there is a pull (as in patch) and people should be able to test it before it is applied.

We can't modify that pull but rather accept changes on top of it. IMO, it will get widely tested in U-Boot next branch.

Quoted 7 lines

If one platform is severely affected
while other platforms are fine, the one platform should be able to use the current working version of DTs, while the other platforms should not be blocked by it. Is that what OF_UPSTREAM=n does ?

As far as I understand OF_UPSTREAM=n, it would require re-importing DTs into the codebase ?

No you don't have to re-import everything but rather import a board DTS file to the arch/ folder and reuse all the DT includes from dts/upstream subtree as per this [1] patch.

[1] https://lore.kernel.org/all/[email protected]/

Quoted 20 lines
Quoted 15 lines
Quoted 9 lines
Quoted 5 lines

On a tangential note: as I understand it, DTs built from dt-rebasing are still subject to U-Boot customisations via the "-u-boot.dtsi" include files, this allows for dealing with incompatibilities due to missing features in U-Boot.

Would it be possible to auto-update those -u-boot.dtsi files during sync, to minimize the resulting DT blob delta before/after update, and thus also minimize the likelihood of causing breakage ?

In the long run the DT community would like to avoid any DT ABI breakages at all. Rob is already working on a DT ABI check tool and seeking inputs for what could be an ABI break [1] from U-Boot perspective too. Feel free to provide your inputs.

Quoted 4 lines

Along with that we wouldn't need -u-boot.dtsi files once we make U-Boot fully compliant with DT bindings. Until that point U-Boot platform maintainers have to keep their -u-boot.dtsi files updated corresponding to latest DT rebasing releases.

Quoted 5 lines

I think upstreaming the bootph* properties would still take a while, but is not relevant to the aforementioned question.

Assume there is a sync, would the current in-tree -u-boot.dtsi files get updated to work correctly with the newly synced DTs ?

As long as they contain nodes/properties (eg. bootph* etc.) which are compliant with upstream DT bindings then yes they should work correctly with the newly synced DTs.

-Sumit

#24 lore raw

On Thu, Jan 25, 2024 at 12:54:22PM +0530, Sumit Garg wrote:

[snip]

Quoted 5 lines

But at this point we have to move away from apprehensions about DT ABI breakages and provide real examples of the DT ABI breakages in the past. Are you aware of any DT ABI breaking change backported to Linux stable releases? This is the sort of information we would like to make DT bindings maintainers aware about.

Well, how far back are we going? There was a serial related one, but it was probably closer than not to 10 years ago and lessons have been learned from it already.

The real breakage comes in the form of (from the Linux kernel):
commit 37685f6a63eeca2135d1f704e7638409a071b1f6

Author: Peter Ujfalusi <[email protected]>
Date:   Tue Feb 19 08:46:33 2019 -0800

ARM: dts: am335x-evm: Fix PHY mode for ethernet

The PHY must add both tx and rx delay and not only on the tx clock. The board uses AR8031_AL1A PHY where the rx delay is enabled by default, the tx dealy is disabled.

The reason why rgmii-txid worked because the rx delay was not disabled by the driver so essentially we ended up with rgmii-id PHY mode.

And this is of the style "the DTS was wrong before so we can break it". This is the specific example (as the board is in my lab) that comes most clearly to mind but there have been similar examples in 2022/2023.

The other just as painful examples I think may be where Marek is concerned and it's around nodes being renamed for correctness. We've had a number of cases where a - turned to _ (or vice versa?) and whoops, platform stops booting. Down the line, tooling would catch that, and it's a problem of not being able to use better tooling until we have the updates that might break the boards that need the better tooling.

And really this gets to the crux of the problem, how much testing do we insist happens prior to a re-sync being merged? Do we want to go with the whole of the dts files are re-synced, or do we leave it per vendor? I think it's been noted that a subtree merge commit doesn't really "git send-email" well.

I really am inclined to start with keeping everyone to the release tags for everyone and merging them as soon as the next window opens. I _think__ and we'll be able to find out quickly enough, that we can cherry-pick fixes from upstream in to our subtree and have subtree Do The Right Thing in the next merge window.

[snip]

Quoted 9 lines
Quoted 5 lines

I think upstreaming the bootph* properties would still take a while, but is not relevant to the aforementioned question.

Assume there is a sync, would the current in-tree -u-boot.dtsi files get updated to work correctly with the newly synced DTs ?

As long as they contain nodes/properties (eg. bootph* etc.) which are compliant with upstream DT bindings then yes they should work correctly with the newly synced DTs.

This is a good specific example. The bootph* properties should _now_ be easier to get accepted upstream as our tooling handles the transitive property of them correctly and so they don't need to be manually applied so much (a problem upstream maintainers had, after the binding was accepted, was the sheer number of them being added, this is now fixed). But also applying these properties via -u-boot.dtsi was tripped up in resyncs where the parent node was renamed for correctness and there's no tooling that we had that complained. In the future, this would have been caught because we would have been dtbs_check clean, or at least clean enough that I'd be running it and caring about deltas from before/after.

Signature · 1 line
Tom
#25 lore raw
Quoted 41 lines · Tom Rini

On Thu, Jan 25, 2024 at 12:54:22PM +0530, Sumit Garg wrote:

[snip]

Quoted 5 lines

But at this point we have to move away from apprehensions about DT ABI breakages and provide real examples of the DT ABI breakages in the past. Are you aware of any DT ABI breaking change backported to Linux stable releases? This is the sort of information we would like to make DT bindings maintainers aware about.

Well, how far back are we going? There was a serial related one, but it was probably closer than not to 10 years ago and lessons have been learned from it already.

The real breakage comes in the form of (from the Linux kernel):
commit 37685f6a63eeca2135d1f704e7638409a071b1f6

Author: Peter Ujfalusi <[email protected]>
Date:   Tue Feb 19 08:46:33 2019 -0800

ARM: dts: am335x-evm: Fix PHY mode for ethernet

The PHY must add both tx and rx delay and not only on the tx clock. The board uses AR8031_AL1A PHY where the rx delay is enabled by default, the tx dealy is disabled.

The reason why rgmii-txid worked because the rx delay was not disabled by the driver so essentially we ended up with rgmii-id PHY mode.

And this is of the style "the DTS was wrong before so we can break it". This is the specific example (as the board is in my lab) that comes most clearly to mind but there have been similar examples in 2022/2023.

The other just as painful examples I think may be where Marek is concerned and it's around nodes being renamed for correctness. We've had a number of cases where a - turned to _ (or vice versa?) and whoops, platform stops booting. Down the line, tooling would catch that, and it's a problem of not being able to use better tooling until we have the updates that might break the boards that need the better tooling.

Quoted 3 lines

And really this gets to the crux of the problem, how much testing do we insist happens prior to a re-sync being merged? Do we want to go with the whole of the dts files are re-synced, or do we leave it per vendor?

I'd much prefer to leave it per vendor, with the recommendation to use synced DTs. Eventually things will stabilize and vendors will start switching over.

#26 lore raw
Quoted 42 lines · Marek Vasut
Quoted 41 lines · Tom Rini

On Thu, Jan 25, 2024 at 12:54:22PM +0530, Sumit Garg wrote:

[snip]

Quoted 5 lines

But at this point we have to move away from apprehensions about DT ABI breakages and provide real examples of the DT ABI breakages in the past. Are you aware of any DT ABI breaking change backported to Linux stable releases? This is the sort of information we would like to make DT bindings maintainers aware about.

Well, how far back are we going? There was a serial related one, but it was probably closer than not to 10 years ago and lessons have been learned from it already.

The real breakage comes in the form of (from the Linux kernel):
commit 37685f6a63eeca2135d1f704e7638409a071b1f6

Author: Peter Ujfalusi <[email protected]>
Date:   Tue Feb 19 08:46:33 2019 -0800

ARM: dts: am335x-evm: Fix PHY mode for ethernet

The PHY must add both tx and rx delay and not only on the tx clock. The board uses AR8031_AL1A PHY where the rx delay is enabled by default, the tx dealy is disabled.

The reason why rgmii-txid worked because the rx delay was not disabled by the driver so essentially we ended up with rgmii-id PHY mode.

And this is of the style "the DTS was wrong before so we can break it". This is the specific example (as the board is in my lab) that comes most clearly to mind but there have been similar examples in 2022/2023.

The other just as painful examples I think may be where Marek is concerned and it's around nodes being renamed for correctness. We've had a number of cases where a - turned to _ (or vice versa?) and whoops, platform stops booting. Down the line, tooling would catch that, and it's a problem of not being able to use better tooling until we have the updates that might break the boards that need the better tooling.

Quoted 7 lines
Quoted 3 lines

And really this gets to the crux of the problem, how much testing do we insist happens prior to a re-sync being merged? Do we want to go with the whole of the dts files are re-synced, or do we leave it per vendor?

I'd much prefer to leave it per vendor, with the recommendation to use synced DTs. Eventually things will stabilize and vendors will start switching over.

To be clear, every SoC (or really, board) has to opt-in to OF_UPSTREAM to start with. With that, I see switching to OF_UPSTREAM meaning that there's a commitment to keeping up with dts change in upstream dts that might lead to issues within U-Boot. Do you still feel it would be better to have the re-sync _also_ be per custodian tree? That might be a bit harder to handle.

Signature · 1 line
Tom
#27 lore raw
Quoted 51 lines · Tom Rini
Quoted 42 lines · Marek Vasut
Quoted 41 lines · Tom Rini

On Thu, Jan 25, 2024 at 12:54:22PM +0530, Sumit Garg wrote:

[snip]

Quoted 5 lines

But at this point we have to move away from apprehensions about DT ABI breakages and provide real examples of the DT ABI breakages in the past. Are you aware of any DT ABI breaking change backported to Linux stable releases? This is the sort of information we would like to make DT bindings maintainers aware about.

Well, how far back are we going? There was a serial related one, but it was probably closer than not to 10 years ago and lessons have been learned from it already.

The real breakage comes in the form of (from the Linux kernel):
commit 37685f6a63eeca2135d1f704e7638409a071b1f6

Author: Peter Ujfalusi <[email protected]>
Date:   Tue Feb 19 08:46:33 2019 -0800

ARM: dts: am335x-evm: Fix PHY mode for ethernet

The PHY must add both tx and rx delay and not only on the tx clock. The board uses AR8031_AL1A PHY where the rx delay is enabled by default, the tx dealy is disabled.

The reason why rgmii-txid worked because the rx delay was not disabled by the driver so essentially we ended up with rgmii-id PHY mode.

And this is of the style "the DTS was wrong before so we can break it". This is the specific example (as the board is in my lab) that comes most clearly to mind but there have been similar examples in 2022/2023.

The other just as painful examples I think may be where Marek is concerned and it's around nodes being renamed for correctness. We've had a number of cases where a - turned to _ (or vice versa?) and whoops, platform stops booting. Down the line, tooling would catch that, and it's a problem of not being able to use better tooling until we have the updates that might break the boards that need the better tooling.

Quoted 7 lines
Quoted 3 lines

And really this gets to the crux of the problem, how much testing do we insist happens prior to a re-sync being merged? Do we want to go with the whole of the dts files are re-synced, or do we leave it per vendor?

I'd much prefer to leave it per vendor, with the recommendation to use synced DTs. Eventually things will stabilize and vendors will start switching over.

Quoted 6 lines

To be clear, every SoC (or really, board) has to opt-in to OF_UPSTREAM to start with. With that, I see switching to OF_UPSTREAM meaning that there's a commitment to keeping up with dts change in upstream dts that might lead to issues within U-Boot. Do you still feel it would be better to have the re-sync _also_ be per custodian tree? That might be a bit harder to handle.

Maybe the best thing we can do is just give it a try and see how it works out, esp. since it is opt-in per board .

It would still be good to solve the part about pulling in fixes from linux-stable though .

#28 lore raw
Quoted 59 lines · Marek Vasut
Quoted 51 lines · Tom Rini
Quoted 42 lines · Marek Vasut
Quoted 41 lines · Tom Rini

On Thu, Jan 25, 2024 at 12:54:22PM +0530, Sumit Garg wrote:

[snip]

Quoted 5 lines

But at this point we have to move away from apprehensions about DT ABI breakages and provide real examples of the DT ABI breakages in the past. Are you aware of any DT ABI breaking change backported to Linux stable releases? This is the sort of information we would like to make DT bindings maintainers aware about.

Well, how far back are we going? There was a serial related one, but it was probably closer than not to 10 years ago and lessons have been learned from it already.

The real breakage comes in the form of (from the Linux kernel):
commit 37685f6a63eeca2135d1f704e7638409a071b1f6
Author: Peter Ujfalusi <[email protected]>
Date:   Tue Feb 19 08:46:33 2019 -0800

      ARM: dts: am335x-evm: Fix PHY mode for ethernet

      The PHY must add both tx and rx delay and not only on the tx clock. The board uses AR8031_AL1A PHY where the rx delay is enabled by default, the tx dealy is disabled.

      The reason why rgmii-txid worked because the rx delay was not disabled by the driver so essentially we ended up with rgmii-id PHY mode.

And this is of the style "the DTS was wrong before so we can break it". This is the specific example (as the board is in my lab) that comes most clearly to mind but there have been similar examples in 2022/2023.

The other just as painful examples I think may be where Marek is concerned and it's around nodes being renamed for correctness. We've had a number of cases where a - turned to _ (or vice versa?) and whoops, platform stops booting. Down the line, tooling would catch that, and it's a problem of not being able to use better tooling until we have the updates that might break the boards that need the better tooling.

Quoted 7 lines
Quoted 3 lines

And really this gets to the crux of the problem, how much testing do we insist happens prior to a re-sync being merged? Do we want to go with the whole of the dts files are re-synced, or do we leave it per vendor?

I'd much prefer to leave it per vendor, with the recommendation to use synced DTs. Eventually things will stabilize and vendors will start switching over.

Quoted 6 lines

To be clear, every SoC (or really, board) has to opt-in to OF_UPSTREAM to start with. With that, I see switching to OF_UPSTREAM meaning that there's a commitment to keeping up with dts change in upstream dts that might lead to issues within U-Boot. Do you still feel it would be better to have the re-sync _also_ be per custodian tree? That might be a bit harder to handle.

Quoted 3 lines

Maybe the best thing we can do is just give it a try and see how it works out, esp. since it is opt-in per board .

It would still be good to solve the part about pulling in fixes from linux-stable though .

I would let board owners/custodians to deal with their boards.
There is very high chance that if you do it globally that it is question of time when something will break. It make sense to talk about how to do that transition and describe that steps and having tools/script to help with.

Thanks,
Michal

author
#29 lore raw
Quoted 33 lines · Michal Simek
Quoted 30 lines · Marek Vasut
Quoted 29 lines · Tom Rini
Quoted 28 lines · Marek Vasut
Quoted 27 lines · Tom Rini

On Thu, Jan 25, 2024 at 12:54:22PM +0530, Sumit Garg wrote:

[snip]

Quoted 5 lines

But at this point we have to move away from apprehensions about DT ABI breakages and provide real examples of the DT ABI breakages in the past. Are you aware of any DT ABI breaking change backported to Linux stable releases? This is the sort of information we would like to make DT bindings maintainers aware about.

Well, how far back are we going? There was a serial related one, but it was probably closer than not to 10 years ago and lessons have been learned from it already.

The real breakage comes in the form of (from the Linux kernel):
commit 37685f6a63eeca2135d1f704e7638409a071b1f6

Author: Peter Ujfalusi <[email protected]>
Date:   Tue Feb 19 08:46:33 2019 -0800

ARM: dts: am335x-evm: Fix PHY mode for ethernet

The PHY must add both tx and rx delay and not only on the tx clock. The board uses AR8031_AL1A PHY where the rx delay is enabled by default, the tx dealy is disabled.

The reason why rgmii-txid worked because the rx delay was not disabled by the driver so essentially we ended up with rgmii-id PHY mode.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

And this is of the style "the DTS was wrong before so we can break it". This is the specific example (as the board is in my lab) that comes most clearly to mind but there have been similar examples in 2022/2023.

I agree that these sorts of changes should be done in a DT ABI compatible manner to U-Boot or atleast proactively adapt U-Boot to those changes. But I am not sure how we can improve here without a regular DT sync cadence with upstream and a Linux kernel maintainer profile to say that DT ABI towards U-Boot has to be kept in mind.

The existing ad hoc syncs won't be motivating Linux DT maintainers to care about U-Boot regressions.

Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines

The other just as painful examples I think may be where Marek is concerned and it's around nodes being renamed for correctness. We've had a number of cases where a - turned to _ (or vice versa?) and whoops, platform stops booting. Down the line, tooling would catch that, and it's a problem of not being able to use better tooling until we have the updates that might break the boards that need the better tooling.

AFAIU from this [1], the DT node names aren't part of the ABI. Given that we should start motivating people to move away from relying on node names, for eg. using uclass_get_device_by_seq() instead of uclass_get_device_by_name().

[1] https://www.kernel.org/doc/Documentation/ABI/testing/sysfs-firmware-ofw

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

And really this gets to the crux of the problem, how much testing do we insist happens prior to a re-sync being merged?

I am not sure why custodians/maintainers depend on the global re-sync to be merged for testing purposes. They can very well have their local vendor directories synced-up and proactively look for any regressions.

Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines
Quoted 2 lines

Do we want to go with
the whole of the dts files are re-synced, or do we leave it per vendor?

Leaving it per vendor would be somewhat similar to existing ad hoc syncs. BTW, what about bindings directory? We won't be able to enforce binding checks given the different state of per vendor DTS directory.

Quoted 12 lines
Quoted 12 lines
Quoted 11 lines
Quoted 4 lines

I'd much prefer to leave it per vendor, with the recommendation to use synced DTs. Eventually things will stabilize and vendors will start switching over.

To be clear, every SoC (or really, board) has to opt-in to OF_UPSTREAM to start with. With that, I see switching to OF_UPSTREAM meaning that there's a commitment to keeping up with dts change in upstream dts that might lead to issues within U-Boot. Do you still feel it would be better to have the re-sync _also_ be per custodian tree? That might be a bit harder to handle.

Quoted 2 lines
Quoted 2 lines

Maybe the best thing we can do is just give it a try and see how it works out, esp. since it is opt-in per board .

Yeah given that we are conservative about re-syncs with a full U-Boot release cycle to detect and fix regressions.

Quoted 3 lines
Quoted 3 lines

It would still be good to solve the part about pulling in fixes from linux-stable though .

So I did a demo experiment for this here [1] where cherry picking DT fixes into subtree just worked fine with the next uprev. Steps followed:

$ cd <U-Boot tree>/
$ git remote add dt-rebasing
https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git
$ git fetch dt-rebasing master
$ git cherry-pick -x --strategy=subtree -Xsubtree=dts/upstream/
9de355a75fdeffc26486508107bf644ca2749fdb
$ ./dts/update-dts-subtree.sh v6.8-rc2-dts

If you would like it to be documented then I can do that for the next rev.

[1] https://github.com/b49020/u-boot/commits/v4_dt_demo_fixes/

Quoted 6 lines

I would let board owners/custodians to deal with their boards. There is very high chance that if you do it globally that it is question of time when something will break.
It make sense to talk about how to do that transition and describe that steps and having tools/script to help with.

Given my comments above, I think we should at least give U-Boot owners/custodians a chance to opt for this and see how it pans out. It will give a better opportunity for the U-Boot community to engage and be a part of the current DT contribution model.

-Sumit

Quoted 3 lines

Thanks,
Michal

#30 lore raw

On Wed, Jan 31, 2024 at 06:26:54PM +0530, Sumit Garg wrote:

[snip]

Quoted 12 lines

So I did a demo experiment for this here [1] where cherry picking DT fixes into subtree just worked fine with the next uprev. Steps followed:

$ cd <U-Boot tree>/
$ git remote add dt-rebasing
https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git
$ git fetch dt-rebasing master
$ git cherry-pick -x --strategy=subtree -Xsubtree=dts/upstream/
9de355a75fdeffc26486508107bf644ca2749fdb
$ ./dts/update-dts-subtree.sh v6.8-rc2-dts
Quoted 1 line

If you would like it to be documented then I can do that for the next rev.

Yes please.

Signature · 1 line
Tom
#31 lore raw
In reply to Sumit Garg

On Wed, 10 Jan 2024 16:05:36 +0530
Sumit Garg <[email protected]> wrote:

Hi,

I certainly welcome this more automatic synchronisation of the DTs, however have one comment about the upcoming sync process:

Quoted 9 lines

...
However, Linux kernel DT maintainers proposed [2] for U-Boot to rather use devicetree-rebasing repo [3] which is a forked copy from Linux kernel for DT source files as well as bindings. It is tagged at every Linux kernel major release or intermideate release candidates. So here I have tried to reuse that to bring DT bingings compliance as well as a standard way to maintain a regular sync of DT source files with Linux kernel.

Quoted 4 lines

In order to maintain devicetree files sync, U-Boot will maintains a Git subtree for devicetee-rebasing repo as dts/upstream sub-directory. U-Boot will regularly sync dts/upstream/ subtree whenever the next window opens with the next available kernel major release.

I hope this doesn't need to stay that restricted? Can we either sync more often, or at least on the kernel's -rc1, and not only on a "full" release?

The reason I ask is that we have a chicken-egg problem here: without a DT merged into the kernel tree, no U-Boot board support can be merged. And without U-Boot support, we cannot boot a kernel, at least not in the canonical way.

Since the U-Boot and kernel merge windows are not in phase, for sunxi I try to sync the kernel DTs either as early as possible (-rc1, sometimes even before, when the maintainers have merged them into their tree), or sometimes "out of season", if a board defconfig patch is coming up.

Otherwise new board support, which typically has a very low regression risk for the rest of the code base, would need to be delayed until the next release. In the worst case the U-Boot merge windows opens one week before a kernel release, then new boards need to wait three months?

Cheers,
Andre

Quoted 14 lines

dts/update-dts-subtree.sh script provides a wrapper around git subtree pull command, usage from the top level U-Boot source tree, run:

$ ./dts/update-dts-subtree.sh <devicetree-rebasing-release-tag>

The RFC/prototype for this series has been discussed with Linux DT maintainers as well as U-Boot maintainers here [4]. Now we would like to reach out to wider U-Boot community to seek feedback.

[1] https://lore.kernel.org/all/CAFA6WYMLUD9cnkr=R0Uur+1UeTMkKjM2zDdMJtXb3nmrLk+pDg@mail.gmail.com/
[2] https://lore.kernel.org/all/CAL_JsqKEjv2tSGmT+0ZiO7_qbBfhTycbGnhJhYpKDFzfO9jzDg@mail.gmail.com/
[3] https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/
[4] https://github.com/u-boot/u-boot/pull/451

#32 lore raw
Quoted 35 lines · Andre Przywara

On Wed, 10 Jan 2024 16:05:36 +0530
Sumit Garg <[email protected]> wrote:

Hi,

I certainly welcome this more automatic synchronisation of the DTs, however have one comment about the upcoming sync process:

Quoted 9 lines

...
However, Linux kernel DT maintainers proposed [2] for U-Boot to rather use devicetree-rebasing repo [3] which is a forked copy from Linux kernel for DT source files as well as bindings. It is tagged at every Linux kernel major release or intermideate release candidates. So here I have tried to reuse that to bring DT bingings compliance as well as a standard way to maintain a regular sync of DT source files with Linux kernel.

Quoted 4 lines

In order to maintain devicetree files sync, U-Boot will maintains a Git subtree for devicetee-rebasing repo as dts/upstream sub-directory. U-Boot will regularly sync dts/upstream/ subtree whenever the next window opens with the next available kernel major release.

I hope this doesn't need to stay that restricted? Can we either sync more often, or at least on the kernel's -rc1, and not only on a "full" release?

The reason I ask is that we have a chicken-egg problem here: without a DT merged into the kernel tree, no U-Boot board support can be merged. And without U-Boot support, we cannot boot a kernel, at least not in the canonical way.

Since the U-Boot and kernel merge windows are not in phase, for sunxi I try to sync the kernel DTs either as early as possible (-rc1, sometimes even before, when the maintainers have merged them into their tree), or sometimes "out of season", if a board defconfig patch is coming up.

Quoted 4 lines

Otherwise new board support, which typically has a very low regression risk for the rest of the code base, would need to be delayed until the next release. In the worst case the U-Boot merge windows opens one week before a kernel release, then new boards need to wait three months?

Would it be to bad to bring in board X with OF_UPSTREAM=n for one U-Boot release, and then with the next one switch to OF_UPSTREAM=y (and delete the dts from arch/) for the next release, when we would have gotten back in sync?

Signature · 1 line
Tom
#33 lore raw

On Mon, 22 Jan 2024 11:49:59 -0500
Tom Rini <[email protected]> wrote:

Hi Tom,

Quoted 41 lines · Andre Przywara
Quoted 35 lines

On Wed, 10 Jan 2024 16:05:36 +0530
Sumit Garg <[email protected]> wrote:

Hi,

I certainly welcome this more automatic synchronisation of the DTs, however have one comment about the upcoming sync process:

Quoted 9 lines

...
However, Linux kernel DT maintainers proposed [2] for U-Boot to rather use devicetree-rebasing repo [3] which is a forked copy from Linux kernel for DT source files as well as bindings. It is tagged at every Linux kernel major release or intermideate release candidates. So here I have tried to reuse that to bring DT bingings compliance as well as a standard way to maintain a regular sync of DT source files with Linux kernel.

Quoted 4 lines

In order to maintain devicetree files sync, U-Boot will maintains a Git subtree for devicetee-rebasing repo as dts/upstream sub-directory. U-Boot will regularly sync dts/upstream/ subtree whenever the next window opens with the next available kernel major release.

I hope this doesn't need to stay that restricted? Can we either sync more often, or at least on the kernel's -rc1, and not only on a "full" release?

The reason I ask is that we have a chicken-egg problem here: without a DT merged into the kernel tree, no U-Boot board support can be merged. And without U-Boot support, we cannot boot a kernel, at least not in the canonical way.

Since the U-Boot and kernel merge windows are not in phase, for sunxi I try to sync the kernel DTs either as early as possible (-rc1, sometimes even before, when the maintainers have merged them into their tree), or sometimes "out of season", if a board defconfig patch is coming up.

Quoted 4 lines

Otherwise new board support, which typically has a very low regression risk for the rest of the code base, would need to be delayed until the next release. In the worst case the U-Boot merge windows opens one week before a kernel release, then new boards need to wait three months?

Quoted 4 lines

Would it be to bad to bring in board X with OF_UPSTREAM=n for one U-Boot release, and then with the next one switch to OF_UPSTREAM=y (and delete the dts from arch/) for the next release, when we would have gotten back in sync?

Ah, I didn't look into the actual patches, but if this provision is there, that sounds surely acceptable. It might still be good to sync earlier than the .0 kernel release: if it appears in Linus' tree, it had already seen a good share of review and testing. And with the U-Boot releases being always further away than the next kernel release, we could pull fixes still in time. So we could pick the latest -rc (or .0 release, whichever is more recent) when the U-Boot merge window opens?

Cheers,
Andre

#34 lore raw
Quoted 52 lines · Andre Przywara

On Mon, 22 Jan 2024 11:49:59 -0500
Tom Rini <[email protected]> wrote:

Hi Tom,

Quoted 41 lines · Andre Przywara
Quoted 35 lines

On Wed, 10 Jan 2024 16:05:36 +0530
Sumit Garg <[email protected]> wrote:

Hi,

I certainly welcome this more automatic synchronisation of the DTs, however have one comment about the upcoming sync process:

Quoted 9 lines

...
However, Linux kernel DT maintainers proposed [2] for U-Boot to rather use devicetree-rebasing repo [3] which is a forked copy from Linux kernel for DT source files as well as bindings. It is tagged at every Linux kernel major release or intermideate release candidates. So here I have tried to reuse that to bring DT bingings compliance as well as a standard way to maintain a regular sync of DT source files with Linux kernel.

Quoted 4 lines

In order to maintain devicetree files sync, U-Boot will maintains a Git subtree for devicetee-rebasing repo as dts/upstream sub-directory. U-Boot will regularly sync dts/upstream/ subtree whenever the next window opens with the next available kernel major release.

I hope this doesn't need to stay that restricted? Can we either sync more often, or at least on the kernel's -rc1, and not only on a "full" release?

The reason I ask is that we have a chicken-egg problem here: without a DT merged into the kernel tree, no U-Boot board support can be merged. And without U-Boot support, we cannot boot a kernel, at least not in the canonical way.

Since the U-Boot and kernel merge windows are not in phase, for sunxi I try to sync the kernel DTs either as early as possible (-rc1, sometimes even before, when the maintainers have merged them into their tree), or sometimes "out of season", if a board defconfig patch is coming up.

Quoted 4 lines

Otherwise new board support, which typically has a very low regression risk for the rest of the code base, would need to be delayed until the next release. In the worst case the U-Boot merge windows opens one week before a kernel release, then new boards need to wait three months?

Quoted 4 lines

Would it be to bad to bring in board X with OF_UPSTREAM=n for one U-Boot release, and then with the next one switch to OF_UPSTREAM=y (and delete the dts from arch/) for the next release, when we would have gotten back in sync?

Quoted 8 lines

Ah, I didn't look into the actual patches, but if this provision is there, that sounds surely acceptable. It might still be good to sync earlier than the .0 kernel release: if it appears in Linus' tree, it had already seen a good share of review and testing. And with the U-Boot releases being always further away than the next kernel release, we could pull fixes still in time. So we could pick the latest -rc (or .0 release, whichever is more recent) when the U-Boot merge window opens?

That should be mostly fine IMO, but there are the occasional "oops, let's change/fix the binding before it's released".

Couldn't you pull in the latest rc in the merge window, but only if the .0 release will happen before the next u-boot release. And then update from rc to .0 before the u-boot release.

Also, from a quick look at the dts changes during rc releases, they tend to come in the later rc releases. Probably that's just the latency of going to sub-arch maintainer->SoC->Linus.

Rob

author
#35 lore raw

Hi Rob, Andre,

Quoted 66 lines · Rob Herring
Quoted 52 lines · Andre Przywara

On Mon, 22 Jan 2024 11:49:59 -0500
Tom Rini <[email protected]> wrote:

Hi Tom,

Quoted 41 lines · Andre Przywara
Quoted 35 lines

On Wed, 10 Jan 2024 16:05:36 +0530
Sumit Garg <[email protected]> wrote:

Hi,

I certainly welcome this more automatic synchronisation of the DTs, however have one comment about the upcoming sync process:

Quoted 9 lines

...
However, Linux kernel DT maintainers proposed [2] for U-Boot to rather use devicetree-rebasing repo [3] which is a forked copy from Linux kernel for DT source files as well as bindings. It is tagged at every Linux kernel major release or intermideate release candidates. So here I have tried to reuse that to bring DT bingings compliance as well as a standard way to maintain a regular sync of DT source files with Linux kernel.

Quoted 4 lines

In order to maintain devicetree files sync, U-Boot will maintains a Git subtree for devicetee-rebasing repo as dts/upstream sub-directory. U-Boot will regularly sync dts/upstream/ subtree whenever the next window opens with the next available kernel major release.

I hope this doesn't need to stay that restricted? Can we either sync more often, or at least on the kernel's -rc1, and not only on a "full" release?

The reason I ask is that we have a chicken-egg problem here: without a DT merged into the kernel tree, no U-Boot board support can be merged. And without U-Boot support, we cannot boot a kernel, at least not in the canonical way.

Since the U-Boot and kernel merge windows are not in phase, for sunxi I try to sync the kernel DTs either as early as possible (-rc1, sometimes even before, when the maintainers have merged them into their tree), or sometimes "out of season", if a board defconfig patch is coming up.

Quoted 4 lines

Otherwise new board support, which typically has a very low regression risk for the rest of the code base, would need to be delayed until the next release. In the worst case the U-Boot merge windows opens one week before a kernel release, then new boards need to wait three months?

Quoted 4 lines

Would it be to bad to bring in board X with OF_UPSTREAM=n for one U-Boot release, and then with the next one switch to OF_UPSTREAM=y (and delete the dts from arch/) for the next release, when we would have gotten back in sync?

Quoted 8 lines

Ah, I didn't look into the actual patches, but if this provision is there, that sounds surely acceptable. It might still be good to sync earlier than the .0 kernel release: if it appears in Linus' tree, it had already seen a good share of review and testing. And with the U-Boot releases being always further away than the next kernel release, we could pull fixes still in time. So we could pick the latest -rc (or .0 release, whichever is more recent) when the U-Boot merge window opens?

That should be mostly fine IMO, but there are the occasional "oops, let's change/fix the binding before it's released".

Quoted 8 lines

Couldn't you pull in the latest rc in the merge window, but only if the .0 release will happen before the next u-boot release. And then update from rc to .0 before the u-boot release.

Also, from a quick look at the dts changes during rc releases, they tend to come in the later rc releases. Probably that's just the latency of going to sub-arch maintainer->SoC->Linus.

I agree with your intent to keep U-Boot updated with the latest Linux DT .0 releases. However, we would like to provide sufficient time (a full U-Boot release cycle) for U-Boot developers/maintainers to adapt, detect and fix problems for their platforms wrt. to a new Linux DT .0 release. We can always revisit the syncing strategy to be more aggressive if everything pans out as per plan.

-Sumit

Quoted 1 line

Rob