usb: Improve error reporting

Author: xlz

examples/protonect/src/command_transaction.cpp

@@ -29,6 +29,8 @@
 
 #include <stdint.h>
 
+#define WRITE_LIBUSB_ERROR(__RESULT) libusb_error_name(__RESULT) << " " << libusb_strerror((libusb_error)__RESULT)
+
 namespace libfreenect2
 {
 namespace protocol
@@ -135,7 +137,7 @@ CommandTransaction::ResultCode CommandTransaction::send(const CommandBase& comma
 
   if(r != LIBUSB_SUCCESS)
   {
-    LOG_ERROR << "bulk transfer failed! libusb error " << r << ": " << libusb_error_name(r);
+    LOG_ERROR << "bulk transfer failed: " << WRITE_LIBUSB_ERROR(r);
     code = Error;
   }
 
@@ -157,7 +159,7 @@ void CommandTransaction::receive(CommandTransaction::Result& result)
 
   if(r != LIBUSB_SUCCESS)
   {
-    LOG_ERROR << "bulk transfer failed! libusb error " << r << ": " << libusb_error_name(r);
+    LOG_ERROR << "bulk transfer failed: " << WRITE_LIBUSB_ERROR(r);
     result.code = Error;
   }
 }

examples/protonect/src/libfreenect2.cpp

@@ -28,6 +28,7 @@
 #include <vector>
 #include <algorithm>
 #include <libusb.h>
+#define WRITE_LIBUSB_ERROR(__RESULT) libusb_error_name(__RESULT) << " " << libusb_strerror((libusb_error)__RESULT)
 
 #include <libfreenect2/libfreenect2.hpp>
 
@@ -101,13 +102,16 @@ class Freenect2DeviceImpl : public Freenect2Device
 struct PrintBusAndDevice
 {
   libusb_device *dev_;
+  int status_;
 
-  PrintBusAndDevice(libusb_device *dev) : dev_(dev) {}
+  PrintBusAndDevice(libusb_device *dev, int status = 0) : dev_(dev), status_(status) {}
 };
 
 std::ostream &operator<<(std::ostream &out, const PrintBusAndDevice& dev)
 {
   out << "@" << int(libusb_get_bus_number(dev.dev_)) << ":" << int(libusb_get_device_address(dev.dev_));
+  if (dev.status_)
+    out << " " << WRITE_LIBUSB_ERROR(dev.status_);
   return out;
 }
 
@@ -130,26 +134,39 @@ class Freenect2Impl
   UsbDeviceVector enumerated_devices_;
   DeviceVector devices_;
 
+  bool initialized;
+
   Freenect2Impl(void *usb_context) :
     managed_usb_context_(usb_context == 0),
     usb_context_(reinterpret_cast<libusb_context *>(usb_context)),
+    initialized(false),
     has_device_enumeration_(false)
   {
+    if (libusb_get_version()->nano < 10952)
+    {
+      LOG_ERROR << "Your libusb does not support large iso buffer!";
+      return;
+    }
+
     if(managed_usb_context_)
     {
       int r = libusb_init(&usb_context_);
-      // TODO: error handling
       if(r != 0)
       {
-        LOG_ERROR << "failed to create usb context!";
+        LOG_ERROR << "failed to create usb context: " << WRITE_LIBUSB_ERROR(r);
+        return;
       }
     }
 
     usb_event_loop_.start(usb_context_);
+    initialized = true;
   }
 
   ~Freenect2Impl()
   {
+    if (!initialized)
+      return;
+
     clearDevices();
     clearDeviceEnumeration();
 
@@ -165,11 +182,17 @@ class Freenect2Impl
 
   void addDevice(Freenect2DeviceImpl *device)
   {
+    if (!initialized)
+      return;
+
     devices_.push_back(device);
   }
 
   void removeDevice(Freenect2DeviceImpl *device)
   {
+    if (!initialized)
+      return;
+
     DeviceVector::iterator it = std::find(devices_.begin(), devices_.end(), device);
 
     if(it != devices_.end())
@@ -184,6 +207,9 @@ class Freenect2Impl
 
   bool tryGetDevice(libusb_device *usb_device, Freenect2DeviceImpl **device)
   {
+    if (!initialized)
+      return false;
+
     for(DeviceVector::iterator it = devices_.begin(); it != devices_.end(); ++it)
     {
       if((*it)->isSameUsbDevice(usb_device))
@@ -198,6 +224,9 @@ class Freenect2Impl
 
   void clearDevices()
   {
+    if (!initialized)
+      return;
+
     DeviceVector devices(devices_.begin(), devices_.end());
 
     for(DeviceVector::iterator it = devices.begin(); it != devices.end(); ++it)
@@ -213,6 +242,9 @@ class Freenect2Impl
 
   void clearDeviceEnumeration()
   {
+    if (!initialized)
+      return;
+
     // free enumerated device pointers, this should not affect opened devices
     for(UsbDeviceVector::iterator it = enumerated_devices_.begin(); it != enumerated_devices_.end(); ++it)
     {
@@ -225,6 +257,9 @@ class Freenect2Impl
 
   void enumerateDevices()
   {
+    if (!initialized)
+      return;
+
     LOG_INFO << "enumerating devices...";
     libusb_device **device_list;
     int num_devices = libusb_get_device_list(usb_context_, &device_list);
@@ -277,14 +312,14 @@ class Freenect2Impl
               }
               else
               {
-                LOG_ERROR << "failed to get serial number of Kinect v2 " << PrintBusAndDevice(dev) << "!";
+                LOG_ERROR << "failed to get serial number of Kinect v2: " << PrintBusAndDevice(dev, r);
               }
 
               libusb_close(dev_handle);
             }
             else
             {
-              LOG_ERROR << "failed to open Kinect v2 " << PrintBusAndDevice(dev) << "!";
+              LOG_ERROR << "failed to open Kinect v2: " << PrintBusAndDevice(dev, r);
             }
           }
         }
@@ -300,6 +335,9 @@ class Freenect2Impl
 
   int getNumDevices()
   {
+    if (!initialized)
+      return 0;
+
     if(!has_device_enumeration_)
     {
       enumerateDevices();
@@ -654,6 +692,9 @@ int Freenect2::enumerateDevices()
 
 std::string Freenect2::getDeviceSerialNumber(int idx)
 {
+  if (!impl_->initialized)
+    return std::string();
+
   return impl_->enumerated_devices_[idx].serial;
 }
 
@@ -701,7 +742,7 @@ Freenect2Device *Freenect2::openDevice(int idx, const PacketPipeline *pipeline,
 
   if(r != LIBUSB_SUCCESS)
   {
-    LOG_ERROR << "failed to open Kinect v2 " << PrintBusAndDevice(dev.dev) << "!";
+    LOG_ERROR << "failed to open Kinect v2: " << PrintBusAndDevice(dev.dev, r);
     delete pipeline;
 
     return device;
@@ -740,7 +781,7 @@ Freenect2Device *Freenect2::openDevice(int idx, const PacketPipeline *pipeline,
     }
     else if(r != LIBUSB_SUCCESS)
     {
-      LOG_ERROR << "failed to reset Kinect v2 " << PrintBusAndDevice(dev.dev) << "!";
+      LOG_ERROR << "failed to reset Kinect v2: " << PrintBusAndDevice(dev.dev, r);
       delete pipeline;
 
       return device;
@@ -755,7 +796,7 @@ Freenect2Device *Freenect2::openDevice(int idx, const PacketPipeline *pipeline,
     delete device;
     device = 0;
 
-    LOG_ERROR << "failed to open Kinect v2 " << PrintBusAndDevice(dev.dev) << "!";
+    LOG_ERROR << "failed to open Kinect v2: " << PrintBusAndDevice(dev.dev);
   }
 
   return device;

examples/protonect/src/transfer_pool.cpp

@@ -27,6 +27,8 @@
 #include <libfreenect2/usb/transfer_pool.h>
 #include <libfreenect2/logging.h>
 
+#define WRITE_LIBUSB_ERROR(__RESULT) libusb_error_name(__RESULT) << " " << libusb_strerror((libusb_error)__RESULT)
+
 namespace libfreenect2
 {
 namespace usb
@@ -84,8 +86,10 @@ void TransferPool::submit(size_t num_parallel_transfers)
   if(transfers_.size() < num_parallel_transfers)
   {
     LOG_ERROR << "too few idle transfers!";
+    return;
   }
 
+  size_t failcount = 0;
   for(size_t i = 0; i < num_parallel_transfers; ++i)
   {
     libusb_transfer *transfer = transfers_[i].transfer;
@@ -95,10 +99,14 @@ void TransferPool::submit(size_t num_parallel_transfers)
 
     if(r != LIBUSB_SUCCESS)
     {
-      LOG_ERROR << "failed to submit transfer: " << libusb_error_name(r);
+      LOG_ERROR << "failed to submit transfer: " << WRITE_LIBUSB_ERROR(r);
       transfers_[i].setStopped(true);
+      failcount++;
     }
   }
+
+  if (failcount == num_parallel_transfers)
+    LOG_ERROR << "all submissions failed. Try debugging with environment variable: LIBUSB_DEBUG=4.";
 }
 
 void TransferPool::cancel()
@@ -109,7 +117,7 @@ void TransferPool::cancel()
 
     if(r != LIBUSB_SUCCESS && r != LIBUSB_ERROR_NOT_FOUND)
     {
-      LOG_ERROR << "failed to cancel transfer: " << libusb_error_name(r);
+      LOG_ERROR << "failed to cancel transfer: " << WRITE_LIBUSB_ERROR(r);
     }
   }
 
@@ -186,7 +194,7 @@ void TransferPool::onTransferComplete(TransferPool::Transfer* t)
 
   if(r != LIBUSB_SUCCESS)
   {
-    LOG_ERROR << "failed to submit transfer: " << libusb_error_name(r);
+    LOG_ERROR << "failed to submit transfer: " << WRITE_LIBUSB_ERROR(r);
     t->setStopped(true);
   }
 }

examples/protonect/src/usb_control.cpp

@@ -188,7 +188,7 @@ UsbControl::~UsbControl()
 }
 
 #define CHECK_LIBUSB_RESULT(__CODE, __RESULT) if((__CODE = (__RESULT == LIBUSB_SUCCESS ? Success : Error)) == Error) LOG_ERROR
-#define WRITE_LIBUSB_ERROR(__RESULT) "libusb error " << __RESULT << ": " << libusb_error_name(__RESULT)
+#define WRITE_LIBUSB_ERROR(__RESULT) libusb_error_name(__RESULT) << " " << libusb_strerror((libusb_error)__RESULT) << ". Try debugging with environment variable: export LIBUSB_DEBUG=4 ."
 
 UsbControl::ResultCode UsbControl::setConfiguration()
 {