From: Oleksij Rempel <o.rempel@pengutronix.de>
Date: Fri, 16 Nov 2018 07:56:25 +0000 (+0100)
Subject: doc: add documentation for "adapter usb location" command
X-Git-Tag: v0.11.0-rc1~843
X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff_plain;h=20ceec69a2ca038847c6b4cf604f0b79cc004ba7

doc: add documentation for "adapter usb location" command

Change-Id: Ia3fbe0c3894b1b96464bbfda5d4101123827b761
Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
Reviewed-on: http://openocd.zylin.com/4769
Tested-by: jenkins
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
---

diff --git a/doc/openocd.texi b/doc/openocd.texi
index 6c6dc9ca71..7f3a7ade10 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -2368,6 +2368,16 @@ the hardware can support.
 Returns the name of the debug adapter driver being used.
 @end deffn
 
+@deffn Command {adapter usb location} <bus>:<port>[.<port>]...
+Specifies the physical USB port of the adapter to use. The path
+roots at @var{bus} and walks down the physical ports, with each
+@var{port} option specifying a deeper level in the bus topology, the last
+@var{port} denoting where the target adapter is actually plugged.
+The USB bus topology can be queried with the command @emph{lsusb -t} or @emph{dmesg}.
+
+This command is only available if your libusb1 is at least version 1.0.16.
+@end deffn
+
 @section Interface Drivers
 
 Each of the interface drivers listed here must be explicitly