summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* version: Remove global macro U_BOOT_VERSION_STRING from version.hPali Rohár2021-09-171-9/+12
| | | | | | | | | | Version string is available in global variable char version_string[]. Macro U_BOOT_VERSION_STRING is not used by any other file, so remove it completely from version.h. Other files were already converted to use variable version_string[]. Signed-off-by: Pali Rohár <pali@kernel.org> Reviewed-by: Tom Rini <trini@konsulko.com>
* dtoc: Further improve documentation about warningsSimon Glass2021-09-161-4/+88
| | | | | | Split this information into subsections and expand it. Signed-off-by: Simon Glass <sjg@chromium.org>
* Merge tag 'v2021.10-rc4' into nextTom Rini2021-09-169-24/+120
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Prepare v2021.10-rc4 Signed-off-by: Tom Rini <trini@konsulko.com> # gpg: Signature made Tue 14 Sep 2021 06:58:32 PM EDT # gpg: using RSA key 1A3C7F70E08FAB1707809BBF147C39FF9634B72C # gpg: Good signature from "Thomas Rini <trini@konsulko.com>" [ultimate] # Conflicts: # board/Arcturus/ucp1020/spl.c # cmd/mvebu/Kconfig # common/Kconfig.boot # common/image-fit.c # configs/UCP1020_defconfig # configs/sifive_unmatched_defconfig # drivers/pci/Kconfig # include/configs/UCP1020.h # include/configs/sifive-unmatched.h # lib/Makefile # scripts/config_whitelist.txt
| * Merge tag 'mmc-2021-9-13' of https://source.denx.de/u-boot/custodians/u-boot-mmcTom Rini2021-09-131-2/+47
| |\ | | | | | | | | | | | | | | | | | | | | | Support using mmc command for enumerating mmc card in a given mode Fix device_remove in mmc Fix switch issue with send_status disabled Drop 1ms delay in fsl_esdhc command sending Revert "mmc: sdhci: set to INT_DATA_END when there are data"
| | * doc: usage: mmc: Document usage of speed mode in "mmc dev" and "mmc rescan"Aswath Govindraju2021-09-101-2/+47
| | | | | | | | | | | | | | | | | | | | | Add documentation on the usage of "mmc dev" and "mmc rescan" commands to set user defined speed modes. Signed-off-by: Aswath Govindraju <a-govindraju@ti.com>
| * | Merge tag 'efi-2021-10-rc4-2' of ↵WIP/12Sep2021Tom Rini2021-09-126-20/+72
| |\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | https://source.denx.de/u-boot/custodians/u-boot-efi Pull request for efi-2021-10-rc4-2 Documentation: * improve documentation of U-Boot for /config DT node * integrate bloblist documentation UEFI: * correct usage of EFI_CALL() * code tidy up
| | * | doc: Complete the list of available runtime-config optionsSimon Glass2021-09-111-0/+45
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The current list is missing a few items. Add them. Reviewed-by: Marcel Ziswiler <marcel.ziswiler@toradex.com> Signed-off-by: Simon Glass <sjg@chromium.org> Acked-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| | * | doc: Tidy up the bindings for the config/ nodeSimon Glass2021-09-111-20/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Sort these and add a type so it is clear how to set the value. Add a note about usage to the top. Correct the 'no-keyboard' binding which is missing a prefix. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Marcel Ziswiler <marcel.ziswiler@toradex.com> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| | * | bloblist: Move to rST formatSimon Glass2021-09-112-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Move this documentation to the new format. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
| | * | doc: board: toradex: fix file namesOleksandr Suvorov2021-09-113-2/+2
| | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fix the documentation file names: s/apalix/apalis/. Fixes: e98ea49a0e ("toradex: MAINTAINERS: entries for new reST docs") Fixes: 3730106cf0 ("doc: board: apalis-imx8x: add documentation") Signed-off-by: Oleksandr Suvorov <oleksandr.suvorov@foundries.io> Reviewed-by: Igor Opaniuk <igor.opaniuk@foundries.io> Acked-by: Francesco Dolcini <francesco.dolcini@toradex.com> Acked-by: Marcel Ziswiler <marcel.ziswiler@toradex.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * | MAINTAINERS: Update ARM TI entryLokesh Vutla2021-09-091-1/+1
| |/ | | | | | | | | | | | | | | | | | | Move TI maintainership to Tom. Updated with the following commands: find ./ -name MAINTAINERS | xargs sed -i s/"Lokesh Vutla <lokeshvutla@ti.com>"/"Tom Rini <trini@konsulko.com>"/g Signed-off-by: Lokesh Vutla <lokeshvutla@ti.com> Reviewed-by: Nishanth Menon <nm@ti.com> Acked-by: Tom Rini <trini@konsulko.com>
| * doc: Remove information about CAPSULE_FMP_HEADERMichal Simek2021-09-031-1/+0
| | | | | | | | | | | | | | | | | | This Kconfig symbol was never added to U-Boot but it was mentioned in the origin commit c35df7c9e43e ("qemu: arm64: Add documentation for capsule update"). That's why remove it from documentation to be accurate. Signed-off-by: Michal Simek <michal.simek@xilinx.com> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* | net: Rename SPL_NET_SUPPORT to SPL_NETSimon Glass2021-09-041-1/+1
| | | | | | | | | | | | Rename this option so that CONFIG_IS_ENABLED can be used with it. Signed-off-by: Simon Glass <sjg@chromium.org>
* | spi: Rename SPI_SUPPORT to SPISimon Glass2021-09-041-1/+1
| | | | | | | | | | | | Rename these options so that CONFIG_IS_ENABLED can be used with them. Signed-off-by: Simon Glass <sjg@chromium.org>
* | serial: Rename SERIAL_SUPPORT to SERIALSimon Glass2021-09-041-1/+1
| | | | | | | | | | | | Rename these options so that CONFIG_IS_ENABLED can be used with them. Signed-off-by: Simon Glass <sjg@chromium.org>
* | mmc: Rename MMC_SUPPORT to MMCSimon Glass2021-09-041-1/+1
| | | | | | | | | | | | | | | | | | Rename these options so that CONFIG_IS_ENABLED can be used with them. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Jaehoon Chung <jh80.chung@samsung.com> [trini: Fixup some incorrect renames] Signed-off-by: Tom Rini <trini@konsulko.com>
* | Revert most of the series for adding vexpress_aemv8r supportWIP/03Sep2021-nextTom Rini2021-09-035-70/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Per a request from Andre Przywara and agreed with by Peter Hoyes, the vexpress aemv8r support wasn't quite ready to be merged, but the discussion had moved off list. We should keep the first patch in the series for now, but revert the rest. This reverts the following commits: e0bd6f31ce41 doc: Add documentation for the Arm vexpress board configs 30e5a449e8c7 arm: Use armv8_switch_to_el1 env to switch to EL1 b53bbca63bf4 vexpress64: Add BASER_FVP vexpress board variant 2f5b7b74903f armv8: Add ARMv8 MPU configuration logic 37a757e227cc armv8: Ensure EL1&0 VMSA is enabled Signed-off-by: Tom Rini <trini@konsulko.com>
* | doc: Add documentation for the Arm vexpress board configsPeter Hoyes2021-09-024-1/+69
| | | | | | | | | | | | | | | | | | | | Create a new documentation section for Arm Ltd boards with a sub-page for the vexpress board (FVP-A, FVP-R and Juno). Document how the armv8_switch_to_el1 environment variable can be used to switch between booting from S-EL2/S-EL1 at runtime on the BASER_FVP. Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com>
* | vexpress64: Add BASER_FVP vexpress board variantPeter Hoyes2021-09-021-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The BASER_FVP board variant is implemented on top of the BASE_FVP board config (which, in turn, is based on the Juno Versatile Express board config). They all share a similar memory map - for BASER_FVP the map is inverted from the BASE_FVP (https://developer.arm.com/documentation/100964/1114/Base-Platform/Base---memory/BaseR-Platform-memory-map) * Create new TARGET_VEXPRESS64_BASER_FVP target, which uses the same board config as BASE_FVP and JUNO * Adapt vexpress_aemv8a.h header file to support BASER_FVP (and rename to vexpress_aemv8.h) * Enable config to switch to EL1 for the BASER_FVP * Create vexpress_aemv8r defconfig * Provide an MPU memory map for the BASER_FVP For now, only single core boot is supported. Signed-off-by: Peter Hoyes <Peter.Hoyes@arm.com> [trini: Add MAINTAINERS, move BOOTCOMMAND to defconfig] Signed-off-by: Tom Rini <trini@konsulko.com>
* | board: stemmy: Update documentationStephan Gerhold2021-09-013-0/+91
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Over the time, the "stemmy" U-Boot board was tested on several other Samsung smartphones based on ST-Ericsson NovaThor Ux500. Convert the documentation to reStructuredText at doc/board/ste/stemmy.rst and make the device list complete. Also note that the board now boots into USB Fastboot instead of just ending up at the U-Boot prompt. The device table is mostly taken from the postmarketOS wiki article (https://wiki.postmarketos.org/wiki/ST-Ericsson_NovaThor_U8500). All the newly added devices were tested by Linus Walleij. Signed-off-by: Stephan Gerhold <stephan@gerhold.net>
* | scripts/checkpatch.pl: Resync with v5.13Tom Rini2021-09-012-0/+756
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This resyncs us with the version found in v5.13 of the Linux kernel with the following exceptions: - Keep our u-boot specific tests / code area. - Change the location of checkpatch.rst (which we now import) - Drop the "use strscpy" test as we don't have that, but do have strlcpy and want that used now. - Keep debug/printf in the list for $logFunctions And note that we now also include the spdxcheck.py tool that checkpatch.pl supports calling out to, and include upstream's checkpatch.rst in our develop section of the documentation. Signed-off-by: Tom Rini <trini@konsulko.com>
* | Merge branch 'next' of ↵WIP/31Aug2021-nextTom Rini2021-08-311-0/+19
|\ \ | | | | | | | | | | | | | | | https://gitlab.denx.de/u-boot/custodians/u-boot-marvell into next - Handling all DM watchdogs in watchdog_reset() (Rasmus)
| * | watchdog: add gpio watchdog driverRasmus Villemoes2021-08-311-0/+19
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A rather common kind of external watchdog circuit is one that is kept alive by toggling a gpio. Add a driver for handling such a watchdog. The corresponding linux driver apparently has support for some watchdog circuits which can be disabled by tri-stating the gpio, but I have never actually encountered such a chip in the wild; the whole point of adding an external watchdog is usually that it is not in any way under software control. For forward-compatibility, and to make DT describe the hardware, the current driver only supports devices that have the always-running property. I went a little back and forth on whether I should fail ->probe or only ->start, and ended up deciding ->start was the right place. The compatible string is probably a little odd as it has nothing to do with linux per se - however, I chose that to make .dts snippets reusable between device trees used with U-Boot and linux, and this is the (only) compatible string that linux' corresponding driver and DT binding accepts. I have asked whether one should/could add "wdt-gpio" to that binding, but the answer was no: https://lore.kernel.org/lkml/CAL_JsqKEGaFpiFV_oAtE+S_bnHkg4qry+bhx2EDs=NSbVf_giA@mail.gmail.com/ If someone feels strongly about this, I can certainly remove the "linux," part from the string - it probably wouldn't the only place where one can't reuse a DT snippet as-is between linux and U-Boot. Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Stefan Roese <sr@denx.de> Signed-off-by: Rasmus Villemoes <rasmus.villemoes@prevas.dk>
* | Convert CONFIG_SKIP_LOWLEVEL_INIT et al to KconfigTom Rini2021-08-311-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | This converts the following to Kconfig: CONFIG_SKIP_LOWLEVEL_INIT CONFIG_SKIP_LOWLEVEL_INIT_ONLY In order to do this, we need to introduce SPL and TPL variants of these options so that we can clearly disable these options only in SPL in some cases, and both instances in other cases. Signed-off-by: Tom Rini <trini@konsulko.com>
* | qfw: Switch to CONFIG_SYS_LOAD_ADDR from CONFIG_LOADADDRTom Rini2021-08-311-1/+1
|/ | | | | | | | | | | | | All platforms define CONFIG_SYS_LOAD_ADDR, but only some define CONFIG_LOADADDR. Very very rarely are these not the same address, and qemu-ppce500 is one such case. However, based on reading the history of the code, this mismatched value was simply a copy-paste from other PowerPC platforms where it is this unused currently. Switch the code to use CONFIG_SYS_LOAD_ADDR and update the documentation. Cc: Bin Meng <bmeng.cn@gmail.com> Signed-off-by: Tom Rini <trini@konsulko.com> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
* Merge tag 'efi-2021-10-rc3' of ↵WIP/23Aug2021Tom Rini2021-08-2319-33/+5
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | https://source.denx.de/u-boot/custodians/u-boot-efi Pull request for efi-2021-10-rc3 Documentation: * Rename Freescale to NXP * Document structures used for the UEFI TCG2 protocol UEFI: * Device paths must use EfiBootServicesData
| * doc: move doc/board/st/st.rstHeinrich Schuchardt2021-08-172-1/+1
| | | | | | | | | | | | | | 'make htmldocs' does not use file doc/board/st/st.rst because the name matches the directory name. Let's rename it to st-dt.rst. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * doc: rename Freescale to NXPHeinrich Schuchardt2021-08-1714-3/+3
| | | | | | | | | | | | Freescale Semiconductor, Inc. was merged into NXP Semiconductors in 2015. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * doc: move i.MX7D/i.MX8MM A/B booting to board specificHeinrich Schuchardt2021-08-175-29/+1
| | | | | | | | | | | | | | | | | | Having "i.MX7D/i.MX8MM SRC_GPR10 PERSIST_SECONDARY_BOOT for bootloader A/B switching" at the top level of the documentation tree does not make sense. Move it to board specific information. Fixes: 59e3d1bd4992 ("doc: imx: psb: Document usage of SRC_GPR10 PERSIST_SECONDARY_BOOT for A/B switching") Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* | bootcount: add a new driver with syscon as backendNandor Han2021-08-221-0/+24
|/ | | | | | | | The driver will use a syscon regmap as backend and supports both 16 and 32 size value. The value will be stored in the CPU's endianness. Signed-off-by: Nandor Han <nandor.han@vaisala.com> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: st: stm32mp1: Add FIP support for trusted bootPatrick Delaunay2021-08-161-96/+232
| | | | | | | | | | | | | TF-A for STM32MP15 now supports the FIP: it is a packaging format which includes the secure monitor, u-boot-nodtb.bin and u-boot.dtb This FIP file is loaded by FSBL = TF-A BL2. This patch updates the board documentation to use this FIP file and no more u-boot.stm32 (with STM32 image header) which is no more generated. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Reviewed-by: Patrice Chotard <patrice.chotard@foss.st.com>
* doc: stm32mp1: add page for device tree bindingsPatrick Delaunay2021-08-1413-893/+69
| | | | | | | | | | | | | | | With device tree binding migration to yaml it is difficult to synchronize the binding from Linux kernel to U-Boot. Instead of maintaining the same dt bindings, this patch adds in the U-Boot documentation the path to the device tree bindings in Linux kernel for STMicroelectronics devices, when they are used without modification. Signed-off-by: Patrick Delaunay <patrick.delaunay@foss.st.com> Signed-off-by: Patrice Chotard <patrice.chotard@foss.st.com> Add links for referenced text files. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Add a note about why devicetree is usedSimon Glass2021-08-142-0/+42
| | | | | | | | This question comes up every now and then with people coming from Linux. Add some notes about it so we can point to it in the mailing list. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Update devicedocs including how to add tweaksSimon Glass2021-08-141-81/+100
| | | | | | | | | | | This file is about 10 years old and the updates have not covered everything that has changed, particularly in the last few years. Update the information and add mention of the u-boot.dtsi files. Signed-off-by: Simon Glass <sjg@chromium.org> Fix typos. Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Move devicetree control doc to rSTSimon Glass2021-08-144-25/+43
| | | | | | | | | | | Move this to rST format, largely unchanged to start with. Add an index for this topic, as well as an empty intro. Note this patch does not include updates! Is it just a conversion to the new format. See the next patch. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchart <xypron.glpk@gmx.de>
* doc: fix Latex marginsHeinrich Schuchardt2021-08-141-12/+19
| | | | | | | | | Adjust the Latex formatting to match Linux v5.13.1: * add Latex margins * reformat the code in doc/conf.py to match Linux Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: require Sphinx 2.4.4Heinrich Schuchardt2021-08-142-98/+5
| | | | | | | Require Sphinx 2.44 to build the documentation. Remove all code related to earlier versions. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: add pkg-config to the build dependenciesHeinrich Schuchardt2021-08-141-2/+2
| | | | | | tools/Makefile uses pkg-config. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: x86: Update SeaBIOS build instructionsBin Meng2021-08-131-13/+8
| | | | | | | | | Update SeaBIOS build instructions using exact command that involves "make olddefconfig", and mention SeaBIOS release 1.14.0 has been used for testing. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
* Merge tag 'u-boot-imx-20210809' of ↵Tom Rini2021-08-091-19/+8
|\ | | | | | | | | | | | | | | | | | | | | | | | | https://source.denx.de/u-boot/custodians/u-boot-imx u-boot-imx-20210809 - new SOC: add support for imx8ulp - Toradex fixes for colibri (vf / imx6 / imx7 / imx8x) - convert to DM for mx28evk - Fixes for Gateworks ventana boards CI: https://source.denx.de/u-boot/custodians/u-boot-imx/-/pipelines/8639
| * board: colibri-imx8x: update building documentationOleksandr Suvorov2021-08-091-19/+8
| | | | | | | | | | | | | | Update the documentation on how to build the u-boot image for Colibri iMX8QXP, adding support of V1.0D revision of the module. Signed-off-by: Oleksandr Suvorov <oleksandr.suvorov@toradex.com>
* | pci: Drop migration methodSimon Glass2021-08-061-9/+0
| | | | | | | | | | | | Migration is complete. Drop the message. Signed-off-by: Simon Glass <sjg@chromium.org>
* | ppc: Drop t4qds and b4860qds referencesSimon Glass2021-08-062-454/+0
|/ | | | | | These boards have been removed. Drop the config file and other references. Signed-off-by: Simon Glass <sjg@chromium.org>
* doc: Add basic information about running CI testsTom Rini2021-08-042-0/+71
| | | | | | | Start out by documenting general expectations on when CI is run, how anyone can run Azure pipelines, and how GitLab CI pipelines can be run. Signed-off-by: Tom Rini <trini@konsulko.com>
* Merge https://source.denx.de/u-boot/custodians/u-boot-x86Tom Rini2021-08-021-11/+2
|\ | | | | | | | | | | | | | | | | | | | | | | | | - Fixed broken ICH SPI driver in software sequencer mode - Added "m25p,fast-read" to SPI flash node for x86 boards - Drop ROM_NEEDS_BLOBS and BUILD_ROM for x86 ROM builds - Define a default TSC timer frequency for all x86 boards - x86 MTRR MSR programming codes bug fixes - x86 "hob" command bug fixes - Don't program MTRR for DRAM for FSP1 - Move INIT_PHASE_END_FIRMWARE to FSP2 - Use external graphics card by default on Intel Crown Bay - tangier: Fix DMA controller IRQ polarity in CSRT
| * x86: kconfig: Drop ROM_NEEDS_BLOBS and BUILD_ROMBin Meng2021-08-021-11/+2
| | | | | | | | | | | | | | | | These 2 options are no longer needed as now binman is used to build u-boot.rom. Signed-off-by: Bin Meng <bmeng.cn@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
* | lib: Allow using 0x when a decimal value is requestedSimon Glass2021-08-021-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | U-Boot mostly uses hex for value input, largely because addresses are much easier to understand in hex. But in some cases a decimal value is requested, such as where the value is small or hex does not make sense in the context. In these cases it is sometimes useful to be able to provide a hex value in any case, if only to resolve any ambiguity. Add this functionality, for increased flexibility. Signed-off-by: Simon Glass <sjg@chromium.org>
* | doc: Add a note about number representationSimon Glass2021-08-021-0/+31
| | | | | | | | | | | | | | Mention the default base of U-Boot in the command-line section. Add examples for decimal and octal. Signed-off-by: Simon Glass <sjg@chromium.org>
* | doc: Convert command-line info to rSTSimon Glass2021-08-022-0/+57
| | | | | | | | | | | | Take this part of the README and put it into rST format. Signed-off-by: Simon Glass <sjg@chromium.org>
* | Merge tag 'efi-2021-10-rc2' of ↵Tom Rini2021-08-025-29/+38
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | https://source.denx.de/u-boot/custodians/u-boot-efi Pull request for efi-2021-10-rc2 Documentation: * handle 'make htmldocs' warnings as errors * add missing board/ti/index.rst Bug fixes: * avoid buffer overrun in TrueType console * lib: disable CONFIG_SPL_HEXDUMP by default