aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/devicetree/bindings/submitting-patches.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
index b7ba01ad1426..56742bc70218 100644
--- a/Documentation/devicetree/bindings/submitting-patches.txt
+++ b/Documentation/devicetree/bindings/submitting-patches.txt
@@ -15,6 +15,29 @@ I. For patch submitters
15 3) The Documentation/ portion of the patch should come in the series before 15 3) The Documentation/ portion of the patch should come in the series before
16 the code implementing the binding. 16 the code implementing the binding.
17 17
18 4) Any compatible strings used in a chip or board DTS file must be
19 previously documented in the corresponding DT binding text file
20 in Documentation/devicetree/bindings. This rule applies even if
21 the Linux device driver does not yet match on the compatible
22 string. [ checkpatch will emit warnings if this step is not
23 followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864
24 ("checkpatch: add DT compatible string documentation checks"). ]
25
26 5) The wildcard "<chip>" may be used in compatible strings, as in
27 the following example:
28
29 - compatible: Must contain '"nvidia,<chip>-pcie",
30 "nvidia,tegra20-pcie"' where <chip> is tegra30, tegra132, ...
31
32 As in the above example, the known values of "<chip>" should be
33 documented if it is used.
34
35 6) If a documented compatible string is not yet matched by the
36 driver, the documentation should also include a compatible
37 string that is matched by the driver (as in the "nvidia,tegra20-pcie"
38 example above).
39
40
18II. For kernel maintainers 41II. For kernel maintainers
19 42
20 1) If you aren't comfortable reviewing a given binding, reply to it and ask 43 1) If you aren't comfortable reviewing a given binding, reply to it and ask