tools/bcharge.cc

   1 ///
   2 /// \file       bcharge.cc
   3 ///             Talk to the Blackberry just enough to change the Max Power
   4 ///             to 500mA.  Cycles through all devices attached to USB,
   5 ///             attempting to set all matching Blackberry devices to charge.
   6 ///
   7 ///             This file is part of the Barry project:
   8 ///
   9 ///             http://www.netdirect.ca/software/packages/barry
  10 ///             http://sourceforge.net/projects/barry
  11 ///
  12 ///             Compile with the following command (needs libusb):
  13 ///
  14 ///             g++ -o bcharge bcharge.cc -lusb
  15 ///
  16
  17 /*
  18     Copyright (C) 2006-2010, Net Direct Inc. (http://www.netdirect.ca/)
  19
  20     This program is free software; you can redistribute it and/or modify
  21     it under the terms of the GNU General Public License as published by
  22     the Free Software Foundation; either version 2 of the License, or
  23     (at your option) any later version.
  24
  25     This program is distributed in the hope that it will be useful,
  26     but WITHOUT ANY WARRANTY; without even the implied warranty of
  27     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  28
  29     See the GNU General Public License in the COPYING file at the
  30     root directory of this project for more details.
  31 */
  32
  33 #include <usb.h>
  34 #include <stdio.h>
  35 #include <string.h>
  36 #include <unistd.h>
  37 #include <errno.h>
  38 #include <sys/types.h>
  39 #include <sys/stat.h>
  40 #include <fcntl.h>
  41 #include <string>
  42 #include <barry/common.h>
  43 #include "i18n.h"
  44
  45 bool old_style_pearl = false;
  46 bool force_dual = false;
  47 std::string udev_devpath;
  48 std::string sysfs_path = "/sys";
  49
  50 void Usage()
  51 {
  52         printf(
  53         "bcharge - Adjust Blackberry charging modes\n"
  54         "          Copyright 2006-2010, Net Direct Inc. (http://www.netdirect.ca/)\n"
  55         "\n"
  56         "   -d          Dual mode (mode 0004) (default)\n"
  57         "   -o          Set a Pearl to old Blackberry mode (0001)\n"
  58         "\n"
  59         "   -h          This help message\n"
  60         "   -p devpath  The devpath argument from udev.  If specified, will attempt\n"
  61         "               to adjust USB suspend settings to keep the device charging.\n"
  62         "   -s path     The path where sysfs is mounted.  Defaults to '/sys'\n"
  63         "\n"
  64         );
  65 }
  66
  67 void control(usb_dev_handle *dev, int requesttype, int request, int value,
  68         int index, char *bytes, int size, int timeout)
  69 {
  70         int result = usb_control_msg(dev, requesttype, request, value, index,
  71                 bytes, size, timeout);
  72         if( result < 0 ) {
  73                 printf("\nusb_control_msg failed: code: %d, %s\n", result,
  74                         usb_strerror());
  75         }
  76 }
  77
  78 void charge(struct usb_dev_handle *handle)
  79 {
  80         // the special sauce... these steps seem to do the trick
  81         // for the 7750 series... needs testing on others
  82         char buffer[2];
  83         control(handle, 0xc0, 0xa5, 0, 1, buffer, 2, 100);
  84         control(handle, 0x40, 0xa2, 0, 1, buffer, 0, 100);
  85 }
  86
  87 void pearl_mode(struct usb_dev_handle *handle)
  88 {
  89         char buffer[2];
  90         if( old_style_pearl ) {
  91                 // use this for "old style" interface: product ID 0001
  92                 control(handle, 0xc0, 0xa9, 0, 1, buffer, 2, 100);
  93         }
  94         else {
  95                 // Product ID 0004
  96                 control(handle, 0xc0, 0xa9, 1, 1, buffer, 2, 100);
  97         }
  98 }
  99
 100 int find_mass_storage_interface(struct usb_dev_handle *handle)
 101 {
 102         // search the configuration descriptor for a Mass Storage
 103         // interface (class 8)
 104         struct usb_device *dev = usb_device(handle);
 105         struct usb_config_descriptor *cfg = dev ? dev->config : 0;
 106
 107         if( cfg ) {
 108
 109                 for( unsigned i = 0; cfg->interface && i < cfg->bNumInterfaces; i++ ) {
 110                         struct usb_interface *iface = &cfg->interface[i];
 111                         for( int a = 0; iface->altsetting && a < iface->num_altsetting; a++ ) {
 112                                 struct usb_interface_descriptor *id = &iface->altsetting[a];
 113                                 if( id->bInterfaceClass == USB_CLASS_MASS_STORAGE )
 114                                         return id->bInterfaceNumber;
 115                         }
 116                 }
 117         }
 118
 119         // if we get here, then we didn't find the Mass Storage interface
 120         // ... this should never happen, but if it does, assume
 121         // the device is s showing product ID 0006, and the Mass Storage
 122         // interface is interface #0
 123         printf("Can't find Mass Storage interface, assuming 0.\n");
 124         return 0;
 125 }
 126
 127 void driver_conflict(struct usb_dev_handle *handle)
 128 {
 129         // this is called if the first usb_set_configuration()
 130         // failed... this most probably means that usb_storage
 131         // has already claimed the Mass Storage interface,
 132         // in which case we politely tell it to away.
 133
 134 #if LIBUSB_HAS_DETACH_KERNEL_DRIVER_NP
 135         printf("Detecting possible kernel driver conflict, trying to resolve...\n");
 136
 137         int iface = find_mass_storage_interface(handle);
 138         if( usb_detach_kernel_driver_np(handle, iface) < 0 )
 139                 printf("usb_detach_kernel_driver_np() failed: %s\n", usb_strerror());
 140
 141         if( usb_set_configuration(handle, BLACKBERRY_CONFIGURATION) < 0 )
 142                 printf("usb_set_configuration() failed: %s\n", usb_strerror());
 143 #endif
 144 }
 145
 146 // returns true if device mode was modified, false otherwise
 147 bool process(struct usb_device *dev, bool is_pearl)
 148 {
 149         bool apply = false;
 150         printf("Found device #%s...", dev->filename);
 151
 152         // open
 153         usb_dev_handle *handle = usb_open(dev);
 154         if( !handle ) {
 155                 printf("unable to open device\n");
 156                 return false;
 157         }
 158
 159         // adjust power
 160         if( dev->config &&
 161             dev->descriptor.bNumConfigurations >= 1 &&
 162             dev->config[0].MaxPower < 250 ) {
 163                 printf("adjusting charge setting");
 164                 charge(handle);
 165                 apply = true;
 166         }
 167         else {
 168                 printf("already at 500mA");
 169         }
 170
 171         // adjust Pearl mode
 172         if( is_pearl || force_dual ) {
 173                 int desired_mode = old_style_pearl
 174                         ? PRODUCT_RIM_BLACKBERRY : PRODUCT_RIM_PEARL_DUAL;
 175
 176                 if( desired_mode != dev->descriptor.idProduct ) {
 177                         printf("...adjusting Pearl mode to %s",
 178                                 old_style_pearl ? "single" : "dual");
 179                         pearl_mode(handle);
 180                         apply = true;
 181                 }
 182                 else {
 183                         printf("...already in desired Pearl mode");
 184                 }
 185         }
 186         else {
 187                 printf("...no Pearl adjustment");
 188         }
 189
 190         // apply changes
 191         if( apply ) {
 192                 if( usb_set_configuration(handle, BLACKBERRY_CONFIGURATION) < 0 )
 193                         driver_conflict(handle);
 194
 195                 // the Blackberry Pearl doesn't reset itself after the above,
 196                 // so do it ourselves
 197                 if( is_pearl || force_dual ) {
 198                         //
 199                         // It has been observed that the 8830 behaves both like
 200                         // a Pearl device (in that it has mass storage +
 201                         // database modes) as well as a Classic device in
 202                         // that it resets itself and doesn't need an explicit
 203                         // reset call.
 204                         //
 205                         // In order to deal with this, we insert a brief sleep.
 206                         // If it is an 8830, it will reset itself and the
 207                         // following reset call will fail.  If it is a Pearl,
 208                         // the reset will work as normal.
 209                         //
 210                         sleep(1);
 211                         if( usb_reset(handle) < 0 ) {
 212                                 printf("\nusb_reset failed: %s\n", usb_strerror());
 213                         }
 214                 }
 215
 216                 printf("...done\n");
 217         }
 218         else {
 219                 printf("...no change\n");
 220         }
 221
 222         // cleanup
 223         usb_close(handle);
 224         return apply;
 225 }
 226
 227 bool power_write(const std::string &file, const std::string &value)
 228 {
 229         // attempt to open the state file
 230         int fd = open(file.c_str(), O_RDWR);
 231         if( fd == -1 ) {
 232                 printf("autosuspend adjustment failure: (file: %s): %s\n",
 233                         file.c_str(),
 234                         strerror(errno));
 235                 return false;
 236         }
 237
 238         int written = write(fd, value.data(), value.size());
 239         int error = errno;
 240         close(fd);
 241
 242         if( written < 0 || (size_t)written != value.size() ) {
 243                 printf("autosuspend adjustment failure (write): (file: %s): %s\n",
 244                         file.c_str(),
 245                         strerror(error));
 246                 return false;
 247         }
 248
 249         printf("autosuspend adjustment: wrote %s to %s\n",
 250                 value.c_str(), file.c_str());
 251         return true;
 252 }
 253
 254 //
 255 // Checks for USB suspend, and enables the device if suspended.
 256 //
 257 // Kernel 2.6.21 behaves with autosuspend=0 meaning off, while 2.6.22
 258 // and higher needs autosuspend=-1 to turn it off.  In 2.6.22, a value
 259 // of 0 means "immediate" instead of "never".
 260 //
 261 // Version 2.6.22 adds variables internal to the system called
 262 // autosuspend_disabled and autoresume_disabled.  These are controlled by the
 263 // /sys/class/usb_device/*/device/power/level file.  (See below)
 264 //
 265 // Here's a summary of files under device/power.  These may or may not exist
 266 // depending on your kernel version and configuration.
 267 //
 268 //
 269 //        autosuspend
 270 //                -1 or 0 means off, depending on kernel,
 271 //                otherwise it is the number of seconds to
 272 //                autosuspend
 273 //
 274 //        level
 275 //                with the settings:
 276 //
 277 //                on      - suspend is disabled, device is fully powered
 278 //                auto    - suspend is controlled by the kernel (default)
 279 //                suspend - suspend is enabled permanently
 280 //
 281 //                You can write these strings to the file to control
 282 //                behaviour on a per-device basis.
 283 //
 284 //                echo on > /sys/usb_device/.../device/power/level
 285 //
 286 //        state
 287 //                current state of device
 288 //                0 - fully powered
 289 //                2 - suspended
 290 //
 291 //                You can write these numbers to control behaviour, but
 292 //                any change you make here might change automatically
 293 //                if autosuspend is on.
 294 //
 295 //                echo -n 0 > /sys/usb_device/.../device/power/state
 296 //
 297 //        wakeup
 298 //                unknown
 299 //
 300 //
 301 // Given the above facts, use the following heuristics to try to disable
 302 // autosuspend for the Blackberry:
 303 //
 304 //      - if level exists, write "on" to it
 305 //      - if autosuspend exists, write -1 to it
 306 //              - if error, write 0 to it
 307 //      - if neither of the above work, and state exists, write 0 to it
 308 //
 309 void resume()
 310 {
 311         if( udev_devpath.size() == 0 )
 312                 return; // nothing to do
 313
 314         // let sysfs settle a bit
 315         sleep(5);
 316
 317         std::string power_path = sysfs_path + "/" + udev_devpath + "/device/power/";
 318
 319         if( !power_write(power_path + "level", "on\n") )
 320                 if( !power_write(power_path + "autosuspend", "-1\n") )
 321                         if( !power_write(power_path + "autosuspend", "0\n") )
 322                                 power_write(power_path + "state", "0");
 323 }
 324
 325 int main(int argc, char *argv[])
 326 {
 327         struct usb_bus *busses;
 328
 329         INIT_I18N(PACKAGE);
 330
 331         //
 332         // allow -o command line switch to choose which mode to use for
 333         // Blackberry Pearls:
 334         //      Dual(default):  0004    -d
 335         //      With switch:    0001    -o
 336         //
 337
 338         // process command line options
 339         for(;;) {
 340                 int cmd = getopt(argc, argv, "dop:s:h");
 341                 if( cmd == -1 )
 342                         break;
 343
 344                 switch( cmd )
 345                 {
 346                 case 'd':       // Dual (default)
 347                         force_dual = true;
 348                         old_style_pearl = false;
 349                         break;
 350
 351                 case 'o':       // Old style pearl
 352                         force_dual = false;
 353                         old_style_pearl = true;
 354                         break;
 355
 356                 case 'p':       // udev devpath
 357                         udev_devpath = optarg;
 358                         break;
 359
 360                 case 's':       // where sysfs is mounted
 361                         sysfs_path = optarg;
 362                         break;
 363
 364                 case 'h':       // help!
 365                 default:
 366                         Usage();
 367                         return 0;
 368                 }
 369         }
 370
 371         usb_init();
 372         if( usb_find_busses() < 0 || usb_find_devices() < 0 ) {
 373                 printf("\nUnable to scan devices: %s\n", usb_strerror());
 374                 return 1;
 375         }
 376         busses = usb_get_busses();
 377
 378         printf("Scanning for Blackberry devices...\n");
 379
 380         struct usb_bus *bus;
 381         for( bus = busses; bus; bus = bus->next ) {
 382                 struct usb_device *dev;
 383
 384                 for (dev = bus->devices; dev; dev = dev->next) {
 385                         // Is this a blackberry?
 386                         if( dev->descriptor.idVendor == VENDOR_RIM ) {
 387                                 switch(dev->descriptor.idProduct)
 388                                 {
 389                                 case PRODUCT_RIM_BLACKBERRY:
 390                                         if( !process(dev, false) )
 391                                                 resume();
 392                                         break;
 393
 394                                 case PRODUCT_RIM_PEARL_DUAL:
 395                                 case PRODUCT_RIM_PEARL:
 396                                 case PRODUCT_RIM_PEARL_8120:
 397                                 case PRODUCT_RIM_PEARL_FLIP:
 398                                 case PRODUCT_RIM_STORM:
 399                                         if( !process(dev, true) )
 400                                                 resume();
 401                                         break;
 402                                 }
 403                         }
 404                 }
 405         }
 406 }
 407