summaryrefslogtreecommitdiff
path: root/doc/develop
AgeCommit message (Collapse)Author
2023-10-23Prepare v2024.01-rc1v2024.01-rc1Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2023-10-13doc: capsule: Add documentation for the capsule dump featureSughosh Ganu
Add documentation to explain the printing of the capsule headers through the mkeficapsule tool. Signed-off-by: Sughosh Ganu <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2023-10-13Merge tag 'efi-2024-01-rc1' of ↵Tom Rini
https://source.denx.de/u-boot/custodians/u-boot-efi Pull request efi-2024-01-rc1 Documentation: * Bump urllib3 version * Migrate Renesas board docs to rst * Link an introduction video UEFI * Use same GUID as EDK II for auto-created boot options * Clean up BitBlt test
2023-10-12cyclic: doc: Update documentation for CONFIG_CYCLIC_MAX_CPU_TIME_USWeizhao Ouyang
Cyclic now just print a warning once instead of disabling the cyclic function when the cyclic function upon exceeding CPU time usage. Fixes: ddc8d36a7455 ("cyclic: Don't disable cylic function upon exceeding CPU time") Signed-off-by: Weizhao Ouyang <[email protected]> Rephrase the paragraph. Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-10-11expo: Update documentation to include textlineSimon Glass
Update the expo documentation to include mention of this new object type. Signed-off-by: Simon Glass <[email protected]>
2023-10-11doc: add ide_integration.rst to doc/developJoao Marcos Costa
Add 'Integration with IDEs' chapter. For now, this chapter is mostly a reference to the documentation of gen_compile_commands, in doc/build, but it can be futurely used as a guide for other IDE-friendly features. Signed-off-by: Joao Marcos Costa <[email protected]> Tested-by: Joao Paulo Goncalves <[email protected]>
2023-10-11doc: use .dtso as extension for device tree overlay sourcesRasmus Villemoes
Moving towards using .dtso for overlay sources, update the documentation examples to follow that pattern. Signed-off-by: Rasmus Villemoes <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2023-10-11bootstd: Drop some TODOsSimon Glass
The existing TODOs are done, so remove them. Add another that came up today. Signed-off-by: Simon Glass <[email protected]>
2023-10-06spl: Rename SYS_SPL_ARGS_ADDR to SPL_PAYLOAD_ARGS_ADDRSimon Glass
Rename this so that SPL is first, as per U-Boot convention. Also add PAYLOAD_ since this is where in memory the parameters for the payload have been stored. Signed-off-by: Simon Glass <[email protected]>
2023-10-04qconfig: Update the documentationSimon Glass
Update qconfig's documentation to better reflect its new purpose in life. Signed-off-by: Simon Glass <[email protected]>
2023-10-02Merge branch 'next'Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2023-10-02Prepare v2023.10v2023.10Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2023-09-19Mark DISTRO_DEFAULTS as deprecatedSimon Glass
Standard boot has been in place for a while now. Quite a few problems have been found and fixed. It seems like a good time to mark the script-based approach as deprecated and encourage people to use standard boot. Update the DISTRO_DEFAULTS Kconfig to encourage people to move to standard boot, which is able to boot Linux distributions automatically. Add a short migration guide to make this easier. Signed-off-by: Simon Glass <[email protected]> Reviewed-by: Tom Rini <[email protected]>
2023-09-09doc: efi: Update for the 64-bit appSimon Glass
The 64-bit app is supported now, so update the documentation. Signed-off-by: Simon Glass <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-09-04Merge tag 'v2023.10-rc4' into nextTom Rini
Prepare v2023.10-rc4
2023-09-04Prepare v2023.10-rc4v2023.10-rc4Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2023-08-31event: Update documentation for simple spySimon Glass
Now that we have two types of spy, mention this in the documentation. Put the simple spy first, since it seems to be the common case. Signed-off-by: Simon Glass <[email protected]>
2023-08-29doc: capsule: Document the new mechanism to embed ESL file into dtbSughosh Ganu
Update the document to specify how the EFI Signature List(ESL) file can be embedded into the platform's dtb as part of the U-Boot build. Signed-off-by: Sughosh Ganu <[email protected]> Reviewed-by: Ilias Apalodimas <[email protected]>
2023-08-29doc: Add documentation to highlight capsule generation related updatesSughosh Ganu
The EFI capsules can now be generated as part of U-Boot build, through binman. Highlight these changes in the documentation. Signed-off-by: Sughosh Ganu <[email protected]> Acked-by: Heinrich Schuchardt <[email protected]>
2023-08-28bootstd: Adjust the default bootmeth orderSimon Glass
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 <[email protected]> Reported-by: Da Xue <[email protected]>
2023-08-25bootstd: Support bootmeths which can scan any partitionSimon Glass
Some bootmeths support scanning a partition without a filesystem on it. Add a flag to support this. This will allow the ChromiumOS bootmeth to find kernel partition, which are stored in a special format, without a filesystem. Signed-off-by: Simon Glass <[email protected]>
2023-08-25expo: doc: Update documentation for persistent settingsSimon Glass
Add mention of persistent settings in the documentation. Signed-off-by: Simon Glass <[email protected]>
2023-08-25expo: cedit: Support writing settings to CMOS RAMSimon Glass
Add a command to write cedit settings to CMOS RAM so that it can be preserved across a reboot. This uses a simple bit-encoding, where each field has a 'bit position' and a 'bit length' in the schema. Signed-off-by: Simon Glass <[email protected]>
2023-08-25expo: Move cedit theme under bootstdSimon Glass
This is related to standard boot, so put it under the same node. This may simplify schema upstreaming later. Mention themes in the documentation while we are here. Signed-off-by: Simon Glass <[email protected]>
2023-08-25expo: Add documentation for the configuration editorSimon Glass
This is mentioned in passing in the 'cedit' command. Its file format is described under `expo`. But it would be better if it had its own entry in the documentation. Add a new 'cedit' entry with a few details about this feature. Signed-off-by: Simon Glass <[email protected]>
2023-08-25expo: Tidy up the expo.py tool and usageSimon Glass
Tidy up this tool a little: - define which arguments are needed - split the enum values out into a header file - warn if no enum values are found - display the dtc error if something goes wrong - avoid a Python traceback on error Signed-off-by: Simon Glass <[email protected]>
2023-08-23Documentation extended with specific information for VirtualBoxThomas Mittelstaedt
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 <[email protected]>
2023-08-21Prepare v2023.10-rc3v2023.10-rc3Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2023-08-19doc: printf() codes: Fix format specifier for unsigned intSiddharth Vadapalli
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 <[email protected]> Signed-off-by: Siddharth Vadapalli <[email protected]> Reviewed-by: Tom Rini <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-08-19docs: fix wrong usage of proftoolPuhan Zhou
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2023-08-09Merge tag 'x86-pull-20230809' of ↵Tom Rini
https://source.denx.de/u-boot/custodians/u-boot-x86 - x86: Fixes for distro booting - x86: Move some boards to text environment
2023-08-09bootstd: Rename bootdev_setup_sibling_blk()Simon Glass
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 <[email protected]> Reviewed-by: Bin Meng <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]>
2023-08-09doc: Begin adding a best practices document for board portsTom Rini
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 <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2023-08-07Prepare v2023.10-rc2v2023.10-rc2Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2023-08-03doc: move README.falcon to HTMLHeinrich Schuchardt
Move the Falcon mode documentation to HTML. Signed-off-by: Heinrich Schuchardt <[email protected]>
2023-08-03doc: U-Boot boot phasesHeinrich Schuchardt
Add more detail to the description of U-Boot boot phases: * describe which steps are optional * mentions alternative boot flows Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Bin Meng <[email protected]>
2023-07-28doc: fix typo device_compat/.hHeinrich Schuchardt
%s/device_compat\/.h/device_compat.h/ Signed-off-by: Heinrich Schuchardt <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2023-07-25Prepare v2023.10-rc1v2023.10-rc1Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2023-07-15doc: uefi: enhance anti-rollback documentationMasahisa Kojima
To enforce anti-rollback to any older version, dtb must be always update manually. This should be described in the documentation. This commit also adds the recommendation that secure system should not enable the fdt command because lowest-supported-version property in device tree can be changed by fdt command. Reviewed-by: Ilias Apalodimas <[email protected]> Signed-off-by: Masahisa Kojima <[email protected]>
2023-07-14expo: Add a configuration editorSimon Glass
Add a new 'cedit' command which allows editing configuration using an expo. The configuration items appear as menus on the display. This is extremely basic, only supporting menus and not providing any way to load or save the configuration. Signed-off-by: Simon Glass <[email protected]>
2023-07-14expo: Support building an expo from a description fileSimon Glass
The only way to create an expo at present is by calling the functions to create each object. It is useful to have more data-driven approach, where the objects can be specified in a suitable file format and created from that. This makes testing easier as well. Add support for describing an expo in a devicetree node. This allows more complex tests to be set up, as well as providing an easier format for users. It also provides a better basis for the upcoming configuration editor. Signed-off-by: Simon Glass <[email protected]>
2023-07-14expo: Add spacing around menus and itemsSimon Glass
It looks better if menus have a bit of an inset, rather than be drawn hard up against the background. Also, menu items look better if they have a bit of spacing between them. Add theme options for these and implement the required changes. Signed-off-by: Simon Glass <[email protected]>
2023-07-14expo: Implement the keypress logic for popup menusSimon Glass
In 'popup' mode, the expo allows moving around the objects in a scene. When 'enter' is pressed on a menu, it opens and the user can move around the items in the menu. Implement this using keypress handles and actions. Signed-off-by: Simon Glass <[email protected]>
2023-07-14expo: Support simple themesSimon Glass
It is a pain to manually set the fonts of all objects to be consistent. Some spacing settings are also better set globally than by manually positioning each object. Add a 'theme' to the expo, to hold this information. For now it includes only the font size. Signed-off-by: Simon Glass <[email protected]>
2023-07-14expo: Set up the width and height of objectsSimon Glass
Provide a way to set the full dimensions of objects, i.e. including the width and height. For menus, calculate the bounding box of all objects in the menu. Set all labels to be the same size, so that highlighting works correct, once implemented. Signed-off-by: Simon Glass <[email protected]>
2023-07-14expo: Allow setting the start of the dynamic-ID rangeSimon Glass
Provide a way to set this value so that it is easy to separate the statically allocated IDs (generated by the caller) from those generated dynamically by expo itself. Signed-off-by: Simon Glass <[email protected]>
2023-07-11Merge tag 'efi-2023-07-rc7' of ↵Tom Rini
https://source.denx.de/u-boot/custodians/u-boot-efi Pull request efi-2023-07-rc7 Documentation: * Fix links to Linux kernel documentation UEFI: * Fix memory leak in efidebug dh subcommand * Fix underflow when calculating remaining variable store size * Increase default variable store size to 64 KiB * mkeficapsule: fix efi_firmware_management_capsule_header data type
2023-07-10Merge branch 'next'Tom Rini
2023-07-10Prepare v2023.07v2023.07Tom Rini
Signed-off-by: Tom Rini <[email protected]>
2023-07-09doc: harmonize Linux kernel documentation linksHeinrich Schuchardt
Linux internally uses https://www.kernel.org/doc/html/latest/ for documentation links. When referring to their documentation we should do the same. Signed-off-by: Heinrich Schuchardt <[email protected]>