src/usbwrap.cc

   1 ///
   2 /// \file       usbwrap.cc
   3 ///             USB API wrapper
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2010, 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                 else if( ret > 0 )
 217                         data.ReleaseBuffer(ret);
 218         } while( ret == -EINTR || ret == -EAGAIN );
 219
 220         return ret >= 0;
 221 }
 222
 223 bool Device::BulkWrite(int ep, const Barry::Data &data, int timeout)
 224 {
 225         ddout("BulkWrite to endpoint 0x" << std::hex << ep << ":\n" << data);
 226         int ret;
 227         do {
 228                 ret = usb_bulk_write(m_handle, ep,
 229                         (char*) data.GetData(), data.GetSize(),
 230                         timeout == -1 ? m_timeout : timeout);
 231                 if( ret < 0 && ret != -EINTR && ret != -EAGAIN ) {
 232                         m_lasterror = ret;
 233                         if( ret == -ETIMEDOUT )
 234                                 throw Timeout(ret, "Timeout in usb_bulk_write (1)");
 235                         else
 236                                 throw Error(ret, "Error in usb_bulk_write (1)");
 237                 }
 238         } while( ret == -EINTR || ret == -EAGAIN );
 239
 240         return ret >= 0;
 241 }
 242
 243 bool Device::BulkWrite(int ep, const void *data, size_t size, int timeout)
 244 {
 245 #ifdef __DEBUG_MODE__
 246         Barry::Data dump(data, size);
 247         ddout("BulkWrite to endpoint 0x" << std::hex << ep << ":\n" << dump);
 248 #endif
 249
 250         int ret;
 251         do {
 252                 ret = usb_bulk_write(m_handle, ep,
 253                         (char*) data, size,
 254                         timeout == -1 ? m_timeout : timeout);
 255                 if( ret < 0 && ret != -EINTR && ret != -EAGAIN ) {
 256                         m_lasterror = ret;
 257                         if( ret == -ETIMEDOUT )
 258                                 throw Timeout(ret, "Timeout in usb_bulk_write (2)");
 259                         else
 260                                 throw Error(ret, "Error in usb_bulk_write (2)");
 261                 }
 262         } while( ret == -EINTR || ret == -EAGAIN );
 263
 264         return ret >= 0;
 265 }
 266
 267 bool Device::InterruptRead(int ep, Barry::Data &data, int timeout)
 268 {
 269         int ret;
 270         do {
 271                 data.QuickZap();
 272                 ret = usb_interrupt_read(m_handle, ep,
 273                         (char*) data.GetBuffer(), data.GetBufSize(),
 274                         timeout == -1 ? m_timeout : timeout);
 275                 if( ret < 0 && ret != -EINTR && ret != -EAGAIN ) {
 276                         m_lasterror = ret;
 277                         if( ret == -ETIMEDOUT )
 278                                 throw Timeout(ret, "Timeout in usb_interrupt_read");
 279                         else
 280                                 throw Error(ret, "Error in usb_interrupt_read");
 281                 }
 282                 else if( ret > 0 )
 283                         data.ReleaseBuffer(ret);
 284         } while( ret == -EINTR || ret == -EAGAIN );
 285
 286         return ret >= 0;
 287 }
 288
 289 bool Device::InterruptWrite(int ep, const Barry::Data &data, int timeout)
 290 {
 291         ddout("InterruptWrite to endpoint 0x" << std::hex << ep << ":\n" << data);
 292
 293         int ret;
 294         do {
 295                 ret = usb_interrupt_write(m_handle, ep,
 296                         (char*) data.GetData(), data.GetSize(),
 297                         timeout == -1 ? m_timeout : timeout);
 298                 if( ret < 0 && ret != -EINTR && ret != -EAGAIN ) {
 299                         m_lasterror = ret;
 300                         if( ret == -ETIMEDOUT )
 301                                 throw Timeout(ret, "Timeout in usb_interrupt_write");
 302                         else
 303                                 throw Error(ret, "Error in usb_interrupt_write");
 304                 }
 305         } while( ret == -EINTR || ret == -EAGAIN );
 306
 307         return ret >= 0;
 308 }
 309
 310 //
 311 // BulkDrain
 312 //
 313 /// Reads anything available on the given endpoint, with a low timeout,
 314 /// in order to clear any pending reads.
 315 ///
 316 void Device::BulkDrain(int ep, int timeout)
 317 {
 318         try {
 319                 Barry::Data data;
 320                 while( BulkRead(ep, data, timeout) )
 321                 ;
 322         }
 323         catch( Usb::Error & ) {}
 324 }
 325
 326 //
 327 // GetConfiguration
 328 //
 329 /// Uses the GET_CONFIGURATION control message to determine the currently
 330 /// selected USB configuration, returning it in the cfg argument.
 331 /// If unsuccessful, returns false.
 332 ///
 333 bool Device::GetConfiguration(unsigned char &cfg)
 334 {
 335         int result = usb_control_msg(m_handle, 0x80, USB_REQ_GET_CONFIGURATION, 0, 0,
 336                 (char*) &cfg, 1, m_timeout);
 337         m_lasterror = result;
 338         return result >= 0;
 339 }
 340
 341
 342
 343 ///////////////////////////////////////////////////////////////////////////////
 344 // Interface
 345
 346 Interface::Interface(Device &dev, int iface)
 347         : m_dev(dev), m_iface(iface)
 348 {
 349         dout("usb_claim_interface(" << dev.GetHandle() << ", 0x" << std::hex << iface << ")");
 350         int ret = usb_claim_interface(dev.GetHandle(), iface);
 351         if( ret < 0 )
 352                 throw Error(ret, "claim interface failed");
 353 }
 354
 355 Interface::~Interface()
 356 {
 357         dout("usb_release_interface(" << m_dev.GetHandle() << ", 0x" << std::hex << m_iface << ")");
 358         usb_release_interface(m_dev.GetHandle(), m_iface);
 359 }
 360
 361
 362
 363 ///////////////////////////////////////////////////////////////////////////////
 364 // EndpointDiscovery
 365
 366 bool EndpointDiscovery::Discover(struct usb_interface_descriptor *interface, int epcount)
 367 {
 368         // start fresh
 369         clear();
 370         m_valid = false;
 371
 372         EndpointPair pair;
 373
 374         if( !interface || !interface->endpoint ) {
 375                 dout("EndpointDiscovery::Discover: empty interface pointer");
 376                 return false;
 377         }
 378
 379         for( int i = 0; i < epcount; i++ ) {
 380                 // load descriptor
 381                 usb_endpoint_descriptor desc;
 382                 desc = interface->endpoint[i];
 383                 dout("      endpoint_desc #" << std::dec << i << " loaded"
 384                         << "\nbLength: " << std::dec << (unsigned ) desc.bLength
 385                         << "\nbDescriptorType: " << std::dec << (unsigned ) desc.bDescriptorType
 386                         << "\nbEndpointAddress: 0x" << std::hex << (unsigned ) desc.bEndpointAddress
 387                         << "\nbmAttributes: 0x" << std::hex << (unsigned ) desc.bmAttributes
 388                         << "\nwMaxPacketSize: " << std::dec << (unsigned ) desc.wMaxPacketSize
 389                         << "\nbInterval: " << std::dec << (unsigned ) desc.bInterval
 390                         << "\nbRefresh: " << std::dec << (unsigned ) desc.bRefresh
 391                         << "\nbSynchAddress: " << std::dec << (unsigned ) desc.bSynchAddress
 392                         << "\n"
 393                         );
 394
 395                 // add to the map
 396                 (*this)[desc.bEndpointAddress] = desc;
 397                 dout("      endpoint added to map with bEndpointAddress: 0x" << std::hex << (unsigned int)desc.bEndpointAddress);
 398
 399                 // parse the endpoint into read/write sets, if possible,
 400                 // going in discovery order...
 401                 // Assumptions:
 402                 //      - endpoints of related utility will be grouped
 403                 //      - endpoints with same type will be grouped
 404                 //      - endpoints that do not meet the above assumptions
 405                 //              do not belong in a pair
 406                 unsigned char type = desc.bmAttributes & USB_ENDPOINT_TYPE_MASK;
 407                 if( desc.bEndpointAddress & USB_ENDPOINT_DIR_MASK ) {
 408                         // read endpoint
 409                         pair.read = desc.bEndpointAddress;
 410                         dout("        pair.read = 0x" << std::hex << (unsigned int)pair.read);
 411                         if( pair.IsTypeSet() && pair.type != type ) {
 412                                 // if type is already set, we must start over
 413                                 pair.write = 0;
 414                         }
 415                 }
 416                 else {
 417                         // write endpoint
 418                         pair.write = desc.bEndpointAddress;
 419                         dout("        pair.write = 0x" << std::hex << (unsigned int)pair.write);
 420                         if( pair.IsTypeSet() && pair.type != type ) {
 421                                 // if type is already set, we must start over
 422                                 pair.read = 0;
 423                         }
 424                 }
 425                 // save the type last
 426                 pair.type = type;
 427                 dout("        pair.type = 0x" << std::hex << (unsigned int)pair.type);
 428
 429                 // if pair is complete, add to array
 430                 if( pair.IsComplete() ) {
 431                         m_endpoints.push_back(pair);
 432                         dout("        pair added! ("
 433                                 << "read: 0x" << std::hex << (unsigned int)pair.read << ","
 434                                 << "write: 0x" << std::hex << (unsigned int)pair.write << ","
 435                                 << "type: 0x" << std::hex << (unsigned int)pair.type << ")");
 436                         pair = EndpointPair();  // clear
 437                 }
 438         }
 439
 440         // just for debugging purposes, check for extra descriptors, and
 441         // dump them to dout if they exist
 442         if( interface->extra ) {
 443                 dout("while parsing endpoints, found a block of extra descriptors:");
 444                 Barry::Data data(interface->extra, interface->extralen);
 445                 dout(data);
 446         }
 447
 448         return m_valid = true;
 449 }
 450
 451
 452 ///////////////////////////////////////////////////////////////////////////////
 453 // InterfaceDiscovery
 454
 455 bool InterfaceDiscovery::DiscoverInterface(struct usb_interface *interface)
 456 {
 457         if( !interface->altsetting ) {
 458                 dout("InterfaceDiscovery::DiscoverIterface: empty altsetting");
 459                 // some devices are buggy and return a higher bNumInterfaces
 460                 // than the number of interfaces available... in this case
 461                 // we just skip and continue
 462                 return true;
 463         }
 464
 465         for( int i = 0; i < interface->num_altsetting; i++ ) {
 466                 // load descriptor
 467                 InterfaceDesc desc;
 468                 desc.desc = interface->altsetting[i];
 469                 dout("    interface_desc #" << std::dec << i << " loaded"
 470                         << "\nbLength: " << std::dec << (unsigned) desc.desc.bLength
 471                         << "\nbDescriptorType: " << std::dec << (unsigned) desc.desc.bDescriptorType
 472                         << "\nbInterfaceNumber: " << std::dec << (unsigned) desc.desc.bInterfaceNumber
 473                         << "\nbAlternateSetting: " << std::dec << (unsigned) desc.desc.bAlternateSetting
 474                         << "\nbNumEndpoints: " << std::dec << (unsigned) desc.desc.bNumEndpoints
 475                         << "\nbInterfaceClass: " << std::dec << (unsigned) desc.desc.bInterfaceClass
 476                         << "\nbInterfaceSubClass: " << std::dec << (unsigned) desc.desc.bInterfaceSubClass
 477                         << "\nbInterfaceProtocol: " << std::dec << (unsigned) desc.desc.bInterfaceProtocol
 478                         << "\niInterface: " << std::dec << (unsigned) desc.desc.iInterface
 479                         << "\n"
 480                         );
 481
 482                 // load all endpoints on this interface
 483                 if( !desc.endpoints.Discover(&desc.desc, desc.desc.bNumEndpoints) ) {
 484                         dout("    endpoint discovery failed for bInterfaceNumber: " << std::dec << (unsigned int)desc.desc.bInterfaceNumber << ", not added to map.");
 485                         return false;
 486                 }
 487
 488                 // add to the map
 489                 (*this)[desc.desc.bInterfaceNumber] = desc;
 490                 dout("    interface added to map with bInterfaceNumber: " << std::dec << (unsigned int)desc.desc.bInterfaceNumber);
 491         }
 492         return true;
 493 }
 494
 495 bool InterfaceDiscovery::Discover(Usb::DeviceIDType devid, int cfgidx, int ifcount)
 496 {
 497         // start fresh
 498         clear();
 499         m_valid = false;
 500
 501         if( !devid || !devid->config || !devid->config[cfgidx].interface ) {
 502                 dout("InterfaceDiscovery::Discover: empty devid/config/interface");
 503                 return false;
 504         }
 505
 506         for( int i = 0; i < ifcount; i++ ) {
 507                 if( !DiscoverInterface(&devid->config[cfgidx].interface[i]) )
 508                         return false;
 509         }
 510
 511         return m_valid = true;
 512 }
 513
 514
 515 ///////////////////////////////////////////////////////////////////////////////
 516 // ConfigDiscovery
 517
 518 bool ConfigDiscovery::Discover(Usb::DeviceIDType devid, int cfgcount)
 519 {
 520         // start fresh
 521         clear();
 522         m_valid = false;
 523
 524         for( int i = 0; i < cfgcount; i++ ) {
 525                 // load descriptor
 526                 ConfigDesc desc;
 527                 if( !devid || !devid->config ) {
 528                         dout("ConfigDiscovery::Discover: empty devid or config");
 529                         return false;
 530                 }
 531                 desc.desc = devid->config[i];
 532                 dout("  config_desc #" << std::dec << i << " loaded"
 533                         << "\nbLength: " << std::dec << (unsigned int) desc.desc.bLength
 534                         << "\nbDescriptorType: " << std::dec << (unsigned int) desc.desc.bDescriptorType
 535                         << "\nwTotalLength: " << std::dec << (unsigned int) desc.desc.wTotalLength
 536                         << "\nbNumInterfaces: " << std::dec << (unsigned int) desc.desc.bNumInterfaces
 537                         << "\nbConfigurationValue: " << std::dec << (unsigned int) desc.desc.bConfigurationValue
 538                         << "\niConfiguration: " << std::dec << (unsigned int) desc.desc.iConfiguration
 539                         << "\nbmAttributes: 0x" << std::hex << (unsigned int) desc.desc.bmAttributes
 540                         << "\nMaxPower: " << std::dec << (unsigned int) desc.desc.MaxPower
 541                         << "\n"
 542                         );
 543
 544                 // just for debugging purposes, check for extra descriptors, and
 545                 // dump them to dout if they exist
 546                 if( desc.desc.extra ) {
 547                         dout("while parsing config descriptor, found a block of extra descriptors:");
 548                         Barry::Data data(desc.desc.extra, desc.desc.extralen);
 549                         dout(data);
 550                 }
 551
 552                 // load all interfaces on this configuration
 553                 if( !desc.interfaces.Discover(devid, i, desc.desc.bNumInterfaces) ) {
 554                         dout("  config discovery failed for bConfigurationValue: " << std::dec << (unsigned int)desc.desc.bConfigurationValue << ", not added to map.");
 555                         return false;
 556                 }
 557
 558                 // add to the map
 559                 (*this)[desc.desc.bConfigurationValue] = desc;
 560                 dout("  config added to map with bConfigurationValue: " << std::dec << (unsigned int)desc.desc.bConfigurationValue);
 561         }
 562
 563         return m_valid = true;
 564 }
 565
 566
 567 ///////////////////////////////////////////////////////////////////////////////
 568 // DeviceDiscovery
 569
 570 DeviceDiscovery::DeviceDiscovery(Usb::DeviceIDType devid)
 571         : m_valid(false)
 572 {
 573         Discover(devid);
 574 }
 575
 576 bool DeviceDiscovery::Discover(Usb::DeviceIDType devid)
 577 {
 578         // start fresh
 579         configs.clear();
 580         m_valid = false;
 581
 582         // copy the descriptor over to our memory
 583         if( !devid ) {
 584                 dout("DeviceDiscovery::Discover: empty devid");
 585                 return false;
 586         }
 587
 588         desc = devid->descriptor;
 589         dout("device_desc loaded"
 590                 << "\nbLength: " << std::dec << (unsigned int) desc.bLength
 591                 << "\nbDescriptorType: " << std::dec << (unsigned int) desc.bDescriptorType
 592                 << "\nbcdUSB: 0x" << std::hex << (unsigned int) desc.bcdUSB
 593                 << "\nbDeviceClass: " << std::dec << (unsigned int) desc.bDeviceClass
 594                 << "\nbDeviceSubClass: " << std::dec << (unsigned int) desc.bDeviceSubClass
 595                 << "\nbDeviceProtocol: " << std::dec << (unsigned int) desc.bDeviceProtocol
 596                 << "\nbMaxPacketSize0: " << std::dec << (unsigned int) desc.bMaxPacketSize0
 597                 << "\nidVendor: 0x" << std::hex << (unsigned int) desc.idVendor
 598                 << "\nidProduct: 0x" << std::hex << (unsigned int) desc.idProduct
 599                 << "\nbcdDevice: 0x" << std::hex << (unsigned int) desc.bcdDevice
 600                 << "\niManufacturer: " << std::dec << (unsigned int) desc.iManufacturer
 601                 << "\niProduct: " << std::dec << (unsigned int) desc.iProduct
 602                 << "\niSerialNumber: " << std::dec << (unsigned int) desc.iSerialNumber
 603                 << "\nbNumConfigurations: " << std::dec << (unsigned int) desc.bNumConfigurations
 604                 << "\n"
 605         );
 606
 607         m_valid = configs.Discover(devid, desc.bNumConfigurations);
 608         return m_valid;
 609 }
 610
 611 } // namespace Usb
 612