probe.cc

Go to the documentation of this file.
00001 ///
00002 /// \file       probe.cc
00003 ///             USB Blackberry detection routines
00004 ///
00005 
00006 /*
00007     Copyright (C) 2005-2008, Net Direct Inc. (http://www.netdirect.ca/)
00008 
00009     This program is free software; you can redistribute it and/or modify
00010     it under the terms of the GNU General Public License as published by
00011     the Free Software Foundation; either version 2 of the License, or
00012     (at your option) any later version.
00013 
00014     This program is distributed in the hope that it will be useful,
00015     but WITHOUT ANY WARRANTY; without even the implied warranty of
00016     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
00017 
00018     See the GNU General Public License in the COPYING file at the
00019     root directory of this project for more details.
00020 */
00021 
00022 #include "common.h"
00023 #include "probe.h"
00024 #include "usbwrap.h"
00025 #include "data.h"
00026 #include "endian.h"
00027 #include "error.h"
00028 #include "debug.h"
00029 #include "packet.h"
00030 #include "socket.h"
00031 #include "protocol.h"
00032 #include "record-internal.h"
00033 #include "strnlen.h"
00034 #include <iomanip>
00035 #include <errno.h>
00036 #include <string.h>
00037 
00038 using namespace Usb;
00039 
00040 namespace Barry {
00041 
00042 unsigned char Intro_Sends[][32] = {
00043         // packet #1
00044         { 0x00, 0x00, 0x10, 0x00, 0x01, 0xff, 0x00, 0x00,
00045           0xa8, 0x18, 0xda, 0x8d, 0x6c, 0x02, 0x00, 0x00 }
00046 };
00047 
00048 
00049 unsigned char Intro_Receives[][32] = {
00050         // response to packet #1
00051         { 0x00, 0x00, 0x10, 0x00, 0x02, 0xff, 0x00, 0x00,
00052           0xa8, 0x18, 0xda, 0x8d, 0x6c, 0x02, 0x00, 0x00 }
00053 };
00054 
00055 namespace {
00056 
00057         unsigned int GetSize(const unsigned char *packet)
00058         {
00059                 uint16_t size = *((uint16_t *)&packet[2]);
00060                 return btohs(size);
00061         }
00062 
00063         bool Intro(int IntroIndex, const EndpointPair &ep, Device &dev, Data &response)
00064         {
00065                 dev.BulkWrite(ep.write, Intro_Sends[IntroIndex],
00066                         GetSize(Intro_Sends[IntroIndex]));
00067                 try {
00068                         dev.BulkRead(ep.read, response, 500);
00069                 }
00070                 catch( Usb::Timeout &to ) {
00071                         ddout("BulkRead: " << to.what());
00072                         return false;
00073                 }
00074                 ddout("BulkRead (" << (unsigned int)ep.read << "):\n" << response);
00075                 return true;
00076         }
00077 
00078 } // anonymous namespace
00079 
00080 
00081 bool Probe::CheckSize(const Data &data, unsigned int required)
00082 {
00083         const unsigned char *pd = data.GetData();
00084 
00085         if( GetSize(pd) != (unsigned int) data.GetSize() ||
00086             data.GetSize() < required ||
00087             pd[4] != SB_COMMAND_FETCHED_ATTRIBUTE )
00088         {
00089                 dout("Probe: Parse data failure: GetSize(pd): " << GetSize(pd)
00090                         << ", data.GetSize(): " << data.GetSize()
00091                         << ", pd[4]: " << (unsigned int) pd[4]);
00092                 return false;
00093         }
00094 
00095         return true;
00096 }
00097 
00098 bool Probe::ParsePIN(const Data &data, uint32_t &pin)
00099 {
00100         // validate response data
00101         const unsigned char *pd = data.GetData();
00102 
00103         if( !CheckSize(data, 0x14) )
00104                 return false;
00105 
00106         // capture the PIN
00107         pin = btohl(*((uint32_t *) &pd[16]));
00108 
00109         return true;
00110 }
00111 
00112 bool Probe::ParseDesc(const Data &data, std::string &desc)
00113 {
00114         if( !CheckSize(data, 29) )
00115                 return false;
00116 
00117         // capture the description
00118         const char *d = (const char*) &data.GetData()[28];
00119         int maxlen = data.GetSize() - 28;
00120         desc.assign(d, strnlen(d, maxlen));
00121 
00122         return true;
00123 }
00124 
00125 Probe::Probe(const char *busname, const char *devname)
00126         : m_fail_count(0)
00127 {
00128         // let the programmer pass in "" as well as 0
00129         if( busname && !strlen(busname) )
00130                 busname = 0;
00131         if( devname && !strlen(devname) )
00132                 devname = 0;
00133 
00134         // Search for standard product ID first
00135         ProbeMatching(VENDOR_RIM, PRODUCT_RIM_BLACKBERRY, busname, devname);
00136 
00137         // Search for Pearl devices second
00138         //
00139         // productID 6 devices (PRODUCT_RIM_PEARL) do not expose
00140         // the USB class 255 interface we need, but only the
00141         // Mass Storage one.  Here we search for PRODUCT_RIM_PEARL_DUAL,
00142         // (ID 4) which has both enabled.
00143         ProbeMatching(VENDOR_RIM, PRODUCT_RIM_PEARL_DUAL, busname, devname);
00144         // And a special case, which behaves similar to the PEARL_DUAL,
00145         // but with a unique Product ID.
00146         ProbeMatching(VENDOR_RIM, PRODUCT_RIM_PEARL_8120, busname, devname);
00147 }
00148 
00149 void Probe::ProbeMatching(int vendor, int product,
00150                         const char *busname, const char *devname)
00151 {
00152         Usb::DeviceIDType devid;
00153 
00154         Match match(vendor, product, busname, devname);
00155         while( match.next_device(&devid) ) try {
00156                 ProbeDevice(devid);
00157         }
00158         catch( Usb::Error &e ) {
00159                 dout("Usb::Error exception caught: " << e.what());
00160                 if( e.libusb_errcode() == -EBUSY ) {
00161                         m_fail_count++;
00162                         m_fail_msgs.push_back(e.what());
00163                 }
00164                 else {
00165                         throw;
00166                 }
00167         }
00168 }
00169 
00170 void Probe::ProbeDevice(Usb::DeviceIDType devid)
00171 {
00172         // skip if we can't properly discover device config
00173         DeviceDiscovery discover(devid);
00174         ConfigDesc &config = discover.configs[BLACKBERRY_CONFIGURATION];
00175 
00176         // search for interface class
00177         InterfaceDiscovery::base_type::iterator idi = config.interfaces.begin();
00178         for( ; idi != config.interfaces.end(); idi++ ) {
00179                 if( idi->second.desc.bInterfaceClass == BLACKBERRY_DB_CLASS )
00180                         break;
00181         }
00182         if( idi == config.interfaces.end() ) {
00183                 dout("Probe: Interface with BLACKBERRY_DB_CLASS ("
00184                         << BLACKBERRY_DB_CLASS << ") not found.");
00185                 return; // not found
00186         }
00187 
00188         unsigned char InterfaceNumber = idi->second.desc.bInterfaceNumber;
00189         dout("Probe: using InterfaceNumber: " << (unsigned int) InterfaceNumber);
00190 
00191         // check endpoint validity
00192         EndpointDiscovery &ed = config.interfaces[InterfaceNumber].endpoints;
00193         if( !ed.IsValid() || ed.GetEndpointPairs().size() == 0 ) {
00194                 dout("Probe: endpoint invalid.   ed.IsValud() == "
00195                         << (ed.IsValid() ? "true" : "false")
00196                         << ", ed.GetEndpointPairs().size() == "
00197                         << ed.GetEndpointPairs().size());
00198                 return;
00199         }
00200 
00201         ProbeResult result;
00202         result.m_dev = devid;
00203         result.m_interface = InterfaceNumber;
00204         result.m_zeroSocketSequence = 0;
00205 
00206         // open device
00207         Device dev(devid);
00208 //      dev.Reset();
00209 //      sleep(5);
00210 
00211         //  make sure we're talking to the right config
00212         unsigned char cfg;
00213         if( !dev.GetConfiguration(cfg) )
00214                 throw Usb::Error(dev.GetLastError(),
00215                         "Probe: GetConfiguration failed");
00216         if( cfg != BLACKBERRY_CONFIGURATION ) {
00217                 if( !dev.SetConfiguration(BLACKBERRY_CONFIGURATION) )
00218                         throw Usb::Error(dev.GetLastError(),
00219                                 "Probe: SetConfiguration failed");
00220         }
00221 
00222         // open interface
00223         Interface iface(dev, InterfaceNumber);
00224 
00225         // find the first bulk read/write endpoint pair that answers
00226         // to our probe commands
00227         // Start with second pair, since evidence indicates the later pairs
00228         // are the ones we need.
00229         size_t i;
00230         for(i = ed.GetEndpointPairs().size() > 1 ? 1 : 0;
00231             i < ed.GetEndpointPairs().size();
00232             i++ )
00233         {
00234                 const EndpointPair &ep = ed.GetEndpointPairs()[i];
00235                 if( ep.type == USB_ENDPOINT_TYPE_BULK ) {
00236 
00237                         uint32_t pin;
00238                         uint8_t zeroSocketSequence;
00239                         std::string desc;
00240                         if( ProbePair(dev, ep, pin, desc, zeroSocketSequence) ) {
00241                                 result.m_ep = ep;
00242                                 result.m_pin = pin;
00243                                 result.m_description = desc;
00244                                 result.m_zeroSocketSequence = zeroSocketSequence;
00245                                 break;
00246                         }
00247                 }
00248                 else {
00249                         dout("Probe: Skipping non-bulk endpoint pair (offset: "
00250                                 << i-1 << ") ");
00251                 }
00252         }
00253 
00254         // check for ip modem endpoints
00255         i++;
00256         if( i < ed.GetEndpointPairs().size() ) {
00257                 const EndpointPair &ep = ed.GetEndpointPairs()[i];
00258                 if( ProbeModem(dev, ep) ) {
00259                         result.m_epModem = ep;
00260                 }
00261         }
00262 
00263         // add to list
00264         if( result.m_ep.IsComplete() ) {
00265                 m_results.push_back(result);
00266                 ddout("Using ReadEndpoint: " << (unsigned int)result.m_ep.read);
00267                 ddout("      WriteEndpoint: " << (unsigned int)result.m_ep.write);
00268         }
00269         else {
00270                 ddout("Unable to discover endpoint pair for one device.");
00271         }
00272 }
00273 
00274 bool Probe::ProbePair(Usb::Device &dev,
00275                         const Usb::EndpointPair &ep,
00276                         uint32_t &pin,
00277                         std::string &desc,
00278                         uint8_t &zeroSocketSequence)
00279 {
00280         dev.ClearHalt(ep.read);
00281         dev.ClearHalt(ep.write);
00282 
00283         Data data;
00284         dev.BulkDrain(ep.read);
00285         if( !Intro(0, ep, dev, data) ) {
00286                 dout("Probe: Intro(0) failed");
00287                 return false;
00288         }
00289 
00290         SocketZero socket(dev, ep.write, ep.read);
00291 
00292         Data send, receive;
00293         ZeroPacket packet(send, receive);
00294 
00295         // unknown attribute: 0x14 / 0x01
00296         packet.GetAttribute(SB_OBJECT_INITIAL_UNKNOWN,
00297                 SB_ATTR_INITIAL_UNKNOWN);
00298         socket.Send(packet);
00299 
00300         // fetch PIN
00301         packet.GetAttribute(SB_OBJECT_PROFILE, SB_ATTR_PROFILE_PIN);
00302         socket.Send(packet);
00303         if( packet.ObjectID() != SB_OBJECT_PROFILE ||
00304             packet.AttributeID() != SB_ATTR_PROFILE_PIN ||
00305             !ParsePIN(receive, pin) )
00306         {
00307                 dout("Probe: unable to fetch PIN");
00308                 return false;
00309         }
00310 
00311         // fetch Description
00312         packet.GetAttribute(SB_OBJECT_PROFILE, SB_ATTR_PROFILE_DESC);
00313         socket.Send(packet);
00314         // response ObjectID does not match request... :-/
00315         if( // packet.ObjectID() != SB_OBJECT_PROFILE ||
00316             packet.AttributeID() != SB_ATTR_PROFILE_DESC ||
00317             !ParseDesc(receive, desc) )
00318         {
00319                 dout("Probe: unable to fetch description");
00320         }
00321 
00322         // more unknowns:
00323         for( uint16_t attr = 5; attr < 9; attr++ ) {
00324                 packet.GetAttribute(SB_OBJECT_SOCKET_UNKNOWN, attr);
00325                 socket.Send(packet);
00326                 // FIXME parse these responses, if they turn
00327                 // out to be important
00328         }
00329 
00330         // all info obtained!
00331         zeroSocketSequence = socket.GetZeroSocketSequence();
00332         return true;
00333 }
00334 
00335 bool Probe::ProbeModem(Usb::Device &dev, const Usb::EndpointPair &ep)
00336 {
00337         //
00338         // This check is not needed for all devices.  Some devices,
00339         // like the 8700 have both the RIM_UsbSerData mode and IpModem mode.
00340         //
00341         // If this function is called, then we have extra endpoints,
00342         // so might as well try them.
00343         //
00344         // FIXME - someday, we might wish to confirm that the endpoints
00345         // work as a modem, and return true/false based on that test.
00346         //
00347         return true;
00348 
00349 
00350 // Thanks to Rick Scott (XmBlackBerry:bb_usb.c) for reverse engineering this
00351 //      int num_read;
00352 //      char data[255];
00353 //      int local_errno;
00354 //
00355 //      num_read = usb_control_msg(dev.GetHandle(),
00356 //              /* bmRequestType */ USB_ENDPOINT_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
00357 //              /* bRequest */ 0xa5,
00358 //              /* wValue */ 0,
00359 //              /* wIndex */ 1,
00360 //              /* data */ data,
00361 //              /* wLength */ sizeof(data),
00362 //              /* timeout */ 2000);
00363 //      local_errno = errno;
00364 //      if( num_read > 1 ) {
00365 //              if( data[0] == 0x02 ) {
00366 //                      return true;
00367 //              }
00368 //      }
00369 //      return false;
00370 }
00371 
00372 int Probe::FindActive(uint32_t pin) const
00373 {
00374         for( int i = 0; i < GetCount(); i++ ) {
00375                 if( Get(i).m_pin == pin )
00376                         return i;
00377         }
00378         if( pin == 0 ) {
00379                 // can we default to a single device?
00380                 if( GetCount() == 1 )
00381                         return 0;       // yes!
00382         }
00383 
00384         // PIN not found
00385         return -1;
00386 }
00387 
00388 void ProbeResult::DumpAll(std::ostream &os) const
00389 {
00390         os << *this
00391            << ", Interface: 0x" << std::hex << (unsigned int) m_interface
00392            << ", Endpoints: (read: 0x" << std::hex << (unsigned int) m_ep.read
00393                 << ", write: 0x" << std::hex << (unsigned int) m_ep.write
00394                 << ", type: 0x" << std::hex << (unsigned int) m_ep.type
00395            << ", ZeroSocketSequence: 0x" << std::hex << (unsigned int) m_zeroSocketSequence;
00396 }
00397 
00398 std::ostream& operator<< (std::ostream &os, const ProbeResult &pr)
00399 {
00400         os << "Device ID: " << pr.m_dev
00401            << std::hex << ". PIN: " << pr.m_pin
00402            << ", Description: " << pr.m_description;
00403         return os;
00404 }
00405 
00406 } // namespace Barry
00407 

Generated on Wed Sep 24 21:27:32 2008 for Barry by  doxygen 1.5.1