Skip to content

Commit

Permalink
chapter2: reference dt-schema in a note
Browse files Browse the repository at this point in the history
Mention in a footnote the dt-schema tools and schemas, which can be used
for automated DTB verification. Add a reference to dt-schema v2024.02.

Signed-off-by: Vincent Stehlé <[email protected]>
  • Loading branch information
vstehle committed Mar 1, 2024
1 parent 7834395 commit f2c68ed
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
5 changes: 4 additions & 1 deletion source/chapter2-uefi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ in Flattened Devicetree Blob (DTB) format version 17 or higher as described in
[DTSPEC]_ § 5.
The DTB Nodes and Properties must be compliant with the requirements listed in
[DTSPEC]_ § 3 & 4 and with the requirements listed in the following table, which
take precedence.
take precedence. [#DTSchNote]_

.. list-table:: DTB Nodes and Properties requirements
:widths: 50 50
Expand All @@ -359,6 +359,9 @@ take precedence.
The DTB must be contained in memory of type `EfiACPIReclaimMemory`.
[#ACPIMemNote]_

.. [#DTSchNote] The validity of the DTB and its conformance to [DTSPEC]_ can be
verified automatically with the tools and schemas in [DTSCHEMA]_.
.. [#ACPIMemNote] `EfiACPIReclaimMemory` was chosen to match the recommendation
for ACPI tables which fulfill the same task as the DTB.
Expand Down
4 changes: 4 additions & 0 deletions source/references.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ Bibliography
<https://uefi.org/sites/default/files/resources/ACPI_Spec_6_5_Aug29.pdf>`_,
August 2022, `UEFI Forum <https://uefi.org/>`_
.. [DTSCHEMA] `Devicetree schema tools v2024.02
<https://github.com/devicetree-org/dt-schema/releases/tag/v2024.02>`_,
`Devicetree.org <https://www.devicetree.org/>`_
.. [DTSPEC] `Devicetree specification v0.4
<https://github.com/devicetree-org/devicetree-specification/releases/tag/v0.4>`_,
`Devicetree.org <https://www.devicetree.org/>`_
Expand Down

0 comments on commit f2c68ed

Please sign in to comment.