aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorOleksij Rempel <o.rempel@pengutronix.de>2018-11-16 08:56:25 +0100
committerMatthias Welwarsky <matthias@welwarsky.de>2019-02-07 09:04:59 +0000
commit20ceec69a2ca038847c6b4cf604f0b79cc004ba7 (patch)
tree206810685a364251e8bf264289f785a08049c7f2 /doc
parent9f021c2bc129f8f7c659c64ad19531bd8073264a (diff)
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index 6c6dc9ca..7f3a7ade 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