1 .. SPDX-License-Identifier: GPL-2.0
2
3 ==========================================
4 Submitting Devicetree (DT) binding patches
5 ==========================================
6
7 I. For patch submitters
8 =======================
9
10 0) Normal patch submission rules from
11 Documentation/process/submitting-patches.
12
13 1) The Documentation/ and include/dt-binding
14 be a separate patch. The preferred subjec
15
16 "dt-bindings: <binding dir>: ..."
17
18 Few subsystems, like ASoC, media, regulat
19 of the prefixes::
20
21 "<binding dir>: dt-bindings: ..."
22
23 The 80 characters of the subject are prec
24 use "Documentation" or "doc" because that
25 docs. Repeating "binding" again should al
26
27 2) DT binding files are written in DT schema
28 vocabulary and YAML file format. The DT b
29 by running::
30
31 make dt_binding_check
32
33 See Documentation/devicetree/bindings/wri
34 about schema and tools setup.
35
36 3) DT binding files should be dual licensed.
37 (GPL-2.0-only OR BSD-2-Clause).
38
39 4) Submit the entire series to the devicetre
40
41 devicetree@vger.kernel.org
42
43 and Cc: the DT maintainers. Use scripts/g
44 all of the DT maintainers.
45
46 5) The Documentation/ portion of the patch s
47 the code implementing the binding.
48
49 6) Any compatible strings used in a chip or
50 previously documented in the correspondin
51 in Documentation/devicetree/bindings. Th
52 the Linux device driver does not yet matc
53 string. [ checkpatch will emit warnings
54 followed as of commit bff5da4335256513497
55 ("checkpatch: add DT compatible string do
56
57 7) If a documented compatible string is not
58 driver, the documentation should also inc
59 string that is matched by the driver.
60
61 8) Bindings are actively used by multiple pr
62 Kernel, extra care and consideration may
63 to existing bindings.
64
65 II. For kernel maintainers
66 ==========================
67
68 1) If you aren't comfortable reviewing a giv
69 the devicetree maintainers for guidance.
70 which ones to review and which ones are o
71
72 2) For driver (not subsystem) bindings: If y
73 binding, and it hasn't received an Acked-
74 maintainers after a few weeks, go ahead a
75
76 For subsystem bindings (anything affectin
77 getting a devicetree maintainer to review
78
79 3) For a series going though multiple trees,
80 kept with the driver using the binding.
81
82 III. Notes
83 ==========
84
85 0) Please see Documentation/devicetree/bindi
86 regarding devicetree ABI.
87
88 1) This document is intended as a general fa
89 decided at the 2013 Kernel Summit. When
90 devicetree maintainers overrules this doc
91 updating this document would be appreciat
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.