€•wmŒsphinx.addnodes”Œdocument”“”)”}”(Œ rawsource”Œ”Œchildren”]”(Œ translations”Œ LanguagesNode”“”)”}”(hhh]”(hŒ pending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ refdomain”Œstd”Œreftype”Œdoc”Œ reftarget”Œ:/translations/zh_CN/devicetree/bindings/submitting-patches”Œmodname”NŒ classname”NŒ refexplicit”ˆuŒtagname”hhh ubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ:/translations/zh_TW/devicetree/bindings/submitting-patches”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ:/translations/it_IT/devicetree/bindings/submitting-patches”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ:/translations/ja_JP/devicetree/bindings/submitting-patches”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ:/translations/ko_KR/devicetree/bindings/submitting-patches”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ:/translations/pt_BR/devicetree/bindings/submitting-patches”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ:/translations/sp_SP/devicetree/bindings/submitting-patches”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h hhŒ _document”hŒsource”NŒline”NubhŒcomment”“”)”}”(hŒ SPDX-License-Identifier: GPL-2.0”h]”hŒ SPDX-License-Identifier: GPL-2.0”…””}”hh·sbah}”(h]”h ]”h"]”h$]”h&]”Œ xml:space”Œpreserve”uh1hµhhh²hh³ŒT/var/lib/git/docbuild/linux/Documentation/devicetree/bindings/submitting-patches.rst”h“KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ*Submitting Devicetree (DT) binding patches”h]”hŒ*Submitting Devicetree (DT) binding patches”…””}”(hhĻh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hĶhhŹh²hh³hĒh“KubhÉ)”}”(hhh]”(hĪ)”}”(hŒI. For patch submitters”h]”hŒI. For patch submitters”…””}”(hhąh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hĶhhŻh²hh³hĒh“KubhŒ block_quote”“”)”}”(hXū 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: : ..." Few subsystems, like ASoC, media, regulators, SCSI, SPI and UFS, expect reverse order of the prefixes, based on subsystem name:: ": dt-bindings: ..." The 80 characters of the subject are precious. It is recommended to not use "Documentation", "doc" or "YAML" because that is implied. All bindings are docs and all new bindings are supposed to be in Devicetree schema format. Repeating "binding" again should also be avoided, so for a new device it is often enough for example:: "dt-bindings: iio: adc: Add ROHM BD79100G" Conversion of other formats to DT schema:: "dt-bindings: iio: adc: adi,ad7476: Convert to DT schema" 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. The example DTS in new bindings should pass scripts/dtc/dt-check-style in 'strict' mode without warnings. 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 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) DTS is treated in general as driver-independent hardware description, thus any DTS patches, regardless whether using existing or new bindings, should be a separate posting or, when combined with driver patches, placed at the end of the patchset to indicate no dependency of drivers on the DTS. DTS will be anyway applied through separate tree or branch, so different order would indicate the series is non-bisectable. If a driver subsystem maintainer prefers to apply entire set, instead of their relevant portion of patchset, please split the DTS patches into separate patchset with a reference in changelog or cover letter to the bindings submission on the mailing list. 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. 9) Bindings are actively used by multiple projects other than the Linux Kernel, extra care and consideration may need to be taken when making changes to existing bindings. ”h]”hŒenumerated_list”“”)”}”(hhh]”(hŒ list_item”“”)”}”(hŒYNormal patch submission rules from Documentation/process/submitting-patches.rst applies. ”h]”hŒ paragraph”“”)”}”(hŒXNormal patch submission rules from Documentation/process/submitting-patches.rst applies.”h]”hŒXNormal patch submission rules from Documentation/process/submitting-patches.rst applies.”…””}”(hjh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K hhūubah}”(h]”h ]”h"]”h$]”h&]”uh1hłhhöubhś)”}”(hX@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: : ..." Few subsystems, like ASoC, media, regulators, SCSI, SPI and UFS, expect reverse order of the prefixes, based on subsystem name:: ": dt-bindings: ..." The 80 characters of the subject are precious. It is recommended to not use "Documentation", "doc" or "YAML" because that is implied. All bindings are docs and all new bindings are supposed to be in Devicetree schema format. Repeating "binding" again should also be avoided, so for a new device it is often enough for example:: "dt-bindings: iio: adc: Add ROHM BD79100G" Conversion of other formats to DT schema:: "dt-bindings: iio: adc: adi,ad7476: Convert to DT schema" ”h]”(j)”}”(hŒ’The Documentation/ and include/dt-bindings/ portion of the patch should be a separate patch. The preferred subject prefix for binding patches is::”h]”hŒ‘The Documentation/ and include/dt-bindings/ portion of the patch should be a separate patch. The preferred subject prefix for binding patches is:”…””}”(hjh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K hjubhŒ literal_block”“”)”}”(hŒ!"dt-bindings: : ..."”h]”hŒ!"dt-bindings: : ..."”…””}”hj)sbah}”(h]”h ]”h"]”h$]”h&]”hÅhĘuh1j'h³hĒh“Khjubj)”}”(hŒ€Few subsystems, like ASoC, media, regulators, SCSI, SPI and UFS, expect reverse order of the prefixes, based on subsystem name::”h]”hŒFew subsystems, like ASoC, media, regulators, SCSI, SPI and UFS, expect reverse order of the prefixes, based on subsystem name:”…””}”(hj7h²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“Khjubj()”}”(hŒ!": dt-bindings: ..."”h]”hŒ!": dt-bindings: ..."”…””}”hjEsbah}”(h]”h ]”h"]”h$]”h&]”hÅhĘuh1j'h³hĒh“Khjubj)”}”(hXHThe 80 characters of the subject are precious. It is recommended to not use "Documentation", "doc" or "YAML" because that is implied. All bindings are docs and all new bindings are supposed to be in Devicetree schema format. Repeating "binding" again should also be avoided, so for a new device it is often enough for example::”h]”hXWThe 80 characters of the subject are precious. It is recommended to not use ā€œDocumentationā€, ā€œdocā€ or ā€œYAMLā€ because that is implied. All bindings are docs and all new bindings are supposed to be in Devicetree schema format. Repeating ā€œbindingā€ again should also be avoided, so for a new device it is often enough for example:”…””}”(hjSh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“Khjubj()”}”(hŒ*"dt-bindings: iio: adc: Add ROHM BD79100G"”h]”hŒ*"dt-bindings: iio: adc: Add ROHM BD79100G"”…””}”hjasbah}”(h]”h ]”h"]”h$]”h&]”hÅhĘuh1j'h³hĒh“Khjubj)”}”(hŒ*Conversion of other formats to DT schema::”h]”hŒ)Conversion of other formats to DT schema:”…””}”(hjoh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“Khjubj()”}”(hŒ9"dt-bindings: iio: adc: adi,ad7476: Convert to DT schema"”h]”hŒ9"dt-bindings: iio: adc: adi,ad7476: Convert to DT schema"”…””}”hj}sbah}”(h]”h ]”h"]”h$]”h&]”hÅhĘuh1j'h³hĒh“K!hjubeh}”(h]”h ]”h"]”h$]”h&]”uh1hłhhöubhś)”}”(hXˆ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. The example DTS in new bindings should pass scripts/dtc/dt-check-style in 'strict' mode without warnings. ”h]”(j)”}”(hŒš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::”h]”hŒ™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:”…””}”(hj•h²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K#hj‘ubj()”}”(hŒmake dt_binding_check”h]”hŒmake dt_binding_check”…””}”hj£sbah}”(h]”h ]”h"]”h$]”h&]”hÅhĘuh1j'h³hĒh“K'hj‘ubj)”}”(hŒgSee Documentation/devicetree/bindings/writing-schema.rst for more details about schema and tools setup.”h]”hŒgSee Documentation/devicetree/bindings/writing-schema.rst for more details about schema and tools setup.”…””}”(hj±h²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K)hj‘ubj)”}”(hŒiThe example DTS in new bindings should pass scripts/dtc/dt-check-style in 'strict' mode without warnings.”h]”hŒmThe example DTS in new bindings should pass scripts/dtc/dt-check-style in ā€˜strictā€™ mode without warnings.”…””}”(hjæh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K,hj‘ubeh}”(h]”h ]”h"]”h$]”h&]”uh1hłhhöubhś)”}”(hŒgDT binding files should be dual licensed. The preferred license tag is (GPL-2.0-only OR BSD-2-Clause). ”h]”j)”}”(hŒfDT binding files should be dual licensed. The preferred license tag is (GPL-2.0-only OR BSD-2-Clause).”h]”hŒfDT binding files should be dual licensed. The preferred license tag is (GPL-2.0-only OR BSD-2-Clause).”…””}”(hj×h²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K/hjÓubah}”(h]”h ]”h"]”h$]”h&]”uh1hłhhöubhś)”}”(hŒŗ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. ”h]”(j)”}”(hŒ9Submit the entire series to the devicetree mailinglist at”h]”hŒ9Submit the entire series to the devicetree mailinglist at”…””}”(hjļh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K2hjėubhļ)”}”(hŒdevicetree@vger.kernel.org ”h]”j)”}”(hŒdevicetree@vger.kernel.org”h]”hŒ reference”“”)”}”(hjh]”hŒdevicetree@vger.kernel.org”…””}”(hjh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ!mailto:devicetree@vger.kernel.org”uh1jhjubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K4hjżubah}”(h]”h ]”h"]”h$]”h&]”uh1hīh³hĒh“K4hjėubj)”}”(hŒ`and Cc: the DT maintainers. Use scripts/get_maintainer.pl to identify all of the DT maintainers.”h]”hŒ`and Cc: the DT maintainers. Use scripts/get_maintainer.pl to identify all of the DT maintainers.”…””}”(hj"h²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K6hjėubeh}”(h]”h ]”h"]”h$]”h&]”uh1hłhhöubhś)”}”(hŒlThe Documentation/ portion of the patch should come in the series before the code implementing the binding. ”h]”j)”}”(hŒkThe Documentation/ portion of the patch should come in the series before the code implementing the binding.”h]”hŒkThe Documentation/ portion of the patch should come in the series before the code implementing the binding.”…””}”(hj:h²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“K9hj6ubah}”(h]”h ]”h"]”h$]”h&]”uh1hłhhöubhś)”}”(hX¶Any compatible strings used in a chip or board DTS file must be previously documented in the corresponding DT binding 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"). ] ”h]”j)”}”(hXµAny compatible strings used in a chip or board DTS file must be previously documented in the corresponding DT binding 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"). ]”h]”hX¹Any compatible strings used in a chip or board DTS file must be previously documented in the corresponding DT binding 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ā€). ]”…””}”(hjRh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’h³hĒh“KEnumerated list start value not ordinal-1: ā€œ0ā€ (ordinal 0)”…””}”(hj^h²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’hj[ubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”ŒINFO”Œsource”hĒŒline”Kuh1jYhhšubjZ)”}”(hhh]”j)”}”(hŒ:Enumerated list start value not ordinal-1: "0" (ordinal 0)”h]”hŒ>Enumerated list start value not ordinal-1: ā€œ0ā€ (ordinal 0)”…””}”(hjzh²hh³Nh“Nubah}”(h]”h ]”h"]”h$]”h&]”uh1h’hjwubah}”(h]”h ]”h"]”h$]”h&]”Œlevel”KŒtype”jtŒsource”hĒŒline”Kuh1jYhjubeŒtransform_messages”]”Œ transformer”NŒ include_log”]”Œ decoration”Nh²hub.