src/usbwrap.cc

   1 ///
   2 /// \file       usbwrap.cc
   3 ///             USB API wrapper
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2009, Chris Frey
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17
  18     See the GNU General Public License in the COPYING file at the
  19     root directory of this project for more details.
  20 */
  21
  22
  23 #include "usbwrap.h"
  24 #include "data.h"
  25 #include "error.h"
  26 #include "debug.h"
  27
  28 #include <iomanip>
  29 #include <sstream>
  30 #include <errno.h>
  31 #include <string.h>
  32
  33 #ifndef __DEBUG_MODE__
  34 #define __DEBUG_MODE__
  35 #endif
  36 #include "debug.h"
  37
  38 namespace Usb {
  39
  40 ///////////////////////////////////////////////////////////////////////////////
  41 // Usb::Error exception class
  42
  43 static std::string GetErrorString(int libusb_errcode, const std::string &str)
  44 {
  45         std::ostringstream oss;
  46         oss << "(";
  47
  48         if( libusb_errcode ) {
  49                 oss << std::setbase(10) << libusb_errcode << ", ";
  50         }
  51
  52 //      oss << strerror(-libusb_errno) << "): "
  53         oss << usb_strerror() << "): ";
  54         oss << str;
  55         return oss.str();
  56 }
  57
  58 Error::Error(const std::string &str)
  59         : Barry::Error(GetErrorString(0, str))
  60         , m_libusb_errcode(0)
  61 {
  62 }
  63
  64 Error::Error(int libusb_errcode, const std::string &str)
  65         : Barry::Error(GetErrorString(libusb_errcode, str))
  66         , m_libusb_errcode(libusb_errcode)
  67 {
  68 }
  69
  70
  71 ///////////////////////////////////////////////////////////////////////////////
  72 // Match
  73
  74 Match::Match(int vendor, int product,
  75                 const char *busname, const char *devname)
  76         : m_busses(0)
  77         , m_dev(0)
  78         , m_vendor(vendor)
  79         , m_product(product)
  80         , m_busname(busname)
  81         , m_devname(devname)
  82 {
  83         usb_find_busses();
  84         usb_find_devices();
  85         m_busses = usb_get_busses();
  86 }
  87
  88 Match::~Match()
  89 {
  90 }
  91
  92 bool Match::ToNum(const char *str, long &num)
  93 {
  94         char *end = 0;
  95         num = strtol(str, &end, 10);
  96         return  num >= 0 &&                     // no negative numbers
  97                 num != LONG_MIN && num != LONG_MAX &&   // no overflow
  98                 str != end && *end == '\0';     // whole string valid
  99 }
 100
 101 //
 102 // Linux treats bus and device path names as numbers, sometimes left
 103 // padded with zeros.  Other platforms, such as Windows, use strings,
 104 // such as "bus-1" or similar.
 105 //
 106 // Here we try to convert each string to a number, and if successful,
 107 // compare them.  If unable to convert, then compare as strings.
 108 // This way, "3" == "003" and "bus-foobar" == "bus-foobar".
 109 //
 110 bool Match::NameCompare(const char *n1, const char *n2)
 111 {
 112         long l1, l2;
 113         if( ToNum(n1, l1) && ToNum(n2, l2) ) {
 114                 return l1 == l2;
 115         }
 116         else {
 117                 return strcmp(n1, n2) == 0;
 118         }
 119 }
 120
 121 bool Match::next_device(Usb::DeviceIDType *devid)
 122 {
 123         for( ; m_busses; m_busses = m_busses->next ) {
 124
 125                 // only search on given bus
 126                 if( m_busname && !NameCompare(m_busname, m_busses->dirname) )
 127                         continue;
 128
 129                 if( !m_dev )
 130                         m_dev = m_busses->devices;
 131
 132                 for( ; m_dev; m_dev = m_dev->next ) {
 133
 134                         // search for specific device
 135                         if( m_devname && !NameCompare(m_devname, m_dev->filename) )
 136                                 continue;
 137
 138                         // is there a match?
 139                         if( m_dev->descriptor.idVendor == m_vendor &&
 140                             m_dev->descriptor.idProduct == m_product ) {
 141                                 // found!
 142                                 *devid = m_dev;
 143
 144                                 // advance for next time
 145                                 m_dev = m_dev->next;
 146                                 if( !m_dev )
 147                                         m_busses = m_busses->next;
 148
 149                                 // done
 150                                 return true;
 151                         }
 152                 }
 153         }
 154         return false;
 155 }
 156
 157
 158 ///////////////////////////////////////////////////////////////////////////////
 159 // Device
 160
 161 Device::Device(Usb::DeviceIDType id, int timeout)
 162         : m_id(id),
 163         m_timeout(timeout)
 164 {
 165         dout("usb_open(" << std::dec << id << ")");
 166         m_handle = usb_open(id);
 167         if( !m_handle )
 168                 throw Error("open failed");
 169 }
 170
 171 Device::~Device()
 172 {
 173         dout("usb_close(" << std::dec << m_handle << ")");
 174         usb_close(m_handle);
 175 }
 176
 177 bool Device::SetConfiguration(unsigned char cfg)
 178 {
 179         dout("usb_set_configuration(" << std::dec << m_handle << ", 0x" << std::hex << (unsigned int) cfg << ")");
 180         int ret = usb_set_configuration(m_handle, cfg);
 181         m_lasterror = ret;
 182         return ret >= 0;
 183 }
 184
 185 bool Device::ClearHalt(int ep)
 186 {
 187         dout("usb_clear_halt(" << std::dec << m_handle << ", 0x" << std::hex << ep << ")");
 188         int ret = usb_clear_halt(m_handle, ep);
 189         m_lasterror = ret;
 190         return ret >= 0;
 191 }
 192
 193 bool Device::Reset()
 194 {
 195         dout("usb_reset(" << std::dec << m_handle << ")");
 196         int ret = usb_reset(m_handle);
 197         m_lasterror = ret;
 198         return ret == 0;
 199 }
 200
 201 bool Device::BulkRead(int ep, Barry::Data &data, int timeout)
 202 {
 203         int ret;
 204         do {
 205                 data.QuickZap();
 206                 ret = usb_bulk_read(m_handle, ep,
 207                         (char*) data.GetBuffer(), data.GetBufSize(),
 208                         timeout == -1 ? m_timeout : timeout);
 209                 if( ret < 0 && ret != -EINTR && ret != -EAGAIN ) {
 210                         m_lasterror = ret;
 211                         if( ret == -ETIMEDOUT )
 212                                 throw Timeout(ret, "Timeout in usb_bulk_read");
 213                         else
 214                                 throw Error(ret, "Error in usb_bulk_read");
 215                 }
 216                 data.ReleaseBuffer(ret);
 217         } while( ret == -EINTR || ret == -EAGAIN );
 218
 219         return ret >= 0;
 220 }
 221
 222 bool Device::BulkWrite(int ep, const Barry::Data &data, int timeout)
 223 {
 224         ddout("BulkWrite to endpoint 0x" << std::hex << ep << ":\n" << data);
 225         int ret;
 226         do {
 227                 ret = usb_bulk_write(m_handle, ep,
 228                         (char*) data.GetData(), data.GetSize(),
 229                         timeout == -1 ? m_timeout : timeout);
 230                 if( ret < 0 && ret != -EINTR && ret != -EAGAIN ) {
 231                         m_lasterror = ret;
 232                         if( ret == -ETIMEDOUT )
 233                                 throw Timeout(ret, "Timeout in usb_bulk_write (1)");
 234                         else
 235                                 throw Error(ret, "Error in usb_bulk_write (1)");
 236                 }
 237         } while( ret == -EINTR || ret == -EAGAIN );
 238
 239         return ret >= 0;
 240 }
 241
 242 bool Device::BulkWrite(int ep, const void *data, size_t size, int timeout)
 243 {
 244 #ifdef __DEBUG_MODE__
 245         Barry::Data dump(data, size);
 246         ddout("BulkWrite to endpoint 0x" << std::hex << ep << ":\n" << dump);
 247 #endif
 248
 249         int ret;
 250         do {
 251                 ret = usb_bulk_write(m_handle, ep,
 252                         (char*) data, size,
 253                         timeout == -1 ? m_timeout : timeout);
 254                 if( ret < 0 && ret != -EINTR && ret != -EAGAIN ) {
 255                         m_lasterror = ret;
 256                         if( ret == -ETIMEDOUT )
 257                                 throw Timeout(ret, "Timeout in usb_bulk_write (2)");
 258                         else
 259                                 throw Error(ret, "Error in usb_bulk_write (2)");
 260                 }
 261         } while( ret == -EINTR || ret == -EAGAIN );
 262
 263         return ret >= 0;
 264 }
 265
 266 bool Device::InterruptRead(int ep, Barry::Data &data, int timeout)
 267 {
 268         int ret;
 269         do {
 270                 data.QuickZap();
 271                 ret = usb_interrupt_read(m_handle, ep,
 272                         (char*) data.GetBuffer(), data.GetBufSize(),
 273                         timeout == -1 ? m_timeout : timeout);
 274                 if( ret < 0 && ret != -EINTR && ret != -EAGAIN ) {
 275                         m_lasterror = ret;
 276                         if( ret == -ETIMEDOUT )
 277                                 throw Timeout(ret, "Timeout in usb_interrupt_read");
 278                         else
 279                                 throw Error(ret, "Error in usb_interrupt_read");
 280                 }
 281                 data.ReleaseBuffer(ret);
 282         } while( ret == -EINTR || ret == -EAGAIN );
 283
 284         return ret >= 0;
 285 }
 286
 287 bool Device::InterruptWrite(int ep, const Barry::Data &data, int timeout)
 288 {
 289         ddout("InterruptWrite to endpoint 0x" << std::hex << ep << ":\n" << data);
 290
 291         int ret;
 292         do {
 293                 ret = usb_interrupt_write(m_handle, ep,
 294                         (char*) data.GetData(), data.GetSize(),
 295                         timeout == -1 ? m_timeout : timeout);
 296                 if( ret < 0 && ret != -EINTR && ret != -EAGAIN ) {
 297                         m_lasterror = ret;
 298                         if( ret == -ETIMEDOUT )
 299                                 throw Timeout(ret, "Timeout in usb_interrupt_write");
 300                         else
 301                                 throw Error(ret, "Error in usb_interrupt_write");
 302                 }
 303         } while( ret == -EINTR || ret == -EAGAIN );
 304
 305         return ret >= 0;
 306 }
 307
 308 //
 309 // BulkDrain
 310 //
 311 /// Reads anything available on the given endpoint, with a low timeout,
 312 /// in order to clear any pending reads.
 313 ///
 314 void Device::BulkDrain(int ep, int timeout)
 315 {
 316         try {
 317                 Barry::Data data;
 318                 while( BulkRead(ep, data, timeout) )
 319                 ;
 320         }
 321         catch( Usb::Error & ) {}
 322 }
 323
 324 //
 325 // GetConfiguration
 326 //
 327 /// Uses the GET_CONFIGURATION control message to determine the currently
 328 /// selected USB configuration, returning it in the cfg argument.
 329 /// If unsuccessful, returns false.
 330 ///
 331 bool Device::GetConfiguration(unsigned char &cfg)
 332 {
 333         int result = usb_control_msg(m_handle, 0x80, USB_REQ_GET_CONFIGURATION, 0, 0,
 334                 (char*) &cfg, 1, m_timeout);
 335         m_lasterror = result;
 336         return result >= 0;
 337 }
 338
 339
 340
 341 ///////////////////////////////////////////////////////////////////////////////
 342 // Interface
 343
 344 Interface::Interface(Device &dev, int iface)
 345         : m_dev(dev), m_iface(iface)
 346 {
 347         dout("usb_claim_interface(" << dev.GetHandle() << ", 0x" << std::hex << iface << ")");
 348         int ret = usb_claim_interface(dev.GetHandle(), iface);
 349         if( ret < 0 )
 350                 throw Error(ret, "claim interface failed");
 351
 352         // kernels >= 2.6.28 don't set the interface the same as
 353         // previous versions did, and the Blackberry gets confused
 354         // if it isn't explicitly set
 355         ret = usb_set_altinterface(dev.GetHandle(), iface);
 356         if( ret < 0 )
 357                 throw Error(ret, "set alt interface failed");
 358 }
 359
 360 Interface::~Interface()
 361 {
 362         dout("usb_release_interface(" << m_dev.GetHandle() << ", 0x" << std::hex << m_iface << ")");
 363         usb_release_interface(m_dev.GetHandle(), m_iface);
 364 }
 365
 366
 367
 368 ///////////////////////////////////////////////////////////////////////////////
 369 // EndpointDiscovery
 370
 371 bool EndpointDiscovery::Discover(struct usb_interface_descriptor *interface, int epcount)
 372 {
 373         // start fresh
 374         clear();
 375         m_valid = false;
 376
 377         EndpointPair pair;
 378
 379         if( !interface || !interface->endpoint ) {
 380                 dout("EndpointDiscovery::Discover: empty interface pointer");
 381                 return false;
 382         }
 383
 384         for( int i = 0; i < epcount; i++ ) {
 385                 // load descriptor
 386                 usb_endpoint_descriptor desc;
 387                 desc = interface->endpoint[i];
 388                 dout("      endpoint_desc #" << std::dec << i << " loaded"
 389                         << "\nbLength: " << std::dec << (unsigned ) desc.bLength
 390                         << "\nbDescriptorType: " << std::dec << (unsigned ) desc.bDescriptorType
 391                         << "\nbEndpointAddress: 0x" << std::hex << (unsigned ) desc.bEndpointAddress
 392                         << "\nbmAttributes: 0x" << std::hex << (unsigned ) desc.bmAttributes
 393                         << "\nwMaxPacketSize: " << std::dec << (unsigned ) desc.wMaxPacketSize
 394                         << "\nbInterval: " << std::dec << (unsigned ) desc.bInterval
 395                         << "\nbRefresh: " << std::dec << (unsigned ) desc.bRefresh
 396                         << "\nbSynchAddress: " << std::dec << (unsigned ) desc.bSynchAddress
 397                         << "\n"
 398                         );
 399
 400                 // add to the map
 401                 (*this)[desc.bEndpointAddress] = desc;
 402                 dout("      endpoint added to map with bEndpointAddress: 0x" << std::hex << (unsigned int)desc.bEndpointAddress);
 403
 404                 // parse the endpoint into read/write sets, if possible,
 405                 // going in discovery order...
 406                 // Assumptions:
 407                 //      - endpoints of related utility will be grouped
 408                 //      - endpoints with same type will be grouped
 409                 //      - endpoints that do not meet the above assumptions
 410                 //              do not belong in a pair
 411                 unsigned char type = desc.bmAttributes & USB_ENDPOINT_TYPE_MASK;
 412                 if( desc.bEndpointAddress & USB_ENDPOINT_DIR_MASK ) {
 413                         // read endpoint
 414                         pair.read = desc.bEndpointAddress;
 415                         dout("        pair.read = 0x" << std::hex << (unsigned int)pair.read);
 416                         if( pair.IsTypeSet() && pair.type != type ) {
 417                                 // if type is already set, we must start over
 418                                 pair.write = 0;
 419                         }
 420                 }
 421                 else {
 422                         // write endpoint
 423                         pair.write = desc.bEndpointAddress;
 424                         dout("        pair.write = 0x" << std::hex << (unsigned int)pair.write);
 425                         if( pair.IsTypeSet() && pair.type != type ) {
 426                                 // if type is already set, we must start over
 427                                 pair.read = 0;
 428                         }
 429                 }
 430                 // save the type last
 431                 pair.type = type;
 432                 dout("        pair.type = 0x" << std::hex << (unsigned int)pair.type);
 433
 434                 // if pair is complete, add to array
 435                 if( pair.IsComplete() ) {
 436                         m_endpoints.push_back(pair);
 437                         dout("        pair added! ("
 438                                 << "read: 0x" << std::hex << (unsigned int)pair.read << ","
 439                                 << "write: 0x" << std::hex << (unsigned int)pair.write << ","
 440                                 << "type: 0x" << std::hex << (unsigned int)pair.type << ")");
 441                         pair = EndpointPair();  // clear
 442                 }
 443         }
 444
 445         // just for debugging purposes, check for extra descriptors, and
 446         // dump them to dout if they exist
 447         if( interface->extra ) {
 448                 dout("while parsing endpoints, found a block of extra descriptors:");
 449                 Barry::Data data(interface->extra, interface->extralen);
 450                 dout(data);
 451         }
 452
 453         return m_valid = true;
 454 }
 455
 456
 457 ///////////////////////////////////////////////////////////////////////////////
 458 // InterfaceDiscovery
 459
 460 bool InterfaceDiscovery::DiscoverInterface(struct usb_interface *interface)
 461 {
 462         if( !interface->altsetting ) {
 463                 dout("InterfaceDiscovery::DiscoverIterface: empty altsetting");
 464                 // some devices are buggy and return a higher bNumInterfaces
 465                 // than the number of interfaces available... in this case
 466                 // we just skip and continue
 467                 return true;
 468         }
 469
 470         for( int i = 0; i < interface->num_altsetting; i++ ) {
 471                 // load descriptor
 472                 InterfaceDesc desc;
 473                 desc.desc = interface->altsetting[i];
 474                 dout("    interface_desc #" << std::dec << i << " loaded"
 475                         << "\nbLength: " << std::dec << (unsigned) desc.desc.bLength
 476                         << "\nbDescriptorType: " << std::dec << (unsigned) desc.desc.bDescriptorType
 477                         << "\nbInterfaceNumber: " << std::dec << (unsigned) desc.desc.bInterfaceNumber
 478                         << "\nbAlternateSetting: " << std::dec << (unsigned) desc.desc.bAlternateSetting
 479                         << "\nbNumEndpoints: " << std::dec << (unsigned) desc.desc.bNumEndpoints
 480                         << "\nbInterfaceClass: " << std::dec << (unsigned) desc.desc.bInterfaceClass
 481                         << "\nbInterfaceSubClass: " << std::dec << (unsigned) desc.desc.bInterfaceSubClass
 482                         << "\nbInterfaceProtocol: " << std::dec << (unsigned) desc.desc.bInterfaceProtocol
 483                         << "\niInterface: " << std::dec << (unsigned) desc.desc.iInterface
 484                         << "\n"
 485                         );
 486
 487                 // load all endpoints on this interface
 488                 if( !desc.endpoints.Discover(&desc.desc, desc.desc.bNumEndpoints) ) {
 489                         dout("    endpoint discovery failed for bInterfaceNumber: " << std::dec << (unsigned int)desc.desc.bInterfaceNumber << ", not added to map.");
 490                         return false;
 491                 }
 492
 493                 // add to the map
 494                 (*this)[desc.desc.bInterfaceNumber] = desc;
 495                 dout("    interface added to map with bInterfaceNumber: " << std::dec << (unsigned int)desc.desc.bInterfaceNumber);
 496         }
 497         return true;
 498 }
 499
 500 bool InterfaceDiscovery::Discover(Usb::DeviceIDType devid, int cfgidx, int ifcount)
 501 {
 502         // start fresh
 503         clear();
 504         m_valid = false;
 505
 506         if( !devid || !devid->config || !devid->config[cfgidx].interface ) {
 507                 dout("InterfaceDiscovery::Discover: empty devid/config/interface");
 508                 return false;
 509         }
 510
 511         for( int i = 0; i < ifcount; i++ ) {
 512                 if( !DiscoverInterface(&devid->config[cfgidx].interface[i]) )
 513                         return false;
 514         }
 515
 516         return m_valid = true;
 517 }
 518
 519
 520 ///////////////////////////////////////////////////////////////////////////////
 521 // ConfigDiscovery
 522
 523 bool ConfigDiscovery::Discover(Usb::DeviceIDType devid, int cfgcount)
 524 {
 525         // start fresh
 526         clear();
 527         m_valid = false;
 528
 529         for( int i = 0; i < cfgcount; i++ ) {
 530                 // load descriptor
 531                 ConfigDesc desc;
 532                 if( !devid || !devid->config ) {
 533                         dout("ConfigDiscovery::Discover: empty devid or config");
 534                         return false;
 535                 }
 536                 desc.desc = devid->config[i];
 537                 dout("  config_desc #" << std::dec << i << " loaded"
 538                         << "\nbLength: " << std::dec << (unsigned int) desc.desc.bLength
 539                         << "\nbDescriptorType: " << std::dec << (unsigned int) desc.desc.bDescriptorType
 540                         << "\nwTotalLength: " << std::dec << (unsigned int) desc.desc.wTotalLength
 541                         << "\nbNumInterfaces: " << std::dec << (unsigned int) desc.desc.bNumInterfaces
 542                         << "\nbConfigurationValue: " << std::dec << (unsigned int) desc.desc.bConfigurationValue
 543                         << "\niConfiguration: " << std::dec << (unsigned int) desc.desc.iConfiguration
 544                         << "\nbmAttributes: 0x" << std::hex << (unsigned int) desc.desc.bmAttributes
 545                         << "\nMaxPower: " << std::dec << (unsigned int) desc.desc.MaxPower
 546                         << "\n"
 547                         );
 548
 549                 // just for debugging purposes, check for extra descriptors, and
 550                 // dump them to dout if they exist
 551                 if( desc.desc.extra ) {
 552                         dout("while parsing config descriptor, found a block of extra descriptors:");
 553                         Barry::Data data(desc.desc.extra, desc.desc.extralen);
 554                         dout(data);
 555                 }
 556
 557                 // load all interfaces on this configuration
 558                 if( !desc.interfaces.Discover(devid, i, desc.desc.bNumInterfaces) ) {
 559                         dout("  config discovery failed for bConfigurationValue: " << std::dec << (unsigned int)desc.desc.bConfigurationValue << ", not added to map.");
 560                         return false;
 561                 }
 562
 563                 // add to the map
 564                 (*this)[desc.desc.bConfigurationValue] = desc;
 565                 dout("  config added to map with bConfigurationValue: " << std::dec << (unsigned int)desc.desc.bConfigurationValue);
 566         }
 567
 568         return m_valid = true;
 569 }
 570
 571
 572 ///////////////////////////////////////////////////////////////////////////////
 573 // DeviceDiscovery
 574
 575 DeviceDiscovery::DeviceDiscovery(Usb::DeviceIDType devid)
 576         : m_valid(false)
 577 {
 578         Discover(devid);
 579 }
 580
 581 bool DeviceDiscovery::Discover(Usb::DeviceIDType devid)
 582 {
 583         // start fresh
 584         configs.clear();
 585         m_valid = false;
 586
 587         // copy the descriptor over to our memory
 588         if( !devid ) {
 589                 dout("DeviceDiscovery::Discover: empty devid");
 590                 return false;
 591         }
 592
 593         desc = devid->descriptor;
 594         dout("device_desc loaded"
 595                 << "\nbLength: " << std::dec << (unsigned int) desc.bLength
 596                 << "\nbDescriptorType: " << std::dec << (unsigned int) desc.bDescriptorType
 597                 << "\nbcdUSB: 0x" << std::hex << (unsigned int) desc.bcdUSB
 598                 << "\nbDeviceClass: " << std::dec << (unsigned int) desc.bDeviceClass
 599                 << "\nbDeviceSubClass: " << std::dec << (unsigned int) desc.bDeviceSubClass
 600                 << "\nbDeviceProtocol: " << std::dec << (unsigned int) desc.bDeviceProtocol
 601                 << "\nbMaxPacketSize0: " << std::dec << (unsigned int) desc.bMaxPacketSize0
 602                 << "\nidVendor: 0x" << std::hex << (unsigned int) desc.idVendor
 603                 << "\nidProduct: 0x" << std::hex << (unsigned int) desc.idProduct
 604                 << "\nbcdDevice: 0x" << std::hex << (unsigned int) desc.bcdDevice
 605                 << "\niManufacturer: " << std::dec << (unsigned int) desc.iManufacturer
 606                 << "\niProduct: " << std::dec << (unsigned int) desc.iProduct
 607                 << "\niSerialNumber: " << std::dec << (unsigned int) desc.iSerialNumber
 608                 << "\nbNumConfigurations: " << std::dec << (unsigned int) desc.bNumConfigurations
 609                 << "\n"
 610         );
 611
 612         m_valid = configs.Discover(devid, desc.bNumConfigurations);
 613         return m_valid;
 614 }
 615
 616 } // namespace Usb
 617