Use picocom to read serial in misc/xhcidbg-log
[libxhcidbg.git] / README.md
index 9da849b7e3909e605e8220d6e23686a82ca8d88f..a38b2b25b8cddcfea39a06808d25f24b314549a9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,17 +34,9 @@ The debug capability should be visible as:
 For convenience, the `xhcidbc-log` shell script in the `misc/` directory
 can be used to gather debug output from the device. It uses the
 `inotifywait` utility (part of [*inotify-tools*][2]) to wait for the
-device to be created and then display the output using `cat`. Either
-execute the script as root or make sure the user has the necessary
-access rights, e.g. is member of the `dialout` group.
-
-If there is no visible console output despite the serial device being present,
-the tty setting may be incorrect. Issue the following command to adjust the
-parameters:
-
-    $ stty -F /dev/serial/by-id/usb-secunet_HW.DbC_1-if00-port0 raw -echo
-
-`stty` is part of the [*coreutils* software collection][3].
+device to be created and then displays the output using `picocom`.
+Either execute the script as root or make sure the user has the
+necessary access rights, e.g. is member of the `dialout` group.
 
 ## BIOS considerations
 
@@ -54,6 +46,9 @@ or Broadwell, the BIOS option *USB 3.0 Mode* **must** be set to
 controller and thus no connected device will be recognized during
 initialization.
 
+If your BIOS has a "USB charging mode" configuration option, it is recommended
+to turn this feature off.
+
 ## ModemManager considerations
 
 The ModemManager service may interact with the USB serial device created by the
@@ -63,4 +58,3 @@ debugging capability. To avoid any interference, the service should be stopped:
 
 [1]: https://www-ssl.intel.com/content/www/us/en/io/universal-serial-bus/extensible-host-controler-interface-usb-xhci.html
 [2]: https://github.com/rvoicilas/inotify-tools/wiki
-[3]: https://www.gnu.org/software/coreutils/