michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/scripts/dts/testedtlib.py

347 lines
18 KiB
Python
Raw Normal View History

dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#!/usr/bin/env python3
# Copyright (c) 2019 Nordic Semiconductor ASA
# SPDX-License-Identifier: BSD-3-Clause
scripts: edtlib: Add easy redirection of warnings Add a 'warn_file' parameter to EDT.__init__() that gives a 'file' object to write warnings to. Use it to capture and verify warnings generated for deprecated features in testedtlib.py. This indirectly gets rid of possibly broken-looking output when running it. Because any function that writes warnings now needs to use EDT._warn() (as self._warn()), some functions were moved into the EDT class. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-28 15:03:45 +02:00
import io
dts: edtlib: Add helper for testing error messages and test _slice() Add a helper function verify_error() to testedtlib.py that takes a DTS source and verifies that it generates a particular EDTError. Use it to test the hints that the previous commit added to errors generated by _slice(). Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-09 07:03:42 +01:00
import os
scripts: testedtlib.py: Generate SystemExit on test failures The devicetree check in check_compliance.py in ci-tools expects the dtlib/edtlib test suites to exit with sys.exit() (which raises SystemExit) on test failures, and interprets Exception as an internal error in the test suite. testedtlib.py accidentally raised Exception on test failures, making check_compliance.py error out and skipping the rest of the tests when there were failures. Fix it. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-20 00:21:03 +02:00
import sys
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
import edtlib
scripts: edtlib: Add a Device.children attribute with child Devices API oversight. This was meant to be there all along together with Device.parent, for navigating the devicetree, but since a need for it never came up in gen_defines.py, it got overlooked. Devices are just devicetree nodes augmented with binding information and some interpretation of devicetree properties. I wonder if the name should be changed to something like edtlib.Node to make that clearer. Calling something like a flash partition a "device" is a bit weird, as Galak pointed out. I think I went with Device originally to avoid confusion with dtlib.Node, but since edtlib users don't directly interact with dtlib, it might not be that confusing in practice. Piggyback some documentation clarifications. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-21 04:14:33 +02:00
# Test suite for edtlib.py. Run it directly as an executable, in this
# directory:
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
scripts: edtlib: Add a Device.children attribute with child Devices API oversight. This was meant to be there all along together with Device.parent, for navigating the devicetree, but since a need for it never came up in gen_defines.py, it got overlooked. Devices are just devicetree nodes augmented with binding information and some interpretation of devicetree properties. I wonder if the name should be changed to something like edtlib.Node to make that clearer. Calling something like a flash partition a "device" is a bit weird, as Galak pointed out. I think I went with Device originally to avoid confusion with dtlib.Node, but since edtlib users don't directly interact with dtlib, it might not be that confusing in practice. Piggyback some documentation clarifications. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-21 04:14:33 +02:00
# $ ./testedtlib.py
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
dts: edtlib: Add helper for testing error messages and test _slice() Add a helper function verify_error() to testedtlib.py that takes a DTS source and verifies that it generates a particular EDTError. Use it to test the hints that the previous commit added to errors generated by _slice(). Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-09 07:03:42 +01:00
# test.dts is the main test file. test-bindings/ and test-bindings-2/ has
# bindings. The tests mostly use string comparisons via the various __repr__()
# methods.
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
def run():
"""
Runs all edtlib tests. Immediately exits with status 1 and a message on
stderr on test suite failures.
"""
scripts: edtlib: Add easy redirection of warnings Add a 'warn_file' parameter to EDT.__init__() that gives a 'file' object to write warnings to. Use it to capture and verify warnings generated for deprecated features in testedtlib.py. This indirectly gets rid of possibly broken-looking output when running it. Because any function that writes warnings now needs to use EDT._warn() (as self._warn()), some functions were moved into the EDT class. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-28 15:03:45 +02:00
warnings = io.StringIO()
edt = edtlib.EDT("test.dts", ["test-bindings"], warnings)
# Deprecated features are tested too, which generate warnings. Verify them.
scripts: testedtlib.py: Simplify warning test a tiny bit verify_eq() can be used instead of verify_streq(), since warnings.getvalue() already returns a string. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-10-03 05:28:52 +02:00
verify_eq(warnings.getvalue(), """\
scripts: edtlib: Add easy redirection of warnings Add a 'warn_file' parameter to EDT.__init__() that gives a 'file' object to write warnings to. Use it to capture and verify warnings generated for deprecated features in testedtlib.py. This indirectly gets rid of possibly broken-looking output when running it. Because any function that writes warnings now needs to use EDT._warn() (as self._warn()), some functions were moved into the EDT class. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-28 15:03:45 +02:00
warning: The 'properties: compatible: constraint: ...' way of specifying the compatible in test-bindings/deprecated.yaml is deprecated. Put 'compatible: "deprecated"' at the top level of the binding instead.
warning: the 'inherits:' syntax in test-bindings/deprecated.yaml is deprecated and will be removed - please use 'include: foo.yaml' or 'include: [foo.yaml, bar.yaml]' instead
scripts: edtlib.py: Deprecate 'title:' Most bindings look something like this: title: Foo description: This binding provides a base representation of Foo That kind of description doesn't add any useful information, as it's just the title along with some copy-pasted text. I'm not sure what "base representation" was supposed to mean originally either. Many bindings also put something that's closer to a description in the title, because it's not clear what's expected or how the title is used. In reality, the title isn't used anywhere. 'description:' on the other hand shows up as a comment in the generated header. Deprecate 'title:' and generate a long informative warning if it shows up in a binding. Next commits will clean up the 'description:' strings (bringing them closer to 'title:' in most cases) and remove 'title:' from all bindings. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-19 10:38:25 +01:00
warning: 'title:' in test-bindings/deprecated.yaml is deprecated and will be removed (and was never used). Just put a 'description:' that describes the device instead. Use other bindings as a reference, and note that all bindings were updated recently. Think about what information would be useful to other people (e.g. explanations of acronyms, or datasheet links), and put that in as well. The description text shows up as a comment in the generated header. See yaml-multiline.info for how to deal with multiple lines. You probably want 'description: |'.
scripts: edtlib: Add easy redirection of warnings Add a 'warn_file' parameter to EDT.__init__() that gives a 'file' object to write warnings to. Use it to capture and verify warnings generated for deprecated features in testedtlib.py. This indirectly gets rid of possibly broken-looking output when running it. Because any function that writes warnings now needs to use EDT._warn() (as self._warn()), some functions were moved into the EDT class. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-28 15:03:45 +02:00
warning: please put 'required: true' instead of 'category: required' in properties: required: ...' in test-bindings/deprecated.yaml - 'category' will be removed
warning: please put 'required: false' instead of 'category: optional' in properties: optional: ...' in test-bindings/deprecated.yaml - 'category' will be removed
warning: 'sub-node: properties: ...' in test-bindings/deprecated.yaml is deprecated and will be removed - please give a full binding for the child node in 'child-binding:' instead (see binding-template.yaml)
warning: "#cells:" in test-bindings/deprecated.yaml is deprecated and will be removed - please put 'interrupt-cells:', 'pwm-cells:', 'gpio-cells:', etc., instead. The name should match the name of the corresponding phandle-array property (see binding-template.yaml)
""")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
# Test interrupts
#
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/interrupt-parent-test/node").interrupts,
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"[<ControllerAndData, name: foo, controller: <Node /interrupt-parent-test/controller in 'test.dts', binding test-bindings/interrupt-3-cell.yaml>, data: OrderedDict([('one', 1), ('two', 2), ('three', 3)])>, <ControllerAndData, name: bar, controller: <Node /interrupt-parent-test/controller in 'test.dts', binding test-bindings/interrupt-3-cell.yaml>, data: OrderedDict([('one', 4), ('two', 5), ('three', 6)])>]")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/interrupts-extended-test/node").interrupts,
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"[<ControllerAndData, controller: <Node /interrupts-extended-test/controller-0 in 'test.dts', binding test-bindings/interrupt-1-cell.yaml>, data: OrderedDict([('one', 1)])>, <ControllerAndData, controller: <Node /interrupts-extended-test/controller-1 in 'test.dts', binding test-bindings/interrupt-2-cell.yaml>, data: OrderedDict([('one', 2), ('two', 3)])>, <ControllerAndData, controller: <Node /interrupts-extended-test/controller-2 in 'test.dts', binding test-bindings/interrupt-3-cell.yaml>, data: OrderedDict([('one', 4), ('two', 5), ('three', 6)])>]")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/interrupt-map-test/node@0").interrupts,
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"[<ControllerAndData, controller: <Node /interrupt-map-test/controller-0 in 'test.dts', binding test-bindings/interrupt-1-cell.yaml>, data: OrderedDict([('one', 0)])>, <ControllerAndData, controller: <Node /interrupt-map-test/controller-1 in 'test.dts', binding test-bindings/interrupt-2-cell.yaml>, data: OrderedDict([('one', 0), ('two', 1)])>, <ControllerAndData, controller: <Node /interrupt-map-test/controller-2 in 'test.dts', binding test-bindings/interrupt-3-cell.yaml>, data: OrderedDict([('one', 0), ('two', 0), ('three', 2)])>]")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/interrupt-map-test/node@1").interrupts,
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"[<ControllerAndData, controller: <Node /interrupt-map-test/controller-0 in 'test.dts', binding test-bindings/interrupt-1-cell.yaml>, data: OrderedDict([('one', 3)])>, <ControllerAndData, controller: <Node /interrupt-map-test/controller-1 in 'test.dts', binding test-bindings/interrupt-2-cell.yaml>, data: OrderedDict([('one', 0), ('two', 4)])>, <ControllerAndData, controller: <Node /interrupt-map-test/controller-2 in 'test.dts', binding test-bindings/interrupt-3-cell.yaml>, data: OrderedDict([('one', 0), ('two', 0), ('three', 5)])>]")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/interrupt-map-bitops-test/node@70000000E").interrupts,
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"[<ControllerAndData, controller: <Node /interrupt-map-bitops-test/controller in 'test.dts', binding test-bindings/interrupt-2-cell.yaml>, data: OrderedDict([('one', 3), ('two', 2)])>]")
scripts/dts: add basic test for IO channel property Test the new io-channel support Signed-off-by: Jim Paris <jim@jtan.com>
2019-08-07 15:21:12 -04:00
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
# Test 'reg'
#
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/reg-zero-address-cells/node").regs,
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
"[<Register, addr: 0x0, size: 0x1>, <Register, addr: 0x0, size: 0x2>]")
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/reg-zero-size-cells/node").regs,
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
"[<Register, addr: 0x1, size: 0x0>, <Register, addr: 0x2, size: 0x0>]")
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/reg-ranges/parent/node").regs,
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
"[<Register, addr: 0x5, size: 0x1>, <Register, addr: 0xe0000000f, size: 0x1>, <Register, addr: 0xc0000000e, size: 0x1>, <Register, addr: 0xc0000000d, size: 0x1>, <Register, addr: 0xa0000000b, size: 0x1>, <Register, addr: 0x0, size: 0x1>]")
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/reg-nested-ranges/grandparent/parent/node").regs,
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
"[<Register, addr: 0x30000000200000001, size: 0x1>]")
dts: edtlib: Add simple generic support for pinctrl-<index> properties (pinctrl-<index> is documented in Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt in Linux.) Add a new Node.pin_states property, derived from any pinctrl-<index> properties on the node. Node.pin_states holds a list of PinState objects, where each PinState represents a single pinctrl-<index> property. For example, Node.pin_states will have two elements for the 'device' node below: device { pinctrl-0 = <&state_0>; pinctrl-1 = <&state_1 &state_2>; pinctrl-names = "default", "sleep"; }; pincontroller { state_0: state_0 { ... }; state_1: state_1 { ... }; state_2: state_2 { ... }; }; Each PinState holds the list of configurations nodes in PinState.conf_nodes. For the node above, node.pin_states[1].conf_nodes will contain the pincontroller/state_1 and pincontroller/state_2 nodes, for example. The new functionality isn't used by gen_defines.py yet, so this change is a no-op in itself, except it adds some error checking for pinctrl-<index> properties. If needed, support for #pinctrl-cells and 'pinmux' (not the same thing as the 'pinmux' properties in Zephyr I think) could be added separately later. Not sure what belongs in edtlib.py there yet. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-10-30 16:05:30 +01:00
#
# Test 'pinctrl-<index>'
#
verify_streq(edt.get_node("/pinctrl/dev").pinctrls,
"[<PinCtrl, name: zero, configuration nodes: []>, <PinCtrl, name: one, configuration nodes: [<Node /pinctrl/pincontroller/state-1 in 'test.dts', no binding>]>, <PinCtrl, name: two, configuration nodes: [<Node /pinctrl/pincontroller/state-1 in 'test.dts', no binding>, <Node /pinctrl/pincontroller/state-2 in 'test.dts', no binding>]>]")
scripts: edtlib: Add a Device.children attribute with child Devices API oversight. This was meant to be there all along together with Device.parent, for navigating the devicetree, but since a need for it never came up in gen_defines.py, it got overlooked. Devices are just devicetree nodes augmented with binding information and some interpretation of devicetree properties. I wonder if the name should be changed to something like edtlib.Node to make that clearer. Calling something like a flash partition a "device" is a bit weird, as Galak pointed out. I think I went with Device originally to avoid confusion with dtlib.Node, but since edtlib users don't directly interact with dtlib, it might not be that confusing in practice. Piggyback some documentation clarifications. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-21 04:14:33 +02:00
#
scripts: dts: Generalize handling of phandle-array types Generating generic information for 'type: phandle-array' properties in edtlib was difficult due to defining phandle-array as just a list of phandles and numbers. To make sense of a phandle-array property like 'pwms', you have to know that #pwm-cells is expected to appear on each referenced controller, and that the binding for the controller has a #cells. Because of this, handling of various 'type: phandle-array' properties was previously hardcoded in edtlib and exposed through properties like Node.pwms, instead of through the generic Node.props (though with a lot of shared code). In practice, it turns out that all 'type: phandle-array' properties in Zephyr work exactly the same way: They all have names that end in -s, the 's' is removed to derive the name of related properties, and they all look up #cells in the binding for the controller, which gives names to the data values. Strengthen the definition of 'type: phandle-array' to mean a property that works exactly like the existing phandle-array properties (which also means requiring that the name ends in -s). This removes a ton of hardcoding from edtlib and allows new 'type: phandle-array' properties to be added without making any code changes. If we ever need a property type that's a list of phandles and numbers but that doesn't follow this scheme, then we could add a separate type for it. We should check if the standard scheme is fine first though. The only property type for which no information is generated is now 'compound'. There's some inconsistency in how we generate identifiers for clocks compared to other 'type: phandle-array' properties, so keep special-casing them for now in gen_defines.py (see the comment in write_clocks()). This change also enabled a bunch of other simplifications, like reusing the ControllerAndData class for interrupts. Piggyback generalization of *-map properties so that they work for any phandle-array properties. It's now possible to have things like 'io-channel-map', if you need to. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 09:10:22 +02:00
# Test Node.parent and Node.children
scripts: edtlib: Add a Device.children attribute with child Devices API oversight. This was meant to be there all along together with Device.parent, for navigating the devicetree, but since a need for it never came up in gen_defines.py, it got overlooked. Devices are just devicetree nodes augmented with binding information and some interpretation of devicetree properties. I wonder if the name should be changed to something like edtlib.Node to make that clearer. Calling something like a flash partition a "device" is a bit weird, as Galak pointed out. I think I went with Device originally to avoid confusion with dtlib.Node, but since edtlib users don't directly interact with dtlib, it might not be that confusing in practice. Piggyback some documentation clarifications. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-21 04:14:33 +02:00
#
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_eq(edt.get_node("/").parent, None)
scripts: edtlib: Add a Device.children attribute with child Devices API oversight. This was meant to be there all along together with Device.parent, for navigating the devicetree, but since a need for it never came up in gen_defines.py, it got overlooked. Devices are just devicetree nodes augmented with binding information and some interpretation of devicetree properties. I wonder if the name should be changed to something like edtlib.Node to make that clearer. Calling something like a flash partition a "device" is a bit weird, as Galak pointed out. I think I went with Device originally to avoid confusion with dtlib.Node, but since edtlib users don't directly interact with dtlib, it might not be that confusing in practice. Piggyback some documentation clarifications. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-21 04:14:33 +02:00
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/parent/child-1").parent,
"<Node /parent in 'test.dts', no binding>")
scripts: edtlib: Add a Device.children attribute with child Devices API oversight. This was meant to be there all along together with Device.parent, for navigating the devicetree, but since a need for it never came up in gen_defines.py, it got overlooked. Devices are just devicetree nodes augmented with binding information and some interpretation of devicetree properties. I wonder if the name should be changed to something like edtlib.Node to make that clearer. Calling something like a flash partition a "device" is a bit weird, as Galak pointed out. I think I went with Device originally to avoid confusion with dtlib.Node, but since edtlib users don't directly interact with dtlib, it might not be that confusing in practice. Piggyback some documentation clarifications. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-21 04:14:33 +02:00
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/parent/child-2/grandchild").parent,
"<Node /parent/child-2 in 'test.dts', no binding>")
scripts: edtlib: Add a Device.children attribute with child Devices API oversight. This was meant to be there all along together with Device.parent, for navigating the devicetree, but since a need for it never came up in gen_defines.py, it got overlooked. Devices are just devicetree nodes augmented with binding information and some interpretation of devicetree properties. I wonder if the name should be changed to something like edtlib.Node to make that clearer. Calling something like a flash partition a "device" is a bit weird, as Galak pointed out. I think I went with Device originally to avoid confusion with dtlib.Node, but since edtlib users don't directly interact with dtlib, it might not be that confusing in practice. Piggyback some documentation clarifications. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-21 04:14:33 +02:00
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/parent").children,
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"OrderedDict([('child-1', <Node /parent/child-1 in 'test.dts', no binding>), ('child-2', <Node /parent/child-2 in 'test.dts', no binding>)])")
scripts: edtlib: Add a Device.children attribute with child Devices API oversight. This was meant to be there all along together with Device.parent, for navigating the devicetree, but since a need for it never came up in gen_defines.py, it got overlooked. Devices are just devicetree nodes augmented with binding information and some interpretation of devicetree properties. I wonder if the name should be changed to something like edtlib.Node to make that clearer. Calling something like a flash partition a "device" is a bit weird, as Galak pointed out. I think I went with Device originally to avoid confusion with dtlib.Node, but since edtlib users don't directly interact with dtlib, it might not be that confusing in practice. Piggyback some documentation clarifications. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-21 04:14:33 +02:00
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_eq(edt.get_node("/parent/child-1").children, {})
scripts: edtlib: Add a Device.children attribute with child Devices API oversight. This was meant to be there all along together with Device.parent, for navigating the devicetree, but since a need for it never came up in gen_defines.py, it got overlooked. Devices are just devicetree nodes augmented with binding information and some interpretation of devicetree properties. I wonder if the name should be changed to something like edtlib.Node to make that clearer. Calling something like a flash partition a "device" is a bit weird, as Galak pointed out. I think I went with Device originally to avoid confusion with dtlib.Node, but since edtlib users don't directly interact with dtlib, it might not be that confusing in practice. Piggyback some documentation clarifications. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-21 04:14:33 +02:00
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
scripts: dts: Improve syntax and code for including binding files Have include: foo.dts include: [foo.dts, bar.dts] instead of inherits: !include foo.dts inherits: !include [foo.dts, bar.dts] This is a nicer and shorter and less cryptic syntax, and will make it possible to get rid of the custom PyYAML constructor for '!include' later. 'inherits: !include ...' is still supported for backwards compatibility for now. Later on, I'm planning to mass-replace it, add a deprecation warning if it's used, and document 'include:'. Then the '!include' implementation can be removed a bit later. '!include' has caused issues in the past (see the comment above the add_constructor() call), gets iffy with multiple EDT instances, and makes the code harder to follow. I'm guessing '!include' might've been intended to be useful outside of 'inherits:' originally, but that's the only place where it's used. It's undocumented that it's possible to put it elsewhere. To implement the backwards compatibility, the code just transforms inherits: !include foo.dts into inherits: - foo.dts and treats 'inherits:' similarly to 'include:'. Previously, !include inserted the contents of the included file instead. Some more sanity checks for 'include:'/'inherits:' are included as well. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-21 16:41:03 +02:00
# Test 'include:' and the legacy 'inherits: !include ...'
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/binding-include").description,
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
"Parent binding")
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/binding-include").props,
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"OrderedDict([('foo', <Property, name: foo, type: int, value: 0>), ('bar', <Property, name: bar, type: int, value: 1>), ('baz', <Property, name: baz, type: int, value: 2>), ('qaz', <Property, name: qaz, type: int, value: 3>)])")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
scripts: dts: Change 'child/parent: bus: ...' to 'child/parent-bus:' Instead of child: bus: foo parent: bus: bar , have child-bus: foo parent-bus: bar 'bus' is the only key that ever appears under 'child' and 'parent'. Support the old keys for backwards compatibility, with a deprecation warning if they're used. Also add 'child/parent-bus' tests to the edtlib test suite. It was untested before. I also considered putting more stuff under 'child' and 'parent', but there's not much point when there's just a few keys I think. Top-level stuff is cleaner and easier to read. I'm planning to add a 'child-binding' key a bit later (like 'sub-node', but more flexible), and child-* is consistent with that. Also add an unrelated test-bindings/grandchild-3.yaml that was accidentally left out earlier. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-16 16:42:18 +02:00
#
scripts: edtlib: Rename 'child-bus:'/'parent-bus:' to 'bus:'/'on-bus:' I keep mixing these up, so that's probably a sign that the names are bad. The root of the problem is that "parent-bus" can be read as both "this is the parent bus" and as "the parent bus is this". Use 'bus:' for the bus "provider" and 'on-bus:' for nodes on the bus instead, which is less confusing. Support the old keys for backwards compatibility, along with a deprecation warning. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-26 22:19:55 +01:00
# Test 'bus:' and 'on-bus:'
scripts: dts: Change 'child/parent: bus: ...' to 'child/parent-bus:' Instead of child: bus: foo parent: bus: bar , have child-bus: foo parent-bus: bar 'bus' is the only key that ever appears under 'child' and 'parent'. Support the old keys for backwards compatibility, with a deprecation warning if they're used. Also add 'child/parent-bus' tests to the edtlib test suite. It was untested before. I also considered putting more stuff under 'child' and 'parent', but there's not much point when there's just a few keys I think. Top-level stuff is cleaner and easier to read. I'm planning to add a 'child-binding' key a bit later (like 'sub-node', but more flexible), and child-* is consistent with that. Also add an unrelated test-bindings/grandchild-3.yaml that was accidentally left out earlier. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-16 16:42:18 +02:00
#
scripts: edtlib: Support nested nodes on buses For the following devicetree, view 'nested' as being on the bus. Previously, only 'node' was considered to be on the bus. some-bus { compatible = "foo,bus-controller"; node { nested { compatible = "foo,device-on-bus"; }; }; }; In practice, this means that a 'bus:' key in the binding for 'foo,bus-controller' will now get matched up to an 'on-bus:' key in the binding for 'foo,device-on-bus'. Change the meaning of Node.bus and add two new attributes Node.on_bus and Node.bus_node, with these meanings: Node.bus: The bus type (as a string) if the node is a bus controller, and None otherwise Node.on_bus: The bus type (as a string) if the node appears on a bus, and None otherwise. The bus type is determined from the closest parent that's a bus controller. Node.bus_node: The node for the bus controller if the node appears on a bus, and None otherwise It's a bit redundant to have both Node.bus_node and Node.on_bus, since Node.on_bus is the same as Node.bus_node.bus, but Node.on_bus is pretty handy to save some None checks. Also update gen_defines.py to use Node.on_bus and Node.bus_node instead of Node.parent wherever the code deals with buses. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-27 04:08:36 +01:00
verify_eq(edt.get_node("/buses/foo-bus").bus, "foo")
# foo-bus does not itself appear on a bus
verify_eq(edt.get_node("/buses/foo-bus").on_bus, None)
verify_eq(edt.get_node("/buses/foo-bus").bus_node, None)
# foo-bus/node is not a bus node...
verify_eq(edt.get_node("/buses/foo-bus/node").bus, None)
# ...but is on a bus
verify_eq(edt.get_node("/buses/foo-bus/node").on_bus, "foo")
verify_eq(edt.get_node("/buses/foo-bus/node").bus_node.path,
"/buses/foo-bus")
# Same compatible string, but different bindings from being on different
# buses
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/buses/foo-bus/node").binding_path,
scripts: dts: Change 'child/parent: bus: ...' to 'child/parent-bus:' Instead of child: bus: foo parent: bus: bar , have child-bus: foo parent-bus: bar 'bus' is the only key that ever appears under 'child' and 'parent'. Support the old keys for backwards compatibility, with a deprecation warning if they're used. Also add 'child/parent-bus' tests to the edtlib test suite. It was untested before. I also considered putting more stuff under 'child' and 'parent', but there's not much point when there's just a few keys I think. Top-level stuff is cleaner and easier to read. I'm planning to add a 'child-binding' key a bit later (like 'sub-node', but more flexible), and child-* is consistent with that. Also add an unrelated test-bindings/grandchild-3.yaml that was accidentally left out earlier. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-16 16:42:18 +02:00
"test-bindings/device-on-foo-bus.yaml")
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/buses/bar-bus/node").binding_path,
scripts: dts: Change 'child/parent: bus: ...' to 'child/parent-bus:' Instead of child: bus: foo parent: bus: bar , have child-bus: foo parent-bus: bar 'bus' is the only key that ever appears under 'child' and 'parent'. Support the old keys for backwards compatibility, with a deprecation warning if they're used. Also add 'child/parent-bus' tests to the edtlib test suite. It was untested before. I also considered putting more stuff under 'child' and 'parent', but there's not much point when there's just a few keys I think. Top-level stuff is cleaner and easier to read. I'm planning to add a 'child-binding' key a bit later (like 'sub-node', but more flexible), and child-* is consistent with that. Also add an unrelated test-bindings/grandchild-3.yaml that was accidentally left out earlier. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-16 16:42:18 +02:00
"test-bindings/device-on-bar-bus.yaml")
scripts: edtlib: Support nested nodes on buses For the following devicetree, view 'nested' as being on the bus. Previously, only 'node' was considered to be on the bus. some-bus { compatible = "foo,bus-controller"; node { nested { compatible = "foo,device-on-bus"; }; }; }; In practice, this means that a 'bus:' key in the binding for 'foo,bus-controller' will now get matched up to an 'on-bus:' key in the binding for 'foo,device-on-bus'. Change the meaning of Node.bus and add two new attributes Node.on_bus and Node.bus_node, with these meanings: Node.bus: The bus type (as a string) if the node is a bus controller, and None otherwise Node.on_bus: The bus type (as a string) if the node appears on a bus, and None otherwise. The bus type is determined from the closest parent that's a bus controller. Node.bus_node: The node for the bus controller if the node appears on a bus, and None otherwise It's a bit redundant to have both Node.bus_node and Node.on_bus, since Node.on_bus is the same as Node.bus_node.bus, but Node.on_bus is pretty handy to save some None checks. Also update gen_defines.py to use Node.on_bus and Node.bus_node instead of Node.parent wherever the code deals with buses. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-27 04:08:36 +01:00
# foo-bus/node/nested also appears on the foo-bus bus
verify_eq(edt.get_node("/buses/foo-bus/node/nested").on_bus, "foo")
verify_streq(edt.get_node("/buses/foo-bus/node/nested").binding_path,
"test-bindings/device-on-foo-bus.yaml")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
scripts: dts: Replace 'sub-node:' with more general 'child-binding:' Deprecate 'sub-node:' and add a more general 'child-binding:' mechanism to bindings. Keep supporting 'sub-node:', but print a deprecation warning when it's used. Like 'sub-node:', 'child-binding:' gives a binding to child nodes, but the binding is required to be a complete binding, and is treated (and checked) like a normal binding. 'child-binding:' can in turn contain another 'child-binding:', up to any number of levels. This is automatic from treating it like a normal binding, and from the code initializing parent Devices before child Devices. This lets nodes give bindings to grandchildren. For example, take this devicetree fragment: parent { compatible = "foo"; child-1 { grandchild-1 { ... }; grandchild-2 { ... }; }; child-2 { grandchild-3 { ... }; }; }; The binding for 'foo' could provide bindings for grandchild-1/2/3 like this: compatible: "foo" # Binding for children child-binding: title: ... description: ... ... # Binding for grandchildren child-binding: title: ... description: ... properties: ... Due to implementation issues with the old devicetree scripts, only two levels of 'child-binding:' is supported for now. This limitation will go away in Zephyr 2.2. Piggyback shortening 'description:' and 'title:' in some bindings that provide child bindings. This makes the generated header a bit neater. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-17 18:24:30 +02:00
# Test 'child-binding:'
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
child1 = edt.get_node("/child-binding/child-1")
child2 = edt.get_node("/child-binding/child-2")
grandchild = edt.get_node("/child-binding/child-1/grandchild")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
scripts: dts: Replace 'sub-node:' with more general 'child-binding:' Deprecate 'sub-node:' and add a more general 'child-binding:' mechanism to bindings. Keep supporting 'sub-node:', but print a deprecation warning when it's used. Like 'sub-node:', 'child-binding:' gives a binding to child nodes, but the binding is required to be a complete binding, and is treated (and checked) like a normal binding. 'child-binding:' can in turn contain another 'child-binding:', up to any number of levels. This is automatic from treating it like a normal binding, and from the code initializing parent Devices before child Devices. This lets nodes give bindings to grandchildren. For example, take this devicetree fragment: parent { compatible = "foo"; child-1 { grandchild-1 { ... }; grandchild-2 { ... }; }; child-2 { grandchild-3 { ... }; }; }; The binding for 'foo' could provide bindings for grandchild-1/2/3 like this: compatible: "foo" # Binding for children child-binding: title: ... description: ... ... # Binding for grandchildren child-binding: title: ... description: ... properties: ... Due to implementation issues with the old devicetree scripts, only two levels of 'child-binding:' is supported for now. This limitation will go away in Zephyr 2.2. Piggyback shortening 'description:' and 'title:' in some bindings that provide child bindings. This makes the generated header a bit neater. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-17 18:24:30 +02:00
verify_streq(child1.binding_path, "test-bindings/child-binding.yaml")
verify_streq(child1.description, "child node")
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
verify_streq(child1.props, "OrderedDict([('child-prop', <Property, name: child-prop, type: int, value: 1>)])")
scripts: dts: Replace 'sub-node:' with more general 'child-binding:' Deprecate 'sub-node:' and add a more general 'child-binding:' mechanism to bindings. Keep supporting 'sub-node:', but print a deprecation warning when it's used. Like 'sub-node:', 'child-binding:' gives a binding to child nodes, but the binding is required to be a complete binding, and is treated (and checked) like a normal binding. 'child-binding:' can in turn contain another 'child-binding:', up to any number of levels. This is automatic from treating it like a normal binding, and from the code initializing parent Devices before child Devices. This lets nodes give bindings to grandchildren. For example, take this devicetree fragment: parent { compatible = "foo"; child-1 { grandchild-1 { ... }; grandchild-2 { ... }; }; child-2 { grandchild-3 { ... }; }; }; The binding for 'foo' could provide bindings for grandchild-1/2/3 like this: compatible: "foo" # Binding for children child-binding: title: ... description: ... ... # Binding for grandchildren child-binding: title: ... description: ... properties: ... Due to implementation issues with the old devicetree scripts, only two levels of 'child-binding:' is supported for now. This limitation will go away in Zephyr 2.2. Piggyback shortening 'description:' and 'title:' in some bindings that provide child bindings. This makes the generated header a bit neater. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-17 18:24:30 +02:00
verify_streq(child2.binding_path, "test-bindings/child-binding.yaml")
verify_streq(child2.description, "child node")
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
verify_streq(child2.props, "OrderedDict([('child-prop', <Property, name: child-prop, type: int, value: 3>)])")
scripts: dts: Replace 'sub-node:' with more general 'child-binding:' Deprecate 'sub-node:' and add a more general 'child-binding:' mechanism to bindings. Keep supporting 'sub-node:', but print a deprecation warning when it's used. Like 'sub-node:', 'child-binding:' gives a binding to child nodes, but the binding is required to be a complete binding, and is treated (and checked) like a normal binding. 'child-binding:' can in turn contain another 'child-binding:', up to any number of levels. This is automatic from treating it like a normal binding, and from the code initializing parent Devices before child Devices. This lets nodes give bindings to grandchildren. For example, take this devicetree fragment: parent { compatible = "foo"; child-1 { grandchild-1 { ... }; grandchild-2 { ... }; }; child-2 { grandchild-3 { ... }; }; }; The binding for 'foo' could provide bindings for grandchild-1/2/3 like this: compatible: "foo" # Binding for children child-binding: title: ... description: ... ... # Binding for grandchildren child-binding: title: ... description: ... properties: ... Due to implementation issues with the old devicetree scripts, only two levels of 'child-binding:' is supported for now. This limitation will go away in Zephyr 2.2. Piggyback shortening 'description:' and 'title:' in some bindings that provide child bindings. This makes the generated header a bit neater. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-17 18:24:30 +02:00
verify_streq(grandchild.binding_path, "test-bindings/child-binding.yaml")
verify_streq(grandchild.description, "grandchild node")
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
verify_streq(grandchild.props, "OrderedDict([('grandchild-prop', <Property, name: grandchild-prop, type: int, value: 2>)])")
scripts: dts: Replace 'sub-node:' with more general 'child-binding:' Deprecate 'sub-node:' and add a more general 'child-binding:' mechanism to bindings. Keep supporting 'sub-node:', but print a deprecation warning when it's used. Like 'sub-node:', 'child-binding:' gives a binding to child nodes, but the binding is required to be a complete binding, and is treated (and checked) like a normal binding. 'child-binding:' can in turn contain another 'child-binding:', up to any number of levels. This is automatic from treating it like a normal binding, and from the code initializing parent Devices before child Devices. This lets nodes give bindings to grandchildren. For example, take this devicetree fragment: parent { compatible = "foo"; child-1 { grandchild-1 { ... }; grandchild-2 { ... }; }; child-2 { grandchild-3 { ... }; }; }; The binding for 'foo' could provide bindings for grandchild-1/2/3 like this: compatible: "foo" # Binding for children child-binding: title: ... description: ... ... # Binding for grandchildren child-binding: title: ... description: ... properties: ... Due to implementation issues with the old devicetree scripts, only two levels of 'child-binding:' is supported for now. This limitation will go away in Zephyr 2.2. Piggyback shortening 'description:' and 'title:' in some bindings that provide child bindings. This makes the generated header a bit neater. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-17 18:24:30 +02:00
#
scripts: dts: Generalize '#cells' to allow multiple sources Implement a nice generalization suggested by Bobby Noelte. Instead of having a generic #cells key in bindings, have source-specific *-cells keys. Some examples: interrupt-cells: - irq - priority - flags gpio-cells: - pin - flags pwm-cells: - channel - period This makes bindings a bit easier to read, and allows a node to be a controller for many different 'phandle-array' properties. The prefix before *-cells is derived from the property name, meaning there's no fixed set of *-cells keys. This is possible because of the earlier 'phandle-array' generalization. The older #cells key is supported for backwards compatibility, but generates a deprecation warning. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-26 20:34:13 +02:00
# Test deprecated 'sub-node' key (replaced with 'child-binding') and
# deprecated '#cells' key (replaced with '*-cells')
scripts: dts: Replace 'sub-node:' with more general 'child-binding:' Deprecate 'sub-node:' and add a more general 'child-binding:' mechanism to bindings. Keep supporting 'sub-node:', but print a deprecation warning when it's used. Like 'sub-node:', 'child-binding:' gives a binding to child nodes, but the binding is required to be a complete binding, and is treated (and checked) like a normal binding. 'child-binding:' can in turn contain another 'child-binding:', up to any number of levels. This is automatic from treating it like a normal binding, and from the code initializing parent Devices before child Devices. This lets nodes give bindings to grandchildren. For example, take this devicetree fragment: parent { compatible = "foo"; child-1 { grandchild-1 { ... }; grandchild-2 { ... }; }; child-2 { grandchild-3 { ... }; }; }; The binding for 'foo' could provide bindings for grandchild-1/2/3 like this: compatible: "foo" # Binding for children child-binding: title: ... description: ... ... # Binding for grandchildren child-binding: title: ... description: ... properties: ... Due to implementation issues with the old devicetree scripts, only two levels of 'child-binding:' is supported for now. This limitation will go away in Zephyr 2.2. Piggyback shortening 'description:' and 'title:' in some bindings that provide child bindings. This makes the generated header a bit neater. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-17 18:24:30 +02:00
#
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/deprecated/sub-node").props,
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"OrderedDict([('foos', <Property, name: foos, type: phandle-array, value: [<ControllerAndData, controller: <Node /deprecated in 'test.dts', binding test-bindings/deprecated.yaml>, data: OrderedDict([('foo', 1), ('bar', 2)])>]>)])")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
dts: edtlib: Turn Node.instance_no into EDT.compat2enabled Add an EDT.compat2enabled attribute that maps compatibles to enabled devicetree nodes that implement them. For example, EDT.compat2enabled["foo"] is a list of all enabled nodes with "foo" in the 'compatible' property. The old Node.instance_no functionality can be implemented in terms of EDT.compat2enabled, so remove Node.instance_no. EDT.compat2enabled is more flexible and easier to understand. Simplify main() in gen_defines.py by using EDT.compat2enabled to generate the DT_COMPAT_<compatible> existence macros. The behavior is slightly different now, as DT_COMPAT_<compatible> is generated for enabled nodes that don't have a binding as well, but that might be an improvement overall. It probably doesn't hurt at least. EDT.compat2enabled simplifies the implementation of the new $(dt_compat_get_str) preprocessor function in https://github.com/zephyrproject-rtos/zephyr/pull/21560. That was the original motivation. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-28 04:46:12 +01:00
#
# Test EDT.compat2enabled
#
verify_streq(edt.compat2enabled["compat2enabled"], "[<Node /compat2enabled/foo-1 in 'test.dts', no binding>, <Node /compat2enabled/foo-2 in 'test.dts', no binding>]")
if "compat2enabled-disabled" in edt.compat2enabled:
fail("'compat2enabled-disabled' should not appear in edt.compat2enabled")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
scripts: dts: Generalize handling of phandle-array types Generating generic information for 'type: phandle-array' properties in edtlib was difficult due to defining phandle-array as just a list of phandles and numbers. To make sense of a phandle-array property like 'pwms', you have to know that #pwm-cells is expected to appear on each referenced controller, and that the binding for the controller has a #cells. Because of this, handling of various 'type: phandle-array' properties was previously hardcoded in edtlib and exposed through properties like Node.pwms, instead of through the generic Node.props (though with a lot of shared code). In practice, it turns out that all 'type: phandle-array' properties in Zephyr work exactly the same way: They all have names that end in -s, the 's' is removed to derive the name of related properties, and they all look up #cells in the binding for the controller, which gives names to the data values. Strengthen the definition of 'type: phandle-array' to mean a property that works exactly like the existing phandle-array properties (which also means requiring that the name ends in -s). This removes a ton of hardcoding from edtlib and allows new 'type: phandle-array' properties to be added without making any code changes. If we ever need a property type that's a list of phandles and numbers but that doesn't follow this scheme, then we could add a separate type for it. We should check if the standard scheme is fine first though. The only property type for which no information is generated is now 'compound'. There's some inconsistency in how we generate identifiers for clocks compared to other 'type: phandle-array' properties, so keep special-casing them for now in gen_defines.py (see the comment in write_clocks()). This change also enabled a bunch of other simplifications, like reusing the ControllerAndData class for interrupts. Piggyback generalization of *-map properties so that they work for any phandle-array properties. It's now possible to have things like 'io-channel-map', if you need to. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 09:10:22 +02:00
# Test Node.props (derived from DT and 'properties:' in the binding)
#
verify_streq(edt.get_node("/props").props["int"],
"<Property, name: int, type: int, value: 1>")
verify_streq(edt.get_node("/props").props["existent-boolean"],
"<Property, name: existent-boolean, type: boolean, value: True>")
verify_streq(edt.get_node("/props").props["nonexistent-boolean"],
"<Property, name: nonexistent-boolean, type: boolean, value: False>")
verify_streq(edt.get_node("/props").props["array"],
"<Property, name: array, type: array, value: [1, 2, 3]>")
verify_streq(edt.get_node("/props").props["uint8-array"],
r"<Property, name: uint8-array, type: uint8-array, value: b'\x124'>")
verify_streq(edt.get_node("/props").props["string"],
"<Property, name: string, type: string, value: 'foo'>")
verify_streq(edt.get_node("/props").props["string-array"],
"<Property, name: string-array, type: string-array, value: ['foo', 'bar', 'baz']>")
verify_streq(edt.get_node("/props").props["phandle-ref"],
"<Property, name: phandle-ref, type: phandle, value: <Node /props/ctrl-1 in 'test.dts', binding test-bindings/phandle-array-controller-1.yaml>>")
verify_streq(edt.get_node("/props").props["phandle-refs"],
"<Property, name: phandle-refs, type: phandles, value: [<Node /props/ctrl-1 in 'test.dts', binding test-bindings/phandle-array-controller-1.yaml>, <Node /props/ctrl-2 in 'test.dts', binding test-bindings/phandle-array-controller-2.yaml>]>")
verify_streq(edt.get_node("/props").props["phandle-array-foos"],
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"<Property, name: phandle-array-foos, type: phandle-array, value: [<ControllerAndData, controller: <Node /props/ctrl-1 in 'test.dts', binding test-bindings/phandle-array-controller-1.yaml>, data: OrderedDict([('one', 1)])>, <ControllerAndData, controller: <Node /props/ctrl-2 in 'test.dts', binding test-bindings/phandle-array-controller-2.yaml>, data: OrderedDict([('one', 2), ('two', 3)])>]>")
scripts: dts: Generalize handling of phandle-array types Generating generic information for 'type: phandle-array' properties in edtlib was difficult due to defining phandle-array as just a list of phandles and numbers. To make sense of a phandle-array property like 'pwms', you have to know that #pwm-cells is expected to appear on each referenced controller, and that the binding for the controller has a #cells. Because of this, handling of various 'type: phandle-array' properties was previously hardcoded in edtlib and exposed through properties like Node.pwms, instead of through the generic Node.props (though with a lot of shared code). In practice, it turns out that all 'type: phandle-array' properties in Zephyr work exactly the same way: They all have names that end in -s, the 's' is removed to derive the name of related properties, and they all look up #cells in the binding for the controller, which gives names to the data values. Strengthen the definition of 'type: phandle-array' to mean a property that works exactly like the existing phandle-array properties (which also means requiring that the name ends in -s). This removes a ton of hardcoding from edtlib and allows new 'type: phandle-array' properties to be added without making any code changes. If we ever need a property type that's a list of phandles and numbers but that doesn't follow this scheme, then we could add a separate type for it. We should check if the standard scheme is fine first though. The only property type for which no information is generated is now 'compound'. There's some inconsistency in how we generate identifiers for clocks compared to other 'type: phandle-array' properties, so keep special-casing them for now in gen_defines.py (see the comment in write_clocks()). This change also enabled a bunch of other simplifications, like reusing the ControllerAndData class for interrupts. Piggyback generalization of *-map properties so that they work for any phandle-array properties. It's now possible to have things like 'io-channel-map', if you need to. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 09:10:22 +02:00
verify_streq(edt.get_node("/props").props["foo-gpios"],
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"<Property, name: foo-gpios, type: phandle-array, value: [<ControllerAndData, controller: <Node /props/ctrl-1 in 'test.dts', binding test-bindings/phandle-array-controller-1.yaml>, data: OrderedDict([('gpio-one', 1)])>]>")
scripts: dts: Generalize handling of phandle-array types Generating generic information for 'type: phandle-array' properties in edtlib was difficult due to defining phandle-array as just a list of phandles and numbers. To make sense of a phandle-array property like 'pwms', you have to know that #pwm-cells is expected to appear on each referenced controller, and that the binding for the controller has a #cells. Because of this, handling of various 'type: phandle-array' properties was previously hardcoded in edtlib and exposed through properties like Node.pwms, instead of through the generic Node.props (though with a lot of shared code). In practice, it turns out that all 'type: phandle-array' properties in Zephyr work exactly the same way: They all have names that end in -s, the 's' is removed to derive the name of related properties, and they all look up #cells in the binding for the controller, which gives names to the data values. Strengthen the definition of 'type: phandle-array' to mean a property that works exactly like the existing phandle-array properties (which also means requiring that the name ends in -s). This removes a ton of hardcoding from edtlib and allows new 'type: phandle-array' properties to be added without making any code changes. If we ever need a property type that's a list of phandles and numbers but that doesn't follow this scheme, then we could add a separate type for it. We should check if the standard scheme is fine first though. The only property type for which no information is generated is now 'compound'. There's some inconsistency in how we generate identifiers for clocks compared to other 'type: phandle-array' properties, so keep special-casing them for now in gen_defines.py (see the comment in write_clocks()). This change also enabled a bunch of other simplifications, like reusing the ControllerAndData class for interrupts. Piggyback generalization of *-map properties so that they work for any phandle-array properties. It's now possible to have things like 'io-channel-map', if you need to. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 09:10:22 +02:00
dts: edtlib: Add 'type: path' for path references Add binding support for a 'path' property type, for properties that are assigned node paths. Usually, paths are assigned with path references like 'foo = &label' (common in /chosen), but plain strings are accepted as well as long as they're valid paths. The 'path' type is mostly for completeness at this point, but might be useful for https://github.com/zephyrproject-rtos/zephyr/issues/21623. The support is there already in dtlib. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-12-30 22:52:11 +01:00
verify_streq(edt.get_node("/props").props["path"],
"<Property, name: path, type: path, value: <Node /props/ctrl-1 in 'test.dts', binding test-bindings/phandle-array-controller-1.yaml>>")
scripts: dts: Generalize handling of phandle-array types Generating generic information for 'type: phandle-array' properties in edtlib was difficult due to defining phandle-array as just a list of phandles and numbers. To make sense of a phandle-array property like 'pwms', you have to know that #pwm-cells is expected to appear on each referenced controller, and that the binding for the controller has a #cells. Because of this, handling of various 'type: phandle-array' properties was previously hardcoded in edtlib and exposed through properties like Node.pwms, instead of through the generic Node.props (though with a lot of shared code). In practice, it turns out that all 'type: phandle-array' properties in Zephyr work exactly the same way: They all have names that end in -s, the 's' is removed to derive the name of related properties, and they all look up #cells in the binding for the controller, which gives names to the data values. Strengthen the definition of 'type: phandle-array' to mean a property that works exactly like the existing phandle-array properties (which also means requiring that the name ends in -s). This removes a ton of hardcoding from edtlib and allows new 'type: phandle-array' properties to be added without making any code changes. If we ever need a property type that's a list of phandles and numbers but that doesn't follow this scheme, then we could add a separate type for it. We should check if the standard scheme is fine first though. The only property type for which no information is generated is now 'compound'. There's some inconsistency in how we generate identifiers for clocks compared to other 'type: phandle-array' properties, so keep special-casing them for now in gen_defines.py (see the comment in write_clocks()). This change also enabled a bunch of other simplifications, like reusing the ControllerAndData class for interrupts. Piggyback generalization of *-map properties so that they work for any phandle-array properties. It's now possible to have things like 'io-channel-map', if you need to. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 09:10:22 +02:00
#
# Test <prefix>-map, via gpio-map (the most common case)
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
#
scripts: dts: Generalize handling of phandle-array types Generating generic information for 'type: phandle-array' properties in edtlib was difficult due to defining phandle-array as just a list of phandles and numbers. To make sense of a phandle-array property like 'pwms', you have to know that #pwm-cells is expected to appear on each referenced controller, and that the binding for the controller has a #cells. Because of this, handling of various 'type: phandle-array' properties was previously hardcoded in edtlib and exposed through properties like Node.pwms, instead of through the generic Node.props (though with a lot of shared code). In practice, it turns out that all 'type: phandle-array' properties in Zephyr work exactly the same way: They all have names that end in -s, the 's' is removed to derive the name of related properties, and they all look up #cells in the binding for the controller, which gives names to the data values. Strengthen the definition of 'type: phandle-array' to mean a property that works exactly like the existing phandle-array properties (which also means requiring that the name ends in -s). This removes a ton of hardcoding from edtlib and allows new 'type: phandle-array' properties to be added without making any code changes. If we ever need a property type that's a list of phandles and numbers but that doesn't follow this scheme, then we could add a separate type for it. We should check if the standard scheme is fine first though. The only property type for which no information is generated is now 'compound'. There's some inconsistency in how we generate identifiers for clocks compared to other 'type: phandle-array' properties, so keep special-casing them for now in gen_defines.py (see the comment in write_clocks()). This change also enabled a bunch of other simplifications, like reusing the ControllerAndData class for interrupts. Piggyback generalization of *-map properties so that they work for any phandle-array properties. It's now possible to have things like 'io-channel-map', if you need to. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 09:10:22 +02:00
verify_streq(edt.get_node("/gpio-map/source").props["foo-gpios"],
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
"<Property, name: foo-gpios, type: phandle-array, value: [<ControllerAndData, controller: <Node /gpio-map/destination in 'test.dts', binding test-bindings/gpio-dst.yaml>, data: OrderedDict([('val', 6)])>, <ControllerAndData, controller: <Node /gpio-map/destination in 'test.dts', binding test-bindings/gpio-dst.yaml>, data: OrderedDict([('val', 5)])>]>")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
dts: edtlib: Support giving missing properties a default value For missing optional properties, it can be handy to generate a default value instead of no value, to cut down on #ifdefs. Allow a default value to be specified in the binding, via a new 'default: <default value>' setting for properties in bindings. Defaults are supported for both scalar and array types. YAML arrays are used to specify the value for array types. 'default:' also appears in json-schema, with the same meaning. Include misc. sanity checks, like the 'default' value matching 'type'. The documentation changes in binding-template.yaml explain the syntax. Suggested by Peter A. Bigot in https://github.com/zephyrproject-rtos/zephyr/issues/17829. Fixes: #17829 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-29 22:21:33 +02:00
#
# Test property default values given in bindings
#
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/defaults").props,
scripts: dtlib/edtlib: Make output consistent on Python 3.5- Python 3.5 and earlier do not preserve dictionary insertion order when iterating over dictionaries, and do not give the same order between runs. This broke the dtlib and edtlib test suites and made the output jump around randomly between runs. It also made device INST_<n> numbers non-deterministic, which broke some code on Python 3.5 (though hardcoding device instance numbers in the code might be a bit shaky). Fix it by using collections.OrderedDict instead of plain dict wherever order matters. This makes the output identical on all supported Python versions. It also allows testdtlib.py and testedtlib.py to run in CI, which uses Python 3.5. Fixes: #20571 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-12 18:33:00 +01:00
r"OrderedDict([('int', <Property, name: int, type: int, value: 123>), ('array', <Property, name: array, type: array, value: [1, 2, 3]>), ('uint8-array', <Property, name: uint8-array, type: uint8-array, value: b'\x89\xab\xcd'>), ('string', <Property, name: string, type: string, value: 'hello'>), ('string-array', <Property, name: string-array, type: string-array, value: ['hello', 'there']>), ('default-not-used', <Property, name: default-not-used, type: int, value: 234>)])")
dts: edtlib: Support giving missing properties a default value For missing optional properties, it can be handy to generate a default value instead of no value, to cut down on #ifdefs. Allow a default value to be specified in the binding, via a new 'default: <default value>' setting for properties in bindings. Defaults are supported for both scalar and array types. YAML arrays are used to specify the value for array types. 'default:' also appears in json-schema, with the same meaning. Include misc. sanity checks, like the 'default' value matching 'type'. The documentation changes in binding-template.yaml explain the syntax. Suggested by Peter A. Bigot in https://github.com/zephyrproject-rtos/zephyr/issues/17829. Fixes: #17829 Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-29 22:21:33 +02:00
scripts: dts: Add test for multiple binding directories Add two bindings test-bindings/multidir.yaml test-bindings-2/multidir.yaml and a new test-multidir.dts with two nodes that use them. Verify that the two bindings were found by checking the Device.binding_path attribute for the two device nodes. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-02 23:45:51 +02:00
#
# Test having multiple directories with bindings, with a different .dts file
#
edt = edtlib.EDT("test-multidir.dts", ["test-bindings", "test-bindings-2"])
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/in-dir-1").binding_path,
scripts: dts: Add test for multiple binding directories Add two bindings test-bindings/multidir.yaml test-bindings-2/multidir.yaml and a new test-multidir.dts with two nodes that use them. Verify that the two bindings were found by checking the Device.binding_path attribute for the two device nodes. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-02 23:45:51 +02:00
"test-bindings/multidir.yaml")
scripts: edtlib: Call nodes "nodes" instead of "devices" edtlib.Device is just a devicetree node augmented with binding information and some interpretation of properties. Rename it to edtlib.Node to make that clearer. That also avoids calling things like flash partition nodes "devices", which is a bit confusing. I called it edtlib.Device instead of edtlib.Node originally to avoid confusion with dtlib.Node, but in retrospect it probably makes it more confusing on the whole. Something like edtlib.ENode might work too, but it's probably overkill. Clients of edtlib.py only interact with edtlib.Node, so the only potential for confusion is within edtlib.py itself, and it doesn't get too bad there either. Piggyback some documentation nits, and consistently write it "devicetree" instead of "device tree", to match the spec. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-09-23 05:14:18 +02:00
verify_streq(edt.get_node("/in-dir-2").binding_path,
scripts: dts: Add test for multiple binding directories Add two bindings test-bindings/multidir.yaml test-bindings-2/multidir.yaml and a new test-multidir.dts with two nodes that use them. Verify that the two bindings were found by checking the Device.binding_path attribute for the two device nodes. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-08-02 23:45:51 +02:00
"test-bindings-2/multidir.yaml")
scripts: dts: add dependency information to edtlib Device tree nodes have a dependency on their parents, as well as other nodes. To ensure driver instances are initialized in the proper we need to identify these dependencies and construct a total order on nodes that ensures no node is initialized before something it depends on. Add a Graph class that calculates a partial order on nodes, taking into account the potential for cycles in the dependency graph. When generating devicetree value headers calculate the dependency graph and document the order and dependencies in the derived files. In the future these dependencies may be expressed in binding data. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-09-27 11:31:36 -05:00
#
# Test dependency relations
#
dts: testedtlib: Fix broken Node.dep_ordinal test Updating the test was overlooked when Node.ordinal was renamed to Node.dep_ordinal. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-06 22:17:10 +01:00
verify_eq(edt.get_node("/").dep_ordinal, 0)
verify_eq(edt.get_node("/in-dir-1").dep_ordinal, 1)
dts: edtlib: Turn edt.required_by()/depends_on() into Node attributes Turns edt.required_by(node) edt.depends_on(node) into node.required_by node.depends_on which might be a bit more readable. One drawback is that @property hides that there's some slight overhead in accessing them, but I suspect it won't be meaningful. Caching could be added if it ever turns out to be. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-06 22:36:50 +01:00
if edt.get_node("/") not in edt.get_node("/in-dir-1").depends_on:
fail("/ should be a direct dependency of /in-dir-1")
if edt.get_node("/in-dir-1") not in edt.get_node("/").required_by:
fail("/in-dir-1 should directly depend on /")
scripts: dts: add dependency information to edtlib Device tree nodes have a dependency on their parents, as well as other nodes. To ensure driver instances are initialized in the proper we need to identify these dependencies and construct a total order on nodes that ensures no node is initialized before something it depends on. Add a Graph class that calculates a partial order on nodes, taking into account the potential for cycles in the dependency graph. When generating devicetree value headers calculate the dependency graph and document the order and dependencies in the derived files. In the future these dependencies may be expressed in binding data. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
2019-09-27 11:31:36 -05:00
dts: edtlib: Add helper for testing error messages and test _slice() Add a helper function verify_error() to testedtlib.py that takes a DTS source and verifies that it generates a particular EDTError. Use it to test the hints that the previous commit added to errors generated by _slice(). Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-09 07:03:42 +01:00
#
# Test error messages from _slice()
#
verify_error("""
/dts-v1/;
/ {
#address-cells = <1>;
#size-cells = <2>;
sub {
reg = <3>;
};
};
""", "'reg' property in <Node /sub in 'error.dts'> has length 4, which is not evenly divisible by 12 (= 4*(<#address-cells> (= 1) + <#size-cells> (= 2))). Note that #*-cells properties come either from the parent node or from the controller (in the case of 'interrupts').")
verify_error("""
/dts-v1/;
/ {
sub {
interrupts = <1>;
interrupt-parent = < &{/controller} >;
};
controller {
interrupt-controller;
#interrupt-cells = <2>;
};
};
""", "'interrupts' property in <Node /sub in 'error.dts'> has length 4, which is not evenly divisible by 8 (= 4*<#interrupt-cells>). Note that #*-cells properties come either from the parent node or from the controller (in the case of 'interrupts').")
verify_error("""
/dts-v1/;
/ {
#address-cells = <1>;
sub-1 {
#address-cells = <2>;
#size-cells = <3>;
ranges = <4 5>;
sub-2 {
reg = <1 2 3 4 5>;
};
};
};
""", "'ranges' property in <Node /sub-1 in 'error.dts'> has length 8, which is not evenly divisible by 24 (= 4*(<#address-cells> (= 2) + <#address-cells for parent> (= 1) + <#size-cells> (= 3))). Note that #*-cells properties come either from the parent node or from the controller (in the case of 'interrupts').")
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
print("all tests passed")
dts: edtlib: Add helper for testing error messages and test _slice() Add a helper function verify_error() to testedtlib.py that takes a DTS source and verifies that it generates a particular EDTError. Use it to test the hints that the previous commit added to errors generated by _slice(). Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-09 07:03:42 +01:00
def verify_error(dts, error):
# Verifies that parsing a file with the contents 'dts' (a string) raises an
# EDTError with the message 'error'
# Could use the 'tempfile' module instead of 'error.dts', but having a
# consistent filename makes error messages consistent and easier to test.
# error.dts is kept if the test fails, which is helpful.
with open("error.dts", "w", encoding="utf-8") as f:
f.write(dts)
f.flush() # Can't have unbuffered text IO, so flush() instead
try:
edtlib.EDT("error.dts", [])
except edtlib.EDTError as e:
if str(e) != error:
fail(f"expected the EDTError '{error}', got the EDTError '{e}'")
except Exception as e:
fail(f"expected the EDTError '{error}', got the {type(e).__name__} '{e}'")
else:
fail(f"expected the error '{error}', got no error")
os.remove("error.dts")
def fail(msg):
sys.exit("test failed: " + msg)
def verify_eq(actual, expected):
if actual != expected:
# Put values on separate lines to make it easy to spot differences
fail("not equal (expected value last):\n'{}'\n'{}'"
.format(actual, expected))
def verify_streq(actual, expected):
verify_eq(str(actual), expected)
dts: Add new DTS/binding parser Add a new DTS/binding parser to scripts/dts/ for generating generated_dts_board.conf and generated_dts_board_unfixed.h. The old code is kept to generate some deprecated defines, using the --deprecated-only flag. It will be removed later. The new parser is implemented in three files in scripts/dts/: dtlib.py: A low-level .dts parsing library. This is similar to devicetree.py in the old code, but is a general robust DTS parser that doesn't rely on preprocessing. edtlib.py (e for extended): A library built on top of dtlib.py that brings together data from DTS files and bindings and creates Device instances with all the data for a device. gen_defines.py: A script that uses edtlib.py to generate generated_dts_board.conf and generated_dts_board_unfixed.h. Corresponds to extract_dts_includes.py and the files in extract/ in the old code. testdtlib.py: Test suite for dtlib.py. Can be run directly as a script. testedtlib.py (uses test.dts and test-bindings/): Test suite for edtlib.py. Can be run directly as a script. The test suites will be run automatically in CI. The new code turns some things that were warnings (or not checked) in the old code into errors, like missing properties that are specified with 'category: required' in the binding for the node. The code includes lots of documentation and tries to give helpful error messages instead of Python errors. Co-authored-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-12-17 20:09:47 +01:00
if __name__ == "__main__":
run()
Copy permalink