Mirrors/u-boot
2
0
Fork 0
mirror of https://github.com/AsahiLinux/u-boot synced 2025-02-17 22:49:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

doc: shorten overlong title underlines

Browse source 
Title underlines should match the length of the title. Unfortunately
docutils only catches underlines that are too short.

Add some missing empty lines after titles.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
This commit is contained in:
Heinrich Schuchardt 2023-10-28 11:59:32 +02:00
parent 0e20948598
commit b214e88071
43 changed files with 86 additions and 70 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc/arch/arm64.ffa.rst
View file

@ -40,7 +40,7 @@ The U-Boot FF-A support provides the following parts:
- Sandbox FF-A test cases. - Sandbox FF-A test cases.
FF-A and SMC specifications FF-A and SMC specifications
------------------------------------------- ---------------------------
The current implementation of the U-Boot FF-A support relies on The current implementation of the U-Boot FF-A support relies on
`FF-A v1.0 specification`_ and uses SMC32 calling convention which `FF-A v1.0 specification`_ and uses SMC32 calling convention which
@ -56,12 +56,12 @@ Hypervisors are supported if they are configured to trap SMC calls.
The FF-A support uses 64-bit registers as per `SMC Calling Convention v1.2 specification`_. The FF-A support uses 64-bit registers as per `SMC Calling Convention v1.2 specification`_.
Supported hardware Supported hardware
-------------------------------- ------------------
Aarch64 plaforms Aarch64 plaforms
Configuration Configuration
---------------------- -------------
CONFIG_ARM_FFA_TRANSPORT CONFIG_ARM_FFA_TRANSPORT
Enables the FF-A support. Turn this on if you want to use FF-A Enables the FF-A support. Turn this on if you want to use FF-A
@ -70,7 +70,7 @@ CONFIG_ARM_FFA_TRANSPORT
When using sandbox, the sandbox FF-A emulator and FF-A sandbox driver will be used. When using sandbox, the sandbox FF-A emulator and FF-A sandbox driver will be used.
FF-A ABIs under the hood FF-A ABIs under the hood
--------------------------------------- ------------------------
Invoking an FF-A ABI involves providing to the secure world/hypervisor the Invoking an FF-A ABI involves providing to the secure world/hypervisor the
expected arguments from the ABI. expected arguments from the ABI.
@ -89,7 +89,7 @@ The driver reads the response and processes it accordingly.
This methodology applies to all the FF-A ABIs. This methodology applies to all the FF-A ABIs.
FF-A bus discovery on Arm 64-bit platforms FF-A bus discovery on Arm 64-bit platforms
--------------------------------------------- ------------------------------------------
When CONFIG_ARM_FFA_TRANSPORT is enabled, the FF-A bus is considered as When CONFIG_ARM_FFA_TRANSPORT is enabled, the FF-A bus is considered as
an architecture feature and discovered using ARM_SMCCC_FEATURES mechanism. an architecture feature and discovered using ARM_SMCCC_FEATURES mechanism.
@ -136,7 +136,7 @@ When one of the above actions fails, probing fails and the driver stays not acti
and can be probed again if needed. and can be probed again if needed.
Requirements for clients Requirements for clients
------------------------------------- ------------------------
When using the FF-A bus with EFI, clients must query the SPs they are looking for When using the FF-A bus with EFI, clients must query the SPs they are looking for
during EFI boot-time mode using the service UUID. during EFI boot-time mode using the service UUID.
@ -159,13 +159,13 @@ the 32-bit or 64-bit version of FFA_MSG_SEND_DIRECT_{REQ, RESP}.
The calling convention between U-Boot and the secure world stays the same: SMC32. The calling convention between U-Boot and the secure world stays the same: SMC32.
Requirements for user drivers Requirements for user drivers
------------------------------------- -----------------------------
Users who want to implement their custom FF-A device driver while reusing the FF-A Uclass can do so Users who want to implement their custom FF-A device driver while reusing the FF-A Uclass can do so
by implementing their own invoke_ffa_fn() in the user driver. by implementing their own invoke_ffa_fn() in the user driver.
The bus driver layer The bus driver layer
------------------------------ --------------------
FF-A support comes on top of the SMCCC layer and is implemented by the FF-A Uclass drivers/firmware/arm-ffa/arm-ffa-uclass.c FF-A support comes on top of the SMCCC layer and is implemented by the FF-A Uclass drivers/firmware/arm-ffa/arm-ffa-uclass.c
@ -210,7 +210,7 @@ The following features are provided:
- FF-A bus can be compiled and used without EFI - FF-A bus can be compiled and used without EFI
Relationship between the sandbox emulator and the FF-A device Relationship between the sandbox emulator and the FF-A device
--------------------------------------------------------------- -------------------------------------------------------------
:: ::
@ -222,7 +222,7 @@ Relationship between the sandbox emulator and the FF-A device
ffa 0 [ ] sandbox_arm_ffa `-- sandbox-arm-ffa ffa 0 [ ] sandbox_arm_ffa `-- sandbox-arm-ffa
The armffa command The armffa command
----------------------------------- ------------------
armffa is a command showcasing how to use the FF-A bus and how to invoke the driver operations. armffa is a command showcasing how to use the FF-A bus and how to invoke the driver operations.

2
doc/board/AndesTech/ae350.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+ .. SPDX-License-Identifier: GPL-2.0+
AE350 AE350
====== =====
AE350 is the mainline SoC produced by Andes Technology using AndesV5 CPU core AE350 is the mainline SoC produced by Andes Technology using AndesV5 CPU core
based on RISC-V architecture. based on RISC-V architecture.

4
doc/board/actions/cubieboard7.rst
View file

@ -20,7 +20,7 @@ Though, one can enter ADFU mode and flash debian image(from host machine) where
getting into u-boot prompt is easy. getting into u-boot prompt is easy.
Enter ADFU Mode Enter ADFU Mode
---------------- ---------------
Before write the firmware, let the development board entering the ADFU mode: insert Before write the firmware, let the development board entering the ADFU mode: insert
one end of the USB cable to the PC, press and hold the ADFU button, and then connect one end of the USB cable to the PC, press and hold the ADFU button, and then connect
@ -28,7 +28,7 @@ the other end of the USB cable to the Mini USB port of the development board, re
the ADFU button, after connecting it will enter the ADFU mode. the ADFU button, after connecting it will enter the ADFU mode.
Check whether entered ADFU Mode Check whether entered ADFU Mode
-------------------------------- -------------------------------
The user needs to run the following command on the PC side to check if the ADFU The user needs to run the following command on the PC side to check if the ADFU
device is detected. ID realted to "Actions Semiconductor Co., Ltd" means that device is detected. ID realted to "Actions Semiconductor Co., Ltd" means that

2
doc/board/actions/index.rst
View file

@ -2,7 +2,7 @@
.. Copyright (C) 2020 Amit Singh Tomar <amittomer25@gmail.com> .. Copyright (C) 2020 Amit Singh Tomar <amittomer25@gmail.com>
Actions Actions
======== =======
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

2
doc/board/armltd/index.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0 .. SPDX-License-Identifier: GPL-2.0
Arm Ltd Arm Ltd
============= =======
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

2
doc/board/mediatek/index.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+ .. SPDX-License-Identifier: GPL-2.0+
Mediatek Mediatek
========= ========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

9
doc/board/nxp/imx8mm_evk.rst
View file

@ -36,7 +36,7 @@ Get the ddr firmware
$ cp firmware-imx-8.9/firmware/ddr/synopsys/lpddr4*.bin $(builddir) $ cp firmware-imx-8.9/firmware/ddr/synopsys/lpddr4*.bin $(builddir)
Build U-Boot for sd card Build U-Boot for sd card
-------------------------- ------------------------
.. code-block:: bash .. code-block:: bash
@ -54,8 +54,8 @@ Boot
---- ----
Set Boot switch to SD boot Set Boot switch to SD boot
Build U-Boot for qspi flash card Build U-Boot for qspi flash card
------------------------------------ --------------------------------
.. code-block:: bash .. code-block:: bash
@ -81,7 +81,8 @@ From sd card to memory
$ sf write $loadaddr 0x00 <size_of_flash.bin_in_hex> $ sf write $loadaddr 0x00 <size_of_flash.bin_in_hex>
Boot from QSPI Flash Boot from QSPI Flash
----------------------- --------------------
Set Boot Switch to QSPI Flash Set Boot Switch to QSPI Flash
Pin configuration for imx8mm_revC evk to boot from qspi flash Pin configuration for imx8mm_revC evk to boot from qspi flash

2
doc/board/nxp/ls1046ardb.rst
View file

@ -54,7 +54,7 @@ LS1046ARDB board Overview
- ARM JTAG support - ARM JTAG support
Memory map from core's view Memory map from core's view
---------------------------- ---------------------------
================== ================== ================ ===== ================== ================== ================ =====
Start Address End Address Description Size Start Address End Address Description Size

2
doc/board/nxp/mx6ul_14x14_evk.rst
View file

@ -4,7 +4,7 @@ mx6ul_14x14_evk
=============== ===============
How to use U-Boot on Freescale MX6UL 14x14 EVK How to use U-Boot on Freescale MX6UL 14x14 EVK
----------------------------------------------- ----------------------------------------------
- Build U-Boot for MX6UL 14x14 EVK: - Build U-Boot for MX6UL 14x14 EVK:

4
doc/board/openpiton/riscv64.rst
View file

@ -11,14 +11,14 @@ OpenPiton has been verified in both ASIC and multiple Xilinx FPGA prototypes
running full-stack Debian linux. running full-stack Debian linux.
RISC-V Standard Bootflow RISC-V Standard Bootflow
------------------------- ------------------------
Currently, OpenPiton implements RISC-V standard bootflow in the following steps Currently, OpenPiton implements RISC-V standard bootflow in the following steps
mover.S -> u-boot-spl -> opensbi -> u-boot -> Linux mover.S -> u-boot-spl -> opensbi -> u-boot -> Linux
This board supports S-mode u-boot as well as M-mode SPL This board supports S-mode u-boot as well as M-mode SPL
Building OpenPition Building OpenPition
--------------------- -------------------
If you'd like to build OpenPiton, please go to OpenPiton github repo If you'd like to build OpenPiton, please go to OpenPiton github repo
(at https://github.com/PrincetonUniversity/openpiton) to build from the latest (at https://github.com/PrincetonUniversity/openpiton) to build from the latest

2
doc/board/purism/librem5.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+ .. SPDX-License-Identifier: GPL-2.0+
Librem5 Librem5
========== =======
U-Boot for the Purism Librem5 phone U-Boot for the Purism Librem5 phone

7
doc/board/qualcomm/sdm845.rst
View file

@ -2,10 +2,11 @@
.. sectionauthor:: Dzmitry Sankouski <dsankouski@gmail.com> .. sectionauthor:: Dzmitry Sankouski <dsankouski@gmail.com>
Snapdragon 845 Snapdragon 845
================ ==============
About this About this
---------- ----------
This document describes the information about Qualcomm Snapdragon 845 This document describes the information about Qualcomm Snapdragon 845
supported boards and it's usage steps. supported boards and it's usage steps.
@ -17,8 +18,10 @@ Qualcomm's UEFI-based ABL (Android) Bootloader.
Installation Installation
------------ ------------
Build Build
^^^^^ ^^^^^
Setup ``CROSS_COMPILE`` for aarch64 and build U-Boot for your board:: Setup ``CROSS_COMPILE`` for aarch64 and build U-Boot for your board::
$ export CROSS_COMPILE=<aarch64 toolchain prefix> $ export CROSS_COMPILE=<aarch64 toolchain prefix>
@ -29,10 +32,12 @@ This will build ``u-boot.bin`` in the configured output directory.
Generate FIT image Generate FIT image
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
See doc/uImage.FIT for more details See doc/uImage.FIT for more details
Pack android boot image Pack android boot image
^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^
We'll assemble android boot image with ``u-boot.bin`` instead of linux kernel, We'll assemble android boot image with ``u-boot.bin`` instead of linux kernel,
and FIT image instead of ``initramfs``. Android bootloader expect gzipped kernel and FIT image instead of ``initramfs``. Android bootloader expect gzipped kernel
with appended dtb, so let's mimic linux to satisfy stock bootloader. with appended dtb, so let's mimic linux to satisfy stock bootloader.

2
doc/board/samsung/index.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+ .. SPDX-License-Identifier: GPL-2.0+
Samsung Samsung
======== =======
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2

2
doc/board/st/st-dt.rst
View file

@ -2,7 +2,7 @@
.. sectionauthor:: Patrick Delaunay <patrick.delaunay@foss.st.com> .. sectionauthor:: Patrick Delaunay <patrick.delaunay@foss.st.com>
U-Boot device tree bindings U-Boot device tree bindings
---------------------------- ---------------------------
The U-Boot specific bindings are defined in the U-Boot directory: The U-Boot specific bindings are defined in the U-Boot directory:
doc/device-tree-bindings doc/device-tree-bindings

2
doc/board/st/stm32_MCU.rst
View file

@ -2,7 +2,7 @@
.. sectionauthor:: Patrice Chotard <patrice.chotardy@foss.st.com> .. sectionauthor:: Patrice Chotard <patrice.chotardy@foss.st.com>
STM32 MCU boards STM32 MCU boards
================= ================
This is a quick instruction for setup STM32 MCU boards. This is a quick instruction for setup STM32 MCU boards.

3
doc/board/starfive/visionfive2.rst
View file

@ -4,7 +4,8 @@ StarFive VisionFive2
==================== ====================
JH7110 RISC-V SoC JH7110 RISC-V SoC
--------------------- -----------------
The JH7110 is 4+1 64-bit RISC-V SoC from StarFive. The JH7110 is 4+1 64-bit RISC-V SoC from StarFive.
The StarFive VisionFive2 development platform is based on JH7110 and capable The StarFive VisionFive2 development platform is based on JH7110 and capable

2
doc/board/thead/index.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+ .. SPDX-License-Identifier: GPL-2.0+
T-HEAD T-HEAD
======== ======
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

4
doc/board/ti/am62x_beagleplay.rst
View file

@ -70,7 +70,7 @@ Set the variables corresponding to this platform:
:end-before: .. am62x_evm_rst_include_end_build_steps :end-before: .. am62x_evm_rst_include_end_build_steps
Target Images Target Images
-------------- -------------
Copy the below images to an SD card and boot: Copy the below images to an SD card and boot:
* tiboot3-am62x-gp-evm.bin from R5 build as tiboot3.bin * tiboot3-am62x-gp-evm.bin from R5 build as tiboot3.bin
@ -109,7 +109,7 @@ There are multiple storage media options on BeaglePlay, but primarily:
depends on the SD card quality. depends on the SD card quality.
Flash to uSD card or how to deal with "bricked" Board Flash to uSD card or how to deal with "bricked" Board
-------------------------------------------------------- -----------------------------------------------------
When deploying or working on Linux, it's common to use the onboard When deploying or working on Linux, it's common to use the onboard
eMMC. However, avoiding the eMMC and using the uSD card is safer when eMMC. However, avoiding the eMMC and using the uSD card is safer when

5
doc/board/ti/am62x_sk.rst
View file

@ -2,7 +2,7 @@
.. sectionauthor:: Vignesh Raghavendra <vigneshr@ti.com> .. sectionauthor:: Vignesh Raghavendra <vigneshr@ti.com>
AM62 Platforms AM62 Platforms
=============== ==============
Introduction: Introduction:
------------- -------------
@ -117,7 +117,8 @@ Set the variables corresponding to this platform:
.. am62x_evm_rst_include_end_build_steps .. am62x_evm_rst_include_end_build_steps
Target Images Target Images
-------------- -------------
In order to boot we need tiboot3.bin, tispl.bin and u-boot.img. Each SoC In order to boot we need tiboot3.bin, tispl.bin and u-boot.img. Each SoC
variant (GP, HS-FS, HS-SE) requires a different source for these files. variant (GP, HS-FS, HS-SE) requires a different source for these files.

3
doc/board/ti/am64x_evm.rst
View file

@ -107,7 +107,8 @@ Set the variables corresponding to this platform:
.. am64x_evm_rst_include_end_build_steps .. am64x_evm_rst_include_end_build_steps
Target Images Target Images
-------------- -------------
In order to boot we need tiboot3.bin, tispl.bin and u-boot.img. Each SoC In order to boot we need tiboot3.bin, tispl.bin and u-boot.img. Each SoC
variant (GP, HS-FS, HS-SE) requires a different source for these files. variant (GP, HS-FS, HS-SE) requires a different source for these files.

3
doc/board/ti/am65x_evm.rst
View file

@ -117,7 +117,8 @@ Set the variables corresponding to this platform:
.. am65x_evm_rst_include_end_build_steps .. am65x_evm_rst_include_end_build_steps
Target Images Target Images
-------------- -------------
In order to boot we need tiboot3.bin, sysfw.itb, tispl.bin and u-boot.img. In order to boot we need tiboot3.bin, sysfw.itb, tispl.bin and u-boot.img.
Each SoC variant (GP and HS) requires a different source for these files. Each SoC variant (GP and HS) requires a different source for these files.

3
doc/board/ti/j7200_evm.rst
View file

@ -106,7 +106,8 @@ Set the variables corresponding to this platform:
.. j7200_evm_rst_include_end_build_steps .. j7200_evm_rst_include_end_build_steps
Target Images Target Images
-------------- -------------
In order to boot we need tiboot3.bin, tispl.bin and u-boot.img. Each SoC In order to boot we need tiboot3.bin, tispl.bin and u-boot.img. Each SoC
variant (GP, HS-FS, HS-SE) requires a different source for these files. variant (GP, HS-FS, HS-SE) requires a different source for these files.

3
doc/board/ti/j721e_evm.rst
View file

@ -111,7 +111,8 @@ Set the variables corresponding to this platform:
.. j721e_evm_rst_include_end_build_steps .. j721e_evm_rst_include_end_build_steps
Target Images Target Images
-------------- -------------
In order to boot we need tiboot3.bin, sysfw.itb, tispl.bin and u-boot.img. In order to boot we need tiboot3.bin, sysfw.itb, tispl.bin and u-boot.img.
Each SoC variant (GP, HS-FS and HS-SE) requires a different source for these Each SoC variant (GP, HS-FS and HS-SE) requires a different source for these
files. files.

6
doc/board/ti/j721s2_evm.rst
View file

@ -6,6 +6,7 @@ J721S2 and AM68 Platforms
Introduction: Introduction:
------------- -------------
The J721S2 family of SoCs are part of K3 Multicore SoC architecture platform The J721S2 family of SoCs are part of K3 Multicore SoC architecture platform
targeting automotive applications. They are designed as a low power, high targeting automotive applications. They are designed as a low power, high
performance and highly integrated device architecture, adding significant performance and highly integrated device architecture, adding significant
@ -38,6 +39,7 @@ Platform information:
Boot Flow: Boot Flow:
---------- ----------
Below is the pictorial representation of boot flow: Below is the pictorial representation of boot flow:
.. image:: img/boot_diagram_k3_current.svg .. image:: img/boot_diagram_k3_current.svg
@ -60,6 +62,7 @@ Sources:
Build procedure: Build procedure:
---------------- ----------------
0. Setup the environment variables: 0. Setup the environment variables:
.. include:: k3.rst .. include:: k3.rst
@ -120,7 +123,8 @@ Set the variables corresponding to this platform:
.. j721s2_evm_rst_include_end_build_steps .. j721s2_evm_rst_include_end_build_steps
Target Images Target Images
-------------- -------------
In order to boot we need tiboot3.bin, tispl.bin and u-boot.img. Each SoC In order to boot we need tiboot3.bin, tispl.bin and u-boot.img. Each SoC
variant (GP, HS-FS, HS-SE) requires a different source for these files. variant (GP, HS-FS, HS-SE) requires a different source for these files.

4
doc/board/ti/k3.rst
View file

@ -238,7 +238,7 @@ other build sources. we shall use the following, in the build descriptions below
.. k3_rst_include_end_board_env_vars_desc .. k3_rst_include_end_board_env_vars_desc
Building tiboot3.bin Building tiboot3.bin
^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
1. To generate the U-Boot SPL for the wakeup domain, use the following 1. To generate the U-Boot SPL for the wakeup domain, use the following
commands, substituting :code:`{SOC}` for the name of your device (eg: commands, substituting :code:`{SOC}` for the name of your device (eg:
@ -273,7 +273,7 @@ domain of your K3 SoC.
UBoot SPL will only look for and load the files with these names. UBoot SPL will only look for and load the files with these names.
Building tispl.bin Building tispl.bin
^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
The `tispl.bin` is a standard fitImage combining the firmware need for The `tispl.bin` is a standard fitImage combining the firmware need for
the main domain to function properly as well as Device Management (DM) the main domain to function properly as well as Device Management (DM)

2
doc/board/xilinx/xilinx.rst
View file

@ -2,7 +2,7 @@
.. (C) Copyright 2019 Xilinx, Inc. .. (C) Copyright 2019 Xilinx, Inc.
U-Boot device tree bindings U-Boot device tree bindings
---------------------------- ---------------------------
All the device tree bindings used in U-Boot are specified in Linux All the device tree bindings used in U-Boot are specified in Linux
kernel. Please refer dt bindings from below specified paths in Linux kernel. Please refer dt bindings from below specified paths in Linux

2
doc/build/source.rst vendored
View file

@ -1,5 +1,5 @@
Obtaining the source Obtaining the source
===================== ====================
The source of the U-Boot project is maintained in a Git repository. The source of the U-Boot project is maintained in a Git repository.

12
doc/develop/driver-model/ethernet.rst
View file

@ -1,5 +1,5 @@
Ethernet Driver Guide Ethernet Driver Guide
======================= =====================
The networking stack in Das U-Boot is designed for multiple network devices The networking stack in Das U-Boot is designed for multiple network devices
to be easily added and controlled at runtime. This guide is meant for people to be easily added and controlled at runtime. This guide is meant for people
@ -14,7 +14,7 @@ Some drivers are still using the old Ethernet interface, differences between
the two and hints about porting will be handled at the end. the two and hints about porting will be handled at the end.
Driver framework Driver framework
------------------ ----------------
A network driver following the driver model must declare itself using A network driver following the driver model must declare itself using
the UCLASS_ETH .id field in the U-Boot driver struct: the UCLASS_ETH .id field in the U-Boot driver struct:
@ -67,7 +67,7 @@ bus. Also it would take care of any special PHY setup (power rails, enable
bits for internal PHYs, etc.). bits for internal PHYs, etc.).
Driver methods Driver methods
---------------- --------------
The real work will be done in the driver method functions the driver provides The real work will be done in the driver method functions the driver provides
by defining the members of struct eth_ops: by defining the members of struct eth_ops:
@ -158,7 +158,7 @@ So the call graph at this stage would look something like:
CONFIG_PHYLIB / CONFIG_CMD_MII CONFIG_PHYLIB / CONFIG_CMD_MII
-------------------------------- ------------------------------
If your device supports banging arbitrary values on the MII bus (pretty much If your device supports banging arbitrary values on the MII bus (pretty much
every device does), you should add support for the mii command. Doing so is every device does), you should add support for the mii command. Doing so is
@ -193,7 +193,7 @@ should logically follow.
................................................................ ................................................................
Legacy network drivers Legacy network drivers
------------------------ ----------------------
!!! WARNING !!! !!! WARNING !!!
@ -221,7 +221,7 @@ instructions on how to port this over. For the records, the old way of
initialising a network driver is as follows: initialising a network driver is as follows:
Old network driver registration Old network driver registration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When U-Boot initializes, it will call the common function eth_initialize(). When U-Boot initializes, it will call the common function eth_initialize().
This will in turn call the board-specific board_eth_init() (or if that fails, This will in turn call the board-specific board_eth_init() (or if that fails,

2
doc/develop/driver-model/migration.rst
View file

@ -100,7 +100,7 @@ Maintainers should submit patches switching over to using CONFIG_DM_I2C and
other base driver model options in time for inclusion in the 2021.10 release. other base driver model options in time for inclusion in the 2021.10 release.
CFG_SYS_TIMER_RATE and CFG_SYS_TIMER_COUNTER CFG_SYS_TIMER_RATE and CFG_SYS_TIMER_COUNTER
-------------------------------------------------- --------------------------------------------
Deadline: 2023.01 Deadline: 2023.01
These are legacy options which have been replaced by driver model. These are legacy options which have been replaced by driver model.

8
doc/develop/driver-model/nvmxip.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+ .. SPDX-License-Identifier: GPL-2.0+
NVM XIP Block Storage Emulation Driver NVM XIP Block Storage Emulation Driver
======================================= ======================================
Summary Summary
------- -------
@ -54,12 +54,12 @@ The NVMXIP Uclass provides the following drivers:
The implementation is generic and can be used by different platforms. The implementation is generic and can be used by different platforms.
Supported hardware Supported hardware
-------------------------------- ------------------
Any plaform supporting readq(). Any plaform supporting readq().
Configuration Configuration
---------------------- -------------
config NVMXIP config NVMXIP
This option allows the emulation of a block storage device This option allows the emulation of a block storage device
@ -77,7 +77,7 @@ config NVMXIP_QSPI
write their own driver (same as nvmxip_qspi in addition to the custom settings). write their own driver (same as nvmxip_qspi in addition to the custom settings).
Device Tree nodes Device Tree nodes
-------------------- -----------------
Multiple QSPI XIP flash devices can be used at the same time by describing them through DT Multiple QSPI XIP flash devices can be used at the same time by describing them through DT
nodes. nodes.

2
doc/develop/driver-model/spi-howto.rst
View file

@ -218,7 +218,7 @@ DM tells you. The name is not quite right. So in this case we would use:
Write of_to_plat() [for device tree only] Write of_to_plat() [for device tree only]
------------------------------------------------- -----------------------------------------
This method will convert information in the device tree node into a C This method will convert information in the device tree node into a C
structure in your driver (called platform data). If you are not using structure in your driver (called platform data). If you are not using

2
doc/develop/falcon.rst
View file

@ -220,7 +220,7 @@ setting the GPIO (on twister GPIO 55 is used) to kernel mode.
The kernel is loaded directly by the SPL without passing through U-Boot. The kernel is loaded directly by the SPL without passing through U-Boot.
Example with FDT: a3m071 board Example with FDT: a3m071 board
------------------------------- ------------------------------
To boot the Linux kernel from the SPL, the DT blob (fdt) needs to get To boot the Linux kernel from the SPL, the DT blob (fdt) needs to get
prepared/patched first. U-Boot usually inserts some dynamic values into prepared/patched first. U-Boot usually inserts some dynamic values into

2
doc/usage/cmd/askenv.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+: .. SPDX-License-Identifier: GPL-2.0+:
askenv command askenv command
=============== ==============
Synopsis Synopsis
-------- --------

4
doc/usage/cmd/bootdev.rst
View file

@ -76,7 +76,7 @@ name is provided, all hunters are run.
bootdev select bootdev select
~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Use this to select a particular bootdev. You can select it by the sequence Use this to select a particular bootdev. You can select it by the sequence
number or name, as shown in `bootdev list`. number or name, as shown in `bootdev list`.
@ -89,7 +89,7 @@ unselected.
bootdev info bootdev info
~~~~~~~~~~~~~~~ ~~~~~~~~~~~~
This shows information on the current bootdev, with the format looking like This shows information on the current bootdev, with the format looking like
this: this:

2
doc/usage/cmd/cat.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+: .. SPDX-License-Identifier: GPL-2.0+:
cat command cat command
=============== ===========
Synopsis Synopsis
-------- --------

2
doc/usage/cmd/coninfo.rst
View file

@ -21,7 +21,7 @@ environment variables stdin, stdout, stderr which contain a comma separated
list of device names. list of device names.
Example Example
-------- -------
.. code-block:: console .. code-block:: console

2
doc/usage/cmd/mmc.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+: .. SPDX-License-Identifier: GPL-2.0+:
mmc command mmc command
============ ===========
Synopsis Synopsis
-------- --------

2
doc/usage/cmd/part.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+: .. SPDX-License-Identifier: GPL-2.0+:
part command part command
=============== ============
Synopis Synopis
------- -------

2
doc/usage/cmd/wdt.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+: .. SPDX-License-Identifier: GPL-2.0+:
wdt command wdt command
============ ===========
Synopsis Synopsis
-------- --------

2
doc/usage/cmd/xxd.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+: .. SPDX-License-Identifier: GPL-2.0+:
xxd command xxd command
=============== ===========
Synopsis Synopsis
-------- --------

2
doc/usage/fit/beaglebone_vboot.rst
View file

@ -86,7 +86,7 @@ c. You will now have a U-Boot image::
Step 2: Build Linux Step 2: Build Linux
-------------------- -------------------
a. Find the kernel image ('Image') and device tree (.dtb) file you plan to a. Find the kernel image ('Image') and device tree (.dtb) file you plan to
use. In our case it is am335x-boneblack.dtb and it is built with the kernel. use. In our case it is am335x-boneblack.dtb and it is built with the kernel.

4
doc/usage/measured_boot.rst
View file

@ -1,7 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+ .. SPDX-License-Identifier: GPL-2.0+
Measured Boot Measured Boot
===================== =============
U-Boot can perform a measured boot, the process of hashing various components U-Boot can perform a measured boot, the process of hashing various components
of the boot process, extending the results in the TPM and logging the of the boot process, extending the results in the TPM and logging the
@ -16,7 +16,7 @@ TPM PCRs match the contents of the event log. This can further be checked
against the hash results of previous boots. against the hash results of previous boots.
Requirements Requirements
--------------------- ------------
* A hardware TPM 2.0 supported by the U-Boot drivers * A hardware TPM 2.0 supported by the U-Boot drivers
* CONFIG_TPM=y * CONFIG_TPM=y

2
tools/binman/entries.rst
View file

@ -1,5 +1,5 @@
Binman Entry Documentation Binman Entry Documentation
=========================== ==========================
This file describes the entry types supported by binman. These entry types can This file describes the entry types supported by binman. These entry types can
be placed in an image one by one to build up a final firmware image. It is be placed in an image one by one to build up a final firmware image. It is