Commit 4f0e3a57 authored by Rob Herring's avatar Rob Herring
Browse files

kbuild: Add support for DT binding schema checks 



This adds the build infrastructure for checking DT binding schema
documents and validating dts files using the binding schema.

Check DT binding schema documents:
make dt_binding_check

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.

Currently, the validation targets are separate from a normal build to
avoid a hard dependency on the external DT schema project and because
there are lots of warnings generated.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Mark Rutland <mark.rutland@arm.com>
Acked-by: default avatarMasahiro Yamada <yamada.masahiro@socionext.com>
Cc: Michal Marek <michal.lkml@markovi.net>
Cc: linux-doc@vger.kernel.org
Cc: devicetree@vger.kernel.org
Cc: linux-kbuild@vger.kernel.org
Signed-off-by: default avatarRob Herring <robh@kernel.org>
parent ccda4af0

.gitignore

+1 −0
Original line number Diff line number Diff line
@@ -15,6 +15,7 @@ 
*.bin

*.bz2

*.c.[012]*.*

*.dt.yaml

*.dtb

*.dtb.S

*.dwo

Documentation/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
# Makefile for Sphinx documentation

#



subdir-y :=

subdir-y := devicetree/bindings/



# You can set these variables from the command line.

SPHINXBUILD   = sphinx-build

Documentation/devicetree/bindings/.gitignore

0 → 100644
+2 −0
Original line number Diff line number Diff line 
*.example.dts

processed-schema.yaml

Documentation/devicetree/bindings/Makefile

0 → 100644
+27 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: GPL-2.0

DT_DOC_CHECKER ?= dt-doc-validate

DT_EXTRACT_EX ?= dt-extract-example

DT_MK_SCHEMA ?= dt-mk-schema

DT_MK_SCHEMA_FLAGS := $(if $(DT_SCHEMA_FILES), -u)



quiet_cmd_chk_binding = CHKDT   $(patsubst $(srctree)/%,%,$<)

      cmd_chk_binding = $(DT_DOC_CHECKER) $< ; \

                        $(DT_EXTRACT_EX) $< > $@



$(obj)/%.example.dts: $(src)/%.yaml FORCE

	$(call if_changed,chk_binding)



DT_TMP_SCHEMA := processed-schema.yaml

extra-y += $(DT_TMP_SCHEMA)



quiet_cmd_mk_schema = SCHEMA  $@

      cmd_mk_schema = $(DT_MK_SCHEMA) $(DT_MK_SCHEMA_FLAGS) -o $@ $(filter-out FORCE, $^)



DT_DOCS = $(shell cd $(srctree)/$(src) && find * -name '*.yaml')

DT_SCHEMA_FILES ?= $(addprefix $(src)/,$(DT_DOCS))



extra-y += $(patsubst $(src)/%.yaml,%.example.dts, $(DT_SCHEMA_FILES))

extra-y += $(patsubst $(src)/%.yaml,%.example.dtb, $(DT_SCHEMA_FILES))



$(obj)/$(DT_TMP_SCHEMA): $(DT_SCHEMA_FILES) FORCE

	$(call if_changed,mk_schema)

Makefile

+10 −3
Original line number Diff line number Diff line
@@ -1232,10 +1232,13 @@ ifneq ($(dtstree),) 
%.dtb: prepare3 scripts_dtc

	$(Q)$(MAKE) $(build)=$(dtstree) $(dtstree)/$@



PHONY += dtbs dtbs_install

dtbs: prepare3 scripts_dtc

PHONY += dtbs dtbs_install dt_binding_check

dtbs dtbs_check: prepare3 scripts_dtc

	$(Q)$(MAKE) $(build)=$(dtstree)



dtbs_check: export CHECK_DTBS=1

dtbs_check: dt_binding_check



dtbs_install:

	$(Q)$(MAKE) $(dtbinst)=$(dtstree)
@@ -1249,6 +1252,9 @@ PHONY += scripts_dtc 
scripts_dtc: scripts_basic

	$(Q)$(MAKE) $(build)=scripts/dtc



dt_binding_check: scripts_dtc

	$(Q)$(MAKE) $(build)=Documentation/devicetree/bindings



# ---------------------------------------------------------------------------

# Modules
@@ -1611,7 +1617,8 @@ clean: $(clean-dirs) 
	$(call cmd,rmfiles)

	@find $(if $(KBUILD_EXTMOD), $(KBUILD_EXTMOD), .) $(RCS_FIND_IGNORE) \

		\( -name '*.[aios]' -o -name '*.ko' -o -name '.*.cmd' \

		-o -name '*.ko.*' -o -name '*.dtb' -o -name '*.dtb.S' \

		-o -name '*.ko.*' \

		-o -name '*.dtb' -o -name '*.dtb.S' -o -name '*.dt.yaml' \

		-o -name '*.dwo' -o -name '*.lst' \

		-o -name '*.su'  \

		-o -name '.*.d' -o -name '.*.tmp' -o -name '*.mod.c' \

CRA Git | Maintained and supported by SUSTech CRA and CCSE