summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2025-05-11doc: pytest: Document the test_bootstage testTom Rini
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2025-05-11doc: pytest: Document the test_net testTom Rini
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2025-05-11doc: pytest: Document the test_net_boot testTom Rini
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2025-05-11doc: pytest: Framework for documenting tests and document test_000_versionTom Rini
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2025-05-11doc: Start improving our pytest documentationTom Rini
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2025-05-11doc: describe u-boot-test-releaseHeinrich Schuchardt
The scripts u-boot-test-release is called at the end of testing. Describe it. Reviewed-by: Mattijs Korpershoek <[email protected]> Reviewed-by: Simon Glass <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-05-11doc: u-boot-test-reset: mention power cyclingHeinrich Schuchardt
Using power cycling is a valid option to implement u-boot-test-reset. Reviewed-by: Mattijs Korpershoek <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-05-09Dockerfile: use lz4 instead of lz4-toolsHeinrich Schuchardt
Since Ubuntu Jammy lz4-tools is only a virtual package which pulls in lz4 as dependency. Update documentation too. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2025-05-09disable mail for swarrenStephen Warren
I haven't been involved in U-Boot development for quite a while, so CCing me on patches isn't currently useful. Add a .mailmap entry that I believe will turn off patch CCs. This can always be removed if I become active again! Remove myself from a few MAINTAINERS failed and the git mailrc file too.
2025-05-08Merge branch 'staging' of https://source.denx.de/u-boot/custodians/u-boot-tegraTom Rini
2025-05-08ARM: tegra: convert boards to use TEGRA_PRAMSvyatoslav Ryhel
Switch boards that use CFG_PRAM to TEGRA_PRAM. Signed-off-by: Svyatoslav Ryhel <[email protected]>
2025-05-08board: lg: star: add Optimus 2X P990 supportSvyatoslav Ryhel
The LG Optimus 2X is a touchscreen-based, slate-sized smartphone designed and manufactured by LG that runs the Android operating system. The Optimus 2X features a 4" WVGA display, an Nvidia Tegra 2 dual-core chip, 512 MB of RAM and extendable 8 GB of internal storage. UART-B is default debug port. Tested-by: Ion Agorria <[email protected]> Signed-off-by: Svyatoslav Ryhel <[email protected]>
2025-05-08board: rockchip: Add LCKFB TaishanPi RK3566 BoardJiehui He
The LCKFB TaishanPi is a single-board computer based on the RK3566 SoC. Specification: - 1/2 Gib RAM - Optinal EMMC - SD-Card - HDMI / MIPI CSI / MIPI DSI - USB 2.0 Host (Type-A) - USB 2.0 Host / OTG (Type-C) - No Ethernet This patch adds U-Boot support for the LCKFB TaishanPi RK3566 board, including: - U-Boot device tree - Default defconfig - Board documentation - MAINTAINERS entry Changes in v2: - Removed unused configs from `lckfb-tspi-rk3566_defconfig` - Reordered TaishanPi entry in `doc/board/rockchip/rockchip.rst` alphabetically Link to v1: https://lore.kernel.org/u-boot/[email protected]/ Signed-off-by: Jiehui He <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2025-05-08board: rockchip: add Xunlong Orange Pi 5 MaxIlya Katsnelson
The 5 Max is another board in the Orange Pi 5 family. It's overall similar to the 5 Plus, but in a smaller form factor, which leads to some I/O being reshuffled, but nothing relevant to u-boot. So, just reuse the config for the 5 Plus and adjust the DT names. Reviewed-by: Jonas Karlman <[email protected]> Signed-off-by: Ilya Katsnelson <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2025-05-03imx95_evk: add i.MX95 19x19 EVK board basic supportYe Li
This patch adds i.MX95 19x19 EVK board basic support. Messaging unit for EdgeLock Secure Enclave, messaging unit for System Manager, uSDHC for SD Card, gpio, lpuart are supported now. Signed-off-by: Ye Li <[email protected]> Signed-off-by: Alice Guo <[email protected]> Reviewed-by: Peng Fan <[email protected]>
2025-05-03doc: imx: add document for i.MX95 Image Container FormatAlice Guo
This patch add a document for i.MX95 Image Container Format. Signed-off-by: Alice Guo <[email protected]>
2025-05-02Merge patch series "board: beagle: beagley-ai: Cleanups and stdboot"Tom Rini
Nishanth Menon <[email protected]> says: Just happened to get a BeagleY-AI at desk and happened to test master branch (7dd49a9264a6 drivers: scsi: Add 'erase' support), noticed a few issues which were rather easy to solve.. so, here we go: Link: https://lore.kernel.org/r/[email protected]
2025-05-02doc: beagle: Add BeagleY-AI documentationNishanth Menon
Document the BeagleY-AI usage, build and basic debug hints Reviewed-by: Udit Kumar <[email protected]> Signed-off-by: Nishanth Menon <[email protected]> Reviewed-by: Bryan Brattlof <[email protected]> Reviewed-by: Andrew Davis <[email protected]>
2025-05-01doc: ti: k3: add language for code-block directiveAnshul Dalal
The code-block directive supports the optional language property which enables syntax highlighting for the block[1]. This patch adds the relevant language property for code-blocks in k3 docs. [1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block Signed-off-by: Anshul Dalal <[email protected]>
2025-05-01doc: ti: update bash code-block directives to promptAnshul Dalal
The code-block directive requires addition of the prompt symbol for each line, using the prompt directive instead allows for auto insertion of the symbol per line[1]. For the readers, the character added by the prompt directive is un-selectable i.e the entire line can be more easily selected for copy pasting etc. Whereas with code-block, the prompt symbol like "$" is also selectable which is usually not the intent. This is mostly a QoL addition + making the docs consistent since k3.rst makes use of prompt directives which these board docs include from. [1]: https://pypi.org/project/sphinx-prompt/ Signed-off-by: Anshul Dalal <[email protected]>
2025-04-28Prepare v2025.07-rc1v2025.07-rc1Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2025-04-28Merge tag 'u-boot-imx-master-20250428' of ↵Tom Rini
https://gitlab.denx.de/u-boot/custodians/u-boot-imx CI: https://source.denx.de/u-boot/custodians/u-boot-imx/-/pipelines/25974 - Fix power-domain ref counting regression. - Fix i.MX8MP USB clock regression. - Fix i.MX8MM osc_32k regression in SPL. - Finish converting clock-osc-24 back to osc_24 on i.MX. - Several imx8mp capricorn updates. - Update Stefano Babic's email address. - Fix fsl_qspi bug by moving AHB read buffer config after LUT. - Fix verdin imx95 sku 0089 pid4.
2025-04-25Merge branch 'master' of https://source.denx.de/u-boot/custodians/u-boot-riscvTom Rini
CI: https://source.denx.de/u-boot/custodians/u-boot-riscv/-/pipelines/25940 - riscv: lib: Simplify FDT retrieving process - board: k1: pinctrl: Add pinctrl support for bananapi-f3 - binman: riscv: Fix binman_sym functionality - board: starfive: visionfive2: Reorder board detection logic - board: starfive: Add DeepComputing FML13V01 support
2025-04-25doc: jh7110: describe debug UARTHeinrich Schuchardt
Provide the settings for using the debug UART in SPL. Reviewed-by: E Shattow <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-04-25doc: starfive: use jh7110_common.rstHeinrich Schuchardt
To avoid duplicate maintenance just include jh7110_common.rst to describe the usage of the different boot sources. Reviewed-by: E Shattow <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-04-25doc: starfive: use consistent formattingHeinrich Schuchardt
Always use ---- for the H2 level. Reviewed-by: E Shattow <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-04-25doc: add DeepComputing FML13V01 documentationHeinrich Schuchardt
Describe building U-Boot for the board and booting. Carve out common information for JH7110 boards into an include. Reviewed-by: E Shattow <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2025-04-25doc: fix typo 'to'Aristo Chen
Fix typo from "to" to "do" Signed-off-by: Aristo Chen <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2025-04-25doc: fix typo commnadAristo Chen
fix typo from "commnad" to "command" Signed-off-by: Aristo Chen <[email protected]>
2025-04-25doc: arch: arm64: fix typosAristo Chen
Fix typo from "recommened" to "recommended" Signed-off-by: Aristo Chen <[email protected]>
2025-04-25doc: remove duplicated "commands"Aristo Chen
The "commands" are duplicated, so remove one of them Signed-off-by: Aristo Chen <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2025-04-25MAINTAINERS: Update email of Stefano BabicStefano Babic
Replace my old e-mail with the current one to get still involved in the project. Signed-off-by: Stefano Babic <[email protected]>
2025-04-25doc: board: starfive: visionfive2: add missing format command to FlashingE Shattow
Signed-off-by: E Shattow <[email protected]> Reviewed-by: Leo Yu-Chi Liang <[email protected]>
2025-04-25doc: jh7110: describe debug UARTHeinrich Schuchardt
Provide the settings for using the debug UART in SPL. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: E Shattow <[email protected]>
2025-04-25doc: starfive: use jh7110_common.rstHeinrich Schuchardt
To avoid duplicate maintenance just include jh7110_common.rst to describe the usage of the different boot sources. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: E Shattow <[email protected]>
2025-04-25doc: starfive: use consistent formattingHeinrich Schuchardt
Always use ---- for the H2 level. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: E Shattow <[email protected]>
2025-04-25doc: add DeepComputing FML13V01 documentationHeinrich Schuchardt
Describe building U-Boot for the board and booting. Carve out common information for JH7110 boards into an include. Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: E Shattow <[email protected]>
2025-04-24python: Use and refer to the venv module rather than virtualenvTom Rini
Using some form of sandbox with Python modules is a long standing best practice with the language. There are a number of ways to have a Python sandbox be created. At this point in time, it seems the Python community is moving towards using the "venv" module provided with Python rather than a separate tool. To match that we make the following changes: - Refer to a "Python sandbox" rather than virtualenv in comments, etc. - Install the python3-venv module in our container and not virtualenv. - In our CI files, invoke "python -m venv" rather than "virtualenv". - In documentation, tell users to install python3-venv and not virtualenv. Signed-off-by: Tom Rini <[email protected]>
2025-04-23Merge patch series "Uthreads"Tom Rini
Jerome Forissier <[email protected]> says: This series introduces threads and uses them to improve the performance of the USB bus scanning code and to implement background jobs in the shell via two new commands: 'spawn' and 'wait'. The threading framework is called 'uthread' and is inspired from the barebox threads [2]. setjmp() and longjmp() are used to save and restore contexts, as well as a non-standard extension called initjmp(). This new function is added in several patches, one for each architecture that supports HAVE_SETJMP. A new symbol is defined: HAVE_INITJMP. Two tests, one for initjmp() and one for the uthread scheduling, are added to the lib suite. After introducing threads and making schedule() and udelay() a thread re-scheduling point, the USB stack initialization is modified to benefit from concurrency when UTHREAD is enabled, where uthreads are used in usb_init() to initialize and scan multiple busses at the same time. The code was tested on arm64 and arm QEMU with 4 simulated XHCI buses and some devices. On this platform the USB scan takes 2.2 s instead of 5.6 s. Tested on i.MX93 EVK with two USB hubs, one ethernet adapter and one webcam on each, "usb start" takes 2.4 s instead of 4.6 s. Finally, the spawn and wait commands are introduced, allowing the use of threads from the shell. Tested on the i.MX93 EVK with a spinning HDD connected to USB1 and the network connected to ENET1. The USB plus DHCP init sequence "spawn usb start; spawn dhcp; wait" takes 4.5 seconds instead of 8 seconds for "usb start; dhcp". [1] https://patchwork.ozlabs.org/project/uboot/list/?series=446674 [2] https://github.com/barebox/barebox/blob/master/common/bthread.c Link: https://lore.kernel.org/r/[email protected]
2025-04-23test: lib: add uthread testJerome Forissier
Add a thread framework test to the lib tests. Update the API documentation to use the test as an example. Signed-off-by: Jerome Forissier <[email protected]> Acked-by: Ilias Apalodimas <[email protected]>
2025-04-23uthread: add cooperative multi-tasking interfaceJerome Forissier
Add a new internal API called uthread (Kconfig symbol: UTHREAD) which provides cooperative multi-tasking. The goal is to be able to improve the performance of some parts of U-Boot by overlapping lengthy operations, and also implement background jobs in the U-Boot shell. Each uthread has its own stack allocated on the heap. The default stack size is defined by the UTHREAD_STACK_SIZE symbol and is used when uthread_create() receives zero for the stack_sz argument. The implementation is based on context-switching via initjmp()/setjmp()/ longjmp() and is inspired from barebox threads [1]. A notion of thread group helps with dependencies, such as when a thread needs to block until a number of other threads have returned. The name "uthread" comes from "user-space threads" because the scheduling happens with no help from a higher privileged mode, contrary to more complex models where kernel threads are defined. But the 'u' may as well stand for 'U-Boot' since the bootloader may actually be running at any privilege level and the notion of user vs. kernel may not make much sense in this context. [1] https://github.com/barebox/barebox/blob/master/common/bthread.c Signed-off-by: Jerome Forissier <[email protected]> Reviewed-by: Ilias Apalodimas <[email protected]>
2025-04-23test: lib: add initjmp() testJerome Forissier
Test the initjmp() function when HAVE_INITJMP is set. Use the test as an example in the API documentation. Signed-off-by: Jerome Forissier <[email protected]> Reviewed-by: Ilias Apalodimas <[email protected]>
2025-04-23arch: introduce initjmp() and Kconfig symbol HAVE_INITJMPJerome Forissier
Add the HAVE_INIJMP symbol to be set by architectures that support initjmp(), a non-standard extension to setjmp()/longjmp() allowing to initialize a jump buffer with a function pointer and a stack pointer. This will be useful to later introduce threads. With this new function it becomes possible to longjmp() to a particular function pointer (rather than to a point previously reached during program execution as is the case with setjmp()), and with a custom stack. Both things are needed to spin off a new thread. Then the usual setjmp()/longjmp() pair is enough to save and restore a context, i.e., switch thread. Add the initjmp() prototype to <include/setjmp.h> since it is common to all architectures. Add an entry to the API documentation: doc/api/setjmp.rst. Signed-off-by: Jerome Forissier <[email protected]> Reviewed-by: Ilias Apalodimas <[email protected]>
2025-04-23board: rockchip: Add minimal generic RK3399 boardJonas Karlman
Add a minimal generic RK3399 board that only have eMMC, SDMMC, SPI flash and USB OTG enabled. This defconfig can be used to boot from eMMC, SD-card or SPI flash on most RK3399 boards that follow reference board design. Signed-off-by: Jonas Karlman <[email protected]> Reviewed-by: Christopher Obbard <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2025-04-23board: rockchip: Add minimal generic RK3328 boardJonas Karlman
Add a minimal generic RK3328 board that only have eMMC, SDMMC, SPI flash and USB OTG enabled. This defconfig can be used to boot from eMMC, SD-card or SPI flash on most RK3328 boards that follow reference board design. Signed-off-by: Jonas Karlman <[email protected]> Reviewed-by: Christopher Obbard <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2025-04-23rockchip: rk3576: Add support for ROC-RK3576-PC boardHeiko Stuebner
The ROC-RK3576-PC is a SBC made by Firefly, designed around the RK3576 SoC. This adds the needed board infrastructure and config for it. Signed-off-by: Heiko Stuebner <[email protected]> Reviewed-by: Jonas Karlman <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2025-04-23arm: rockchip: Add RK3576 arch core supportXuhui Lin
The Rockchip RK3576 is a ARM-based SoC with quad-core Cortex-A72 and quad-core Cortex-A53 including 6TOPS NPU, Mali-G52 MC3, HDMI Out, DP, eDP, MIPI DSI, MIPI CSI2, LPDDR4/4X/5, eMMC5.1, SD3.0/MMC4.5, UFS, USB OTG 3.0, Type-C, USB 2.0, PCIe 2.1, SATA 3, Ethernet, SDIO3.0, I2C, UART, SPI, GPIO and PWM. Add arch core support for it. Signed-off-by: Xuhui Lin <[email protected]> [adapted for mainline u-boot] Signed-off-by: Heiko Stuebner <[email protected]> Reviewed-by: Jonas Karlman <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2025-04-23board: rockchip: Add Radxa E20CJonas Karlman
The Radxa E20C is an ultra-compact network computer with a RK3528A SoC that offers a wide range of networking capabilities. Features tested on a Radxa E20C v1.104: - SD-card boot - eMMC boot Signed-off-by: Jonas Karlman <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2025-04-23board: rockchip: Add minimal generic RK3528 boardJonas Karlman
Add a minimal generic RK3528 board that only have eMMC and SD-card enabled. This defconfig can be used to boot from eMMC or SD-card on most RK3528 boards that follow reference board design. Signed-off-by: Jonas Karlman <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2025-04-19doc: dt_qemu: correct dumpdtb descriptionHeinrich Schuchardt
Use only a single -machine parameter. Describe that the same invocation of qemu-system-<arch> has to be used for dumping the device-tree as will be used when executing U-Boot. Signed-off-by: Heinrich Schuchardt <[email protected]>