From 6e5d3e6e0569f5b9df0f891b1fdab8e3dac6291e Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sat, 3 May 2025 12:12:37 +0200 Subject: [PATCH 01/18] doc: u-boot-test-reset: mention power cycling Using power cycling is a valid option to implement u-boot-test-reset. Reviewed-by: Mattijs Korpershoek Signed-off-by: Heinrich Schuchardt --- doc/develop/py_testing.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/develop/py_testing.rst b/doc/develop/py_testing.rst index 217ae447035..5ad7f576ccd 100644 --- a/doc/develop/py_testing.rst +++ b/doc/develop/py_testing.rst @@ -377,7 +377,8 @@ this script again to restore U-Boot to an operational state before running the next test function. This script will likely be implemented by communicating with some form of -relay or electronic switch attached to the board's reset signal. +relay or electronic switch attached to the board's reset signal. Power cycling +is another option. The semantics of this script require that when it is executed, U-Boot will start running from scratch. If the U-Boot binary to be tested has been written From de56e5c9ebe65c1888c3b6f711223cf3a1e1038f Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sat, 3 May 2025 12:14:24 +0200 Subject: [PATCH 02/18] doc: describe u-boot-test-release The scripts u-boot-test-release is called at the end of testing. Describe it. Reviewed-by: Mattijs Korpershoek Reviewed-by: Simon Glass Signed-off-by: Heinrich Schuchardt --- doc/develop/py_testing.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/develop/py_testing.rst b/doc/develop/py_testing.rst index 5ad7f576ccd..deea048f771 100644 --- a/doc/develop/py_testing.rst +++ b/doc/develop/py_testing.rst @@ -389,6 +389,13 @@ to download the U-Boot binary directly into RAM and execute it. This would avoid the need for `u-boot-test-flash` to actually write U-Boot to flash, thus saving wear on the flash chip(s). +u-boot-test-release +''''''''''''''''''' + +When all tests for the board have been executed, this script is called. + +The board can be switched off now. + Examples '''''''' From 2865a8590f29c20a64cf0ba986f697d9973ed963 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vincent=20Stehl=C3=A9?= Date: Tue, 6 May 2025 14:36:22 +0200 Subject: [PATCH 03/18] cmd: nvedit: fix efi env -e -i command help MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The help string for the `setenv -e' command shows a comma being used as the separator between address and size for the -i option, which deals with UEFI Variables contents passed as a buffer in memory. This is no longer the case since commit 2b3fbcb59f41 ("efi_loader: use ':' as separator for setenv -i") and commit 8f0ac536d493 ("efi: change 'env -e -i' usage syntax"), which changed the separator from a comma to a colon. Therefore fix this last bit of the help string accordingly. While at it, fix the comment of function do_env_set_efi(), which also mentions a comma as separator. Signed-off-by: Vincent Stehlé Cc: Tom Rini Cc: Heinrich Schuchardt Cc: Ilias Apalodimas Cc: Maxim Uvarov Reviewed-by: Ilias Apalodimas Reviewed-by: Heinrich Schuchardt --- cmd/nvedit.c | 2 +- cmd/nvedit_efi.c | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/nvedit.c b/cmd/nvedit.c index 1f259801293..11c3cea882b 100644 --- a/cmd/nvedit.c +++ b/cmd/nvedit.c @@ -1263,7 +1263,7 @@ U_BOOT_CMD_COMPLETE( " \"-rt\": set runtime attribute\n" " \"-at\": set time-based authentication attribute\n" " \"-a\": append-write\n" - " \"-i addr,size\": use as variable's value\n" + " \"-i addr:size\": use as variable's value\n" " \"-v\": verbose message\n" " - delete UEFI variable 'name' if 'value' not specified\n" #endif diff --git a/cmd/nvedit_efi.c b/cmd/nvedit_efi.c index 32b7d049074..351ae47e870 100644 --- a/cmd/nvedit_efi.c +++ b/cmd/nvedit_efi.c @@ -367,7 +367,7 @@ out: * * This function is for "env set -e" or "setenv -e" command: * => env set -e [-guid guid][-nv][-bs][-rt][-at][-a][-v] - * [-i address,size] var, or + * [-i address:size] var, or * var [value ...] * Encode values specified and set given UEFI variable. * If no value is specified, delete the variable. From be2bdfd0199f37fed0ce19f90840f79d185e20d1 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Wed, 7 May 2025 16:08:17 -0600 Subject: [PATCH 04/18] doc: Start improving our pytest documentation Begin the work of documenting all of our pytests. To do this, we should have a directory under develop for it as there will be a large number of new files. As the current document is referenced externally in a number of locations, add the sphinx_reredirects module so that we can redirect from the old location to the new. Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- doc/conf.py | 8 +++++++- doc/develop/ci_testing.rst | 2 +- doc/develop/index.rst | 2 +- doc/develop/pytest/index.rst | 12 ++++++++++++ doc/develop/{py_testing.rst => pytest/usage.rst} | 2 +- doc/develop/testing.rst | 4 ++-- doc/develop/tests_writing.rst | 2 +- doc/sphinx/requirements.txt | 1 + 8 files changed, 26 insertions(+), 7 deletions(-) create mode 100644 doc/develop/pytest/index.rst rename doc/develop/{py_testing.rst => pytest/usage.rst} (99%) diff --git a/doc/conf.py b/doc/conf.py index c50daf874a5..3cb9b2bb65e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -47,7 +47,8 @@ needs_sphinx = '2.4.4' extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'kfigure', 'sphinx.ext.ifconfig', # 'automarkup', 'maintainers_include', 'sphinx.ext.autosectionlabel', - 'kernel_abi', 'kernel_feat', 'sphinx-prompt'] + 'kernel_abi', 'kernel_feat', 'sphinx-prompt', + 'sphinx_reredirects' ] # # cdomain is badly broken in Sphinx 3+. Leaving it out generates *most* @@ -148,6 +149,11 @@ project = 'Das U-Boot' copyright = 'The U-Boot development community' author = 'The U-Boot development community' +# Pages we have moved after being heavily referenced externally +redirects = { + "develop/py_testing": "pytest/usage.html" +} + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. diff --git a/doc/develop/ci_testing.rst b/doc/develop/ci_testing.rst index ffaacedc3d8..2033e3447e9 100644 --- a/doc/develop/ci_testing.rst +++ b/doc/develop/ci_testing.rst @@ -18,7 +18,7 @@ be built with mingw to run on Windows. Each of the pipelines is written in such as way as to be a "world build" style test and as such we try and build all possible platforms. In addition, for all platforms that support being run in QEMU we run them in QEMU and use our pytest -suite. See :doc:`py_testing` for more information about those tests. +suite. See :doc:`pytest/usage` for more information about those tests. Azure Pipelines --------------- diff --git a/doc/develop/index.rst b/doc/develop/index.rst index c907f8c9c2c..0c83ef109ab 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -82,7 +82,7 @@ Testing :maxdepth: 1 testing - py_testing + pytest/index tests_writing tests_sandbox binman_tests diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst new file mode 100644 index 00000000000..435d84fc619 --- /dev/null +++ b/doc/develop/pytest/index.rst @@ -0,0 +1,12 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +pytest Framework within U-Boot +============================== + +General +------- + +.. toctree:: + :maxdepth: 1 + + usage diff --git a/doc/develop/py_testing.rst b/doc/develop/pytest/usage.rst similarity index 99% rename from doc/develop/py_testing.rst rename to doc/develop/pytest/usage.rst index deea048f771..49d269d66a7 100644 --- a/doc/develop/py_testing.rst +++ b/doc/develop/pytest/usage.rst @@ -13,7 +13,7 @@ results. Advantages of this approach are: U-Boot; there can be no disconnect. - There is no need to write or embed test-related code into U-Boot itself. It is asserted that writing test-related code in Python is simpler and more - flexible than writing it all in C. But see :doc:`tests_writing` for caveats + flexible than writing it all in C. But see :doc:`../tests_writing` for caveats and more discussion / analysis. - It is reasonably simple to interact with U-Boot in this way. diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst index 9114d11ad26..aa7786c99fd 100644 --- a/doc/develop/testing.rst +++ b/doc/develop/testing.rst @@ -33,7 +33,7 @@ You can also run a selection tests in parallel with:: make pcheck All of the above use the test/run script with a paremeter to select which tests -are run. See :doc:`py_testing` for more information. +are run. See :doc:`pytest/usage` for more information. Sandbox @@ -69,7 +69,7 @@ build:: ./test/py/test.py --bd sandbox_spl --build -k test_spl -See :doc:`py_testing` for more information about the pytest suite. +See :doc:`pytest/usage` for more information about the pytest suite. See :doc:`tests_sandbox` for how to run tests directly (not through pytest). diff --git a/doc/develop/tests_writing.rst b/doc/develop/tests_writing.rst index f6f852c297d..062194659b5 100644 --- a/doc/develop/tests_writing.rst +++ b/doc/develop/tests_writing.rst @@ -376,5 +376,5 @@ An example SPL test is spl_test_load(). Writing Python tests -------------------- -See :doc:`py_testing` for brief notes how to write Python tests. You +See :doc:`pytest/usage` for brief notes how to write Python tests. You should be able to use the existing tests in test/py/tests as examples. diff --git a/doc/sphinx/requirements.txt b/doc/sphinx/requirements.txt index 13e0327c0f6..12c5772684d 100644 --- a/doc/sphinx/requirements.txt +++ b/doc/sphinx/requirements.txt @@ -15,6 +15,7 @@ six==1.16.0 snowballstemmer==2.2.0 Sphinx==8.1.3 sphinx-prompt==1.9.0 +sphinx-reredirects==0.1.5 sphinx-rtd-theme==3.0.1 sphinxcontrib-applehelp==2.0.0 sphinxcontrib-devhelp==2.0.0 From a865d1d25410af97376fd3c822bac560b99fd84b Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Wed, 7 May 2025 16:08:18 -0600 Subject: [PATCH 05/18] doc: pytest: Framework for documenting tests and document test_000_version In order to easily document pytests, we need to include the autodoc extension. We also need to make sure that for building the docs, CI includes pytest and that we have PYTHONPATH configured such that it will find all of the tests and related files. Finally, we need to have our comments in the test file by in proper pydoc format in order to be included in the output. Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- .azure-pipelines.yml | 2 +- .gitlab-ci.yml | 2 +- Makefile | 3 ++- doc/conf.py | 2 +- doc/develop/pytest/index.rst | 8 ++++++++ doc/develop/pytest/test_000_version.rst | 8 ++++++++ test/py/tests/test_000_version.py | 10 ++++++---- 7 files changed, 27 insertions(+), 8 deletions(-) create mode 100644 doc/develop/pytest/test_000_version.rst diff --git a/.azure-pipelines.yml b/.azure-pipelines.yml index 5e1938b0526..9c136513bb9 100644 --- a/.azure-pipelines.yml +++ b/.azure-pipelines.yml @@ -92,7 +92,7 @@ stages: set -e python3 -m venv /tmp/venvhtml . /tmp/venvhtml/bin/activate - pip install -r doc/sphinx/requirements.txt + pip install -r doc/sphinx/requirements.txt pytest make htmldocs KDOC_WERROR=1 make infodocs diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 6f11331514b..7aadd5d8b73 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -164,7 +164,7 @@ docs: script: - python3 -m venv /tmp/venvhtml - . /tmp/venvhtml/bin/activate - - pip install -r doc/sphinx/requirements.txt + - pip install -r doc/sphinx/requirements.txt pytest - make htmldocs KDOC_WERROR=1 - make infodocs diff --git a/Makefile b/Makefile index 15c7e633b87..bd136a48982 100644 --- a/Makefile +++ b/Makefile @@ -2448,7 +2448,8 @@ DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs \ linkcheckdocs dochelp refcheckdocs texinfodocs infodocs PHONY += $(DOC_TARGETS) $(DOC_TARGETS): scripts_basic FORCE - $(Q)$(MAKE) $(build)=doc $@ + $(Q)PYTHONPATH=$(srctree)/test/py/tests:$(srctree)/test/py \ + $(MAKE) $(build)=doc $@ PHONY += checkstack ubootrelease ubootversion diff --git a/doc/conf.py b/doc/conf.py index 3cb9b2bb65e..84d028feda8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -48,7 +48,7 @@ extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'kfigure', 'sphinx.ext.ifconfig', # 'automarkup', 'maintainers_include', 'sphinx.ext.autosectionlabel', 'kernel_abi', 'kernel_feat', 'sphinx-prompt', - 'sphinx_reredirects' ] + 'sphinx_reredirects', 'sphinx.ext.autodoc' ] # # cdomain is badly broken in Sphinx 3+. Leaving it out generates *most* diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst index 435d84fc619..ca45e157d3b 100644 --- a/doc/develop/pytest/index.rst +++ b/doc/develop/pytest/index.rst @@ -10,3 +10,11 @@ General :maxdepth: 1 usage + +Individual tests +---------------- + +.. toctree:: + :maxdepth: 1 + + test_000_version diff --git a/doc/develop/pytest/test_000_version.rst b/doc/develop/pytest/test_000_version.rst new file mode 100644 index 00000000000..09e9a361729 --- /dev/null +++ b/doc/develop/pytest/test_000_version.rst @@ -0,0 +1,8 @@ +test_000_version +================ + +.. automodule:: test_000_version + :synopsis: + :member-order: bysource + :members: + :undoc-members: diff --git a/test/py/tests/test_000_version.py b/test/py/tests/test_000_version.py index b95ceae2346..63d392e956e 100644 --- a/test/py/tests/test_000_version.py +++ b/test/py/tests/test_000_version.py @@ -2,10 +2,12 @@ # Copyright (c) 2015 Stephen Warren # Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved. -# pytest runs tests the order of their module path, which is related to the -# filename containing the test. This file is named such that it is sorted -# first, simply as a very basic sanity check of the functionality of the U-Boot -# command prompt. +""" +pytest runs tests the order of their module path, which is related to the +filename containing the test. This file is named such that it is sorted +first, simply as a very basic sanity check of the functionality of the U-Boot +command prompt. +""" def test_version(ubman): """Test that the "version" command prints the U-Boot version.""" From 8f8f0f0ed9d0f9d4ac385da735cef1eedd891499 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Wed, 7 May 2025 16:08:19 -0600 Subject: [PATCH 06/18] doc: pytest: Document the test_net_boot test Add the test_net_boot.py test to the generated documentation. While most of this was already commented correctly for inclusion the biggest problem was examples of code without a code-block notation. This in turn broke parsing. Add the missing notations. We also must have the comment prior to any import lines or it will not be seen as a comment on the overall file and thus not included. Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- doc/develop/pytest/index.rst | 1 + doc/develop/pytest/test_net_boot.rst | 8 ++ test/py/tests/test_net_boot.py | 153 +++++++++++++++------------ 3 files changed, 93 insertions(+), 69 deletions(-) create mode 100644 doc/develop/pytest/test_net_boot.rst diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst index ca45e157d3b..36083882584 100644 --- a/doc/develop/pytest/index.rst +++ b/doc/develop/pytest/index.rst @@ -18,3 +18,4 @@ Individual tests :maxdepth: 1 test_000_version + test_net_boot diff --git a/doc/develop/pytest/test_net_boot.rst b/doc/develop/pytest/test_net_boot.rst new file mode 100644 index 00000000000..369bd3b809c --- /dev/null +++ b/doc/develop/pytest/test_net_boot.rst @@ -0,0 +1,8 @@ +test_net_boot +============= + +.. automodule:: test_net_boot + :synopsis: + :member-order: bysource + :members: + :undoc-members: diff --git a/test/py/tests/test_net_boot.py b/test/py/tests/test_net_boot.py index abf6dfbaf5e..6585f0574c0 100644 --- a/test/py/tests/test_net_boot.py +++ b/test/py/tests/test_net_boot.py @@ -1,11 +1,6 @@ # SPDX-License-Identifier: GPL-2.0 # (C) Copyright 2023, Advanced Micro Devices, Inc. -import pytest -import utils -import test_net -import re - """ Note: This test relies on boardenv_* containing configuration values to define which the network environment available for testing. Without this, this test @@ -13,77 +8,88 @@ will be automatically skipped. For example: -# Details regarding a boot image file that may be read from a TFTP server. This -# variable may be omitted or set to None if TFTP boot testing is not possible -# or desired. -env__net_tftp_bootable_file = { - 'fn': 'image.ub', - 'addr': 0x10000000, - 'size': 5058624, - 'crc32': 'c2244b26', - 'pattern': 'Linux', - 'config': 'config@2', - 'timeout': 50000, - 'check_type': 'boot_error', - 'check_pattern': 'ERROR', -} +.. code-block:: python -# False or omitted if a TFTP boot test should be tested. -# If TFTP boot testing is not possible or desired, set this variable to True. -# For example: If FIT image is not proper to boot -env__tftp_boot_test_skip = False + # Details regarding a boot image file that may be read from a TFTP server. This + # variable may be omitted or set to None if TFTP boot testing is not possible + # or desired. + env__net_tftp_bootable_file = { + 'fn': 'image.ub', + 'addr': 0x10000000, + 'size': 5058624, + 'crc32': 'c2244b26', + 'pattern': 'Linux', + 'config': 'config@2', + 'timeout': 50000, + 'check_type': 'boot_error', + 'check_pattern': 'ERROR', + } -# Here is the example of FIT image configurations: -configurations { - default = "config@1"; - config@1 { - description = "Boot Linux kernel with config@1"; - kernel = "kernel@0"; - fdt = "fdt@0"; - ramdisk = "ramdisk@0"; - hash@1 { - algo = "sha1"; - }; - }; - config@2 { - description = "Boot Linux kernel with config@2"; - kernel = "kernel@1"; - fdt = "fdt@1"; - ramdisk = "ramdisk@1"; - hash@1 { - algo = "sha1"; - }; - }; -}; + # False or omitted if a TFTP boot test should be tested. + # If TFTP boot testing is not possible or desired, set this variable to True. + # For example: If FIT image is not proper to boot + env__tftp_boot_test_skip = False -# Details regarding a file that may be read from a TFTP server. This variable -# may be omitted or set to None if PXE testing is not possible or desired. -env__net_pxe_bootable_file = { - 'fn': 'default', - 'addr': 0x10000000, - 'size': 74, - 'timeout': 50000, - 'pattern': 'Linux', - 'valid_label': '1', - 'invalid_label': '2', - 'exp_str_invalid': 'Skipping install for failure retrieving', - 'local_label': '3', - 'exp_str_local': 'missing environment variable: localcmd', - 'empty_label': '4', - 'exp_str_empty': 'No kernel given, skipping boot', - 'check_type': 'boot_error', - 'check_pattern': 'ERROR', -} -# False if a PXE boot test should be tested. -# If PXE boot testing is not possible or desired, set this variable to True. -# For example: If pxe configuration file is not proper to boot -env__pxe_boot_test_skip = False +Here is the example of FIT image configurations: + +.. code-block:: devicetree + + configurations { + default = "config@1"; + config@1 { + description = "Boot Linux kernel with config@1"; + kernel = "kernel@0"; + fdt = "fdt@0"; + ramdisk = "ramdisk@0"; + hash@1 { + algo = "sha1"; + }; + }; + config@2 { + description = "Boot Linux kernel with config@2"; + kernel = "kernel@1"; + fdt = "fdt@1"; + ramdisk = "ramdisk@1"; + hash@1 { + algo = "sha1"; + }; + }; + }; + +.. code-block:: python + + # Details regarding a file that may be read from a TFTP server. This variable + # may be omitted or set to None if PXE testing is not possible or desired. + env__net_pxe_bootable_file = { + 'fn': 'default', + 'addr': 0x10000000, + 'size': 74, + 'timeout': 50000, + 'pattern': 'Linux', + 'valid_label': '1', + 'invalid_label': '2', + 'exp_str_invalid': 'Skipping install for failure retrieving', + 'local_label': '3', + 'exp_str_local': 'missing environment variable: localcmd', + 'empty_label': '4', + 'exp_str_empty': 'No kernel given, skipping boot', + 'check_type': 'boot_error', + 'check_pattern': 'ERROR', + } + + # False if a PXE boot test should be tested. + # If PXE boot testing is not possible or desired, set this variable to True. + # For example: If pxe configuration file is not proper to boot + env__pxe_boot_test_skip = False + +Here is the example of pxe configuration file ordered based on the execution +flow: -# Here is the example of pxe configuration file ordered based on the execution -# flow: 1) /tftpboot/pxelinux.cfg/default-arm-zynqmp +.. code-block:: + menu include pxelinux.cfg/default-arm timeout 50 @@ -91,6 +97,8 @@ env__pxe_boot_test_skip = False 2) /tftpboot/pxelinux.cfg/default-arm +.. code-block:: + menu title Linux boot selections menu include pxelinux.cfg/default @@ -110,6 +118,8 @@ env__pxe_boot_test_skip = False 3) /tftpboot/pxelinux.cfg/default +.. code-block:: + label Linux menu label Boot kernel kernel Image @@ -117,6 +127,11 @@ env__pxe_boot_test_skip = False initrd rootfs.cpio.gz.u-boot """ +import pytest +import utils +import test_net +import re + def setup_networking(ubman): test_net.test_net_dhcp(ubman) if not test_net.net_set_up: From 9e5624858476dd6c570acb25a6d15b3f8738f076 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Wed, 7 May 2025 16:08:20 -0600 Subject: [PATCH 07/18] test: test_net_boot: Add more comments Some of the functions were missing pydoc comments. Add them so they will be included in the documentation. Reported-by: Heinrich Schuchardt Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- test/py/tests/test_net_boot.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/test/py/tests/test_net_boot.py b/test/py/tests/test_net_boot.py index 6585f0574c0..72086a74637 100644 --- a/test/py/tests/test_net_boot.py +++ b/test/py/tests/test_net_boot.py @@ -133,11 +133,21 @@ import test_net import re def setup_networking(ubman): + """Setup networking + + Making use of the test_net test, first try and configure networking via + DHCP. If this fails, fall back to static configuration. + """ test_net.test_net_dhcp(ubman) if not test_net.net_set_up: test_net.test_net_setup_static(ubman) def setup_tftpboot_boot(ubman): + """Setup for the tftpboot 'boot' test + + We check that a file to use has been configured. If it has, we download it + and ensure it has the expected crc32 value. + """ f = ubman.config.env.get('env__net_tftp_bootable_file', None) if not f: pytest.skip('No TFTP bootable file to read') @@ -213,6 +223,10 @@ def test_net_tftpboot_boot(ubman): ubman.cleanup_spawn() def setup_pxe_boot(ubman): + """Setup for the PXE 'boot' test + + Make sure that the file to load via PXE boot has been configured. + """ f = ubman.config.env.get('env__net_pxe_bootable_file', None) if not f: pytest.skip('No PXE bootable file to read') From 45d325ba0993f60b7b81bae1efde0bc324d49400 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Wed, 7 May 2025 17:23:00 -0600 Subject: [PATCH 08/18] doc: pytest: Document the test_net test Add this test to the documentation. While the diff appears large at first, the only changes within the test are to move the imports to follow the pydoc comment and then to code-block and indent the example configuration. Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- doc/develop/pytest/index.rst | 1 + doc/develop/pytest/test_net.rst | 8 ++ test/py/tests/test_net.py | 134 ++++++++++++++++---------------- 3 files changed, 77 insertions(+), 66 deletions(-) create mode 100644 doc/develop/pytest/test_net.rst diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst index 36083882584..e2131a2f4a6 100644 --- a/doc/develop/pytest/index.rst +++ b/doc/develop/pytest/index.rst @@ -18,4 +18,5 @@ Individual tests :maxdepth: 1 test_000_version + test_net test_net_boot diff --git a/doc/develop/pytest/test_net.rst b/doc/develop/pytest/test_net.rst new file mode 100644 index 00000000000..571179f7b9d --- /dev/null +++ b/doc/develop/pytest/test_net.rst @@ -0,0 +1,8 @@ +test_net +======== + +.. automodule:: test_net + :synopsis: + :member-order: bysource + :members: + :undoc-members: diff --git a/test/py/tests/test_net.py b/test/py/tests/test_net.py index 4732e4b57f8..27cdd73fd49 100644 --- a/test/py/tests/test_net.py +++ b/test/py/tests/test_net.py @@ -4,12 +4,6 @@ # Test various network-related functionality, such as the dhcp, ping, and # tftpboot commands. -import pytest -import utils -import uuid -import datetime -import re - """ Note: This test relies on boardenv_* containing configuration values to define which network environment is available for testing. Without this, this test @@ -17,77 +11,85 @@ will be automatically skipped. For example: -# Boolean indicating whether the Ethernet device is attached to USB, and hence -# USB enumeration needs to be performed prior to network tests. -# This variable may be omitted if its value is False. -env__net_uses_usb = False +.. code-block:: python -# Boolean indicating whether the Ethernet device is attached to PCI, and hence -# PCI enumeration needs to be performed prior to network tests. -# This variable may be omitted if its value is False. -env__net_uses_pci = True + # Boolean indicating whether the Ethernet device is attached to USB, and hence + # USB enumeration needs to be performed prior to network tests. + # This variable may be omitted if its value is False. + env__net_uses_usb = False -# True if a DHCP server is attached to the network, and should be tested. -# If DHCP testing is not possible or desired, this variable may be omitted or -# set to False. -env__net_dhcp_server = True + # Boolean indicating whether the Ethernet device is attached to PCI, and hence + # PCI enumeration needs to be performed prior to network tests. + # This variable may be omitted if its value is False. + env__net_uses_pci = True -# False or omitted if a DHCP server is attached to the network, and dhcp abort -# case should be tested. -# If DHCP abort testing is not possible or desired, set this variable to True. -# For example: On some setup, dhcp is too fast and this case may not work. -env__dhcp_abort_test_skip = True + # True if a DHCP server is attached to the network, and should be tested. + # If DHCP testing is not possible or desired, this variable may be omitted or + # set to False. + env__net_dhcp_server = True -# True if a DHCPv6 server is attached to the network, and should be tested. -# If DHCPv6 testing is not possible or desired, this variable may be omitted or -# set to False. -env__net_dhcp6_server = True + # False or omitted if a DHCP server is attached to the network, and dhcp abort + # case should be tested. + # If DHCP abort testing is not possible or desired, set this variable to True. + # For example: On some setup, dhcp is too fast and this case may not work. + env__dhcp_abort_test_skip = True -# A list of environment variables that should be set in order to configure a -# static IP. If solely relying on DHCP, this variable may be omitted or set to -# an empty list. -env__net_static_env_vars = [ - ('ipaddr', '10.0.0.100'), - ('netmask', '255.255.255.0'), - ('serverip', '10.0.0.1'), -] + # True if a DHCPv6 server is attached to the network, and should be tested. + # If DHCPv6 testing is not possible or desired, this variable may be omitted or + # set to False. + env__net_dhcp6_server = True -# Details regarding a file that may be read from a TFTP server. This variable -# may be omitted or set to None if TFTP testing is not possible or desired. -env__net_tftp_readable_file = { - 'fn': 'ubtest-readable.bin', - 'addr': 0x10000000, - 'size': 5058624, - 'crc32': 'c2244b26', - 'timeout': 50000, - 'fnu': 'ubtest-upload.bin', -} + # A list of environment variables that should be set in order to configure a + # static IP. If solely relying on DHCP, this variable may be omitted or set to + # an empty list. + env__net_static_env_vars = [ + ('ipaddr', '10.0.0.100'), + ('netmask', '255.255.255.0'), + ('serverip', '10.0.0.1'), + ] -# Details regarding a file that may be read from a NFS server. This variable -# may be omitted or set to None if NFS testing is not possible or desired. -env__net_nfs_readable_file = { - 'fn': 'ubtest-readable.bin', - 'addr': 0x10000000, - 'size': 5058624, - 'crc32': 'c2244b26', -} + # Details regarding a file that may be read from a TFTP server. This variable + # may be omitted or set to None if TFTP testing is not possible or desired. + env__net_tftp_readable_file = { + 'fn': 'ubtest-readable.bin', + 'addr': 0x10000000, + 'size': 5058624, + 'crc32': 'c2244b26', + 'timeout': 50000, + 'fnu': 'ubtest-upload.bin', + } -# Details regarding a file that may be read from a TFTP server. This variable -# may be omitted or set to None if PXE testing is not possible or desired. -env__net_pxe_readable_file = { - 'fn': 'default', - 'addr': 0x2000000, - 'size': 74, - 'timeout': 50000, - 'pattern': 'Linux', -} + # Details regarding a file that may be read from a NFS server. This variable + # may be omitted or set to None if NFS testing is not possible or desired. + env__net_nfs_readable_file = { + 'fn': 'ubtest-readable.bin', + 'addr': 0x10000000, + 'size': 5058624, + 'crc32': 'c2244b26', + } -# True if a router advertisement service is connected to the network, and should -# be tested. If router advertisement testing is not possible or desired, this -variable may be omitted or set to False. -env__router_on_net = True + # Details regarding a file that may be read from a TFTP server. This variable + # may be omitted or set to None if PXE testing is not possible or desired. + env__net_pxe_readable_file = { + 'fn': 'default', + 'addr': 0x2000000, + 'size': 74, + 'timeout': 50000, + 'pattern': 'Linux', + } + + # True if a router advertisement service is connected to the network, and should + # be tested. If router advertisement testing is not possible or desired, this + variable may be omitted or set to False. + env__router_on_net = True """ +import pytest +import utils +import uuid +import datetime +import re + net_set_up = False net6_set_up = False From 58b2f0895bcbe24aad86c14813911f04b35cc5fb Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Wed, 7 May 2025 17:23:01 -0600 Subject: [PATCH 09/18] doc: pytest: Document the test_bootstage test Add this test to the documentation. We need to move the import to follow the main comment so that it renders correctly, and add a code-block annotation to the example and indent it correctly. Next, neither of the functions had comments themselves, so document them now. Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- doc/develop/pytest/index.rst | 1 + doc/develop/pytest/test_bootstage.rst | 8 ++++++ test/py/tests/test_bootstage.py | 35 +++++++++++++++++++++------ 3 files changed, 37 insertions(+), 7 deletions(-) create mode 100644 doc/develop/pytest/test_bootstage.rst diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst index e2131a2f4a6..5bcda1f0952 100644 --- a/doc/develop/pytest/index.rst +++ b/doc/develop/pytest/index.rst @@ -18,5 +18,6 @@ Individual tests :maxdepth: 1 test_000_version + test_bootstage test_net test_net_boot diff --git a/doc/develop/pytest/test_bootstage.rst b/doc/develop/pytest/test_bootstage.rst new file mode 100644 index 00000000000..f8f10e96a42 --- /dev/null +++ b/doc/develop/pytest/test_bootstage.rst @@ -0,0 +1,8 @@ +test_bootstage +============== + +.. automodule:: test_bootstage + :synopsis: + :member-order: bysource + :members: + :undoc-members: diff --git a/test/py/tests/test_bootstage.py b/test/py/tests/test_bootstage.py index 379c1cae6dd..2505862c5a4 100644 --- a/test/py/tests/test_bootstage.py +++ b/test/py/tests/test_bootstage.py @@ -1,8 +1,6 @@ # SPDX-License-Identifier: GPL-2.0 # (C) Copyright 2023, Advanced Micro Devices, Inc. -import pytest - """ Test the bootstage command. @@ -15,16 +13,32 @@ common/bootstage.c). Without this, bootstage stash and unstash tests will be automatically skipped. For example: -env__bootstage_cmd_file = { - 'addr': 0x200000, - 'size': 0x1000, - 'bootstage_magic_addr': 0xb00757a3, -} + +.. code-block:: python + + env__bootstage_cmd_file = { + 'addr': 0x200000, + 'size': 0x1000, + 'bootstage_magic_addr': 0xb00757a3, + } """ +import pytest + @pytest.mark.buildconfigspec('bootstage') @pytest.mark.buildconfigspec('cmd_bootstage') def test_bootstage_report(ubman): + """Test the bootstage report subcommand + + This will run the 'bootstage report' subcommand and ensure that we are + reporting: + + - A timer summary in microseconds + - The accumulated time + - That at least the phrase 'dm_r' is in the output + + Note that the time values are not checked. + """ output = ubman.run_command('bootstage report') assert 'Timer summary in microseconds' in output assert 'Accumulated time:' in output @@ -34,6 +48,13 @@ def test_bootstage_report(ubman): @pytest.mark.buildconfigspec('cmd_bootstage') @pytest.mark.buildconfigspec('bootstage_stash') def test_bootstage_stash_and_unstash(ubman): + """Test the bootstage stash and unstash subcommands + + After checking that we have configured an environment file to use, we will + use the stash subcommand to save information. Then we will use the md + command to verify the contents in memory. Finally we confirm the unstash + subcommand runs successfully. + """ f = ubman.config.env.get('env__bootstage_cmd_file', None) if not f: pytest.skip('No bootstage environment file is defined') From 6c3c08c4789b482e810dc4b60bfee914b063b232 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Wed, 7 May 2025 17:23:02 -0600 Subject: [PATCH 10/18] doc: pytest: Document the test_efi_loader test Add this test to the documentation. We need to add a code-block annotation to the example and indent it correctly. We also need to document the do_test_efi_helloworld_net function and that in turn means changing the documentation to test_efi_helloworld_net_http and test_efi_helloworld_net_tftp to reflect what is and isn't done in those functions themselves now. Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- doc/develop/pytest/index.rst | 1 + doc/develop/pytest/test_efi_loader.rst | 8 +++ test/py/tests/test_efi_loader.py | 77 ++++++++++++++------------ 3 files changed, 50 insertions(+), 36 deletions(-) create mode 100644 doc/develop/pytest/test_efi_loader.rst diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst index 5bcda1f0952..3265eb97c7e 100644 --- a/doc/develop/pytest/index.rst +++ b/doc/develop/pytest/index.rst @@ -19,5 +19,6 @@ Individual tests test_000_version test_bootstage + test_efi_loader test_net test_net_boot diff --git a/doc/develop/pytest/test_efi_loader.rst b/doc/develop/pytest/test_efi_loader.rst new file mode 100644 index 00000000000..da2fa7e6ec2 --- /dev/null +++ b/doc/develop/pytest/test_efi_loader.rst @@ -0,0 +1,8 @@ +test_efi_loader +=============== + +.. automodule:: test_efi_loader + :synopsis: + :member-order: bysource + :members: + :undoc-members: diff --git a/test/py/tests/test_efi_loader.py b/test/py/tests/test_efi_loader.py index 58f2655191f..91f151d09cd 100644 --- a/test/py/tests/test_efi_loader.py +++ b/test/py/tests/test_efi_loader.py @@ -13,43 +13,45 @@ that rely on network will be automatically skipped. For example: -# Boolean indicating whether the Ethernet device is attached to USB, and hence -# USB enumeration needs to be performed prior to network tests. -# This variable may be omitted if its value is False. -env__net_uses_usb = False +.. code-block:: python -# Boolean indicating whether the Ethernet device is attached to PCI, and hence -# PCI enumeration needs to be performed prior to network tests. -# This variable may be omitted if its value is False. -env__net_uses_pci = True + # Boolean indicating whether the Ethernet device is attached to USB, and hence + # USB enumeration needs to be performed prior to network tests. + # This variable may be omitted if its value is False. + env__net_uses_usb = False -# True if a DHCP server is attached to the network, and should be tested. -# If DHCP testing is not possible or desired, this variable may be omitted or -# set to False. -env__net_dhcp_server = True + # Boolean indicating whether the Ethernet device is attached to PCI, and hence + # PCI enumeration needs to be performed prior to network tests. + # This variable may be omitted if its value is False. + env__net_uses_pci = True -# A list of environment variables that should be set in order to configure a -# static IP. If solely relying on DHCP, this variable may be omitted or set to -# an empty list. -env__net_static_env_vars = [ - ('ipaddr', '10.0.0.100'), - ('netmask', '255.255.255.0'), - ('serverip', '10.0.0.1'), -] + # True if a DHCP server is attached to the network, and should be tested. + # If DHCP testing is not possible or desired, this variable may be omitted or + # set to False. + env__net_dhcp_server = True -# Details regarding a file that may be read from a TFTP server. This variable -# may be omitted or set to None if TFTP testing is not possible or desired. -env__efi_loader_helloworld_file = { - 'fn': 'lib/efi_loader/helloworld.efi', # file name - 'size': 5058624, # file length in bytes - 'crc32': 'c2244b26', # CRC32 check sum - 'addr': 0x40400000, # load address -} + # A list of environment variables that should be set in order to configure a + # static IP. If solely relying on DHCP, this variable may be omitted or set to + # an empty list. + env__net_static_env_vars = [ + ('ipaddr', '10.0.0.100'), + ('netmask', '255.255.255.0'), + ('serverip', '10.0.0.1'), + ] -# False if the helloworld EFI over HTTP boot test should be performed. -# If HTTP boot testing is not possible or desired, set this variable to True or -# ommit it. -env__efi_helloworld_net_http_test_skip = True + # Details regarding a file that may be read from a TFTP server. This variable + # may be omitted or set to None if TFTP testing is not possible or desired. + env__efi_loader_helloworld_file = { + 'fn': 'lib/efi_loader/helloworld.efi', # file name + 'size': 5058624, # file length in bytes + 'crc32': 'c2244b26', # CRC32 check sum + 'addr': 0x40400000, # load address + } + + # False if the helloworld EFI over HTTP boot test should be performed. + # If HTTP boot testing is not possible or desired, set this variable to True or + # ommit it. + env__efi_helloworld_net_http_test_skip = True """ import pytest @@ -161,6 +163,11 @@ def fetch_file(ubman, env_conf, proto): return addr def do_test_efi_helloworld_net(ubman, proto): + """Download and execute the helloworld appliation + + The helloworld.efi file is downloaded based on the value passed to us as a + protocol and is executed using the fallback device tree at $fdtcontroladdr. + """ addr = fetch_file(ubman, 'env__efi_loader_helloworld_file', proto) output = ubman.run_command('bootefi %x' % addr) @@ -175,8 +182,7 @@ def do_test_efi_helloworld_net(ubman, proto): def test_efi_helloworld_net_tftp(ubman): """Run the helloworld.efi binary via TFTP. - The helloworld.efi file is downloaded from the TFTP server and is executed - using the fallback device tree at $fdtcontroladdr. + Call the do_test_efi_helloworld_net function to execute the test via TFTP. """ do_test_efi_helloworld_net(ubman, PROTO_TFTP); @@ -187,8 +193,7 @@ def test_efi_helloworld_net_tftp(ubman): def test_efi_helloworld_net_http(ubman): """Run the helloworld.efi binary via HTTP. - The helloworld.efi file is downloaded from the HTTP server and is executed - using the fallback device tree at $fdtcontroladdr. + Call the do_test_efi_helloworld_net function to execute the test via HTTP. """ if ubman.config.env.get('env__efi_helloworld_net_http_test_skip', True): pytest.skip('helloworld.efi HTTP test is not enabled!') From 4964cc9caa885dbcdc028ecff5e86678ef3ea8af Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Thu, 8 May 2025 15:34:43 -0600 Subject: [PATCH 11/18] doc: pytest: Document the test_bind test Add this test to the documentation. None of the functions had comments, so attempt to explain what each does. Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- doc/develop/pytest/index.rst | 1 + doc/develop/pytest/test_bind.rst | 8 ++++++++ test/py/tests/test_bind.py | 12 ++++++++++++ 3 files changed, 21 insertions(+) create mode 100644 doc/develop/pytest/test_bind.rst diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst index 3265eb97c7e..cd6eb5f038f 100644 --- a/doc/develop/pytest/index.rst +++ b/doc/develop/pytest/index.rst @@ -18,6 +18,7 @@ Individual tests :maxdepth: 1 test_000_version + test_bind test_bootstage test_efi_loader test_net diff --git a/doc/develop/pytest/test_bind.rst b/doc/develop/pytest/test_bind.rst new file mode 100644 index 00000000000..0f636a9cc5a --- /dev/null +++ b/doc/develop/pytest/test_bind.rst @@ -0,0 +1,8 @@ +test_bind +========= + +.. automodule:: test_bind + :synopsis: + :member-order: bysource + :members: + :undoc-members: diff --git a/test/py/tests/test_bind.py b/test/py/tests/test_bind.py index 16c63ae9684..850fe113fe2 100644 --- a/test/py/tests/test_bind.py +++ b/test/py/tests/test_bind.py @@ -7,6 +7,7 @@ import re import pytest def in_tree(response, name, uclass, drv, depth, last_child): + """A helper function to confirm contents of the device tree """ lines = [x.strip() for x in response.splitlines()] leaf = '' if depth != 0: @@ -28,7 +29,12 @@ def in_tree(response, name, uclass, drv, depth, last_child): @pytest.mark.boardspec('sandbox') @pytest.mark.buildconfigspec('cmd_bind') def test_bind_unbind_with_node(ubman): + """Test the bind and unbind commands of a node + Verify that the dm tree output contains some expected nodes, and then bind + and unbind a USB via node device while verifying that the dm tree output + matches the expected values at each step. + """ tree = ubman.run_command('dm tree') assert in_tree(tree, 'bind-test', 'simple_bus', 'simple_bus', 0, True) assert in_tree(tree, 'bind-test-child1', 'phy', 'phy_sandbox', 1, False) @@ -106,6 +112,7 @@ def test_bind_unbind_with_node(ubman): assert response == '' def get_next_line(tree, name): + """A helper function to strip content out of dm tree output""" treelines = [x.strip() for x in tree.splitlines() if x.strip()] child_line = '' for idx, line in enumerate(treelines): @@ -121,6 +128,11 @@ def get_next_line(tree, name): @pytest.mark.buildconfigspec('cmd_bind') @pytest.mark.singlethread def test_bind_unbind_with_uclass(ubman): + """Test the bind and unbind commands of a class + + Bind and unbind the simple_bus class while verifying that the dm tree + output matches the expected values at each step. + """ #bind /bind-test response = ubman.run_command('bind /bind-test simple_bus') assert response == '' From e1076c6619194ddd82f8e364d8cafd907da40616 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Thu, 8 May 2025 15:34:44 -0600 Subject: [PATCH 12/18] doc: pytest: Document the test_bootmenu test Add this test to the documentation. There was already a function comment that included the argument, so convert it to the right style to be rendered correctly in output. Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- doc/develop/pytest/index.rst | 1 + doc/develop/pytest/test_bootmenu.rst | 8 ++++++++ test/py/tests/test_bootmenu.py | 4 ++-- 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 doc/develop/pytest/test_bootmenu.rst diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst index cd6eb5f038f..4d949cfd1d2 100644 --- a/doc/develop/pytest/index.rst +++ b/doc/develop/pytest/index.rst @@ -19,6 +19,7 @@ Individual tests test_000_version test_bind + test_bootmenu test_bootstage test_efi_loader test_net diff --git a/doc/develop/pytest/test_bootmenu.rst b/doc/develop/pytest/test_bootmenu.rst new file mode 100644 index 00000000000..e2ff5c4c201 --- /dev/null +++ b/doc/develop/pytest/test_bootmenu.rst @@ -0,0 +1,8 @@ +test_bootmenu +============= + +.. automodule:: test_bootmenu + :synopsis: + :member-order: bysource + :members: + :undoc-members: diff --git a/test/py/tests/test_bootmenu.py b/test/py/tests/test_bootmenu.py index 66f3fb8a131..be8257fe3e8 100644 --- a/test/py/tests/test_bootmenu.py +++ b/test/py/tests/test_bootmenu.py @@ -8,9 +8,9 @@ import pytest def test_bootmenu(ubman): """Test bootmenu - ubman -- U-Boot console + Args: + ubman: U-Boot console """ - with ubman.temporary_timeout(500): ubman.run_command('setenv bootmenu_default 1') ubman.run_command('setenv bootmenu_0 test 1=echo ok 1') From 02e5d344a0d75a4f05682b3438354748dc83d941 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Thu, 8 May 2025 15:34:45 -0600 Subject: [PATCH 13/18] doc: pytest: Document the test_button test Add this test to the documentation. No changes to the test itself were required. Signed-off-by: Tom Rini Reviewed-by: Simon Glass --- doc/develop/pytest/index.rst | 1 + doc/develop/pytest/test_button.rst | 8 ++++++++ test/py/tests/test_button.py | 2 ++ 3 files changed, 11 insertions(+) create mode 100644 doc/develop/pytest/test_button.rst diff --git a/doc/develop/pytest/index.rst b/doc/develop/pytest/index.rst index 4d949cfd1d2..0a7c1b21a24 100644 --- a/doc/develop/pytest/index.rst +++ b/doc/develop/pytest/index.rst @@ -21,6 +21,7 @@ Individual tests test_bind test_bootmenu test_bootstage + test_button test_efi_loader test_net test_net_boot diff --git a/doc/develop/pytest/test_button.rst b/doc/develop/pytest/test_button.rst new file mode 100644 index 00000000000..4e5a29f20a7 --- /dev/null +++ b/doc/develop/pytest/test_button.rst @@ -0,0 +1,8 @@ +test_button +=========== + +.. automodule:: test_button + :synopsis: + :member-order: bysource + :members: + :undoc-members: diff --git a/test/py/tests/test_button.py b/test/py/tests/test_button.py index f0d85be896d..f3f68169e14 100644 --- a/test/py/tests/test_button.py +++ b/test/py/tests/test_button.py @@ -1,5 +1,7 @@ # SPDX-License-Identifier: GPL-2.0+ +"""Tests for the button command""" + import pytest @pytest.mark.boardspec('sandbox') From b043852a789ec90e60b45012bc8cda29815cb44b Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Fri, 9 May 2025 08:39:04 +0200 Subject: [PATCH 14/18] doc: correct link to QEMU %s/hhttps:/https:/ Reviewed-by: Quentin Schulz Signed-off-by: Heinrich Schuchardt --- doc/develop/bootstd/qfw.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/develop/bootstd/qfw.rst b/doc/develop/bootstd/qfw.rst index 70086ad1817..fdc3ff71619 100644 --- a/doc/develop/bootstd/qfw.rst +++ b/doc/develop/bootstd/qfw.rst @@ -3,7 +3,7 @@ QFW Bootmeth ============ -`QEMU `_ is a system emulator which is able to boot +`QEMU `_ is a system emulator which is able to boot Operating Systems. QEMU provides specific support for booting an OS image provided on the QEMU command line. From 5e5ddf79f1f54e8a32334003d5133777c909c34b Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Fri, 9 May 2025 08:42:07 +0200 Subject: [PATCH 15/18] doc: RISC-V supports semihosting Mention that RISC-V supports semihosting. Update the link to ARM's semihosting documentation Update SPDX identifier to current format. Signed-off-by: Heinrich Schuchardt --- doc/usage/semihosting.rst | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/doc/usage/semihosting.rst b/doc/usage/semihosting.rst index 9303a6364d5..728367ffaf5 100644 --- a/doc/usage/semihosting.rst +++ b/doc/usage/semihosting.rst @@ -1,14 +1,17 @@ -.. SPDX-License-Identifier: GPL-2.0+ +.. SPDX-License-Identifier: GPL-2.0-or-later .. Copyright 2014 Broadcom Corporation. Semihosting =========== -Semihosting is ARM's way of having a real or virtual target communicate -with a host or host debugger for basic operations such as file I/O, -console I/O, etc. Please see `Arm's semihosting documentation -`_ for more -information. +Semihosting is a technique to let a real or virtual target communicate with a +host or host debugger for basic operations such as file I/O, console I/O, etc. +Originally introduced by ARM it has also been adopted for RISC-V. Please, see +`Arm's semihosting documentation +`_ and +`RISC-V Semihosting +`_ +for more information. Platform Support ---------------- @@ -40,7 +43,7 @@ Foundation and Base fastmodel simulators. QEMU ^^^^ -Another ARM emulator which supports semihosting is `QEMU +Another emulator which supports semihosting is `QEMU `_. To enable semihosting, enable ``CONFIG_SERIAL_PROBE_ALL`` when configuring U-Boot, and use ``-semihosting`` when invoking QEMU. Adding ``-nographic`` can also be @@ -53,8 +56,8 @@ running QEMU, refer to the :doc:`board documentation OpenOCD ^^^^^^^ -Any ARM platform can use semihosting with an attached debugger. One such -debugger with good support for a variety of boards and JTAG adapters is +Any ARM or RISC-V platform can use semihosting with an attached debugger. One +such debugger with good support for a variety of boards and JTAG adapters is `OpenOCD `_. Semihosting is not enabled by default, so you will need to enable it:: From 43d43241d1c9592bee640227a1c8ed8bc880f255 Mon Sep 17 00:00:00 2001 From: Adriano Cordova Date: Thu, 8 May 2025 14:30:32 -0400 Subject: [PATCH 16/18] scripts/Makefile.lib: add PLATFORM_LIBGCC to efi linking Link .efi applications using libgcc Signed-off-by: Adriano Cordova --- scripts/Makefile.lib | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/Makefile.lib b/scripts/Makefile.lib index 83fd5ff6c31..e89a4a51b74 100644 --- a/scripts/Makefile.lib +++ b/scripts/Makefile.lib @@ -497,7 +497,7 @@ KBUILD_EFILDFLAGS = -nostdlib -zexecstack -znocombreloc -znorelro KBUILD_EFILDFLAGS += $(call ld-option,--no-warn-rwx-segments) quiet_cmd_efi_ld = LD $@ cmd_efi_ld = $(LD) $(KBUILD_EFILDFLAGS) -L $(srctree) -T $(EFI_LDS_PATH) \ - -shared -Bsymbolic -s $^ -o $@ + -shared -Bsymbolic -s $^ $(PLATFORM_LIBGCC) -o $@ EFI_LDS_PATH = arch/$(ARCH)/lib/$(EFI_LDS) From 92cf91119f3c4785c37e8b12af224092c9a80b36 Mon Sep 17 00:00:00 2001 From: Adriano Cordova Date: Thu, 8 May 2025 14:30:33 -0400 Subject: [PATCH 17/18] efi_loader: fix dtbdump output color and format Imitate in dtbdump what initrddump does for color, newlines and input handling. The output parsing in the CI is strict and with the current output the CI is not recongnizing the prompt '=>'. Signed-off-by: Adriano Cordova Reviewed-by: Heinrich Schuchardt --- lib/efi_loader/dtbdump.c | 86 ++++++++++++++++++++++++++++++++++------ 1 file changed, 74 insertions(+), 12 deletions(-) diff --git a/lib/efi_loader/dtbdump.c b/lib/efi_loader/dtbdump.c index a3d59a2fd3b..1e72404ecc1 100644 --- a/lib/efi_loader/dtbdump.c +++ b/lib/efi_loader/dtbdump.c @@ -29,6 +29,18 @@ static struct efi_system_table *systable; static const efi_guid_t efi_dt_fixup_protocol_guid = EFI_DT_FIXUP_PROTOCOL_GUID; static const efi_guid_t efi_file_info_guid = EFI_FILE_INFO_GUID; static const efi_guid_t efi_system_partition_guid = PARTITION_SYSTEM_GUID; +static bool nocolor; + +/** + * color() - set foreground color + * + * @color: foreground color + */ +static void color(u8 color) +{ + if (!nocolor) + cout->set_attribute(cout, color | EFI_BACKGROUND_BLACK); +} /** * print() - print string @@ -87,6 +99,17 @@ static void printx(unsigned char val) print_hex_digit(val & 0xf); } +/** + * cls() - clear screen + */ +static void cls(void) +{ + if (nocolor) + print(u"\r\n"); + else + cout->clear_screen(cout); +} + /** * error() - print error string * @@ -94,9 +117,17 @@ static void printx(unsigned char val) */ static void error(u16 *string) { - cout->set_attribute(cout, EFI_LIGHTRED | EFI_BACKGROUND_BLACK); + color(EFI_LIGHTRED); print(string); - cout->set_attribute(cout, EFI_LIGHTBLUE | EFI_BACKGROUND_BLACK); + color(EFI_LIGHTBLUE); +} + +/** + * efi_drain_input() - drain console input + */ +static void efi_drain_input(void) +{ + cin->reset(cin, true); } /** @@ -116,8 +147,6 @@ static efi_status_t efi_input_yn(void) efi_uintn_t index; efi_status_t ret; - /* Drain the console input */ - ret = cin->reset(cin, true); for (;;) { ret = bs->wait_for_event(1, &cin->wait_for_key, &index); if (ret != EFI_SUCCESS) @@ -158,8 +187,6 @@ static efi_status_t efi_input(u16 *buffer, efi_uintn_t buffer_size) u16 outbuf[2] = u" "; efi_status_t ret; - /* Drain the console input */ - ret = cin->reset(cin, true); *buffer = 0; for (;;) { ret = bs->wait_for_event(1, &cin->wait_for_key, &index); @@ -262,6 +289,9 @@ static u16 *skip_whitespace(u16 *pos) */ static bool starts_with(u16 *string, u16 *keyword) { + if (!string || !keyword) + return false; + for (; *keyword; ++string, ++keyword) { if (*string != *keyword) return false; @@ -737,6 +767,7 @@ static efi_status_t do_dump(void) error(u"Missing end node\r\n"); return EFI_LOAD_ERROR; } + print(u"\r\n"); return EFI_SUCCESS; default: error(u"Invalid device tree token\r\n"); @@ -748,6 +779,30 @@ static efi_status_t do_dump(void) return EFI_LOAD_ERROR; } +/** + * get_load_options() - get load options + * + * Return: load options or NULL + */ +static u16 *get_load_options(void) +{ + efi_status_t ret; + struct efi_loaded_image *loaded_image; + + ret = bs->open_protocol(handle, &loaded_image_guid, + (void **)&loaded_image, NULL, NULL, + EFI_OPEN_PROTOCOL_GET_PROTOCOL); + if (ret != EFI_SUCCESS) { + error(u"Loaded image protocol not found\r\n"); + return NULL; + } + + if (!loaded_image->load_options_size || !loaded_image->load_options) + return NULL; + + return loaded_image->load_options; +} + /** * efi_main() - entry point of the EFI application. * @@ -758,24 +813,31 @@ static efi_status_t do_dump(void) efi_status_t EFIAPI efi_main(efi_handle_t image_handle, struct efi_system_table *systab) { + u16 *load_options; + handle = image_handle; systable = systab; cerr = systable->std_err; cout = systable->con_out; cin = systable->con_in; bs = systable->boottime; + load_options = get_load_options(); - cout->set_attribute(cout, EFI_LIGHTBLUE | EFI_BACKGROUND_BLACK); - cout->clear_screen(cout); - cout->set_attribute(cout, EFI_WHITE | EFI_BACKGROUND_BLACK); + if (starts_with(load_options, u"nocolor")) + nocolor = true; + + color(EFI_LIGHTBLUE); + cls(); + color(EFI_WHITE); print(u"DTB Dump\r\n========\r\n\r\n"); - cout->set_attribute(cout, EFI_LIGHTBLUE | EFI_BACKGROUND_BLACK); + color(EFI_LIGHTBLUE); for (;;) { u16 command[BUFFER_SIZE]; u16 *pos; efi_uintn_t ret; + efi_drain_input(); print(u"=> "); ret = efi_input(command, sizeof(command)); if (ret == EFI_ABORTED) @@ -793,7 +855,7 @@ efi_status_t EFIAPI efi_main(efi_handle_t image_handle, do_help(); } - cout->set_attribute(cout, EFI_LIGHTGRAY | EFI_BACKGROUND_BLACK); - cout->clear_screen(cout); + color(EFI_LIGHTGRAY); + cls(); return EFI_SUCCESS; } From 8fdb8740b39b01d182137d437f2d1d16b526a4b5 Mon Sep 17 00:00:00 2001 From: Adriano Cordova Date: Thu, 8 May 2025 14:30:34 -0400 Subject: [PATCH 18/18] test/py/test_efi_fit: test fdt and initrd Add tests to check initrd and dtb loading Signed-off-by: Adriano Cordova --- test/py/tests/test_efi_fit.py | 156 +++++++++++++++++++++++++++------- 1 file changed, 124 insertions(+), 32 deletions(-) diff --git a/test/py/tests/test_efi_fit.py b/test/py/tests/test_efi_fit.py index 5f352e7efff..63ee8e6cef2 100644 --- a/test/py/tests/test_efi_fit.py +++ b/test/py/tests/test_efi_fit.py @@ -66,9 +66,29 @@ ITS_DATA = ''' #address-cells = <1>; images { - efi { + helloworld { description = "Test EFI"; - data = /incbin/("%(efi-bin)s"); + data = /incbin/("%(hello-bin)s"); + type = "%(kernel-type)s"; + arch = "%(sys-arch)s"; + os = "efi"; + compression = "%(efi-comp)s"; + load = <0x0>; + entry = <0x0>; + }; + dtbdump { + description = "Test EFI fdtdump"; + data = /incbin/("%(dtbdump-bin)s"); + type = "%(kernel-type)s"; + arch = "%(sys-arch)s"; + os = "efi"; + compression = "%(efi-comp)s"; + load = <0x0>; + entry = <0x0>; + }; + initrddump { + description = "Test EFI initrddump"; + data = /incbin/("%(initrddump-bin)s"); type = "%(kernel-type)s"; arch = "%(sys-arch)s"; os = "efi"; @@ -83,18 +103,33 @@ ITS_DATA = ''' arch = "%(sys-arch)s"; compression = "%(fdt-comp)s"; }; + initrd { + description = "Initial RAM Disk"; + data = /incbin/("%(initrd-fs)s"); + type = "ramdisk"; + compression = "%(initrd-comp)s"; + os = "efi"; + }; }; configurations { default = "config-efi-fdt"; + + config-efi { + description = "EFI FIT w/o FDT"; + kernel = "helloworld"; + }; + config-efi-fdt { description = "EFI FIT w/ FDT"; - kernel = "efi"; + kernel = "dtbdump"; fdt = "fdt"; }; - config-efi-nofdt { - description = "EFI FIT w/o FDT"; - kernel = "efi"; + + config-efi-initrd { + description = "EFI FIT w/ initrd"; + kernel = "initrddump"; + ramdisk = "initrd"; }; }; }; @@ -108,7 +143,7 @@ FDT_DATA = ''' #address-cells = <1>; #size-cells = <1>; - model = "%(sys-arch)s %(fdt_type)s EFI FIT Boot Test"; + model = "%(sys-arch)s %(fdt_type)s EFI FIT FDT Boot Test"; compatible = "%(sys-arch)s"; reset@0 { @@ -120,6 +155,7 @@ FDT_DATA = ''' @pytest.mark.buildconfigspec('bootm_efi') @pytest.mark.buildconfigspec('BOOTEFI_HELLO_COMPILE') +@pytest.mark.buildconfigspec('EFI_LOAD_FILE2_INITRD') @pytest.mark.buildconfigspec('fit') @pytest.mark.notbuildconfigspec('generate_acpi_table') @pytest.mark.requiredtool('dtc') @@ -137,8 +173,10 @@ def test_efi_fit_launch(ubman): The following test cases are currently defined and enabled: - Launch uncompressed FIT EFI & internal FDT - Launch uncompressed FIT EFI & FIT FDT + - Launch uncompressed FIT EFI & internal FDT & FIT initrd - Launch compressed FIT EFI & internal FDT - Launch compressed FIT EFI & FIT FDT + - Launch compressed FIT EFI & internal FDT & FIT initrd """ def net_pre_commands(): @@ -210,7 +248,7 @@ def test_efi_fit_launch(ubman): return os.path.join(ubman.config.build_dir, file_name) - def make_efi(fname, comp): + def make_efi(fname, efi_file, comp): """Create an UEFI binary. This simply copies lib/efi_loader/helloworld.efi into U-Boot @@ -218,6 +256,7 @@ def test_efi_fit_launch(ubman): Args: fname -- The target file name within U-Boot build dir. + efi_file -- The source .efi application comp -- Flag to enable gzip compression. Return: The path of the created file. @@ -225,7 +264,7 @@ def test_efi_fit_launch(ubman): bin_path = make_fpath(fname) utils.run_and_log(ubman, - ['cp', make_fpath('lib/efi_loader/helloworld.efi'), + ['cp', make_fpath(f'lib/efi_loader/{efi_file}'), bin_path]) if comp: utils.run_and_log(ubman, ['gzip', '-f', bin_path]) @@ -264,6 +303,27 @@ def test_efi_fit_launch(ubman): dtb += '.gz' return dtb + def make_initrd(comp): + """Create a sample initrd. + + Creates an initrd. + + Args: + comp -- Flag to enable gzip compression. + Return: + The path of the created file. + """ + + # Generate a test initrd file. + initrd = make_fpath('test-efi-initrd') + with open(initrd, 'w', encoding='ascii') as file: + file.write('test-efi-initrd') + + if comp: + utils.run_and_log(ubman, ['gzip', '-f', initrd]) + initrd += '.gz' + return initrd + def make_fit(comp): """Create a sample FIT image. @@ -275,22 +335,35 @@ def test_efi_fit_launch(ubman): """ # Generate resources referenced by ITS. + hello_bin = os.path.basename(make_efi('test-efi-helloworld.efi', 'helloworld.efi', comp)) + dtbdump_bin = os.path.basename(make_efi('test-efi-dtbdump.efi', 'dtbdump.efi', comp)) + initrddump_bin = os.path.basename(make_efi('test-efi-initrddump.efi', 'initrddump.efi', comp)) + fdt_bin = os.path.basename(make_dtb('user', comp)) + initrd_fs = make_initrd(comp) + initrd_fs = os.path.basename(initrd_fs) + compression = 'gzip' if comp else 'none' + kernel_type = 'kernel' if comp else 'kernel_noload' + its_params = { 'sys-arch': sys_arch, - 'efi-bin': os.path.basename(make_efi('test-efi-fit-helloworld.efi', comp)), - 'kernel-type': 'kernel' if comp else 'kernel_noload', - 'efi-comp': 'gzip' if comp else 'none', - 'fdt-bin': os.path.basename(make_dtb('user', comp)), - 'fdt-comp': 'gzip' if comp else 'none', + 'hello-bin': hello_bin, + 'dtbdump-bin': dtbdump_bin, + 'initrddump-bin': initrddump_bin, + 'kernel-type': kernel_type, + 'efi-comp': compression, + 'fdt-bin': fdt_bin, + 'fdt-comp': compression, + 'initrd-fs': initrd_fs, + 'initrd-comp': compression, } # Generate a test ITS file. - its_path = make_fpath('test-efi-fit-helloworld.its') + its_path = make_fpath('test-efi-fit.its') with open(its_path, 'w', encoding='ascii') as file: file.write(ITS_DATA % its_params) # Build the test ITS. - fit_path = make_fpath('test-efi-fit-helloworld.fit') + fit_path = make_fpath('test-efi-fit.fit') utils.run_and_log( ubman, [make_fpath('tools/mkimage'), '-f', its_path, fit_path]) return fit_path @@ -357,7 +430,7 @@ def test_efi_fit_launch(ubman): return addr - def launch_efi(enable_fdt, enable_comp): + def launch_efi(enable_fdt, enable_initrd, enable_comp): """Launch U-Boot's helloworld.efi binary from a FIT image. An external image file can be downloaded from TFTP, when related @@ -372,19 +445,20 @@ def test_efi_fit_launch(ubman): from the host filesystem. Once the load address is available on U-Boot console, the 'bootm' - command is executed for either 'config-efi-fdt' or 'config-efi-nofdt' - FIT configuration, depending on the value of the 'enable_fdt' function - argument. + command is executed for either 'config-efi', 'config-efi-fdt' or + 'config-efi-initrd' FIT configuration, depending on the value of the + 'enable_fdt' and 'enable_initrd' function arguments. Eventually the 'Hello, world' message is expected in the U-Boot console. Args: enable_fdt -- Flag to enable using the FDT blob inside FIT image. + enable_initrd -- Flag to enable using an initrd inside FIT image. enable_comp -- Flag to enable GZIP compression on EFI and FDT generated content. """ - with ubman.log.section('FDT=%s;COMP=%s' % (enable_fdt, enable_comp)): + with ubman.log.section('FDT=%s;INITRD=%s;COMP=%s' % (enable_fdt, enable_initrd, enable_comp)): if is_sandbox: fit = { 'dn': ubman.config.build_dir, @@ -420,14 +494,28 @@ def test_efi_fit_launch(ubman): addr = load_fit_from_host(fit) if is_sandbox else load_fit_from_tftp(fit) # Select boot configuration. - fit_config = 'config-efi-fdt' if enable_fdt else 'config-efi-nofdt' + fit_config = 'config-efi' + fit_config = fit_config + '-fdt' if enable_fdt else fit_config + fit_config = fit_config + '-initrd' if enable_initrd else fit_config # Try booting. + ubman.run_command('setenv bootargs nocolor') output = ubman.run_command('bootm %x#%s' % (addr, fit_config)) + assert '## Application failed' not in output if enable_fdt: assert 'Booting using the fdt blob' in output - assert 'Hello, world' in output - assert '## Application failed' not in output + assert 'DTB Dump' in output + if enable_initrd: + assert 'Loading ramdisk' in output + assert 'INITRD Dump' in output + if enable_fdt: + response = ubman.run_command(cmd = 'dump', wait_for_echo=False) + assert 'EFI FIT FDT Boot Test' in response + if enable_initrd: + response = ubman.run_command('load', wait_for_echo=False) + assert f"crc32: 0x0c77b025" in response + if not enable_fdt and not enable_initrd: + assert 'Hello, world' in output ubman.restart_uboot() # Array slice removes leading/trailing quotes. @@ -449,16 +537,20 @@ def test_efi_fit_launch(ubman): ubman.config.dtb = control_dtb # Run tests - # - fdt OFF, gzip OFF - launch_efi(False, False) - # - fdt ON, gzip OFF - launch_efi(True, False) + # - fdt OFF, initrd OFF, gzip OFF + launch_efi(False, False, False) + # - fdt ON, initrd OFF, gzip OFF + launch_efi(True, False, False) + # - fdt OFF, initrd ON, gzip OFF + launch_efi(False, True, False) if is_sandbox: - # - fdt OFF, gzip ON - launch_efi(False, True) - # - fdt ON, gzip ON - launch_efi(True, True) + # - fdt OFF, initrd OFF, gzip ON + launch_efi(False, False, True) + # - fdt ON, initrd OFF, gzip ON + launch_efi(True, False, True) + # - fdt OFF, initrd ON, gzip ON + launch_efi(False, True, True) finally: if is_sandbox: