usb-serial.txt 18 KB

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