ftdi_sio.c 74 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288
  1. /*
  2. * USB FTDI SIO driver
  3. *
  4. * Copyright (C) 1999 - 2001
  5. * Greg Kroah-Hartman (greg@kroah.com)
  6. * Bill Ryder (bryder@sgi.com)
  7. * Copyright (C) 2002
  8. * Kuba Ober (kuba@mareimbrium.org)
  9. *
  10. * This program is free software; you can redistribute it and/or modify
  11. * it under the terms of the GNU General Public License as published by
  12. * the Free Software Foundation; either version 2 of the License, or
  13. * (at your option) any later version.
  14. *
  15. * See Documentation/usb/usb-serial.txt for more information on using this driver
  16. *
  17. * See http://ftdi-usb-sio.sourceforge.net for upto date testing info
  18. * and extra documentation
  19. *
  20. * (21/Jul/2004) Ian Abbott
  21. * Incorporated Steven Turner's code to add support for the FT2232C chip.
  22. * The prelimilary port to the 2.6 kernel was by Rus V. Brushkoff. I have
  23. * fixed a couple of things.
  24. *
  25. * (27/May/2004) Ian Abbott
  26. * Improved throttling code, mostly stolen from the WhiteHEAT driver.
  27. *
  28. * (26/Mar/2004) Jan Capek
  29. * Added PID's for ICD-U20/ICD-U40 - incircuit PIC debuggers from CCS Inc.
  30. *
  31. * (09/Feb/2004) Ian Abbott
  32. * Changed full name of USB-UIRT device to avoid "/" character.
  33. * Added FTDI's alternate PID (0x6006) for FT232/245 devices.
  34. * Added PID for "ELV USB Module UO100" from Stefan Frings.
  35. *
  36. * (21/Oct/2003) Ian Abbott
  37. * Renamed some VID/PID macros for Matrix Orbital and Perle Systems
  38. * devices. Removed Matrix Orbital and Perle Systems devices from the
  39. * 8U232AM device table, but left them in the FT232BM table, as they are
  40. * known to use only FT232BM.
  41. *
  42. * (17/Oct/2003) Scott Allen
  43. * Added vid/pid for Perle Systems UltraPort USB serial converters
  44. *
  45. * (21/Sep/2003) Ian Abbott
  46. * Added VID/PID for Omnidirectional Control Technology US101 USB to
  47. * RS-232 adapter (also rebadged as Dick Smith Electronics XH6381).
  48. * VID/PID supplied by Donald Gordon.
  49. *
  50. * (19/Aug/2003) Ian Abbott
  51. * Freed urb's transfer buffer in write bulk callback.
  52. * Omitted some paranoid checks in write bulk callback that don't matter.
  53. * Scheduled work in write bulk callback regardless of port's open count.
  54. *
  55. * (05/Aug/2003) Ian Abbott
  56. * Added VID/PID for ID TECH IDT1221U USB to RS-232 adapter.
  57. * VID/PID provided by Steve Briggs.
  58. *
  59. * (23/Jul/2003) Ian Abbott
  60. * Added PIDs for CrystalFontz 547, 633, 631, 635, 640 and 640 from
  61. * Wayne Wylupski.
  62. *
  63. * (10/Jul/2003) David Glance
  64. * Added PID for DSS-20 SyncStation cradle for Sony-Ericsson P800.
  65. *
  66. * (27/Jun/2003) Ian Abbott
  67. * Reworked the urb handling logic. We have no more pool, but dynamically
  68. * allocate the urb and the transfer buffer on the fly. In testing this
  69. * does not incure any measurable overhead. This also relies on the fact
  70. * that we have proper reference counting logic for urbs. I nicked this
  71. * from Greg KH's Visor driver.
  72. *
  73. * (23/Jun/2003) Ian Abbott
  74. * Reduced flip buffer pushes and corrected a data length test in
  75. * ftdi_read_bulk_callback.
  76. * Defererence pointers after any paranoid checks, not before.
  77. *
  78. * (21/Jun/2003) Erik Nygren
  79. * Added support for Home Electronics Tira-1 IR transceiver using FT232BM chip.
  80. * See <http://www.home-electro.com/tira1.htm>. Only operates properly
  81. * at 100000 and RTS-CTS, so set custom divisor mode on startup.
  82. * Also force the Tira-1 and USB-UIRT to only use their custom baud rates.
  83. *
  84. * (18/Jun/2003) Ian Abbott
  85. * Added Device ID of the USB relais from Rudolf Gugler (backported from
  86. * Philipp Gühring's patch for 2.5.x kernel).
  87. * Moved read transfer buffer reallocation into startup function.
  88. * Free existing write urb and transfer buffer in startup function.
  89. * Only use urbs in write urb pool that were successfully allocated.
  90. * Moved some constant macros out of functions.
  91. * Minor whitespace and comment changes.
  92. *
  93. * (12/Jun/2003) David Norwood
  94. * Added support for USB-UIRT IR transceiver using 8U232AM chip.
  95. * See <http://home.earthlink.net/~jrhees/USBUIRT/index.htm>. Only
  96. * operates properly at 312500, so set custom divisor mode on startup.
  97. *
  98. * (12/Jun/2003) Ian Abbott
  99. * Added Sealevel SeaLINK+ 210x, 220x, 240x, 280x vid/pids from Tuan Hoang
  100. * - I've eliminated some that don't seem to exist!
  101. * Added Home Electronics Tira-1 IR transceiver pid from Chris Horn
  102. * Some whitespace/coding-style cleanups
  103. *
  104. * (11/Jun/2003) Ian Abbott
  105. * Fixed unsafe spinlock usage in ftdi_write
  106. *
  107. * (24/Feb/2003) Richard Shooter
  108. * Increase read buffer size to improve read speeds at higher baud rates
  109. * (specifically tested with up to 1Mb/sec at 1.5M baud)
  110. *
  111. * (23/Feb/2003) John Wilkins
  112. * Added Xon/xoff flow control (activating support in the ftdi device)
  113. * Added vid/pid for Videonetworks/Homechoice (UK ISP)
  114. *
  115. * (23/Feb/2003) Bill Ryder
  116. * Added matrix orb device vid/pids from Wayne Wylupski
  117. *
  118. * (19/Feb/2003) Ian Abbott
  119. * For TIOCSSERIAL, set alt_speed to 0 when ASYNC_SPD_MASK value has
  120. * changed to something other than ASYNC_SPD_HI, ASYNC_SPD_VHI,
  121. * ASYNC_SPD_SHI or ASYNC_SPD_WARP. Also, unless ASYNC_SPD_CUST is in
  122. * force, don't bother changing baud rate when custom_divisor has changed.
  123. *
  124. * (18/Feb/2003) Ian Abbott
  125. * Fixed TIOCMGET handling to include state of DTR and RTS, the state
  126. * of which are now saved by set_dtr() and set_rts().
  127. * Fixed improper storage class for buf in set_dtr() and set_rts().
  128. * Added FT232BM chip type and support for its extra baud rates (compared
  129. * to FT8U232AM).
  130. * Took account of special case divisor values for highest baud rates of
  131. * FT8U232AM and FT232BM.
  132. * For TIOCSSERIAL, forced alt_speed to 0 when ASYNC_SPD_CUST kludge used,
  133. * as previous alt_speed setting is now stale.
  134. * Moved startup code common between the startup routines for the
  135. * different chip types into a common subroutine.
  136. *
  137. * (17/Feb/2003) Bill Ryder
  138. * Added write urb buffer pool on a per device basis
  139. * Added more checking for open file on callbacks (fixed OOPS)
  140. * Added CrystalFontz 632 and 634 PIDs
  141. * (thanx to CrystalFontz for the sample devices - they flushed out
  142. * some driver bugs)
  143. * Minor debugging message changes
  144. * Added throttle, unthrottle and chars_in_buffer functions
  145. * Fixed FTDI_SIO (the original device) bug
  146. * Fixed some shutdown handling
  147. *
  148. *
  149. *
  150. *
  151. * (07/Jun/2002) Kuba Ober
  152. * Changed FTDI_SIO_BASE_BAUD_TO_DIVISOR macro into ftdi_baud_to_divisor
  153. * function. It was getting too complex.
  154. * Fix the divisor calculation logic which was setting divisor of 0.125
  155. * instead of 0.5 for fractional parts of divisor equal to 5/8, 6/8, 7/8.
  156. * Also make it bump up the divisor to next integer in case of 7/8 - it's
  157. * a better approximation.
  158. *
  159. * (25/Jul/2002) Bill Ryder inserted Dmitri's TIOCMIWAIT patch
  160. * Not tested by me but it doesn't break anything I use.
  161. *
  162. * (04/Jan/2002) Kuba Ober
  163. * Implemented 38400 baudrate kludge, where it can be substituted with other
  164. * values. That's the only way to set custom baudrates.
  165. * Implemented TIOCSSERIAL, TIOCGSERIAL ioctl's so that setserial is happy.
  166. * FIXME: both baudrate things should eventually go to usbserial.c as other
  167. * devices may need that functionality too. Actually, it can probably be
  168. * merged in serial.c somehow - too many drivers repeat this code over
  169. * and over.
  170. * Fixed baudrate forgetfulness - open() used to reset baudrate to 9600 every time.
  171. * Divisors for baudrates are calculated by a macro.
  172. * Small code cleanups. Ugly whitespace changes for Plato's sake only ;-].
  173. *
  174. * (04/Nov/2001) Bill Ryder
  175. * Fixed bug in read_bulk_callback where incorrect urb buffer was used.
  176. * Cleaned up write offset calculation
  177. * Added write_room since default values can be incorrect for sio
  178. * Changed write_bulk_callback to use same queue_task as other drivers
  179. * (the previous version caused panics)
  180. * Removed port iteration code since the device only has one I/O port and it
  181. * was wrong anyway.
  182. *
  183. * (31/May/2001) gkh
  184. * Switched from using spinlock to a semaphore, which fixes lots of problems.
  185. *
  186. * (23/May/2001) Bill Ryder
  187. * Added runtime debug patch (thanx Tyson D Sawyer).
  188. * Cleaned up comments for 8U232
  189. * Added parity, framing and overrun error handling
  190. * Added receive break handling.
  191. *
  192. * (04/08/2001) gb
  193. * Identify version on module load.
  194. *
  195. * (18/March/2001) Bill Ryder
  196. * (Not released)
  197. * Added send break handling. (requires kernel patch too)
  198. * Fixed 8U232AM hardware RTS/CTS etc status reporting.
  199. * Added flipbuf fix copied from generic device
  200. *
  201. * (12/3/2000) Bill Ryder
  202. * Added support for 8U232AM device.
  203. * Moved PID and VIDs into header file only.
  204. * Turned on low-latency for the tty (device will do high baudrates)
  205. * Added shutdown routine to close files when device removed.
  206. * More debug and error message cleanups.
  207. *
  208. * (11/13/2000) Bill Ryder
  209. * Added spinlock protected open code and close code.
  210. * Multiple opens work (sort of - see webpage mentioned above).
  211. * Cleaned up comments. Removed multiple PID/VID definitions.
  212. * Factorised cts/dtr code
  213. * Made use of __FUNCTION__ in dbg's
  214. *
  215. * (11/01/2000) Adam J. Richter
  216. * usb_device_id table support
  217. *
  218. * (10/05/2000) gkh
  219. * Fixed bug with urb->dev not being set properly, now that the usb
  220. * core needs it.
  221. *
  222. * (09/11/2000) gkh
  223. * Removed DEBUG #ifdefs with call to usb_serial_debug_data
  224. *
  225. * (07/19/2000) gkh
  226. * Added module_init and module_exit functions to handle the fact that this
  227. * driver is a loadable module now.
  228. *
  229. * (04/04/2000) Bill Ryder
  230. * Fixed bugs in TCGET/TCSET ioctls (by removing them - they are
  231. * handled elsewhere in the tty io driver chain).
  232. *
  233. * (03/30/2000) Bill Ryder
  234. * Implemented lots of ioctls
  235. * Fixed a race condition in write
  236. * Changed some dbg's to errs
  237. *
  238. * (03/26/2000) gkh
  239. * Split driver up into device specific pieces.
  240. *
  241. */
  242. /* Bill Ryder - bryder@sgi.com - wrote the FTDI_SIO implementation */
  243. /* Thanx to FTDI for so kindly providing details of the protocol required */
  244. /* to talk to the device */
  245. /* Thanx to gkh and the rest of the usb dev group for all code I have assimilated :-) */
  246. #include <linux/kernel.h>
  247. #include <linux/errno.h>
  248. #include <linux/init.h>
  249. #include <linux/slab.h>
  250. #include <linux/tty.h>
  251. #include <linux/tty_driver.h>
  252. #include <linux/tty_flip.h>
  253. #include <linux/module.h>
  254. #include <linux/spinlock.h>
  255. #include <asm/uaccess.h>
  256. #include <linux/usb.h>
  257. #include <linux/serial.h>
  258. #include <linux/usb/serial.h>
  259. #include "ftdi_sio.h"
  260. /*
  261. * Version Information
  262. */
  263. #define DRIVER_VERSION "v1.4.3"
  264. #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Bill Ryder <bryder@sgi.com>, Kuba Ober <kuba@mareimbrium.org>"
  265. #define DRIVER_DESC "USB FTDI Serial Converters Driver"
  266. static int debug;
  267. static __u16 vendor = FTDI_VID;
  268. static __u16 product;
  269. struct ftdi_private {
  270. ftdi_chip_type_t chip_type;
  271. /* type of the device, either SIO or FT8U232AM */
  272. int baud_base; /* baud base clock for divisor setting */
  273. int custom_divisor; /* custom_divisor kludge, this is for baud_base (different from what goes to the chip!) */
  274. __u16 last_set_data_urb_value ;
  275. /* the last data state set - needed for doing a break */
  276. int write_offset; /* This is the offset in the usb data block to write the serial data -
  277. * it is different between devices
  278. */
  279. int flags; /* some ASYNC_xxxx flags are supported */
  280. unsigned long last_dtr_rts; /* saved modem control outputs */
  281. wait_queue_head_t delta_msr_wait; /* Used for TIOCMIWAIT */
  282. char prev_status, diff_status; /* Used for TIOCMIWAIT */
  283. __u8 rx_flags; /* receive state flags (throttling) */
  284. spinlock_t rx_lock; /* spinlock for receive state */
  285. struct delayed_work rx_work;
  286. struct usb_serial_port *port;
  287. int rx_processed;
  288. unsigned long rx_bytes;
  289. __u16 interface; /* FT2232C port interface (0 for FT232/245) */
  290. int force_baud; /* if non-zero, force the baud rate to this value */
  291. int force_rtscts; /* if non-zero, force RTS-CTS to always be enabled */
  292. spinlock_t tx_lock; /* spinlock for transmit state */
  293. unsigned long tx_bytes;
  294. unsigned long tx_outstanding_bytes;
  295. unsigned long tx_outstanding_urbs;
  296. };
  297. /* struct ftdi_sio_quirk is used by devices requiring special attention. */
  298. struct ftdi_sio_quirk {
  299. int (*probe)(struct usb_serial *);
  300. void (*port_probe)(struct ftdi_private *); /* Special settings for probed ports. */
  301. };
  302. static int ftdi_olimex_probe (struct usb_serial *serial);
  303. static void ftdi_USB_UIRT_setup (struct ftdi_private *priv);
  304. static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv);
  305. static struct ftdi_sio_quirk ftdi_olimex_quirk = {
  306. .probe = ftdi_olimex_probe,
  307. };
  308. static struct ftdi_sio_quirk ftdi_USB_UIRT_quirk = {
  309. .port_probe = ftdi_USB_UIRT_setup,
  310. };
  311. static struct ftdi_sio_quirk ftdi_HE_TIRA1_quirk = {
  312. .port_probe = ftdi_HE_TIRA1_setup,
  313. };
  314. /*
  315. * The 8U232AM has the same API as the sio except for:
  316. * - it can support MUCH higher baudrates; up to:
  317. * o 921600 for RS232 and 2000000 for RS422/485 at 48MHz
  318. * o 230400 at 12MHz
  319. * so .. 8U232AM's baudrate setting codes are different
  320. * - it has a two byte status code.
  321. * - it returns characters every 16ms (the FTDI does it every 40ms)
  322. *
  323. * the bcdDevice value is used to differentiate FT232BM and FT245BM from
  324. * the earlier FT8U232AM and FT8U232BM. For now, include all known VID/PID
  325. * combinations in both tables.
  326. * FIXME: perhaps bcdDevice can also identify 12MHz FT8U232AM devices,
  327. * but I don't know if those ever went into mass production. [Ian Abbott]
  328. */
  329. static struct usb_device_id id_table_combined [] = {
  330. { USB_DEVICE(FTDI_VID, FTDI_AMC232_PID) },
  331. { USB_DEVICE(FTDI_VID, FTDI_CANUSB_PID) },
  332. { USB_DEVICE(FTDI_VID, FTDI_ACTZWAVE_PID) },
  333. { USB_DEVICE(FTDI_VID, FTDI_IRTRANS_PID) },
  334. { USB_DEVICE(FTDI_VID, FTDI_IPLUS_PID) },
  335. { USB_DEVICE(FTDI_VID, FTDI_IPLUS2_PID) },
  336. { USB_DEVICE(FTDI_VID, FTDI_DMX4ALL) },
  337. { USB_DEVICE(FTDI_VID, FTDI_SIO_PID) },
  338. { USB_DEVICE(FTDI_VID, FTDI_8U232AM_PID) },
  339. { USB_DEVICE(FTDI_VID, FTDI_8U232AM_ALT_PID) },
  340. { USB_DEVICE(FTDI_VID, FTDI_232RL_PID) },
  341. { USB_DEVICE(FTDI_VID, FTDI_8U2232C_PID) },
  342. { USB_DEVICE(FTDI_VID, FTDI_MICRO_CHAMELEON_PID) },
  343. { USB_DEVICE(FTDI_VID, FTDI_RELAIS_PID) },
  344. { USB_DEVICE(FTDI_VID, FTDI_OPENDCC_PID) },
  345. { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_IOBOARD_PID) },
  346. { USB_DEVICE(INTERBIOMETRICS_VID, INTERBIOMETRICS_MINI_IOBOARD_PID) },
  347. { USB_DEVICE(FTDI_VID, FTDI_XF_632_PID) },
  348. { USB_DEVICE(FTDI_VID, FTDI_XF_634_PID) },
  349. { USB_DEVICE(FTDI_VID, FTDI_XF_547_PID) },
  350. { USB_DEVICE(FTDI_VID, FTDI_XF_633_PID) },
  351. { USB_DEVICE(FTDI_VID, FTDI_XF_631_PID) },
  352. { USB_DEVICE(FTDI_VID, FTDI_XF_635_PID) },
  353. { USB_DEVICE(FTDI_VID, FTDI_XF_640_PID) },
  354. { USB_DEVICE(FTDI_VID, FTDI_XF_642_PID) },
  355. { USB_DEVICE(FTDI_VID, FTDI_DSS20_PID) },
  356. { USB_DEVICE(FTDI_NF_RIC_VID, FTDI_NF_RIC_PID) },
  357. { USB_DEVICE(FTDI_VID, FTDI_VNHCPCUSB_D_PID) },
  358. { USB_DEVICE(FTDI_VID, FTDI_MTXORB_0_PID) },
  359. { USB_DEVICE(FTDI_VID, FTDI_MTXORB_1_PID) },
  360. { USB_DEVICE(FTDI_VID, FTDI_MTXORB_2_PID) },
  361. { USB_DEVICE(FTDI_VID, FTDI_MTXORB_3_PID) },
  362. { USB_DEVICE(FTDI_VID, FTDI_MTXORB_4_PID) },
  363. { USB_DEVICE(FTDI_VID, FTDI_MTXORB_5_PID) },
  364. { USB_DEVICE(FTDI_VID, FTDI_MTXORB_6_PID) },
  365. { USB_DEVICE(FTDI_VID, FTDI_PERLE_ULTRAPORT_PID) },
  366. { USB_DEVICE(FTDI_VID, FTDI_PIEGROUP_PID) },
  367. { USB_DEVICE(FTDI_VID, FTDI_TNC_X_PID) },
  368. { USB_DEVICE(FTDI_VID, FTDI_USBX_707_PID) },
  369. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2101_PID) },
  370. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2102_PID) },
  371. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2103_PID) },
  372. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2104_PID) },
  373. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2106_PID) },
  374. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_1_PID) },
  375. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2201_2_PID) },
  376. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_1_PID) },
  377. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2202_2_PID) },
  378. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_1_PID) },
  379. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2203_2_PID) },
  380. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_1_PID) },
  381. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_2_PID) },
  382. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_3_PID) },
  383. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2401_4_PID) },
  384. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_1_PID) },
  385. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_2_PID) },
  386. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_3_PID) },
  387. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2402_4_PID) },
  388. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_1_PID) },
  389. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_2_PID) },
  390. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_3_PID) },
  391. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2403_4_PID) },
  392. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_1_PID) },
  393. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_2_PID) },
  394. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_3_PID) },
  395. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_4_PID) },
  396. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_5_PID) },
  397. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_6_PID) },
  398. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_7_PID) },
  399. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2801_8_PID) },
  400. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_1_PID) },
  401. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_2_PID) },
  402. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_3_PID) },
  403. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_4_PID) },
  404. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_5_PID) },
  405. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_6_PID) },
  406. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_7_PID) },
  407. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2802_8_PID) },
  408. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_1_PID) },
  409. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_2_PID) },
  410. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_3_PID) },
  411. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_4_PID) },
  412. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_5_PID) },
  413. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_6_PID) },
  414. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_7_PID) },
  415. { USB_DEVICE(SEALEVEL_VID, SEALEVEL_2803_8_PID) },
  416. { USB_DEVICE(IDTECH_VID, IDTECH_IDT1221U_PID) },
  417. { USB_DEVICE(OCT_VID, OCT_US101_PID) },
  418. { USB_DEVICE(FTDI_VID, FTDI_HE_TIRA1_PID),
  419. .driver_info = (kernel_ulong_t)&ftdi_HE_TIRA1_quirk },
  420. { USB_DEVICE(FTDI_VID, FTDI_USB_UIRT_PID),
  421. .driver_info = (kernel_ulong_t)&ftdi_USB_UIRT_quirk },
  422. { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_1) },
  423. { USB_DEVICE(FTDI_VID, PROTEGO_R2X0) },
  424. { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_3) },
  425. { USB_DEVICE(FTDI_VID, PROTEGO_SPECIAL_4) },
  426. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E808_PID) },
  427. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E809_PID) },
  428. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80A_PID) },
  429. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80B_PID) },
  430. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80C_PID) },
  431. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80D_PID) },
  432. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80E_PID) },
  433. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E80F_PID) },
  434. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E888_PID) },
  435. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E889_PID) },
  436. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88A_PID) },
  437. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88B_PID) },
  438. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88C_PID) },
  439. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88D_PID) },
  440. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88E_PID) },
  441. { USB_DEVICE(FTDI_VID, FTDI_GUDEADS_E88F_PID) },
  442. { USB_DEVICE(FTDI_VID, FTDI_ELV_UO100_PID) },
  443. { USB_DEVICE(FTDI_VID, FTDI_ELV_UM100_PID) },
  444. { USB_DEVICE(FTDI_VID, FTDI_ELV_UR100_PID) },
  445. { USB_DEVICE(FTDI_VID, FTDI_ELV_ALC8500_PID) },
  446. { USB_DEVICE(FTDI_VID, FTDI_PYRAMID_PID) },
  447. { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1000PC_PID) },
  448. { USB_DEVICE(FTDI_VID, FTDI_IBS_US485_PID) },
  449. { USB_DEVICE(FTDI_VID, FTDI_IBS_PICPRO_PID) },
  450. { USB_DEVICE(FTDI_VID, FTDI_IBS_PCMCIA_PID) },
  451. { USB_DEVICE(FTDI_VID, FTDI_IBS_PK1_PID) },
  452. { USB_DEVICE(FTDI_VID, FTDI_IBS_RS232MON_PID) },
  453. { USB_DEVICE(FTDI_VID, FTDI_IBS_APP70_PID) },
  454. { USB_DEVICE(FTDI_VID, FTDI_IBS_PEDO_PID) },
  455. { USB_DEVICE(FTDI_VID, FTDI_IBS_PROD_PID) },
  456. /*
  457. * These will probably use user-space drivers. Uncomment them if
  458. * you need them or use the user-specified vendor/product module
  459. * parameters (see ftdi_sio.h for the numbers). Make a fuss if
  460. * you think the driver should recognize any of them by default.
  461. */
  462. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CLI7000_PID) }, */
  463. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PPS7330_PID) }, */
  464. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_TFM100_PID) }, */
  465. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDF77_PID) }, */
  466. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UIO88_PID) }, */
  467. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UAD8_PID) }, */
  468. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_UDA7_PID) }, */
  469. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_USI2_PID) }, */
  470. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_T1100_PID) }, */
  471. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCD200_PID) }, */
  472. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_ULA200_PID) }, */
  473. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_CSI8_PID) }, */
  474. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_EM1000DL_PID) }, */
  475. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_PCK100_PID) }, */
  476. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_RFP500_PID) }, */
  477. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FS20SIG_PID) }, */
  478. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS300PC_PID) }, */
  479. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_FHZ1300PC_PID) }, */
  480. /* { USB_DEVICE(FTDI_VID, FTDI_ELV_WS500_PID) }, */
  481. { USB_DEVICE(FTDI_VID, LINX_SDMUSBQSS_PID) },
  482. { USB_DEVICE(FTDI_VID, LINX_MASTERDEVEL2_PID) },
  483. { USB_DEVICE(FTDI_VID, LINX_FUTURE_0_PID) },
  484. { USB_DEVICE(FTDI_VID, LINX_FUTURE_1_PID) },
  485. { USB_DEVICE(FTDI_VID, LINX_FUTURE_2_PID) },
  486. { USB_DEVICE(FTDI_VID, FTDI_CCSICDU20_0_PID) },
  487. { USB_DEVICE(FTDI_VID, FTDI_CCSICDU40_1_PID) },
  488. { USB_DEVICE(FTDI_VID, FTDI_CCSMACHX_2_PID) },
  489. { USB_DEVICE(FTDI_VID, INSIDE_ACCESSO) },
  490. { USB_DEVICE(INTREPID_VID, INTREPID_VALUECAN_PID) },
  491. { USB_DEVICE(INTREPID_VID, INTREPID_NEOVI_PID) },
  492. { USB_DEVICE(FALCOM_VID, FALCOM_TWIST_PID) },
  493. { USB_DEVICE(FALCOM_VID, FALCOM_SAMBA_PID) },
  494. { USB_DEVICE(FTDI_VID, FTDI_SUUNTO_SPORTS_PID) },
  495. { USB_DEVICE(TTI_VID, TTI_QL355P_PID) },
  496. { USB_DEVICE(FTDI_VID, FTDI_RM_CANVIEW_PID) },
  497. { USB_DEVICE(BANDB_VID, BANDB_USOTL4_PID) },
  498. { USB_DEVICE(BANDB_VID, BANDB_USTL4_PID) },
  499. { USB_DEVICE(BANDB_VID, BANDB_USO9ML2_PID) },
  500. { USB_DEVICE(FTDI_VID, EVER_ECO_PRO_CDS) },
  501. { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_1_PID) },
  502. { USB_DEVICE(FTDI_VID, FTDI_4N_GALAXY_DE_2_PID) },
  503. { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_0_PID) },
  504. { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_1_PID) },
  505. { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_2_PID) },
  506. { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_3_PID) },
  507. { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_4_PID) },
  508. { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_5_PID) },
  509. { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_6_PID) },
  510. { USB_DEVICE(FTDI_VID, XSENS_CONVERTER_7_PID) },
  511. { USB_DEVICE(MOBILITY_VID, MOBILITY_USB_SERIAL_PID) },
  512. { USB_DEVICE(FTDI_VID, FTDI_ACTIVE_ROBOTS_PID) },
  513. { USB_DEVICE(FTDI_VID, FTDI_MHAM_KW_PID) },
  514. { USB_DEVICE(FTDI_VID, FTDI_MHAM_YS_PID) },
  515. { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y6_PID) },
  516. { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y8_PID) },
  517. { USB_DEVICE(FTDI_VID, FTDI_MHAM_IC_PID) },
  518. { USB_DEVICE(FTDI_VID, FTDI_MHAM_DB9_PID) },
  519. { USB_DEVICE(FTDI_VID, FTDI_MHAM_RS232_PID) },
  520. { USB_DEVICE(FTDI_VID, FTDI_MHAM_Y9_PID) },
  521. { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_VCP_PID) },
  522. { USB_DEVICE(FTDI_VID, FTDI_TERATRONIK_D2XX_PID) },
  523. { USB_DEVICE(EVOLUTION_VID, EVOLUTION_ER1_PID) },
  524. { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
  525. { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
  526. { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
  527. { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
  528. { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
  529. { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
  530. { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
  531. { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
  532. { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
  533. { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
  534. { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
  535. { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
  536. { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
  537. { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
  538. { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
  539. { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
  540. { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
  541. { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
  542. { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
  543. { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
  544. { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
  545. { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
  546. { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
  547. { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
  548. { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
  549. { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
  550. { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
  551. { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
  552. { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
  553. .driver_info = (kernel_ulong_t)&ftdi_olimex_quirk },
  554. { }, /* Optional parameter entry */
  555. { } /* Terminating entry */
  556. };
  557. MODULE_DEVICE_TABLE (usb, id_table_combined);
  558. static struct usb_driver ftdi_driver = {
  559. .name = "ftdi_sio",
  560. .probe = usb_serial_probe,
  561. .disconnect = usb_serial_disconnect,
  562. .id_table = id_table_combined,
  563. .no_dynamic_id = 1,
  564. };
  565. static const char *ftdi_chip_name[] = {
  566. [SIO] = "SIO", /* the serial part of FT8U100AX */
  567. [FT8U232AM] = "FT8U232AM",
  568. [FT232BM] = "FT232BM",
  569. [FT2232C] = "FT2232C",
  570. [FT232RL] = "FT232RL",
  571. };
  572. /* Constants for read urb and write urb */
  573. #define BUFSZ 512
  574. #define PKTSZ 64
  575. /* rx_flags */
  576. #define THROTTLED 0x01
  577. #define ACTUALLY_THROTTLED 0x02
  578. /* Used for TIOCMIWAIT */
  579. #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
  580. #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
  581. /* End TIOCMIWAIT */
  582. #define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
  583. ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
  584. /* function prototypes for a FTDI serial converter */
  585. static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
  586. static void ftdi_shutdown (struct usb_serial *serial);
  587. static int ftdi_sio_port_probe (struct usb_serial_port *port);
  588. static int ftdi_sio_port_remove (struct usb_serial_port *port);
  589. static int ftdi_open (struct usb_serial_port *port, struct file *filp);
  590. static void ftdi_close (struct usb_serial_port *port, struct file *filp);
  591. static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
  592. static int ftdi_write_room (struct usb_serial_port *port);
  593. static int ftdi_chars_in_buffer (struct usb_serial_port *port);
  594. static void ftdi_write_bulk_callback (struct urb *urb);
  595. static void ftdi_read_bulk_callback (struct urb *urb);
  596. static void ftdi_process_read (struct work_struct *work);
  597. static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios * old);
  598. static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
  599. static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
  600. static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
  601. static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
  602. static void ftdi_throttle (struct usb_serial_port *port);
  603. static void ftdi_unthrottle (struct usb_serial_port *port);
  604. static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
  605. static unsigned short int ftdi_232am_baud_to_divisor (int baud);
  606. static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
  607. static __u32 ftdi_232bm_baud_to_divisor (int baud);
  608. static struct usb_serial_driver ftdi_sio_device = {
  609. .driver = {
  610. .owner = THIS_MODULE,
  611. .name = "ftdi_sio",
  612. },
  613. .description = "FTDI USB Serial Device",
  614. .usb_driver = &ftdi_driver ,
  615. .id_table = id_table_combined,
  616. .num_interrupt_in = 0,
  617. .num_bulk_in = 1,
  618. .num_bulk_out = 1,
  619. .num_ports = 1,
  620. .probe = ftdi_sio_probe,
  621. .port_probe = ftdi_sio_port_probe,
  622. .port_remove = ftdi_sio_port_remove,
  623. .open = ftdi_open,
  624. .close = ftdi_close,
  625. .throttle = ftdi_throttle,
  626. .unthrottle = ftdi_unthrottle,
  627. .write = ftdi_write,
  628. .write_room = ftdi_write_room,
  629. .chars_in_buffer = ftdi_chars_in_buffer,
  630. .read_bulk_callback = ftdi_read_bulk_callback,
  631. .write_bulk_callback = ftdi_write_bulk_callback,
  632. .tiocmget = ftdi_tiocmget,
  633. .tiocmset = ftdi_tiocmset,
  634. .ioctl = ftdi_ioctl,
  635. .set_termios = ftdi_set_termios,
  636. .break_ctl = ftdi_break_ctl,
  637. .shutdown = ftdi_shutdown,
  638. };
  639. #define WDR_TIMEOUT 5000 /* default urb timeout */
  640. #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
  641. /* High and low are for DTR, RTS etc etc */
  642. #define HIGH 1
  643. #define LOW 0
  644. /* number of outstanding urbs to prevent userspace DoS from happening */
  645. #define URB_UPPER_LIMIT 42
  646. /*
  647. * ***************************************************************************
  648. * Utility functions
  649. * ***************************************************************************
  650. */
  651. static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
  652. {
  653. unsigned short int divisor;
  654. int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
  655. if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
  656. divisor = divisor3 >> 3;
  657. divisor3 &= 0x7;
  658. if (divisor3 == 1) divisor |= 0xc000; else // 0.125
  659. if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
  660. if (divisor3 != 0) divisor |= 0x8000; // 0.25
  661. if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
  662. return divisor;
  663. }
  664. static unsigned short int ftdi_232am_baud_to_divisor(int baud)
  665. {
  666. return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
  667. }
  668. static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
  669. {
  670. static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
  671. __u32 divisor;
  672. int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
  673. divisor = divisor3 >> 3;
  674. divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
  675. /* Deal with special cases for highest baud rates. */
  676. if (divisor == 1) divisor = 0; else // 1.0
  677. if (divisor == 0x4001) divisor = 1; // 1.5
  678. return divisor;
  679. }
  680. static __u32 ftdi_232bm_baud_to_divisor(int baud)
  681. {
  682. return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
  683. }
  684. #define set_mctrl(port, set) update_mctrl((port), (set), 0)
  685. #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
  686. static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
  687. {
  688. struct ftdi_private *priv = usb_get_serial_port_data(port);
  689. char *buf;
  690. unsigned urb_value;
  691. int rv;
  692. if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
  693. dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
  694. return 0; /* no change */
  695. }
  696. buf = kmalloc(1, GFP_NOIO);
  697. if (!buf) {
  698. return -ENOMEM;
  699. }
  700. clear &= ~set; /* 'set' takes precedence over 'clear' */
  701. urb_value = 0;
  702. if (clear & TIOCM_DTR)
  703. urb_value |= FTDI_SIO_SET_DTR_LOW;
  704. if (clear & TIOCM_RTS)
  705. urb_value |= FTDI_SIO_SET_RTS_LOW;
  706. if (set & TIOCM_DTR)
  707. urb_value |= FTDI_SIO_SET_DTR_HIGH;
  708. if (set & TIOCM_RTS)
  709. urb_value |= FTDI_SIO_SET_RTS_HIGH;
  710. rv = usb_control_msg(port->serial->dev,
  711. usb_sndctrlpipe(port->serial->dev, 0),
  712. FTDI_SIO_SET_MODEM_CTRL_REQUEST,
  713. FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
  714. urb_value, priv->interface,
  715. buf, 0, WDR_TIMEOUT);
  716. kfree(buf);
  717. if (rv < 0) {
  718. err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
  719. __FUNCTION__,
  720. (set & TIOCM_DTR) ? "HIGH" :
  721. (clear & TIOCM_DTR) ? "LOW" : "unchanged",
  722. (set & TIOCM_RTS) ? "HIGH" :
  723. (clear & TIOCM_RTS) ? "LOW" : "unchanged");
  724. } else {
  725. dbg("%s - DTR %s, RTS %s", __FUNCTION__,
  726. (set & TIOCM_DTR) ? "HIGH" :
  727. (clear & TIOCM_DTR) ? "LOW" : "unchanged",
  728. (set & TIOCM_RTS) ? "HIGH" :
  729. (clear & TIOCM_RTS) ? "LOW" : "unchanged");
  730. priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
  731. }
  732. return rv;
  733. }
  734. static __u32 get_ftdi_divisor(struct usb_serial_port * port);
  735. static int change_speed(struct usb_serial_port *port)
  736. {
  737. struct ftdi_private *priv = usb_get_serial_port_data(port);
  738. char *buf;
  739. __u16 urb_value;
  740. __u16 urb_index;
  741. __u32 urb_index_value;
  742. int rv;
  743. buf = kmalloc(1, GFP_NOIO);
  744. if (!buf)
  745. return -ENOMEM;
  746. urb_index_value = get_ftdi_divisor(port);
  747. urb_value = (__u16)urb_index_value;
  748. urb_index = (__u16)(urb_index_value >> 16);
  749. if (priv->interface) { /* FT2232C */
  750. urb_index = (__u16)((urb_index << 8) | priv->interface);
  751. }
  752. rv = usb_control_msg(port->serial->dev,
  753. usb_sndctrlpipe(port->serial->dev, 0),
  754. FTDI_SIO_SET_BAUDRATE_REQUEST,
  755. FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
  756. urb_value, urb_index,
  757. buf, 0, WDR_SHORT_TIMEOUT);
  758. kfree(buf);
  759. return rv;
  760. }
  761. static __u32 get_ftdi_divisor(struct usb_serial_port * port)
  762. { /* get_ftdi_divisor */
  763. struct ftdi_private *priv = usb_get_serial_port_data(port);
  764. __u32 div_value = 0;
  765. int div_okay = 1;
  766. int baud;
  767. /*
  768. * The logic involved in setting the baudrate can be cleanly split in 3 steps.
  769. * Obtaining the actual baud rate is a little tricky since unix traditionally
  770. * somehow ignored the possibility to set non-standard baud rates.
  771. * 1. Standard baud rates are set in tty->termios->c_cflag
  772. * 2. If these are not enough, you can set any speed using alt_speed as follows:
  773. * - set tty->termios->c_cflag speed to B38400
  774. * - set your real speed in tty->alt_speed; it gets ignored when
  775. * alt_speed==0, (or)
  776. * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
  777. * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
  778. * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
  779. * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
  780. * 3. You can also set baud rate by setting custom divisor as follows
  781. * - set tty->termios->c_cflag speed to B38400
  782. * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
  783. * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
  784. * o custom_divisor set to baud_base / your_new_baudrate
  785. * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
  786. * spend some time and separate+move this common code to serial.c, it is
  787. * replicated in nearly every serial driver you see.
  788. */
  789. /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
  790. baud = tty_get_baud_rate(port->tty);
  791. dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
  792. /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
  793. if (baud == 38400 &&
  794. ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
  795. (priv->custom_divisor)) {
  796. baud = priv->baud_base / priv->custom_divisor;
  797. dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
  798. }
  799. /* 3. Convert baudrate to device-specific divisor */
  800. if (!baud) baud = 9600;
  801. switch(priv->chip_type) {
  802. case SIO: /* SIO chip */
  803. switch(baud) {
  804. case 300: div_value = ftdi_sio_b300; break;
  805. case 600: div_value = ftdi_sio_b600; break;
  806. case 1200: div_value = ftdi_sio_b1200; break;
  807. case 2400: div_value = ftdi_sio_b2400; break;
  808. case 4800: div_value = ftdi_sio_b4800; break;
  809. case 9600: div_value = ftdi_sio_b9600; break;
  810. case 19200: div_value = ftdi_sio_b19200; break;
  811. case 38400: div_value = ftdi_sio_b38400; break;
  812. case 57600: div_value = ftdi_sio_b57600; break;
  813. case 115200: div_value = ftdi_sio_b115200; break;
  814. } /* baud */
  815. if (div_value == 0) {
  816. dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
  817. div_value = ftdi_sio_b9600;
  818. div_okay = 0;
  819. }
  820. break;
  821. case FT8U232AM: /* 8U232AM chip */
  822. if (baud <= 3000000) {
  823. div_value = ftdi_232am_baud_to_divisor(baud);
  824. } else {
  825. dbg("%s - Baud rate too high!", __FUNCTION__);
  826. div_value = ftdi_232am_baud_to_divisor(9600);
  827. div_okay = 0;
  828. }
  829. break;
  830. case FT232BM: /* FT232BM chip */
  831. case FT2232C: /* FT2232C chip */
  832. case FT232RL:
  833. if (baud <= 3000000) {
  834. div_value = ftdi_232bm_baud_to_divisor(baud);
  835. } else {
  836. dbg("%s - Baud rate too high!", __FUNCTION__);
  837. div_value = ftdi_232bm_baud_to_divisor(9600);
  838. div_okay = 0;
  839. }
  840. break;
  841. } /* priv->chip_type */
  842. if (div_okay) {
  843. dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
  844. __FUNCTION__, baud, (unsigned long)div_value,
  845. ftdi_chip_name[priv->chip_type]);
  846. }
  847. return(div_value);
  848. }
  849. static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
  850. {
  851. struct ftdi_private *priv = usb_get_serial_port_data(port);
  852. struct serial_struct tmp;
  853. if (!retinfo)
  854. return -EFAULT;
  855. memset(&tmp, 0, sizeof(tmp));
  856. tmp.flags = priv->flags;
  857. tmp.baud_base = priv->baud_base;
  858. tmp.custom_divisor = priv->custom_divisor;
  859. if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
  860. return -EFAULT;
  861. return 0;
  862. } /* get_serial_info */
  863. static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
  864. { /* set_serial_info */
  865. struct ftdi_private *priv = usb_get_serial_port_data(port);
  866. struct serial_struct new_serial;
  867. struct ftdi_private old_priv;
  868. if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
  869. return -EFAULT;
  870. old_priv = * priv;
  871. /* Do error checking and permission checking */
  872. if (!capable(CAP_SYS_ADMIN)) {
  873. if (((new_serial.flags & ~ASYNC_USR_MASK) !=
  874. (priv->flags & ~ASYNC_USR_MASK)))
  875. return -EPERM;
  876. priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
  877. (new_serial.flags & ASYNC_USR_MASK));
  878. priv->custom_divisor = new_serial.custom_divisor;
  879. goto check_and_exit;
  880. }
  881. if ((new_serial.baud_base != priv->baud_base) &&
  882. (new_serial.baud_base < 9600))
  883. return -EINVAL;
  884. /* Make the changes - these are privileged changes! */
  885. priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
  886. (new_serial.flags & ASYNC_FLAGS));
  887. priv->custom_divisor = new_serial.custom_divisor;
  888. port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
  889. check_and_exit:
  890. if ((old_priv.flags & ASYNC_SPD_MASK) !=
  891. (priv->flags & ASYNC_SPD_MASK)) {
  892. if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
  893. port->tty->alt_speed = 57600;
  894. else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
  895. port->tty->alt_speed = 115200;
  896. else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
  897. port->tty->alt_speed = 230400;
  898. else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
  899. port->tty->alt_speed = 460800;
  900. else
  901. port->tty->alt_speed = 0;
  902. }
  903. if (((old_priv.flags & ASYNC_SPD_MASK) !=
  904. (priv->flags & ASYNC_SPD_MASK)) ||
  905. (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
  906. (old_priv.custom_divisor != priv->custom_divisor))) {
  907. change_speed(port);
  908. }
  909. return (0);
  910. } /* set_serial_info */
  911. /* Determine type of FTDI chip based on USB config and descriptor. */
  912. static void ftdi_determine_type(struct usb_serial_port *port)
  913. {
  914. struct ftdi_private *priv = usb_get_serial_port_data(port);
  915. struct usb_serial *serial = port->serial;
  916. struct usb_device *udev = serial->dev;
  917. unsigned version;
  918. unsigned interfaces;
  919. /* Assume it is not the original SIO device for now. */
  920. priv->baud_base = 48000000 / 2;
  921. priv->write_offset = 0;
  922. version = le16_to_cpu(udev->descriptor.bcdDevice);
  923. interfaces = udev->actconfig->desc.bNumInterfaces;
  924. dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
  925. version, interfaces);
  926. if (interfaces > 1) {
  927. int inter;
  928. /* Multiple interfaces. Assume FT2232C. */
  929. priv->chip_type = FT2232C;
  930. /* Determine interface code. */
  931. inter = serial->interface->altsetting->desc.bInterfaceNumber;
  932. if (inter == 0) {
  933. priv->interface = PIT_SIOA;
  934. } else {
  935. priv->interface = PIT_SIOB;
  936. }
  937. /* BM-type devices have a bug where bcdDevice gets set
  938. * to 0x200 when iSerialNumber is 0. */
  939. if (version < 0x500) {
  940. dbg("%s: something fishy - bcdDevice too low for multi-interface device",
  941. __FUNCTION__);
  942. }
  943. } else if (version < 0x200) {
  944. /* Old device. Assume its the original SIO. */
  945. priv->chip_type = SIO;
  946. priv->baud_base = 12000000 / 16;
  947. priv->write_offset = 1;
  948. } else if (version < 0x400) {
  949. /* Assume its an FT8U232AM (or FT8U245AM) */
  950. /* (It might be a BM because of the iSerialNumber bug,
  951. * but it will still work as an AM device.) */
  952. priv->chip_type = FT8U232AM;
  953. } else if (version < 0x600) {
  954. /* Assume its an FT232BM (or FT245BM) */
  955. priv->chip_type = FT232BM;
  956. } else {
  957. /* Assume its an FT232R */
  958. priv->chip_type = FT232RL;
  959. }
  960. info("Detected %s", ftdi_chip_name[priv->chip_type]);
  961. }
  962. /*
  963. * ***************************************************************************
  964. * Sysfs Attribute
  965. * ***************************************************************************
  966. */
  967. static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
  968. {
  969. struct usb_serial_port *port = to_usb_serial_port(dev);
  970. struct ftdi_private *priv = usb_get_serial_port_data(port);
  971. struct usb_device *udev = port->serial->dev;
  972. unsigned short latency = 0;
  973. int rv = 0;
  974. dbg("%s",__FUNCTION__);
  975. rv = usb_control_msg(udev,
  976. usb_rcvctrlpipe(udev, 0),
  977. FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
  978. FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
  979. 0, priv->interface,
  980. (char*) &latency, 1, WDR_TIMEOUT);
  981. if (rv < 0) {
  982. dev_err(dev, "Unable to read latency timer: %i", rv);
  983. return -EIO;
  984. }
  985. return sprintf(buf, "%i\n", latency);
  986. }
  987. /* Write a new value of the latency timer, in units of milliseconds. */
  988. static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
  989. size_t count)
  990. {
  991. struct usb_serial_port *port = to_usb_serial_port(dev);
  992. struct ftdi_private *priv = usb_get_serial_port_data(port);
  993. struct usb_device *udev = port->serial->dev;
  994. char buf[1];
  995. int v = simple_strtoul(valbuf, NULL, 10);
  996. int rv = 0;
  997. dbg("%s: setting latency timer = %i", __FUNCTION__, v);
  998. rv = usb_control_msg(udev,
  999. usb_sndctrlpipe(udev, 0),
  1000. FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
  1001. FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
  1002. v, priv->interface,
  1003. buf, 0, WDR_TIMEOUT);
  1004. if (rv < 0) {
  1005. dev_err(dev, "Unable to write latency timer: %i", rv);
  1006. return -EIO;
  1007. }
  1008. return count;
  1009. }
  1010. /* Write an event character directly to the FTDI register. The ASCII
  1011. value is in the low 8 bits, with the enable bit in the 9th bit. */
  1012. static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
  1013. size_t count)
  1014. {
  1015. struct usb_serial_port *port = to_usb_serial_port(dev);
  1016. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1017. struct usb_device *udev = port->serial->dev;
  1018. char buf[1];
  1019. int v = simple_strtoul(valbuf, NULL, 10);
  1020. int rv = 0;
  1021. dbg("%s: setting event char = %i", __FUNCTION__, v);
  1022. rv = usb_control_msg(udev,
  1023. usb_sndctrlpipe(udev, 0),
  1024. FTDI_SIO_SET_EVENT_CHAR_REQUEST,
  1025. FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
  1026. v, priv->interface,
  1027. buf, 0, WDR_TIMEOUT);
  1028. if (rv < 0) {
  1029. dbg("Unable to write event character: %i", rv);
  1030. return -EIO;
  1031. }
  1032. return count;
  1033. }
  1034. static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
  1035. static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
  1036. static int create_sysfs_attrs(struct usb_serial_port *port)
  1037. {
  1038. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1039. int retval = 0;
  1040. dbg("%s",__FUNCTION__);
  1041. /* XXX I've no idea if the original SIO supports the event_char
  1042. * sysfs parameter, so I'm playing it safe. */
  1043. if (priv->chip_type != SIO) {
  1044. dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
  1045. retval = device_create_file(&port->dev, &dev_attr_event_char);
  1046. if ((!retval) &&
  1047. (priv->chip_type == FT232BM ||
  1048. priv->chip_type == FT2232C ||
  1049. priv->chip_type == FT232RL)) {
  1050. retval = device_create_file(&port->dev,
  1051. &dev_attr_latency_timer);
  1052. }
  1053. }
  1054. return retval;
  1055. }
  1056. static void remove_sysfs_attrs(struct usb_serial_port *port)
  1057. {
  1058. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1059. dbg("%s",__FUNCTION__);
  1060. /* XXX see create_sysfs_attrs */
  1061. if (priv->chip_type != SIO) {
  1062. device_remove_file(&port->dev, &dev_attr_event_char);
  1063. if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
  1064. device_remove_file(&port->dev, &dev_attr_latency_timer);
  1065. }
  1066. }
  1067. }
  1068. /*
  1069. * ***************************************************************************
  1070. * FTDI driver specific functions
  1071. * ***************************************************************************
  1072. */
  1073. /* Probe function to check for special devices */
  1074. static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
  1075. {
  1076. struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
  1077. if (quirk && quirk->probe) {
  1078. int ret = quirk->probe(serial);
  1079. if (ret != 0)
  1080. return ret;
  1081. }
  1082. usb_set_serial_data(serial, (void *)id->driver_info);
  1083. return 0;
  1084. }
  1085. static int ftdi_sio_port_probe(struct usb_serial_port *port)
  1086. {
  1087. struct ftdi_private *priv;
  1088. struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
  1089. dbg("%s",__FUNCTION__);
  1090. priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
  1091. if (!priv){
  1092. err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
  1093. return -ENOMEM;
  1094. }
  1095. spin_lock_init(&priv->rx_lock);
  1096. spin_lock_init(&priv->tx_lock);
  1097. init_waitqueue_head(&priv->delta_msr_wait);
  1098. /* This will push the characters through immediately rather
  1099. than queue a task to deliver them */
  1100. priv->flags = ASYNC_LOW_LATENCY;
  1101. if (quirk && quirk->port_probe)
  1102. quirk->port_probe(priv);
  1103. /* Increase the size of read buffers */
  1104. kfree(port->bulk_in_buffer);
  1105. port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
  1106. if (!port->bulk_in_buffer) {
  1107. kfree (priv);
  1108. return -ENOMEM;
  1109. }
  1110. if (port->read_urb) {
  1111. port->read_urb->transfer_buffer = port->bulk_in_buffer;
  1112. port->read_urb->transfer_buffer_length = BUFSZ;
  1113. }
  1114. INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
  1115. priv->port = port;
  1116. /* Free port's existing write urb and transfer buffer. */
  1117. if (port->write_urb) {
  1118. usb_free_urb (port->write_urb);
  1119. port->write_urb = NULL;
  1120. }
  1121. kfree(port->bulk_out_buffer);
  1122. port->bulk_out_buffer = NULL;
  1123. usb_set_serial_port_data(port, priv);
  1124. ftdi_determine_type (port);
  1125. create_sysfs_attrs(port);
  1126. return 0;
  1127. }
  1128. /* Setup for the USB-UIRT device, which requires hardwired
  1129. * baudrate (38400 gets mapped to 312500) */
  1130. /* Called from usbserial:serial_probe */
  1131. static void ftdi_USB_UIRT_setup (struct ftdi_private *priv)
  1132. {
  1133. dbg("%s",__FUNCTION__);
  1134. priv->flags |= ASYNC_SPD_CUST;
  1135. priv->custom_divisor = 77;
  1136. priv->force_baud = B38400;
  1137. } /* ftdi_USB_UIRT_setup */
  1138. /* Setup for the HE-TIRA1 device, which requires hardwired
  1139. * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
  1140. static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv)
  1141. {
  1142. dbg("%s",__FUNCTION__);
  1143. priv->flags |= ASYNC_SPD_CUST;
  1144. priv->custom_divisor = 240;
  1145. priv->force_baud = B38400;
  1146. priv->force_rtscts = 1;
  1147. } /* ftdi_HE_TIRA1_setup */
  1148. /*
  1149. * First port on Olimex arm-usb-ocd is reserved for JTAG interface
  1150. * and can be accessed from userspace using openocd.
  1151. */
  1152. static int ftdi_olimex_probe(struct usb_serial *serial)
  1153. {
  1154. struct usb_device *udev = serial->dev;
  1155. struct usb_interface *interface = serial->interface;
  1156. dbg("%s",__FUNCTION__);
  1157. if (interface == udev->actconfig->interface[0]) {
  1158. info("Ignoring reserved serial port on Olimex arm-usb-ocd\n");
  1159. return -ENODEV;
  1160. }
  1161. return 0;
  1162. }
  1163. /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
  1164. * it is called when the usb device is disconnected
  1165. *
  1166. * usbserial:usb_serial_disconnect
  1167. * calls __serial_close for each open of the port
  1168. * shutdown is called then (ie ftdi_shutdown)
  1169. */
  1170. static void ftdi_shutdown (struct usb_serial *serial)
  1171. {
  1172. dbg("%s", __FUNCTION__);
  1173. }
  1174. static int ftdi_sio_port_remove(struct usb_serial_port *port)
  1175. {
  1176. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1177. dbg("%s", __FUNCTION__);
  1178. remove_sysfs_attrs(port);
  1179. /* all open ports are closed at this point
  1180. * (by usbserial.c:__serial_close, which calls ftdi_close)
  1181. */
  1182. if (priv) {
  1183. usb_set_serial_port_data(port, NULL);
  1184. kfree(priv);
  1185. }
  1186. return 0;
  1187. }
  1188. static int ftdi_open (struct usb_serial_port *port, struct file *filp)
  1189. { /* ftdi_open */
  1190. struct usb_device *dev = port->serial->dev;
  1191. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1192. unsigned long flags;
  1193. int result = 0;
  1194. char buf[1]; /* Needed for the usb_control_msg I think */
  1195. dbg("%s", __FUNCTION__);
  1196. spin_lock_irqsave(&priv->tx_lock, flags);
  1197. priv->tx_bytes = 0;
  1198. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1199. spin_lock_irqsave(&priv->rx_lock, flags);
  1200. priv->rx_bytes = 0;
  1201. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1202. if (port->tty)
  1203. port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
  1204. /* No error checking for this (will get errors later anyway) */
  1205. /* See ftdi_sio.h for description of what is reset */
  1206. usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  1207. FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
  1208. FTDI_SIO_RESET_SIO,
  1209. priv->interface, buf, 0, WDR_TIMEOUT);
  1210. /* Termios defaults are set by usb_serial_init. We don't change
  1211. port->tty->termios - this would loose speed settings, etc.
  1212. This is same behaviour as serial.c/rs_open() - Kuba */
  1213. /* ftdi_set_termios will send usb control messages */
  1214. if (port->tty)
  1215. ftdi_set_termios(port, NULL);
  1216. /* FIXME: Flow control might be enabled, so it should be checked -
  1217. we have no control of defaults! */
  1218. /* Turn on RTS and DTR since we are not flow controlling by default */
  1219. set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
  1220. /* Not throttled */
  1221. spin_lock_irqsave(&priv->rx_lock, flags);
  1222. priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
  1223. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1224. /* Start reading from the device */
  1225. priv->rx_processed = 0;
  1226. usb_fill_bulk_urb(port->read_urb, dev,
  1227. usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
  1228. port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
  1229. ftdi_read_bulk_callback, port);
  1230. result = usb_submit_urb(port->read_urb, GFP_KERNEL);
  1231. if (result)
  1232. err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
  1233. return result;
  1234. } /* ftdi_open */
  1235. /*
  1236. * usbserial:__serial_close only calls ftdi_close if the point is open
  1237. *
  1238. * This only gets called when it is the last close
  1239. *
  1240. *
  1241. */
  1242. static void ftdi_close (struct usb_serial_port *port, struct file *filp)
  1243. { /* ftdi_close */
  1244. unsigned int c_cflag = port->tty->termios->c_cflag;
  1245. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1246. char buf[1];
  1247. dbg("%s", __FUNCTION__);
  1248. if (c_cflag & HUPCL){
  1249. /* Disable flow control */
  1250. if (usb_control_msg(port->serial->dev,
  1251. usb_sndctrlpipe(port->serial->dev, 0),
  1252. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1253. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1254. 0, priv->interface, buf, 0,
  1255. WDR_TIMEOUT) < 0) {
  1256. err("error from flowcontrol urb");
  1257. }
  1258. /* drop RTS and DTR */
  1259. clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
  1260. } /* Note change no line if hupcl is off */
  1261. /* cancel any scheduled reading */
  1262. cancel_delayed_work(&priv->rx_work);
  1263. flush_scheduled_work();
  1264. /* shutdown our bulk read */
  1265. usb_kill_urb(port->read_urb);
  1266. } /* ftdi_close */
  1267. /* The SIO requires the first byte to have:
  1268. * B0 1
  1269. * B1 0
  1270. * B2..7 length of message excluding byte 0
  1271. *
  1272. * The new devices do not require this byte
  1273. */
  1274. static int ftdi_write (struct usb_serial_port *port,
  1275. const unsigned char *buf, int count)
  1276. { /* ftdi_write */
  1277. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1278. struct urb *urb;
  1279. unsigned char *buffer;
  1280. int data_offset ; /* will be 1 for the SIO and 0 otherwise */
  1281. int status;
  1282. int transfer_size;
  1283. unsigned long flags;
  1284. dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
  1285. if (count == 0) {
  1286. dbg("write request of 0 bytes");
  1287. return 0;
  1288. }
  1289. spin_lock_irqsave(&priv->tx_lock, flags);
  1290. if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
  1291. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1292. dbg("%s - write limit hit\n", __FUNCTION__);
  1293. return 0;
  1294. }
  1295. priv->tx_outstanding_urbs++;
  1296. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1297. data_offset = priv->write_offset;
  1298. dbg("data_offset set to %d",data_offset);
  1299. /* Determine total transfer size */
  1300. transfer_size = count;
  1301. if (data_offset > 0) {
  1302. /* Original sio needs control bytes too... */
  1303. transfer_size += (data_offset *
  1304. ((count + (PKTSZ - 1 - data_offset)) /
  1305. (PKTSZ - data_offset)));
  1306. }
  1307. buffer = kmalloc (transfer_size, GFP_ATOMIC);
  1308. if (!buffer) {
  1309. err("%s ran out of kernel memory for urb ...", __FUNCTION__);
  1310. count = -ENOMEM;
  1311. goto error_no_buffer;
  1312. }
  1313. urb = usb_alloc_urb(0, GFP_ATOMIC);
  1314. if (!urb) {
  1315. err("%s - no more free urbs", __FUNCTION__);
  1316. count = -ENOMEM;
  1317. goto error_no_urb;
  1318. }
  1319. /* Copy data */
  1320. if (data_offset > 0) {
  1321. /* Original sio requires control byte at start of each packet. */
  1322. int user_pktsz = PKTSZ - data_offset;
  1323. int todo = count;
  1324. unsigned char *first_byte = buffer;
  1325. const unsigned char *current_position = buf;
  1326. while (todo > 0) {
  1327. if (user_pktsz > todo) {
  1328. user_pktsz = todo;
  1329. }
  1330. /* Write the control byte at the front of the packet*/
  1331. *first_byte = 1 | ((user_pktsz) << 2);
  1332. /* Copy data for packet */
  1333. memcpy (first_byte + data_offset,
  1334. current_position, user_pktsz);
  1335. first_byte += user_pktsz + data_offset;
  1336. current_position += user_pktsz;
  1337. todo -= user_pktsz;
  1338. }
  1339. } else {
  1340. /* No control byte required. */
  1341. /* Copy in the data to send */
  1342. memcpy (buffer, buf, count);
  1343. }
  1344. usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
  1345. /* fill the buffer and send it */
  1346. usb_fill_bulk_urb(urb, port->serial->dev,
  1347. usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
  1348. buffer, transfer_size,
  1349. ftdi_write_bulk_callback, port);
  1350. status = usb_submit_urb(urb, GFP_ATOMIC);
  1351. if (status) {
  1352. err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
  1353. count = status;
  1354. goto error;
  1355. } else {
  1356. spin_lock_irqsave(&priv->tx_lock, flags);
  1357. priv->tx_outstanding_bytes += count;
  1358. priv->tx_bytes += count;
  1359. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1360. }
  1361. /* we are done with this urb, so let the host driver
  1362. * really free it when it is finished with it */
  1363. usb_free_urb(urb);
  1364. dbg("%s write returning: %d", __FUNCTION__, count);
  1365. return count;
  1366. error:
  1367. usb_free_urb(urb);
  1368. error_no_urb:
  1369. kfree (buffer);
  1370. error_no_buffer:
  1371. spin_lock_irqsave(&priv->tx_lock, flags);
  1372. priv->tx_outstanding_urbs--;
  1373. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1374. return count;
  1375. } /* ftdi_write */
  1376. /* This function may get called when the device is closed */
  1377. static void ftdi_write_bulk_callback (struct urb *urb)
  1378. {
  1379. unsigned long flags;
  1380. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  1381. struct ftdi_private *priv;
  1382. int data_offset; /* will be 1 for the SIO and 0 otherwise */
  1383. unsigned long countback;
  1384. int status = urb->status;
  1385. /* free up the transfer buffer, as usb_free_urb() does not do this */
  1386. kfree (urb->transfer_buffer);
  1387. dbg("%s - port %d", __FUNCTION__, port->number);
  1388. if (status) {
  1389. dbg("nonzero write bulk status received: %d", status);
  1390. return;
  1391. }
  1392. priv = usb_get_serial_port_data(port);
  1393. if (!priv) {
  1394. dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
  1395. return;
  1396. }
  1397. /* account for transferred data */
  1398. countback = urb->actual_length;
  1399. data_offset = priv->write_offset;
  1400. if (data_offset > 0) {
  1401. /* Subtract the control bytes */
  1402. countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
  1403. }
  1404. spin_lock_irqsave(&priv->tx_lock, flags);
  1405. --priv->tx_outstanding_urbs;
  1406. priv->tx_outstanding_bytes -= countback;
  1407. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1408. usb_serial_port_softint(port);
  1409. } /* ftdi_write_bulk_callback */
  1410. static int ftdi_write_room( struct usb_serial_port *port )
  1411. {
  1412. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1413. int room;
  1414. unsigned long flags;
  1415. dbg("%s - port %d", __FUNCTION__, port->number);
  1416. spin_lock_irqsave(&priv->tx_lock, flags);
  1417. if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
  1418. /*
  1419. * We really can take anything the user throws at us
  1420. * but let's pick a nice big number to tell the tty
  1421. * layer that we have lots of free space
  1422. */
  1423. room = 2048;
  1424. } else {
  1425. room = 0;
  1426. }
  1427. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1428. return room;
  1429. } /* ftdi_write_room */
  1430. static int ftdi_chars_in_buffer (struct usb_serial_port *port)
  1431. { /* ftdi_chars_in_buffer */
  1432. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1433. int buffered;
  1434. unsigned long flags;
  1435. dbg("%s - port %d", __FUNCTION__, port->number);
  1436. spin_lock_irqsave(&priv->tx_lock, flags);
  1437. buffered = (int)priv->tx_outstanding_bytes;
  1438. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1439. if (buffered < 0) {
  1440. err("%s outstanding tx bytes is negative!", __FUNCTION__);
  1441. buffered = 0;
  1442. }
  1443. return buffered;
  1444. } /* ftdi_chars_in_buffer */
  1445. static void ftdi_read_bulk_callback (struct urb *urb)
  1446. { /* ftdi_read_bulk_callback */
  1447. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  1448. struct tty_struct *tty;
  1449. struct ftdi_private *priv;
  1450. unsigned long countread;
  1451. unsigned long flags;
  1452. int status = urb->status;
  1453. if (urb->number_of_packets > 0) {
  1454. err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
  1455. urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
  1456. err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
  1457. }
  1458. dbg("%s - port %d", __FUNCTION__, port->number);
  1459. if (port->open_count <= 0)
  1460. return;
  1461. tty = port->tty;
  1462. if (!tty) {
  1463. dbg("%s - bad tty pointer - exiting",__FUNCTION__);
  1464. return;
  1465. }
  1466. priv = usb_get_serial_port_data(port);
  1467. if (!priv) {
  1468. dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
  1469. return;
  1470. }
  1471. if (urb != port->read_urb) {
  1472. err("%s - Not my urb!", __FUNCTION__);
  1473. }
  1474. if (status) {
  1475. /* This will happen at close every time so it is a dbg not an err */
  1476. dbg("(this is ok on close) nonzero read bulk status received: "
  1477. "%d", status);
  1478. return;
  1479. }
  1480. /* count data bytes, but not status bytes */
  1481. countread = urb->actual_length;
  1482. countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
  1483. spin_lock_irqsave(&priv->rx_lock, flags);
  1484. priv->rx_bytes += countread;
  1485. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1486. ftdi_process_read(&priv->rx_work.work);
  1487. } /* ftdi_read_bulk_callback */
  1488. static void ftdi_process_read (struct work_struct *work)
  1489. { /* ftdi_process_read */
  1490. struct ftdi_private *priv =
  1491. container_of(work, struct ftdi_private, rx_work.work);
  1492. struct usb_serial_port *port = priv->port;
  1493. struct urb *urb;
  1494. struct tty_struct *tty;
  1495. char error_flag;
  1496. unsigned char *data;
  1497. int i;
  1498. int result;
  1499. int need_flip;
  1500. int packet_offset;
  1501. unsigned long flags;
  1502. dbg("%s - port %d", __FUNCTION__, port->number);
  1503. if (port->open_count <= 0)
  1504. return;
  1505. tty = port->tty;
  1506. if (!tty) {
  1507. dbg("%s - bad tty pointer - exiting",__FUNCTION__);
  1508. return;
  1509. }
  1510. priv = usb_get_serial_port_data(port);
  1511. if (!priv) {
  1512. dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
  1513. return;
  1514. }
  1515. urb = port->read_urb;
  1516. if (!urb) {
  1517. dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
  1518. return;
  1519. }
  1520. data = urb->transfer_buffer;
  1521. if (priv->rx_processed) {
  1522. dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
  1523. priv->rx_processed,
  1524. urb->actual_length - priv->rx_processed);
  1525. } else {
  1526. /* The first two bytes of every read packet are status */
  1527. if (urb->actual_length > 2) {
  1528. usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
  1529. } else {
  1530. dbg("Status only: %03oo %03oo",data[0],data[1]);
  1531. }
  1532. }
  1533. /* TO DO -- check for hung up line and handle appropriately: */
  1534. /* send hangup */
  1535. /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
  1536. /* if CD is dropped and the line is not CLOCAL then we should hangup */
  1537. need_flip = 0;
  1538. for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
  1539. int length;
  1540. /* Compare new line status to the old one, signal if different */
  1541. /* N.B. packet may be processed more than once, but differences
  1542. * are only processed once. */
  1543. if (priv != NULL) {
  1544. char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
  1545. if (new_status != priv->prev_status) {
  1546. priv->diff_status |= new_status ^ priv->prev_status;
  1547. wake_up_interruptible(&priv->delta_msr_wait);
  1548. priv->prev_status = new_status;
  1549. }
  1550. }
  1551. length = min(PKTSZ, urb->actual_length-packet_offset)-2;
  1552. if (length < 0) {
  1553. err("%s - bad packet length: %d", __FUNCTION__, length+2);
  1554. length = 0;
  1555. }
  1556. if (priv->rx_flags & THROTTLED) {
  1557. dbg("%s - throttled", __FUNCTION__);
  1558. break;
  1559. }
  1560. if (tty_buffer_request_room(tty, length) < length) {
  1561. /* break out & wait for throttling/unthrottling to happen */
  1562. dbg("%s - receive room low", __FUNCTION__);
  1563. break;
  1564. }
  1565. /* Handle errors and break */
  1566. error_flag = TTY_NORMAL;
  1567. /* Although the device uses a bitmask and hence can have multiple */
  1568. /* errors on a packet - the order here sets the priority the */
  1569. /* error is returned to the tty layer */
  1570. if ( data[packet_offset+1] & FTDI_RS_OE ) {
  1571. error_flag = TTY_OVERRUN;
  1572. dbg("OVERRRUN error");
  1573. }
  1574. if ( data[packet_offset+1] & FTDI_RS_BI ) {
  1575. error_flag = TTY_BREAK;
  1576. dbg("BREAK received");
  1577. }
  1578. if ( data[packet_offset+1] & FTDI_RS_PE ) {
  1579. error_flag = TTY_PARITY;
  1580. dbg("PARITY error");
  1581. }
  1582. if ( data[packet_offset+1] & FTDI_RS_FE ) {
  1583. error_flag = TTY_FRAME;
  1584. dbg("FRAMING error");
  1585. }
  1586. if (length > 0) {
  1587. for (i = 2; i < length+2; i++) {
  1588. /* Note that the error flag is duplicated for
  1589. every character received since we don't know
  1590. which character it applied to */
  1591. tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
  1592. }
  1593. need_flip = 1;
  1594. }
  1595. #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
  1596. /* if a parity error is detected you get status packets forever
  1597. until a character is sent without a parity error.
  1598. This doesn't work well since the application receives a never
  1599. ending stream of bad data - even though new data hasn't been sent.
  1600. Therefore I (bill) have taken this out.
  1601. However - this might make sense for framing errors and so on
  1602. so I am leaving the code in for now.
  1603. */
  1604. else {
  1605. if (error_flag != TTY_NORMAL){
  1606. dbg("error_flag is not normal");
  1607. /* In this case it is just status - if that is an error send a bad character */
  1608. if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
  1609. tty_flip_buffer_push(tty);
  1610. }
  1611. tty_insert_flip_char(tty, 0xff, error_flag);
  1612. need_flip = 1;
  1613. }
  1614. }
  1615. #endif
  1616. } /* "for(packet_offset=0..." */
  1617. /* Low latency */
  1618. if (need_flip) {
  1619. tty_flip_buffer_push(tty);
  1620. }
  1621. if (packet_offset < urb->actual_length) {
  1622. /* not completely processed - record progress */
  1623. priv->rx_processed = packet_offset;
  1624. dbg("%s - incomplete, %d bytes processed, %d remain",
  1625. __FUNCTION__, packet_offset,
  1626. urb->actual_length - packet_offset);
  1627. /* check if we were throttled while processing */
  1628. spin_lock_irqsave(&priv->rx_lock, flags);
  1629. if (priv->rx_flags & THROTTLED) {
  1630. priv->rx_flags |= ACTUALLY_THROTTLED;
  1631. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1632. dbg("%s - deferring remainder until unthrottled",
  1633. __FUNCTION__);
  1634. return;
  1635. }
  1636. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1637. /* if the port is closed stop trying to read */
  1638. if (port->open_count > 0){
  1639. /* delay processing of remainder */
  1640. schedule_delayed_work(&priv->rx_work, 1);
  1641. } else {
  1642. dbg("%s - port is closed", __FUNCTION__);
  1643. }
  1644. return;
  1645. }
  1646. /* urb is completely processed */
  1647. priv->rx_processed = 0;
  1648. /* if the port is closed stop trying to read */
  1649. if (port->open_count > 0){
  1650. /* Continue trying to always read */
  1651. usb_fill_bulk_urb(port->read_urb, port->serial->dev,
  1652. usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
  1653. port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
  1654. ftdi_read_bulk_callback, port);
  1655. result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
  1656. if (result)
  1657. err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
  1658. }
  1659. return;
  1660. } /* ftdi_process_read */
  1661. static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
  1662. {
  1663. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1664. __u16 urb_value = 0;
  1665. char buf[1];
  1666. /* break_state = -1 to turn on break, and 0 to turn off break */
  1667. /* see drivers/char/tty_io.c to see it used */
  1668. /* last_set_data_urb_value NEVER has the break bit set in it */
  1669. if (break_state) {
  1670. urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
  1671. } else {
  1672. urb_value = priv->last_set_data_urb_value;
  1673. }
  1674. if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
  1675. FTDI_SIO_SET_DATA_REQUEST,
  1676. FTDI_SIO_SET_DATA_REQUEST_TYPE,
  1677. urb_value , priv->interface,
  1678. buf, 0, WDR_TIMEOUT) < 0) {
  1679. err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
  1680. }
  1681. dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
  1682. }
  1683. /* old_termios contains the original termios settings and tty->termios contains
  1684. * the new setting to be used
  1685. * WARNING: set_termios calls this with old_termios in kernel space
  1686. */
  1687. static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
  1688. { /* ftdi_termios */
  1689. struct usb_device *dev = port->serial->dev;
  1690. unsigned int cflag = port->tty->termios->c_cflag;
  1691. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1692. __u16 urb_value; /* will hold the new flags */
  1693. char buf[1]; /* Perhaps I should dynamically alloc this? */
  1694. // Added for xon/xoff support
  1695. unsigned int iflag = port->tty->termios->c_iflag;
  1696. unsigned char vstop;
  1697. unsigned char vstart;
  1698. dbg("%s", __FUNCTION__);
  1699. /* Force baud rate if this device requires it, unless it is set to B0. */
  1700. if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
  1701. dbg("%s: forcing baud rate for this device", __FUNCTION__);
  1702. port->tty->termios->c_cflag &= ~CBAUD;
  1703. port->tty->termios->c_cflag |= priv->force_baud;
  1704. }
  1705. /* Force RTS-CTS if this device requires it. */
  1706. if (priv->force_rtscts) {
  1707. dbg("%s: forcing rtscts for this device", __FUNCTION__);
  1708. port->tty->termios->c_cflag |= CRTSCTS;
  1709. }
  1710. cflag = port->tty->termios->c_cflag;
  1711. /* FIXME -For this cut I don't care if the line is really changing or
  1712. not - so just do the change regardless - should be able to
  1713. compare old_termios and tty->termios */
  1714. /* NOTE These routines can get interrupted by
  1715. ftdi_sio_read_bulk_callback - need to examine what this
  1716. means - don't see any problems yet */
  1717. /* Set number of data bits, parity, stop bits */
  1718. urb_value = 0;
  1719. urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
  1720. FTDI_SIO_SET_DATA_STOP_BITS_1);
  1721. urb_value |= (cflag & PARENB ?
  1722. (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
  1723. FTDI_SIO_SET_DATA_PARITY_EVEN) :
  1724. FTDI_SIO_SET_DATA_PARITY_NONE);
  1725. if (cflag & CSIZE) {
  1726. switch (cflag & CSIZE) {
  1727. case CS5: urb_value |= 5; dbg("Setting CS5"); break;
  1728. case CS6: urb_value |= 6; dbg("Setting CS6"); break;
  1729. case CS7: urb_value |= 7; dbg("Setting CS7"); break;
  1730. case CS8: urb_value |= 8; dbg("Setting CS8"); break;
  1731. default:
  1732. err("CSIZE was set but not CS5-CS8");
  1733. }
  1734. }
  1735. /* This is needed by the break command since it uses the same command - but is
  1736. * or'ed with this value */
  1737. priv->last_set_data_urb_value = urb_value;
  1738. if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  1739. FTDI_SIO_SET_DATA_REQUEST,
  1740. FTDI_SIO_SET_DATA_REQUEST_TYPE,
  1741. urb_value , priv->interface,
  1742. buf, 0, WDR_SHORT_TIMEOUT) < 0) {
  1743. err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
  1744. }
  1745. /* Now do the baudrate */
  1746. if ((cflag & CBAUD) == B0 ) {
  1747. /* Disable flow control */
  1748. if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  1749. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1750. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1751. 0, priv->interface,
  1752. buf, 0, WDR_TIMEOUT) < 0) {
  1753. err("%s error from disable flowcontrol urb", __FUNCTION__);
  1754. }
  1755. /* Drop RTS and DTR */
  1756. clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
  1757. } else {
  1758. /* set the baudrate determined before */
  1759. if (change_speed(port)) {
  1760. err("%s urb failed to set baudrate", __FUNCTION__);
  1761. }
  1762. /* Ensure RTS and DTR are raised when baudrate changed from 0 */
  1763. if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
  1764. set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
  1765. }
  1766. }
  1767. /* Set flow control */
  1768. /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
  1769. if (cflag & CRTSCTS) {
  1770. dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
  1771. if (usb_control_msg(dev,
  1772. usb_sndctrlpipe(dev, 0),
  1773. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1774. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1775. 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
  1776. buf, 0, WDR_TIMEOUT) < 0) {
  1777. err("urb failed to set to rts/cts flow control");
  1778. }
  1779. } else {
  1780. /*
  1781. * Xon/Xoff code
  1782. *
  1783. * Check the IXOFF status in the iflag component of the termios structure
  1784. * if IXOFF is not set, the pre-xon/xoff code is executed.
  1785. */
  1786. if (iflag & IXOFF) {
  1787. dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
  1788. // Try to enable the XON/XOFF on the ftdi_sio
  1789. // Set the vstart and vstop -- could have been done up above where
  1790. // a lot of other dereferencing is done but that would be very
  1791. // inefficient as vstart and vstop are not always needed
  1792. vstart=port->tty->termios->c_cc[VSTART];
  1793. vstop=port->tty->termios->c_cc[VSTOP];
  1794. urb_value=(vstop << 8) | (vstart);
  1795. if (usb_control_msg(dev,
  1796. usb_sndctrlpipe(dev, 0),
  1797. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1798. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1799. urb_value , (FTDI_SIO_XON_XOFF_HS
  1800. | priv->interface),
  1801. buf, 0, WDR_TIMEOUT) < 0) {
  1802. err("urb failed to set to xon/xoff flow control");
  1803. }
  1804. } else {
  1805. /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
  1806. /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
  1807. dbg("%s Turning off hardware flow control", __FUNCTION__);
  1808. if (usb_control_msg(dev,
  1809. usb_sndctrlpipe(dev, 0),
  1810. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1811. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1812. 0, priv->interface,
  1813. buf, 0, WDR_TIMEOUT) < 0) {
  1814. err("urb failed to clear flow control");
  1815. }
  1816. }
  1817. }
  1818. return;
  1819. } /* ftdi_termios */
  1820. static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
  1821. {
  1822. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1823. unsigned char buf[2];
  1824. int ret;
  1825. dbg("%s TIOCMGET", __FUNCTION__);
  1826. switch (priv->chip_type) {
  1827. case SIO:
  1828. /* Request the status from the device */
  1829. if ((ret = usb_control_msg(port->serial->dev,
  1830. usb_rcvctrlpipe(port->serial->dev, 0),
  1831. FTDI_SIO_GET_MODEM_STATUS_REQUEST,
  1832. FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
  1833. 0, 0,
  1834. buf, 1, WDR_TIMEOUT)) < 0 ) {
  1835. err("%s Could not get modem status of device - err: %d", __FUNCTION__,
  1836. ret);
  1837. return(ret);
  1838. }
  1839. break;
  1840. case FT8U232AM:
  1841. case FT232BM:
  1842. case FT2232C:
  1843. /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
  1844. format as the data returned from the in point */
  1845. if ((ret = usb_control_msg(port->serial->dev,
  1846. usb_rcvctrlpipe(port->serial->dev, 0),
  1847. FTDI_SIO_GET_MODEM_STATUS_REQUEST,
  1848. FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
  1849. 0, priv->interface,
  1850. buf, 2, WDR_TIMEOUT)) < 0 ) {
  1851. err("%s Could not get modem status of device - err: %d", __FUNCTION__,
  1852. ret);
  1853. return(ret);
  1854. }
  1855. break;
  1856. default:
  1857. return -EFAULT;
  1858. break;
  1859. }
  1860. return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
  1861. (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
  1862. (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
  1863. (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
  1864. priv->last_dtr_rts;
  1865. }
  1866. static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
  1867. {
  1868. dbg("%s TIOCMSET", __FUNCTION__);
  1869. return update_mctrl(port, set, clear);
  1870. }
  1871. static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
  1872. {
  1873. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1874. dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
  1875. /* Based on code from acm.c and others */
  1876. switch (cmd) {
  1877. case TIOCGSERIAL: /* gets serial port data */
  1878. return get_serial_info(port, (struct serial_struct __user *) arg);
  1879. case TIOCSSERIAL: /* sets serial port data */
  1880. return set_serial_info(port, (struct serial_struct __user *) arg);
  1881. /*
  1882. * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
  1883. * - mask passed in arg for lines of interest
  1884. * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
  1885. * Caller should use TIOCGICOUNT to see which one it was.
  1886. *
  1887. * This code is borrowed from linux/drivers/char/serial.c
  1888. */
  1889. case TIOCMIWAIT:
  1890. while (priv != NULL) {
  1891. interruptible_sleep_on(&priv->delta_msr_wait);
  1892. /* see if a signal did it */
  1893. if (signal_pending(current))
  1894. return -ERESTARTSYS;
  1895. else {
  1896. char diff = priv->diff_status;
  1897. if (diff == 0) {
  1898. return -EIO; /* no change => error */
  1899. }
  1900. /* Consume all events */
  1901. priv->diff_status = 0;
  1902. /* Return 0 if caller wanted to know about these bits */
  1903. if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
  1904. ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
  1905. ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
  1906. ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
  1907. return 0;
  1908. }
  1909. /*
  1910. * Otherwise caller can't care less about what happened,
  1911. * and so we continue to wait for more events.
  1912. */
  1913. }
  1914. }
  1915. return(0);
  1916. break;
  1917. default:
  1918. break;
  1919. }
  1920. /* This is not necessarily an error - turns out the higher layers will do
  1921. * some ioctls itself (see comment above)
  1922. */
  1923. dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
  1924. return(-ENOIOCTLCMD);
  1925. } /* ftdi_ioctl */
  1926. static void ftdi_throttle (struct usb_serial_port *port)
  1927. {
  1928. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1929. unsigned long flags;
  1930. dbg("%s - port %d", __FUNCTION__, port->number);
  1931. spin_lock_irqsave(&priv->rx_lock, flags);
  1932. priv->rx_flags |= THROTTLED;
  1933. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1934. }
  1935. static void ftdi_unthrottle (struct usb_serial_port *port)
  1936. {
  1937. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1938. int actually_throttled;
  1939. unsigned long flags;
  1940. dbg("%s - port %d", __FUNCTION__, port->number);
  1941. spin_lock_irqsave(&priv->rx_lock, flags);
  1942. actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
  1943. priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
  1944. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1945. if (actually_throttled)
  1946. schedule_delayed_work(&priv->rx_work, 0);
  1947. }
  1948. static int __init ftdi_init (void)
  1949. {
  1950. int retval;
  1951. dbg("%s", __FUNCTION__);
  1952. if (vendor > 0 && product > 0) {
  1953. /* Add user specified VID/PID to reserved element of table. */
  1954. int i;
  1955. for (i = 0; id_table_combined[i].idVendor; i++)
  1956. ;
  1957. id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
  1958. id_table_combined[i].idVendor = vendor;
  1959. id_table_combined[i].idProduct = product;
  1960. }
  1961. retval = usb_serial_register(&ftdi_sio_device);
  1962. if (retval)
  1963. goto failed_sio_register;
  1964. retval = usb_register(&ftdi_driver);
  1965. if (retval)
  1966. goto failed_usb_register;
  1967. info(DRIVER_VERSION ":" DRIVER_DESC);
  1968. return 0;
  1969. failed_usb_register:
  1970. usb_serial_deregister(&ftdi_sio_device);
  1971. failed_sio_register:
  1972. return retval;
  1973. }
  1974. static void __exit ftdi_exit (void)
  1975. {
  1976. dbg("%s", __FUNCTION__);
  1977. usb_deregister (&ftdi_driver);
  1978. usb_serial_deregister (&ftdi_sio_device);
  1979. }
  1980. module_init(ftdi_init);
  1981. module_exit(ftdi_exit);
  1982. MODULE_AUTHOR( DRIVER_AUTHOR );
  1983. MODULE_DESCRIPTION( DRIVER_DESC );
  1984. MODULE_LICENSE("GPL");
  1985. module_param(debug, bool, S_IRUGO | S_IWUSR);
  1986. MODULE_PARM_DESC(debug, "Debug enabled or not");
  1987. module_param(vendor, ushort, 0);
  1988. MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
  1989. __MODULE_STRING(FTDI_VID)")");
  1990. module_param(product, ushort, 0);
  1991. MODULE_PARM_DESC(vendor, "User specified product ID");