[issue #12] doc: adding description of lm32-vuart tool

e68e34eb · Grzegorz Daniluk · dcbf5ebb · e68e34eb
Commit e68e34eb authored Jun 10, 2020 by Grzegorz Daniluk
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 1 deletion

wrs-user-manual.in doc/wrs-user-manual.in +8 -1

No files found.
--- a/doc/wrs-user-manual.in
+++ b/doc/wrs-user-manual.in
@@ -2472,6 +2472,13 @@ The following tools and scripts are provided:

 @table @file

+@item lm32-vuart
+	The tool allows connecting to the virtual UART of the LM32 soft-core CPU.
+	It can be used to observe log messages from the SoftPLL (the same as
+	@i{FPGA Test}
+	physical UART port available in the back of a WR switch). Use
+	@code{Ctrl+C} escape combination to go back to WR Switch Linux shell.
+
 @item load-virtex
 @itemx load-lm32

@@ -2619,7 +2626,7 @@ The following tools and scripts are provided:
 	information, please refer to the
 	@ref{Configuration Items that Apply at Run Time}.

-@c FIXME: document lm32-vuart rtu_stat spll_dbg_proxy
+@c FIXME: document rtu_stat spll_dbg_proxy
 @end table

 @c --------------------------------------------------------------------------