summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2024-08-26doc: Add a few notes about how to use console checkingSimon Glass
Tidy up the existing docs in line with current conventions. Signed-off-by: Simon Glass <[email protected]>
2024-08-26test: Rename UTF_CONSOLE_REC to UTF_CONSOLESimon Glass
The _REC suffix doesn't add much. Really what we want to know is whether the test uses the console, so rename this flag. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2024-08-26test: Drop the blank line before test macrosSimon Glass
Most tests don't have this. It helps to keep the test declaration clearly associated with the function it relates to, rather than the next one in the file. Remove the extra blank line and mention this in the docs. Signed-off-by: Simon Glass <[email protected]>
2024-08-26test: Rename unit-test flagsSimon Glass
The UT_TESTF_ macros read as 'unit test test flags' which is not right. Rename to UTF ('unit test flags'). This has the benefit of being shorter, which helps keep UNIT_TEST() declarations on a single line. Give the enum a name and reference it from the UNIT_TEST() macros while we are here. Signed-off-by: Simon Glass <[email protected]>
2024-08-26doc: Add some guidelines about global dataSimon Glass
Update the documentation to provide a bit more information about how to use global data. Signed-off-by: Simon Glass <[email protected]>
2024-08-26doc: Move generic-board documentation into rstSimon Glass
This information is useful for people looking at how U-Boot has changed over the years and the design decisions which led to it. Move it into doc/ in an 'historical' section. Signed-off-by: Simon Glass <[email protected]>
2024-08-24doc: document the pwm commandEmil Kronborg
Signed-off-by: Emil Kronborg <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-08-22Merge branch 'master' of ↵Tom Rini
https://source.denx.de/u-boot/custodians/u-boot-samsung into next
2024-08-19Merge tag 'v2024.10-rc3' into nextTom Rini
Prepare v2024.10-rc3
2024-08-19Prepare v2024.10-rc3v2024.10-rc3Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2024-08-19doc: samsung: Mention enabled eMMC in E850-96 board docSam Protsenko
eMMC is enabled on E850-96 board now. Mention that in the board documentation. Signed-off-by: Sam Protsenko <[email protected]> Signed-off-by: Minkyu Kang <[email protected]>
2024-08-19dt-bindings: exynos: Update bindings doc for DW MMC controllerSam Protsenko
Update the bindings doc for Exynos DW MMC block to follow the upstream example and reflect the latest changes made in corresponding Linux kernel bindings. Signed-off-by: Sam Protsenko <[email protected]> Signed-off-by: Minkyu Kang <[email protected]>
2024-08-15env: remove vars that are not in default envRavi Minnikanti
current env_set_default_vars() doesn't delete var that are not in the imported env. hashtable removes vars that are not in the imported env but present in the current env only if H_NOCLEAR flag is not set. This change is to avoid passing H_NOCLEAR flag if specific vars are passed to env_set_default_vars() Without this change: Marvell>> env default boot_mode Marvell>> With the change: Marvell>> env default boot_mode WARNING: 'boot_mode' not in imported env, deleting it! Signed-off-by: Ravi Minnikanti <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-08-15spi: soft_spi: Parse cs-gpios only if num-chipselects is not <0>Michael Polyntsov
Some boards don't have chipselect lines for leds so cs-gpios is not specified in the dts leading to probing error. Fix it by making behavior similar to the one in Linux, parse num-chipselects and if it is zero, ignore cs-gpios. Signed-off-by: Michael Polyntsov <[email protected]> Signed-off-by: Mikhail Kshevetskiy <[email protected]>
2024-08-13imx8ulp_evk: enable binman supportGary Bisson
Enable binman support and add documentation for the imx8ul-evk board. Signed-off-by: Gary Bisson <[email protected]>
2024-08-13i2c: Drop reference to SYS_I2C_INIT_BOARDSimon Glass
This is not now used by any boards, so drop it. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Heiko Schocher <[email protected]>
2024-08-12board: rockchip: Add Radxa ROCK 5 ITXHeiko Stuebner
The Rock 5 ITX is a board in ITX form factor using the RK3588 SoC It can be powered either by 12V, ATX power-supply or PoE. Notable peripherals are the 4 SATA ports, M.2 M-Key slot, M.2 E-key slot, 2*2.5Gb PCIe-connected Ethernet NICs. Display options are 2*HDMI, DP via USB-c, eDP + 2*DSI via PCB connectors. USB ports are 4*USB3 + 2*USB2 on the back panel and 2-port front-panel connector. Schematics for the board can be found on - https://dl.radxa.com/rock5/5itx/radxa_rock_5_itx_X1100_schematic.pdf - https://dl.radxa.com/rock5/5itx/v1110/radxa_rock_5itx_v1110_schematic.pdf The naming scheme with the dashes follows Dragan's comment on the mainline devicetree commit: "the name of this board deviates from the standard Radxa naming scheme, which is something like "ROCK <number><letter>" thus, "rock-5a" is fine, but it should be "rock-5-itx", simply because there's a space between "5" and "ITX" in "ROCK 5 ITX" Signed-off-by: Heiko Stuebner <[email protected]> Reviewed-by: Kever Yang <[email protected]> Signed-off-by: Kever Yang <[email protected]>
2024-08-09upl: Add initial documentationSimon Glass
Add some documentation to explain the basic concept along with a link to the full spec. Signed-off-by: Simon Glass <[email protected]>
2024-08-09upl: Add a commandSimon Glass
Add a 'upl' command to work with Universal Payload features. For now it only supports reading and writing a handoff structure. Signed-off-by: Simon Glass <[email protected]>
2024-08-09board: rockchip: Add FriendlyElec CM3588 NASJonas Karlman
The CM3588 NAS by FriendlyElec pairs the CM3588 compute module, based on the Rockchip RK3588 SoC, with the CM3588 NAS Kit carrier board. Features tested on a CM3588 NAS Kit with 8GB RAM 64GB eMMC module: - SD-card boot - eMMC boot - Ethernet - PCIe/NVMe - USB gadget - USB host Signed-off-by: Jonas Karlman <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2024-08-09board: rockchip: Add Xunlong Orange Pi 3BRicardo Pardini
The Xunlong Orange Pi 3B is a single-board computer based on the Rockchip RK3566 SoC. The two hw revisions use different io-voltage for Ethernet PHY and can be identified using GPIO4_C4: - v1.1.1: x (internal pull-down) - v2.1: PHY_RESET (external pull-up) Implement rk_board_late_init() to set correct fdtfile env var and board_fit_config_name_match() to load correct FIT config based on what board is detected at runtime so a single board target can be used for both hw revisions. Minimal DTs that includ DT from dts/upstream is added to support booting from both hw revision and only set Ethernet PHY io-voltage when the hw revision is detected at runtime. A side-affect of this is that defconfig show OF_UPSTREAM=n, however dts/upstream DTs is used for this board. Features tested on Orange Pi 3B 4GB (v1.1.1 and v2.1): - SD-card boot - eMMC boot - SPI Flash boot - Ethernet - PCIe/NVMe - USB host Signed-off-by: Ricardo Pardini <[email protected]> Co-developed-by: Jonas Karlman <[email protected]> Signed-off-by: Jonas Karlman <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2024-08-09board: rockchip: Add Radxa ZERO 3W/3EJonas Karlman
The Radxa ZERO 3W/3E is an ultra-small, high-performance single board computer based on the Rockchip RK3566, with a compact form factor and rich interfaces. Implement rk_board_late_init() to set correct fdtfile env var and board_fit_config_name_match() to load correct FIT config based on what board is detected at runtime so a single board target can be used for both board models. Features tested on a ZERO 3W 8GB v1.11: - SD-card boot - eMMC boot - USB gadget - USB host Features tested on a ZERO 3E 4GB v1.2: - SD-card boot - Ethernet - USB gadget - USB host Signed-off-by: Jonas Karlman <[email protected]> Tested-by: FUKAUMI Naoki <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2024-08-09board: rockchip: Add Radxa ROCK 3BJonas Karlman
The Radxa ROCK 3B is a single-board computer based on the Pico-ITX form factor (100mm x 75mm). Two versions of the ROCK 3B exists, a community version based on the RK3568 SoC and an industrial version based on the RK3568J SoC. Features tested on ROCK 3B 8GB v1.51 (both variants): - SD-card boot - eMMC boot - SPI Flash boot - Ethernet - PCIe/NVMe - USB gadget - USB host Signed-off-by: Jonas Karlman <[email protected]> Tested-by: FUKAUMI Naoki <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2024-08-09board: rockchip: add Radxa ROCK 3 Model CMaxim Moskalets
Based on rock-3a-rk3568_defconfig. Tested on v1.31 revision. Board Specifications: - Rockchip RK3566 - 1/2/4GB LPDDR4 2112MT/s - eMMC socket - uSD card slot - M.2 2230 Connector - GbE LAN with POE - 3.5mm jack with mic - HDMI 2.0, MIPI DSI/CSI - USB 3.0 Host, USB 2.0 Host/OTG - 40-pin GPIO expansion ports Signed-off-by: Maxim Moskalets <[email protected]> Suggested-by: Jonas Karlman <[email protected]> Reviewed-by: Jonas Karlman <[email protected]> Tested-by: FUKAUMI Naoki <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2024-08-09board: rockchip: Add Radxa ROCK S0Jonas Karlman
Radxa ROCK S0 is a single-board computer based on the Rockchip RK3308B SoC in an ultra-compact form factor. Add a board target for the board. Features tested on a ROCK S0 v1.2 with 512 MiB RAM and 8 GiB eMMC: - SD-card boot - eMMC boot - Ethernet - USB gadget - USB host Signed-off-by: Jonas Karlman <[email protected]> Reviewed-by: Kever Yang <[email protected]>
2024-08-08Merge patch series "Low Power Mode: Package TIFS Stub in BeaglePlay"Tom Rini
Dhruva Gole <[email protected]> says: This series aims to add documentation around the boot flow and tispl packaging details regarding the TIFS Stub. While at it, also refactors the k3 common docs to add more labels to provide more granularity on how we include chunks from common docs into SoC specific docs. This series also includes the binman related changes required to package TIFS Stub to support Low Power Modes on BeaglePlay and phycore-am625 SOM.
2024-08-08arm: dts: phycore-am62x: Package TIFS StubDhruva Gole
Add support for packaging the TIFS Stub as it's required for basic Low Power Modes like Deep Sleep. The reason it is packaged using binman and not inherently as part of the DM firmware is because for HS devices, customer owns the customer key and only customer has access to it. DM is release by TI, Since TI doesn't have access to the customer key it cannot have a component that is signed by customer key. Hence, it's left as part of binman to be signed and packaged. While at it, also make sure it's documented in phycore-am62x Reviewed-by: Nishanth Menon <[email protected]> Reviewed-by: Wadim Egorov <[email protected]> Signed-off-by: Dhruva Gole <[email protected]>
2024-08-08doc: beagle: am62x_beagleplay: Document the use of TIFS StubDhruva Gole
* Include the actual common documentation about the TIFS Stub and role it plays to enable Low Power Modes in the platform. * Add the AM62x boot flow to show at which point the TIFS Stub actually gets loaded. * Mention the TIFS Stub in the TISPL image format. Reviewed-by: Nishanth Menon <[email protected]> Signed-off-by: Dhruva Gole <[email protected]>
2024-08-08doc: ti: am62*: Mention TIFS Stub in img fmts and boot flowDhruva Gole
Since AM62x, AM62P and AM62A all use similar boot flows and their low power mode s/w ARCH is also similar in the way that they make use of the TIFS Stub, update their documentation to show where TIFS Stub is. Reviewed-by: Nishanth Menon <[email protected]> Signed-off-by: Dhruva Gole <[email protected]>
2024-08-08doc: board: ti: Update to use the new boot firmware labelsDhruva Gole
Use the new boot_firmwares labels that help make documentation more specific as to which firmwares are used in which devices Signed-off-by: Dhruva Gole <[email protected]>
2024-08-08doc: ti: k3: Add TIFS Stub documentationDhruva Gole
* Add documentation to briefly explain the role of TIFS Stub in relevant K3 SoC's. * Shed light on why TIFS Stub isn't package with the DM firmware itself. * Modify the platform docs wherever the TIFS Stub documentation applies. * Also, refactor and add a few new labels to help split the firmware documentation chunks. This will make it easier to include them one by one wherever applicable Reviewed-by: Nishanth Menon <[email protected]> Signed-off-by: Dhruva Gole <[email protected]> Acked-by: Francesco Dolcini <[email protected]> # verdin-am62
2024-08-05Prepare v2024.10-rc2v2024.10-rc2Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2024-08-05Merge patch series "Bug-fixes for a few boards"Tom Rini
Simon Glass <[email protected]> says: This series includes fixes to get some rockchip and nvidia boards working again. It also drops the broken Beaglebone Black config and provides a devicetree fix for coral (x86).
2024-08-05mkeficapsule: Add a --version argumentSimon Glass
Tools should have an option to obtain the version, so add this to the mkeficapsule tool. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Ilias Apalodimas <[email protected]>
2024-08-02doc: cmd: add documentation for cpu commandHou Zhiqiang
Add documentation for the 'cpu' command, taking NXP i.MX 8M Plus as a example. Signed-off-by: Hou Zhiqiang <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-07-31tools: Add script to update git subtree projectsRaymond Mao
Recently we are introducing multiple git subtree projects and it is the right time to have a universal script to update various subtrees and replace the dts/update-dts-subtree.sh. update-subtree.sh is a wrapper of git subtree commands. Usage: From U-Boot top directory, run $ ./tools/update-subtree.sh pull <subtree-name> <release-tag> for pulling a tag from the upstream. Or run $ ./tools/update-subtree.sh pick <subtree-name> <commit-id> for cherry-pick a commit from the upstream. Currently <subtree-name> supports dts, mbedtls and lwip. Signed-off-by: Raymond Mao <[email protected]>
2024-07-31doc: Add a description for bootmeth_androidMattijs Korpershoek
Add initial documentation for the Android bootmeth. Signed-off-by: Mattijs Korpershoek <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2024-07-29binman: fit: Allow running fdtgrep on devicetree blobsSimon Glass
When using FIT to load firmware builds for multiple models, the FIT must include a common binary along with a number of devicetree blobs, one for each model. This is the same mechanism as is used for loading an OS. However, SPL builds do not normally use the full devicetree, but instead a cut-down version which various nodes and properties removed. Add a new fit,fdt-phase property to allow binman to produce these devicetree blobs. Signed-off-by: Simon Glass <[email protected]>
2024-07-29qconfig: Allow searching for CONFIG valuesSimon Glass
Add basic support for searching for matching of non-matching values. Signed-off-by: Simon Glass <[email protected]> Fixes: https://source.denx.de/u-boot/custodians/u-boot-dm/-/issues/20
2024-07-22Prepare v2024.10-rc1v2024.10-rc1Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2024-07-20doc: define html_context in conf.pyHeinrich Schuchardt
The dictionary html_context is not passed into conf.py but must be created there. See https://dev.readthedocs.io/en/latest/design/theme-context.html#customizing-the-context Fixes: df86796028df ("doc: enable ReadTheDocs addon management") Reviewed-by: Simon Glass <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2024-07-19doc: Describe the bootstd settingsSimon Glass
The bootstd node provides some configuration properties. Add these to the documentation. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Quentin Schulz <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2024-07-19doc: Add a link to VBE from the bootstd docsSimon Glass
Link to this page to make it easier to find the VBE docs. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Quentin Schulz <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2024-07-19doc: Add a description for bootmeth_scriptSimon Glass
Add documentation for the script bootmeth. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Quentin Schulz <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2024-07-19doc: Add a description for bootmeth_sandboxSimon Glass
Add documentation for the sandbox bootmeth. Fix up the compatible string to drop the 'extlinux' part, which is not relevant to this bootmeth. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Quentin Schulz <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2024-07-19doc: Add a description for bootmeth_crosSimon Glass
Add documentation for the cros bootmeth. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Quentin Schulz <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2024-07-19doc: Add a description for bootmeth_qfwSimon Glass
Add documentation for the qfw bootmeth. Fix up the compatible string to drop the 'extlinux' part, which is not relevant to this bootmeth. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Quentin Schulz <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2024-07-19doc: Add a description for bootmeth_pxeSimon Glass
Add documentation for the pxe bootmeth. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Quentin Schulz <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2024-07-19doc: Add a description for bootmeth_extlinuxSimon Glass
Add documentation for the extlinux bootmeth. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Quentin Schulz <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2024-07-19doc: Mention automatic binding of bootmethsSimon Glass
Add a note about how bootmeth drivers are instantiated. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]> Suggested-by: Heinrich Schuchardt <[email protected]>