英语

提交设备树 (DT) 绑定补丁

I. 对于补丁提交者

  1. 适用 提交补丁:将代码放入内核的基本指南 中的正常补丁提交规则。

  2. 补丁的 Documentation/ 和 include/dt-bindings/ 部分应为单独的补丁。绑定补丁的首选主题前缀是

    "dt-bindings: <binding dir>: ..."
    

    少数子系统,如 ASoC、媒体、调节器和 SPI,期望前缀的顺序相反

    "<binding dir>: dt-bindings: ..."
    

    主题的 80 个字符非常宝贵。建议不要使用“Documentation”或“doc”,因为这是隐含的。所有绑定都是文档。也应避免再次重复“binding”。

  3. DT 绑定文件使用 json-schema 词汇表和 YAML 文件格式以 DT 模式格式编写。DT 绑定文件必须通过运行验证

    make dt_binding_check
    

    有关模式和工具设置的更多详细信息,请参阅 使用 json-schema 编写设备树绑定

  4. DT 绑定文件应采用双重许可。首选许可标签是 (GPL-2.0-only OR BSD-2-Clause)。

  5. 将整个系列提交到 devicetree 邮件列表:

    并抄送给 DT 维护者。使用 scripts/get_maintainer.pl 来识别所有 DT 维护者。

  6. 补丁的 Documentation/ 部分应在实现绑定的代码之前出现在系列中。

  7. 芯片或板级 DTS 文件中使用的任何兼容字符串必须事先在 Documentation/devicetree/bindings 中相应的 DT 绑定文件中进行记录。即使 Linux 设备驱动程序尚未匹配兼容字符串,此规则也适用。[如果未遵循此步骤,checkpatch 将发出警告,从 commit bff5da4335256513497cc8c79f9a9d1665e09864 (“checkpatch: add DT compatible string documentation checks”) 开始。]

  8. 如果驱动程序尚未匹配已记录的兼容字符串,则文档还应包含驱动程序匹配的兼容字符串。

  9. 绑定被 Linux 内核之外的多个项目积极使用,在对现有绑定进行更改时可能需要格外注意和考虑。

II. 对于内核维护者

  1. 如果您不熟悉对给定绑定的审查,请回复它并要求设备树维护者提供指导。这将帮助他们确定优先审查哪些,哪些可以放过。

  2. 对于驱动程序(而非子系统)绑定:如果您熟悉该绑定,并且在几周后仍未收到设备树维护者的 Acked-by,请继续接受它。

    对于子系统绑定(影响多个设备的任何绑定),需要设备树维护者进行审查。

  3. 对于通过多个树的系列,绑定补丁应与使用该绑定的驱动程序保持一致。

III. 注释

  1. 有关设备树 ABI 的详细信息,请参阅 设备树 (DT) ABI

  2. 本文档旨在作为对 2013 年内核峰会决定的流程的一般熟悉。如有疑问,设备树维护者的当前意见将优先于本文档。在这种情况下,更新本文档的补丁将不胜感激。