mirror of
https://github.com/u-boot/u-boot.git
synced 2025-05-08 19:11:53 +00:00
Pull request for efi-2023-07-rc1
Documentation: * man-page for coninfo command * documentation style * switch settings for boot modes on AM62 SK UEFI: * avoid using deprecated HandleProtocol() * set static attribute for non-exported functions and variables -----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEbcT5xx8ppvoGt20zxIHbvCwFGsQFAmQxz2YACgkQxIHbvCwF GsTxqw/+L3uDNDa9a5f9M2AX/HIoUtdkmhvLeIrE5NlJufV9razkPRN6uUvYpeeJ YJDkYxEkNZmNmliFagsVJEXjxgQGdEh/P0SLffkX89Bg5u1DhP1Rfx5vf7RcbM77 m54+m4lRiYYi4woq/i7l3jqusSUTX4amDbO/3eIXVmSko61xiu1L4+0Mhe8lYWwo FTGkg2+eOtnZ/u+hmTT+6XXyXkAXCZOjcEc25SnEfA7rtlIyzaJOb2+XPXr8q2nc GMGg9QItTu0aDHarkunuflHpXQ/APs9AtY7Q8pj0Ko2IXvCu2OXFu+mRgquHrNKJ 0koN69Ie2mqt7kzImInu5KtGRli5Vf1M820L5Y//BdvX+emGK3ccx4ywj9+yZQSr qo+ch7hup19sT/g8+wsG3cwYfn6qQyGz73rkSYB2D2ris2o5xoTgOsnyuFFHTQrv Zwj79/DTkgcPUvzCnUkH1sz2HKi/J3h44L5aTVM7bslrJL4AgXzlcssr4cM4ElwT aAUJKfX5AukrIhw2AA6f/FYrdEW5yt8oiNPfIs5x0bYNsWcooMBdE5ZYvqJPy2Mp 2U/dDHYWNbKOFP6od3eyjCHTp4mC1BTiCcVQ9Zhp3T/E/Ehfu65vWHaf1LwcjRFL z44cZGny341WoMZzImgj+ciPWABzbMEWCfb7Indva3tlFVCFZ1U= =bYxY -----END PGP SIGNATURE----- Merge tag 'efi-2023-07-rc1' of https://source.denx.de/u-boot/custodians/u-boot-efi Pull request for efi-2023-07-rc1 Documentation: * man-page for coninfo command * documentation style * switch settings for boot modes on AM62 SK UEFI: * avoid using deprecated HandleProtocol() * set static attribute for non-exported functions and variables
This commit is contained in:
commit
7daa8dd59b
15 changed files with 149 additions and 27 deletions
|
@ -229,3 +229,28 @@ Image formats:
|
|||
| | SPL DTB 1...N | |
|
||||
| +-------------------+ |
|
||||
+-----------------------+
|
||||
|
||||
Switch Setting for Boot Mode
|
||||
----------------------------
|
||||
|
||||
Boot Mode pins provide means to select the boot mode and options before the
|
||||
device is powered up. After every POR, they are the main source to populate
|
||||
the Boot Parameter Tables.
|
||||
|
||||
The following table shows some common boot modes used on AM62 platform. More
|
||||
details can be found in the Technical Reference Manual:
|
||||
https://www.ti.com/lit/pdf/spruiv7 under the `Boot Mode Pins` section.
|
||||
|
||||
*Boot Modes*
|
||||
|
||||
============ ============= =============
|
||||
Switch Label SW2: 12345678 SW3: 12345678
|
||||
============ ============= =============
|
||||
SD 01000000 11000010
|
||||
OSPI 00000000 11001110
|
||||
EMMC 00000000 11010010
|
||||
UART 00000000 11011100
|
||||
USB DFU 00000000 11001010
|
||||
============ ============= =============
|
||||
|
||||
For SW2 and SW1, the switch state in the "ON" position = 1.
|
||||
|
|
3
doc/build/documentation.rst
vendored
3
doc/build/documentation.rst
vendored
|
@ -26,6 +26,9 @@ The *htmldocs* target is used to build the HTML documentation. It uses the
|
|||
# Display the documentation in a graphical web browser
|
||||
x-www-browser doc/output/index.html
|
||||
|
||||
The HTML documentation is published at https://u-boot.readthedocs.io. The build
|
||||
process for that site is controlled by the file *.readthedocs.yml*.
|
||||
|
||||
Infodoc documentation
|
||||
---------------------
|
||||
|
||||
|
|
29
doc/develop/docstyle.rst
Normal file
29
doc/develop/docstyle.rst
Normal file
|
@ -0,0 +1,29 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0+:
|
||||
|
||||
Documentation Style
|
||||
===================
|
||||
|
||||
Documentation is crucial for the U-Boot project. It has to encompass the needs
|
||||
of different reader groups from first time users to developers and maintainers.
|
||||
This requires different types of documentation like tutorials, how-to-guides,
|
||||
explanatory texts, and reference.
|
||||
|
||||
We want to be able to generate documentation in different target formats. We
|
||||
therefore use `Sphinx <https://www.sphinx-doc.org>`_ for the generation of
|
||||
documents from reStructured text.
|
||||
|
||||
We apply the following rules:
|
||||
|
||||
* Documentation files are located in *doc/* or its sub-directories.
|
||||
* Each documentation file is added to an index page to allow navigation
|
||||
to the document.
|
||||
* For documentation we use reStructured text conforming to the requirements
|
||||
of `Sphinx <https://www.sphinx-doc.org>`_.
|
||||
* For documentation within code we follow the Linux kernel guide
|
||||
`Writing kernel-doc comments <https://docs.kernel.org/doc-guide/kernel-doc.html>`_.
|
||||
* We try to stick to 80 columns per line in documents.
|
||||
* For tables we prefer simple tables over grid tables. We avoid list tables
|
||||
as they make the reStructured text documents hard to read.
|
||||
* Before submitting documentation patches we build the HTML documentation and
|
||||
fix all warnings. The build process is described in
|
||||
:doc:`/build/documentation`.
|
|
@ -11,6 +11,7 @@ General
|
|||
|
||||
codingstyle
|
||||
designprinciples
|
||||
docstyle
|
||||
patman
|
||||
process
|
||||
release_cycle
|
||||
|
|
55
doc/usage/cmd/coninfo.rst
Normal file
55
doc/usage/cmd/coninfo.rst
Normal file
|
@ -0,0 +1,55 @@
|
|||
.. SPDX-License-Identifier: GPL-2.0+:
|
||||
|
||||
coninfo command
|
||||
===============
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
::
|
||||
|
||||
coninfo
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
The coninfo command provides a list of available console input and output
|
||||
devices and their assignment as stdin, stdout, stderr console devices.
|
||||
|
||||
If CONFIG_SYS_CONSOLE_IS_IN_ENV=y, the assignment is controlled by the
|
||||
environment variables stdin, stdout, stderr which contain a comma separated
|
||||
list of device names.
|
||||
|
||||
Example
|
||||
--------
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
=> coninfo
|
||||
List of available devices
|
||||
|-- pl011@9000000 (IO)
|
||||
| |-- stdin
|
||||
| |-- stdout
|
||||
| |-- stderr
|
||||
|-- serial (IO)
|
||||
|-- usbkbd (I)
|
||||
=> setenv stdin pl011@9000000,usbkbd
|
||||
=> coninfo
|
||||
List of available devices
|
||||
|-- pl011@9000000 (IO)
|
||||
| |-- stdin
|
||||
| |-- stdout
|
||||
| |-- stderr
|
||||
|-- serial (IO)
|
||||
|-- usbkbd (I)
|
||||
| |-- stdin
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
The coninfo command is only available if CONFIG_CMD_CONSOLE=y.
|
||||
|
||||
Return value
|
||||
------------
|
||||
|
||||
The return value $? is always 0 (true).
|
|
@ -39,6 +39,7 @@ Shell commands
|
|||
cmd/cbsysinfo
|
||||
cmd/cls
|
||||
cmd/cmp
|
||||
cmd/coninfo
|
||||
cmd/conitrace
|
||||
cmd/cyclic
|
||||
cmd/dm
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue