summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge tag 'ti-v2021.04-rc2' of ↵WIP/05Feb2021Tom Rini2021-02-051-13/+13
|\ | | | | | | | | | | | | | | | | https://gitlab.denx.de/u-boot/custodians/u-boot-ti - Sync DTS from Linux kernel for all K3 platforms - Add MMC higher speed nodes for AM65x, J721e, J7200 - Convert Nokia RX-51 to use CONFIG_DM_MMC - Minor fixes for LEGO MINDSTORMS
| * remoteproc: k3_r5: Sync to upstreamed kernel DT property namesSuman Anna2021-02-041-13/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The K3 R5F remoteproc driver in U-Boot was upstreamed prior to the equivalent remoteproc driver in the Linux kernel. Some of the DT properties used in U-Boot got upstreamed using different names in Linux kernel. The modified property names include the R5F cluster mode configuration property "lockstep-mode"; and three different individual R5F core config properties - "atcm-enable", "btcm-enable" and "loczrama". The property names were updated as follows: lockstep-mode => ti,cluster-mode atcm-enable => ti,atcm-enable btcm-enable => ti,btcm-enable loczrama => ti,loczrama Update the K3 R5F remoteproc driver, the corresponding binding, and all the existing usage in AM65x, J721E and J7200 dts files all at once to use the new properties and to not break any bisectability. Signed-off-by: Suman Anna <s-anna@ti.com>
* | Merge tag 'efi-2021-04-rc2' of ↵WIP/04Feb2021Tom Rini2021-02-044-8/+78
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | https://gitlab.denx.de/u-boot/custodians/u-boot-efi Pull request for UEFI sub-system for efi-2021-04-rc2 Bug fixes: * do not allow creating of files with filenames on FAT file system * install UEFI System Partition GUID on ESP handle * in dtbdump.efi test tool use GUID to find ESP handle Documentation: * man-page for load command * describe end of life of plat_auto
| * | doc: dm: describe end of life of plat_autoHeinrich Schuchardt2021-02-041-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | Describe when plat_auto is freed. Fix a typo. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
| * | doc: return value exception commandHeinrich Schuchardt2021-02-041-5/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | If the exception cannot be raised, the command returns. Currently the return values are not all the same. Remove the sub-chapter 'Return value' Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * | doc: describe load commandHeinrich Schuchardt2021-02-042-0/+75
| |/ | | | | | | | | | | | | Man-page for load command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* | dm: core: Add documentation about device removalSimon Glass2021-02-031-0/+20
|/ | | | | | | Make mention of this feature in the core documentation so people can discover it without looking at a header file. Signed-off-by: Simon Glass <sjg@chromium.org>
* Merge https://gitlab.denx.de/u-boot/custodians/u-boot-usbTom Rini2021-01-311-1/+29
|\ | | | | | | | | | | | | | | | | | | | | - Assorted gadget changes including: - dfu: Fix handling of UBI partitions in MTD backend - gadget: f_thor: fix wrong file size cast - Extend cmd: bcb - Fixes for fastboot and rockchip gadgets - dfu: Add SCRIPT and SKIP entities - dfu/thor: Add `dfu_alt_info` reinitialization from flashed script - u-boot: Reduce size of u-boot as usbd_device_* arrays are not exported
| * dfu: add 'SCRIPT' entityMarek Szyprowski2021-01-311-1/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | Define a new 'SCRIPT' type for DFU entities. The downloaded data are treated as simple u-boot's scripts and executed with run_command_list() function. Flashing the 'SCRIPT' entity might result in changing the 'dfu_alt_info' environment variable from the flashed script, so add a global variable for tracking the potential need to reinitialize the dfu_alt_info related structures. Signed-off-by: Marek Szyprowski <m.szyprowski@samsung.com>
| * dfu: add 'SKIP' entityJaehoon Chung2021-01-311-1/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Define a new 'SKIP' type for the DFU entities. The flashed data for that entity is simply ignored without returning any error values. This allows to have one flashing procedure and images for the different board types or variants, where each board uses only the images relevant to it and skips the rest. This is especially usefull for the THOR protocol, which usually transfers more than one file in a single session. Signed-off-by: Jaehoon Chung <jh80.chung@samsung.com> Reviewed-by: Minkyu Kang <mk7.kang@samsung.com> [mszyprow: rephrased commit message and docs for easier reading, changed subject to "dfu: add 'SKIP' entity"] Signed-off-by: Marek Szyprowski <m.szyprowski@samsung.com>
* | sandbox: keep time offset when resettingHeinrich Schuchardt2021-01-301-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The UEFI Self Certification Test (SCT) checks the SetTime() service with the following steps: * set date * reset * check date matches To be compliant the sandbox should keep the offset to the host RTC during resets. The implementation uses the environment variable UBOOT_SB_TIME_OFFSET to persist the offset. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* | doc/sandbox: improve formatting of command line optionsHeinrich Schuchardt2021-01-301-14/+14
|/ | | | | | | Show the command line options in bold. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: device-tree-bindings: rtc: Abracon AB x80x i2c rtcYing-Chun Liu (PaulLiu)2021-01-271-0/+31
| | | | | | Document the bindings for abracon,abx80x and related compatibles. Signed-off-by: Ying-Chun Liu (PaulLiu) <paul.liu@linaro.org>
* Merge https://gitlab.denx.de/u-boot/custodians/u-boot-marvellTom Rini2021-01-271-0/+11
|\ | | | | | | | | | | | | | | | | | | | | - Espressobin: Disable slot when emmc is not present (Pali) - DS414; config header cleanup (Phil) - PCI: auto-config enhancement (Phil) - pci_mvebu: Also map IO region (Phil) - serial: a3720: Implement pending method for output direction (Pali) - turris_mox: Enable a few commands (Marek) - helios4 & ClearFog changes (Dennis) - Plus some minor misc changes
| * ARM: Distro boot: document the need for fdtfile variable to be setDennis Gilmore2021-01-271-0/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | When testing builds provided in https://github.com/openwrt/openwrt/pull/3360 I discovered that fdtfile was not set and as a result the firmware was not functional. So I am documenting what is needed. Signed-off-by: Dennis Gilmore <dennis@ausil.us> Cc: Atish Patra <atish.patra@wdc.com> Cc: Lukas Auer <lukas.auer@aisec.fraunhofer.de> Cc: Tom Rini <trini@konsulko.com> Cc: Masahiro Yamada <yamada.masahiro@socionext.com> Cc: Vagrant Cascadian <vagrant@debian.org> Cc: Stephen Warren <swarren@nvidia.com> Cc: Karsten Merker <merker@debian.org>
* | Merge tag 'doc-2021-04-rc1-3' of ↵Tom Rini2021-01-2719-68/+1254
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | https://gitlab.denx.de/u-boot/custodians/u-boot-efi Pull request for documentation tag doc-2021-04-rc1-3 Update the build system for the HTML documentation to allow using Sphinx 3. Man-page for exception command.
| * | doc: exception commandHeinrich Schuchardt2021-01-272-0/+69
| | | | | | | | | | | | | | | | | | Create man-page for exception command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * | doc: update Kernel documentation build systemHeinrich Schuchardt2021-01-2713-40/+1142
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Update the documentation build system according to Linux v5.11-rc1. Deactive the automarkup.py extension module which on Gitlab CI is incompatible with Unicode. With this patch we can build the HTML documentation using either of Sphinx 2 and Sphinx 3. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * | doc: fix doc/develop/logging.rstHeinrich Schuchardt2021-01-273-10/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sphinx 3 builds fail due to doc/develop/logging.rst producing duplicate labels. Include logging.h only once in the API section and use cross-references for the enums log_level_t and log_category_t. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * | doc: board: fix Microchip MPFS Icicle Kit docHeinrich Schuchardt2021-01-271-18/+33
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Two sibling headings (here eMMC) cannot have the same title. Warning, treated as error: doc/board/microchip/mpfs_icicle.rst:423:duplicate label board/microchip/mpfs_icicle:emmc, other instance in doc/board/microchip/mpfs_icicle.rst make[1]: *** [doc/Makefile:69: htmldocs] Error 2 * Correct the heading levels. * Add missing empty lines after headings. Fixes: 9e550e18305f ("doc: board: Add Microchip MPFS Icicle Kit doc") Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* | cmd: pxe: add support for FDT overlaysWIP/2021-01-27-assorted-net-updatesNeil Armstrong2021-01-271-0/+9
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This adds support for specifying FDT overlays in an extlinux/pxelinux configuration file. Without this, there is no simple way to apply overlays when the kernel and fdt is loaded by the pxe command. This change adds the 'fdtoverlays' keyword for a label, supporting multiple overlay files to be applied on top of the fdt specified in the 'fdt' or 'devicetree' keyword. Example: label linux kernel /Image fdt /soc-board.dtb fdtoverlays /soc-board-function.dtbo append console=ttyS0,115200 root=/dev/mmcblk0p2 rootwait This code makes usage of a new variable called fdtoverlay_addr_r used to load the overlay files without overwritting anything important. Cc: Tom Rini <trini@konsulko.com> Cc: Andre Heider <a.heider@gmail.com> Cc: Jernej Škrabec <jernej.skrabec@siol.net> Cc: Jonas Karlman <jonas@kwiboo.se> Tested-by: Jernej Škrabec <jernej.skrabec@siol.net> Reviewed-by: Jernej Škrabec <jernej.skrabec@siol.net> Signed-off-by: Neil Armstrong <narmstrong@baylibre.com>
* Merge tag 'doc-2021-04-rc1-2' of ↵Tom Rini2021-01-259-0/+404
|\ | | | | | | | | | | | | | | | | | | https://gitlab.denx.de/u-boot/custodians/u-boot-efi Pull request for documentation tag doc-2021-04-rc1 (2) * Man-pages for sbi, exit, for, echo, loady, true, false, conitrace * Adjust suppression of newline in echo command. * Provide unit test for echo command.
| * doc: describe command conitraceHeinrich Schuchardt2021-01-252-0/+55
| | | | | | | | | | | | Provide a man-page for the conitrace command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * doc: describe the false commandHeinrich Schuchardt2021-01-252-0/+29
| | | | | | | | | | | | Provide a man-page for the false command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * doc: document true commandHeinrich Schuchardt2021-01-252-0/+29
| | | | | | | | | | | | Create a man-page for the true command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * doc: describe loady commandHeinrich Schuchardt2021-01-252-0/+68
| | | | | | | | | | | | Create a man-page for the loady command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * doc: document echo commandHeinrich Schuchardt2021-01-252-0/+66
| | | | | | | | | | | | | | Provide a man-page for the echo command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
| * doc: document for statementHeinrich Schuchardt2021-01-252-0/+66
| | | | | | | | | | | | Create a man-page for the for statement. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * doc: describe exit commandHeinrich Schuchardt2021-01-252-0/+41
| | | | | | | | | | | | Man-page for exit shell command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * doc: document sbi commandHeinrich Schuchardt2021-01-252-0/+50
| | | | | | | | | | | | Add a man-page for the sbi command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* | Merge tag 'u-boot-atmel-2021.04-b' of ↵Tom Rini2021-01-251-0/+2
|\ \ | |/ |/| | | | | | | | | | | | | | | | | | | https://gitlab.denx.de/u-boot/custodians/u-boot-atmel Second set of u-boot-atmel features for 2021.04 cycle This feature set includes macb updates for all interfaces and new sama7g5 variant support; micrel ksz9031 DLL support; a new board from Giant based on Adafruit feather form factor which contains a SAMA5D27 SoC; several fixes regarding the NAND flash PMECC block; and pincontrol drive strength support for pio4 controller.
| * dt-bindings: pinctrl: at91-pio4: add property for drive strengthEugen Hristev2021-01-221-0/+2
| | | | | | | | | | | | Add drive strength property which is equivalent with the one in Linux Signed-off-by: Eugen Hristev <eugen.hristev@microchip.com>
* | Revert "doc: update Kernel documentation build system"Tom Rini2021-01-2314-1146/+44
| | | | | | | | | | | | | | | | | | | | Unfortunately we now see a number of now-fatal warnings about duplicate labels. It is often unclear how best to re-write the document in question to not duplicate these otherwise logical headings. This reverts commit 10a1df3cd43ba2fe893d5dd1aeb2e7109ef0007f. Signed-off-by: Tom Rini <trini@konsulko.com>
* | doc: move README.menu to HTML documentationHeinrich Schuchardt2021-01-233-124/+132
| | | | | | | | | | | | | | Convert README.menu to reStructured text and add it to the HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* | doc: move test/py/README.md to HTML documentationHeinrich Schuchardt2021-01-232-0/+427
| | | | | | | | | | | | | | | | Convert test/py/README.md to restructured text and add it to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* | doc: move test/README to HTML documentationHeinrich Schuchardt2021-01-232-0/+97
| | | | | | | | | | | | | | Move test/README to the 'Develop U-Boot' chapter of the HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* | doc: structure doc/develop/index.rstHeinrich Schuchardt2021-01-231-3/+19
| | | | | | | | | | | | | | Provide sub-chapters for 'Develop U-Boot' Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* | doc: update help messagePatrick Delaunay2021-01-231-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | Update the help message used for 'make help': Documentation targets: Linux kernel internal documentation in different formats from ReST: => U-Boot documentation in different formats from ReST: Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
* | doc: update Kernel documentation build systemHeinrich Schuchardt2021-01-2314-44/+1146
| | | | | | | | | | | | | | | | | | | | | | | | Update the docomentation build system according to Linux v5.11-rc1. With this patch we can build the HTML documentation using either of Sphinx 2 and Sphinx 3. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org> [Fix warning in b4860qds.rst about "Switch Settings"] Signed-off-by: Tom Rini <trini@konsulko.com>
* | doc: FIT image: Clarify format and simplify syntaxAlexandru Gagniuc2021-01-221-19/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ** Introduction There are currently four ways to load an OS image with u-boot 1. SPL -> u-boot -> bootm 2. SPL blue falcon mode 3. "Basic" FIT image (CONFIG_LOAD_FIT) 4. "Full-featured" FIT image (CONFIG_LOAD_FIT_FULL) These four code paths were developed independently, and share very little code. (3) and (4), behave very differently, are littered with special cases. They even have different DTS syntax and properties. The cause of this divergence is that the FIT format specification leaves a number of things open to interpretation. The purpose of this change is to enable the reduction of code size, duplication, and complexity by updating and streamlining the FIT format. We are only marginally concerned with backwards compatibility, because we don't have inter-compatibility. For example, CONFIG_LOAD_FIT is able to load images that CONFIG_LOAD_FIT_FULL won't. This is a direct result of the incompatible syntax between the two implementations. Ideally, these changes would enable "simple" FIT to be a subset of the "full" fit implementation, and share most code. These changes should also eliminate the need for falcon mode (although we are not advocating for the removal of falcon mode at this time). ** Description of changes * The "configurations" node is now mandatory Guessing how to load components based on their "os" and "type" invites confusion and superfluous heuristics. Instead, require each FIT image to be explicit on how components should be loaded. * Eliminate "ramdisk", "setup", "standalone", and "fpga" properties Having too many special purpose properties requires special-casing FIT loading code. When a special property can be handled by another property, it is redundant. - A "ramdisk" is identical to a loadable. Thus ramdisk images should be placed under "loadables". - A "setup" node can be achieved by using a "kernel" or "firmware" property instead. - "standalone" is used for u-boot nodes. The correct property to use in this case is "firmware". - "fpga" is a loadable * Prioritize control between "firmware" and "kernel" "firmware" and "kernel" are special nodes in that control is passed to the "entry-point" of the image. Both can be present, for example, an OP-TEE firmware with a linux kernel. When both are present, control is passed to the "firmware" image. ** Further generalizations (not included herein) The "firmware" and "kernel" properties could be generalized as a "next-boot-stage", or similar name. This "next" stage would be special in that it is both executable, and is the stage that is passed control. For example, "next-stage" could be an op-tee image, with linux as a loadable, or a u-boot image. Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
* | doc: board: freescale: advise to use newer atf and firmwareAndrey Zhizhikin2021-01-184-24/+24
|/ | | | | | | | | | | | | | | Update branch and version information of ATF and DDR firmware files to point to latest releases provided by NXP. This is especially critical for imx8mp evk, as the ATF support for that SoC is only available in latest releases. Align all SoCs from imx8m family to use identical revisions of ATF and DDR firmware. Signed-off-by: Andrey Zhizhikin <andrey.zhizhikin@leica-geosystems.com> Reviewed-by: Fabio Estevam <festevam@gmail.com> Reviewed-by: Peng Fan <peng.fan@nxp.com>
* Merge https://gitlab.denx.de/u-boot/custodians/u-boot-riscvWIP/18Jan2021Tom Rini2021-01-185-49/+1088
|\ | | | | | | | | | | | | | | - Update qemu-riscv.rst build instructions. - Add support for SPI on Kendryte K210. - Add Microchip PolarFire SoC Icicle Kit support. - Add support for an early timer. - Select TIMER_EARLY to avoid infinite recursion for Trace.
| * doc: board: Add Microchip MPFS Icicle Kit docPadmarao Begari2021-01-183-0/+820
| | | | | | | | | | | | | | | | | | This doc describes the procedure to build, flash and boot Linux using U-boot on Microchip MPFS Icicle Kit. Signed-off-by: Padmarao Begari <padmarao.begari@microchip.com> Reviewed-by: Anup Patel <anup.patel@wdc.com> Reviewed-by: Bin Meng <bin.meng@windriver.com>
| * riscv: Add support for SPI on Kendryte K210Sean Anderson2021-01-181-48/+267
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This enables configs necessary for using SPI. The environment is saved to the very end of SPI flash. This is unlikely to be overwritten unless the entire flash is reprogrammed. This also supplies a default bootcommand. It loads an image and device tree from the first partition of the MMC. This is a minimal/least effort bootcmd, so suggestions (especially in the form of patches) are welcome. I didn't set up distro boot because I think it is unlikely that any general-purpose linux distros will ever be ported to this board. Signed-off-by: Sean Anderson <seanga2@gmail.com> Tested-by: Chrstopher Obbard <obbardc@gmail.com> Reviewed-by: Rick Chen <rick@andestech.com>
| * doc: qemu-riscv: Fix opensbi build instructionsAtish Patra2021-01-181-1/+1
| | | | | | | | | | | | | | | | | | Latest opensbi uses generic platform for Qemu. Update the build instructions. Signed-off-by: Atish Patra <atish.patra@wdc.com> Reviewed-by: Bin Meng <bin.meng@windriver.com> Reviewed-by: Rick Chen <rick@andestech.com>
* | Merge tag 'doc-2021-04-rc1' of ↵Tom Rini2021-01-187-125/+183
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | https://gitlab.denx.de/u-boot/custodians/u-boot-efi Pull request for documentation tag doc-2021-04-rc1 * document man-page base command * move README.fdt-overlays to HTML documentation * add synopsis for pstore command
| * | doc: sifive: fu540: fix heading levelsHeinrich Schuchardt2021-01-161-8/+11
| | | | | | | | | | | | | | | | | | Two sibling headings cannot have the same name. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * | doc: move README.fdt-overlays to HTML documentationHeinrich Schuchardt2021-01-163-114/+136
| | | | | | | | | | | | | | | | | | | | | | | | Convert doc/README.fdt-overlays to doc/usage/fdt_overlays.rst. Edit the text for readability. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * | doc: board: fix README.b4860qdsHeinrich Schuchardt2021-01-161-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | Two sibling headings can never be the same. Fix the heading levels. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
| * | doc: add synopsis for pstore commandHeinrich Schuchardt2021-01-161-1/+10
| | | | | | | | | | | | | | | | | | | | | | | | Add a synopsis section. Use lower case for command name. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
View Lorry Controller Status