summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2023-09-05nokia_rx51: Remove platformTom Rini3-260/+0
This platform is behind on migrations (it is the sole user of the oldest legacy version of the USB gadget stack and is long overdue for migration) and with Pali no longer being a maintainer, we remove this platform. Signed-off-by: Tom Rini <trini@konsulko.com>
2023-09-04Prepare v2023.10-rc4Tom Rini1-1/+1
Signed-off-by: Tom Rini <trini@konsulko.com>
2023-09-02doc: Add gpt command documentationJoshua Watt2-0/+185
Adds initial documentation for the gpt command Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
2023-09-02doc: board: toradex: verdin-am62: document update u-boot wrapperMarcel Ziswiler1-0/+14
Now with the update U-Boot wrappers having been sorted out, document their usage. Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>
2023-09-02doc: board: toradex: minor documentation updateMarcel Ziswiler6-46/+71
- Update SPDX-License-Identifier from obsolete GPL-2.0+ to GPL-2.0-or-later. - Add links to product websites of SoM and carrier board where missing. - Add information about update U-Boot wrapper where missing. - Add sectionauthor where missing. - Update information about imx-seco from version 3.7.4 to 3.8.1. - Various minor grammatic and spelling fixes. - Improve whitespace by adding or removing new lines. - Change from code-block for output to just Output::. Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>
2023-09-02doc: add events.h to documentationHeinrich Schuchardt2-0/+10
Add the events.h include to the API documentation. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-08-28bootstd: Adjust the default bootmeth orderSimon Glass1-1/+7
The existing distro scripts check extlinux and scripts before EFI. Adjust the default ordering to do the same, to avoid breaking existing flows. Add some documentation, mentioning that this order will likely change in future. Signed-off-by: Simon Glass <sjg@chromium.org> Reported-by: Da Xue <da@libre.computer>
2023-08-27doc: describe TPL/VPL/SPL bootHeinrich Schuchardt2-0/+322
This is a stub describing how TPL, VPL, and SPL load the next boot stages on a detail level for users. For sure we will need a few patches on top to catch the whole complexity. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Paul Barker <paul.barker.ct@bp.renesas.com>
2023-08-27doc: board: ti: k3: Convert to sphinx-promptNishanth Menon1-55/+57
Sphinx-prompt provides a handy scheme to provide documentation that renders nicely and yet provides a scheme to copy paste for users without having to hand-edit the copied text as is the result of code-block [1] https://lore.kernel.org/all/87fs48rgto.fsf@baylibre.com/ Reported-by: Simon Glass <sjg@chromium.org> Suggested-by: Mattijs Korpershoek <mkorpershoek@baylibre.com> Signed-off-by: Nishanth Menon <nm@ti.com> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-27doc: sphinx: Add sphinx-promptNishanth Menon2-1/+2
Sphinx-prompt[1] helps bring-in '.. prompt::' option that allows a better rendered documentation, yet be able to copy paste without picking up the prompt from rendered documentation. [1] https://lore.kernel.org/all/87fs48rgto.fsf@baylibre.com/ Suggested-by: Mattijs Korpershoek <mkorpershoek@baylibre.com> Signed-off-by: Nishanth Menon <nm@ti.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-27doc: board: sdm845: Explicitly add boot.img flashing commandSumit Garg1-3/+8
Signed-off-by: Sumit Garg <sumit.garg@linaro.org> Use code-block. Fix length of two heading underlines. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-23doc: Highlight the most relevant u-boot talksPaul Barker1-3/+12
The list of u-boot talks on elinux.org is quite long, so let's highlight the talks which are likely most relevant for newcomers. Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-08-23doc: Explicitly list build dependencies for docsPaul Barker1-0/+11
Highlight the packages which need to be installed in order to build the docs. Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com>
2023-08-23Documentation extended with specific information for VirtualBoxThomas Mittelstaedt1-0/+84
The configuration for EFI is enhanced to start U-Boot at VirtualBox (x86_64) with all features like booting with help of boot scripts and extended linux. This documentation describes how to use U-Boot at VirtualBox to boot Linux systems with a some simple example. Signed-off-by: Thomas Mittelstaedt <thomas.mittelstaedt@de.bosch.com>
2023-08-23doc: board: ti: k3: Fix up OpenOCD references and debug infoJonathan Humphreys1-3/+3
Fix minor path and config macro name updates to sync with latest OpenOCD and U-Boot configurations. Fixes: effe50854a69 ("doc: board: ti: k3: Add a guide to debugging with OpenOCD") Signed-off-by: Jonathan Humphreys <j-humphreys@ti.com> Signed-off-by: Nishanth Menon <nm@ti.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-23doc: board: ti: k3: Elaborate on various firmwareNishanth Menon1-1/+20
Add elaboration text for the various firmware involved for system management. Signed-off-by: Nishanth Menon <nm@ti.com>
2023-08-23doc: board: ti: j721e: Fix build step numberingNishanth Menon1-8/+8
Fix up build step numbering. Fixes: c727b81d6530 ("doc: board: ti: k3: Reuse build instructions") Signed-off-by: Nishanth Menon <nm@ti.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-23doc: board: ti: j7200: Fix build step numberingNishanth Menon1-8/+8
Fix up build step numbering. Fixes: c727b81d6530 ("doc: board: ti: k3: Reuse build instructions") Signed-off-by: Nishanth Menon <nm@ti.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-23doc: board: ti: am65x: Fix build step numberingNishanth Menon1-6/+6
Fix up build step numbering. Fixes: c727b81d6530 ("doc: board: ti: k3: Reuse build instructions") Signed-off-by: Nishanth Menon <nm@ti.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-23doc: board: ti: am62x: Fix build step numberingNishanth Menon1-2/+2
Fix up build step numbering. Fixes: c727b81d6530 ("doc: board: ti: k3: Reuse build instructions") Signed-off-by: Nishanth Menon <nm@ti.com> Revieed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-23doc: board: ti: j721e: provide image alt textNishanth Menon1-0/+5
Provide alternative text for image. Fixes: 3b83dff183b5 ("doc: board: ti: j721e: Convert the image format to svg") Reported-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Signed-off-by: Nishanth Menon <nm@ti.com>
2023-08-23doc: board: ti: j7200: provide image alt textNishanth Menon1-2/+5
Provide alternative text for image. Fixes: f4ade09a1e76 ("doc: board: ti: j7200: Convert the image format to svg") Reported-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Signed-off-by: Nishanth Menon <nm@ti.com>
2023-08-23doc: board: ti: am65x: provide image alt textHeinrich Schuchardt1-0/+6
Provide alternative text for image. Fixes: fd358121bdb8 ("doc: board: ti: am65x: Update with boot flow diagram") Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Signed-off-by: Nishanth Menon <nm@ti.com>
2023-08-23doc: board: ti: am62x: provide image alt textsHeinrich Schuchardt1-0/+3
Provide alternative texts for images. Fixes: 34f76921d801 ("doc: board: ti: am62x: Convert the image format to svg") Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Signed-off-by: Nishanth Menon <nm@ti.com>
2023-08-23doc: board: ti: k3: Fixup alt text for openocd sequenceNishanth Menon1-0/+1
Fix up OpenOCD setup sequence Fixes: effe50854a69 ("doc: board: ti: k3: Add a guide to debugging with OpenOCD") Reported-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Signed-off-by: Nishanth Menon <nm@ti.com>
2023-08-23doc: board: ti: k3: image alt textsHeinrich Schuchardt1-0/+3
Provide alternative texts for images. Fixes: 6e8fa0611f19 ("board: ti: k3: Convert boot flow ascii flow to svg") Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Signed-off-by: Nishanth Menon <nm@ti.com>
2023-08-21Prepare v2023.10-rc3Tom Rini1-1/+1
Signed-off-by: Tom Rini <trini@konsulko.com>
2023-08-19doc: csf_examples: csf.sh: Remove unneeded export ATF_LOAD_ADDR lineFabio Estevam1-1/+0
Originally, exporting the ATF_LOAD_ADDR was required, but since binman has been used to generate the flash.bin, it is no longer needed to do such manual export. The ATF address is now passed via binman. Remove the unneeded export ATF_LOAD_ADDR line. Signed-off-by: Fabio Estevam <festevam@denx.de>
2023-08-19doc: printf() codes: Fix format specifier for unsigned intSiddharth Vadapalli1-3/+3
The format specifier for the "unsigned int" variable is documented as "%d". However, it should be "%u". Thus, fix it. Fixes: f5e9035043fb ("doc: printf() codes") Reported-by: Tom Rini <trini@konsulko.com> Signed-off-by: Siddharth Vadapalli <s-vadapalli@ti.com> Reviewed-by: Tom Rini <trini@konsulko.com> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-19docs: fix wrong usage of proftoolPuhan Zhou1-3/+3
The usage of proftool in docs is incorrect. If proftool is used without '-o' argument, it will show the usage like following $ ./sandbox/tools/proftool -m sandbox/System.map -t trace -f funcgraph dump-ftrace >trace.dat Must provide trace data, System.map file and output file Usage: proftool [-cmtv] <cmd> <profdata> Change '>' to '-o' to fix it. Signed-off-by: Puhan Zhou <puh4n.zhou@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-08-18rockchip: rk3566-anbernic-rgxx3: Rename defconfig to include SoC nameJonas Karlman1-1/+1
Rename defconfig to include SoC name, use similar pattern as other RK356x boards: <soc>-<name>.dts -> <name>-<soc>_defconfig Suggested-by: Kever Yang <kever.yang@rock-chips.com> Signed-off-by: Jonas Karlman <jonas@kwiboo.se> Reviewed-by: Kever Yang <kever.yang@rock-chips.com>
2023-08-18Merge tag 'tegra-for-2023.10-rc1' of ↵Tom Rini8-0/+423
https://source.denx.de/u-boot/custodians/u-boot-tegra ARM: tegra: Changes for v2023.10-rc1 This adds support for various new Tegra30 boards (ASUS, LG and HTC) and has some other minor enhancements, such as enabling the poweroff command on several Tegra210 and Tegra186 boards.
2023-08-17doc: rockchip: Add supported RK3566/RK3568 boardsJonas Karlman1-8/+12
Update Rockchip documentation to include RK3566/RK3568 boards already supported. Also list Pine64 boards under RK3566 and drop defconfig to match other listed boards. Signed-off-by: Jonas Karlman <jonas@kwiboo.se>
2023-08-17CI: x86: coreboot: Update to latest corebootSimon Glass1-0/+20
Use a recent coreboot build for this test. The coreboot commit is: 6f5ead14b4 mb/google/nissa/var/joxer: Update eMMC DLL settings This is build with default settings, i.e. QEMU x86 i440fx/piix4 Add some documentation as to how to update it next time. Signed-off-by: Simon Glass <sjg@chromium.org>
2023-08-17arm_ffa: use debug logsAbdellatif El Khlifi1-1/+1
replace info logs with debug logs Signed-off-by: Abdellatif El Khlifi <abdellatif.elkhlifi@arm.com> Cc: Tom Rini <trini@konsulko.com> Cc: Simon Glass <sjg@chromium.org> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-08-15doc: add partition API to HTML documentationHeinrich Schuchardt2-0/+7
* Convert comments in part.h to Sphinx style. * Create documentation page for the partition API. * Add the partition API page to the API index page. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-08-15doc/sphinx/requirements.txt: Bump certifi upTom Rini1-1/+1
Upgrade certifi to the latest version, to remove e-Tugra from the root store. Link: https://groups.google.com/a/mozilla.org/g/dev-security-policy/c/C-HrP1SEq1A?pli=1 Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Simon Glass <sjg@chromium.org> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2023-08-12rockchip: rk3568: Add EmbedFire Lubancat 2 supportAndy Yan1-0/+1
LubanCat2 is a rk3568 based SBC from EmbedFire. Specification: - Rockchip rk3568 - LPDDR4/4X 1/2/4/8 GB - TF scard slot - eMMC 8/32/64/128 GB - Gigabit ethernet x 2 - HDMI out - USB 2.0 Host x 1 - USB 2.0 Type-C OTG x 1 - USB 3.0 Host x 1 - Mini PCIE interface for WIFI/BT module - M.2 key for 2280 NVME - 40 pin header The dts file is sync from linux mainline. Signed-off-by: Andy Yan <andyshrk@163.com> Reviewed-by: Kever Yang <kever.yang@rock-chips.com>
2023-08-09Merge tag 'x86-pull-20230809' of ↵Tom Rini4-7/+127
https://source.denx.de/u-boot/custodians/u-boot-x86 - x86: Fixes for distro booting - x86: Move some boards to text environment
2023-08-09env: Explain how to use #include files in text environmentSimon Glass1-0/+6
Provide documentation on how to share common settings among boards. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> # Intel Edison Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2023-08-09doc: Explain how to avoid the distro-boot scriptsSimon Glass1-1/+1
Now that standard boot is available, mention this in the environment documentation. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com> # Intel Edison Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2023-08-09x86: Update qemu documentationSimon Glass1-4/+84
Add some hints and observations related to booting distros on QEMU on x86. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2023-08-09x86: coreboot: Update doc for CBFS accessSimon Glass1-0/+34
Add an example to show how cbfs is used. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com> [Removed CONFIG_CMD_CBFS from defconfig files] Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2023-08-09bootstd: Rename bootdev_setup_sibling_blk()Simon Glass1-2/+2
This name is a little confusing since it suggests that it sets up the sibling block device. In fact it sets up a bootdev for it. Rename the function to make this clearer. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
2023-08-09doc: Begin adding a best practices document for board portsTom Rini2-0/+27
To help guide developers down the right path, begin a document that lists some best practices to follow when creating a new board port. Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2023-08-09doc: imx8mp_evk: Use in-tree build in the exampleFabio Estevam1-7/+9
To make it consistent with the instructions from other NXP imx8m boards, such as imx8mm-evk and imx8mn-evk, use U-Boot in-tree build in the examples. Signed-off-by: Fabio Estevam <festevam@denx.de> Reviewed-by: Peng Fan <peng.fan@nxp.com>
2023-08-09doc: imx8mp_evk: Remove unneeded export ATF_LOAD_ADDR lineFabio Estevam1-1/+0
Originally, exporting the ATF_LOAD_ADDR was required, but since binman has been used to generate the flash.bin, it is no longer needed to do such manual export. The ATF address is now passed via binman in imx8mp-u-boot.dtsi: atf { description = "ARM Trusted Firmware"; type = "firmware"; arch = "arm64"; compression = "none"; load = <0x970000>; entry = <0x970000>; atf_blob: atf-blob { filename = "bl31.bin"; type = "atf-bl31"; }; }; Remove the unneeded export ATF_LOAD_ADDR line. Signed-off-by: Fabio Estevam <festevam@denx.de> Reviewed-by: Peng Fan <peng.fan@nxp.com>
2023-08-09doc: ti: Explain how the various gadget devices can be usedMiquel Raynal1-0/+62
Describe the current situation wrt the handling of USB devices on AM33xx based boards, taking the example of a common board (the Beagle Bone Black) and explaining how the different USB gadgets can be used. Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
2023-08-09doc: board: toradex: fix verdin module outputMarcel Ziswiler3-115/+127
Fix the Verdin module output which was missing white space for correct rendering. While at it also leave product links, add section author also for the Verdin iMX8M Mini and Plus, and add a missing CROSS_COMPILE export for the Verdin iMX8M Mini. Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com> Reviewed-by: Nishanth Menon <nm@ti.com> #verdin-am62 Reviewed-by: Tom Rini <trini@konsulko.com>
2023-08-09doc: Add the link for the documentation of the .itsJit Loon Lim1-0/+3
Provide the link for the .its related documentation for Arria10. Signed-off-by: Jit Loon Lim <jit.loon.lim@intel.com>
generated by cgit v1.2.3 (git 2.39.0) at 2024-09-29 16:19:12 +0300