summaryrefslogtreecommitdiff
path: root/doc/develop
Commit message (Collapse)AuthorAgeFilesLines
* doc: Move distro boot doc to rSTSimon Glass2021-11-112-0/+412
| | | | | | | | Move this over to the new rST format. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Artem Lapkin <email2tema@gmail.com> Reviewed-by: Ramon Fried <rfried.dev@gmail.com>
* efi: Add video support to the appSimon Glass2021-11-071-1/+1
| | | | | | | | | | | | | | | | | | | | | | | The current EFI video driver only works when running in the stub. In that case the stub calls boot services (before jumping to U-Boot proper) and copies the graphics info over to the efi table. This is necessary because the stub exits boot services before jumping to U-Boot. The app maintains access to boot services throughout its life, so does not need to do this. Update the driver to support calling boot services directly. Enable video output for the app. Note that this uses the EFI_GRAPHICS_OUTPUT_PROTOCOL protocol, even though it mentions vesa. A sample qemu command-line for this case is: qemu-system-x86_64 -bios /usr/share/edk2.git/ovmf-ia32/OVMF-pure-efi.fd -drive id=disk,file=try.img,if=none,format=raw -nic none -device ahci,id=ahci -device ide-hd,drive=disk,bus=ahci.0 Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* efi: Create a 64-bit appSimon Glass2021-11-071-3/+3
| | | | | | | | | | | | | | Most modern platforms use 64-bit EFI so it is useful to have a U-Boot app that runs under that. Add a (non-functional) build for this. Note that --whole-archive causes the gcc 9.2 linker to crash, so disable this for now. Once this is resolved, things should work. For now, avoid mentioning the documentation for the 64-bit app, since it does not work. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* efi: Add a script to build an image for testing on UEFISimon Glass2021-11-071-0/+62
| | | | | | | | | | | | It is quite complicated to run U-Boot on QEMU since we have four different builds and they must use different versions of qemu and the UEFI binaries. Add a script to help. It requires U-Boot itself to be built. Once that is done you can use this script to build an image for use with qemu and optionally run it. Signed-off-by: Simon Glass <sjg@chromium.org>
* docs: uefi: Update stale U-Boot on EFI docBin Meng2021-11-011-5/+7
| | | | | | | | The existing intructions in the U-Boot on EFI doc do not work with the latest QEMU. Update the doc with the correct instructions, as well as using the new OVMF URL link. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
* sandbox: Remove OF_HOSTFILEIlias Apalodimas2021-10-271-4/+3
| | | | | | | | | | | | | | | OF_HOSTFILE is used on sandbox configs only. Although it's pretty unique and not causing any confusions, we are better of having simpler config options for the DTB. So let's replace that with the existing OF_BOARD. U-Boot would then have only three config options for the DTB origin. - OF_SEPARATE, build separately from U-Boot - OF_BOARD, board specific way of providing the DTB - OF_EMBED embedded in the u-boot binary(should not be used in production Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Reviewed-by: Simon Glass <sjg@chromium.org>
* Revert "Revert "doc: Update CapsuleUpdate READMEs""AKASHI Takahiro2021-10-251-0/+124
| | | | | | | | | This reverts commit a7e4f905d206d5895dab4bd38a8316e4f2fe15fe. The description originally written by Sughosh is still valid even after the commit 47a25e81d35c ("Revert "efi_capsule: Move signature from DTB to .rodata"") was applied. Signed-off-by: AKASHI Takahiro <takahiro.akashi@linaro.org>
* pytest: Show a message when sandbox crashesSimon Glass2021-10-141-0/+8
| | | | | | | | | | | | | | | | | | | | | | When a test hands on a real board there is no way on the console to obtain any information about why it hung. With sandbox we can actually find out that it died and get a signal or exit code. Add this to make it easier to figure out what happened. So instead of: test/py/u_boot_spawn.py:171: in expect c = os.read(self.fd, 1024).decode(errors='replace') E OSError: [Errno 5] Input/output error We get: test/py/u_boot_spawn.py:171: in expect c = os.read(self.fd, 1024).decode(errors='replace') E ValueError: U-Boot exited with signal 11 (Signals.SIGSEGV) Signed-off-by: Simon Glass <sjg@chromium.org>
* pytest: Shorten traceback length by defaultSimon Glass2021-10-141-0/+7
| | | | | | | This produces a lot of code output which is not very helpful and is quite annoying to wade through. Use the short format by default. Signed-off-by: Simon Glass <sjg@chromium.org>
* acpi: Use U-Boot version for OEM_REVISIONPali Rohár2021-10-061-1/+0
| | | | | | | | | | | | | | | | | OEM_REVISION is 32-bit unsigned number. It should be increased only when changing software version. Therefore it should not depend on build time. Change calculation to use U-Boot version numbers and set this revision to date number. Prior this change OEM_REVISION was calculated from build date and stored in the same format. After this change macro U_BOOT_BUILD_DATE is not used in other files so remove it from global autogenerated files and also from Makefile. Signed-off-by: Pali Rohár <pali@kernel.org> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: test: Explain how to run pytests in parallelSimon Glass2021-10-051-0/+30
| | | | | | | Add documentation for this so people can try it out. At present it does not fully work. Signed-off-by: Simon Glass <sjg@chromium.org>
* Merge tag 'dm-pull-next-27sep21' of ↵WIP/27Sep2021-nextTom Rini2021-09-271-4/+52
|\ | | | | | | | | | | https://source.denx.de/u-boot/custodians/u-boot-dm into next Various of-platdata improvements, including CONFIG_OF_REAL
| * dm: doc: Add a note about of-platdata header filesSimon Glass2021-09-251-1/+49
| | | | | | | | | | | | | | This error can be confusing so mention it specifically in the documentation. Signed-off-by: Simon Glass <sjg@chromium.org>
| * treewide: Try to avoid the preprocessor with OF_REALSimon Glass2021-09-251-3/+3
| | | | | | | | | | | | | | Convert some of these occurences to C code, where it is easy to do. This should help encourage this approach to be used in new code. Signed-off-by: Simon Glass <sjg@chromium.org>
| * treewide: Use OF_REAL instead of !OF_PLATDATASimon Glass2021-09-251-1/+1
| | | | | | | | | | | | | | Now that we have a 'positive' Kconfig option, use this instead of the negative one, which is harder to understand. Signed-off-by: Simon Glass <sjg@chromium.org>
* | Merge tag 'v2021.10-rc5' into nextTom Rini2021-09-273-124/+11
|\ \ | |/ |/| | | Prepare v2021.10-rc5
| * doc: Add mention of the /config bindingSimon Glass2021-09-252-0/+11
| | | | | | | | | | | | | | | | | | | | The devicetree binding files are in their own directory and use a simple text format. Add a link for the binding for the /config node, since it is otherwise hard to find. Suggested-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
| * Revert "doc: Update CapsuleUpdate READMEs"Simon Glass2021-09-181-124/+0
| | | | | | | | | | | | This reverts commit 316ab801c0d91c02b21b8be1e3db7e69555364e9. Signed-off-by: Simon Glass <sjg@chromium.org>
* | 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-163-1/+83
|\ \ | |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
| * bloblist: Move to rST formatSimon Glass2021-09-112-0/+83
| | | | | | | | | | | | | | Move this documentation to the new format. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.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>
* | 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>
* 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-0/+248
| | | | | | | | | | | 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>
* pci: Drop migration methodSimon Glass2021-08-061-9/+0
| | | | | | Migration is complete. Drop the message. 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>
* doc: Fix up outdated moveconfig docsSimon Glass2021-08-011-36/+22
| | | | | | | The examples here are a bit messed up since the command does not match the documentation. Use a different example instead. Signed-off-by: Simon Glass <sjg@chromium.org>
* doc: Add docs for the moveconfig toolSimon Glass2021-08-012-0/+297
| | | | | | Move these docs into htmldocs so they can be read there. Signed-off-by: Simon Glass <sjg@chromium.org>
* doc: Move coccinelle into its own sectionSimon Glass2021-08-011-1/+8
| | | | | | | | | | | This tool has nothing to do with testing. It is for refactoring code automatically using a 'semantic patch' tool. Create a new section for 'refactoring' and move it into there. It is likely that other topics may fall under the same heading, such as using moveconfig and search/replace tools. Signed-off-by: Simon Glass <sjg@chromium.org>
* doc: Create an intro section for testingSimon Glass2021-08-012-3/+5
| | | | | | | | At present this information is hidden away. Make it more visible by putting it first, in an intro section. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* smbios: Fix calculating BIOS Release DatePali Rohár2021-07-241-1/+0
| | | | | | | | | | | | | | | | | | | | | | BIOS Release Date must be in format mm/dd/yyyy and must be release date. U-Boot currently sets BIOS Release Date from U_BOOT_DMI_DATE macro which is generated from current build timestamp. Fix this issue by setting U_BOOT_DMI_DATE macro to U-Boot version which is better approximation of U-Boot release date than current build timestamp. Current U-Boot versioning is in format yyyy.mm so as a day choose 01. Some operating systems are using BIOS Release Date for detecting when was SMBIOS table filled or if it could support some feature (e.g. BIOS from 1990 cannot support features invented in 2000). So this change also ensures that recompiling U-Boot from same sources but in different year does not change behavior of some operating systems. Macro U_BOOT_DMI_DATE is not used in other file than lib/smbios.c so remove it from global autogenerated files and also from Makefile. Signed-off-by: Pali Rohár <pali@kernel.org> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: Bring in Makefile documentationSimon Glass2021-07-242-0/+1676
| | | | | | | | | U-Boot uses the Linux Kbuild build system. Add the associated documentation so that people can understand the Makefiles better. This is taken from Linux v5.12 Signed-off-by: Simon Glass <sjg@chromium.org>
* dtoc: Update documentation to cover warnings in more detailSimon Glass2021-07-211-0/+53
| | | | | | | | | | When things go wrong it can be confusing to figure out what to change. Add a few more details to the documentation. Fix a 'make htmldocs' warning while we are here. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Walter Lozano <walter.lozano@collabora.com>
* doc: Update CapsuleUpdate READMEsIlias Apalodimas2021-07-181-0/+125
| | | | | | | | Since we removed embeddingg the capsule key into a .dtb and fixed authenticated capsule updates for all boards, move the relevant documentation in the efi file and update it accordingly Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org>
* Merge tag 'v2021.07-rc5' into nextTom Rini2021-06-282-0/+98
|\ | | | | | | | | | | | | | | | | | | | | Prepare v2021.07-rc5 # gpg: Signature made Mon 28 Jun 2021 03:39:36 PM EDT # gpg: using RSA key 1A3C7F70E08FAB1707809BBF147C39FF9634B72C # gpg: Good signature from "Thomas Rini <trini@konsulko.com>" [ultimate] # Conflicts: # configs/am64x_evm_r5_defconfig
| * doc: develop: Convert README.nvme to reSTBin Meng2021-06-232-0/+98
| | | | | | | | | | | | | | This converts the existing README.nvme to reST, and puts it under the develop/driver-model/ directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
* | log: Convert log values to printf() if not enabledSimon Glass2021-06-081-2/+4
|/ | | | | | | | | | | | At present if logging not enabled, log_info() becomes a nop. But we want log output at the 'info' level to be akin to printf(). Update the macro to pass the output straight to printf() in this case. This mimics the behaviour for the log_...() macros like log_debug() and log_info(), so we can drop the special case for these. Add new tests to cover this case. Signed-off-by: Simon Glass <sjg@chromium.org>
* doc: develop: Convert README.virtio to reSTBin Meng2021-05-102-0/+288
| | | | | | | This converts the existing README.virtio to reST, and puts it under the develop/driver-model/ directory. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
* doc: Add build instructions for OP-TEE backed EFI variablesIlias Apalodimas2021-04-101-1/+57
| | | | | | | | Since that invlolves external projects and not only U-Boot, add guidance for supported platforms Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Update uefi documentation for initrd loading optionsIlias Apalodimas2021-04-101-1/+21
| | | | | | | Document the command line options for efidebug and initrd loading Signed-off-by: Ilias Apalodimas <ilias.apalodimas@linaro.org> Rewiewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* dm: core: Document the common error codesSimon Glass2021-04-061-0/+133
| | | | | | | | | Driver model uses quite strong conventions on error codes, but these are currently not clearly documented. Add a description of the commonly used errors. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Sean Anderson <seanga2@gmail.com>
* Merge tag 'v2021.04-rc5' into nextWIP/29Mar2021-nextTom Rini2021-03-291-0/+8
|\ | | | | | | Prepare v2021.04-rc5
* \ Merge tag 'dm-pull-26mar21-take2' of git://git.denx.de/u-boot-dm into nextWIP/26Mar2021-nextTom Rini2021-03-2626-0/+5795
|\ \ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | dtoc support for of-platdata-inst driver model support for of-platdata-inst support of-platdata-inst on x86 / coral binman support for exapanded entries binman convert docs to reST ti-sysc fix for duplicate uclass driver patman minor improvements pylibfdt build only if needed correct obscure CI error with OF_PLATDATA_INST
| * | binman: Update various pieces of the documentationSimon Glass2021-03-261-0/+1
| | | | | | | | | | | | | | | | | | A few sections are a little out of date now. Update them. Signed-off-by: Simon Glass <sjg@chromium.org>
| * | binman: doc: Add documentation to htmldocsSimon Glass2021-03-263-0/+28
| | | | | | | | | | | | | | | | | | | | | | | | Add a link to binman's documentation and adjust the files so that it is accessible. Use the name README.rst so it is easy to discover when binman is installed without U-Boot. Signed-off-by: Simon Glass <sjg@chromium.org>
| * | doc: Move driver model docs under develop/Simon Glass2021-03-2619-0/+4833
| | | | | | | | | | | | | | | | | | | | | | | | These docs are useful for developers, not users. Move them under that section. Suggested-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Signed-off-by: Simon Glass <sjg@chromium.org>
| * | doc: Move UEFI under develop/Simon Glass2021-03-265-0/+933
|/ / | | | | | | | | | | | | | | Much of the content here is useful only for development. Move it under that section. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
View Lorry Controller Status