drivers/am335xgpio: Add AM335x driver for bitbang support on BeagleBones

[fw/openocd] / src / jtag / drivers / libusb_helper.h

diff --git a/src/jtag/drivers/libusb_helper.h b/src/jtag/drivers/libusb_helper.h
index 46e4954e7895d282fe999ef28f0565fa6f9a22c4..9d51464a7f5dca89233535056a4b9811582d8ead 100644 (file)
--- a/src/jtag/drivers/libusb_helper.h
+++ b/src/jtag/drivers/libusb_helper.h
@@ -22,13 +22,32 @@
 
 #include <libusb.h>
 
+/* When we debug a target that works as a USB device, halting the target causes the
+ * USB communication with the USB host to become unresponsive. The host will try
+ * to reconnect/reset/setup the unresponsive device during which communication
+ * with other devices on the same USB bus can get stalled for several seconds.
+ * If the JTAG adapter is on the same bus, we need to make sure openOCD will wait
+ * for packets at least as long as the host USB stack. Otherwise the USB stack
+ * might deliver a valid packet, but openOCD would ignore it due to the timeout.
+ * The xHCI spec uses 5 sec timeouts, so let's use that in openOCD with some margin.
+ *
+ * Use this value in all libusb calls. HID API might have a libusb backend and
+ * would probably be victim to the same bug, so it should use this timeout, too.
+ */
+#define LIBUSB_TIMEOUT_MS      (6000)
+
+/* this callback should return a non NULL value only when the serial could not
+ * be retrieved by the standard 'libusb_get_string_descriptor_ascii' */
+typedef char * (*adapter_get_alternate_serial_fn)(struct libusb_device_handle *device,
+               struct libusb_device_descriptor *dev_desc);
+
 int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
-               const char *serial,
-               struct libusb_device_handle **out);
+               struct libusb_device_handle **out,
+               adapter_get_alternate_serial_fn adapter_get_alternate_serial);
 void jtag_libusb_close(struct libusb_device_handle *dev);
 int jtag_libusb_control_transfer(struct libusb_device_handle *dev,
-               uint8_t requestType, uint8_t request, uint16_t wValue,
-               uint16_t wIndex, char *bytes,   uint16_t size, unsigned int timeout);
+               uint8_t request_type, uint8_t request, uint16_t value,
+               uint16_t index, char *bytes, uint16_t size, unsigned int timeout);
 int jtag_libusb_bulk_write(struct libusb_device_handle *dev, int ep,
                char *bytes, int size, int timeout, int *transferred);
 int jtag_libusb_bulk_read(struct libusb_device_handle *dev, int ep,
@@ -54,5 +73,6 @@ int jtag_libusb_choose_interface(struct libusb_device_handle *devh,
                unsigned int *usb_write_ep,
                int bclass, int subclass, int protocol, int trans_type);
 int jtag_libusb_get_pid(struct libusb_device *dev, uint16_t *pid);
+int jtag_libusb_handle_events_completed(int *completed);
 
 #endif /* OPENOCD_JTAG_DRIVERS_LIBUSB_HELPER_H */