1# SPDX-License-Identifier: GPL-2.0
2DT_DOC_CHECKER ?= dt-doc-validate
3DT_EXTRACT_EX ?= dt-extract-example
4DT_MK_SCHEMA ?= dt-mk-schema
5
6DT_SCHEMA_LINT := $(shell which yamllint || \
7  echo "warning: python package 'yamllint' not installed, skipping" >&2)
8
9DT_SCHEMA_MIN_VERSION = 2021.2.1
10
11PHONY += check_dtschema_version
12check_dtschema_version:
13	@which $(DT_DOC_CHECKER) >/dev/null || \
14		{ echo "Error: '$(DT_DOC_CHECKER)' not found!" >&2; \
15		  echo "Ensure dtschema python package is installed and in your PATH." >&2; \
16		  echo "Current PATH is:" >&2; \
17		  echo "$$PATH" >&2; false; }
18	@{ echo $(DT_SCHEMA_MIN_VERSION); \
19	$(DT_DOC_CHECKER) --version 2>/dev/null || echo 0; } | sort -Vc >/dev/null || \
20	{ echo "ERROR: dtschema minimum version is v$(DT_SCHEMA_MIN_VERSION)" >&2; false; }
21
22quiet_cmd_extract_ex = DTEX    $@
23      cmd_extract_ex = $(DT_EXTRACT_EX) $< > $@
24
25$(obj)/%.example.dts: $(src)/%.yaml check_dtschema_version FORCE
26	$(call if_changed,extract_ex)
27
28# Use full schemas when checking %.example.dts
29DT_TMP_SCHEMA := $(obj)/processed-schema-examples.json
30
31find_all_cmd = find $(srctree)/$(src) \( -name '*.yaml' ! \
32		-name 'processed-schema*' ! \
33		-name '*.example.dt.yaml' \)
34
35find_cmd = $(find_all_cmd) | grep -F "$(DT_SCHEMA_FILES)"
36CHK_DT_DOCS := $(shell $(find_cmd))
37
38quiet_cmd_yamllint = LINT    $(src)
39      cmd_yamllint = ($(find_cmd) | \
40                     xargs -n200 -P$$(nproc) \
41		     $(DT_SCHEMA_LINT) -f parsable -c $(srctree)/$(src)/.yamllint >&2) || true
42
43quiet_cmd_chk_bindings = CHKDT   $@
44      cmd_chk_bindings = ($(find_cmd) | \
45                         xargs -n200 -P$$(nproc) $(DT_DOC_CHECKER) -u $(srctree)/$(src)) || true
46
47quiet_cmd_mk_schema = SCHEMA  $@
48      cmd_mk_schema = f=$$(mktemp) ; \
49                      $(if $(DT_MK_SCHEMA_FLAGS), \
50                           printf '%s\n' $(real-prereqs), \
51                           $(find_all_cmd)) > $$f ; \
52                      $(DT_MK_SCHEMA) -j $(DT_MK_SCHEMA_FLAGS) @$$f > $@ ; \
53		      rm -f $$f
54
55define rule_chkdt
56	$(if $(DT_SCHEMA_LINT),$(call cmd,yamllint),)
57	$(call cmd,chk_bindings)
58	$(call cmd,mk_schema)
59endef
60
61DT_DOCS = $(patsubst $(srctree)/%,%,$(shell $(find_all_cmd)))
62
63override DTC_FLAGS := \
64	-Wno-avoid_unnecessary_addr_size \
65	-Wno-graph_child_address \
66	-Wno-interrupt_provider \
67	-Wno-unique_unit_address \
68	-Wunique_unit_address_if_enabled
69
70# Disable undocumented compatible checks until warning free
71override DT_CHECKER_FLAGS ?=
72
73$(obj)/processed-schema-examples.json: $(DT_DOCS) $(src)/.yamllint check_dtschema_version FORCE
74	$(call if_changed_rule,chkdt)
75
76ifeq ($(DT_SCHEMA_FILES),)
77
78# Unless DT_SCHEMA_FILES is specified, use the full schema for dtbs_check too.
79# Just copy processed-schema-examples.json
80
81$(obj)/processed-schema.json: $(obj)/processed-schema-examples.json FORCE
82	$(call if_changed,copy)
83
84else
85
86# If DT_SCHEMA_FILES is specified, use it for processed-schema.json
87
88$(obj)/processed-schema.json: DT_MK_SCHEMA_FLAGS := -u
89$(obj)/processed-schema.json: $(CHK_DT_DOCS) check_dtschema_version FORCE
90	$(call if_changed,mk_schema)
91
92endif
93
94always-$(CHECK_DT_BINDING) += processed-schema-examples.json
95always-$(CHECK_DTBS)       += processed-schema.json
96always-$(CHECK_DT_BINDING) += $(patsubst $(srctree)/$(src)/%.yaml,%.example.dts, $(CHK_DT_DOCS))
97always-$(CHECK_DT_BINDING) += $(patsubst $(srctree)/$(src)/%.yaml,%.example.dt.yaml, $(CHK_DT_DOCS))
98
99# Hack: avoid 'Argument list too long' error for 'make clean'. Remove most of
100# build artifacts here before they are processed by scripts/Makefile.clean
101clean-files = $(shell find $(obj) \( -name '*.example.dts' -o \
102			-name '*.example.dt.yaml' \) -delete 2>/dev/null)
103