mirrors/u-boot
1
0
Fork 0
mirror of https://source.denx.de/u-boot/u-boot.git synced 2026-05-05 20:56:12 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation:

Browse Source 
* Update netconsole examples mentioning stderr.
 * Describe what an "fpga" image is in FIT files.
 * process.rst: Document device tree resync rules.
 -----BEGIN PGP SIGNATURE-----
 
 iQIzBAABCAAdFiEEK7wKXt3/btL6/yA+hO4vgnE3U0sFAmZhZvUACgkQhO4vgnE3
 U0sokBAAlRiCKK0WsHYEO6/RQhAUKX31myw7U8ZlWJbkx/ohlNlq2alb7P+VuRWQ
 OGaGSmJLJp2/9CDqqMkHoskNPwDoLuBzOgIupOxuTygQgD7Yz7mO3sVtbyvkT3dW
 Yt5uWJVqlcO2Pul9n8g171asLrJ9z3zHUPugjJTVVQOejgZdtEGAE0ppielHYsSJ
 FfMBtH2mEhzeKecgCVh/QIbYx3CNW5MUA/yc5n6PhoSMALY5VxuFlNYVEUe0NB01
 uO5zdirj6V3QNaf2oyCPLToC6prHKQzURnLX/+Xj3B3YuONA2gLW+d8858Gel9bQ
 8s2QmuYGNgsekKZbLgGjsK0cSlaxEoHkVTdMkokCnNuXvPsqdIo1XjK7kEaaUUhF
 lPdhX5feSlmlSIt9t7vMSazi16birmpYDLUTmkpYYHt82OY9DWHHyI6+6bdw8JWq
 yKD2a2XSY17vh0sFSJSJbbxfKdTQy1VgU4LRtNdM1xk/l9YSl0RdMvZxKb+oXhGU
 D3Jt4WRpKFlQElBdzxkFGHVtTvm/mhFXXPNZPHyDzfPHj0T4qZGiAQITnZrn2Jyx
 N7s0evUp9oy4+BRUPQJE/cjZg4hv7yeI4+gbByUjRNo9CRm6yLmz3hNp+eeABoDn
 u5yMO2sS17AIk3bvhnqsX/fbwUeP0CrkwhbuNNyiD1ezZazA1lQ=
 =SVyE
 -----END PGP SIGNATURE-----

Merge tag 'doc-2024-07-rc5' of https://source.denx.de/u-boot/custodians/u-boot-efi

Documentation:

* Update netconsole examples mentioning stderr.
* Describe what an "fpga" image is in FIT files.
* process.rst: Document device tree resync rules.
This commit is contained in:
Tom Rini 2024-06-06 08:22:43 -06:00
commit d908143b2b
4 changed files with 82 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/develop/devicetree/control.rst
View File

@ -113,9 +113,12 @@ SoC being used via Kconfig and set `DEFAULT_DEVICE_TREE=<vendor>/<name>` when
prompted by Kconfig.
However, if `dts/upstream/` hasn't yet received devicetree source file for your
newly added board support then you can add corresponding devicetree source file
as `arch/<arch>/dts/<name>.dts`. To select that add `# CONFIG_OF_UPSTREAM is not
set` and set `DEFAULT_DEVICE_TREE=<name>` when prompted by Kconfig.
newly added board support then one option is that you can add the corresponding
devicetree source file as `arch/<arch>/dts/<name>.dts`. To select that add `#
CONFIG_OF_UPSTREAM is not set` and set `DEFAULT_DEVICE_TREE=<name>` when
prompted by Kconfig. Another option is that you can use use the "pick" option of
`dts/update-dts-subtree.sh` mentioned above to bring in the commits that you
need.
This should include your CPU or SoC's devicetree file. On top of that any U-Boot
specific tweaks (see: :ref:`dttweaks`) can be made for your board.

21
doc/develop/process.rst
View File

@ -34,7 +34,7 @@ It is followed by a *Stabilization Period*.
The end of a Release Cycle is marked by the release of a new U-Boot version.
Merge Window
------------
^^^^^^^^^^^^
The Merge Window is the period when new patches get submitted (and hopefully
accepted) for inclusion into U-Boot mainline. This period lasts for 21 days (3
@ -44,7 +44,7 @@ This is the only time when new code (like support for new processors or new
boards, or other new features or reorganization of code) is accepted.
Twilight Time
-------------
^^^^^^^^^^^^^
Usually patches do not get accepted as they are - the peer review that takes
place will usually require changes and resubmissions of the patches before they
@ -65,13 +65,13 @@ the Merge Window does not preclude patches that were already posted from being
merged for the upcoming release.
Stabilization Period
--------------------
^^^^^^^^^^^^^^^^^^^^
During the Stabilization Period only patches containing bug fixes get
applied.
Corner Cases
------------
^^^^^^^^^^^^
Sometimes it is not clear if a patch contains a bug fix or not.
For example, changes that remove dead code, unused macros etc. or
@ -108,6 +108,19 @@ Differences to the Linux Development Process
In U-Boot, ``"-rc1"`` will only be released after all (or at least most of
the) patches that were submitted during the merge window have been applied.
Resyncing of the device tree subtree
------------------------------------
As explained in :doc:`devicetree/control` some platforms make use of device tree
files which come from a git subtree that mirrors the Linux Kernel sources
itself. For our purposes, we only track releases and not release candidates for
merging in our tree. These merges follow the normal merge window rules.
In the case of specific changes, such as bug fixes or new platform support,
these can be "cherry-picked" and are subject to the normal merge rules. For
example, a bug fix can come in later in the window but a full re-sync only
happens within the merge window itself.
.. _custodians:
Custodians

28
doc/usage/fit/source_file_format.rst
View File

@ -192,13 +192,13 @@ type
invalid Invalid Image
aisimage Davinci AIS image
atmelimage ATMEL ROM-Boot Image
copro Coprocessor Image}
copro Coprocessor Image
fdt_legacy legacy Image with Flat Device Tree
filesystem Filesystem Image
firmware Firmware
firmware_ivt Firmware with HABv4 IVT }
firmware_ivt Firmware with HABv4 IVT
flat_dt Flat Device Tree
fpga FPGA Image }
fpga FPGA Device Image (bitstream file, vendor specific)
gpimage TI Keystone SPL Image
imx8image NXP i.MX8 Boot Image
imx8mimage NXP i.MX8M Boot Image
@ -207,31 +207,31 @@ type
kernel_noload Kernel Image (no loading done)
kwbimage Kirkwood Boot Image
lpc32xximage LPC32XX Boot Image
mtk_image MediaTek BootROM loadable Image }
mtk_image MediaTek BootROM loadable Image
multi Multi-File Image
mxsimage Freescale MXS Boot Image
omapimage TI OMAP SPL With GP CH
pblimage Freescale PBL Boot Image
pmmc TI Power Management Micro-Controller Firmware
ramdisk RAMDisk Image
rkimage Rockchip Boot Image }
rksd Rockchip SD Boot Image }
rkspi Rockchip SPI Boot Image }
rkimage Rockchip Boot Image
rksd Rockchip SD Boot Image
rkspi Rockchip SPI Boot Image
script Script
socfpgaimage Altera SoCFPGA CV/AV preloader
socfpgaimage_v1 Altera SoCFPGA A10 preloader
spkgimage Renesas SPKG Image }
spkgimage Renesas SPKG Image
standalone Standalone Program
stm32image STMicroelectronics STM32 Image }
sunxi_egon Allwinner eGON Boot Image }
sunxi_toc0 Allwinner TOC0 Boot Image }
stm32image STMicroelectronics STM32 Image
sunxi_egon Allwinner eGON Boot Image
sunxi_toc0 Allwinner TOC0 Boot Image
tee Trusted Execution Environment Image
ublimage Davinci UBL image
vybridimage Vybrid Boot Image
x86_setup x86 setup.bin
zynqimage Xilinx Zynq Boot Image }
zynqmpbif Xilinx ZynqMP Boot Image (bif) }
zynqmpimage Xilinx ZynqMP Boot Image }
zynqimage Xilinx Zynq Boot Image
zynqmpbif Xilinx ZynqMP Boot Image (bif)
zynqmpimage Xilinx ZynqMP Boot Image
==================== ==================
compression

55
doc/usage/netconsole.rst
View File

@ -3,10 +3,10 @@ Network console
In U-Boot, we implemented the networked console via the standard
"devices" mechanism, which means that you can switch between the
serial and network input/output devices by adjusting the 'stdin' and
'stdout' environment variables. To switch to the networked console,
set either of these variables to "nc". Input and output can be
switched independently.
serial and network input/output devices by adjusting the 'stdin',
'stdout', and 'stderr' environment variables. To switch to the
networked console, set either of these variables to "nc". Input and
output can be switched independently.
The default buffer size can be overridden by setting
CFG_NETCONSOLE_BUFFER_SIZE.
@ -18,14 +18,18 @@ broadcast address and port 6666 are used. If it is set to an IP
address of 0 (or 0.0.0.0) then no messages are sent to the network.
The source / listening port can be configured separately by setting
the 'ncinport' environment variable and the destination port can be
configured by setting the 'ncoutport' environment variable.
configured by setting the 'ncoutport' environment variable. Note that
you need to set up the network interface (e.g. using DHCP) before it
can be used for network console.
For example, if your server IP is 192.168.1.1, you could use::
For example, if your server IP is 192.168.1.1, you could use:
=> setenv nc 'setenv stdout nc;setenv stdin nc'
=> setenv ncip 192.168.1.1
=> saveenv
=> run nc
.. prompt:: bash =>
env set nc 'env set stdout nc; env set stderr nc; env set stdin nc'
env set ncip '192.168.1.1'
env save
run nc
On the host side, please use this script to access the console
@ -107,3 +111,34 @@ as follows:
Note that unlike the U-Boot implementation the Linux netconsole is
unidirectional, i. e. you have console output only in Linux.
Setup via environment
---------------------
If persistent environment is enabled in your U-Boot configuration, you
can configure the network console using the environment. For example:
.. prompt:: bash =>
env set autoload no
env set hostname "u-boot"
env set bootdelay 5
env set nc 'dhcp; env set stdout nc; env set stderr nc; env set stdin nc'
env set ncip '192.168.1.1'
env set preboot "${preboot}; run nc;"
env save
reset
``autoload no`` tells the ``dhcp`` command to configure the network
interface without trying to load an image. ``hostname "u-boot"`` sets
the hostname to be sent in DHCP requests, so they are easy to
recognize in the DHCP server log. The command in ``nc`` calls ``dhcp``
to make sure the network interface is set up before enabling
netconsole.
Adding ``nc`` to ``preboot`` tells U-Boot to activate netconsole
before trying to find any boot options, so you can interact with it if
desired.
``env save`` stores the settings persistently, and ``reset`` then
triggers a fresh start that will use the changed settings.