Remove since long deprecated ft2232 driver
[openocd.git] / src / jtag / drivers / libusb1_common.h
1 /***************************************************************************
2 * Copyright (C) 2009 by Zachary T Welch <zw@superlucidity.net> *
3 * *
4 * Copyright (C) 2011 by Mauro Gamba <maurillo71@gmail.com> *
5 * *
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. *
10 * *
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. *
15 * *
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 ***************************************************************************/
19
20 #ifndef OPENOCD_JTAG_DRIVERS_LIBUSB1_COMMON_H
21 #define OPENOCD_JTAG_DRIVERS_LIBUSB1_COMMON_H
22
23 #include <libusb.h>
24
25 #define jtag_libusb_device libusb_device
26 #define jtag_libusb_device_handle libusb_device_handle
27 #define jtag_libusb_device_descriptor libusb_device_descriptor
28 #define jtag_libusb_interface libusb_interface
29 #define jtag_libusb_interface_descriptor libusb_interface_descriptor
30 #define jtag_libusb_endpoint_descriptor libusb_endpoint_descriptor
31 #define jtag_libusb_config_descriptor libusb_config_descriptor
32
33 #define jtag_libusb_reset_device(dev) libusb_reset_device(dev)
34 #define jtag_libusb_get_device(devh) libusb_get_device(devh)
35
36 static inline int jtag_libusb_claim_interface(jtag_libusb_device_handle *devh,
37 int iface)
38 {
39 return libusb_claim_interface(devh, iface);
40 };
41
42 static inline int jtag_libusb_release_interface(jtag_libusb_device_handle *devh,
43 int iface)
44 {
45 return libusb_release_interface(devh, iface);
46 }
47
48 int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
49 const char *serial,
50 struct jtag_libusb_device_handle **out);
51 void jtag_libusb_close(jtag_libusb_device_handle *dev);
52 int jtag_libusb_control_transfer(jtag_libusb_device_handle *dev,
53 uint8_t requestType, uint8_t request, uint16_t wValue,
54 uint16_t wIndex, char *bytes, uint16_t size, unsigned int timeout);
55 int jtag_libusb_bulk_write(struct jtag_libusb_device_handle *dev, int ep,
56 char *bytes, int size, int timeout);
57 int jtag_libusb_bulk_read(struct jtag_libusb_device_handle *dev, int ep,
58 char *bytes, int size, int timeout);
59 int jtag_libusb_set_configuration(jtag_libusb_device_handle *devh,
60 int configuration);
61 /**
62 * Find the first interface optionally matching class, subclass and
63 * protocol and claim it.
64 * @param devh _libusb_ device handle.
65 * @param usb_read_ep A pointer to a variable where the _IN_ endpoint
66 * number will be stored.
67 * @param usb_write_ep A pointer to a variable where the _OUT_ endpoint
68 * number will be stored.
69 * @param bclass `bInterfaceClass` to match, or -1 to ignore this field.
70 * @param subclass `bInterfaceSubClass` to match, or -1 to ignore this field.
71 * @param protocol `bInterfaceProtocol` to match, or -1 to ignore this field.
72 * @returns Returns ERROR_OK on success, ERROR_FAIL otherwise.
73 */
74 int jtag_libusb_choose_interface(struct jtag_libusb_device_handle *devh,
75 unsigned int *usb_read_ep,
76 unsigned int *usb_write_ep,
77 int bclass, int subclass, int protocol);
78 int jtag_libusb_get_pid(struct jtag_libusb_device *dev, uint16_t *pid);
79
80 #endif /* OPENOCD_JTAG_DRIVERS_LIBUSB1_COMMON_H */