1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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 436 437
|
#include "dfu_libusb.hh"
#include <unistd.h>
#include "logger.hh"
#include "utils.hh"
// USB request types.
#define REQUEST_TYPE_TO_HOST 0xA1
#define REQUEST_TYPE_TO_DEVICE 0x21
enum {
REQUEST_DETACH = 0,
REQUEST_DNLOAD = 1,
REQUEST_UPLOAD = 2,
REQUEST_GETSTATUS = 3,
REQUEST_CLRSTATUS = 4,
REQUEST_GETSTATE = 5,
REQUEST_ABORT = 6,
};
enum {
appIDLE = 0,
appDETACH = 1,
dfuIDLE = 2,
dfuDNLOAD_SYNC = 3,
dfuDNBUSY = 4,
dfuDNLOAD_IDLE = 5,
dfuMANIFEST_SYNC = 6,
dfuMANIFEST = 7,
dfuMANIFEST_WAIT_RESET = 8,
dfuUPLOAD_IDLE = 9,
dfuERROR = 10,
};
/* ********************************************************************************************* *
* Implementation of DFUDevice::Descriptor
* ********************************************************************************************* */
DFUDevice::Descriptor::Descriptor(const USBDeviceInfo &info, uint8_t bus, uint8_t device)
: USBDeviceDescriptor(info, USBDeviceHandle(bus, device))
{
// pass...
}
/* ********************************************************************************************* *
* Implementation of DFUDevice
* ********************************************************************************************* */
DFUDevice::DFUDevice(const USBDeviceDescriptor &descr, const ErrorStack &err, QObject *parent)
: QObject(parent), _ctx(nullptr), _dev(nullptr)
{
if (USBDeviceInfo::Class::DFU != descr.interfaceClass()) {
errMsg(err) << "Cannot connect to DFU device using a non DFU descriptor: "
<< descr.description() << ".";
return;
}
int error = libusb_init(&_ctx);
if (error < 0) {
errMsg(err) << "Libusb init failed (" << error << "): "
<< libusb_strerror((enum libusb_error) error) << ".";
return;
}
int num=0;
libusb_device **lst;
libusb_device *dev=nullptr;
if (0 > (num = libusb_get_device_list(_ctx, &lst))) {
errMsg(err) << "Cannot obtain list of USB devices.";
libusb_exit(_ctx);
_ctx = nullptr;
return;
}
logDebug() << "Try to detect USB DFU interface " << descr.description() << ".";
USBDeviceHandle addr = descr.device().value<USBDeviceHandle>();
for (int i=0; (i<num)&&(nullptr!=lst[i]); i++) {
if (addr.bus != libusb_get_bus_number(lst[i]))
continue;
if (addr.device != libusb_get_device_address(lst[i]))
continue;
libusb_device_descriptor usb_descr;
if (0 > libusb_get_device_descriptor(lst[i],&usb_descr))
continue;
if (descr.vendorId() != usb_descr.idVendor)
continue;
if (descr.productId() != usb_descr.idProduct)
continue;
logDebug() << "Matching device found at bus " << addr.bus << ", device " << addr.device
<< " with vendor ID " << QString::number(usb_descr.idVendor, 16)
<< " and product ID " << QString::number(usb_descr.idProduct, 16) << ".";
libusb_ref_device(lst[i]); dev = lst[i];
}
// Unref all devices and free list, matching device was referenced earlier
libusb_free_device_list(lst, 1);
if (nullptr == dev) {
errMsg(err) << "No matching device found: " << descr.description() << ".";
libusb_exit(_ctx);
_ctx = nullptr;
return;
}
if (0 > (error = libusb_open(dev, &_dev))) {
errMsg(err) << "Cannot open device " << descr.description()
<< ": " << libusb_strerror((enum libusb_error) error) << ".";
libusb_unref_device(dev);
libusb_exit(_ctx);
_ctx = nullptr;
return;
}
if (libusb_kernel_driver_active(_dev, 0) && libusb_detach_kernel_driver(_dev, 0)) {
errMsg(err) << "Cannot detach kernel driver for device " << descr.description()
<< ". Interface claim will likely fail.";
}
if (0 > (error = libusb_claim_interface(_dev, 0))) {
errMsg(err) << "Failed to claim USB interface " << descr.description()
<< ": " << libusb_strerror((enum libusb_error) error) << ".";
libusb_close(_dev);
_dev = nullptr;
libusb_exit(_ctx);
_ctx = nullptr;
return;
}
logDebug() << "Connected to DFU device " << descr.description() << ".";
}
DFUDevice::~DFUDevice() {
close();
}
QList<USBDeviceDescriptor>
DFUDevice::detect(uint16_t vid, uint16_t pid)
{
QList<USBDeviceDescriptor> res;
int error, num;
libusb_context *ctx;
if (0 > (error = libusb_init(&ctx))) {
logError() << "Libusb init failed (" << error << "): "
<< libusb_strerror((enum libusb_error) error) << ".";
return res;
}
libusb_device **lst;
if (0 == (num = libusb_get_device_list(ctx, &lst))) {
logDebug() << "No USB devices found at all.";
// unref devices and free list
libusb_free_device_list(lst, 1);
return res;
}
logDebug() << "Search for DFU devices matching VID:PID "
<< QString::number(vid, 16) << ":" << QString::number(pid, 16) << ".";
for (int i=0; (i<num)&&(nullptr!=lst[i]); i++) {
libusb_device_descriptor descr;
libusb_get_device_descriptor(lst[i], &descr);
if ((vid == descr.idVendor) && (pid == descr.idProduct)) {
logDebug() << "Found device on bus=" << libusb_get_bus_number(lst[i])
<< ", device=" << libusb_get_device_address(lst[i])
<< " with " << QString::number(vid, 16) << ":" << QString::number(pid, 16) << ".";
res.append(DFUDevice::Descriptor(
USBDeviceInfo(USBDeviceInfo::Class::DFU, vid, pid),
libusb_get_bus_number(lst[i]),
libusb_get_device_address(lst[i])));
}
}
libusb_free_device_list(lst, 1);
return res;
}
bool
DFUDevice::isOpen() const {
return nullptr != _dev;
}
void
DFUDevice::close() {
if (nullptr != _dev) {
libusb_release_interface(_dev, 0);
libusb_close(_dev);
}
if (nullptr != _ctx)
libusb_exit(_ctx);
_ctx = nullptr;
_dev = nullptr;
}
int
DFUDevice::download(unsigned block, uint8_t *data, unsigned len, const ErrorStack &err) {
int error = libusb_control_transfer(
_dev, REQUEST_TYPE_TO_DEVICE, REQUEST_DNLOAD, block, 0, data, len, 0);
if (error < 0) {
errMsg(err) << "Cannot write to device: " << libusb_strerror((enum libusb_error) error) << ".";
return error;
}
return get_status();
}
int
DFUDevice::upload(unsigned block, uint8_t *data, unsigned len, const ErrorStack &err) {
int error = libusb_control_transfer(
_dev, REQUEST_TYPE_TO_HOST, REQUEST_UPLOAD, block, 0, data, len, 0);
if (error < 0) {
errMsg(err) << "Cannot read block: " << libusb_strerror((enum libusb_error) error) << ".";
return error;
}
return get_status();
}
int
DFUDevice::detach(int timeout, const ErrorStack &err)
{
int error = libusb_control_transfer(
_dev, REQUEST_TYPE_TO_DEVICE, REQUEST_DETACH, timeout, 0, nullptr, 0, 0);
if (0 > error) {
errMsg(err) << "Cannot detach device: " << libusb_strerror((enum libusb_error) error) << ".";
return error;
}
return 0;
}
int
DFUDevice::get_status(const ErrorStack &err)
{
int error = libusb_control_transfer(
_dev, REQUEST_TYPE_TO_HOST, REQUEST_GETSTATUS, 0, 0, (unsigned char*)&_status, 6, 0);
if (0 > error) {
errMsg(err) << "Cannot get status: " << libusb_strerror((enum libusb_error) error) << ".";
return error;
}
return 0;
}
int
DFUDevice::clear_status(const ErrorStack &err)
{
int error = libusb_control_transfer(
_dev, REQUEST_TYPE_TO_DEVICE, REQUEST_CLRSTATUS, 0, 0, NULL, 0, 0);
if (0 > error) {
errMsg(err) << "Cannot clear status: " << libusb_strerror((enum libusb_error) error) << ".";
return error;
}
return 0;
}
int
DFUDevice::get_state(int &pstate, const ErrorStack &err)
{
unsigned char state;
int error = libusb_control_transfer(
_dev, REQUEST_TYPE_TO_HOST, REQUEST_GETSTATE, 0, 0, &state, 1, 0);
pstate = state;
if (error < 0) {
errMsg(err) << "Cannot get state: " << libusb_strerror((enum libusb_error) error) << ".";
return error;
}
return 0;
}
int
DFUDevice::abort(const ErrorStack &err)
{
int error = libusb_control_transfer(
_dev, REQUEST_TYPE_TO_DEVICE, REQUEST_ABORT, 0, 0, NULL, 0, 0);
if (error < 0) {
errMsg(err) << "Cannot abort: " << libusb_strerror((enum libusb_error) error) << ".";
return error;
}
return 0;
}
int
DFUDevice::wait_idle(const ErrorStack &err)
{
int state, error;
for (;;) {
if (0 > (error = get_state(state, err)))
return 1;
switch (state) {
case dfuIDLE:
return 0;
case appIDLE:
error = detach(1000, err);
break;
case dfuERROR:
error = clear_status(err);
break;
case appDETACH:
case dfuDNBUSY:
case dfuMANIFEST_WAIT_RESET:
usleep(100000);
continue;
default:
error = abort(err);
break;
}
if (error < 0)
return 1;
}
}
/* ********************************************************************************************* *
* Implementation of DFUSEDevice
* ********************************************************************************************* */
DFUSEDevice::DFUSEDevice(const USBDeviceDescriptor &descr, const ErrorStack &err, uint16_t blocksize, QObject *parent)
: DFUDevice(descr, err, parent), _blocksize(blocksize)
{
// pass...
}
void
DFUSEDevice::close() {
leaveDFU();
DFUDevice::close();
}
uint16_t
DFUSEDevice::blocksize() const {
return _blocksize;
}
bool
DFUSEDevice::setAddress(uint32_t address, const ErrorStack &err) {
uint8_t cmd[5] ={
0x21, (uint8_t)address, (uint8_t)(address >> 8), (uint8_t)(address >> 16), (uint8_t)(address >> 24)
};
if (int error = download(0, cmd, 5, err)) {
errMsg(err) << "Cannot set address to " << QString::number(address, 16) << ".";
return error;
}
if (wait_idle(err)) {
errMsg(err) << "Set address command failed.";
return false;
}
return true;
}
bool
DFUSEDevice::readBlock(unsigned block, uint8_t *data, const ErrorStack &err) {
return 0 == upload(block+2, data, _blocksize, err);
}
bool
DFUSEDevice::writeBlock(unsigned block, const uint8_t *data, const ErrorStack &err) {
if (download(block+2, (uint8_t *)data, _blocksize, err)) {
return false;
}
if (wait_idle(err)) {
return false;
}
return true;
}
bool
DFUSEDevice::erasePage(uint32_t address, const ErrorStack &err) {
uint8_t cmd[5] ={
0x41, (uint8_t)address, (uint8_t)(address >> 8), (uint8_t)(address >> 16), (uint8_t)(address >> 24)
};
if (int error = download(0, cmd, 5, err)) {
errMsg(err) << "Cannot erase page at address " << QString::number(address, 16) << ".";
return error;
}
if (wait_idle(err)) {
errMsg(err) << "Erase page command failed.";
return false;
}
return true;
}
bool
DFUSEDevice::eraseAll(const ErrorStack &err) {
uint8_t cmd[1] ={0x41};
if (int error = download(0, cmd, 1, err)) {
errMsg(err) << "Cannot erase entire memory.";
return error;
}
if (wait_idle(err)) {
errMsg(err) << "Erase memory command failed.";
return false;
}
return true;
}
bool
DFUSEDevice::releaseReadLock(const ErrorStack &err) {
uint8_t cmd[1] ={0x92};
if (int error = download(0, cmd, 1, err)) {
errMsg(err) << "Cannot unlock memory.";
return error;
}
if (wait_idle(err)) {
errMsg(err) << "Unlock memory command failed.";
return false;
}
return true;
}
bool
DFUSEDevice::leaveDFU(const ErrorStack &err) {
if (int error = download(0, nullptr, 0)) {
errMsg(err) << "Cannot leave DFU mode.";
return error;
}
return true;
}
|