diff options
author | Rob Herring <robh@kernel.org> | 2022-03-10 10:05:13 -0600 |
---|---|---|
committer | Rob Herring <robh@kernel.org> | 2022-03-11 11:16:16 -0600 |
commit | ef8795f3f1cef2b2d2cd5dfab3758a7601898bc9 (patch) | |
tree | 849f097b6158fe664bfee30ba4ee8a024d877afa /Documentation/devicetree/bindings/writing-schema.rst | |
parent | 2783a7f56f9980f61ca809b826bcd14dc77eb7b9 (diff) | |
download | lwn-ef8795f3f1cef2b2d2cd5dfab3758a7601898bc9.tar.gz lwn-ef8795f3f1cef2b2d2cd5dfab3758a7601898bc9.zip |
dt-bindings: kbuild: Use DTB files for validation
Switch the DT validation to use DTB files directly instead of a DTS to
YAML conversion.
The original motivation for supporting validation on DTB files was to
enable running validation on a running system (e.g. 'dt-validate
/sys/firmware/fdt') or other cases where the original source DTS is not
available.
The YAML format was not without issues. Using DTBs with the schema type
information solves some of those problems. The YAML format relies on the
DTS source level information including bracketing of properties, size
directives, and phandle tags all of which are lost in a DTB file. While
standardizing the bracketing is a good thing, it does cause a lot of
extra warnings and churn to fix them.
Another issue has been signed types are not validated correctly as sign
information is not propagated to YAML. Using the schema type information
allows for proper handling of signed types. YAML also can't represent
the full range of 64-bit integers as numbers are stored as floats by
most/all parsers.
The DTB validation works by decoding property values using the type
information in the schemas themselves. The main corner case this does
not work for is matrix types where neither dimension is fixed. For
now, checking the dimensions in these cases are skipped.
Signed-off-by: Rob Herring <robh@kernel.org>
Tested-by: Geert Uytterhoeven <geert+renesas@glider.be>
Link: https://lore.kernel.org/r/20220310160513.1708182-3-robh@kernel.org
Diffstat (limited to 'Documentation/devicetree/bindings/writing-schema.rst')
-rw-r--r-- | Documentation/devicetree/bindings/writing-schema.rst | 17 |
1 files changed, 5 insertions, 12 deletions
diff --git a/Documentation/devicetree/bindings/writing-schema.rst b/Documentation/devicetree/bindings/writing-schema.rst index 3b00fe981494..95ecf55559e5 100644 --- a/Documentation/devicetree/bindings/writing-schema.rst +++ b/Documentation/devicetree/bindings/writing-schema.rst @@ -120,20 +120,13 @@ project can be installed with pip:: pip3 install dtschema -Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be -installed. Ensure they are in your PATH (~/.local/bin by default). - -dtc must also be built with YAML output support enabled. This requires that -libyaml and its headers be installed on the host system. For some distributions -that involves installing the development package, such as: - -Debian:: +Note that 'dtschema' installation requires 'swig' and Python development files +installed first. On Debian/Ubuntu systems:: - apt-get install libyaml-dev + apt install swig python3-dev -Fedora:: - - dnf -y install libyaml-devel +Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be +installed. Ensure they are in your PATH (~/.local/bin by default). Running checks ~~~~~~~~~~~~~~ |