f0d8c3b0e0
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. Ticket: https://sourceforge.net/p/openocd/tickets/343/ Signed-off-by: Gabor Csapo <gaborcsapo@google.com> Change-Id: Ia3dc1356e676fe550f57a4c72f7a24ba296b6af2 Reviewed-on: https://review.openocd.org/c/openocd/+/6882 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
79 lines
4.4 KiB
C
79 lines
4.4 KiB
C
/***************************************************************************
|
|
* Copyright (C) 2009 by Zachary T Welch <zw@superlucidity.net> *
|
|
* *
|
|
* Copyright (C) 2011 by Mauro Gamba <maurillo71@gmail.com> *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* This program is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
|
|
***************************************************************************/
|
|
|
|
#ifndef OPENOCD_JTAG_DRIVERS_LIBUSB_HELPER_H
|
|
#define OPENOCD_JTAG_DRIVERS_LIBUSB_HELPER_H
|
|
|
|
#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[],
|
|
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 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,
|
|
char *bytes, int size, int timeout, int *transferred);
|
|
int jtag_libusb_set_configuration(struct libusb_device_handle *devh,
|
|
int configuration);
|
|
/**
|
|
* Find the first interface optionally matching class, subclass and
|
|
* protocol and claim it.
|
|
* @param devh _libusb_ device handle.
|
|
* @param usb_read_ep A pointer to a variable where the _IN_ endpoint
|
|
* number will be stored.
|
|
* @param usb_write_ep A pointer to a variable where the _OUT_ endpoint
|
|
* number will be stored.
|
|
* @param bclass `bInterfaceClass` to match, or -1 to ignore this field.
|
|
* @param subclass `bInterfaceSubClass` to match, or -1 to ignore this field.
|
|
* @param protocol `bInterfaceProtocol` to match, or -1 to ignore this field.
|
|
* @param trans_type `bmAttributes Bits 0..1 Transfer type` to match, or -1 to ignore this field.
|
|
* @returns Returns ERROR_OK on success, ERROR_FAIL otherwise.
|
|
*/
|
|
int jtag_libusb_choose_interface(struct libusb_device_handle *devh,
|
|
unsigned int *usb_read_ep,
|
|
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 */
|