diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/board/ti/am62x_sk.rst | 25 | ||||
-rw-r--r-- | doc/build/documentation.rst | 3 | ||||
-rw-r--r-- | doc/develop/docstyle.rst | 29 | ||||
-rw-r--r-- | doc/develop/index.rst | 1 | ||||
-rw-r--r-- | doc/usage/cmd/coninfo.rst | 55 | ||||
-rw-r--r-- | doc/usage/index.rst | 1 |
6 files changed, 114 insertions, 0 deletions
diff --git a/doc/board/ti/am62x_sk.rst b/doc/board/ti/am62x_sk.rst index b1b7d99befb..27d7b527c6a 100644 --- a/doc/board/ti/am62x_sk.rst +++ b/doc/board/ti/am62x_sk.rst @@ -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. diff --git a/doc/build/documentation.rst b/doc/build/documentation.rst index 896264dd7c1..011cd34a57c 100644 --- a/doc/build/documentation.rst +++ b/doc/build/documentation.rst @@ -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 --------------------- diff --git a/doc/develop/docstyle.rst b/doc/develop/docstyle.rst new file mode 100644 index 00000000000..f9ba83a559c --- /dev/null +++ b/doc/develop/docstyle.rst @@ -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`. diff --git a/doc/develop/index.rst b/doc/develop/index.rst index a52ad630d0d..ddbf8dad4a1 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -11,6 +11,7 @@ General codingstyle designprinciples + docstyle patman process release_cycle diff --git a/doc/usage/cmd/coninfo.rst b/doc/usage/cmd/coninfo.rst new file mode 100644 index 00000000000..f913148c44a --- /dev/null +++ b/doc/usage/cmd/coninfo.rst @@ -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). diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 729541bcff5..cdf710919a2 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -39,6 +39,7 @@ Shell commands cmd/cbsysinfo cmd/cls cmd/cmp + cmd/coninfo cmd/conitrace cmd/cyclic cmd/dm |