]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
1da177e4 LT |
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 | ||
1da177e4 LT |
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 | |
8bc84930 | 45 | Connect Tech's Support Department at support@connecttech.com |
1da177e4 LT |
46 | |
47 | ||
be2a608b | 48 | HandSpring Visor, Palm USB, and Clié USB driver |
1da177e4 | 49 | |
be2a608b | 50 | This driver works with all HandSpring USB, Palm USB, and Sony Clié USB |
1da177e4 LT |
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 | ||
be2a608b | 72 | For some Sony Clié devices, /dev/ttyUSB0 must be used to talk to the |
1da177e4 LT |
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 | |
fa00e7e1 | 178 | have been pretty thoroughly tested at various baud rates with 8-N-1 |
1da177e4 LT |
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. More information about this | |
196 | device and the Linux driver can be found at: | |
197 | http://reality.sgi.com/bryder_wellington/ftdi_sio/ | |
198 | ||
199 | For any questions or problems with this driver, please contact Bill Ryder | |
200 | at bryder@sgi.com | |
201 | ||
202 | ||
203 | ZyXEL omni.net lcd plus ISDN TA | |
204 | ||
205 | This is an ISDN TA. Please report both successes and troubles to | |
206 | azummo@towertech.it | |
207 | ||
208 | ||
209 | Cypress M8 CY4601 Family Serial Driver | |
210 | ||
211 | This driver was in most part developed by Neil "koyama" Whelchel. It | |
212 | has been improved since that previous form to support dynamic serial | |
213 | line settings and improved line handling. The driver is for the most | |
214 | part stable and has been tested on an smp machine. (dual p2) | |
215 | ||
216 | Chipsets supported under CY4601 family: | |
217 | ||
218 | CY7C63723, CY7C63742, CY7C63743, CY7C64013 | |
219 | ||
220 | Devices supported: | |
221 | ||
222 | -DeLorme's USB Earthmate (SiRF Star II lp arch) | |
223 | -Cypress HID->COM RS232 adapter | |
224 | ||
225 | Note: Cypress Semiconductor claims no affiliation with the | |
670e9f34 | 226 | hid->com device. |
1da177e4 LT |
227 | |
228 | Most devices using chipsets under the CY4601 family should | |
229 | work with the driver. As long as they stay true to the CY4601 | |
230 | usbserial specification. | |
231 | ||
232 | Technical notes: | |
233 | ||
234 | The Earthmate starts out at 4800 8N1 by default... the driver will | |
235 | upon start init to this setting. usbserial core provides the rest | |
236 | of the termios settings, along with some custom termios so that the | |
237 | output is in proper format and parsable. | |
238 | ||
239 | The device can be put into sirf mode by issuing NMEA command: | |
240 | $PSRF100,<protocol>,<baud>,<databits>,<stopbits>,<parity>*CHECKSUM | |
241 | $PSRF100,0,9600,8,1,0*0C | |
242 | ||
243 | It should then be sufficient to change the port termios to match this | |
244 | to begin communicating. | |
245 | ||
246 | As far as I can tell it supports pretty much every sirf command as | |
247 | documented online available with firmware 2.31, with some unknown | |
248 | message ids. | |
249 | ||
250 | The hid->com adapter can run at a maximum baud of 115200bps. Please note | |
251 | that the device has trouble or is incapable of raising line voltage properly. | |
252 | It will be fine with null modem links, as long as you do not try to link two | |
253 | together without hacking the adapter to set the line high. | |
254 | ||
255 | The driver is smp safe. Performance with the driver is rather low when using | |
fa00e7e1 | 256 | it for transferring files. This is being worked on, but I would be willing to |
1da177e4 LT |
257 | accept patches. An urb queue or packet buffer would likely fit the bill here. |
258 | ||
259 | If you have any questions, problems, patches, feature requests, etc. you can | |
260 | contact me here via email: | |
261 | dignome@gmail.com | |
262 | (your problems/patches can alternately be submitted to usb-devel) | |
263 | ||
264 | ||
265 | Digi AccelePort Driver | |
266 | ||
267 | This driver supports the Digi AccelePort USB 2 and 4 devices, 2 port | |
268 | (plus a parallel port) and 4 port USB serial converters. The driver | |
269 | does NOT yet support the Digi AccelePort USB 8. | |
270 | ||
271 | This driver works under SMP with the usb-uhci driver. It does not | |
272 | work under SMP with the uhci driver. | |
273 | ||
274 | The driver is generally working, though we still have a few more ioctls | |
992caacf | 275 | to implement and final testing and debugging to do. The parallel port |
1da177e4 LT |
276 | on the USB 2 is supported as a serial to parallel converter; in other |
277 | words, it appears as another USB serial port on Linux, even though | |
278 | physically it is really a parallel port. The Digi Acceleport USB 8 | |
279 | is not yet supported. | |
280 | ||
281 | Please contact Peter Berger (pberger@brimson.com) or Al Borchers | |
282 | (alborchers@steinerpoint.com) for questions or problems with this | |
283 | driver. | |
284 | ||
285 | ||
286 | Belkin USB Serial Adapter F5U103 | |
287 | ||
288 | Single port DB-9/PS-2 serial adapter from Belkin with firmware by eTEK Labs. | |
289 | The Peracom single port serial adapter also works with this driver, as | |
290 | well as the GoHubs adapter. | |
291 | ||
292 | Current status: | |
293 | The following have been tested and work: | |
294 | Baud rate 300-230400 | |
295 | Data bits 5-8 | |
296 | Stop bits 1-2 | |
297 | Parity N,E,O,M,S | |
298 | Handshake None, Software (XON/XOFF), Hardware (CTSRTS,CTSDTR)* | |
299 | Break Set and clear | |
5d3f083d | 300 | Line control Input/Output query and control ** |
1da177e4 LT |
301 | |
302 | * Hardware input flow control is only enabled for firmware | |
303 | levels above 2.06. Read source code comments describing Belkin | |
304 | firmware errata. Hardware output flow control is working for all | |
305 | firmware versions. | |
306 | ** Queries of inputs (CTS,DSR,CD,RI) show the last | |
307 | reported state. Queries of outputs (DTR,RTS) show the last | |
308 | requested state and may not reflect current state as set by | |
309 | automatic hardware flow control. | |
310 | ||
311 | TO DO List: | |
5d3f083d | 312 | -- Add true modem control line query capability. Currently tracks the |
1da177e4 LT |
313 | states reported by the interrupt and the states requested. |
314 | -- Add error reporting back to application for UART error conditions. | |
315 | -- Add support for flush ioctls. | |
316 | -- Add everything else that is missing :) | |
317 | ||
318 | For any questions or problems with this driver, please contact William | |
319 | Greathouse at wgreathouse@smva.com | |
320 | ||
321 | ||
322 | Empeg empeg-car Mark I/II Driver | |
323 | ||
324 | This is an experimental driver to provide connectivity support for the | |
325 | client synchronization tools for an Empeg empeg-car mp3 player. | |
326 | ||
327 | Tips: | |
328 | * Don't forget to create the device nodes for ttyUSB{0,1,2,...} | |
329 | * modprobe empeg (modprobe is your friend) | |
330 | * emptool --usb /dev/ttyUSB0 (or whatever you named your device node) | |
331 | ||
332 | For any questions or problems with this driver, please contact Gary | |
333 | Brubaker at xavyer@ix.netcom.com | |
334 | ||
335 | ||
336 | MCT USB Single Port Serial Adapter U232 | |
337 | ||
338 | This driver is for the MCT USB-RS232 Converter (25 pin, Model No. | |
339 | U232-P25) from Magic Control Technology Corp. (there is also a 9 pin | |
340 | Model No. U232-P9). More information about this device can be found at | |
0f035b8e | 341 | the manufacturer's web-site: http://www.mct.com.tw. |
1da177e4 LT |
342 | |
343 | The driver is generally working, though it still needs some more testing. | |
344 | It is derived from the Belkin USB Serial Adapter F5U103 driver and its | |
345 | TODO list is valid for this driver as well. | |
346 | ||
347 | This driver has also been found to work for other products, which have | |
348 | the same Vendor ID but different Product IDs. Sitecom's U232-P25 serial | |
349 | converter uses Product ID 0x230 and Vendor ID 0x711 and works with this | |
350 | driver. Also, D-Link's DU-H3SP USB BAY also works with this driver. | |
351 | ||
352 | For any questions or problems with this driver, please contact Wolfgang | |
353 | Grandegger at wolfgang@ces.ch | |
354 | ||
355 | ||
356 | Inside Out Networks Edgeport Driver | |
357 | ||
358 | This driver supports all devices made by Inside Out Networks, specifically | |
359 | the following models: | |
360 | Edgeport/4 | |
361 | Rapidport/4 | |
362 | Edgeport/4t | |
363 | Edgeport/2 | |
364 | Edgeport/4i | |
365 | Edgeport/2i | |
366 | Edgeport/421 | |
367 | Edgeport/21 | |
368 | Edgeport/8 | |
369 | Edgeport/8 Dual | |
370 | Edgeport/2D8 | |
371 | Edgeport/4D8 | |
372 | Edgeport/8i | |
373 | Edgeport/2 DIN | |
374 | Edgeport/4 DIN | |
375 | Edgeport/16 Dual | |
376 | ||
377 | For any questions or problems with this driver, please contact Greg | |
378 | Kroah-Hartman at greg@kroah.com | |
379 | ||
380 | ||
381 | REINER SCT cyberJack pinpad/e-com USB chipcard reader | |
382 | ||
383 | Interface to ISO 7816 compatible contactbased chipcards, e.g. GSM SIMs. | |
384 | ||
385 | Current status: | |
386 | This is the kernel part of the driver for this USB card reader. | |
387 | There is also a user part for a CT-API driver available. A site | |
388 | for downloading is TBA. For now, you can request it from the | |
389 | maintainer (linux-usb@sii.li). | |
390 | ||
391 | For any questions or problems with this driver, please contact | |
392 | linux-usb@sii.li | |
393 | ||
394 | ||
395 | Prolific PL2303 Driver | |
396 | ||
3d861494 | 397 | This driver supports any device that has the PL2303 chip from Prolific |
1da177e4 LT |
398 | in it. This includes a number of single port USB to serial |
399 | converters and USB GPS devices. Devices from Aten (the UC-232) and | |
3d861494 | 400 | IO-Data work with this driver, as does the DCU-11 mobile-phone cable. |
1da177e4 LT |
401 | |
402 | For any questions or problems with this driver, please contact Greg | |
403 | Kroah-Hartman at greg@kroah.com | |
404 | ||
405 | ||
406 | KL5KUSB105 chipset / PalmConnect USB single-port adapter | |
407 | ||
408 | Current status: | |
409 | The driver was put together by looking at the usb bus transactions | |
410 | done by Palm's driver under Windows, so a lot of functionality is | |
411 | still missing. Notably, serial ioctls are sometimes faked or not yet | |
412 | implemented. Support for finding out about DSR and CTS line status is | |
413 | however implemented (though not nicely), so your favorite autopilot(1) | |
414 | and pilot-manager -daemon calls will work. Baud rates up to 115200 | |
415 | are supported, but handshaking (software or hardware) is not, which is | |
416 | why it is wise to cut down on the rate used is wise for large | |
417 | transfers until this is settled. | |
418 | ||
419 | Options supported: | |
420 | If this driver is compiled as a module you can pass the following | |
421 | options to it: | |
422 | debug - extra verbose debugging info | |
423 | (default: 0; nonzero enables) | |
424 | use_lowlatency - use low_latency flag to speed up tty layer | |
670e9f34 | 425 | when reading from the device. |
1da177e4 LT |
426 | (default: 0; nonzero enables) |
427 | ||
428 | See http://www.uuhaus.de/linux/palmconnect.html for up-to-date | |
429 | information on this driver. | |
430 | ||
6ce76104 FK |
431 | Winchiphead CH341 Driver |
432 | ||
433 | This driver is for the Winchiphead CH341 USB-RS232 Converter. This chip | |
434 | also implements an IEEE 1284 parallel port, I2C and SPI, but that is not | |
435 | supported by the driver. The protocol was analyzed from the behaviour | |
436 | of the Windows driver, no datasheet is available at present. | |
437 | The manufacturer's website: http://www.winchiphead.com/. | |
438 | For any questions or problems with this driver, please contact | |
439 | frank@kingswood-consulting.co.uk. | |
440 | ||
441 | ||
1da177e4 LT |
442 | Generic Serial driver |
443 | ||
444 | If your device is not one of the above listed devices, compatible with | |
445 | the above models, you can try out the "generic" interface. This | |
446 | interface does not provide any type of control messages sent to the | |
447 | device, and does not support any kind of device flow control. All that | |
448 | is required of your device is that it has at least one bulk in endpoint, | |
449 | or one bulk out endpoint. | |
450 | ||
451 | To enable the generic driver to recognize your device, build the driver | |
452 | as a module and load it by the following invocation: | |
453 | insmod usbserial vendor=0x#### product=0x#### | |
454 | where the #### is replaced with the hex representation of your device's | |
455 | vendor id and product id. | |
456 | ||
457 | This driver has been successfully used to connect to the NetChip USB | |
458 | development board, providing a way to develop USB firmware without | |
459 | having to write a custom driver. | |
460 | ||
461 | For any questions or problems with this driver, please contact Greg | |
462 | Kroah-Hartman at greg@kroah.com | |
463 | ||
464 | ||
465 | CONTACT: | |
466 | ||
467 | If anyone has any problems using these drivers, with any of the above | |
468 | specified products, please contact the specific driver's author listed | |
469 | above, or join the Linux-USB mailing list (information on joining the | |
470 | mailing list, as well as a link to its searchable archive is at | |
471 | http://www.linux-usb.org/ ) | |
472 | ||
473 | ||
474 | Greg Kroah-Hartman | |
475 | greg@kroah.com |