€•«vŒ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”Œ8/translations/zh_CN/devicetree/bindings/writing-bindings”Œmodname”NŒ classname”NŒ refexplicit”ˆuŒtagname”hhh ubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ8/translations/zh_TW/devicetree/bindings/writing-bindings”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ8/translations/it_IT/devicetree/bindings/writing-bindings”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ8/translations/ja_JP/devicetree/bindings/writing-bindings”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ8/translations/ko_KR/devicetree/bindings/writing-bindings”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ8/translations/pt_BR/devicetree/bindings/writing-bindings”Œmodname”NŒ classname”NŒ refexplicit”ˆuh1hhh ubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ refdomain”h)Œreftype”h+Œ reftarget”Œ8/translations/sp_SP/devicetree/bindings/writing-bindings”Œ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³ŒR/var/lib/git/docbuild/linux/Documentation/devicetree/bindings/writing-bindings.rst”h´KubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒDOs and DON’Ts for designing and writing Devicetree bindings”…””}”(hhÏh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhhÊh²hh³hÇh´KubhŒ paragraph”“”)”}”(hŒ’This is a list of common review feedback items focused on binding design. With every rule, there are exceptions and bindings have many gray areas.”h]”hŒ’This is a list of common review feedback items focused on binding design. With every rule, there are exceptions and bindings have many gray areas.”…””}”(hhßh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhhÊh²hubhÞ)”}”(hŒ_For guidelines related to patches, see Documentation/devicetree/bindings/submitting-patches.rst”h]”hŒ_For guidelines related to patches, see Documentation/devicetree/bindings/submitting-patches.rst”…””}”(hhíh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K hhÊh²hubhÉ)”}”(hhh]”(hÎ)”}”(hŒOverall design”h]”hŒOverall design”…””}”(hhþh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhhûh²hh³hÇh´KubhŒ bullet_list”“”)”}”(hhh]”(hŒ list_item”“”)”}”(hŒÏDO attempt to make bindings complete even if a driver doesn't support some features. For example, if a device has an interrupt, then include the 'interrupts' property even if the driver is only polled mode. ”h]”hÞ)”}”(hŒÎDO attempt to make bindings complete even if a driver doesn't support some features. For example, if a device has an interrupt, then include the 'interrupts' property even if the driver is only polled mode.”h]”hŒÔDO attempt to make bindings complete even if a driver doesn’t support some features. For example, if a device has an interrupt, then include the ‘interrupts’ property even if the driver is only polled mode.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjh²hh³hÇh´Nubj)”}”(hŒ•DON'T refer to Linux or "device driver" in bindings. Bindings should be based on what the hardware has, not what an OS and driver currently support. ”h]”hÞ)”}”(hŒ”DON'T refer to Linux or "device driver" in bindings. Bindings should be based on what the hardware has, not what an OS and driver currently support.”h]”hŒšDON’T refer to Linux or “device driver†in bindings. Bindings should be based on what the hardware has, not what an OS and driver currently support.”…””}”(hj/h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khj+ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjh²hh³hÇh´Nubj)”}”(hŒŒDO use node names matching the class of the device. Many standard names are defined in the DT Spec. If there isn't one, consider adding it. ”h]”hÞ)”}”(hŒ‹DO use node names matching the class of the device. Many standard names are defined in the DT Spec. If there isn't one, consider adding it.”h]”hŒDO use node names matching the class of the device. Many standard names are defined in the DT Spec. If there isn’t one, consider adding it.”…””}”(hjGh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KhjCubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjh²hh³hÇh´Nubj)”}”(hŒ\DO check that the example matches the documentation especially after making review changes. ”h]”hÞ)”}”(hŒ[DO check that the example matches the documentation especially after making review changes.”h]”hŒ[DO check that the example matches the documentation especially after making review changes.”…””}”(hj_h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khj[ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjh²hh³hÇh´Nubj)”}”(hŒàDON'T create nodes just for the sake of instantiating drivers. Multi-function devices only need child nodes when the child nodes have their own DT resources. A single node can be multiple providers (e.g. clocks and resets). ”h]”hÞ)”}”(hŒßDON'T create nodes just for the sake of instantiating drivers. Multi-function devices only need child nodes when the child nodes have their own DT resources. A single node can be multiple providers (e.g. clocks and resets).”h]”hŒáDON’T create nodes just for the sake of instantiating drivers. Multi-function devices only need child nodes when the child nodes have their own DT resources. A single node can be multiple providers (e.g. clocks and resets).”…””}”(hjwh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khjsubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjh²hh³hÇh´Nubj)”}”(hŒØDON'T treat device node names as a stable ABI, but instead use phandles or compatibles to find sibling devices. Exception: sub-nodes of given device could be treated as ABI, if explicitly documented in the bindings. ”h]”hÞ)”}”(hŒ×DON'T treat device node names as a stable ABI, but instead use phandles or compatibles to find sibling devices. Exception: sub-nodes of given device could be treated as ABI, if explicitly documented in the bindings.”h]”hŒÙDON’T treat device node names as a stable ABI, but instead use phandles or compatibles to find sibling devices. Exception: sub-nodes of given device could be treated as ABI, if explicitly documented in the bindings.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K"hj‹ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjh²hh³hÇh´Nubj)”}”(hŒÈDON'T use 'syscon' alone without a specific compatible string. A 'syscon' hardware block should have a compatible string unique enough to infer the register layout of the entire block (at a minimum). ”h]”hÞ)”}”(hŒÇDON'T use 'syscon' alone without a specific compatible string. A 'syscon' hardware block should have a compatible string unique enough to infer the register layout of the entire block (at a minimum).”h]”hŒÑDON’T use ‘syscon’ alone without a specific compatible string. A ‘syscon’ hardware block should have a compatible string unique enough to infer the register layout of the entire block (at a minimum).”…””}”(hj§h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K&hj£ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjh²hh³hÇh´Nubj)”}”(hŒíDON'T use 'simple-mfd' compatible for non-trivial devices, where children depend on some resources from the parent. Similarly, 'simple-bus' should not be used for complex buses and even 'regs' property means device is not a simple bus. ”h]”hÞ)”}”(hŒëDON'T use 'simple-mfd' compatible for non-trivial devices, where children depend on some resources from the parent. Similarly, 'simple-bus' should not be used for complex buses and even 'regs' property means device is not a simple bus.”h]”hŒùDON’T use ‘simple-mfd’ compatible for non-trivial devices, where children depend on some resources from the parent. Similarly, ‘simple-bus’ should not be used for complex buses and even ‘regs’ property means device is not a simple bus.”…””}”(hj¿h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K*hj»ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjh²hh³hÇh´Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1j h³hÇh´Khhûh²hubeh}”(h]”Œoverall-design”ah ]”h"]”Œoverall design”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´KubhÉ)”}”(hhh]”(hÎ)”}”(hŒ Properties”h]”hŒ Properties”…””}”(hjæh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhjãh²hh³hÇh´K1ubj )”}”(hhh]”(j)”}”(hX{DO make 'compatible' properties specific. - DON'T use wildcards or device-family names in compatible strings. - DO use fallback compatibles when devices are the same as or a superset of prior implementations. Fallback compatibles are applicable especially when sharing a programming interface or when able to discover the variants. - DON'T add fake fallback compatibles when software cannot use such to match and bind to a device, and still operate correctly. - DO use the commit message to explain why devices that may appear compatible in a diff (e.g. no differences in property use, same handling by the software) but are not made compatible in the binding, are not compatible. - DO add new compatibles in case there are new features or bugs. - DO use a SoC-specific compatible for all SoC devices, followed by a fallback if appropriate. SoC-specific compatibles are also preferred for the fallbacks. - DON'T use bus suffixes to encode the type of interface device is using. The parent bus node already implies that interface. DON'T add the type of device, if the device cannot be anything else. ”h]”(hÞ)”}”(hŒ)DO make 'compatible' properties specific.”h]”hŒ-DO make ‘compatible’ properties specific.”…””}”(hjûh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K3hj÷ubhŒ block_quote”“”)”}”(hX>- DON'T use wildcards or device-family names in compatible strings. - DO use fallback compatibles when devices are the same as or a superset of prior implementations. Fallback compatibles are applicable especially when sharing a programming interface or when able to discover the variants. - DON'T add fake fallback compatibles when software cannot use such to match and bind to a device, and still operate correctly. - DO use the commit message to explain why devices that may appear compatible in a diff (e.g. no differences in property use, same handling by the software) but are not made compatible in the binding, are not compatible. - DO add new compatibles in case there are new features or bugs. - DO use a SoC-specific compatible for all SoC devices, followed by a fallback if appropriate. SoC-specific compatibles are also preferred for the fallbacks. - DON'T use bus suffixes to encode the type of interface device is using. The parent bus node already implies that interface. DON'T add the type of device, if the device cannot be anything else. ”h]”j )”}”(hhh]”(j)”}”(hŒBDON'T use wildcards or device-family names in compatible strings. ”h]”hÞ)”}”(hŒADON'T use wildcards or device-family names in compatible strings.”h]”hŒCDON’T use wildcards or device-family names in compatible strings.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K5hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)”}”(hŒÜDO use fallback compatibles when devices are the same as or a superset of prior implementations. Fallback compatibles are applicable especially when sharing a programming interface or when able to discover the variants. ”h]”hÞ)”}”(hŒÛDO use fallback compatibles when devices are the same as or a superset of prior implementations. Fallback compatibles are applicable especially when sharing a programming interface or when able to discover the variants.”h]”hŒÛDO use fallback compatibles when devices are the same as or a superset of prior implementations. Fallback compatibles are applicable especially when sharing a programming interface or when able to discover the variants.”…””}”(hj.h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K7hj*ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)”}”(hŒ~DON'T add fake fallback compatibles when software cannot use such to match and bind to a device, and still operate correctly. ”h]”hÞ)”}”(hŒ}DON'T add fake fallback compatibles when software cannot use such to match and bind to a device, and still operate correctly.”h]”hŒDON’T add fake fallback compatibles when software cannot use such to match and bind to a device, and still operate correctly.”…””}”(hjFh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KDO add new compatibles in case there are new features or bugs.”h]”hŒ>DO add new compatibles in case there are new features or bugs.”…””}”(hjvh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KDhjrubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)”}”(hŒœDO use a SoC-specific compatible for all SoC devices, followed by a fallback if appropriate. SoC-specific compatibles are also preferred for the fallbacks. ”h]”hÞ)”}”(hŒ›DO use a SoC-specific compatible for all SoC devices, followed by a fallback if appropriate. SoC-specific compatibles are also preferred for the fallbacks.”h]”hŒ›DO use a SoC-specific compatible for all SoC devices, followed by a fallback if appropriate. SoC-specific compatibles are also preferred for the fallbacks.”…””}”(hjŽh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KFhjŠubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubj)”}”(hŒÂDON'T use bus suffixes to encode the type of interface device is using. The parent bus node already implies that interface. DON'T add the type of device, if the device cannot be anything else. ”h]”hÞ)”}”(hŒÁDON'T use bus suffixes to encode the type of interface device is using. The parent bus node already implies that interface. DON'T add the type of device, if the device cannot be anything else.”h]”hŒÅDON’T use bus suffixes to encode the type of interface device is using. The parent bus node already implies that interface. DON’T add the type of device, if the device cannot be anything else.”…””}”(hj¦h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KJhj¢ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjubeh}”(h]”h ]”h"]”h$]”h&]”jÙjÚuh1j h³hÇh´K5hj ubah}”(h]”h ]”h"]”h$]”h&]”uh1j h³hÇh´K5hj÷ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jhjôh²hh³hÇh´Nubj)”}”(hŒµDO use a vendor prefix on device-specific property names. Consider if properties could be common among devices of the same class. Check other existing bindings for similar devices. ”h]”hÞ)”}”(hŒ´DO use a vendor prefix on device-specific property names. Consider if properties could be common among devices of the same class. Check other existing bindings for similar devices.”h]”hŒ´DO use a vendor prefix on device-specific property names. Consider if properties could be common among devices of the same class. Check other existing bindings for similar devices.”…””}”(hjÐh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KNhjÌubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjôh²hh³hÇh´Nubj)”}”(hŒoDON'T redefine common properties. Just reference the definition and define constraints specific to the device. ”h]”hÞ)”}”(hŒnDON'T redefine common properties. Just reference the definition and define constraints specific to the device.”h]”hŒpDON’T redefine common properties. Just reference the definition and define constraints specific to the device.”…””}”(hjèh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KRhjäubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjôh²hh³hÇh´Nubj)”}”(hŒ‚DON'T add properties to avoid a specific compatible. DON'T add properties if they are implied by (deducible from) the compatible. ”h]”hÞ)”}”(hŒDON'T add properties to avoid a specific compatible. DON'T add properties if they are implied by (deducible from) the compatible.”h]”hŒ…DON’T add properties to avoid a specific compatible. DON’T add properties if they are implied by (deducible from) the compatible.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KUhjüubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjôh²hh³hÇh´Nubj)”}”(hŒÉDO use common property unit suffixes for properties with scientific units. Recommended suffixes are listed at https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/property-units.yaml ”h]”hÞ)”}”(hŒÈDO use common property unit suffixes for properties with scientific units. Recommended suffixes are listed at https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/property-units.yaml”h]”(hŒnDO use common property unit suffixes for properties with scientific units. Recommended suffixes are listed at ”…””}”(hjh²hh³Nh´NubhŒ reference”“”)”}”(hŒZhttps://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/property-units.yaml”h]”hŒZhttps://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/property-units.yaml”…””}”(hj"h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”j$uh1j hjubeh}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´KXhjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjôh²hh³hÇh´Nubj)”}”(hŒžDO define properties in terms of constraints. How many entries? What are possible values? What is the order? All these constraints represent the ABI as well. ”h]”hÞ)”}”(hŒDO define properties in terms of constraints. How many entries? What are possible values? What is the order? All these constraints represent the ABI as well.”h]”hŒDO define properties in terms of constraints. How many entries? What are possible values? What is the order? All these constraints represent the ABI as well.”…””}”(hjAh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K\hj=ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjôh²hh³hÇh´Nubj)”}”(hŒêDON'T make changes that break the ABI without explicit and detailed rationale for why the changes have to be made and their impact. ABI impact goes beyond the Linux kernel, because it also covers other open-source upstream projects. ”h]”hÞ)”}”(hŒèDON'T make changes that break the ABI without explicit and detailed rationale for why the changes have to be made and their impact. ABI impact goes beyond the Linux kernel, because it also covers other open-source upstream projects.”h]”hŒêDON’T make changes that break the ABI without explicit and detailed rationale for why the changes have to be made and their impact. ABI impact goes beyond the Linux kernel, because it also covers other open-source upstream projects.”…””}”(hjYh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K`hjUubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjôh²hh³hÇh´Nubeh}”(h]”h ]”h"]”h$]”h&]”jÙjÚuh1j h³hÇh´K3hjãh²hubeh}”(h]”Œ properties”ah ]”h"]”Œ properties”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´K1ubhÉ)”}”(hhh]”(hÎ)”}”(hŒTypical cases and caveats”h]”hŒTypical cases and caveats”…””}”(hj~h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj{h²hh³hÇh´Kfubj )”}”(hhh]”(j)”}”(hŒûPhandle entries, like clocks/dmas/interrupts/resets, should always be explicitly ordered. Include the {clock,dma,interrupt,reset}-names if there is more than one phandle. When used, both of these fields need the same constraints (e.g. list of items). ”h]”hÞ)”}”(hŒúPhandle entries, like clocks/dmas/interrupts/resets, should always be explicitly ordered. Include the {clock,dma,interrupt,reset}-names if there is more than one phandle. When used, both of these fields need the same constraints (e.g. list of items).”h]”hŒúPhandle entries, like clocks/dmas/interrupts/resets, should always be explicitly ordered. Include the {clock,dma,interrupt,reset}-names if there is more than one phandle. When used, both of these fields need the same constraints (e.g. list of items).”…””}”(hj“h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khhjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjŒh²hh³hÇh´Nubj)”}”(hŒ{For names used in {clock,dma,interrupt,reset}-names, do not add any suffix, e.g.: "tx" instead of "txirq" (for interrupt). ”h]”hÞ)”}”(hŒzFor names used in {clock,dma,interrupt,reset}-names, do not add any suffix, e.g.: "tx" instead of "txirq" (for interrupt).”h]”hŒ‚For names used in {clock,dma,interrupt,reset}-names, do not add any suffix, e.g.: “tx†instead of “txirq†(for interrupt).”…””}”(hj«h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kmhj§ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjŒh²hh³hÇh´Nubj)”}”(hŒ€Properties without schema types (e.g. without standard suffix or not defined by schema) need the type, even if this is an enum. ”h]”hÞ)”}”(hŒProperties without schema types (e.g. without standard suffix or not defined by schema) need the type, even if this is an enum.”h]”hŒProperties without schema types (e.g. without standard suffix or not defined by schema) need the type, even if this is an enum.”…””}”(hjÃh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kphj¿ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjŒh²hh³hÇh´Nubj)”}”(hŒ¥If schema includes other schema (e.g. /schemas/i2c/i2c-controller.yaml) use "unevaluatedProperties:false". In other cases, usually use "additionalProperties:false". ”h]”hÞ)”}”(hŒ¤If schema includes other schema (e.g. /schemas/i2c/i2c-controller.yaml) use "unevaluatedProperties:false". In other cases, usually use "additionalProperties:false".”h]”hŒ¬If schema includes other schema (e.g. /schemas/i2c/i2c-controller.yaml) use “unevaluatedProperties:falseâ€. In other cases, usually use “additionalProperties:falseâ€.”…””}”(hjÛh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kshj×ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjŒh²hh³hÇh´Nubj)”}”(hŒîFor sub-blocks/components of bigger device (e.g. SoC blocks) use rather device-based compatible (e.g. SoC-based compatible), instead of custom versioning of that component. For example use "vendor,soc1234-i2c" instead of "vendor,i2c-v2". ”h]”hÞ)”}”(hŒíFor sub-blocks/components of bigger device (e.g. SoC blocks) use rather device-based compatible (e.g. SoC-based compatible), instead of custom versioning of that component. For example use "vendor,soc1234-i2c" instead of "vendor,i2c-v2".”h]”hŒõFor sub-blocks/components of bigger device (e.g. SoC blocks) use rather device-based compatible (e.g. SoC-based compatible), instead of custom versioning of that component. For example use “vendor,soc1234-i2c†instead of “vendor,i2c-v2â€.”…””}”(hjóh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Kwhjïubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjŒh²hh³hÇh´Nubj)”}”(hŒ]"syscon" is not a generic property. Use vendor and type, e.g. "vendor,power-manager-syscon". ”h]”hÞ)”}”(hŒ\"syscon" is not a generic property. Use vendor and type, e.g. "vendor,power-manager-syscon".”h]”hŒd“syscon†is not a generic property. Use vendor and type, e.g. “vendor,power-manager-sysconâ€.”…””}”(hj h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K|hjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjŒh²hh³hÇh´Nubj)”}”(hXDo not add instance index (IDs) properties or custom OF aliases. If the devices have different programming model, they might need different compatibles. If such devices use some other device in a different way, e.g. they program the phy differently, use cell/phandle arguments. ”h]”hÞ)”}”(hXDo not add instance index (IDs) properties or custom OF aliases. If the devices have different programming model, they might need different compatibles. If such devices use some other device in a different way, e.g. they program the phy differently, use cell/phandle arguments.”h]”hXDo not add instance index (IDs) properties or custom OF aliases. If the devices have different programming model, they might need different compatibles. If such devices use some other device in a different way, e.g. they program the phy differently, use cell/phandle arguments.”…””}”(hj#h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khjubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjŒh²hh³hÇh´Nubj)”}”(hŒÊBindings files should be named like compatible: vendor,device.yaml. In case of multiple compatibles in the binding, use one of the fallbacks or a more generic name, yet still matching compatible style. ”h]”hÞ)”}”(hŒÉBindings files should be named like compatible: vendor,device.yaml. In case of multiple compatibles in the binding, use one of the fallbacks or a more generic name, yet still matching compatible style.”h]”hŒÉBindings files should be named like compatible: vendor,device.yaml. In case of multiple compatibles in the binding, use one of the fallbacks or a more generic name, yet still matching compatible style.”…””}”(hj;h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K„hj7ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjŒh²hh³hÇh´Nubeh}”(h]”h ]”h"]”h$]”h&]”jÙjÚuh1j h³hÇh´Khhj{h²hubeh}”(h]”Œtypical-cases-and-caveats”ah ]”h"]”Œtypical cases and caveats”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´KfubhÉ)”}”(hhh]”(hÎ)”}”(hŒBoard/SoC .dts Files”h]”hŒBoard/SoC .dts Files”…””}”(hj`h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÍhj]h²hh³hÇh´K‰ubj )”}”(hhh]”(j)”}”(hŒCDO put all MMIO devices under a bus node and not at the top-level. ”h]”hÞ)”}”(hŒBDO put all MMIO devices under a bus node and not at the top-level.”h]”hŒBDO put all MMIO devices under a bus node and not at the top-level.”…””}”(hjuh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´K‹hjqubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjnh²hh³hÇh´Nubj)”}”(hŒŒDO use non-empty 'ranges' to limit the size of child buses/devices. 64-bit platforms don't need all devices to have 64-bit address and size.”h]”hÞ)”}”(hŒŒDO use non-empty 'ranges' to limit the size of child buses/devices. 64-bit platforms don't need all devices to have 64-bit address and size.”h]”hŒ’DO use non-empty ‘ranges’ to limit the size of child buses/devices. 64-bit platforms don’t need all devices to have 64-bit address and size.”…””}”(hjh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hÝh³hÇh´Khj‰ubah}”(h]”h ]”h"]”h$]”h&]”uh1jhjnh²hh³hÇh´Nubeh}”(h]”h ]”h"]”h$]”h&]”jÙjÚuh1j h³hÇh´K‹hj]h²hubeh}”(h]”Œboard-soc-dts-files”ah ]”h"]”Œboard/soc .dts files”ah$]”h&]”uh1hÈhhÊh²hh³hÇh´K‰ubeh}”(h]”Œ