1 /***************************************************************************
2 * Copyright (C) 2009 by Zachary T Welch <zw@superlucidity.net> *
4 * Copyright (C) 2011 by Mauro Gamba <maurillo71@gmail.com> *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. *
18 ***************************************************************************/
20 #ifndef OPENOCD_JTAG_DRIVERS_LIBUSB_HELPER_H
21 #define OPENOCD_JTAG_DRIVERS_LIBUSB_HELPER_H
25 /* this callback should return a non NULL value only when the serial could not
26 * be retrieved by the standard 'libusb_get_string_descriptor_ascii' */
27 typedef char * (*adapter_get_alternate_serial_fn)(struct libusb_device_handle *device,
28 struct libusb_device_descriptor *dev_desc);
30 int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
32 struct libusb_device_handle **out,
33 adapter_get_alternate_serial_fn adapter_get_alternate_serial);
34 void jtag_libusb_close(struct libusb_device_handle *dev);
35 int jtag_libusb_control_transfer(struct libusb_device_handle *dev,
36 uint8_t request_type, uint8_t request, uint16_t value,
37 uint16_t index, char *bytes, uint16_t size, unsigned int timeout);
38 int jtag_libusb_bulk_write(struct libusb_device_handle *dev, int ep,
39 char *bytes, int size, int timeout, int *transferred);
40 int jtag_libusb_bulk_read(struct libusb_device_handle *dev, int ep,
41 char *bytes, int size, int timeout, int *transferred);
42 int jtag_libusb_set_configuration(struct libusb_device_handle *devh,
45 * Find the first interface optionally matching class, subclass and
46 * protocol and claim it.
47 * @param devh _libusb_ device handle.
48 * @param usb_read_ep A pointer to a variable where the _IN_ endpoint
49 * number will be stored.
50 * @param usb_write_ep A pointer to a variable where the _OUT_ endpoint
51 * number will be stored.
52 * @param bclass `bInterfaceClass` to match, or -1 to ignore this field.
53 * @param subclass `bInterfaceSubClass` to match, or -1 to ignore this field.
54 * @param protocol `bInterfaceProtocol` to match, or -1 to ignore this field.
55 * @param trans_type `bmAttributes Bits 0..1 Transfer type` to match, or -1 to ignore this field.
56 * @returns Returns ERROR_OK on success, ERROR_FAIL otherwise.
58 int jtag_libusb_choose_interface(struct libusb_device_handle *devh,
59 unsigned int *usb_read_ep,
60 unsigned int *usb_write_ep,
61 int bclass, int subclass, int protocol, int trans_type);
62 int jtag_libusb_get_pid(struct libusb_device *dev, uint16_t *pid);
63 int jtag_libusb_handle_events_completed(int *completed);
65 #endif /* OPENOCD_JTAG_DRIVERS_LIBUSB_HELPER_H */