jtag: drivers: provide initial support for usb path filtering

[openocd.git] / src / jtag / drivers / libusb1_common.c

diff --git a/src/jtag/drivers/libusb1_common.c b/src/jtag/drivers/libusb1_common.c
index bda91ffbc0a811157d1c8eb970fe39ffa46c0843..d96ac7692b91dfa654574628b06a2b20717a2fb3 100644 (file)
--- a/src/jtag/drivers/libusb1_common.c
+++ b/src/jtag/drivers/libusb1_common.c
@@ -14,16 +14,21 @@
  *   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, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  ***************************************************************************/
 
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
-#include "log.h"
+#include <jtag/drivers/jtag_usb_common.h>
 #include "libusb1_common.h"
+#include "log.h"
+
+/*
+ * comment from libusb:
+ * As per the USB 3.0 specs, the current maximum limit for the depth is 7.
+ */
+#define MAX_USB_PORTS  7
 
 static struct libusb_context *jtag_libusb_context; /**< Libusb context **/
 static libusb_device **devs; /**< The usb device list **/
@@ -40,6 +45,31 @@ static bool jtag_libusb_match(struct libusb_device_descriptor *dev_desc,
        return false;
 }
 
+#ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
+static bool jtag_libusb_location_equal(libusb_device *device)
+{
+       uint8_t port_path[MAX_USB_PORTS];
+       uint8_t dev_bus;
+       int path_len;
+
+       path_len = libusb_get_port_numbers(device, port_path, MAX_USB_PORTS);
+       if (path_len == LIBUSB_ERROR_OVERFLOW) {
+               LOG_WARNING("cannot determine path to usb device! (more than %i ports in path)\n",
+                       MAX_USB_PORTS);
+               return false;
+       }
+       dev_bus = libusb_get_bus_number(device);
+
+       return jtag_usb_location_equal(dev_bus, port_path, path_len);
+}
+#else /* HAVE_LIBUSB_GET_PORT_NUMBERS */
+static bool jtag_libusb_location_equal(libusb_device *device)
+{
+       return true;
+}
+#endif /* HAVE_LIBUSB_GET_PORT_NUMBERS */
+
+
 /* Returns true if the string descriptor indexed by str_index in device matches string */
 static bool string_descriptor_equal(libusb_device_handle *device, uint8_t str_index,
                                                                        const char *string)
@@ -73,11 +103,12 @@ int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
                struct jtag_libusb_device_handle **out)
 {
        int cnt, idx, errCode;
-       int retval = -ENODEV;
+       int retval = ERROR_FAIL;
+       bool serial_mismatch = false;
        struct jtag_libusb_device_handle *libusb_handle = NULL;
 
        if (libusb_init(&jtag_libusb_context) < 0)
-               return -ENODEV;
+               return ERROR_FAIL;
 
        cnt = libusb_get_device_list(jtag_libusb_context, &devs);
 
@@ -90,6 +121,9 @@ int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
                if (!jtag_libusb_match(&dev_desc, vids, pids))
                        continue;
 
+               if (jtag_usb_get_location() && !jtag_libusb_location_equal(devs[idx]))
+                       continue;
+
                errCode = libusb_open(devs[idx], &libusb_handle);
 
                if (errCode) {
@@ -101,17 +135,23 @@ int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[],
                /* Device must be open to use libusb_get_string_descriptor_ascii. */
                if (serial != NULL &&
                                !string_descriptor_equal(libusb_handle, dev_desc.iSerialNumber, serial)) {
+                       serial_mismatch = true;
                        libusb_close(libusb_handle);
                        continue;
                }
 
                /* Success. */
                *out = libusb_handle;
-               retval = 0;
+               retval = ERROR_OK;
+               serial_mismatch = false;
                break;
        }
        if (cnt >= 0)
                libusb_free_device_list(devs, 1);
+
+       if (serial_mismatch)
+               LOG_INFO("No device matches the serial string");
+
        return retval;
 }
 
@@ -189,7 +229,7 @@ int jtag_libusb_set_configuration(jtag_libusb_device_handle *devh,
 int jtag_libusb_choose_interface(struct jtag_libusb_device_handle *devh,
                unsigned int *usb_read_ep,
                unsigned int *usb_write_ep,
-               int bclass, int subclass, int protocol)
+               int bclass, int subclass, int protocol, int trans_type)
 {
        struct jtag_libusb_device *udev = jtag_libusb_get_device(devh);
        const struct libusb_interface *inter;
@@ -212,6 +252,8 @@ int jtag_libusb_choose_interface(struct jtag_libusb_device_handle *devh,
                                continue;
 
                        epdesc = &interdesc->endpoint[k];
+                       if (trans_type > 0 && (epdesc->bmAttributes & 0x3) != trans_type)
+                               continue;
 
                        uint8_t epnum = epdesc->bEndpointAddress;
                        bool is_input = epnum & 0x80;