ftdi_sio.c 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290
  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(EVOLUTION_VID, EVO_HYBRID_PID) },
  525. { USB_DEVICE(EVOLUTION_VID, EVO_RCM4_PID) },
  526. { USB_DEVICE(FTDI_VID, FTDI_ARTEMIS_PID) },
  527. { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16_PID) },
  528. { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16C_PID) },
  529. { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HR_PID) },
  530. { USB_DEVICE(FTDI_VID, FTDI_ATIK_ATK16HRC_PID) },
  531. { USB_DEVICE(KOBIL_VID, KOBIL_CONV_B1_PID) },
  532. { USB_DEVICE(KOBIL_VID, KOBIL_CONV_KAAN_PID) },
  533. { USB_DEVICE(POSIFLEX_VID, POSIFLEX_PP7000_PID) },
  534. { USB_DEVICE(FTDI_VID, FTDI_TTUSB_PID) },
  535. { USB_DEVICE(FTDI_VID, FTDI_ECLO_COM_1WIRE_PID) },
  536. { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_777_PID) },
  537. { USB_DEVICE(FTDI_VID, FTDI_WESTREX_MODEL_8900F_PID) },
  538. { USB_DEVICE(FTDI_VID, FTDI_PCDJ_DAC2_PID) },
  539. { USB_DEVICE(FTDI_VID, FTDI_RRCIRKITS_LOCOBUFFER_PID) },
  540. { USB_DEVICE(FTDI_VID, FTDI_ASK_RDR400_PID) },
  541. { USB_DEVICE(ICOM_ID1_VID, ICOM_ID1_PID) },
  542. { USB_DEVICE(PAPOUCH_VID, PAPOUCH_TMU_PID) },
  543. { USB_DEVICE(FTDI_VID, FTDI_ACG_HFDUAL_PID) },
  544. { USB_DEVICE(FTDI_VID, FTDI_YEI_SERVOCENTER31_PID) },
  545. { USB_DEVICE(FTDI_VID, FTDI_THORLABS_PID) },
  546. { USB_DEVICE(TESTO_VID, TESTO_USB_INTERFACE_PID) },
  547. { USB_DEVICE(FTDI_VID, FTDI_GAMMA_SCOUT_PID) },
  548. { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13M_PID) },
  549. { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13S_PID) },
  550. { USB_DEVICE(FTDI_VID, FTDI_TACTRIX_OPENPORT_13U_PID) },
  551. { USB_DEVICE(ELEKTOR_VID, ELEKTOR_FT323R_PID) },
  552. { USB_DEVICE(TELLDUS_VID, TELLDUS_TELLSTICK_PID) },
  553. { USB_DEVICE(FTDI_VID, FTDI_MAXSTREAM_PID) },
  554. { USB_DEVICE(OLIMEX_VID, OLIMEX_ARM_USB_OCD_PID),
  555. .driver_info = (kernel_ulong_t)&ftdi_olimex_quirk },
  556. { }, /* Optional parameter entry */
  557. { } /* Terminating entry */
  558. };
  559. MODULE_DEVICE_TABLE (usb, id_table_combined);
  560. static struct usb_driver ftdi_driver = {
  561. .name = "ftdi_sio",
  562. .probe = usb_serial_probe,
  563. .disconnect = usb_serial_disconnect,
  564. .id_table = id_table_combined,
  565. .no_dynamic_id = 1,
  566. };
  567. static const char *ftdi_chip_name[] = {
  568. [SIO] = "SIO", /* the serial part of FT8U100AX */
  569. [FT8U232AM] = "FT8U232AM",
  570. [FT232BM] = "FT232BM",
  571. [FT2232C] = "FT2232C",
  572. [FT232RL] = "FT232RL",
  573. };
  574. /* Constants for read urb and write urb */
  575. #define BUFSZ 512
  576. #define PKTSZ 64
  577. /* rx_flags */
  578. #define THROTTLED 0x01
  579. #define ACTUALLY_THROTTLED 0x02
  580. /* Used for TIOCMIWAIT */
  581. #define FTDI_STATUS_B0_MASK (FTDI_RS0_CTS | FTDI_RS0_DSR | FTDI_RS0_RI | FTDI_RS0_RLSD)
  582. #define FTDI_STATUS_B1_MASK (FTDI_RS_BI)
  583. /* End TIOCMIWAIT */
  584. #define FTDI_IMPL_ASYNC_FLAGS = ( ASYNC_SPD_HI | ASYNC_SPD_VHI \
  585. ASYNC_SPD_CUST | ASYNC_SPD_SHI | ASYNC_SPD_WARP )
  586. /* function prototypes for a FTDI serial converter */
  587. static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id);
  588. static void ftdi_shutdown (struct usb_serial *serial);
  589. static int ftdi_sio_port_probe (struct usb_serial_port *port);
  590. static int ftdi_sio_port_remove (struct usb_serial_port *port);
  591. static int ftdi_open (struct usb_serial_port *port, struct file *filp);
  592. static void ftdi_close (struct usb_serial_port *port, struct file *filp);
  593. static int ftdi_write (struct usb_serial_port *port, const unsigned char *buf, int count);
  594. static int ftdi_write_room (struct usb_serial_port *port);
  595. static int ftdi_chars_in_buffer (struct usb_serial_port *port);
  596. static void ftdi_write_bulk_callback (struct urb *urb);
  597. static void ftdi_read_bulk_callback (struct urb *urb);
  598. static void ftdi_process_read (struct work_struct *work);
  599. static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios * old);
  600. static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file);
  601. static int ftdi_tiocmset (struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear);
  602. static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg);
  603. static void ftdi_break_ctl (struct usb_serial_port *port, int break_state );
  604. static void ftdi_throttle (struct usb_serial_port *port);
  605. static void ftdi_unthrottle (struct usb_serial_port *port);
  606. static unsigned short int ftdi_232am_baud_base_to_divisor (int baud, int base);
  607. static unsigned short int ftdi_232am_baud_to_divisor (int baud);
  608. static __u32 ftdi_232bm_baud_base_to_divisor (int baud, int base);
  609. static __u32 ftdi_232bm_baud_to_divisor (int baud);
  610. static struct usb_serial_driver ftdi_sio_device = {
  611. .driver = {
  612. .owner = THIS_MODULE,
  613. .name = "ftdi_sio",
  614. },
  615. .description = "FTDI USB Serial Device",
  616. .usb_driver = &ftdi_driver ,
  617. .id_table = id_table_combined,
  618. .num_interrupt_in = 0,
  619. .num_bulk_in = 1,
  620. .num_bulk_out = 1,
  621. .num_ports = 1,
  622. .probe = ftdi_sio_probe,
  623. .port_probe = ftdi_sio_port_probe,
  624. .port_remove = ftdi_sio_port_remove,
  625. .open = ftdi_open,
  626. .close = ftdi_close,
  627. .throttle = ftdi_throttle,
  628. .unthrottle = ftdi_unthrottle,
  629. .write = ftdi_write,
  630. .write_room = ftdi_write_room,
  631. .chars_in_buffer = ftdi_chars_in_buffer,
  632. .read_bulk_callback = ftdi_read_bulk_callback,
  633. .write_bulk_callback = ftdi_write_bulk_callback,
  634. .tiocmget = ftdi_tiocmget,
  635. .tiocmset = ftdi_tiocmset,
  636. .ioctl = ftdi_ioctl,
  637. .set_termios = ftdi_set_termios,
  638. .break_ctl = ftdi_break_ctl,
  639. .shutdown = ftdi_shutdown,
  640. };
  641. #define WDR_TIMEOUT 5000 /* default urb timeout */
  642. #define WDR_SHORT_TIMEOUT 1000 /* shorter urb timeout */
  643. /* High and low are for DTR, RTS etc etc */
  644. #define HIGH 1
  645. #define LOW 0
  646. /* number of outstanding urbs to prevent userspace DoS from happening */
  647. #define URB_UPPER_LIMIT 42
  648. /*
  649. * ***************************************************************************
  650. * Utility functions
  651. * ***************************************************************************
  652. */
  653. static unsigned short int ftdi_232am_baud_base_to_divisor(int baud, int base)
  654. {
  655. unsigned short int divisor;
  656. int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
  657. if ((divisor3 & 0x7) == 7) divisor3 ++; // round x.7/8 up to x+1
  658. divisor = divisor3 >> 3;
  659. divisor3 &= 0x7;
  660. if (divisor3 == 1) divisor |= 0xc000; else // 0.125
  661. if (divisor3 >= 4) divisor |= 0x4000; else // 0.5
  662. if (divisor3 != 0) divisor |= 0x8000; // 0.25
  663. if (divisor == 1) divisor = 0; /* special case for maximum baud rate */
  664. return divisor;
  665. }
  666. static unsigned short int ftdi_232am_baud_to_divisor(int baud)
  667. {
  668. return(ftdi_232am_baud_base_to_divisor(baud, 48000000));
  669. }
  670. static __u32 ftdi_232bm_baud_base_to_divisor(int baud, int base)
  671. {
  672. static const unsigned char divfrac[8] = { 0, 3, 2, 4, 1, 5, 6, 7 };
  673. __u32 divisor;
  674. int divisor3 = base / 2 / baud; // divisor shifted 3 bits to the left
  675. divisor = divisor3 >> 3;
  676. divisor |= (__u32)divfrac[divisor3 & 0x7] << 14;
  677. /* Deal with special cases for highest baud rates. */
  678. if (divisor == 1) divisor = 0; else // 1.0
  679. if (divisor == 0x4001) divisor = 1; // 1.5
  680. return divisor;
  681. }
  682. static __u32 ftdi_232bm_baud_to_divisor(int baud)
  683. {
  684. return(ftdi_232bm_baud_base_to_divisor(baud, 48000000));
  685. }
  686. #define set_mctrl(port, set) update_mctrl((port), (set), 0)
  687. #define clear_mctrl(port, clear) update_mctrl((port), 0, (clear))
  688. static int update_mctrl(struct usb_serial_port *port, unsigned int set, unsigned int clear)
  689. {
  690. struct ftdi_private *priv = usb_get_serial_port_data(port);
  691. char *buf;
  692. unsigned urb_value;
  693. int rv;
  694. if (((set | clear) & (TIOCM_DTR | TIOCM_RTS)) == 0) {
  695. dbg("%s - DTR|RTS not being set|cleared", __FUNCTION__);
  696. return 0; /* no change */
  697. }
  698. buf = kmalloc(1, GFP_NOIO);
  699. if (!buf) {
  700. return -ENOMEM;
  701. }
  702. clear &= ~set; /* 'set' takes precedence over 'clear' */
  703. urb_value = 0;
  704. if (clear & TIOCM_DTR)
  705. urb_value |= FTDI_SIO_SET_DTR_LOW;
  706. if (clear & TIOCM_RTS)
  707. urb_value |= FTDI_SIO_SET_RTS_LOW;
  708. if (set & TIOCM_DTR)
  709. urb_value |= FTDI_SIO_SET_DTR_HIGH;
  710. if (set & TIOCM_RTS)
  711. urb_value |= FTDI_SIO_SET_RTS_HIGH;
  712. rv = usb_control_msg(port->serial->dev,
  713. usb_sndctrlpipe(port->serial->dev, 0),
  714. FTDI_SIO_SET_MODEM_CTRL_REQUEST,
  715. FTDI_SIO_SET_MODEM_CTRL_REQUEST_TYPE,
  716. urb_value, priv->interface,
  717. buf, 0, WDR_TIMEOUT);
  718. kfree(buf);
  719. if (rv < 0) {
  720. err("%s Error from MODEM_CTRL urb: DTR %s, RTS %s",
  721. __FUNCTION__,
  722. (set & TIOCM_DTR) ? "HIGH" :
  723. (clear & TIOCM_DTR) ? "LOW" : "unchanged",
  724. (set & TIOCM_RTS) ? "HIGH" :
  725. (clear & TIOCM_RTS) ? "LOW" : "unchanged");
  726. } else {
  727. dbg("%s - DTR %s, RTS %s", __FUNCTION__,
  728. (set & TIOCM_DTR) ? "HIGH" :
  729. (clear & TIOCM_DTR) ? "LOW" : "unchanged",
  730. (set & TIOCM_RTS) ? "HIGH" :
  731. (clear & TIOCM_RTS) ? "LOW" : "unchanged");
  732. priv->last_dtr_rts = (priv->last_dtr_rts & ~clear) | set;
  733. }
  734. return rv;
  735. }
  736. static __u32 get_ftdi_divisor(struct usb_serial_port * port);
  737. static int change_speed(struct usb_serial_port *port)
  738. {
  739. struct ftdi_private *priv = usb_get_serial_port_data(port);
  740. char *buf;
  741. __u16 urb_value;
  742. __u16 urb_index;
  743. __u32 urb_index_value;
  744. int rv;
  745. buf = kmalloc(1, GFP_NOIO);
  746. if (!buf)
  747. return -ENOMEM;
  748. urb_index_value = get_ftdi_divisor(port);
  749. urb_value = (__u16)urb_index_value;
  750. urb_index = (__u16)(urb_index_value >> 16);
  751. if (priv->interface) { /* FT2232C */
  752. urb_index = (__u16)((urb_index << 8) | priv->interface);
  753. }
  754. rv = usb_control_msg(port->serial->dev,
  755. usb_sndctrlpipe(port->serial->dev, 0),
  756. FTDI_SIO_SET_BAUDRATE_REQUEST,
  757. FTDI_SIO_SET_BAUDRATE_REQUEST_TYPE,
  758. urb_value, urb_index,
  759. buf, 0, WDR_SHORT_TIMEOUT);
  760. kfree(buf);
  761. return rv;
  762. }
  763. static __u32 get_ftdi_divisor(struct usb_serial_port * port)
  764. { /* get_ftdi_divisor */
  765. struct ftdi_private *priv = usb_get_serial_port_data(port);
  766. __u32 div_value = 0;
  767. int div_okay = 1;
  768. int baud;
  769. /*
  770. * The logic involved in setting the baudrate can be cleanly split in 3 steps.
  771. * Obtaining the actual baud rate is a little tricky since unix traditionally
  772. * somehow ignored the possibility to set non-standard baud rates.
  773. * 1. Standard baud rates are set in tty->termios->c_cflag
  774. * 2. If these are not enough, you can set any speed using alt_speed as follows:
  775. * - set tty->termios->c_cflag speed to B38400
  776. * - set your real speed in tty->alt_speed; it gets ignored when
  777. * alt_speed==0, (or)
  778. * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
  779. * flags & ASYNC_SPD_MASK == ASYNC_SPD_[HI, VHI, SHI, WARP], this just
  780. * sets alt_speed to (HI: 57600, VHI: 115200, SHI: 230400, WARP: 460800)
  781. * ** Steps 1, 2 are done courtesy of tty_get_baud_rate
  782. * 3. You can also set baud rate by setting custom divisor as follows
  783. * - set tty->termios->c_cflag speed to B38400
  784. * - call TIOCSSERIAL ioctl with (struct serial_struct) set as follows:
  785. * o flags & ASYNC_SPD_MASK == ASYNC_SPD_CUST
  786. * o custom_divisor set to baud_base / your_new_baudrate
  787. * ** Step 3 is done courtesy of code borrowed from serial.c - I should really
  788. * spend some time and separate+move this common code to serial.c, it is
  789. * replicated in nearly every serial driver you see.
  790. */
  791. /* 1. Get the baud rate from the tty settings, this observes alt_speed hack */
  792. baud = tty_get_baud_rate(port->tty);
  793. dbg("%s - tty_get_baud_rate reports speed %d", __FUNCTION__, baud);
  794. /* 2. Observe async-compatible custom_divisor hack, update baudrate if needed */
  795. if (baud == 38400 &&
  796. ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
  797. (priv->custom_divisor)) {
  798. baud = priv->baud_base / priv->custom_divisor;
  799. dbg("%s - custom divisor %d sets baud rate to %d", __FUNCTION__, priv->custom_divisor, baud);
  800. }
  801. /* 3. Convert baudrate to device-specific divisor */
  802. if (!baud) baud = 9600;
  803. switch(priv->chip_type) {
  804. case SIO: /* SIO chip */
  805. switch(baud) {
  806. case 300: div_value = ftdi_sio_b300; break;
  807. case 600: div_value = ftdi_sio_b600; break;
  808. case 1200: div_value = ftdi_sio_b1200; break;
  809. case 2400: div_value = ftdi_sio_b2400; break;
  810. case 4800: div_value = ftdi_sio_b4800; break;
  811. case 9600: div_value = ftdi_sio_b9600; break;
  812. case 19200: div_value = ftdi_sio_b19200; break;
  813. case 38400: div_value = ftdi_sio_b38400; break;
  814. case 57600: div_value = ftdi_sio_b57600; break;
  815. case 115200: div_value = ftdi_sio_b115200; break;
  816. } /* baud */
  817. if (div_value == 0) {
  818. dbg("%s - Baudrate (%d) requested is not supported", __FUNCTION__, baud);
  819. div_value = ftdi_sio_b9600;
  820. div_okay = 0;
  821. }
  822. break;
  823. case FT8U232AM: /* 8U232AM chip */
  824. if (baud <= 3000000) {
  825. div_value = ftdi_232am_baud_to_divisor(baud);
  826. } else {
  827. dbg("%s - Baud rate too high!", __FUNCTION__);
  828. div_value = ftdi_232am_baud_to_divisor(9600);
  829. div_okay = 0;
  830. }
  831. break;
  832. case FT232BM: /* FT232BM chip */
  833. case FT2232C: /* FT2232C chip */
  834. case FT232RL:
  835. if (baud <= 3000000) {
  836. div_value = ftdi_232bm_baud_to_divisor(baud);
  837. } else {
  838. dbg("%s - Baud rate too high!", __FUNCTION__);
  839. div_value = ftdi_232bm_baud_to_divisor(9600);
  840. div_okay = 0;
  841. }
  842. break;
  843. } /* priv->chip_type */
  844. if (div_okay) {
  845. dbg("%s - Baud rate set to %d (divisor 0x%lX) on chip %s",
  846. __FUNCTION__, baud, (unsigned long)div_value,
  847. ftdi_chip_name[priv->chip_type]);
  848. }
  849. return(div_value);
  850. }
  851. static int get_serial_info(struct usb_serial_port * port, struct serial_struct __user * retinfo)
  852. {
  853. struct ftdi_private *priv = usb_get_serial_port_data(port);
  854. struct serial_struct tmp;
  855. if (!retinfo)
  856. return -EFAULT;
  857. memset(&tmp, 0, sizeof(tmp));
  858. tmp.flags = priv->flags;
  859. tmp.baud_base = priv->baud_base;
  860. tmp.custom_divisor = priv->custom_divisor;
  861. if (copy_to_user(retinfo, &tmp, sizeof(*retinfo)))
  862. return -EFAULT;
  863. return 0;
  864. } /* get_serial_info */
  865. static int set_serial_info(struct usb_serial_port * port, struct serial_struct __user * newinfo)
  866. { /* set_serial_info */
  867. struct ftdi_private *priv = usb_get_serial_port_data(port);
  868. struct serial_struct new_serial;
  869. struct ftdi_private old_priv;
  870. if (copy_from_user(&new_serial, newinfo, sizeof(new_serial)))
  871. return -EFAULT;
  872. old_priv = * priv;
  873. /* Do error checking and permission checking */
  874. if (!capable(CAP_SYS_ADMIN)) {
  875. if (((new_serial.flags & ~ASYNC_USR_MASK) !=
  876. (priv->flags & ~ASYNC_USR_MASK)))
  877. return -EPERM;
  878. priv->flags = ((priv->flags & ~ASYNC_USR_MASK) |
  879. (new_serial.flags & ASYNC_USR_MASK));
  880. priv->custom_divisor = new_serial.custom_divisor;
  881. goto check_and_exit;
  882. }
  883. if ((new_serial.baud_base != priv->baud_base) &&
  884. (new_serial.baud_base < 9600))
  885. return -EINVAL;
  886. /* Make the changes - these are privileged changes! */
  887. priv->flags = ((priv->flags & ~ASYNC_FLAGS) |
  888. (new_serial.flags & ASYNC_FLAGS));
  889. priv->custom_divisor = new_serial.custom_divisor;
  890. port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
  891. check_and_exit:
  892. if ((old_priv.flags & ASYNC_SPD_MASK) !=
  893. (priv->flags & ASYNC_SPD_MASK)) {
  894. if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_HI)
  895. port->tty->alt_speed = 57600;
  896. else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_VHI)
  897. port->tty->alt_speed = 115200;
  898. else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_SHI)
  899. port->tty->alt_speed = 230400;
  900. else if ((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_WARP)
  901. port->tty->alt_speed = 460800;
  902. else
  903. port->tty->alt_speed = 0;
  904. }
  905. if (((old_priv.flags & ASYNC_SPD_MASK) !=
  906. (priv->flags & ASYNC_SPD_MASK)) ||
  907. (((priv->flags & ASYNC_SPD_MASK) == ASYNC_SPD_CUST) &&
  908. (old_priv.custom_divisor != priv->custom_divisor))) {
  909. change_speed(port);
  910. }
  911. return (0);
  912. } /* set_serial_info */
  913. /* Determine type of FTDI chip based on USB config and descriptor. */
  914. static void ftdi_determine_type(struct usb_serial_port *port)
  915. {
  916. struct ftdi_private *priv = usb_get_serial_port_data(port);
  917. struct usb_serial *serial = port->serial;
  918. struct usb_device *udev = serial->dev;
  919. unsigned version;
  920. unsigned interfaces;
  921. /* Assume it is not the original SIO device for now. */
  922. priv->baud_base = 48000000 / 2;
  923. priv->write_offset = 0;
  924. version = le16_to_cpu(udev->descriptor.bcdDevice);
  925. interfaces = udev->actconfig->desc.bNumInterfaces;
  926. dbg("%s: bcdDevice = 0x%x, bNumInterfaces = %u", __FUNCTION__,
  927. version, interfaces);
  928. if (interfaces > 1) {
  929. int inter;
  930. /* Multiple interfaces. Assume FT2232C. */
  931. priv->chip_type = FT2232C;
  932. /* Determine interface code. */
  933. inter = serial->interface->altsetting->desc.bInterfaceNumber;
  934. if (inter == 0) {
  935. priv->interface = PIT_SIOA;
  936. } else {
  937. priv->interface = PIT_SIOB;
  938. }
  939. /* BM-type devices have a bug where bcdDevice gets set
  940. * to 0x200 when iSerialNumber is 0. */
  941. if (version < 0x500) {
  942. dbg("%s: something fishy - bcdDevice too low for multi-interface device",
  943. __FUNCTION__);
  944. }
  945. } else if (version < 0x200) {
  946. /* Old device. Assume its the original SIO. */
  947. priv->chip_type = SIO;
  948. priv->baud_base = 12000000 / 16;
  949. priv->write_offset = 1;
  950. } else if (version < 0x400) {
  951. /* Assume its an FT8U232AM (or FT8U245AM) */
  952. /* (It might be a BM because of the iSerialNumber bug,
  953. * but it will still work as an AM device.) */
  954. priv->chip_type = FT8U232AM;
  955. } else if (version < 0x600) {
  956. /* Assume its an FT232BM (or FT245BM) */
  957. priv->chip_type = FT232BM;
  958. } else {
  959. /* Assume its an FT232R */
  960. priv->chip_type = FT232RL;
  961. }
  962. info("Detected %s", ftdi_chip_name[priv->chip_type]);
  963. }
  964. /*
  965. * ***************************************************************************
  966. * Sysfs Attribute
  967. * ***************************************************************************
  968. */
  969. static ssize_t show_latency_timer(struct device *dev, struct device_attribute *attr, char *buf)
  970. {
  971. struct usb_serial_port *port = to_usb_serial_port(dev);
  972. struct ftdi_private *priv = usb_get_serial_port_data(port);
  973. struct usb_device *udev = port->serial->dev;
  974. unsigned short latency = 0;
  975. int rv = 0;
  976. dbg("%s",__FUNCTION__);
  977. rv = usb_control_msg(udev,
  978. usb_rcvctrlpipe(udev, 0),
  979. FTDI_SIO_GET_LATENCY_TIMER_REQUEST,
  980. FTDI_SIO_GET_LATENCY_TIMER_REQUEST_TYPE,
  981. 0, priv->interface,
  982. (char*) &latency, 1, WDR_TIMEOUT);
  983. if (rv < 0) {
  984. dev_err(dev, "Unable to read latency timer: %i", rv);
  985. return -EIO;
  986. }
  987. return sprintf(buf, "%i\n", latency);
  988. }
  989. /* Write a new value of the latency timer, in units of milliseconds. */
  990. static ssize_t store_latency_timer(struct device *dev, struct device_attribute *attr, const char *valbuf,
  991. size_t count)
  992. {
  993. struct usb_serial_port *port = to_usb_serial_port(dev);
  994. struct ftdi_private *priv = usb_get_serial_port_data(port);
  995. struct usb_device *udev = port->serial->dev;
  996. char buf[1];
  997. int v = simple_strtoul(valbuf, NULL, 10);
  998. int rv = 0;
  999. dbg("%s: setting latency timer = %i", __FUNCTION__, v);
  1000. rv = usb_control_msg(udev,
  1001. usb_sndctrlpipe(udev, 0),
  1002. FTDI_SIO_SET_LATENCY_TIMER_REQUEST,
  1003. FTDI_SIO_SET_LATENCY_TIMER_REQUEST_TYPE,
  1004. v, priv->interface,
  1005. buf, 0, WDR_TIMEOUT);
  1006. if (rv < 0) {
  1007. dev_err(dev, "Unable to write latency timer: %i", rv);
  1008. return -EIO;
  1009. }
  1010. return count;
  1011. }
  1012. /* Write an event character directly to the FTDI register. The ASCII
  1013. value is in the low 8 bits, with the enable bit in the 9th bit. */
  1014. static ssize_t store_event_char(struct device *dev, struct device_attribute *attr, const char *valbuf,
  1015. size_t count)
  1016. {
  1017. struct usb_serial_port *port = to_usb_serial_port(dev);
  1018. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1019. struct usb_device *udev = port->serial->dev;
  1020. char buf[1];
  1021. int v = simple_strtoul(valbuf, NULL, 10);
  1022. int rv = 0;
  1023. dbg("%s: setting event char = %i", __FUNCTION__, v);
  1024. rv = usb_control_msg(udev,
  1025. usb_sndctrlpipe(udev, 0),
  1026. FTDI_SIO_SET_EVENT_CHAR_REQUEST,
  1027. FTDI_SIO_SET_EVENT_CHAR_REQUEST_TYPE,
  1028. v, priv->interface,
  1029. buf, 0, WDR_TIMEOUT);
  1030. if (rv < 0) {
  1031. dbg("Unable to write event character: %i", rv);
  1032. return -EIO;
  1033. }
  1034. return count;
  1035. }
  1036. static DEVICE_ATTR(latency_timer, S_IWUSR | S_IRUGO, show_latency_timer, store_latency_timer);
  1037. static DEVICE_ATTR(event_char, S_IWUSR, NULL, store_event_char);
  1038. static int create_sysfs_attrs(struct usb_serial_port *port)
  1039. {
  1040. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1041. int retval = 0;
  1042. dbg("%s",__FUNCTION__);
  1043. /* XXX I've no idea if the original SIO supports the event_char
  1044. * sysfs parameter, so I'm playing it safe. */
  1045. if (priv->chip_type != SIO) {
  1046. dbg("sysfs attributes for %s", ftdi_chip_name[priv->chip_type]);
  1047. retval = device_create_file(&port->dev, &dev_attr_event_char);
  1048. if ((!retval) &&
  1049. (priv->chip_type == FT232BM ||
  1050. priv->chip_type == FT2232C ||
  1051. priv->chip_type == FT232RL)) {
  1052. retval = device_create_file(&port->dev,
  1053. &dev_attr_latency_timer);
  1054. }
  1055. }
  1056. return retval;
  1057. }
  1058. static void remove_sysfs_attrs(struct usb_serial_port *port)
  1059. {
  1060. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1061. dbg("%s",__FUNCTION__);
  1062. /* XXX see create_sysfs_attrs */
  1063. if (priv->chip_type != SIO) {
  1064. device_remove_file(&port->dev, &dev_attr_event_char);
  1065. if (priv->chip_type == FT232BM || priv->chip_type == FT2232C) {
  1066. device_remove_file(&port->dev, &dev_attr_latency_timer);
  1067. }
  1068. }
  1069. }
  1070. /*
  1071. * ***************************************************************************
  1072. * FTDI driver specific functions
  1073. * ***************************************************************************
  1074. */
  1075. /* Probe function to check for special devices */
  1076. static int ftdi_sio_probe (struct usb_serial *serial, const struct usb_device_id *id)
  1077. {
  1078. struct ftdi_sio_quirk *quirk = (struct ftdi_sio_quirk *)id->driver_info;
  1079. if (quirk && quirk->probe) {
  1080. int ret = quirk->probe(serial);
  1081. if (ret != 0)
  1082. return ret;
  1083. }
  1084. usb_set_serial_data(serial, (void *)id->driver_info);
  1085. return 0;
  1086. }
  1087. static int ftdi_sio_port_probe(struct usb_serial_port *port)
  1088. {
  1089. struct ftdi_private *priv;
  1090. struct ftdi_sio_quirk *quirk = usb_get_serial_data(port->serial);
  1091. dbg("%s",__FUNCTION__);
  1092. priv = kzalloc(sizeof(struct ftdi_private), GFP_KERNEL);
  1093. if (!priv){
  1094. err("%s- kmalloc(%Zd) failed.", __FUNCTION__, sizeof(struct ftdi_private));
  1095. return -ENOMEM;
  1096. }
  1097. spin_lock_init(&priv->rx_lock);
  1098. spin_lock_init(&priv->tx_lock);
  1099. init_waitqueue_head(&priv->delta_msr_wait);
  1100. /* This will push the characters through immediately rather
  1101. than queue a task to deliver them */
  1102. priv->flags = ASYNC_LOW_LATENCY;
  1103. if (quirk && quirk->port_probe)
  1104. quirk->port_probe(priv);
  1105. /* Increase the size of read buffers */
  1106. kfree(port->bulk_in_buffer);
  1107. port->bulk_in_buffer = kmalloc (BUFSZ, GFP_KERNEL);
  1108. if (!port->bulk_in_buffer) {
  1109. kfree (priv);
  1110. return -ENOMEM;
  1111. }
  1112. if (port->read_urb) {
  1113. port->read_urb->transfer_buffer = port->bulk_in_buffer;
  1114. port->read_urb->transfer_buffer_length = BUFSZ;
  1115. }
  1116. INIT_DELAYED_WORK(&priv->rx_work, ftdi_process_read);
  1117. priv->port = port;
  1118. /* Free port's existing write urb and transfer buffer. */
  1119. if (port->write_urb) {
  1120. usb_free_urb (port->write_urb);
  1121. port->write_urb = NULL;
  1122. }
  1123. kfree(port->bulk_out_buffer);
  1124. port->bulk_out_buffer = NULL;
  1125. usb_set_serial_port_data(port, priv);
  1126. ftdi_determine_type (port);
  1127. create_sysfs_attrs(port);
  1128. return 0;
  1129. }
  1130. /* Setup for the USB-UIRT device, which requires hardwired
  1131. * baudrate (38400 gets mapped to 312500) */
  1132. /* Called from usbserial:serial_probe */
  1133. static void ftdi_USB_UIRT_setup (struct ftdi_private *priv)
  1134. {
  1135. dbg("%s",__FUNCTION__);
  1136. priv->flags |= ASYNC_SPD_CUST;
  1137. priv->custom_divisor = 77;
  1138. priv->force_baud = B38400;
  1139. } /* ftdi_USB_UIRT_setup */
  1140. /* Setup for the HE-TIRA1 device, which requires hardwired
  1141. * baudrate (38400 gets mapped to 100000) and RTS-CTS enabled. */
  1142. static void ftdi_HE_TIRA1_setup (struct ftdi_private *priv)
  1143. {
  1144. dbg("%s",__FUNCTION__);
  1145. priv->flags |= ASYNC_SPD_CUST;
  1146. priv->custom_divisor = 240;
  1147. priv->force_baud = B38400;
  1148. priv->force_rtscts = 1;
  1149. } /* ftdi_HE_TIRA1_setup */
  1150. /*
  1151. * First port on Olimex arm-usb-ocd is reserved for JTAG interface
  1152. * and can be accessed from userspace using openocd.
  1153. */
  1154. static int ftdi_olimex_probe(struct usb_serial *serial)
  1155. {
  1156. struct usb_device *udev = serial->dev;
  1157. struct usb_interface *interface = serial->interface;
  1158. dbg("%s",__FUNCTION__);
  1159. if (interface == udev->actconfig->interface[0]) {
  1160. info("Ignoring reserved serial port on Olimex arm-usb-ocd\n");
  1161. return -ENODEV;
  1162. }
  1163. return 0;
  1164. }
  1165. /* ftdi_shutdown is called from usbserial:usb_serial_disconnect
  1166. * it is called when the usb device is disconnected
  1167. *
  1168. * usbserial:usb_serial_disconnect
  1169. * calls __serial_close for each open of the port
  1170. * shutdown is called then (ie ftdi_shutdown)
  1171. */
  1172. static void ftdi_shutdown (struct usb_serial *serial)
  1173. {
  1174. dbg("%s", __FUNCTION__);
  1175. }
  1176. static int ftdi_sio_port_remove(struct usb_serial_port *port)
  1177. {
  1178. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1179. dbg("%s", __FUNCTION__);
  1180. remove_sysfs_attrs(port);
  1181. /* all open ports are closed at this point
  1182. * (by usbserial.c:__serial_close, which calls ftdi_close)
  1183. */
  1184. if (priv) {
  1185. usb_set_serial_port_data(port, NULL);
  1186. kfree(priv);
  1187. }
  1188. return 0;
  1189. }
  1190. static int ftdi_open (struct usb_serial_port *port, struct file *filp)
  1191. { /* ftdi_open */
  1192. struct usb_device *dev = port->serial->dev;
  1193. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1194. unsigned long flags;
  1195. int result = 0;
  1196. char buf[1]; /* Needed for the usb_control_msg I think */
  1197. dbg("%s", __FUNCTION__);
  1198. spin_lock_irqsave(&priv->tx_lock, flags);
  1199. priv->tx_bytes = 0;
  1200. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1201. spin_lock_irqsave(&priv->rx_lock, flags);
  1202. priv->rx_bytes = 0;
  1203. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1204. if (port->tty)
  1205. port->tty->low_latency = (priv->flags & ASYNC_LOW_LATENCY) ? 1 : 0;
  1206. /* No error checking for this (will get errors later anyway) */
  1207. /* See ftdi_sio.h for description of what is reset */
  1208. usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  1209. FTDI_SIO_RESET_REQUEST, FTDI_SIO_RESET_REQUEST_TYPE,
  1210. FTDI_SIO_RESET_SIO,
  1211. priv->interface, buf, 0, WDR_TIMEOUT);
  1212. /* Termios defaults are set by usb_serial_init. We don't change
  1213. port->tty->termios - this would loose speed settings, etc.
  1214. This is same behaviour as serial.c/rs_open() - Kuba */
  1215. /* ftdi_set_termios will send usb control messages */
  1216. if (port->tty)
  1217. ftdi_set_termios(port, NULL);
  1218. /* FIXME: Flow control might be enabled, so it should be checked -
  1219. we have no control of defaults! */
  1220. /* Turn on RTS and DTR since we are not flow controlling by default */
  1221. set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
  1222. /* Not throttled */
  1223. spin_lock_irqsave(&priv->rx_lock, flags);
  1224. priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
  1225. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1226. /* Start reading from the device */
  1227. priv->rx_processed = 0;
  1228. usb_fill_bulk_urb(port->read_urb, dev,
  1229. usb_rcvbulkpipe(dev, port->bulk_in_endpointAddress),
  1230. port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
  1231. ftdi_read_bulk_callback, port);
  1232. result = usb_submit_urb(port->read_urb, GFP_KERNEL);
  1233. if (result)
  1234. err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
  1235. return result;
  1236. } /* ftdi_open */
  1237. /*
  1238. * usbserial:__serial_close only calls ftdi_close if the point is open
  1239. *
  1240. * This only gets called when it is the last close
  1241. *
  1242. *
  1243. */
  1244. static void ftdi_close (struct usb_serial_port *port, struct file *filp)
  1245. { /* ftdi_close */
  1246. unsigned int c_cflag = port->tty->termios->c_cflag;
  1247. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1248. char buf[1];
  1249. dbg("%s", __FUNCTION__);
  1250. if (c_cflag & HUPCL){
  1251. /* Disable flow control */
  1252. if (usb_control_msg(port->serial->dev,
  1253. usb_sndctrlpipe(port->serial->dev, 0),
  1254. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1255. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1256. 0, priv->interface, buf, 0,
  1257. WDR_TIMEOUT) < 0) {
  1258. err("error from flowcontrol urb");
  1259. }
  1260. /* drop RTS and DTR */
  1261. clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
  1262. } /* Note change no line if hupcl is off */
  1263. /* cancel any scheduled reading */
  1264. cancel_delayed_work(&priv->rx_work);
  1265. flush_scheduled_work();
  1266. /* shutdown our bulk read */
  1267. usb_kill_urb(port->read_urb);
  1268. } /* ftdi_close */
  1269. /* The SIO requires the first byte to have:
  1270. * B0 1
  1271. * B1 0
  1272. * B2..7 length of message excluding byte 0
  1273. *
  1274. * The new devices do not require this byte
  1275. */
  1276. static int ftdi_write (struct usb_serial_port *port,
  1277. const unsigned char *buf, int count)
  1278. { /* ftdi_write */
  1279. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1280. struct urb *urb;
  1281. unsigned char *buffer;
  1282. int data_offset ; /* will be 1 for the SIO and 0 otherwise */
  1283. int status;
  1284. int transfer_size;
  1285. unsigned long flags;
  1286. dbg("%s port %d, %d bytes", __FUNCTION__, port->number, count);
  1287. if (count == 0) {
  1288. dbg("write request of 0 bytes");
  1289. return 0;
  1290. }
  1291. spin_lock_irqsave(&priv->tx_lock, flags);
  1292. if (priv->tx_outstanding_urbs > URB_UPPER_LIMIT) {
  1293. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1294. dbg("%s - write limit hit\n", __FUNCTION__);
  1295. return 0;
  1296. }
  1297. priv->tx_outstanding_urbs++;
  1298. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1299. data_offset = priv->write_offset;
  1300. dbg("data_offset set to %d",data_offset);
  1301. /* Determine total transfer size */
  1302. transfer_size = count;
  1303. if (data_offset > 0) {
  1304. /* Original sio needs control bytes too... */
  1305. transfer_size += (data_offset *
  1306. ((count + (PKTSZ - 1 - data_offset)) /
  1307. (PKTSZ - data_offset)));
  1308. }
  1309. buffer = kmalloc (transfer_size, GFP_ATOMIC);
  1310. if (!buffer) {
  1311. err("%s ran out of kernel memory for urb ...", __FUNCTION__);
  1312. count = -ENOMEM;
  1313. goto error_no_buffer;
  1314. }
  1315. urb = usb_alloc_urb(0, GFP_ATOMIC);
  1316. if (!urb) {
  1317. err("%s - no more free urbs", __FUNCTION__);
  1318. count = -ENOMEM;
  1319. goto error_no_urb;
  1320. }
  1321. /* Copy data */
  1322. if (data_offset > 0) {
  1323. /* Original sio requires control byte at start of each packet. */
  1324. int user_pktsz = PKTSZ - data_offset;
  1325. int todo = count;
  1326. unsigned char *first_byte = buffer;
  1327. const unsigned char *current_position = buf;
  1328. while (todo > 0) {
  1329. if (user_pktsz > todo) {
  1330. user_pktsz = todo;
  1331. }
  1332. /* Write the control byte at the front of the packet*/
  1333. *first_byte = 1 | ((user_pktsz) << 2);
  1334. /* Copy data for packet */
  1335. memcpy (first_byte + data_offset,
  1336. current_position, user_pktsz);
  1337. first_byte += user_pktsz + data_offset;
  1338. current_position += user_pktsz;
  1339. todo -= user_pktsz;
  1340. }
  1341. } else {
  1342. /* No control byte required. */
  1343. /* Copy in the data to send */
  1344. memcpy (buffer, buf, count);
  1345. }
  1346. usb_serial_debug_data(debug, &port->dev, __FUNCTION__, transfer_size, buffer);
  1347. /* fill the buffer and send it */
  1348. usb_fill_bulk_urb(urb, port->serial->dev,
  1349. usb_sndbulkpipe(port->serial->dev, port->bulk_out_endpointAddress),
  1350. buffer, transfer_size,
  1351. ftdi_write_bulk_callback, port);
  1352. status = usb_submit_urb(urb, GFP_ATOMIC);
  1353. if (status) {
  1354. err("%s - failed submitting write urb, error %d", __FUNCTION__, status);
  1355. count = status;
  1356. goto error;
  1357. } else {
  1358. spin_lock_irqsave(&priv->tx_lock, flags);
  1359. priv->tx_outstanding_bytes += count;
  1360. priv->tx_bytes += count;
  1361. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1362. }
  1363. /* we are done with this urb, so let the host driver
  1364. * really free it when it is finished with it */
  1365. usb_free_urb(urb);
  1366. dbg("%s write returning: %d", __FUNCTION__, count);
  1367. return count;
  1368. error:
  1369. usb_free_urb(urb);
  1370. error_no_urb:
  1371. kfree (buffer);
  1372. error_no_buffer:
  1373. spin_lock_irqsave(&priv->tx_lock, flags);
  1374. priv->tx_outstanding_urbs--;
  1375. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1376. return count;
  1377. } /* ftdi_write */
  1378. /* This function may get called when the device is closed */
  1379. static void ftdi_write_bulk_callback (struct urb *urb)
  1380. {
  1381. unsigned long flags;
  1382. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  1383. struct ftdi_private *priv;
  1384. int data_offset; /* will be 1 for the SIO and 0 otherwise */
  1385. unsigned long countback;
  1386. int status = urb->status;
  1387. /* free up the transfer buffer, as usb_free_urb() does not do this */
  1388. kfree (urb->transfer_buffer);
  1389. dbg("%s - port %d", __FUNCTION__, port->number);
  1390. if (status) {
  1391. dbg("nonzero write bulk status received: %d", status);
  1392. return;
  1393. }
  1394. priv = usb_get_serial_port_data(port);
  1395. if (!priv) {
  1396. dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
  1397. return;
  1398. }
  1399. /* account for transferred data */
  1400. countback = urb->actual_length;
  1401. data_offset = priv->write_offset;
  1402. if (data_offset > 0) {
  1403. /* Subtract the control bytes */
  1404. countback -= (data_offset * ((countback + (PKTSZ - 1)) / PKTSZ));
  1405. }
  1406. spin_lock_irqsave(&priv->tx_lock, flags);
  1407. --priv->tx_outstanding_urbs;
  1408. priv->tx_outstanding_bytes -= countback;
  1409. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1410. usb_serial_port_softint(port);
  1411. } /* ftdi_write_bulk_callback */
  1412. static int ftdi_write_room( struct usb_serial_port *port )
  1413. {
  1414. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1415. int room;
  1416. unsigned long flags;
  1417. dbg("%s - port %d", __FUNCTION__, port->number);
  1418. spin_lock_irqsave(&priv->tx_lock, flags);
  1419. if (priv->tx_outstanding_urbs < URB_UPPER_LIMIT) {
  1420. /*
  1421. * We really can take anything the user throws at us
  1422. * but let's pick a nice big number to tell the tty
  1423. * layer that we have lots of free space
  1424. */
  1425. room = 2048;
  1426. } else {
  1427. room = 0;
  1428. }
  1429. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1430. return room;
  1431. } /* ftdi_write_room */
  1432. static int ftdi_chars_in_buffer (struct usb_serial_port *port)
  1433. { /* ftdi_chars_in_buffer */
  1434. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1435. int buffered;
  1436. unsigned long flags;
  1437. dbg("%s - port %d", __FUNCTION__, port->number);
  1438. spin_lock_irqsave(&priv->tx_lock, flags);
  1439. buffered = (int)priv->tx_outstanding_bytes;
  1440. spin_unlock_irqrestore(&priv->tx_lock, flags);
  1441. if (buffered < 0) {
  1442. err("%s outstanding tx bytes is negative!", __FUNCTION__);
  1443. buffered = 0;
  1444. }
  1445. return buffered;
  1446. } /* ftdi_chars_in_buffer */
  1447. static void ftdi_read_bulk_callback (struct urb *urb)
  1448. { /* ftdi_read_bulk_callback */
  1449. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  1450. struct tty_struct *tty;
  1451. struct ftdi_private *priv;
  1452. unsigned long countread;
  1453. unsigned long flags;
  1454. int status = urb->status;
  1455. if (urb->number_of_packets > 0) {
  1456. err("%s transfer_buffer_length %d actual_length %d number of packets %d",__FUNCTION__,
  1457. urb->transfer_buffer_length, urb->actual_length, urb->number_of_packets );
  1458. err("%s transfer_flags %x ", __FUNCTION__,urb->transfer_flags );
  1459. }
  1460. dbg("%s - port %d", __FUNCTION__, port->number);
  1461. if (port->open_count <= 0)
  1462. return;
  1463. tty = port->tty;
  1464. if (!tty) {
  1465. dbg("%s - bad tty pointer - exiting",__FUNCTION__);
  1466. return;
  1467. }
  1468. priv = usb_get_serial_port_data(port);
  1469. if (!priv) {
  1470. dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
  1471. return;
  1472. }
  1473. if (urb != port->read_urb) {
  1474. err("%s - Not my urb!", __FUNCTION__);
  1475. }
  1476. if (status) {
  1477. /* This will happen at close every time so it is a dbg not an err */
  1478. dbg("(this is ok on close) nonzero read bulk status received: "
  1479. "%d", status);
  1480. return;
  1481. }
  1482. /* count data bytes, but not status bytes */
  1483. countread = urb->actual_length;
  1484. countread -= 2 * ((countread + (PKTSZ - 1)) / PKTSZ);
  1485. spin_lock_irqsave(&priv->rx_lock, flags);
  1486. priv->rx_bytes += countread;
  1487. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1488. ftdi_process_read(&priv->rx_work.work);
  1489. } /* ftdi_read_bulk_callback */
  1490. static void ftdi_process_read (struct work_struct *work)
  1491. { /* ftdi_process_read */
  1492. struct ftdi_private *priv =
  1493. container_of(work, struct ftdi_private, rx_work.work);
  1494. struct usb_serial_port *port = priv->port;
  1495. struct urb *urb;
  1496. struct tty_struct *tty;
  1497. char error_flag;
  1498. unsigned char *data;
  1499. int i;
  1500. int result;
  1501. int need_flip;
  1502. int packet_offset;
  1503. unsigned long flags;
  1504. dbg("%s - port %d", __FUNCTION__, port->number);
  1505. if (port->open_count <= 0)
  1506. return;
  1507. tty = port->tty;
  1508. if (!tty) {
  1509. dbg("%s - bad tty pointer - exiting",__FUNCTION__);
  1510. return;
  1511. }
  1512. priv = usb_get_serial_port_data(port);
  1513. if (!priv) {
  1514. dbg("%s - bad port private data pointer - exiting", __FUNCTION__);
  1515. return;
  1516. }
  1517. urb = port->read_urb;
  1518. if (!urb) {
  1519. dbg("%s - bad read_urb pointer - exiting", __FUNCTION__);
  1520. return;
  1521. }
  1522. data = urb->transfer_buffer;
  1523. if (priv->rx_processed) {
  1524. dbg("%s - already processed: %d bytes, %d remain", __FUNCTION__,
  1525. priv->rx_processed,
  1526. urb->actual_length - priv->rx_processed);
  1527. } else {
  1528. /* The first two bytes of every read packet are status */
  1529. if (urb->actual_length > 2) {
  1530. usb_serial_debug_data(debug, &port->dev, __FUNCTION__, urb->actual_length, data);
  1531. } else {
  1532. dbg("Status only: %03oo %03oo",data[0],data[1]);
  1533. }
  1534. }
  1535. /* TO DO -- check for hung up line and handle appropriately: */
  1536. /* send hangup */
  1537. /* See acm.c - you do a tty_hangup - eg tty_hangup(tty) */
  1538. /* if CD is dropped and the line is not CLOCAL then we should hangup */
  1539. need_flip = 0;
  1540. for (packet_offset = priv->rx_processed; packet_offset < urb->actual_length; packet_offset += PKTSZ) {
  1541. int length;
  1542. /* Compare new line status to the old one, signal if different */
  1543. /* N.B. packet may be processed more than once, but differences
  1544. * are only processed once. */
  1545. if (priv != NULL) {
  1546. char new_status = data[packet_offset+0] & FTDI_STATUS_B0_MASK;
  1547. if (new_status != priv->prev_status) {
  1548. priv->diff_status |= new_status ^ priv->prev_status;
  1549. wake_up_interruptible(&priv->delta_msr_wait);
  1550. priv->prev_status = new_status;
  1551. }
  1552. }
  1553. length = min(PKTSZ, urb->actual_length-packet_offset)-2;
  1554. if (length < 0) {
  1555. err("%s - bad packet length: %d", __FUNCTION__, length+2);
  1556. length = 0;
  1557. }
  1558. if (priv->rx_flags & THROTTLED) {
  1559. dbg("%s - throttled", __FUNCTION__);
  1560. break;
  1561. }
  1562. if (tty_buffer_request_room(tty, length) < length) {
  1563. /* break out & wait for throttling/unthrottling to happen */
  1564. dbg("%s - receive room low", __FUNCTION__);
  1565. break;
  1566. }
  1567. /* Handle errors and break */
  1568. error_flag = TTY_NORMAL;
  1569. /* Although the device uses a bitmask and hence can have multiple */
  1570. /* errors on a packet - the order here sets the priority the */
  1571. /* error is returned to the tty layer */
  1572. if ( data[packet_offset+1] & FTDI_RS_OE ) {
  1573. error_flag = TTY_OVERRUN;
  1574. dbg("OVERRRUN error");
  1575. }
  1576. if ( data[packet_offset+1] & FTDI_RS_BI ) {
  1577. error_flag = TTY_BREAK;
  1578. dbg("BREAK received");
  1579. }
  1580. if ( data[packet_offset+1] & FTDI_RS_PE ) {
  1581. error_flag = TTY_PARITY;
  1582. dbg("PARITY error");
  1583. }
  1584. if ( data[packet_offset+1] & FTDI_RS_FE ) {
  1585. error_flag = TTY_FRAME;
  1586. dbg("FRAMING error");
  1587. }
  1588. if (length > 0) {
  1589. for (i = 2; i < length+2; i++) {
  1590. /* Note that the error flag is duplicated for
  1591. every character received since we don't know
  1592. which character it applied to */
  1593. tty_insert_flip_char(tty, data[packet_offset+i], error_flag);
  1594. }
  1595. need_flip = 1;
  1596. }
  1597. #ifdef NOT_CORRECT_BUT_KEEPING_IT_FOR_NOW
  1598. /* if a parity error is detected you get status packets forever
  1599. until a character is sent without a parity error.
  1600. This doesn't work well since the application receives a never
  1601. ending stream of bad data - even though new data hasn't been sent.
  1602. Therefore I (bill) have taken this out.
  1603. However - this might make sense for framing errors and so on
  1604. so I am leaving the code in for now.
  1605. */
  1606. else {
  1607. if (error_flag != TTY_NORMAL){
  1608. dbg("error_flag is not normal");
  1609. /* In this case it is just status - if that is an error send a bad character */
  1610. if(tty->flip.count >= TTY_FLIPBUF_SIZE) {
  1611. tty_flip_buffer_push(tty);
  1612. }
  1613. tty_insert_flip_char(tty, 0xff, error_flag);
  1614. need_flip = 1;
  1615. }
  1616. }
  1617. #endif
  1618. } /* "for(packet_offset=0..." */
  1619. /* Low latency */
  1620. if (need_flip) {
  1621. tty_flip_buffer_push(tty);
  1622. }
  1623. if (packet_offset < urb->actual_length) {
  1624. /* not completely processed - record progress */
  1625. priv->rx_processed = packet_offset;
  1626. dbg("%s - incomplete, %d bytes processed, %d remain",
  1627. __FUNCTION__, packet_offset,
  1628. urb->actual_length - packet_offset);
  1629. /* check if we were throttled while processing */
  1630. spin_lock_irqsave(&priv->rx_lock, flags);
  1631. if (priv->rx_flags & THROTTLED) {
  1632. priv->rx_flags |= ACTUALLY_THROTTLED;
  1633. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1634. dbg("%s - deferring remainder until unthrottled",
  1635. __FUNCTION__);
  1636. return;
  1637. }
  1638. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1639. /* if the port is closed stop trying to read */
  1640. if (port->open_count > 0){
  1641. /* delay processing of remainder */
  1642. schedule_delayed_work(&priv->rx_work, 1);
  1643. } else {
  1644. dbg("%s - port is closed", __FUNCTION__);
  1645. }
  1646. return;
  1647. }
  1648. /* urb is completely processed */
  1649. priv->rx_processed = 0;
  1650. /* if the port is closed stop trying to read */
  1651. if (port->open_count > 0){
  1652. /* Continue trying to always read */
  1653. usb_fill_bulk_urb(port->read_urb, port->serial->dev,
  1654. usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress),
  1655. port->read_urb->transfer_buffer, port->read_urb->transfer_buffer_length,
  1656. ftdi_read_bulk_callback, port);
  1657. result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
  1658. if (result)
  1659. err("%s - failed resubmitting read urb, error %d", __FUNCTION__, result);
  1660. }
  1661. return;
  1662. } /* ftdi_process_read */
  1663. static void ftdi_break_ctl( struct usb_serial_port *port, int break_state )
  1664. {
  1665. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1666. __u16 urb_value = 0;
  1667. char buf[1];
  1668. /* break_state = -1 to turn on break, and 0 to turn off break */
  1669. /* see drivers/char/tty_io.c to see it used */
  1670. /* last_set_data_urb_value NEVER has the break bit set in it */
  1671. if (break_state) {
  1672. urb_value = priv->last_set_data_urb_value | FTDI_SIO_SET_BREAK;
  1673. } else {
  1674. urb_value = priv->last_set_data_urb_value;
  1675. }
  1676. if (usb_control_msg(port->serial->dev, usb_sndctrlpipe(port->serial->dev, 0),
  1677. FTDI_SIO_SET_DATA_REQUEST,
  1678. FTDI_SIO_SET_DATA_REQUEST_TYPE,
  1679. urb_value , priv->interface,
  1680. buf, 0, WDR_TIMEOUT) < 0) {
  1681. err("%s FAILED to enable/disable break state (state was %d)", __FUNCTION__,break_state);
  1682. }
  1683. dbg("%s break state is %d - urb is %d", __FUNCTION__,break_state, urb_value);
  1684. }
  1685. /* old_termios contains the original termios settings and tty->termios contains
  1686. * the new setting to be used
  1687. * WARNING: set_termios calls this with old_termios in kernel space
  1688. */
  1689. static void ftdi_set_termios (struct usb_serial_port *port, struct ktermios *old_termios)
  1690. { /* ftdi_termios */
  1691. struct usb_device *dev = port->serial->dev;
  1692. unsigned int cflag = port->tty->termios->c_cflag;
  1693. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1694. __u16 urb_value; /* will hold the new flags */
  1695. char buf[1]; /* Perhaps I should dynamically alloc this? */
  1696. // Added for xon/xoff support
  1697. unsigned int iflag = port->tty->termios->c_iflag;
  1698. unsigned char vstop;
  1699. unsigned char vstart;
  1700. dbg("%s", __FUNCTION__);
  1701. /* Force baud rate if this device requires it, unless it is set to B0. */
  1702. if (priv->force_baud && ((port->tty->termios->c_cflag & CBAUD) != B0)) {
  1703. dbg("%s: forcing baud rate for this device", __FUNCTION__);
  1704. port->tty->termios->c_cflag &= ~CBAUD;
  1705. port->tty->termios->c_cflag |= priv->force_baud;
  1706. }
  1707. /* Force RTS-CTS if this device requires it. */
  1708. if (priv->force_rtscts) {
  1709. dbg("%s: forcing rtscts for this device", __FUNCTION__);
  1710. port->tty->termios->c_cflag |= CRTSCTS;
  1711. }
  1712. cflag = port->tty->termios->c_cflag;
  1713. /* FIXME -For this cut I don't care if the line is really changing or
  1714. not - so just do the change regardless - should be able to
  1715. compare old_termios and tty->termios */
  1716. /* NOTE These routines can get interrupted by
  1717. ftdi_sio_read_bulk_callback - need to examine what this
  1718. means - don't see any problems yet */
  1719. /* Set number of data bits, parity, stop bits */
  1720. urb_value = 0;
  1721. urb_value |= (cflag & CSTOPB ? FTDI_SIO_SET_DATA_STOP_BITS_2 :
  1722. FTDI_SIO_SET_DATA_STOP_BITS_1);
  1723. urb_value |= (cflag & PARENB ?
  1724. (cflag & PARODD ? FTDI_SIO_SET_DATA_PARITY_ODD :
  1725. FTDI_SIO_SET_DATA_PARITY_EVEN) :
  1726. FTDI_SIO_SET_DATA_PARITY_NONE);
  1727. if (cflag & CSIZE) {
  1728. switch (cflag & CSIZE) {
  1729. case CS5: urb_value |= 5; dbg("Setting CS5"); break;
  1730. case CS6: urb_value |= 6; dbg("Setting CS6"); break;
  1731. case CS7: urb_value |= 7; dbg("Setting CS7"); break;
  1732. case CS8: urb_value |= 8; dbg("Setting CS8"); break;
  1733. default:
  1734. err("CSIZE was set but not CS5-CS8");
  1735. }
  1736. }
  1737. /* This is needed by the break command since it uses the same command - but is
  1738. * or'ed with this value */
  1739. priv->last_set_data_urb_value = urb_value;
  1740. if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  1741. FTDI_SIO_SET_DATA_REQUEST,
  1742. FTDI_SIO_SET_DATA_REQUEST_TYPE,
  1743. urb_value , priv->interface,
  1744. buf, 0, WDR_SHORT_TIMEOUT) < 0) {
  1745. err("%s FAILED to set databits/stopbits/parity", __FUNCTION__);
  1746. }
  1747. /* Now do the baudrate */
  1748. if ((cflag & CBAUD) == B0 ) {
  1749. /* Disable flow control */
  1750. if (usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  1751. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1752. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1753. 0, priv->interface,
  1754. buf, 0, WDR_TIMEOUT) < 0) {
  1755. err("%s error from disable flowcontrol urb", __FUNCTION__);
  1756. }
  1757. /* Drop RTS and DTR */
  1758. clear_mctrl(port, TIOCM_DTR | TIOCM_RTS);
  1759. } else {
  1760. /* set the baudrate determined before */
  1761. if (change_speed(port)) {
  1762. err("%s urb failed to set baudrate", __FUNCTION__);
  1763. }
  1764. /* Ensure RTS and DTR are raised when baudrate changed from 0 */
  1765. if (!old_termios || (old_termios->c_cflag & CBAUD) == B0) {
  1766. set_mctrl(port, TIOCM_DTR | TIOCM_RTS);
  1767. }
  1768. }
  1769. /* Set flow control */
  1770. /* Note device also supports DTR/CD (ugh) and Xon/Xoff in hardware */
  1771. if (cflag & CRTSCTS) {
  1772. dbg("%s Setting to CRTSCTS flow control", __FUNCTION__);
  1773. if (usb_control_msg(dev,
  1774. usb_sndctrlpipe(dev, 0),
  1775. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1776. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1777. 0 , (FTDI_SIO_RTS_CTS_HS | priv->interface),
  1778. buf, 0, WDR_TIMEOUT) < 0) {
  1779. err("urb failed to set to rts/cts flow control");
  1780. }
  1781. } else {
  1782. /*
  1783. * Xon/Xoff code
  1784. *
  1785. * Check the IXOFF status in the iflag component of the termios structure
  1786. * if IXOFF is not set, the pre-xon/xoff code is executed.
  1787. */
  1788. if (iflag & IXOFF) {
  1789. dbg("%s request to enable xonxoff iflag=%04x",__FUNCTION__,iflag);
  1790. // Try to enable the XON/XOFF on the ftdi_sio
  1791. // Set the vstart and vstop -- could have been done up above where
  1792. // a lot of other dereferencing is done but that would be very
  1793. // inefficient as vstart and vstop are not always needed
  1794. vstart=port->tty->termios->c_cc[VSTART];
  1795. vstop=port->tty->termios->c_cc[VSTOP];
  1796. urb_value=(vstop << 8) | (vstart);
  1797. if (usb_control_msg(dev,
  1798. usb_sndctrlpipe(dev, 0),
  1799. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1800. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1801. urb_value , (FTDI_SIO_XON_XOFF_HS
  1802. | priv->interface),
  1803. buf, 0, WDR_TIMEOUT) < 0) {
  1804. err("urb failed to set to xon/xoff flow control");
  1805. }
  1806. } else {
  1807. /* else clause to only run if cfag ! CRTSCTS and iflag ! XOFF */
  1808. /* CHECKME Assuming XON/XOFF handled by tty stack - not by device */
  1809. dbg("%s Turning off hardware flow control", __FUNCTION__);
  1810. if (usb_control_msg(dev,
  1811. usb_sndctrlpipe(dev, 0),
  1812. FTDI_SIO_SET_FLOW_CTRL_REQUEST,
  1813. FTDI_SIO_SET_FLOW_CTRL_REQUEST_TYPE,
  1814. 0, priv->interface,
  1815. buf, 0, WDR_TIMEOUT) < 0) {
  1816. err("urb failed to clear flow control");
  1817. }
  1818. }
  1819. }
  1820. return;
  1821. } /* ftdi_termios */
  1822. static int ftdi_tiocmget (struct usb_serial_port *port, struct file *file)
  1823. {
  1824. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1825. unsigned char buf[2];
  1826. int ret;
  1827. dbg("%s TIOCMGET", __FUNCTION__);
  1828. switch (priv->chip_type) {
  1829. case SIO:
  1830. /* Request the status from the device */
  1831. if ((ret = usb_control_msg(port->serial->dev,
  1832. usb_rcvctrlpipe(port->serial->dev, 0),
  1833. FTDI_SIO_GET_MODEM_STATUS_REQUEST,
  1834. FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
  1835. 0, 0,
  1836. buf, 1, WDR_TIMEOUT)) < 0 ) {
  1837. err("%s Could not get modem status of device - err: %d", __FUNCTION__,
  1838. ret);
  1839. return(ret);
  1840. }
  1841. break;
  1842. case FT8U232AM:
  1843. case FT232BM:
  1844. case FT2232C:
  1845. /* the 8U232AM returns a two byte value (the sio is a 1 byte value) - in the same
  1846. format as the data returned from the in point */
  1847. if ((ret = usb_control_msg(port->serial->dev,
  1848. usb_rcvctrlpipe(port->serial->dev, 0),
  1849. FTDI_SIO_GET_MODEM_STATUS_REQUEST,
  1850. FTDI_SIO_GET_MODEM_STATUS_REQUEST_TYPE,
  1851. 0, priv->interface,
  1852. buf, 2, WDR_TIMEOUT)) < 0 ) {
  1853. err("%s Could not get modem status of device - err: %d", __FUNCTION__,
  1854. ret);
  1855. return(ret);
  1856. }
  1857. break;
  1858. default:
  1859. return -EFAULT;
  1860. break;
  1861. }
  1862. return (buf[0] & FTDI_SIO_DSR_MASK ? TIOCM_DSR : 0) |
  1863. (buf[0] & FTDI_SIO_CTS_MASK ? TIOCM_CTS : 0) |
  1864. (buf[0] & FTDI_SIO_RI_MASK ? TIOCM_RI : 0) |
  1865. (buf[0] & FTDI_SIO_RLSD_MASK ? TIOCM_CD : 0) |
  1866. priv->last_dtr_rts;
  1867. }
  1868. static int ftdi_tiocmset(struct usb_serial_port *port, struct file * file, unsigned int set, unsigned int clear)
  1869. {
  1870. dbg("%s TIOCMSET", __FUNCTION__);
  1871. return update_mctrl(port, set, clear);
  1872. }
  1873. static int ftdi_ioctl (struct usb_serial_port *port, struct file * file, unsigned int cmd, unsigned long arg)
  1874. {
  1875. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1876. dbg("%s cmd 0x%04x", __FUNCTION__, cmd);
  1877. /* Based on code from acm.c and others */
  1878. switch (cmd) {
  1879. case TIOCGSERIAL: /* gets serial port data */
  1880. return get_serial_info(port, (struct serial_struct __user *) arg);
  1881. case TIOCSSERIAL: /* sets serial port data */
  1882. return set_serial_info(port, (struct serial_struct __user *) arg);
  1883. /*
  1884. * Wait for any of the 4 modem inputs (DCD,RI,DSR,CTS) to change
  1885. * - mask passed in arg for lines of interest
  1886. * (use |'ed TIOCM_RNG/DSR/CD/CTS for masking)
  1887. * Caller should use TIOCGICOUNT to see which one it was.
  1888. *
  1889. * This code is borrowed from linux/drivers/char/serial.c
  1890. */
  1891. case TIOCMIWAIT:
  1892. while (priv != NULL) {
  1893. interruptible_sleep_on(&priv->delta_msr_wait);
  1894. /* see if a signal did it */
  1895. if (signal_pending(current))
  1896. return -ERESTARTSYS;
  1897. else {
  1898. char diff = priv->diff_status;
  1899. if (diff == 0) {
  1900. return -EIO; /* no change => error */
  1901. }
  1902. /* Consume all events */
  1903. priv->diff_status = 0;
  1904. /* Return 0 if caller wanted to know about these bits */
  1905. if ( ((arg & TIOCM_RNG) && (diff & FTDI_RS0_RI)) ||
  1906. ((arg & TIOCM_DSR) && (diff & FTDI_RS0_DSR)) ||
  1907. ((arg & TIOCM_CD) && (diff & FTDI_RS0_RLSD)) ||
  1908. ((arg & TIOCM_CTS) && (diff & FTDI_RS0_CTS)) ) {
  1909. return 0;
  1910. }
  1911. /*
  1912. * Otherwise caller can't care less about what happened,
  1913. * and so we continue to wait for more events.
  1914. */
  1915. }
  1916. }
  1917. return(0);
  1918. break;
  1919. default:
  1920. break;
  1921. }
  1922. /* This is not necessarily an error - turns out the higher layers will do
  1923. * some ioctls itself (see comment above)
  1924. */
  1925. dbg("%s arg not supported - it was 0x%04x - check /usr/include/asm/ioctls.h", __FUNCTION__, cmd);
  1926. return(-ENOIOCTLCMD);
  1927. } /* ftdi_ioctl */
  1928. static void ftdi_throttle (struct usb_serial_port *port)
  1929. {
  1930. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1931. unsigned long flags;
  1932. dbg("%s - port %d", __FUNCTION__, port->number);
  1933. spin_lock_irqsave(&priv->rx_lock, flags);
  1934. priv->rx_flags |= THROTTLED;
  1935. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1936. }
  1937. static void ftdi_unthrottle (struct usb_serial_port *port)
  1938. {
  1939. struct ftdi_private *priv = usb_get_serial_port_data(port);
  1940. int actually_throttled;
  1941. unsigned long flags;
  1942. dbg("%s - port %d", __FUNCTION__, port->number);
  1943. spin_lock_irqsave(&priv->rx_lock, flags);
  1944. actually_throttled = priv->rx_flags & ACTUALLY_THROTTLED;
  1945. priv->rx_flags &= ~(THROTTLED | ACTUALLY_THROTTLED);
  1946. spin_unlock_irqrestore(&priv->rx_lock, flags);
  1947. if (actually_throttled)
  1948. schedule_delayed_work(&priv->rx_work, 0);
  1949. }
  1950. static int __init ftdi_init (void)
  1951. {
  1952. int retval;
  1953. dbg("%s", __FUNCTION__);
  1954. if (vendor > 0 && product > 0) {
  1955. /* Add user specified VID/PID to reserved element of table. */
  1956. int i;
  1957. for (i = 0; id_table_combined[i].idVendor; i++)
  1958. ;
  1959. id_table_combined[i].match_flags = USB_DEVICE_ID_MATCH_DEVICE;
  1960. id_table_combined[i].idVendor = vendor;
  1961. id_table_combined[i].idProduct = product;
  1962. }
  1963. retval = usb_serial_register(&ftdi_sio_device);
  1964. if (retval)
  1965. goto failed_sio_register;
  1966. retval = usb_register(&ftdi_driver);
  1967. if (retval)
  1968. goto failed_usb_register;
  1969. info(DRIVER_VERSION ":" DRIVER_DESC);
  1970. return 0;
  1971. failed_usb_register:
  1972. usb_serial_deregister(&ftdi_sio_device);
  1973. failed_sio_register:
  1974. return retval;
  1975. }
  1976. static void __exit ftdi_exit (void)
  1977. {
  1978. dbg("%s", __FUNCTION__);
  1979. usb_deregister (&ftdi_driver);
  1980. usb_serial_deregister (&ftdi_sio_device);
  1981. }
  1982. module_init(ftdi_init);
  1983. module_exit(ftdi_exit);
  1984. MODULE_AUTHOR( DRIVER_AUTHOR );
  1985. MODULE_DESCRIPTION( DRIVER_DESC );
  1986. MODULE_LICENSE("GPL");
  1987. module_param(debug, bool, S_IRUGO | S_IWUSR);
  1988. MODULE_PARM_DESC(debug, "Debug enabled or not");
  1989. module_param(vendor, ushort, 0);
  1990. MODULE_PARM_DESC(vendor, "User specified vendor ID (default="
  1991. __MODULE_STRING(FTDI_VID)")");
  1992. module_param(product, ushort, 0);
  1993. MODULE_PARM_DESC(vendor, "User specified product ID");