Documentation/devicetree/bindings/submitting-patches.txt

   1
   2   Submitting devicetree (DT) binding patches
   3
   4 I. For patch submitters
   5
   6   0) Normal patch submission rules from Documentation/process/submitting-patches.rst
   7      applies.
   8
   9   1) The Documentation/ and include/dt-bindings/ portion of the patch should
  10      be a separate patch. The preferred subject prefix for binding patches is:
  11
  12        "dt-bindings: <binding dir>: ..."
  13
  14      The 80 characters of the subject are precious. It is recommended to not
  15      use "Documentation" or "doc" because that is implied. All bindings are
  16      docs. Repeating "binding" again should also be avoided.
  17
  18   2) DT binding files are written in DT schema format using json-schema
  19      vocabulary and YAML file format. The DT binding files must pass validation
  20      by running:
  21
  22        make dt_binding_check
  23
  24      See ../writing-schema.rst for more details about schema and tools setup.
  25
  26   3) DT binding files should be dual licensed. The preferred license tag is
  27      (GPL-2.0-only OR BSD-2-Clause).
  28
  29   4) Submit the entire series to the devicetree mailinglist at
  30
  31        devicetree@vger.kernel.org
  32
  33      and Cc: the DT maintainers. Use scripts/get_maintainer.pl to identify
  34      all of the DT maintainers.
  35
  36   5) The Documentation/ portion of the patch should come in the series before
  37      the code implementing the binding.
  38
  39   6) Any compatible strings used in a chip or board DTS file must be
  40      previously documented in the corresponding DT binding text file
  41      in Documentation/devicetree/bindings.  This rule applies even if
  42      the Linux device driver does not yet match on the compatible
  43      string.  [ checkpatch will emit warnings if this step is not
  44      followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864
  45      ("checkpatch: add DT compatible string documentation checks"). ]
  46
  47   7) The wildcard "<chip>" may be used in compatible strings, as in
  48      the following example:
  49
  50          - compatible: Must contain '"nvidia,<chip>-pcie",
  51            "nvidia,tegra20-pcie"' where <chip> is tegra30, tegra132, ...
  52
  53      As in the above example, the known values of "<chip>" should be
  54      documented if it is used.
  55
  56   8) If a documented compatible string is not yet matched by the
  57      driver, the documentation should also include a compatible
  58      string that is matched by the driver (as in the "nvidia,tegra20-pcie"
  59      example above).
  60
  61
  62 II. For kernel maintainers
  63
  64   1) If you aren't comfortable reviewing a given binding, reply to it and ask
  65      the devicetree maintainers for guidance.  This will help them prioritize
  66      which ones to review and which ones are ok to let go.
  67
  68   2) For driver (not subsystem) bindings: If you are comfortable with the
  69      binding, and it hasn't received an Acked-by from the devicetree
  70      maintainers after a few weeks, go ahead and take it.
  71
  72      Subsystem bindings (anything affecting more than a single device)
  73      then getting a devicetree maintainer to review it is required.
  74
  75   3) For a series going though multiple trees, the binding patch should be
  76      kept with the driver using the binding.
  77
  78 III. Notes
  79
  80   0) Please see ...bindings/ABI.txt for details regarding devicetree ABI.
  81
  82   1) This document is intended as a general familiarization with the process as
  83      decided at the 2013 Kernel Summit.  When in doubt, the current word of the
  84      devicetree maintainers overrules this document.  In that situation, a patch
  85      updating this document would be appreciated.