Skip to contentSkip to conversation

dt: Add a check for undocumented compatible strings in kernel

PATCH New Rob Herring 1 participant 1 message Sep 16, 2022

Subsystems (3)
lore
Share & tools
lore

Rob Herring

author maintainer
#0 lore raw

PATCH 1/1 dt: Add a check for undocumented compatible strings in kernel

Add a make target, dt_compatible_check, to extract compatible strings from kernel sources and check if they are documented by a schema. At least version v2022.08 of dtschema with dt-check-compatible is required.

This check can also be run manually on specific files or directories:

scripts/dtc/dt-extract-compatibles drivers/clk/ | \
xargs dt-check-compatible -v -s Documentation/devicetree/bindings/processed-schema.json

Currently, there are about 3800 undocumented compatible strings. Most of these are cases where the binding is not yet converted (given there are 1900 .txt binding files remaining).

---
 Documentation/devicetree/bindings/Makefile |  3 +
 Makefile                                   |  4 ++
 scripts/dtc/dt-extract-compatibles         | 68 ++++++++++++++++++++++
 3 files changed, 75 insertions(+)
 create mode 100755 scripts/dtc/dt-extract-compatibles
Documentation/devicetree/bindings/Makefile +3 -0
index 1eaccf135b30..bf2d8a8ced77 100644
@@ -75,3 +75,6 @@ always-$(CHECK_DT_BINDING) += $(patsubst $(srctree)/$(src)/%.yaml,%.example.dtb,
 # build artifacts here before they are processed by scripts/Makefile.clean
 clean-files = $(shell find $(obj) \( -name '*.example.dts' -o \
 			-name '*.example.dtb' \) -delete 2>/dev/null)
+
+dt_compatible_check: $(obj)/processed-schema.json
+	$(Q)$(srctree)/scripts/dtc/dt-extract-compatibles $(srctree) | xargs dt-check-compatible -v -s $<
Makefile +4 -0
index f09673b6c11d..7f19e1725b2f 100644
@@ -1419,6 +1419,10 @@ PHONY += dt_binding_check
 dt_binding_check: scripts_dtc
 	$(Q)$(MAKE) $(build)=Documentation/devicetree/bindings
 
+PHONY += dt_compatible_check
+dt_compatible_check: dt_binding_check
+	$(Q)$(MAKE) $(build)=Documentation/devicetree/bindings $@
+
 # ---------------------------------------------------------------------------
 # Modules
 
scripts/dtc/dt-extract-compatibles new file +68 -0

68 lines not on this page · raw message

Signature · 1 line
2.34.1