git.sur5r.net Git - openocd/blob - 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, write to the                         *
  18  *   Free Software Foundation, Inc.,                                       *
  19  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  20  ***************************************************************************/
  21
  22 #ifndef JTAG_LIBUSB_COMMON_H
  23 #define JTAG_LIBUSB_COMMON_H
  24
  25 #include <libusb.h>
  26
  27 #define jtag_libusb_device                      libusb_device
  28 #define jtag_libusb_device_handle               libusb_device_handle
  29 #define jtag_libusb_device_descriptor           libusb_device_descriptor
  30 #define jtag_libusb_interface                   libusb_interface
  31 #define jtag_libusb_interface_descriptor        libusb_interface_descriptor
  32 #define jtag_libusb_endpoint_descriptor         libusb_endpoint_descriptor
  33 #define jtag_libusb_config_descriptor           libusb_config_descriptor
  34
  35 #define jtag_libusb_reset_device(dev)           libusb_reset_device(dev)
  36 #define jtag_libusb_get_device(devh)            libusb_get_device(devh)
  37
  38 static inline int jtag_libusb_claim_interface(jtag_libusb_device_handle *devh,
  39                 int iface)
  40 {
  41         return libusb_claim_interface(devh, iface);
  42 };
  43
  44 static inline int jtag_libusb_release_interface(jtag_libusb_device_handle *devh,
  45                 int iface)
  46 {
  47         return libusb_release_interface(devh, iface);
  48 }
  49
  50 int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
  51                 const char *serial,
  52                 struct jtag_libusb_device_handle **out);
  53 void jtag_libusb_close(jtag_libusb_device_handle *dev);
  54 int jtag_libusb_control_transfer(jtag_libusb_device_handle *dev,
  55                 uint8_t requestType, uint8_t request, uint16_t wValue,
  56                 uint16_t wIndex, char *bytes,   uint16_t size, unsigned int timeout);
  57 int jtag_libusb_bulk_write(struct jtag_libusb_device_handle *dev, int ep,
  58                 char *bytes,    int size, int timeout);
  59 int jtag_libusb_bulk_read(struct jtag_libusb_device_handle *dev, int ep,
  60                 char *bytes, int size, int timeout);
  61 int jtag_libusb_set_configuration(jtag_libusb_device_handle *devh,
  62                 int configuration);
  63 /**
  64  * Find the first interface optionally matching class, subclass and
  65  * protocol and claim it.
  66  * @param devh _libusb_ device handle.
  67  * @param usb_read_ep A pointer to a variable where the _IN_ endpoint
  68  *      number will be stored.
  69  * @param usb_write_ep A pointer to a variable where the _OUT_ endpoint
  70  *      number will be stored.
  71  * @param bclass `bInterfaceClass` to match, or -1 to ignore this field.
  72  * @param subclass `bInterfaceSubClass` to match, or -1 to ignore this field.
  73  * @param protocol `bInterfaceProtocol` to match, or -1 to ignore this field.
  74  * @returns Returns ERROR_OK on success, ERROR_FAIL otherwise.
  75  */
  76 int jtag_libusb_choose_interface(struct jtag_libusb_device_handle *devh,
  77                 unsigned int *usb_read_ep,
  78                 unsigned int *usb_write_ep,
  79                 int bclass, int subclass, int protocol);
  80 int jtag_libusb_get_pid(struct jtag_libusb_device *dev, uint16_t *pid);
  81
  82 #endif /* JTAG_USB_COMMON_H */