release/src/router/usbmodeswitch/data/README

   1 README for USB_ModeSwitch Data
   2
   3
   4 For up-to-date and detailed information (plus a friendly forum) visit
   5 http://www.draisberghof.de/usb_modeswitch
   6
   7 PLEASE REPORT NEW DEVICES !
   8
   9
  10
  11 This is a data package to complement the full release package of
  12 USB_ModeSwitch, a tool to switch multi-mode USB devices.
  13 It is used since usb-modeswitch version 1.0.3.
  14
  15 Recommended version of usb-modeswitch package is 1.2.5 and above. From
  16 this version on, the rules file does not check for the class of inter-
  17 face 0 anymore, the check was moved to the dispatcher.
  18 The changes were necessary for future MBIM device support.
  19
  20 Just do "make install". To re-generate udev rules file, type "make clean"
  21 and install again ("tcl" package required).
  22
  23
  24 Tasks initiated by the rules file:
  25 ==================================
  26
  27 - call wrapper to initiate switching for known devices when plugged in
  28   (starting from version 1.1.4 at boot time too)
  29
  30 - adding symlink "gsmmodem" to appropriate connection port (out of 2-5
  31   ports provided by some devices); this is only a convenience feature and
  32   NOT needed for switching or later port operation.
  33   This action will be triggered for known modems only (at least switched
  34   once on this system)
  35
  36 - loading and binding the "option" driver if the device arrives in modem
  37   state (not CDC/ACM) and the device ID is not yet known to the driver.
  38   This action will be triggered only for modems known to the system (at
  39   least switched once).
  40   To prevent the default driver binding, add NoDriverLoading=1 to the
  41   respective device configuration file
  42
  43
  44 Explanation about config file names:
  45 ====================================
  46
  47 Names consist of <VendorID>:<ProductID>, respective to the default device
  48 mode.
  49 Should more detailed identification become necessary, one or more attributes
  50 to test can be attached after further colons:
  51 <VendorID>:<ProductID>:<Attribute>=<String>[:<Attribute>=<String> ...]
  52
  53 The strings match if they are part of the attribute content. Use "_"
  54 to match spaces (it will match "_" too!).
  55
  56 Currently recognized attibutes are:
  57
  58 uMa = USB, iManufacturer
  59 uPr = USB, iProduct
  60 uSe = USB, iSerial
  61 sVe = SCSI, Vendor
  62 sMo = SCSI, Model
  63 sRe = SCSI, Revision
  64
  65 This list is easily extendable if necessary.
  66
  67 Example:
  68 <vid>:<pid>:uPr=CDMA_Mo will match iProduct "CDMA Modem" or "MyCDMA_Mordor"
  69
  70
  71
  72 Parameters used only in config files:
  73 =====================================
  74
  75 These are not evaluated by the binary but by the wrapper.
  76
  77 WaitBefore=<seconds>            delay the switching process
  78
  79 DriverModule=<module name>      load a specific driver module after switch
  80
  81 DriverIDPath=<path to attribute>
  82                                 if the driver has the ability to add new device IDs
  83                                 on-the-fly, this is the file node to use.
  84                                 Example: "/sys/bus/usb-serial/drivers/option1/new_id"
  85
  86
  87
  88 Notes about specific devices:
  89 =============================
  90
  91 - 1004:607f (LG KP500): switching message derived from report but untested
  92
  93 - 1266:1000 (Royaltek Q110): switching method very likely but unconfirmed
  94
  95 - Some WiMAX and LTE devices are included since 20101222; for some of these
  96   drivers are work in progress or not available yet. Efforts are underway.
  97   Stand by or search for "staging drivers".
  98
  99 - 05c6:2000 (unnamed HSDPA modem from "dealextreme"): unusually long switching
 100   time reported, even with MS Windoze - 30 to 40 seconds. Don't be alarmed.
 101
 102 - 0471:1210 (Philips chipset): had to be split after variants with different
 103   targets and behaviour appeared. This is not fully confirmed yet, please
 104   report problems.
 105
 106
 107 Legal
 108 =====
 109
 110 This program is free software; you can redistribute it and/or modify it under
 111 the terms of the GNU General Public License as published by the Free Software
 112 Foundation; either version 2 of the License, or (at your option) any later
 113 version.
 114
 115 This program is distributed in the hope that it will be useful, but WITHOUT ANY
 116 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 117 PARTICULAR PURPOSE.  See the GNU General Public License for more details:
 118
 119 http://www.gnu.org/licenses/gpl.txt
 120
 121 Or find it as the file COPYING in this folder.
 122
 123
 124
 125
 126 Last revised: 2013-06-02, Josua Dietze