src/jtag/drivers/libusb_helper.c (OpenOCD)

Outline

#include "config.h"

#include <string.h>

#include <helper/log.h>

#include <jtag/adapter.h>

#include "libusb_helper.h"

#define MAX_USB_PORTS

jtag_libusb_context

devs

jtag_libusb_error(int)

jtag_libusb_match_ids(struct libusb_device_descriptor *, const uint16_t *, const uint16_t *)

jtag_libusb_location_equal(struct libusb_device *)

string_descriptor_equal(struct libusb_device_handle *, uint8_t, const char *)

jtag_libusb_match_serial(struct libusb_device_handle *, struct libusb_device_descriptor *, const char *, adapter_get_alternate_serial_fn)

jtag_libusb_open(const uint16_t *, const uint16_t *, const char *, struct libusb_device_handle **, adapter_get_alternate_serial_fn)

jtag_libusb_close(struct libusb_device_handle *)

jtag_libusb_control_transfer(struct libusb_device_handle *, uint8_t, uint8_t, uint16_t, uint16_t, char *, uint16_t, unsigned int, int *)

jtag_libusb_bulk_write(struct libusb_device_handle *, int, char *, int, int, int *)

jtag_libusb_bulk_read(struct libusb_device_handle *, int, char *, int, int, int *)

jtag_libusb_set_configuration(struct libusb_device_handle *, int)

jtag_libusb_choose_interface(struct libusb_device_handle *, unsigned int *, unsigned int *, int, int, int, int)

jtag_libusb_get_pid(struct libusb_device *, uint16_t *)

jtag_libusb_handle_events_completed(int *)

dev_mem_allocation

libusb_dev_mem_alloc(int *, size_t)

libusb_dev_mem_free(int *, uint8_t *, size_t)

oocd_libusb_dev_mem_alloc(int *, size_t)

oocd_libusb_dev_mem_free(int *, uint8_t *, size_t)

Files

SourceVuDevelopment ToolsOpenOCDsrc/jtag/drivers/libusb_helper.c

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

// SPDX-License-Identifier: GPL-2.0-or-later /*************************************************************************** * Copyright (C) 2009 by Zachary T Welch <zw@superlucidity.net> * * * * Copyright (C) 2011 by Mauro Gamba <maurillo71@gmail.com> * ***************************************************************************/ #ifdef HAVE_CONFIG_H #include "config.h" #endif #include <string.h> #include <helper/log.h> #include <jtag/adapter.h> #include "libusb_helper.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 struct libusb_device **devs; /**< The usb device list **/ static int jtag_libusb_error(int err) { switch (err) { case LIBUSB_SUCCESS: return ERROR_OK; case LIBUSB_ERROR_TIMEOUT: return ERROR_TIMEOUT_REACHED; case LIBUSB_ERROR_IO: case LIBUSB_ERROR_INVALID_PARAM: case LIBUSB_ERROR_ACCESS: case LIBUSB_ERROR_NO_DEVICE: case LIBUSB_ERROR_NOT_FOUND: case LIBUSB_ERROR_BUSY: case LIBUSB_ERROR_OVERFLOW: case LIBUSB_ERROR_PIPE: case LIBUSB_ERROR_INTERRUPTED: case LIBUSB_ERROR_NO_MEM: case LIBUSB_ERROR_NOT_SUPPORTED: case LIBUSB_ERROR_OTHER: return ERROR_FAIL; default: return ERROR_FAIL; } } bool jtag_libusb_match_ids(struct libusb_device_descriptor *dev_desc, const uint16_t vids[], const uint16_t pids[]) { for (unsigned i = 0; vids[i]; i++) { if (dev_desc->idVendor == vids[i] && dev_desc->idProduct == pids[i]) { return true; } } return false; } #ifdef HAVE_LIBUSB_GET_PORT_NUMBERS static bool jtag_libusb_location_equal(struct 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 adapter_usb_location_equal(dev_bus, port_path, path_len); } #else /* HAVE_LIBUSB_GET_PORT_NUMBERS */ static bool jtag_libusb_location_equal(struct 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(struct libusb_device_handle *device, uint8_t str_index, const char *string) { int retval; bool matched; char desc_string[256+1]; /* Max size of string descriptor */ if (str_index == 0) return false; retval = libusb_get_string_descriptor_ascii(device, str_index, (unsigned char *)desc_string, sizeof(desc_string)-1); if (retval < 0) { LOG_ERROR("libusb_get_string_descriptor_ascii() failed with %d", retval); return false; } /* Null terminate descriptor string in case it needs to be logged. */ desc_string[sizeof(desc_string)-1] = '\0'; matched = strncmp(string, desc_string, sizeof(desc_string)) == 0; if (!matched) LOG_DEBUG("Device serial number '%s' doesn't match requested serial '%s'", desc_string, string); return matched; } static bool jtag_libusb_match_serial(struct libusb_device_handle *device, struct libusb_device_descriptor *dev_desc, const char *serial, adapter_get_alternate_serial_fn adapter_get_alternate_serial) { if (string_descriptor_equal(device, dev_desc->iSerialNumber, serial)) return true; /* check the alternate serial helper */ if (!adapter_get_alternate_serial) return false; /* get the alternate serial */ char *alternate_serial = adapter_get_alternate_serial(device, dev_desc); /* check possible failures */ if (!alternate_serial) return false; /* then compare and free the alternate serial */ bool match = false; if (strcmp(serial, alternate_serial) == 0) match = true; else LOG_DEBUG("Device alternate serial number '%s' doesn't match requested serial '%s'", alternate_serial, serial); free(alternate_serial); return match; } int jtag_libusb_open(const uint16_t vids[], const uint16_t pids[], const char *product, struct libusb_device_handle **out, adapter_get_alternate_serial_fn adapter_get_alternate_serial) { int cnt, idx, err_code; int retval = ERROR_FAIL; bool serial_mismatch = false; bool product_mismatch = false; struct libusb_device_handle *libusb_handle = NULL; const char *serial = adapter_get_required_serial(); if (libusb_init(&jtag_libusb_context) < 0) return ERROR_FAIL; cnt = libusb_get_device_list(jtag_libusb_context, &devs); for (idx = 0; idx < cnt; idx++) { struct libusb_device_descriptor dev_desc; if (libusb_get_device_descriptor(devs[idx], &dev_desc) != 0) continue; if (!jtag_libusb_match_ids(&dev_desc, vids, pids)) continue; if (adapter_usb_get_location() && !jtag_libusb_location_equal(devs[idx])) continue; err_code = libusb_open(devs[idx], &libusb_handle); if (err_code) { LOG_ERROR("libusb_open() failed with %s", libusb_error_name(err_code)); continue; } /* Device must be open to use libusb_get_string_descriptor_ascii. */ if (serial && !jtag_libusb_match_serial(libusb_handle, &dev_desc, serial, adapter_get_alternate_serial)) { serial_mismatch = true; libusb_close(libusb_handle); continue; } if (product && !string_descriptor_equal(libusb_handle, dev_desc.iProduct, product)) { product_mismatch = true; libusb_close(libusb_handle); continue; } /* Success. */ *out = libusb_handle; retval = ERROR_OK; serial_mismatch = false; product_mismatch = false; break; } if (cnt >= 0) libusb_free_device_list(devs, 1); if (serial_mismatch) LOG_INFO("No device matches the serial string"); if (product_mismatch) LOG_INFO("No device matches the product string"); if (retval != ERROR_OK) libusb_exit(jtag_libusb_context); return retval; } void jtag_libusb_close(struct libusb_device_handle *dev) { /* Close device */ libusb_close(dev); libusb_exit(jtag_libusb_context); } int jtag_libusb_control_transfer(struct libusb_device_handle *dev, uint8_t request_type, uint8_t request, uint16_t value, uint16_t index, char *bytes, uint16_t size, unsigned int timeout, int *transferred) { int retval = libusb_control_transfer(dev, request_type, request, value, index, (unsigned char *)bytes, size, timeout); if (retval < 0) { LOG_ERROR("libusb_control_transfer error: %s", libusb_error_name(retval)); if (transferred) *transferred = 0; return jtag_libusb_error(retval); } if (transferred) *transferred = retval; return ERROR_OK; } int jtag_libusb_bulk_write(struct libusb_device_handle *dev, int ep, char *bytes, int size, int timeout, int *transferred) { int ret; *transferred = 0; ret = libusb_bulk_transfer(dev, ep, (unsigned char *)bytes, size, transferred, timeout); if (ret != LIBUSB_SUCCESS) { LOG_ERROR("libusb_bulk_write error: %s", libusb_error_name(ret)); return jtag_libusb_error(ret); } return ERROR_OK; } int jtag_libusb_bulk_read(struct libusb_device_handle *dev, int ep, char *bytes, int size, int timeout, int *transferred) { int ret; *transferred = 0; ret = libusb_bulk_transfer(dev, ep, (unsigned char *)bytes, size, transferred, timeout); if (ret != LIBUSB_SUCCESS) { LOG_ERROR("libusb_bulk_read error: %s", libusb_error_name(ret)); return jtag_libusb_error(ret); } return ERROR_OK; } int jtag_libusb_set_configuration(struct libusb_device_handle *devh, int configuration) { struct libusb_device *udev = libusb_get_device(devh); int retval = -99; struct libusb_config_descriptor *config = NULL; int current_config = -1; retval = libusb_get_configuration(devh, &current_config); if (retval != 0) return retval; retval = libusb_get_config_descriptor(udev, configuration, &config); if (retval != 0 || !config) return retval; /* Only change the configuration if it is not already set to the same one. Otherwise this issues a lightweight reset and hangs LPC-Link2 with JLink firmware. */ if (current_config != config->bConfigurationValue) retval = libusb_set_configuration(devh, config->bConfigurationValue); libusb_free_config_descriptor(config); return retval; } int jtag_libusb_choose_interface(struct libusb_device_handle *devh, unsigned int *usb_read_ep, unsigned int *usb_write_ep, int bclass, int subclass, int protocol, int trans_type) { struct libusb_device *udev = libusb_get_device(devh); const struct libusb_interface *inter; const struct libusb_interface_descriptor *interdesc; const struct libusb_endpoint_descriptor *epdesc; struct libusb_config_descriptor *config; *usb_read_ep = *usb_write_ep = 0; libusb_get_config_descriptor(udev, 0, &config); for (int i = 0; i < (int)config->bNumInterfaces; i++) { inter = &config->interface[i]; interdesc = &inter->altsetting[0]; for (int k = 0; k < (int)interdesc->bNumEndpoints; k++) { if ((bclass > 0 && interdesc->bInterfaceClass != bclass) || (subclass > 0 && interdesc->bInterfaceSubClass != subclass) || (protocol > 0 && interdesc->bInterfaceProtocol != protocol)) 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; LOG_DEBUG("usb ep %s %02x", is_input ? "in" : "out", epnum); if (is_input) *usb_read_ep = epnum; else *usb_write_ep = epnum; if (*usb_read_ep && *usb_write_ep) { LOG_DEBUG("Claiming interface %d", (int)interdesc->bInterfaceNumber); libusb_claim_interface(devh, (int)interdesc->bInterfaceNumber); libusb_free_config_descriptor(config); return ERROR_OK; } } } libusb_free_config_descriptor(config); return ERROR_FAIL; } int jtag_libusb_get_pid(struct libusb_device *dev, uint16_t *pid) { struct libusb_device_descriptor dev_desc; if (libusb_get_device_descriptor(dev, &dev_desc) == 0) { *pid = dev_desc.idProduct; return ERROR_OK; } return ERROR_FAIL; } int jtag_libusb_handle_events_completed(int *completed) { return libusb_handle_events_completed(jtag_libusb_context, completed); } static enum { DEV_MEM_NOT_YET_DECIDED, DEV_MEM_AVAILABLE, DEV_MEM_FALLBACK_MALLOC } dev_mem_allocation; /* Older libusb does not implement following API calls - define stubs instead */ #if !defined(LIBUSB_API_VERSION) || (LIBUSB_API_VERSION < 0x01000105) static uint8_t *libusb_dev_mem_alloc(libusb_device_handle *devh, size_t length) { return NULL; } static int libusb_dev_mem_free(libusb_device_handle *devh, uint8_t *buffer, size_t length) { return LIBUSB_ERROR_NOT_SUPPORTED; } #endif uint8_t *oocd_libusb_dev_mem_alloc(libusb_device_handle *devh, size_t length) { uint8_t *buffer = NULL; if (dev_mem_allocation != DEV_MEM_FALLBACK_MALLOC) buffer = libusb_dev_mem_alloc(devh, length); if (dev_mem_allocation == DEV_MEM_NOT_YET_DECIDED) dev_mem_allocation = buffer ? DEV_MEM_AVAILABLE : DEV_MEM_FALLBACK_MALLOC; if (dev_mem_allocation == DEV_MEM_FALLBACK_MALLOC) buffer = malloc(length); return buffer; } int oocd_libusb_dev_mem_free(libusb_device_handle *devh, uint8_t *buffer, size_t length) { if (!buffer) return ERROR_OK; switch (dev_mem_allocation) { case DEV_MEM_AVAILABLE: return jtag_libusb_error(libusb_dev_mem_free(devh, buffer, length)); case DEV_MEM_FALLBACK_MALLOC: free(buffer); return ERROR_OK; case DEV_MEM_NOT_YET_DECIDED: return ERROR_FAIL; } return ERROR_FAIL; }

Details

Click anywhere in the source to view detailed information here...