jtag_libusb_bulk_read|write: return error code instead of size
[fw/openocd] / src / jtag / drivers / libusb0_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_LIBUSB0_COMMON_H
21 #define OPENOCD_JTAG_DRIVERS_LIBUSB0_COMMON_H
22
23 #include <usb.h>
24
25 #define jtag_libusb_device                      usb_device
26 #define jtag_libusb_device_handle               usb_dev_handle
27 #define jtag_libusb_device_descriptor           usb_device_descriptor
28 #define jtag_libusb_interface                   usb_interface
29 #define jtag_libusb_interface_descriptor        usb_interface_descriptor
30 #define jtag_libusb_endpoint_descriptor         usb_endpoint_descriptor
31 #define jtag_libusb_config_descriptor           usb_config_descriptor
32
33 #define jtag_libusb_reset_device(dev)           usb_reset(dev)
34 #define jtag_libusb_get_device(devh)            usb_device(devh)
35
36 /* make some defines compatible to libusb1 */
37 #define LIBUSB_REQUEST_TYPE_VENDOR              USB_TYPE_VENDOR
38 #define LIBUSB_RECIPIENT_DEVICE                 USB_RECIP_DEVICE
39 #define LIBUSB_ENDPOINT_OUT                             USB_ENDPOINT_OUT
40 #define LIBUSB_ENDPOINT_IN                              USB_ENDPOINT_IN
41 #define LIBUSB_TRANSFER_TYPE_BULK               USB_ENDPOINT_TYPE_BULK
42
43 static inline int jtag_libusb_claim_interface(jtag_libusb_device_handle *devh,
44                                        int iface)
45 {
46         return usb_claim_interface(devh, iface);
47 };
48
49 static inline int jtag_libusb_release_interface(jtag_libusb_device_handle *devh,
50                                        int iface)
51 {
52         return usb_release_interface(devh, iface);
53 }
54
55 int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
56                 const char *serial,
57                 struct jtag_libusb_device_handle **out);
58 void jtag_libusb_close(jtag_libusb_device_handle *dev);
59 int jtag_libusb_control_transfer(jtag_libusb_device_handle *dev,
60                 uint8_t requestType, uint8_t request, uint16_t wValue,
61                 uint16_t wIndex, char *bytes,   uint16_t size, unsigned int timeout);
62 int jtag_libusb_bulk_write(struct jtag_libusb_device_handle *dev, int ep,
63                 char *bytes, int size, int timeout, int *transferred);
64 int jtag_libusb_bulk_read(struct jtag_libusb_device_handle *dev, int ep,
65                 char *bytes, int size, int timeout, int *transferred);
66 int jtag_libusb_set_configuration(jtag_libusb_device_handle *devh,
67                 int configuration);
68 int jtag_libusb_choose_interface(struct jtag_libusb_device_handle *devh,
69                 unsigned int *usb_read_ep,
70                 unsigned int *usb_write_ep,
71                 int bclass, int subclass, int protocol, int trans_type);
72 int jtag_libusb_get_pid(struct jtag_libusb_device *dev, uint16_t *pid);
73
74 #endif /* OPENOCD_JTAG_DRIVERS_LIBUSB0_COMMON_H */