0080665fbd
- Refactoring powerpc and arm64 kexec DT handling to common code. This enables IMA on arm64. - Add kbuild support for applying DT overlays at build time. The first user are the DT unittests. - Fix kerneldoc formatting and W=1 warnings in drivers/of/ - Fix handling 64-bit flag on PCI resources - Bump dtschema version required to v2021.2.1 - Enable undocumented compatible checks for dtbs_check. This allows tracking of missing binding schemas. - DT docs improvements. Regroup the DT docs and add the example schema and DT kernel ABI docs to the doc build. - Convert Broadcom Bluetooth and video-mux bindings to schema - Add QCom sm8250 Venus video codec binding schema - Add vendor prefixes for AESOP, YIC System Co., Ltd, and Siliconfile Technologies Inc. - Cleanup of DT schema type references on common properties and standard unit properties -----BEGIN PGP SIGNATURE----- iQJEBAABCgAuFiEEktVUI4SxYhzZyEuo+vtdtY28YcMFAmCIYdgQHHJvYmhAa2Vy bmVsLm9yZwAKCRD6+121jbxhw/PKEACkOCWDnLSY9U7w1uGDHr6UgXIWOY9j8bYy 2pTvDrVa6KZphT6yGU/hxrOk8Mqh5AMd2vUhO2OCoyyl/priTv+Ktqo+bikvJZLa MQm3JnrLpPy/GetdmVD8wq1l+FoeOSTnRIJqRxInsd8UFVpZImtP22ELox6KgGiv keVHIrjsHU/HpafK3w8wHCLikCZk+1Gl6pL/QgFDv2FaaCTKW16Dt64dPqYm49Xk j7YMMQWl+3NJ9ywZV0+PMbl9udi3EjGm5Ap5VfKzpj53Nh07QObg/QtH/1sj0HPo apyW7jAyQFyLytbjxzFL/tljtOeW/5rZos1GWThZ326e+Y0mTKUTDZShvNplfjIf e26FvVi7gndWlRSr30Ia5gdNFAx72IkpJUAuypBXgb+qNPchBJjAXLn9tcIcg/k+ 2R6BIB7SkVLpgTnJ1Bq1+PRqkKM+ggACdJNJIUApj44xoiG01vtGDGRaFuIio+Ch HT4aBbic4kLvagm8VzuiIF/sL7af5pntzArcyOfQTaZ92DyGI2C0j90rK3yPRIYM u9qX/24t1SXiUji74QpoQFzt/+Egy5hYXMJOJJSywUjKf7DBhehqklTjiJRQHKm6 0DJ/n8q4lNru8F0Y4keKSuYTfHBstF7fS3UTH/rUmBAbfEwkvZe6B29KQbs+7aph GTw+jeoR5Q== =rF27 -----END PGP SIGNATURE----- Merge tag 'devicetree-for-5.13' of git://git.kernel.org/pub/scm/linux/kernel/git/robh/linux Pull devicetree updates from Rob Herring: - Refactor powerpc and arm64 kexec DT handling to common code. This enables IMA on arm64. - Add kbuild support for applying DT overlays at build time. The first user are the DT unittests. - Fix kerneldoc formatting and W=1 warnings in drivers/of/ - Fix handling 64-bit flag on PCI resources - Bump dtschema version required to v2021.2.1 - Enable undocumented compatible checks for dtbs_check. This allows tracking of missing binding schemas. - DT docs improvements. Regroup the DT docs and add the example schema and DT kernel ABI docs to the doc build. - Convert Broadcom Bluetooth and video-mux bindings to schema - Add QCom sm8250 Venus video codec binding schema - Add vendor prefixes for AESOP, YIC System Co., Ltd, and Siliconfile Technologies Inc. - Cleanup of DT schema type references on common properties and standard unit properties * tag 'devicetree-for-5.13' of git://git.kernel.org/pub/scm/linux/kernel/git/robh/linux: (64 commits) powerpc: If kexec_build_elf_info() fails return immediately from elf64_load() powerpc: Free fdt on error in elf64_load() of: overlay: Fix kerneldoc warning in of_overlay_remove() of: linux/of.h: fix kernel-doc warnings of/pci: Add IORESOURCE_MEM_64 to resource flags for 64-bit memory addresses dt-bindings: bcm4329-fmac: add optional brcm,ccode-map docs: dt: update writing-schema.rst references dt-bindings: media: venus: Add sm8250 dt schema of: base: Fix spelling issue with function param 'prop' docs: dt: Add DT API documentation of: Add missing 'Return' section in kerneldoc comments of: Fix kerneldoc output formatting docs: dt: Group DT docs into relevant sub-sections docs: dt: Make 'Devicetree' wording more consistent docs: dt: writing-schema: Include the example schema in the doc build docs: dt: writing-schema: Remove spurious indentation dt-bindings: Fix reference in submitting-patches.rst to the DT ABI doc dt-bindings: ddr: Add optional manufacturer and revision ID to LPDDR3 dt-bindings: media: video-interfaces: Drop the example devicetree: bindings: clock: Minor typo fix in the file armada3700-tbg-clock.txt ...
93 lines
3.6 KiB
ReStructuredText
93 lines
3.6 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
==========================================
|
|
Submitting Devicetree (DT) binding patches
|
|
==========================================
|
|
|
|
I. For patch submitters
|
|
=======================
|
|
|
|
0) Normal patch submission rules from Documentation/process/submitting-patches.rst
|
|
applies.
|
|
|
|
1) The Documentation/ and include/dt-bindings/ portion of the patch should
|
|
be a separate patch. The preferred subject prefix for binding patches is::
|
|
|
|
"dt-bindings: <binding dir>: ..."
|
|
|
|
The 80 characters of the subject are precious. It is recommended to not
|
|
use "Documentation" or "doc" because that is implied. All bindings are
|
|
docs. Repeating "binding" again should also be avoided.
|
|
|
|
2) DT binding files are written in DT schema format using json-schema
|
|
vocabulary and YAML file format. The DT binding files must pass validation
|
|
by running::
|
|
|
|
make dt_binding_check
|
|
|
|
See Documentation/devicetree/bindings/writing-schema.rst for more details about
|
|
schema and tools setup.
|
|
|
|
3) DT binding files should be dual licensed. The preferred license tag is
|
|
(GPL-2.0-only OR BSD-2-Clause).
|
|
|
|
4) Submit the entire series to the devicetree mailinglist at
|
|
|
|
devicetree@vger.kernel.org
|
|
|
|
and Cc: the DT maintainers. Use scripts/get_maintainer.pl to identify
|
|
all of the DT maintainers.
|
|
|
|
5) The Documentation/ portion of the patch should come in the series before
|
|
the code implementing the binding.
|
|
|
|
6) Any compatible strings used in a chip or board DTS file must be
|
|
previously documented in the corresponding DT binding text file
|
|
in Documentation/devicetree/bindings. This rule applies even if
|
|
the Linux device driver does not yet match on the compatible
|
|
string. [ checkpatch will emit warnings if this step is not
|
|
followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864
|
|
("checkpatch: add DT compatible string documentation checks"). ]
|
|
|
|
7) The wildcard "<chip>" may be used in compatible strings, as in
|
|
the following example:
|
|
|
|
- compatible: Must contain '"nvidia,<chip>-pcie",
|
|
"nvidia,tegra20-pcie"' where <chip> is tegra30, tegra132, ...
|
|
|
|
As in the above example, the known values of "<chip>" should be
|
|
documented if it is used.
|
|
|
|
8) If a documented compatible string is not yet matched by the
|
|
driver, the documentation should also include a compatible
|
|
string that is matched by the driver (as in the "nvidia,tegra20-pcie"
|
|
example above).
|
|
|
|
|
|
II. For kernel maintainers
|
|
==========================
|
|
|
|
1) If you aren't comfortable reviewing a given binding, reply to it and ask
|
|
the devicetree maintainers for guidance. This will help them prioritize
|
|
which ones to review and which ones are ok to let go.
|
|
|
|
2) For driver (not subsystem) bindings: If you are comfortable with the
|
|
binding, and it hasn't received an Acked-by from the devicetree
|
|
maintainers after a few weeks, go ahead and take it.
|
|
|
|
For subsystem bindings (anything affecting more than a single device),
|
|
getting a devicetree maintainer to review it is required.
|
|
|
|
3) For a series going though multiple trees, the binding patch should be
|
|
kept with the driver using the binding.
|
|
|
|
III. Notes
|
|
==========
|
|
|
|
0) Please see :doc:`ABI` for details regarding devicetree ABI.
|
|
|
|
1) This document is intended as a general familiarization with the process as
|
|
decided at the 2013 Kernel Summit. When in doubt, the current word of the
|
|
devicetree maintainers overrules this document. In that situation, a patch
|
|
updating this document would be appreciated.
|