Menu

Tree [6834f0] master / doc / usb_adapters /
 History

HTTPS access


File Date Author Commit
 angie 2023-12-11 Ahmed BOUDJELIDA Ahmed BOUDJELIDA [b50a8d] jtag/drivers: Add GPIO extender configuration f...
 cmsis_dap 2023-12-10 Antonio Borneo Antonio Borneo [494897] doc: usb_adapters: fix HID report in lsusb dump...
 esp_usb_jtag 2023-01-20 Erhan Kurubas Erhan Kurubas [41231d] doc:usb_adapters: add lsusb dump of esp_usb_jtag
 ft232r 2022-10-22 Antonio Borneo Antonio Borneo [e0059d] doc: usb_adapters: add lsusb dump of few adapters
 ftdi 2022-10-22 Antonio Borneo Antonio Borneo [6d76a9] doc: usb_adapters: add other adapters
 icdi 2022-10-22 Antonio Borneo Antonio Borneo [e0059d] doc: usb_adapters: add lsusb dump of few adapters
 jlink 2022-10-22 Antonio Borneo Antonio Borneo [6d76a9] doc: usb_adapters: add other adapters
 kitprog 2022-10-22 Antonio Borneo Antonio Borneo [6d76a9] doc: usb_adapters: add other adapters
 nulink 2023-12-10 Antonio Borneo Antonio Borneo [494897] doc: usb_adapters: fix HID report in lsusb dump...
 stlink 2023-07-10 Antonio Borneo Antonio Borneo [886d6c] doc:usb_adapters: add lsusb dump of STLINK-V3PWR
 xds110 2023-12-10 Antonio Borneo Antonio Borneo [494897] doc: usb_adapters: fix HID report in lsusb dump...
 dump.sh 2023-12-10 Antonio Borneo Antonio Borneo [b71737] doc: usb_adapters: update the script for unavai...
 readme.txt 2023-01-20 Erhan Kurubas Erhan Kurubas [41231d] doc:usb_adapters: add lsusb dump of esp_usb_jtag

Read Me

# SPDX-License-Identifier: GPL-2.0-or-later OR GFDL-1.2-no-invariants-or-later

This folder contains a collection of dumps of USB descriptors, obtained through
Linux lsusb command, of several USB adapters supported by OpenOCD.
This collection should help maintaining adapter drivers even if the developer
doesn't have access to all the devices supported by the driver.

To add a new file, run:

	./doc/usb_adapters/dump.sh ${vid} ${pid} \
		> doc/usb_adapters/${driver}/${vid}_${pid}_${short_description}.txt

eventually edit the file to add some extra comment, then submit the file to
OpenOCD gerrit, as explained in HACKING.

The dumps are organized in subfolders corresponding to OpenOCD drivers:
- cmsis_dap;
- esp_usb_jtag;
- ft232r;
- ftdi;
- icdi;
- jlink;
- kitprog;
- nulink;
- stlink;
- xds110.

The script above assumes the user has granted access permissions to the USB
device file in
	/dev/bus/usb/<n>/<m>
This is usually the case when the device is listed in
	contrib/60-openocd.rules
and this udev rules file is properly installed in the host machine.
If the user has no proper access permissions, the script has to be run as
root or through 'sudo'.

Old versions of 'lsusb -v' dump cryptic errors like:
	can't get device qualifier: Resource temporarily unavailable
	can't get debug descriptor: Resource temporarily unavailable
when some optional descriptor is not present.
This is fixed in usbutils v014.
If you get such messages simply ignore them. They are printed on stderr, so
will not be included in the generated file as the redirection '>' does only
redirects stdout.
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.