src/probe.cc

   1 ///
   2 /// \file       probe.cc
   3 ///             USB Blackberry detection routines
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2013, Net Direct Inc. (http://www.netdirect.ca/)
   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 #include "i18n.h"
  23 #include "common.h"
  24 #include "probe.h"
  25 #include "usbwrap.h"
  26 #include "data.h"
  27 #include "endian.h"
  28 #include "error.h"
  29 #include "debug.h"
  30 #include "packet.h"
  31 #include "socket.h"
  32 #include "protocol.h"
  33 #include "protostructs.h"
  34 #include "record-internal.h"
  35 #include "strnlen.h"
  36 #include "configfile.h"
  37 #include "platform.h"
  38 #include <iomanip>
  39 #include <sstream>
  40 #include <errno.h>
  41 #include <string.h>
  42 #include "ios_state.h"
  43
  44 using namespace Usb;
  45
  46 namespace Barry {
  47
  48 unsigned char Intro_Sends[][32] = {
  49         // packet #1
  50         { 0x00, 0x00, 0x10, 0x00, 0x01, 0xff, 0x00, 0x00,
  51           0xa8, 0x18, 0xda, 0x8d, 0x6c, 0x02, 0x00, 0x00 }
  52 };
  53
  54
  55 unsigned char Intro_Receives[][32] = {
  56         // response to packet #1
  57         { 0x00, 0x00, 0x10, 0x00, 0x02, 0xff, 0x00, 0x00,
  58           0xa8, 0x18, 0xda, 0x8d, 0x6c, 0x02, 0x00, 0x00 }
  59 };
  60
  61 namespace {
  62
  63         unsigned int GetSize(const unsigned char *packet)
  64         {
  65                 const Protocol::Packet *pack = (const Protocol::Packet*) packet;
  66                 return btohs(pack->size);
  67         }
  68
  69         bool Intro(int IntroIndex, const EndpointPair &ep, Device &dev, Data &response)
  70         {
  71                 dev.BulkWrite(ep.write, Intro_Sends[IntroIndex],
  72                         GetSize(Intro_Sends[IntroIndex]));
  73                 try {
  74                         dev.BulkRead(ep.read, response, 500);
  75                 }
  76                 catch( Usb::Timeout &to ) {
  77                         ddout("BulkRead: " << to.what());
  78                         return false;
  79                 }
  80                 ddout("BulkRead (" << (unsigned int)ep.read << "):\n" << response);
  81                 return true;
  82         }
  83
  84 } // anonymous namespace
  85
  86
  87 bool Probe::CheckSize(const Data &data, unsigned int required)
  88 {
  89         const unsigned char *pd = data.GetData();
  90
  91         if( GetSize(pd) != (unsigned int) data.GetSize() ||
  92             data.GetSize() < required ||
  93             pd[4] != SB_COMMAND_FETCHED_ATTRIBUTE )
  94         {
  95                 dout(_("Probe: Parse data failure: ")
  96                         << "GetSize(pd): " << GetSize(pd)
  97                         << ", data.GetSize(): " << data.GetSize()
  98                         << ", pd[4]: " << (unsigned int) pd[4]);
  99                 return false;
 100         }
 101
 102         return true;
 103 }
 104
 105 bool Probe::ParsePIN(const Data &data, uint32_t &pin)
 106 {
 107         // validate response data
 108         const unsigned char *pd = data.GetData();
 109
 110         if( !CheckSize(data, 0x14) )
 111                 return false;
 112
 113         // capture the PIN
 114         memcpy(&pin, &pd[16], sizeof(pin));
 115         pin = btohl(pin);
 116
 117         return true;
 118 }
 119
 120 bool Probe::ParseDesc(const Data &data, std::string &desc)
 121 {
 122         if( !CheckSize(data, 29) )
 123                 return false;
 124
 125         // capture the description
 126         const char *d = (const char*) &data.GetData()[28];
 127         int maxlen = data.GetSize() - 28;
 128         desc.assign(d, strnlen(d, maxlen));
 129
 130         return true;
 131 }
 132
 133 Probe::Probe(const char *busname, const char *devname,
 134                 const Usb::EndpointPair *epp,
 135                 unsigned int log_exceptions,
 136                 bool auto_dump_log)
 137         : m_log_exceptions(log_exceptions)
 138         , m_fail_count(0)
 139         , m_epp_override(epp != NULL)
 140 {
 141         if( m_epp_override ) {
 142                 m_epp = *epp;
 143         }
 144
 145         // let the programmer pass in "" as well as 0
 146         if( busname && !strlen(busname) )
 147                 busname = 0;
 148         if( devname && !strlen(devname) )
 149                 devname = 0;
 150
 151         // Search for standard product ID first
 152         ProbeMatching(VENDOR_RIM, PRODUCT_RIM_BLACKBERRY, busname, devname);
 153
 154         // Search for Pearl devices second
 155         //
 156         // productID 6 devices (PRODUCT_RIM_PEARL) do not expose
 157         // the USB class 255 interface we need, but only the
 158         // Mass Storage one.  Here we search for PRODUCT_RIM_PEARL_DUAL,
 159         // (ID 4) which has both enabled.
 160         ProbeMatching(VENDOR_RIM, PRODUCT_RIM_PEARL_DUAL, busname, devname);
 161         // And a special case, which behaves similar to the PEARL_DUAL,
 162         // but with a unique Product ID.
 163         ProbeMatching(VENDOR_RIM, PRODUCT_RIM_PEARL_8120, busname, devname);
 164         // And one more!  The Pearl Flip
 165         ProbeMatching(VENDOR_RIM, PRODUCT_RIM_PEARL_FLIP, busname, devname);
 166
 167         // And one more time, for the Blackberry Storm
 168         ProbeMatching(VENDOR_RIM, PRODUCT_RIM_STORM, busname, devname);
 169
 170         // now dump all logged error messages
 171         if( auto_dump_log && m_fail_msgs.size() ) {
 172                 eout(string_vprintf(_("Probe logged %u exception messages:"),
 173                         m_fail_msgs.size()));
 174                 for( std::vector<std::string>::const_iterator b = m_fail_msgs.begin();
 175                         b != m_fail_msgs.end();
 176                         ++b )
 177                 {
 178                         eout(*b);
 179                 }
 180         }
 181 }
 182
 183 void Probe::ProbeMatching(int vendor, int product,
 184                         const char *busname, const char *devname)
 185 {
 186         Usb::DeviceID devid;
 187
 188         Match match(m_devices, vendor, product, busname, devname);
 189         while( match.next_device(devid) ) try {
 190                 ProbeDevice(devid);
 191         }
 192         catch( Usb::Error &e ) {
 193                 using namespace std;
 194
 195                 dout(_("Usb::Error exception caught: ") << e.what());
 196                 if( ((m_log_exceptions & LOG_BUSY) && e.system_errcode() == -EBUSY) ||
 197                     ((m_log_exceptions & LOG_ACCESS) && e.system_errcode() == -EACCES) ||
 198                     ((m_log_exceptions & LOG_PERM) && e.system_errcode() == -EPERM) )
 199                 {
 200                         m_fail_count++;
 201                         string msg = "Device " + devid.GetUsbName() + ": ";
 202                         if( e.system_errcode() == -EBUSY )
 203                                 msg += "(EBUSY) ";
 204                         else if( e.system_errcode() == -EACCES )
 205                                 msg += "(EACCES) ";
 206                         else if( e.system_errcode() == -EPERM )
 207                                 msg += "(EPERM) ";
 208                         msg += e.what();
 209
 210                         m_fail_msgs.push_back(msg);
 211                 }
 212                 else {
 213                         throw;
 214                 }
 215         }
 216 }
 217
 218 void Probe::ProbeDevice(Usb::DeviceID& devid)
 219 {
 220         // skip if we can't properly discover device config
 221         DeviceDescriptor desc(devid);
 222         ConfigDescriptor* config = desc[BLACKBERRY_CONFIGURATION];
 223         if( !config ) {
 224                 dout(_("Probe: No device descriptor for BlackBerry config (config id: ")
 225                         << BLACKBERRY_CONFIGURATION << ")");
 226                 return; // not found
 227         }
 228
 229         // search for interface class
 230         ConfigDescriptor::base_type::iterator idi = config->begin();
 231         for( ; idi != config->end(); idi++ ) {
 232                 if( idi->second->GetClass() == BLACKBERRY_DB_CLASS )
 233                         break;
 234         }
 235         if( idi == config->end() ) {
 236                 dout(string_vprintf(_("Probe: Interface with BLACKBERRY_DB_CLASS (%u) not found."), BLACKBERRY_DB_CLASS));
 237                 return; // not found
 238         }
 239
 240         unsigned char InterfaceNumber = idi->second->GetNumber();
 241         unsigned char InterfaceAltSetting = idi->second->GetAltSetting();
 242         dout("Probe: using InterfaceNumber: " << (unsigned int) InterfaceNumber <<
 243              " AltSetting: " << (unsigned int) InterfaceAltSetting);
 244
 245         // check endpoint validity
 246         EndpointPairings ep(*(*config)[InterfaceNumber]);
 247         if( !ep.IsValid() || ep.size() == 0 ) {
 248                 dout(_("Probe: endpoint invalid.")
 249                         << "     ep.IsValid() == "
 250                         << (ep.IsValid() ? _("true") : _("false"))
 251                         << ", ep.size() == "
 252                         << ep.size());
 253                 return;
 254         }
 255
 256         ProbeResult result;
 257         result.m_dev = devid;
 258         result.m_interface = InterfaceNumber;
 259         result.m_altsetting = InterfaceAltSetting;
 260         result.m_zeroSocketSequence = 0;
 261
 262         // open device
 263         Device dev(devid);
 264 //      dev.Reset();
 265 //      sleep(5);
 266
 267         //  make sure we're talking to the right config
 268         unsigned char cfg;
 269         if( !dev.GetConfiguration(cfg) )
 270                 throw Usb::Error(dev.GetLastError(),
 271                         _("Probe: GetConfiguration failed"));
 272         if( cfg != BLACKBERRY_CONFIGURATION || MUST_SET_CONFIGURATION ) {
 273                 if( !dev.SetConfiguration(BLACKBERRY_CONFIGURATION) )
 274                         throw Usb::Error(dev.GetLastError(),
 275                                 _("Probe: SetConfiguration failed"));
 276         }
 277
 278         // open interface
 279         Interface iface(dev, InterfaceNumber);
 280
 281         // Try the initial probing of endpoints
 282         ProbeDeviceEndpoints(dev, ep, result);
 283
 284         if( !result.m_ep.IsComplete() ) {
 285                 // Probing of end-points failed, so try reprobing
 286                 // after calling usb_set_altinterface().
 287                 //
 288                 // Calling usb_set_altinterface() should be harmless
 289                 // and can help the host and device to synchronize the
 290                 // USB state, especially on FreeBSD and Mac OS X.
 291                 // However it can cause usb-storage URBs to be lost
 292                 // on some devices, so is only used if necessary.
 293                 dout(_("Probe: probing endpoints failed, retrying after setting alternate interface"));
 294
 295                 iface.SetAltInterface(InterfaceAltSetting);
 296                 result.m_needSetAltInterface = true;
 297                 ProbeDeviceEndpoints(dev, ep, result);
 298         }
 299
 300         // add to list
 301         if( result.m_ep.IsComplete() ) {
 302                 // before adding to list, try to load the device's
 303                 // friendly name from the configfile... but don't
 304                 // fail if we can't do it
 305                 try {
 306                         ConfigFile cfg(result.m_pin);
 307                         result.m_cfgDeviceName = cfg.GetDeviceName();
 308                 }
 309                 catch( Barry::ConfigFileError & ) {
 310                         // ignore...
 311                 }
 312
 313                 m_results.push_back(result);
 314                 ddout("Using ReadEndpoint: " << (unsigned int)result.m_ep.read);
 315                 ddout("      WriteEndpoint: " << (unsigned int)result.m_ep.write);
 316         }
 317         else {
 318                 ddout(_("Unable to discover endpoint pair for one device."));
 319         }
 320 }
 321
 322 void Probe::ProbeDeviceEndpoints(Device &dev, EndpointPairings &ed, ProbeResult &result)
 323 {
 324         if( m_epp_override ) {
 325                 // user has given us endpoints to try... so try them
 326                 uint32_t pin;
 327                 uint8_t zeroSocketSequence;
 328                 std::string desc;
 329                 bool needClearHalt;
 330                 if( ProbePair(dev, m_epp, pin, desc, zeroSocketSequence, needClearHalt) ) {
 331                         // looks good, finish filling out the result
 332                         result.m_ep = m_epp;
 333                         result.m_pin = pin;
 334                         result.m_description = desc;
 335                         result.m_zeroSocketSequence = zeroSocketSequence;
 336                         result.m_needClearHalt = needClearHalt;
 337                 }
 338         }
 339         else {
 340                 // find the first bulk read/write endpoint pair that answers
 341                 // to our probe commands
 342                 // Start with second pair, since evidence indicates the later pairs
 343                 // are the ones we need.
 344                 size_t i;
 345                 for(i = ed.size() > 1 ? 1 : 0;
 346                     i < ed.size();
 347                     i++ )
 348                 {
 349                         const EndpointPair &ep = ed[i];
 350                         if( ep.type == Usb::EndpointDescriptor::BulkType ) {
 351
 352                                 uint32_t pin;
 353                                 uint8_t zeroSocketSequence;
 354                                 std::string desc;
 355                                 bool needClearHalt;
 356                                 if( ProbePair(dev, ep, pin, desc, zeroSocketSequence, needClearHalt) ) {
 357                                         result.m_ep = ep;
 358                                         result.m_pin = pin;
 359                                         result.m_description = desc;
 360                                         result.m_zeroSocketSequence = zeroSocketSequence;
 361                                         result.m_needClearHalt = needClearHalt;
 362                                         break;
 363                                 }
 364                         }
 365                         else {
 366                                 dout(_("Probe: Skipping non-bulk endpoint pair (offset: ")
 367                                      << i-1 << ") ");
 368                         }
 369                 }
 370
 371                 // check for ip modem endpoints
 372                 i++;
 373                 if( i < ed.size() ) {
 374                         const EndpointPair &ep = ed[i];
 375                         if( ProbeModem(dev, ep) ) {
 376                                 result.m_epModem = ep;
 377                         }
 378                 }
 379         }
 380 }
 381
 382 bool Probe::ProbePair(Usb::Device &dev,
 383                         const Usb::EndpointPair &ep,
 384                         uint32_t &pin,
 385                         std::string &desc,
 386                         uint8_t &zeroSocketSequence,
 387                         bool &needClearHalt)
 388 {
 389         // Initially assume that clear halt isn't needed as it causes some
 390         // devices to drop packets. The suspicion is that the toggle bits
 391         // get out of sync, but this hasn't been confirmed with hardware
 392         // tracing.
 393         //
 394         // It is possible to always use clear halt, as long as SET
 395         // INTERFACE has been sent before, via usb_set_altinterface().
 396         // However this has the side affect that any outstanding URBs
 397         // on other interfaces (i.e. usb-storage) timeout and lose
 398         // their data. This is not a good thing as it can corrupt the
 399         // file system exposed over usb-storage. This also has the
 400         // side-affect that usb-storage issues a port reset after the
 401         // 30 second timeout, which kills any current Barry
 402         // connection.
 403         //
 404         // To further complicate matters some devices, such as the
 405         // 8830, always need clear halt before they will respond to
 406         // probes.
 407         //
 408         // So to work with all these device quirks the probe is first
 409         // attempted without calling clear halt. If that probe fails
 410         // then a clear halt is issued followed by a retry on the
 411         // probing.
 412         needClearHalt = false;
 413
 414         Data data;
 415         dev.BulkDrain(ep.read);
 416         if( !Intro(0, ep, dev, data) ) {
 417                 // Try clearing halt and then reprobing
 418                 dout(_("Probe: Intro(0) failed, retrying after clearing halt"));
 419                 dev.ClearHalt(ep.read);
 420                 dev.ClearHalt(ep.write);
 421                 needClearHalt = true;
 422                 // Retry
 423                 dev.BulkDrain(ep.read);
 424                 if( !Intro(0, ep, dev, data) ) {
 425                         // Still no response so fail the probe
 426                         dout(_("Probe: Intro(0) still failed after clearing halt"));
 427                         return false;
 428                 }
 429         }
 430
 431         SocketZero socket(dev, ep.write, ep.read);
 432
 433         Data send, receive;
 434         ZeroPacket packet(send, receive);
 435
 436         // unknown attribute: 0x14 / 0x01
 437         packet.GetAttribute(SB_OBJECT_INITIAL_UNKNOWN,
 438                 SB_ATTR_INITIAL_UNKNOWN);
 439         socket.Send(packet);
 440
 441         // fetch PIN
 442         packet.GetAttribute(SB_OBJECT_PROFILE, SB_ATTR_PROFILE_PIN);
 443         socket.Send(packet);
 444         if( packet.ObjectID() != SB_OBJECT_PROFILE ||
 445             packet.AttributeID() != SB_ATTR_PROFILE_PIN ||
 446             !ParsePIN(receive, pin) )
 447         {
 448                 dout(_("Probe: unable to fetch PIN"));
 449                 return false;
 450         }
 451
 452         // fetch Description
 453         packet.GetAttribute(SB_OBJECT_PROFILE, SB_ATTR_PROFILE_DESC);
 454         socket.Send(packet);
 455         // response ObjectID does not match request... :-/
 456         if( // packet.ObjectID() != SB_OBJECT_PROFILE ||
 457             packet.AttributeID() != SB_ATTR_PROFILE_DESC ||
 458             !ParseDesc(receive, desc) )
 459         {
 460                 dout(_("Probe: unable to fetch description"));
 461         }
 462
 463         // more unknowns:
 464         for( uint16_t attr = 5; attr < 9; attr++ ) {
 465                 packet.GetAttribute(SB_OBJECT_SOCKET_UNKNOWN, attr);
 466                 socket.Send(packet);
 467                 // FIXME parse these responses, if they turn
 468                 // out to be important
 469         }
 470
 471         // all info obtained!
 472         zeroSocketSequence = socket.GetZeroSocketSequence();
 473         return true;
 474 }
 475
 476 bool Probe::ProbeModem(Usb::Device &dev, const Usb::EndpointPair &ep)
 477 {
 478         //
 479         // This check is not needed for all devices.  Some devices,
 480         // like the 8700 have both the RIM_UsbSerData mode and IpModem mode.
 481         //
 482         // If this function is called, then we have extra endpoints,
 483         // so might as well try them.
 484         //
 485         // FIXME - someday, we might wish to confirm that the endpoints
 486         // work as a modem, and return true/false based on that test.
 487         //
 488         return true;
 489
 490
 491 // Thanks to Rick Scott (XmBlackBerry:bb_usb.c) for reverse engineering this
 492 //      int num_read;
 493 //      char data[255];
 494 //      int local_errno;
 495 //
 496 //      num_read = usb_control_msg(dev.GetHandle(),
 497 //              /* bmRequestType */ USB_ENDPOINT_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
 498 //              /* bRequest */ 0xa5,
 499 //              /* wValue */ 0,
 500 //              /* wIndex */ 1,
 501 //              /* data */ data,
 502 //              /* wLength */ sizeof(data),
 503 //              /* timeout */ 2000);
 504 //      local_errno = errno;
 505 //      if( num_read > 1 ) {
 506 //              if( data[0] == 0x02 ) {
 507 //                      return true;
 508 //              }
 509 //      }
 510 //      return false;
 511 }
 512
 513 int Probe::FindActive(Barry::Pin pin) const
 514 {
 515         return FindActive(m_results, pin);
 516 }
 517
 518 int Probe::FindActive(const Barry::Probe::Results &results, Barry::Pin pin)
 519 {
 520         int i = Find(results, pin);
 521
 522         if( i == -1 && pin == 0 ) {
 523                 // can we default to a single device?
 524                 if( results.size() == 1 )
 525                         return 0;       // yes!
 526         }
 527
 528         return i;
 529 }
 530
 531 int Probe::Find(const Results &results, Barry::Pin pin)
 532 {
 533         Barry::Probe::Results::const_iterator ci = results.begin();
 534         for( int i = 0; ci != results.end(); i++, ++ci ) {
 535                 if( ci->m_pin == pin )
 536                         return i;
 537         }
 538         // PIN not found
 539         return -1;
 540 }
 541
 542 void ProbeResult::DumpAll(std::ostream &os) const
 543 {
 544         ios_format_state state(os);
 545
 546         os << *this
 547            << ", Interface: 0x" << std::hex << (unsigned int) m_interface
 548            << ", Endpoints: (read: 0x" << std::hex << (unsigned int) m_ep.read
 549                 << ", write: 0x" << std::hex << (unsigned int) m_ep.write
 550                 << ", type: 0x" << std::hex << (unsigned int) m_ep.type
 551            << ", ZeroSocketSequence: 0x" << std::hex << (unsigned int) m_zeroSocketSequence;
 552 }
 553
 554 std::string ProbeResult::GetDisplayName() const
 555 {
 556         std::ostringstream oss;
 557         oss << m_pin.Str();
 558         if( m_cfgDeviceName.size() )
 559                 oss << " (" << m_cfgDeviceName << ")";
 560         return oss.str();
 561 }
 562
 563 std::ostream& operator<< (std::ostream &os, const ProbeResult &pr)
 564 {
 565         ios_format_state state(os);
 566
 567         os << _("Device ID: ") << pr.m_dev.m_impl.get()
 568            << ". " << _("PIN: ") << pr.m_pin.Str()
 569            << ", " << _("Description: ") << pr.m_description;
 570         if( pr.m_cfgDeviceName.size() )
 571                 os << ", " << _("Name: ") << pr.m_cfgDeviceName;
 572         return os;
 573 }
 574
 575 } // namespace Barry
 576