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 ***************************************************************************/
23 #include <jtag/drivers/jtag_usb_common.h>
24 #include "libusb1_common.h"
28 * comment from libusb:
29 * As per the USB 3.0 specs, the current maximum limit for the depth is 7.
31 #define MAX_USB_PORTS 7
33 static struct libusb_context
*jtag_libusb_context
; /**< Libusb context **/
34 static libusb_device
**devs
; /**< The usb device list **/
36 static bool jtag_libusb_match(struct libusb_device_descriptor
*dev_desc
,
37 const uint16_t vids
[], const uint16_t pids
[])
39 for (unsigned i
= 0; vids
[i
]; i
++) {
40 if (dev_desc
->idVendor
== vids
[i
] &&
41 dev_desc
->idProduct
== pids
[i
]) {
48 #ifdef HAVE_LIBUSB_GET_PORT_NUMBERS
49 static bool jtag_libusb_location_equal(libusb_device
*device
)
51 uint8_t port_path
[MAX_USB_PORTS
];
55 path_len
= libusb_get_port_numbers(device
, port_path
, MAX_USB_PORTS
);
56 if (path_len
== LIBUSB_ERROR_OVERFLOW
) {
57 LOG_WARNING("cannot determine path to usb device! (more than %i ports in path)\n",
61 dev_bus
= libusb_get_bus_number(device
);
63 return jtag_usb_location_equal(dev_bus
, port_path
, path_len
);
65 #else /* HAVE_LIBUSB_GET_PORT_NUMBERS */
66 static bool jtag_libusb_location_equal(libusb_device
*device
)
70 #endif /* HAVE_LIBUSB_GET_PORT_NUMBERS */
73 /* Returns true if the string descriptor indexed by str_index in device matches string */
74 static bool string_descriptor_equal(libusb_device_handle
*device
, uint8_t str_index
,
79 char desc_string
[256+1]; /* Max size of string descriptor */
84 retval
= libusb_get_string_descriptor_ascii(device
, str_index
,
85 (unsigned char *)desc_string
, sizeof(desc_string
)-1);
87 LOG_ERROR("libusb_get_string_descriptor_ascii() failed with %d", retval
);
91 /* Null terminate descriptor string in case it needs to be logged. */
92 desc_string
[sizeof(desc_string
)-1] = '\0';
94 matched
= strncmp(string
, desc_string
, sizeof(desc_string
)) == 0;
96 LOG_DEBUG("Device serial number '%s' doesn't match requested serial '%s'",
101 int jtag_libusb_open(const uint16_t vids
[], const uint16_t pids
[],
103 struct jtag_libusb_device_handle
**out
)
105 int cnt
, idx
, errCode
;
106 int retval
= ERROR_FAIL
;
107 bool serial_mismatch
= false;
108 struct jtag_libusb_device_handle
*libusb_handle
= NULL
;
110 if (libusb_init(&jtag_libusb_context
) < 0)
113 cnt
= libusb_get_device_list(jtag_libusb_context
, &devs
);
115 for (idx
= 0; idx
< cnt
; idx
++) {
116 struct libusb_device_descriptor dev_desc
;
118 if (libusb_get_device_descriptor(devs
[idx
], &dev_desc
) != 0)
121 if (!jtag_libusb_match(&dev_desc
, vids
, pids
))
124 if (jtag_usb_get_location() && !jtag_libusb_location_equal(devs
[idx
]))
127 errCode
= libusb_open(devs
[idx
], &libusb_handle
);
130 LOG_ERROR("libusb_open() failed with %s",
131 libusb_error_name(errCode
));
135 /* Device must be open to use libusb_get_string_descriptor_ascii. */
136 if (serial
!= NULL
&&
137 !string_descriptor_equal(libusb_handle
, dev_desc
.iSerialNumber
, serial
)) {
138 serial_mismatch
= true;
139 libusb_close(libusb_handle
);
144 *out
= libusb_handle
;
146 serial_mismatch
= false;
150 libusb_free_device_list(devs
, 1);
153 LOG_INFO("No device matches the serial string");
158 void jtag_libusb_close(jtag_libusb_device_handle
*dev
)
163 libusb_exit(jtag_libusb_context
);
166 int jtag_libusb_control_transfer(jtag_libusb_device_handle
*dev
, uint8_t requestType
,
167 uint8_t request
, uint16_t wValue
, uint16_t wIndex
, char *bytes
,
168 uint16_t size
, unsigned int timeout
)
172 transferred
= libusb_control_transfer(dev
, requestType
, request
, wValue
, wIndex
,
173 (unsigned char *)bytes
, size
, timeout
);
181 int jtag_libusb_bulk_write(jtag_libusb_device_handle
*dev
, int ep
, char *bytes
,
182 int size
, int timeout
)
186 libusb_bulk_transfer(dev
, ep
, (unsigned char *)bytes
, size
,
187 &transferred
, timeout
);
191 int jtag_libusb_bulk_read(jtag_libusb_device_handle
*dev
, int ep
, char *bytes
,
192 int size
, int timeout
)
196 libusb_bulk_transfer(dev
, ep
, (unsigned char *)bytes
, size
,
197 &transferred
, timeout
);
201 int jtag_libusb_set_configuration(jtag_libusb_device_handle
*devh
,
204 struct jtag_libusb_device
*udev
= jtag_libusb_get_device(devh
);
207 struct libusb_config_descriptor
*config
= NULL
;
208 int current_config
= -1;
210 retCode
= libusb_get_configuration(devh
, ¤t_config
);
214 retCode
= libusb_get_config_descriptor(udev
, configuration
, &config
);
215 if (retCode
!= 0 || config
== NULL
)
218 /* Only change the configuration if it is not already set to the
219 same one. Otherwise this issues a lightweight reset and hangs
220 LPC-Link2 with JLink firmware. */
221 if (current_config
!= config
->bConfigurationValue
)
222 retCode
= libusb_set_configuration(devh
, config
->bConfigurationValue
);
224 libusb_free_config_descriptor(config
);
229 int jtag_libusb_choose_interface(struct jtag_libusb_device_handle
*devh
,
230 unsigned int *usb_read_ep
,
231 unsigned int *usb_write_ep
,
232 int bclass
, int subclass
, int protocol
, int trans_type
)
234 struct jtag_libusb_device
*udev
= jtag_libusb_get_device(devh
);
235 const struct libusb_interface
*inter
;
236 const struct libusb_interface_descriptor
*interdesc
;
237 const struct libusb_endpoint_descriptor
*epdesc
;
238 struct libusb_config_descriptor
*config
;
240 *usb_read_ep
= *usb_write_ep
= 0;
242 libusb_get_config_descriptor(udev
, 0, &config
);
243 for (int i
= 0; i
< (int)config
->bNumInterfaces
; i
++) {
244 inter
= &config
->interface
[i
];
246 interdesc
= &inter
->altsetting
[0];
248 k
< (int)interdesc
->bNumEndpoints
; k
++) {
249 if ((bclass
> 0 && interdesc
->bInterfaceClass
!= bclass
) ||
250 (subclass
> 0 && interdesc
->bInterfaceSubClass
!= subclass
) ||
251 (protocol
> 0 && interdesc
->bInterfaceProtocol
!= protocol
))
254 epdesc
= &interdesc
->endpoint
[k
];
255 if (trans_type
> 0 && (epdesc
->bmAttributes
& 0x3) != trans_type
)
258 uint8_t epnum
= epdesc
->bEndpointAddress
;
259 bool is_input
= epnum
& 0x80;
260 LOG_DEBUG("usb ep %s %02x",
261 is_input
? "in" : "out", epnum
);
264 *usb_read_ep
= epnum
;
266 *usb_write_ep
= epnum
;
268 if (*usb_read_ep
&& *usb_write_ep
) {
269 LOG_DEBUG("Claiming interface %d", (int)interdesc
->bInterfaceNumber
);
270 libusb_claim_interface(devh
, (int)interdesc
->bInterfaceNumber
);
271 libusb_free_config_descriptor(config
);
276 libusb_free_config_descriptor(config
);
281 int jtag_libusb_get_pid(struct jtag_libusb_device
*dev
, uint16_t *pid
)
283 struct libusb_device_descriptor dev_desc
;
285 if (libusb_get_device_descriptor(dev
, &dev_desc
) == 0) {
286 *pid
= dev_desc
.idProduct
;
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)