7 Copyright (C) 2005-2010, Chris Frey
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.
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.
18 See the GNU General Public License in the COPYING file at the
19 root directory of this project for more details.
34 #ifndef __DEBUG_MODE__
35 #define __DEBUG_MODE__
41 ///////////////////////////////////////////////////////////////////////////////
42 // Usb::Error exception class
44 static std::string
GetErrorString(int libusb_errcode
, const std::string
&str
)
46 std::ostringstream oss
;
49 if( libusb_errcode
) {
50 oss
<< std::setbase(10) << libusb_errcode
<< ", ";
53 // oss << strerror(-libusb_errno) << "): "
54 oss
<< usb_strerror() << "): ";
59 Error::Error(const std::string
&str
)
60 : Barry::Error(GetErrorString(0, str
))
65 Error::Error(int libusb_errcode
, const std::string
&str
)
66 : Barry::Error(GetErrorString(libusb_errcode
, str
))
67 , m_libusb_errcode(libusb_errcode
)
72 ///////////////////////////////////////////////////////////////////////////////
75 Match::Match(int vendor
, int product
,
76 const char *busname
, const char *devname
)
86 m_busses
= usb_get_busses();
93 bool Match::ToNum(const char *str
, long &num
)
96 num
= strtol(str
, &end
, 10);
97 return num
>= 0 && // no negative numbers
98 num
!= LONG_MIN
&& num
!= LONG_MAX
&& // no overflow
99 str
!= end
&& *end
== '\0'; // whole string valid
103 // Linux treats bus and device path names as numbers, sometimes left
104 // padded with zeros. Other platforms, such as Windows, use strings,
105 // such as "bus-1" or similar.
107 // Here we try to convert each string to a number, and if successful,
108 // compare them. If unable to convert, then compare as strings.
109 // This way, "3" == "003" and "bus-foobar" == "bus-foobar".
111 bool Match::NameCompare(const char *n1
, const char *n2
)
114 if( ToNum(n1
, l1
) && ToNum(n2
, l2
) ) {
118 return strcmp(n1
, n2
) == 0;
122 bool Match::next_device(Usb::DeviceIDType
*devid
)
124 for( ; m_busses
; m_busses
= m_busses
->next
) {
126 // only search on given bus
127 if( m_busname
&& !NameCompare(m_busname
, m_busses
->dirname
) )
131 m_dev
= m_busses
->devices
;
133 for( ; m_dev
; m_dev
= m_dev
->next
) {
135 // search for specific device
136 if( m_devname
&& !NameCompare(m_devname
, m_dev
->filename
) )
140 if( m_dev
->descriptor
.idVendor
== m_vendor
&&
141 m_dev
->descriptor
.idProduct
== m_product
) {
145 // advance for next time
148 m_busses
= m_busses
->next
;
159 ///////////////////////////////////////////////////////////////////////////////
162 Device::Device(Usb::DeviceIDType id
, int timeout
)
166 dout("usb_open(" << std::dec
<< id
<< ")");
167 m_handle
= usb_open(id
);
169 throw Error("open failed");
174 dout("usb_close(" << std::dec
<< m_handle
<< ")");
178 bool Device::SetConfiguration(unsigned char cfg
)
180 dout("usb_set_configuration(" << std::dec
<< m_handle
<< ", 0x" << std::hex
<< (unsigned int) cfg
<< ")");
181 int ret
= usb_set_configuration(m_handle
, cfg
);
186 bool Device::ClearHalt(int ep
)
188 dout("usb_clear_halt(" << std::dec
<< m_handle
<< ", 0x" << std::hex
<< ep
<< ")");
189 int ret
= usb_clear_halt(m_handle
, ep
);
196 dout("usb_reset(" << std::dec
<< m_handle
<< ")");
197 int ret
= usb_reset(m_handle
);
202 bool Device::BulkRead(int ep
, Barry::Data
&data
, int timeout
)
207 ret
= usb_bulk_read(m_handle
, ep
,
208 (char*) data
.GetBuffer(), data
.GetBufSize(),
209 timeout
== -1 ? m_timeout
: timeout
);
210 if( ret
< 0 && ret
!= -EINTR
&& ret
!= -EAGAIN
) {
212 if( ret
== -ETIMEDOUT
)
213 throw Timeout(ret
, "Timeout in usb_bulk_read");
215 throw Error(ret
, "Error in usb_bulk_read");
218 data
.ReleaseBuffer(ret
);
219 } while( ret
== -EINTR
|| ret
== -EAGAIN
);
224 bool Device::BulkWrite(int ep
, const Barry::Data
&data
, int timeout
)
226 ddout("BulkWrite to endpoint 0x" << std::hex
<< ep
<< ":\n" << data
);
229 ret
= usb_bulk_write(m_handle
, ep
,
230 (char*) data
.GetData(), data
.GetSize(),
231 timeout
== -1 ? m_timeout
: timeout
);
232 if( ret
< 0 && ret
!= -EINTR
&& ret
!= -EAGAIN
) {
234 if( ret
== -ETIMEDOUT
)
235 throw Timeout(ret
, "Timeout in usb_bulk_write (1)");
237 throw Error(ret
, "Error in usb_bulk_write (1)");
239 } while( ret
== -EINTR
|| ret
== -EAGAIN
);
244 bool Device::BulkWrite(int ep
, const void *data
, size_t size
, int timeout
)
246 #ifdef __DEBUG_MODE__
247 Barry::Data
dump(data
, size
);
248 ddout("BulkWrite to endpoint 0x" << std::hex
<< ep
<< ":\n" << dump
);
253 ret
= usb_bulk_write(m_handle
, ep
,
255 timeout
== -1 ? m_timeout
: timeout
);
256 if( ret
< 0 && ret
!= -EINTR
&& ret
!= -EAGAIN
) {
258 if( ret
== -ETIMEDOUT
)
259 throw Timeout(ret
, "Timeout in usb_bulk_write (2)");
261 throw Error(ret
, "Error in usb_bulk_write (2)");
263 } while( ret
== -EINTR
|| ret
== -EAGAIN
);
268 bool Device::InterruptRead(int ep
, Barry::Data
&data
, int timeout
)
273 ret
= usb_interrupt_read(m_handle
, ep
,
274 (char*) data
.GetBuffer(), data
.GetBufSize(),
275 timeout
== -1 ? m_timeout
: timeout
);
276 if( ret
< 0 && ret
!= -EINTR
&& ret
!= -EAGAIN
) {
278 if( ret
== -ETIMEDOUT
)
279 throw Timeout(ret
, "Timeout in usb_interrupt_read");
281 throw Error(ret
, "Error in usb_interrupt_read");
284 data
.ReleaseBuffer(ret
);
285 } while( ret
== -EINTR
|| ret
== -EAGAIN
);
290 bool Device::InterruptWrite(int ep
, const Barry::Data
&data
, int timeout
)
292 ddout("InterruptWrite to endpoint 0x" << std::hex
<< ep
<< ":\n" << data
);
296 ret
= usb_interrupt_write(m_handle
, ep
,
297 (char*) data
.GetData(), data
.GetSize(),
298 timeout
== -1 ? m_timeout
: timeout
);
299 if( ret
< 0 && ret
!= -EINTR
&& ret
!= -EAGAIN
) {
301 if( ret
== -ETIMEDOUT
)
302 throw Timeout(ret
, "Timeout in usb_interrupt_write");
304 throw Error(ret
, "Error in usb_interrupt_write");
306 } while( ret
== -EINTR
|| ret
== -EAGAIN
);
314 /// Reads anything available on the given endpoint, with a low timeout,
315 /// in order to clear any pending reads.
317 void Device::BulkDrain(int ep
, int timeout
)
321 while( BulkRead(ep
, data
, timeout
) )
324 catch( Usb::Error
& ) {}
330 /// Uses the GET_CONFIGURATION control message to determine the currently
331 /// selected USB configuration, returning it in the cfg argument.
332 /// If unsuccessful, returns false.
334 bool Device::GetConfiguration(unsigned char &cfg
)
336 int result
= usb_control_msg(m_handle
, 0x80, USB_REQ_GET_CONFIGURATION
, 0, 0,
337 (char*) &cfg
, 1, m_timeout
);
338 m_lasterror
= result
;
345 /// Uses the usb_set_altinterface() function to set the currently
346 /// selected USB alternate setting of the current interface.
347 /// The iface parameter passed in should be a value specified
348 /// in the bAlternateSetting descriptor field.
349 /// If unsuccessful, returns false.
351 bool Device::SetAltInterface(int iface
)
353 int result
= usb_set_altinterface(m_handle
, iface
);
354 m_lasterror
= result
;
360 ///////////////////////////////////////////////////////////////////////////////
363 Interface::Interface(Device
&dev
, int iface
)
364 : m_dev(dev
), m_iface(iface
)
366 dout("usb_claim_interface(" << dev
.GetHandle() << ", 0x" << std::hex
<< iface
<< ")");
367 int ret
= usb_claim_interface(dev
.GetHandle(), iface
);
369 throw Error(ret
, "claim interface failed");
372 Interface::~Interface()
374 dout("usb_release_interface(" << m_dev
.GetHandle() << ", 0x" << std::hex
<< m_iface
<< ")");
375 usb_release_interface(m_dev
.GetHandle(), m_iface
);
380 ///////////////////////////////////////////////////////////////////////////////
383 bool EndpointDiscovery::Discover(struct usb_interface_descriptor
*interface
, int epcount
)
391 if( !interface
|| !interface
->endpoint
) {
392 dout("EndpointDiscovery::Discover: empty interface pointer");
396 for( int i
= 0; i
< epcount
; i
++ ) {
398 usb_endpoint_descriptor desc
;
399 desc
= interface
->endpoint
[i
];
400 dout(" endpoint_desc #" << std::dec
<< i
<< " loaded"
401 << "\nbLength: " << std::dec
<< (unsigned ) desc
.bLength
402 << "\nbDescriptorType: " << std::dec
<< (unsigned ) desc
.bDescriptorType
403 << "\nbEndpointAddress: 0x" << std::hex
<< (unsigned ) desc
.bEndpointAddress
404 << "\nbmAttributes: 0x" << std::hex
<< (unsigned ) desc
.bmAttributes
405 << "\nwMaxPacketSize: " << std::dec
<< (unsigned ) desc
.wMaxPacketSize
406 << "\nbInterval: " << std::dec
<< (unsigned ) desc
.bInterval
407 << "\nbRefresh: " << std::dec
<< (unsigned ) desc
.bRefresh
408 << "\nbSynchAddress: " << std::dec
<< (unsigned ) desc
.bSynchAddress
413 (*this)[desc
.bEndpointAddress
] = desc
;
414 dout(" endpoint added to map with bEndpointAddress: 0x" << std::hex
<< (unsigned int)desc
.bEndpointAddress
);
416 // parse the endpoint into read/write sets, if possible,
417 // going in discovery order...
419 // - endpoints of related utility will be grouped
420 // - endpoints with same type will be grouped
421 // - endpoints that do not meet the above assumptions
422 // do not belong in a pair
423 unsigned char type
= desc
.bmAttributes
& USB_ENDPOINT_TYPE_MASK
;
424 if( desc
.bEndpointAddress
& USB_ENDPOINT_DIR_MASK
) {
426 pair
.read
= desc
.bEndpointAddress
;
427 dout(" pair.read = 0x" << std::hex
<< (unsigned int)pair
.read
);
428 if( pair
.IsTypeSet() && pair
.type
!= type
) {
429 // if type is already set, we must start over
435 pair
.write
= desc
.bEndpointAddress
;
436 dout(" pair.write = 0x" << std::hex
<< (unsigned int)pair
.write
);
437 if( pair
.IsTypeSet() && pair
.type
!= type
) {
438 // if type is already set, we must start over
442 // save the type last
444 dout(" pair.type = 0x" << std::hex
<< (unsigned int)pair
.type
);
446 // if pair is complete, add to array
447 if( pair
.IsComplete() ) {
448 m_endpoints
.push_back(pair
);
449 dout(" pair added! ("
450 << "read: 0x" << std::hex
<< (unsigned int)pair
.read
<< ","
451 << "write: 0x" << std::hex
<< (unsigned int)pair
.write
<< ","
452 << "type: 0x" << std::hex
<< (unsigned int)pair
.type
<< ")");
453 pair
= EndpointPair(); // clear
457 // just for debugging purposes, check for extra descriptors, and
458 // dump them to dout if they exist
459 if( interface
->extra
) {
460 dout("while parsing endpoints, found a block of extra descriptors:");
461 Barry::Data
data(interface
->extra
, interface
->extralen
);
465 return m_valid
= true;
469 ///////////////////////////////////////////////////////////////////////////////
470 // InterfaceDiscovery
472 bool InterfaceDiscovery::DiscoverInterface(struct usb_interface
*interface
)
474 if( !interface
->altsetting
) {
475 dout("InterfaceDiscovery::DiscoverIterface: empty altsetting");
476 // some devices are buggy and return a higher bNumInterfaces
477 // than the number of interfaces available... in this case
478 // we just skip and continue
482 for( int i
= 0; i
< interface
->num_altsetting
; i
++ ) {
485 desc
.desc
= interface
->altsetting
[i
];
486 dout(" interface_desc #" << std::dec
<< i
<< " loaded"
487 << "\nbLength: " << std::dec
<< (unsigned) desc
.desc
.bLength
488 << "\nbDescriptorType: " << std::dec
<< (unsigned) desc
.desc
.bDescriptorType
489 << "\nbInterfaceNumber: " << std::dec
<< (unsigned) desc
.desc
.bInterfaceNumber
490 << "\nbAlternateSetting: " << std::dec
<< (unsigned) desc
.desc
.bAlternateSetting
491 << "\nbNumEndpoints: " << std::dec
<< (unsigned) desc
.desc
.bNumEndpoints
492 << "\nbInterfaceClass: " << std::dec
<< (unsigned) desc
.desc
.bInterfaceClass
493 << "\nbInterfaceSubClass: " << std::dec
<< (unsigned) desc
.desc
.bInterfaceSubClass
494 << "\nbInterfaceProtocol: " << std::dec
<< (unsigned) desc
.desc
.bInterfaceProtocol
495 << "\niInterface: " << std::dec
<< (unsigned) desc
.desc
.iInterface
499 // load all endpoints on this interface
500 if( !desc
.endpoints
.Discover(&desc
.desc
, desc
.desc
.bNumEndpoints
) ) {
501 dout(" endpoint discovery failed for bInterfaceNumber: " << std::dec
<< (unsigned int)desc
.desc
.bInterfaceNumber
<< ", not added to map.");
506 (*this)[desc
.desc
.bInterfaceNumber
] = desc
;
507 dout(" interface added to map with bInterfaceNumber: " << std::dec
<< (unsigned int)desc
.desc
.bInterfaceNumber
);
512 bool InterfaceDiscovery::Discover(Usb::DeviceIDType devid
, int cfgidx
, int ifcount
)
518 if( !devid
|| !devid
->config
|| !devid
->config
[cfgidx
].interface
) {
519 dout("InterfaceDiscovery::Discover: empty devid/config/interface");
523 for( int i
= 0; i
< ifcount
; i
++ ) {
524 if( !DiscoverInterface(&devid
->config
[cfgidx
].interface
[i
]) )
528 return m_valid
= true;
532 ///////////////////////////////////////////////////////////////////////////////
535 bool ConfigDiscovery::Discover(Usb::DeviceIDType devid
, int cfgcount
)
541 for( int i
= 0; i
< cfgcount
; i
++ ) {
544 if( !devid
|| !devid
->config
) {
545 dout("ConfigDiscovery::Discover: empty devid or config");
548 desc
.desc
= devid
->config
[i
];
549 dout(" config_desc #" << std::dec
<< i
<< " loaded"
550 << "\nbLength: " << std::dec
<< (unsigned int) desc
.desc
.bLength
551 << "\nbDescriptorType: " << std::dec
<< (unsigned int) desc
.desc
.bDescriptorType
552 << "\nwTotalLength: " << std::dec
<< (unsigned int) desc
.desc
.wTotalLength
553 << "\nbNumInterfaces: " << std::dec
<< (unsigned int) desc
.desc
.bNumInterfaces
554 << "\nbConfigurationValue: " << std::dec
<< (unsigned int) desc
.desc
.bConfigurationValue
555 << "\niConfiguration: " << std::dec
<< (unsigned int) desc
.desc
.iConfiguration
556 << "\nbmAttributes: 0x" << std::hex
<< (unsigned int) desc
.desc
.bmAttributes
557 << "\nMaxPower: " << std::dec
<< (unsigned int) desc
.desc
.MaxPower
561 // just for debugging purposes, check for extra descriptors, and
562 // dump them to dout if they exist
563 if( desc
.desc
.extra
) {
564 dout("while parsing config descriptor, found a block of extra descriptors:");
565 Barry::Data
data(desc
.desc
.extra
, desc
.desc
.extralen
);
569 // load all interfaces on this configuration
570 if( !desc
.interfaces
.Discover(devid
, i
, desc
.desc
.bNumInterfaces
) ) {
571 dout(" config discovery failed for bConfigurationValue: " << std::dec
<< (unsigned int)desc
.desc
.bConfigurationValue
<< ", not added to map.");
576 (*this)[desc
.desc
.bConfigurationValue
] = desc
;
577 dout(" config added to map with bConfigurationValue: " << std::dec
<< (unsigned int)desc
.desc
.bConfigurationValue
);
580 return m_valid
= true;
584 ///////////////////////////////////////////////////////////////////////////////
587 DeviceDiscovery::DeviceDiscovery(Usb::DeviceIDType devid
)
593 bool DeviceDiscovery::Discover(Usb::DeviceIDType devid
)
599 // copy the descriptor over to our memory
601 dout("DeviceDiscovery::Discover: empty devid");
605 desc
= devid
->descriptor
;
606 dout("device_desc loaded"
607 << "\nbLength: " << std::dec
<< (unsigned int) desc
.bLength
608 << "\nbDescriptorType: " << std::dec
<< (unsigned int) desc
.bDescriptorType
609 << "\nbcdUSB: 0x" << std::hex
<< (unsigned int) desc
.bcdUSB
610 << "\nbDeviceClass: " << std::dec
<< (unsigned int) desc
.bDeviceClass
611 << "\nbDeviceSubClass: " << std::dec
<< (unsigned int) desc
.bDeviceSubClass
612 << "\nbDeviceProtocol: " << std::dec
<< (unsigned int) desc
.bDeviceProtocol
613 << "\nbMaxPacketSize0: " << std::dec
<< (unsigned int) desc
.bMaxPacketSize0
614 << "\nidVendor: 0x" << std::hex
<< (unsigned int) desc
.idVendor
615 << "\nidProduct: 0x" << std::hex
<< (unsigned int) desc
.idProduct
616 << "\nbcdDevice: 0x" << std::hex
<< (unsigned int) desc
.bcdDevice
617 << "\niManufacturer: " << std::dec
<< (unsigned int) desc
.iManufacturer
618 << "\niProduct: " << std::dec
<< (unsigned int) desc
.iProduct
619 << "\niSerialNumber: " << std::dec
<< (unsigned int) desc
.iSerialNumber
620 << "\nbNumConfigurations: " << std::dec
<< (unsigned int) desc
.bNumConfigurations
624 m_valid
= configs
.Discover(devid
, desc
.bNumConfigurations
);