From d0253f7e5ca1e1d79a6c42aea330cb9e2355211a Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sat, 12 Dec 2020 09:37:47 +0100 Subject: [PATCH] doc: move README.NetConsole to HTML documentation Convert README.NetConsole to reStructured text and move it to doc/usage/netconsole.rst. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- doc/usage/index.rst | 2 + .../netconsole.rst} | 54 +++++++++++-------- 2 files changed, 35 insertions(+), 21 deletions(-) rename doc/{README.NetConsole => usage/netconsole.rst} (79%) diff --git a/doc/usage/index.rst b/doc/usage/index.rst index af7d50650d..063e970981 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -3,6 +3,8 @@ Use U-Boot .. toctree:: + netconsole + Shell commands -------------- diff --git a/doc/README.NetConsole b/doc/usage/netconsole.rst similarity index 79% rename from doc/README.NetConsole rename to doc/usage/netconsole.rst index af7fc6043a..0156f0212d 100644 --- a/doc/README.NetConsole +++ b/doc/usage/netconsole.rst @@ -1,3 +1,5 @@ +Network console +=============== In U-Boot, we implemented the networked console via the standard "devices" mechanism, which means that you can switch between the @@ -6,7 +8,8 @@ serial and network input/output devices by adjusting the 'stdin' and set either of these variables to "nc". Input and output can be switched independently. -CONFIG_NETCONSOLE_BUFFER_SIZE - Override the default buffer size +The default buffer size can be overridden by setting +CONFIG_NETCONSOLE_BUFFER_SIZE. We use an environment variable 'ncip' to set the IP address and the port of the destination. The format is :. If is @@ -17,15 +20,16 @@ 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. -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 +On the host side, please use this script to access the console -On the host side, please use this script to access the console: +.. code-block:: bash tools/netconsole [port] @@ -54,31 +58,37 @@ file for the original Ingo Molnar's documentation on how to pass parameters to the loadable module. The format of the kernel command line parameter (for the static -configuration) is as follows: +configuration) is as follows - netconsole=[src-port]@[src-ip]/[],[tgt-port]@/[tgt-macaddr] +.. code-block:: bash + + netconsole=[src-port]@[src-ip]/[],[tgt-port]@/[tgt-macaddr] where - src-port source for UDP packets - (defaults to 6665) - src-ip source IP to use - (defaults to the interface's address) - dev network interface - (defaults to eth0) - tgt-port port for logging agent - (defaults to 6666) - tgt-ip IP address for logging agent - (this is the required parameter) - tgt-macaddr ethernet MAC address for logging agent - (defaults to broadcast) - -Examples: +src-port + source for UDP packets (defaults to 6665) - netconsole=4444@10.0.0.1/eth1,9353@10.0.0.2/12:34:56:78:9a:bc +src-ip + source IP to use (defaults to the interface's address) + +dev + network interface (defaults to eth0) + +tgt-port + port for logging agent (defaults to 6666) + +tgt-ip + IP address for logging agent (this is the required parameter) -or +tgt-macaddr + ethernet MAC address for logging agent (defaults to broadcast) +Examples + +.. code-block:: bash + + netconsole=4444@10.0.0.1/eth1,9353@10.0.0.2/12:34:56:78:9a:bc netconsole=@/,@192.168.3.1/ Please note that for the Linux networked console to work, the @@ -91,6 +101,8 @@ in the ELDK-NFS-based environment. To browse the Linux network console output, use the 'netcat' tool invoked as follows: +.. code-block:: bash + nc -u -l -p 6666 Note that unlike the U-Boot implementation the Linux netconsole is -- 2.39.5