Documentation/usb/usb-serial.txt

   1 INTRODUCTION
   2
   3   The USB serial driver currently supports a number of different USB to
   4   serial converter products, as well as some devices that use a serial
   5   interface from userspace to talk to the device.
   6
   7   See the individual product section below for specific information about
   8   the different devices.
   9
  10
  11 CONFIGURATION
  12
  13   Currently the driver can handle up to 256 different serial interfaces at
  14   one time.
  15
  16   If you are not using devfs:
  17     The major number that the driver uses is 188 so to use the driver,
  18     create the following nodes:
  19         mknod /dev/ttyUSB0 c 188 0
  20         mknod /dev/ttyUSB1 c 188 1
  21         mknod /dev/ttyUSB2 c 188 2
  22         mknod /dev/ttyUSB3 c 188 3
  23                 .
  24                 .
  25                 .
  26         mknod /dev/ttyUSB254 c 188 254
  27         mknod /dev/ttyUSB255 c 188 255
  28
  29   If you are using devfs:
  30     The devices supported by this driver will show up as
  31     /dev/usb/tts/{0,1,...}
  32
  33   When the device is connected and recognized by the driver, the driver
  34   will print to the system log, which node(s) the device has been bound
  35   to.
  36
  37
  38 SPECIFIC DEVICES SUPPORTED
  39
  40
  41 ConnectTech WhiteHEAT 4 port converter
  42
  43   ConnectTech has been very forthcoming with information about their
  44   device, including providing a unit to test with. This driver will end up
  45   being fully supported.
  46
  47 Current status:
  48   The device's firmware is downloaded on connection, the new firmware
  49   runs properly and all four ports are successfully recognized and connected.
  50   Data can be sent and received through the device on all ports.
  51   Hardware flow control needs to be implemented.
  52
  53
  54 HandSpring Visor USB docking station
  55
  56 Current status:
  57   Only when the Visor tries to connect to the host, does the docking
  58   station show up as a valid USB device. When this happens, the device is
  59   properly enumerated, assigned a port, and then communication _should_ be
  60   possible. The driver cleans up properly when the device is removed, or
  61   the connection is canceled on the Visor.
  62
  63   NOTE:
  64     This means that in order to talk to the Visor, the sync button must be
  65     pressed BEFORE trying to get any program to communicate to the Visor.
  66     This goes against the current documentation for pilot-xfer and other
  67     packages, but is the only way that it will work due to the hardware
  68     in the Visor.
  69
  70   When the device is connected, try talking to it on the second port
  71   (this is usually /dev/ttyUSB1 if you do not have any other usb-serial
  72   devices in the system.) The system log should tell you which port is
  73   the port to use for the HotSync transfer. The "Generic" port can be used
  74   for other device communication, such as a PPP link.
  75
  76   There is a webpage and mailing lists for this portion of the driver at:
  77   http://usbvisor.sourceforge.net/
  78
  79
  80 Keyspan PDA Serial Adapter
  81
  82   Single port DB-9 serial adapter, pushed as a PDA adapter for iMacs (mostly
  83   sold in Macintosh catalogs, comes in a translucent white/green dongle).
  84   Fairly simple device. Firmware is homebrew.
  85
  86 Current status:
  87  Things that work:
  88    basic input/output (tested with 'cu')
  89    blocking write when serial line can't keep up
  90    changing baud rates (up to 115200)
  91    getting/setting modem control pins (TIOCM{GET,SET,BIS,BIC})
  92    sending break (although duration looks suspect)
  93  Things that don't:
  94    device strings (as logged by kernel) have trailing binary garbage
  95    device ID isn't right, might collide with other Keyspan products
  96    changing baud rates ought to flush tx/rx to avoid mangled half characters
  97  Big Things on the todo list:
  98    parity, 7 vs 8 bits per char, 1 or 2 stop bits
  99    HW flow control
 100    not all of the standard USB descriptors are handled: Get_Status, Set_Feature
 101    O_NONBLOCK, select()
 102
 103
 104 Keyspan USA-series Serial Adapters
 105
 106   Single and Dual port adapters - driver uses Keyspan supplied
 107   firmware and is being developed with their support.
 108
 109   Driver isn't as far advanced as Keyspan PDA driver mentioned above.
 110
 111 Current status:
 112  Things that work:
 113    Firmware upload for USA-18X, USA-28, USA-28X, USA-19 and USA-19W
 114    Simple character I/O fixed at 9600 baud on USA-19 only
 115
 116  Things that don't:
 117    Everything else. (for now...)
 118
 119  Big Things on the todo list:
 120    Driver is in infancy, much functionality remains to be added
 121
 122
 123 FTDI Single Port Serial Driver
 124
 125   This is a single port DB-25 serial adapter. More information about this
 126   device and the Linux driver can be found at:
 127         http://reality.sgi.com/bryder_wellington/ftdi_sio/
 128
 129
 130 ZyXEL omni.net lcd plus ISDN TA
 131
 132   This is an ISDN TA. Please report both successes and troubles to the
 133   author at omninet@kroah.com
 134
 135
 136 Digi AccelePort Driver
 137
 138   This driver supports the Digi AccelePort USB 2 and 4 devices, 2 port
 139   (plus a parallel port) and 4 port USB serial converters.  The driver
 140   does NOT yet support the Digi AccelePort USB 8.
 141
 142   The driver is generally working, though we still have a few more ioctls
 143   to implement and final testing and debugging to do.  The paralled port
 144   on the USB 2 is supported as a serial to parallel converter; in other
 145   words, it appears as another USB serial port on Linux, even though
 146   physically it is really a parallel port.  The Digi Acceleport USB 8
 147   is not yet supported.
 148
 149   Please contact Peter Berger (pberger@brimson.com) or Al Borchers
 150   (alborchers@steinerpoint.com) for questions or problems with this
 151   driver.
 152
 153
 154 Belkin USB Serial Adapter F5U103
 155
 156   Single port DB-9/PS-2 serial adapter from Belkin with firmware by eTEK Labs.
 157
 158 Current status:
 159   The following have been tested and work:
 160     Baud rate    300-230400
 161     Data bits    5-8
 162     Stop bits    1-2
 163     Parity       N,E,O,M,S
 164     Handshake    None, Software (XON/XOFF), Hardware (CTSRTS,CTSDTR)*
 165     Break        Set and clear
 166     Line contrl  Input/Output query and control **
 167
 168     *  Hardware input flow control is only enabled for firmware
 169        levels above 2.06.  Read source code comments describing Belkin
 170        firmware errata.  Hardware output flow control is working for all
 171        firmware versions.
 172     ** Queries of inputs (CTS,DSR,CD,RI) show the last
 173        reported state.  Queries of outputs (DTR,RTS) show the last
 174        requested state and may not reflect current state as set by
 175        automatic hardware flow control.
 176
 177 TO DO List:
 178   -- Add true modem contol line query capability.  Currently tracks the
 179      states reported by the interrupt and the states requested.
 180   -- Add error reporting back to application for UART error conditions.
 181   -- Add support for flush ioctls.
 182   -- Add everything else that is missing :)
 183
 184
 185 Empeg empeg-car Mark I/II Driver (empeg.c)
 186
 187   This is an experimental driver to provide connectivity support for the
 188   client synchronization tools for an Empeg empeg-car mp3 player.
 189
 190   The driver is still pretty new, so some testing 'in the wild' would be
 191   helpful. :)
 192
 193
 194 Generic Serial driver
 195
 196   If your device is not one of the above listed devices, compatible with
 197   the above models, you can try out the "generic" interface. This
 198   interface does not provide any type of control messages sent to the
 199   device, and does not support any kind of device flow control. All that
 200   is required of your device is that it has at least one bulk in endpoint,
 201   or one bulk out endpoint.
 202
 203   To enable the generic driver to recognize your device, build the driver
 204   as a module and load it by the following invocation:
 205         insmod usb-serial vendor=0x#### product=0x####
 206   where the #### is replaced with the hex representation of your device's
 207   vendor id and product id.
 208
 209   This driver has been successfully used to connect to the NetChip USB
 210   development board, providing a way to develop USB firmware without
 211   having to write a custom driver.
 212
 213
 214 CONTACT:
 215
 216   If anyone has any problems using this driver, with any of the above
 217   specified products, please contact me, or join the Linux-USB mailing
 218   list (information on joining the mailing list, as well as a link to its
 219   searchable archive is at http://www.linux-usb.org/ )
 220
 221
 222 Greg Kroah-Hartman
 223 greg@kroah.com