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.1.4 and above. Some
  16 devices contained here may not be switched with older versions, even if
  17 they will not cause any error.
  18
  19
  20 Tasks initiated by the rules file:
  21 ==================================
  22
  23 - call wrapper to initiate switching for known devices when plugged in
  24   (starting from version 1.1.4 at boot time too)
  25
  26 - adding symlink "gsmmodem" to appropriate connection port (out of 2-5
  27   ports provided by some devices); this is only a help for handling and
  28   NOT needed for switching to work.
  29   This action will be done for known modems only (at least switched once
  30   on this system)
  31
  32 - loading and binding the "option" driver if the device arrives in modem
  33   state (not CDC/ACM!) and the device ID is not yet known to the driver.
  34   This action will be done for known modems only (at least switched once
  35   on this system)
  36
  37
  38 Explanation about config file names:
  39 ====================================
  40
  41 Names consist of <VendorID>:<ProductID>, respective to the default device
  42 mode.
  43 Should more detailed identification become necessary, one or more attributes
  44 to test can be attached after further colons:
  45 <VendorID>:<ProductID>:<Attribute>=<String>[:<Attribute>=<String> ...]
  46
  47 The strings match if they are part of the attribute content. Use "_"
  48 to match spaces (it will match "_" too!).
  49
  50 Currently recognized attibutes are:
  51
  52 uMa = USB, iManufacturer
  53 uPr = USB, iProduct
  54 uSe = USB, iSerial
  55 sVe = SCSI, Vendor
  56 sMo = SCSI, Model
  57 sRe = SCSI, Revision
  58
  59 This list is easily extendable if necessary.
  60
  61 Example:
  62 <vid>:<pid>:uPr=CDMA_Mo will match iProduct "CDMA Modem" or "MyCDMA_Mordor"
  63
  64
  65 If information is missing about ambiguous devices, a ":?" is attached
  66 to the file/ID in question. Please contact the forum if you need help
  67 in such a case.
  68
  69
  70 Parameters used only in config files:
  71 =====================================
  72
  73 These are not evaluated by the binary but by the wrapper.
  74
  75 WaitBefore=<seconds>            delay the switching process
  76
  77 DriverModule=<module name>      load a specific driver module after switch
  78
  79 DriverIDPath=<path to attribute>
  80                                 if the driver has the ability to add new device IDs
  81                                 on-the-fly, this is the file node to use.
  82                                 Example: "/sys/bus/usb-serial/drivers/option1/new_id"
  83
  84
  85
  86 Notes about specific devices:
  87 =============================
  88
  89 - 16d8:6803 (C-motech D50, CDU-680): two versions popped up; one with
  90   ID unchanged, target class 0xff, providing standard serial ports,
  91   and one with target product 0x680a, providing an ACM port. There is
  92   not enough information how to tell them apart; if you have the second
  93   one, we badly need information (usb_modeswitch output with SCSI inquiry)
  94
  95 - 1004:607f (LG KP500): switching message derived from report but untested
  96
  97 - 1266:1000 (Royaltek Q110): switching method very likely but unconfirmed
  98
  99 - 1a8d:1000 (BandLuxe): now just one config for all devices; the new parameter
 100   "ReleaseDelay" will improve ambiguous behaviour on older systems
 101
 102 - Some WiMAX and LTE devices are included since 20101222; for most of these
 103   there are no working Linux drivers available yet. Efforts are underway.
 104   Stand by or search for "staging drivers".
 105
 106 - 05c6:2000 (unnamed HSDPA modem from "dealextreme"): unusually long switching
 107   time, even with MS Windoze - 30 to 40 seconds. Don't be alarmed.
 108
 109 - 0471:1210 (Philips chipset): had to be split after variants with different
 110   targets and behaviour appeared. This is not properly tested yet, please
 111   report problems.
 112
 113
 114 Legal
 115 =====
 116
 117 This program is free software; you can redistribute it and/or modify it under
 118 the terms of the GNU General Public License as published by the Free Software
 119 Foundation; either version 2 of the License, or (at your option) any later
 120 version.
 121
 122 This program is distributed in the hope that it will be useful, but WITHOUT ANY
 123 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 124 PARTICULAR PURPOSE.  See the GNU General Public License for more details:
 125
 126 http://www.gnu.org/licenses/gpl.txt
 127
 128 Or find it as the file COPYING in this folder.
 129
 130
 131
 132
 133 Last revised: 2011-07-14, Josua Dietze