Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/sparc-2.6
[linux-2.6.git] / 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     The major number that the driver uses is 188 so to use the driver,
17     create the following nodes:
18         mknod /dev/ttyUSB0 c 188 0
19         mknod /dev/ttyUSB1 c 188 1
20         mknod /dev/ttyUSB2 c 188 2
21         mknod /dev/ttyUSB3 c 188 3
22                 .
23                 .
24                 .
25         mknod /dev/ttyUSB254 c 188 254
26         mknod /dev/ttyUSB255 c 188 255
27
28   When the device is connected and recognized by the driver, the driver
29   will print to the system log, which node(s) the device has been bound
30   to.
31   
32
33 SPECIFIC DEVICES SUPPORTED
34
35
36 ConnectTech WhiteHEAT 4 port converter
37
38   ConnectTech has been very forthcoming with information about their
39   device, including providing a unit to test with.
40
41   The driver is officially supported by Connect Tech Inc.
42   http://www.connecttech.com
43
44   For any questions or problems with this driver, please contact
45   Connect Tech's Support Department at support@connecttech.com
46
47
48 HandSpring Visor, Palm USB, and Clié USB driver
49
50   This driver works with all HandSpring USB, Palm USB, and Sony Clié USB
51   devices.
52
53   Only when the device tries to connect to the host, will the device show
54   up to the host as a valid USB device. When this happens, the device is
55   properly enumerated, assigned a port, and then communication _should_ be
56   possible. The driver cleans up properly when the device is removed, or
57   the connection is canceled on the device.
58
59   NOTE:
60     This means that in order to talk to the device, the sync button must be
61     pressed BEFORE trying to get any program to communicate to the device.
62     This goes against the current documentation for pilot-xfer and other
63     packages, but is the only way that it will work due to the hardware
64     in the device.
65   
66   When the device is connected, try talking to it on the second port
67   (this is usually /dev/ttyUSB1 if you do not have any other usb-serial
68   devices in the system.) The system log should tell you which port is
69   the port to use for the HotSync transfer. The "Generic" port can be used
70   for other device communication, such as a PPP link.
71
72   For some Sony Clié devices, /dev/ttyUSB0 must be used to talk to the
73   device.  This is true for all OS version 3.5 devices, and most devices
74   that have had a flash upgrade to a newer version of the OS.  See the
75   kernel system log for information on which is the correct port to use.
76
77   If after pressing the sync button, nothing shows up in the system log,
78   try resetting the device, first a hot reset, and then a cold reset if
79   necessary.  Some devices need this before they can talk to the USB port
80   properly.
81   
82   Devices that are not compiled into the kernel can be specified with module
83   parameters.  e.g. modprobe visor vendor=0x54c product=0x66
84   
85   There is a webpage and mailing lists for this portion of the driver at:
86   http://usbvisor.sourceforge.net/
87
88   For any questions or problems with this driver, please contact Greg
89   Kroah-Hartman at greg@kroah.com
90
91
92 PocketPC PDA Driver
93
94   This driver can be used to connect to Compaq iPAQ, HP Jornada, Casio EM500
95   and other PDAs running Windows CE 3.0 or PocketPC 2002 using a USB
96   cable/cradle.
97   Most devices supported by ActiveSync are supported out of the box.
98   For others, please use module parameters to specify the product and vendor
99   id. e.g. modprobe ipaq vendor=0x3f0 product=0x1125
100
101   The driver presents a serial interface (usually on /dev/ttyUSB0) over
102   which one may run ppp and establish a TCP/IP link to the PDA. Once this
103   is done, you can transfer files, backup, download email etc. The most
104   significant advantage of using USB is speed - I can get 73 to 113
105   kbytes/sec for download/upload to my iPAQ.
106
107   This driver is only one of a set of components required to utilize
108   the USB connection. Please visit http://synce.sourceforge.net which
109   contains the necessary packages and a simple step-by-step howto.
110
111   Once connected, you can use Win CE programs like ftpView, Pocket Outlook
112   from the PDA and xcerdisp, synce utilities from the Linux side.
113
114   To use Pocket IE, follow the instructions given at
115   http://www.tekguru.co.uk/EM500/usbtonet.htm to achieve the same thing
116   on Win98. Omit the proxy server part; Linux is quite capable of forwarding
117   packets unlike Win98. Another modification is required at least for the
118   iPAQ - disable autosync by going to the Start/Settings/Connections menu
119   and unchecking the "Automatically synchronize ..." box. Go to
120   Start/Programs/Connections, connect the cable and select "usbdial" (or
121   whatever you named your new USB connection). You should finally wind
122   up with a "Connected to usbdial" window with status shown as connected.
123   Now start up PIE and browse away.
124
125   If it doesn't work for some reason, load both the usbserial and ipaq module
126   with the module parameter "debug" set to 1 and examine the system log.
127   You can also try soft-resetting your PDA before attempting a connection.
128
129   Other functionality may be possible depending on your PDA. According to
130   Wes Cilldhaire <billybobjoehenrybob@hotmail.com>, with the Toshiba E570,
131   ...if you boot into the bootloader (hold down the power when hitting the
132   reset button, continuing to hold onto the power until the bootloader screen
133   is displayed), then put it in the cradle with the ipaq driver loaded, open
134   a terminal on /dev/ttyUSB0, it gives you a "USB Reflash" terminal, which can
135   be used to flash the ROM, as well as the microP code..  so much for needing
136   Toshiba's $350 serial cable for flashing!! :D
137   NOTE: This has NOT been tested. Use at your own risk.
138  
139   For any questions or problems with the driver, please contact Ganesh
140   Varadarajan <ganesh@veritas.com>
141
142
143 Keyspan PDA Serial Adapter
144
145   Single port DB-9 serial adapter, pushed as a PDA adapter for iMacs (mostly
146   sold in Macintosh catalogs, comes in a translucent white/green dongle).
147   Fairly simple device. Firmware is homebrew.
148   This driver also works for the Xircom/Entrgra single port serial adapter.
149
150   Current status:
151    Things that work:
152      basic input/output (tested with 'cu')
153      blocking write when serial line can't keep up
154      changing baud rates (up to 115200)
155      getting/setting modem control pins (TIOCM{GET,SET,BIS,BIC})
156      sending break (although duration looks suspect)
157    Things that don't:
158      device strings (as logged by kernel) have trailing binary garbage
159      device ID isn't right, might collide with other Keyspan products
160      changing baud rates ought to flush tx/rx to avoid mangled half characters
161    Big Things on the todo list:
162      parity, 7 vs 8 bits per char, 1 or 2 stop bits
163      HW flow control
164      not all of the standard USB descriptors are handled: Get_Status, Set_Feature
165      O_NONBLOCK, select()
166
167   For any questions or problems with this driver, please contact Brian
168   Warner at warner@lothar.com 
169
170
171 Keyspan USA-series Serial Adapters
172
173   Single, Dual and Quad port adapters - driver uses Keyspan supplied 
174   firmware and is being developed with their support.
175   
176   Current status:
177     The USA-18X, USA-28X, USA-19, USA-19W and USA-49W are supported and
178     have been pretty thoroughly tested at various baud rates with 8-N-1
179     character settings.  Other character lengths and parity setups are
180     presently untested.
181
182     The USA-28 isn't yet supported though doing so should be pretty
183     straightforward.  Contact the maintainer if you require this
184     functionality.
185   
186   More information is available at:
187         http://misc.nu/hugh/keyspan.html
188    
189   For any questions or problems with this driver, please contact Hugh
190   Blemings at hugh@misc.nu
191
192
193 FTDI Single Port Serial Driver
194
195   This is a single port DB-25 serial adapter.
196
197   For any questions or problems with this driver, please contact Bill Ryder.
198
199
200 ZyXEL omni.net lcd plus ISDN TA
201
202   This is an ISDN TA. Please report both successes and troubles to
203   azummo@towertech.it
204
205
206 Cypress M8 CY4601 Family Serial Driver
207
208   This driver was in most part developed by Neil "koyama" Whelchel.  It
209   has been improved since that previous form to support dynamic serial
210   line settings and improved line handling.  The driver is for the most
211   part stable and has been tested on an smp machine. (dual p2)
212
213     Chipsets supported under CY4601 family:
214         
215                 CY7C63723, CY7C63742, CY7C63743, CY7C64013
216
217     Devices supported:
218
219                 -DeLorme's USB Earthmate (SiRF Star II lp arch)
220                 -Cypress HID->COM RS232 adapter
221         
222                 Note: Cypress Semiconductor claims no affiliation with the
223                         hid->com device.
224
225         Most devices using chipsets under the CY4601 family should
226      work with the driver.  As long as they stay true to the CY4601
227      usbserial specification.
228
229     Technical notes:
230
231         The Earthmate starts out at 4800 8N1 by default... the driver will
232         upon start init to this setting.  usbserial core provides the rest
233         of the termios settings, along with some custom termios so that the
234         output is in proper format and parsable.
235         
236         The device can be put into sirf mode by issuing NMEA command:
237                 $PSRF100,<protocol>,<baud>,<databits>,<stopbits>,<parity>*CHECKSUM
238                 $PSRF100,0,9600,8,1,0*0C
239
240                 It should then be sufficient to change the port termios to match this
241                 to begin communicating.
242
243         As far as I can tell it supports pretty much every sirf command as
244         documented online available with firmware 2.31, with some unknown
245         message ids.
246
247         The hid->com adapter can run at a maximum baud of 115200bps.  Please note
248         that the device has trouble or is incapable of raising line voltage properly.
249         It will be fine with null modem links, as long as you do not try to link two
250         together without hacking the adapter to set the line high.
251
252         The driver is smp safe.  Performance with the driver is rather low when using
253         it for transferring files.  This is being worked on, but I would be willing to
254         accept patches.  An urb queue or packet buffer would likely fit the bill here.
255
256         If you have any questions, problems, patches, feature requests, etc. you can
257         contact me here via email:
258                                         dignome@gmail.com
259                 (your problems/patches can alternately be submitted to usb-devel)
260
261
262 Digi AccelePort Driver
263
264   This driver supports the Digi AccelePort USB 2 and 4 devices, 2 port
265   (plus a parallel port) and 4 port USB serial converters.  The driver
266   does NOT yet support the Digi AccelePort USB 8.
267
268   This driver works under SMP with the usb-uhci driver.  It does not
269   work under SMP with the uhci driver.
270
271   The driver is generally working, though we still have a few more ioctls
272   to implement and final testing and debugging to do.  The parallel port
273   on the USB 2 is supported as a serial to parallel converter; in other
274   words, it appears as another USB serial port on Linux, even though
275   physically it is really a parallel port.  The Digi Acceleport USB 8
276   is not yet supported.
277
278   Please contact Peter Berger (pberger@brimson.com) or Al Borchers
279   (alborchers@steinerpoint.com) for questions or problems with this
280   driver.
281
282
283 Belkin USB Serial Adapter F5U103
284
285   Single port DB-9/PS-2 serial adapter from Belkin with firmware by eTEK Labs.
286   The Peracom single port serial adapter also works with this driver, as
287   well as the GoHubs adapter.
288
289   Current status:
290     The following have been tested and work:
291       Baud rate    300-230400               
292       Data bits    5-8
293       Stop bits    1-2
294       Parity       N,E,O,M,S
295       Handshake    None, Software (XON/XOFF), Hardware (CTSRTS,CTSDTR)*
296       Break        Set and clear
297       Line control Input/Output query and control **
298
299       *  Hardware input flow control is only enabled for firmware
300          levels above 2.06.  Read source code comments describing Belkin
301          firmware errata.  Hardware output flow control is working for all
302          firmware versions.
303       ** Queries of inputs (CTS,DSR,CD,RI) show the last
304          reported state.  Queries of outputs (DTR,RTS) show the last
305          requested state and may not reflect current state as set by
306          automatic hardware flow control.
307
308   TO DO List:
309     -- Add true modem control line query capability.  Currently tracks the
310        states reported by the interrupt and the states requested.
311     -- Add error reporting back to application for UART error conditions.
312     -- Add support for flush ioctls.
313     -- Add everything else that is missing :)
314
315   For any questions or problems with this driver, please contact William
316   Greathouse at wgreathouse@smva.com
317
318
319 Empeg empeg-car Mark I/II Driver
320
321   This is an experimental driver to provide connectivity support for the
322   client synchronization tools for an Empeg empeg-car mp3 player.
323
324   Tips:
325     * Don't forget to create the device nodes for ttyUSB{0,1,2,...}
326     * modprobe empeg (modprobe is your friend)
327     * emptool --usb /dev/ttyUSB0 (or whatever you named your device node)
328
329   For any questions or problems with this driver, please contact Gary
330   Brubaker at xavyer@ix.netcom.com
331
332
333 MCT USB Single Port Serial Adapter U232
334
335   This driver is for the MCT USB-RS232 Converter (25 pin, Model No.
336   U232-P25) from Magic Control Technology Corp. (there is also a 9 pin
337   Model No. U232-P9). More information about this device can be found at
338   the manufacturer's web-site: http://www.mct.com.tw.
339
340   The driver is generally working, though it still needs some more testing.
341   It is derived from the Belkin USB Serial Adapter F5U103 driver and its
342   TODO list is valid for this driver as well.
343
344   This driver has also been found to work for other products, which have
345   the same Vendor ID but different Product IDs. Sitecom's U232-P25 serial
346   converter uses Product ID 0x230 and Vendor ID 0x711 and works with this
347   driver. Also, D-Link's DU-H3SP USB BAY also works with this driver.
348
349   For any questions or problems with this driver, please contact Wolfgang
350   Grandegger at wolfgang@ces.ch
351
352
353 Inside Out Networks Edgeport Driver
354
355   This driver supports all devices made by Inside Out Networks, specifically
356   the following models:
357        Edgeport/4
358        Rapidport/4
359        Edgeport/4t
360        Edgeport/2
361        Edgeport/4i
362        Edgeport/2i
363        Edgeport/421
364        Edgeport/21
365        Edgeport/8
366        Edgeport/8 Dual
367        Edgeport/2D8
368        Edgeport/4D8
369        Edgeport/8i
370        Edgeport/2 DIN
371        Edgeport/4 DIN
372        Edgeport/16 Dual
373
374   For any questions or problems with this driver, please contact Greg
375   Kroah-Hartman at greg@kroah.com
376
377
378 REINER SCT cyberJack pinpad/e-com USB chipcard reader
379    
380   Interface to ISO 7816 compatible contactbased chipcards, e.g. GSM SIMs.
381   
382   Current status:
383     This is the kernel part of the driver for this USB card reader.
384     There is also a user part for a CT-API driver available. A site
385     for downloading is TBA. For now, you can request it from the
386     maintainer (linux-usb@sii.li).
387
388   For any questions or problems with this driver, please contact
389   linux-usb@sii.li
390
391
392 Prolific PL2303 Driver
393
394   This driver supports any device that has the PL2303 chip from Prolific
395   in it.  This includes a number of single port USB to serial
396   converters and USB GPS devices.  Devices from Aten (the UC-232) and
397   IO-Data work with this driver, as does the DCU-11 mobile-phone cable.
398
399   For any questions or problems with this driver, please contact Greg
400   Kroah-Hartman at greg@kroah.com
401   
402
403 KL5KUSB105 chipset / PalmConnect USB single-port adapter
404   
405 Current status:
406   The driver was put together by looking at the usb bus transactions
407   done by Palm's driver under Windows, so a lot of functionality is
408   still missing.  Notably, serial ioctls are sometimes faked or not yet
409   implemented.  Support for finding out about DSR and CTS line status is
410   however implemented (though not nicely), so your favorite autopilot(1)
411   and pilot-manager -daemon calls will work.  Baud rates up to 115200
412   are supported, but handshaking (software or hardware) is not, which is
413   why it is wise to cut down on the rate used is wise for large
414   transfers until this is settled.
415   
416 Options supported:
417   If this driver is compiled as a module you can pass the following
418   options to it:
419   debug                 - extra verbose debugging info
420                           (default: 0; nonzero enables)
421   use_lowlatency        - use low_latency flag to speed up tty layer
422                           when reading from the device.
423                           (default: 0; nonzero enables)
424
425   See http://www.uuhaus.de/linux/palmconnect.html for up-to-date
426   information on this driver.
427
428 Winchiphead CH341 Driver
429
430   This driver is for the Winchiphead CH341 USB-RS232 Converter. This chip
431   also implements an IEEE 1284 parallel port, I2C and SPI, but that is not
432   supported by the driver. The protocol was analyzed from the behaviour
433   of the Windows driver, no datasheet is available at present.
434   The manufacturer's website: http://www.winchiphead.com/.
435   For any questions or problems with this driver, please contact
436   frank@kingswood-consulting.co.uk.
437
438
439 Generic Serial driver
440
441   If your device is not one of the above listed devices, compatible with
442   the above models, you can try out the "generic" interface. This
443   interface does not provide any type of control messages sent to the
444   device, and does not support any kind of device flow control. All that
445   is required of your device is that it has at least one bulk in endpoint,
446   or one bulk out endpoint. 
447   
448   To enable the generic driver to recognize your device, build the driver
449   as a module and load it by the following invocation:
450         insmod usbserial vendor=0x#### product=0x####
451   where the #### is replaced with the hex representation of your device's
452   vendor id and product id.
453
454   This driver has been successfully used to connect to the NetChip USB
455   development board, providing a way to develop USB firmware without
456   having to write a custom driver.
457
458   For any questions or problems with this driver, please contact Greg
459   Kroah-Hartman at greg@kroah.com
460
461
462 CONTACT:
463
464   If anyone has any problems using these drivers, with any of the above
465   specified products, please contact the specific driver's author listed
466   above, or join the Linux-USB mailing list (information on joining the
467   mailing list, as well as a link to its searchable archive is at
468   http://www.linux-usb.org/ )
469
470
471 Greg Kroah-Hartman
472 greg@kroah.com