src/probe.cc

   1 ///
   2 /// \file       probe.cc
   3 ///             USB Blackberry detection routines
   4 ///
   5
   6 /*
   7     Copyright (C) 2005-2007, 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 "common.h"
  23 #include "probe.h"
  24 #include "usbwrap.h"
  25 #include "data.h"
  26 #include "endian.h"
  27 #include "error.h"
  28 #include "debug.h"
  29 #include "packet.h"
  30 #include "socket.h"
  31 #include "protocol.h"
  32 #include "record-internal.h"
  33 #include "strnlen.h"
  34 #include <iomanip>
  35
  36 using namespace Usb;
  37
  38 namespace Barry {
  39
  40 unsigned char Intro_Sends[][32] = {
  41         // packet #1
  42         { 0x00, 0x00, 0x10, 0x00, 0x01, 0xff, 0x00, 0x00,
  43           0xa8, 0x18, 0xda, 0x8d, 0x6c, 0x02, 0x00, 0x00 }
  44 };
  45
  46
  47 unsigned char Intro_Receives[][32] = {
  48         // response to packet #1
  49         { 0x00, 0x00, 0x10, 0x00, 0x02, 0xff, 0x00, 0x00,
  50           0xa8, 0x18, 0xda, 0x8d, 0x6c, 0x02, 0x00, 0x00 }
  51 };
  52
  53 namespace {
  54
  55         unsigned int GetSize(const unsigned char *packet)
  56         {
  57                 uint16_t size = *((uint16_t *)&packet[2]);
  58                 return btohs(size);
  59         }
  60
  61         bool Intro(int IntroIndex, const EndpointPair &ep, Device &dev, Data &response)
  62         {
  63                 dev.BulkWrite(ep.write, Intro_Sends[IntroIndex],
  64                         GetSize(Intro_Sends[IntroIndex]));
  65                 dev.BulkRead(ep.read, response);
  66                 ddout("BulkRead (" << (unsigned int)ep.read << "):\n" << response);
  67                 return true;
  68         }
  69
  70 } // anonymous namespace
  71
  72
  73 bool Probe::CheckSize(const Data &data, unsigned int required)
  74 {
  75         const unsigned char *pd = data.GetData();
  76
  77         if( GetSize(pd) != (unsigned int) data.GetSize() ||
  78             data.GetSize() < required ||
  79             pd[4] != SB_COMMAND_FETCHED_ATTRIBUTE )
  80         {
  81                 dout("Probe: Parse data failure: GetSize(pd): " << GetSize(pd)
  82                         << ", data.GetSize(): " << data.GetSize()
  83                         << ", pd[4]: " << (unsigned int) pd[4]);
  84                 return false;
  85         }
  86
  87         return true;
  88 }
  89
  90 bool Probe::ParsePIN(const Data &data, ProbeResult &result)
  91 {
  92         // validate response data
  93         const unsigned char *pd = data.GetData();
  94
  95         if( !CheckSize(data, 0x14) )
  96                 return false;
  97
  98         // capture the PIN
  99         result.m_pin = btohl(*((uint32_t *) &pd[16]));
 100
 101         return true;
 102 }
 103
 104 bool Probe::ParseDesc(const Data &data, ProbeResult &result)
 105 {
 106         if( !CheckSize(data, 29) )
 107                 return false;
 108
 109         // capture the description
 110         const char *desc = (const char*) &data.GetData()[28];
 111         int maxlen = data.GetSize() - 28;
 112         result.m_description.assign(desc, strnlen(desc, maxlen));
 113
 114         return true;
 115 }
 116
 117 Probe::Probe()
 118 {
 119         Usb::DeviceIDType devid;
 120
 121         // Search for standard product ID first
 122         {
 123                 Match match(VENDOR_RIM, PRODUCT_RIM_BLACKBERRY);
 124                 while( match.next_device(&devid) )
 125                         ProbeDevice(devid);
 126         }
 127
 128         // Search for Pearl devices second
 129         {
 130                 // productID 6 devices (PRODUCT_RIM_PEARL) do not expose
 131                 // the USB class 255 interface we need, but only the
 132                 // Mass Storage one.  Here we search for PRODUCT_RIM_PEARL_DUAL,
 133                 // (ID 4) which has both enabled.
 134                 Match match(VENDOR_RIM, PRODUCT_RIM_PEARL_DUAL);
 135                 while( match.next_device(&devid) )
 136                         ProbeDevice(devid);
 137         }
 138 }
 139
 140 void Probe::ProbeDevice(Usb::DeviceIDType devid)
 141 {
 142         // skip if we can't properly discover device config
 143         DeviceDiscovery discover(devid);
 144         ConfigDesc &config = discover.configs[BLACKBERRY_CONFIGURATION];
 145
 146         // search for interface class
 147         InterfaceDiscovery::base_type::iterator i = config.interfaces.begin();
 148         for( ; i != config.interfaces.end(); i++ ) {
 149                 if( i->second.desc.bInterfaceClass == BLACKBERRY_DB_CLASS )
 150                         break;
 151         }
 152         if( i == config.interfaces.end() ) {
 153                 dout("Probe: Interface with BLACKBERRY_DB_CLASS ("
 154                         << BLACKBERRY_DB_CLASS << ") not found.");
 155                 return; // not found
 156         }
 157
 158         unsigned char InterfaceNumber = i->second.desc.bInterfaceNumber;
 159         dout("Probe: using InterfaceNumber: " << (unsigned int) InterfaceNumber);
 160
 161         // check endpoint validity
 162         EndpointDiscovery &ed = config.interfaces[InterfaceNumber].endpoints;
 163         if( !ed.IsValid() || ed.GetEndpointPairs().size() == 0 ) {
 164                 dout("Probe: endpoint invalid.   ed.IsValud() == "
 165                         << (ed.IsValid() ? "true" : "false")
 166                         << ", ed.GetEndpointPairs().size() == "
 167                         << ed.GetEndpointPairs().size());
 168                 return;
 169         }
 170
 171         ProbeResult result;
 172         result.m_dev = devid;
 173         result.m_interface = InterfaceNumber;
 174         result.m_zeroSocketSequence = 0;
 175
 176         // find the first bulk read/write endpoint pair that answers
 177         // to our probe commands
 178         // Start with second pair, since evidence indicates the later pairs
 179         // are the ones we need.
 180         for(size_t i = ed.GetEndpointPairs().size() > 1 ? 1 : 0;
 181             i < ed.GetEndpointPairs().size();
 182             i++ )
 183         {
 184                 const EndpointPair &ep = ed.GetEndpointPairs()[i];
 185                 if( ep.type == USB_ENDPOINT_TYPE_BULK ) {
 186                         result.m_ep = ep;
 187
 188                         Device dev(devid);
 189 //                              dev.Reset();
 190 //                              sleep(5);
 191
 192                         if( !dev.SetConfiguration(BLACKBERRY_CONFIGURATION) )
 193                                 throw Usb::Error(dev.GetLastError(),
 194                                         "Probe: SetConfiguration failed");
 195
 196                         Interface iface(dev, InterfaceNumber);
 197
 198                         Data data;
 199                         dev.BulkDrain(ep.read);
 200                         if( !Intro(0, ep, dev, data) ) {
 201                                 dout("Probe: Intro(0) failed");
 202                                 continue;
 203                         }
 204
 205                         Socket socket(dev, ep.write, ep.read);
 206
 207                         Data send, receive;
 208                         ZeroPacket packet(send, receive);
 209
 210                         // unknown attribute: 0x14 / 0x01
 211                         packet.GetAttribute(SB_OBJECT_INITIAL_UNKNOWN,
 212                                 SB_ATTR_INITIAL_UNKNOWN);
 213                         socket.Send(packet);
 214
 215                         // fetch PIN
 216                         packet.GetAttribute(SB_OBJECT_PROFILE, SB_ATTR_PROFILE_PIN);
 217                         socket.Send(packet);
 218                         if( packet.ObjectID() != SB_OBJECT_PROFILE ||
 219                             packet.AttributeID() != SB_ATTR_PROFILE_PIN ||
 220                             !ParsePIN(receive, result) )
 221                         {
 222                                 dout("Probe: unable to fetch PIN");
 223                                 continue;
 224                         }
 225
 226                         // fetch Description
 227                         packet.GetAttribute(SB_OBJECT_PROFILE, SB_ATTR_PROFILE_DESC);
 228                         socket.Send(packet);
 229                         // response ObjectID does not match request... :-/
 230                         if( // packet.ObjectID() != SB_OBJECT_PROFILE ||
 231                             packet.AttributeID() != SB_ATTR_PROFILE_DESC ||
 232                             !ParseDesc(receive, result) )
 233                         {
 234                                 dout("Probe: unable to fetch description");
 235                                 // this is a relatively new feature, so don't
 236                                 // fail here... just blank the description
 237                                 result.m_description.clear();
 238                         }
 239
 240                         // more unknowns:
 241                         for( uint16_t attr = 5; attr < 9; attr++ ) {
 242                                 packet.GetAttribute(SB_OBJECT_SOCKET_UNKNOWN, attr);
 243                                 socket.Send(packet);
 244                                 // FIXME parse these responses, if they turn
 245                                 // out to be important
 246                         }
 247
 248
 249                         // all info obtained, add to list
 250                         result.m_zeroSocketSequence = socket.GetZeroSocketSequence();
 251                         m_results.push_back(result);
 252                         ddout("Using ReadEndpoint: " << (unsigned int)result.m_ep.read);
 253                         ddout("      WriteEndpoint: " << (unsigned int)result.m_ep.write);
 254                         break;
 255                 }
 256                 else {
 257                         dout("Probe: Skipping non-bulk endpoint pair (offset: "
 258                                 << i-1 << ") ");
 259                 }
 260         }
 261
 262         if( !result.m_ep.IsComplete() )
 263                 ddout("Unable to discover endpoint pair for one device.");
 264 }
 265
 266 int Probe::FindActive(uint32_t pin) const
 267 {
 268         for( int i = 0; i < GetCount(); i++ ) {
 269                 if( Get(i).m_pin == pin )
 270                         return i;
 271         }
 272         if( pin == 0 ) {
 273                 // can we default to a single device?
 274                 if( GetCount() == 1 )
 275                         return 0;       // yes!
 276         }
 277
 278         // PIN not found
 279         return -1;
 280 }
 281
 282 std::ostream& operator<< (std::ostream &os, const ProbeResult &pr)
 283 {
 284         os << "Device ID: " << pr.m_dev
 285            << std::hex << ". PIN: " << pr.m_pin
 286            << ", Description: " << pr.m_description;
 287         return os;
 288 }
 289
 290 } // namespace Barry
 291