pl2303.c 28 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042
  1. /*
  2. * Prolific PL2303 USB to serial adaptor driver
  3. *
  4. * Copyright (C) 2001-2007 Greg Kroah-Hartman (greg@kroah.com)
  5. * Copyright (C) 2003 IBM Corp.
  6. *
  7. * Original driver for 2.2.x by anonymous
  8. *
  9. * This program is free software; you can redistribute it and/or
  10. * modify it under the terms of the GNU General Public License version
  11. * 2 as published by the Free Software Foundation.
  12. *
  13. * See Documentation/usb/usb-serial.txt for more information on using this
  14. * driver
  15. */
  16. #include <linux/kernel.h>
  17. #include <linux/errno.h>
  18. #include <linux/slab.h>
  19. #include <linux/tty.h>
  20. #include <linux/tty_driver.h>
  21. #include <linux/tty_flip.h>
  22. #include <linux/serial.h>
  23. #include <linux/module.h>
  24. #include <linux/moduleparam.h>
  25. #include <linux/spinlock.h>
  26. #include <linux/uaccess.h>
  27. #include <linux/usb.h>
  28. #include <linux/usb/serial.h>
  29. #include <asm/unaligned.h>
  30. #include "pl2303.h"
  31. #define PL2303_QUIRK_UART_STATE_IDX0 BIT(0)
  32. #define PL2303_QUIRK_LEGACY BIT(1)
  33. #define PL2303_QUIRK_ENDPOINT_HACK BIT(2)
  34. static const struct usb_device_id id_table[] = {
  35. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID),
  36. .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  37. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ2) },
  38. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_DCU11) },
  39. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_RSAQ3) },
  40. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_CHILITAG) },
  41. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_PHAROS) },
  42. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ALDIGA) },
  43. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MMX) },
  44. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_GPRS) },
  45. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_HCR331) },
  46. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_MOTOROLA) },
  47. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_ZTEK) },
  48. { USB_DEVICE(PL2303_VENDOR_ID, PL2303_PRODUCT_ID_TB) },
  49. { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID) },
  50. { USB_DEVICE(IODATA_VENDOR_ID, IODATA_PRODUCT_ID_RSAQ5) },
  51. { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID),
  52. .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  53. { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC485),
  54. .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  55. { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_UC232B),
  56. .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  57. { USB_DEVICE(ATEN_VENDOR_ID, ATEN_PRODUCT_ID2) },
  58. { USB_DEVICE(ATEN_VENDOR_ID2, ATEN_PRODUCT_ID) },
  59. { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID) },
  60. { USB_DEVICE(ELCOM_VENDOR_ID, ELCOM_PRODUCT_ID_UCSGT) },
  61. { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID) },
  62. { USB_DEVICE(ITEGNO_VENDOR_ID, ITEGNO_PRODUCT_ID_2080) },
  63. { USB_DEVICE(MA620_VENDOR_ID, MA620_PRODUCT_ID) },
  64. { USB_DEVICE(RATOC_VENDOR_ID, RATOC_PRODUCT_ID) },
  65. { USB_DEVICE(TRIPP_VENDOR_ID, TRIPP_PRODUCT_ID) },
  66. { USB_DEVICE(RADIOSHACK_VENDOR_ID, RADIOSHACK_PRODUCT_ID) },
  67. { USB_DEVICE(DCU10_VENDOR_ID, DCU10_PRODUCT_ID) },
  68. { USB_DEVICE(SITECOM_VENDOR_ID, SITECOM_PRODUCT_ID) },
  69. { USB_DEVICE(ALCATEL_VENDOR_ID, ALCATEL_PRODUCT_ID) },
  70. { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_SX1),
  71. .driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
  72. { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X65),
  73. .driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
  74. { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_X75),
  75. .driver_info = PL2303_QUIRK_UART_STATE_IDX0 },
  76. { USB_DEVICE(SIEMENS_VENDOR_ID, SIEMENS_PRODUCT_ID_EF81),
  77. .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  78. { USB_DEVICE(BENQ_VENDOR_ID, BENQ_PRODUCT_ID_S81) }, /* Benq/Siemens S81 */
  79. { USB_DEVICE(SYNTECH_VENDOR_ID, SYNTECH_PRODUCT_ID) },
  80. { USB_DEVICE(NOKIA_CA42_VENDOR_ID, NOKIA_CA42_PRODUCT_ID) },
  81. { USB_DEVICE(CA_42_CA42_VENDOR_ID, CA_42_CA42_PRODUCT_ID) },
  82. { USB_DEVICE(SAGEM_VENDOR_ID, SAGEM_PRODUCT_ID) },
  83. { USB_DEVICE(LEADTEK_VENDOR_ID, LEADTEK_9531_PRODUCT_ID) },
  84. { USB_DEVICE(SPEEDDRAGON_VENDOR_ID, SPEEDDRAGON_PRODUCT_ID) },
  85. { USB_DEVICE(DATAPILOT_U2_VENDOR_ID, DATAPILOT_U2_PRODUCT_ID) },
  86. { USB_DEVICE(BELKIN_VENDOR_ID, BELKIN_PRODUCT_ID) },
  87. { USB_DEVICE(ALCOR_VENDOR_ID, ALCOR_PRODUCT_ID),
  88. .driver_info = PL2303_QUIRK_ENDPOINT_HACK },
  89. { USB_DEVICE(WS002IN_VENDOR_ID, WS002IN_PRODUCT_ID) },
  90. { USB_DEVICE(COREGA_VENDOR_ID, COREGA_PRODUCT_ID) },
  91. { USB_DEVICE(YCCABLE_VENDOR_ID, YCCABLE_PRODUCT_ID) },
  92. { USB_DEVICE(SUPERIAL_VENDOR_ID, SUPERIAL_PRODUCT_ID) },
  93. { USB_DEVICE(HP_VENDOR_ID, HP_LD220_PRODUCT_ID) },
  94. { USB_DEVICE(HP_VENDOR_ID, HP_LD220TA_PRODUCT_ID) },
  95. { USB_DEVICE(HP_VENDOR_ID, HP_LD381_PRODUCT_ID) },
  96. { USB_DEVICE(HP_VENDOR_ID, HP_LD381GC_PRODUCT_ID) },
  97. { USB_DEVICE(HP_VENDOR_ID, HP_LD960_PRODUCT_ID) },
  98. { USB_DEVICE(HP_VENDOR_ID, HP_LD960TA_PRODUCT_ID) },
  99. { USB_DEVICE(HP_VENDOR_ID, HP_LCM220_PRODUCT_ID) },
  100. { USB_DEVICE(HP_VENDOR_ID, HP_LCM960_PRODUCT_ID) },
  101. { USB_DEVICE(HP_VENDOR_ID, HP_LM920_PRODUCT_ID) },
  102. { USB_DEVICE(HP_VENDOR_ID, HP_LM940_PRODUCT_ID) },
  103. { USB_DEVICE(HP_VENDOR_ID, HP_TD620_PRODUCT_ID) },
  104. { USB_DEVICE(CRESSI_VENDOR_ID, CRESSI_EDY_PRODUCT_ID) },
  105. { USB_DEVICE(ZEAGLE_VENDOR_ID, ZEAGLE_N2ITION3_PRODUCT_ID) },
  106. { USB_DEVICE(SONY_VENDOR_ID, SONY_QN3USB_PRODUCT_ID) },
  107. { USB_DEVICE(SANWA_VENDOR_ID, SANWA_PRODUCT_ID) },
  108. { USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530_PRODUCT_ID) },
  109. { USB_DEVICE(ADLINK_VENDOR_ID, ADLINK_ND6530GC_PRODUCT_ID) },
  110. { USB_DEVICE(SMART_VENDOR_ID, SMART_PRODUCT_ID) },
  111. { USB_DEVICE(AT_VENDOR_ID, AT_VTKIT3_PRODUCT_ID) },
  112. { } /* Terminating entry */
  113. };
  114. MODULE_DEVICE_TABLE(usb, id_table);
  115. #define SET_LINE_REQUEST_TYPE 0x21
  116. #define SET_LINE_REQUEST 0x20
  117. #define SET_CONTROL_REQUEST_TYPE 0x21
  118. #define SET_CONTROL_REQUEST 0x22
  119. #define CONTROL_DTR 0x01
  120. #define CONTROL_RTS 0x02
  121. #define BREAK_REQUEST_TYPE 0x21
  122. #define BREAK_REQUEST 0x23
  123. #define BREAK_ON 0xffff
  124. #define BREAK_OFF 0x0000
  125. #define GET_LINE_REQUEST_TYPE 0xa1
  126. #define GET_LINE_REQUEST 0x21
  127. #define VENDOR_WRITE_REQUEST_TYPE 0x40
  128. #define VENDOR_WRITE_REQUEST 0x01
  129. #define VENDOR_READ_REQUEST_TYPE 0xc0
  130. #define VENDOR_READ_REQUEST 0x01
  131. #define UART_STATE_INDEX 8
  132. #define UART_STATE_MSR_MASK 0x8b
  133. #define UART_STATE_TRANSIENT_MASK 0x74
  134. #define UART_DCD 0x01
  135. #define UART_DSR 0x02
  136. #define UART_BREAK_ERROR 0x04
  137. #define UART_RING 0x08
  138. #define UART_FRAME_ERROR 0x10
  139. #define UART_PARITY_ERROR 0x20
  140. #define UART_OVERRUN_ERROR 0x40
  141. #define UART_CTS 0x80
  142. static void pl2303_set_break(struct usb_serial_port *port, bool enable);
  143. enum pl2303_type {
  144. TYPE_01, /* Type 0 and 1 (difference unknown) */
  145. TYPE_HX, /* HX version of the pl2303 chip */
  146. TYPE_COUNT
  147. };
  148. struct pl2303_type_data {
  149. speed_t max_baud_rate;
  150. unsigned long quirks;
  151. };
  152. struct pl2303_serial_private {
  153. const struct pl2303_type_data *type;
  154. unsigned long quirks;
  155. };
  156. struct pl2303_private {
  157. spinlock_t lock;
  158. u8 line_control;
  159. u8 line_status;
  160. u8 line_settings[7];
  161. };
  162. static const struct pl2303_type_data pl2303_type_data[TYPE_COUNT] = {
  163. [TYPE_01] = {
  164. .max_baud_rate = 1228800,
  165. .quirks = PL2303_QUIRK_LEGACY,
  166. },
  167. [TYPE_HX] = {
  168. .max_baud_rate = 12000000,
  169. },
  170. };
  171. static int pl2303_vendor_read(struct usb_serial *serial, u16 value,
  172. unsigned char buf[1])
  173. {
  174. struct device *dev = &serial->interface->dev;
  175. int res;
  176. res = usb_control_msg(serial->dev, usb_rcvctrlpipe(serial->dev, 0),
  177. VENDOR_READ_REQUEST, VENDOR_READ_REQUEST_TYPE,
  178. value, 0, buf, 1, 100);
  179. if (res != 1) {
  180. dev_err(dev, "%s - failed to read [%04x]: %d\n", __func__,
  181. value, res);
  182. if (res >= 0)
  183. res = -EIO;
  184. return res;
  185. }
  186. dev_dbg(dev, "%s - [%04x] = %02x\n", __func__, value, buf[0]);
  187. return 0;
  188. }
  189. static int pl2303_vendor_write(struct usb_serial *serial, u16 value, u16 index)
  190. {
  191. struct device *dev = &serial->interface->dev;
  192. int res;
  193. dev_dbg(dev, "%s - [%04x] = %02x\n", __func__, value, index);
  194. res = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
  195. VENDOR_WRITE_REQUEST, VENDOR_WRITE_REQUEST_TYPE,
  196. value, index, NULL, 0, 100);
  197. if (res) {
  198. dev_err(dev, "%s - failed to write [%04x]: %d\n", __func__,
  199. value, res);
  200. return res;
  201. }
  202. return 0;
  203. }
  204. static int pl2303_probe(struct usb_serial *serial,
  205. const struct usb_device_id *id)
  206. {
  207. usb_set_serial_data(serial, (void *)id->driver_info);
  208. return 0;
  209. }
  210. /*
  211. * Use interrupt endpoint from first interface if available.
  212. *
  213. * This is needed due to the looney way its endpoints are set up.
  214. */
  215. static int pl2303_endpoint_hack(struct usb_serial *serial,
  216. struct usb_serial_endpoints *epds)
  217. {
  218. struct usb_interface *interface = serial->interface;
  219. struct usb_device *dev = serial->dev;
  220. struct device *ddev = &interface->dev;
  221. struct usb_host_interface *iface_desc;
  222. struct usb_endpoint_descriptor *endpoint;
  223. unsigned int i;
  224. if (interface == dev->actconfig->interface[0])
  225. return 0;
  226. /* check out the endpoints of the other interface */
  227. iface_desc = dev->actconfig->interface[0]->cur_altsetting;
  228. for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
  229. endpoint = &iface_desc->endpoint[i].desc;
  230. if (!usb_endpoint_is_int_in(endpoint))
  231. continue;
  232. dev_dbg(ddev, "found interrupt in on separate interface\n");
  233. if (epds->num_interrupt_in < ARRAY_SIZE(epds->interrupt_in))
  234. epds->interrupt_in[epds->num_interrupt_in++] = endpoint;
  235. }
  236. return 0;
  237. }
  238. static int pl2303_calc_num_ports(struct usb_serial *serial,
  239. struct usb_serial_endpoints *epds)
  240. {
  241. unsigned long quirks = (unsigned long)usb_get_serial_data(serial);
  242. struct device *dev = &serial->interface->dev;
  243. int ret;
  244. if (quirks & PL2303_QUIRK_ENDPOINT_HACK) {
  245. ret = pl2303_endpoint_hack(serial, epds);
  246. if (ret)
  247. return ret;
  248. }
  249. if (epds->num_interrupt_in < 1) {
  250. dev_err(dev, "required interrupt-in endpoint missing\n");
  251. return -ENODEV;
  252. }
  253. return 1;
  254. }
  255. static int pl2303_startup(struct usb_serial *serial)
  256. {
  257. struct pl2303_serial_private *spriv;
  258. enum pl2303_type type = TYPE_01;
  259. unsigned char *buf;
  260. spriv = kzalloc(sizeof(*spriv), GFP_KERNEL);
  261. if (!spriv)
  262. return -ENOMEM;
  263. buf = kmalloc(1, GFP_KERNEL);
  264. if (!buf) {
  265. kfree(spriv);
  266. return -ENOMEM;
  267. }
  268. if (serial->dev->descriptor.bDeviceClass == 0x02)
  269. type = TYPE_01; /* type 0 */
  270. else if (serial->dev->descriptor.bMaxPacketSize0 == 0x40)
  271. type = TYPE_HX;
  272. else if (serial->dev->descriptor.bDeviceClass == 0x00)
  273. type = TYPE_01; /* type 1 */
  274. else if (serial->dev->descriptor.bDeviceClass == 0xFF)
  275. type = TYPE_01; /* type 1 */
  276. dev_dbg(&serial->interface->dev, "device type: %d\n", type);
  277. spriv->type = &pl2303_type_data[type];
  278. spriv->quirks = (unsigned long)usb_get_serial_data(serial);
  279. spriv->quirks |= spriv->type->quirks;
  280. usb_set_serial_data(serial, spriv);
  281. pl2303_vendor_read(serial, 0x8484, buf);
  282. pl2303_vendor_write(serial, 0x0404, 0);
  283. pl2303_vendor_read(serial, 0x8484, buf);
  284. pl2303_vendor_read(serial, 0x8383, buf);
  285. pl2303_vendor_read(serial, 0x8484, buf);
  286. pl2303_vendor_write(serial, 0x0404, 1);
  287. pl2303_vendor_read(serial, 0x8484, buf);
  288. pl2303_vendor_read(serial, 0x8383, buf);
  289. pl2303_vendor_write(serial, 0, 1);
  290. pl2303_vendor_write(serial, 1, 0);
  291. if (spriv->quirks & PL2303_QUIRK_LEGACY)
  292. pl2303_vendor_write(serial, 2, 0x24);
  293. else
  294. pl2303_vendor_write(serial, 2, 0x44);
  295. kfree(buf);
  296. return 0;
  297. }
  298. static void pl2303_release(struct usb_serial *serial)
  299. {
  300. struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
  301. kfree(spriv);
  302. }
  303. static int pl2303_port_probe(struct usb_serial_port *port)
  304. {
  305. struct pl2303_private *priv;
  306. priv = kzalloc(sizeof(*priv), GFP_KERNEL);
  307. if (!priv)
  308. return -ENOMEM;
  309. spin_lock_init(&priv->lock);
  310. usb_set_serial_port_data(port, priv);
  311. port->port.drain_delay = 256;
  312. return 0;
  313. }
  314. static int pl2303_port_remove(struct usb_serial_port *port)
  315. {
  316. struct pl2303_private *priv = usb_get_serial_port_data(port);
  317. kfree(priv);
  318. return 0;
  319. }
  320. static int pl2303_set_control_lines(struct usb_serial_port *port, u8 value)
  321. {
  322. struct usb_device *dev = port->serial->dev;
  323. int retval;
  324. dev_dbg(&port->dev, "%s - %02x\n", __func__, value);
  325. retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
  326. SET_CONTROL_REQUEST, SET_CONTROL_REQUEST_TYPE,
  327. value, 0, NULL, 0, 100);
  328. if (retval)
  329. dev_err(&port->dev, "%s - failed: %d\n", __func__, retval);
  330. return retval;
  331. }
  332. /*
  333. * Returns the nearest supported baud rate that can be set directly without
  334. * using divisors.
  335. */
  336. static speed_t pl2303_get_supported_baud_rate(speed_t baud)
  337. {
  338. static const speed_t baud_sup[] = {
  339. 75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600,
  340. 14400, 19200, 28800, 38400, 57600, 115200, 230400, 460800,
  341. 614400, 921600, 1228800, 2457600, 3000000, 6000000
  342. };
  343. unsigned i;
  344. for (i = 0; i < ARRAY_SIZE(baud_sup); ++i) {
  345. if (baud_sup[i] > baud)
  346. break;
  347. }
  348. if (i == ARRAY_SIZE(baud_sup))
  349. baud = baud_sup[i - 1];
  350. else if (i > 0 && (baud_sup[i] - baud) > (baud - baud_sup[i - 1]))
  351. baud = baud_sup[i - 1];
  352. else
  353. baud = baud_sup[i];
  354. return baud;
  355. }
  356. /*
  357. * NOTE: If unsupported baud rates are set directly, the PL2303 seems to
  358. * use 9600 baud.
  359. */
  360. static speed_t pl2303_encode_baud_rate_direct(unsigned char buf[4],
  361. speed_t baud)
  362. {
  363. put_unaligned_le32(baud, buf);
  364. return baud;
  365. }
  366. static speed_t pl2303_encode_baud_rate_divisor(unsigned char buf[4],
  367. speed_t baud)
  368. {
  369. unsigned int baseline, mantissa, exponent;
  370. /*
  371. * Apparently the formula is:
  372. * baudrate = 12M * 32 / (mantissa * 4^exponent)
  373. * where
  374. * mantissa = buf[8:0]
  375. * exponent = buf[11:9]
  376. */
  377. baseline = 12000000 * 32;
  378. mantissa = baseline / baud;
  379. if (mantissa == 0)
  380. mantissa = 1; /* Avoid dividing by zero if baud > 32*12M. */
  381. exponent = 0;
  382. while (mantissa >= 512) {
  383. if (exponent < 7) {
  384. mantissa >>= 2; /* divide by 4 */
  385. exponent++;
  386. } else {
  387. /* Exponent is maxed. Trim mantissa and leave. */
  388. mantissa = 511;
  389. break;
  390. }
  391. }
  392. buf[3] = 0x80;
  393. buf[2] = 0;
  394. buf[1] = exponent << 1 | mantissa >> 8;
  395. buf[0] = mantissa & 0xff;
  396. /* Calculate and return the exact baud rate. */
  397. baud = (baseline / mantissa) >> (exponent << 1);
  398. return baud;
  399. }
  400. static void pl2303_encode_baud_rate(struct tty_struct *tty,
  401. struct usb_serial_port *port,
  402. u8 buf[4])
  403. {
  404. struct usb_serial *serial = port->serial;
  405. struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
  406. speed_t baud_sup;
  407. speed_t baud;
  408. baud = tty_get_baud_rate(tty);
  409. dev_dbg(&port->dev, "baud requested = %u\n", baud);
  410. if (!baud)
  411. return;
  412. if (spriv->type->max_baud_rate)
  413. baud = min_t(speed_t, baud, spriv->type->max_baud_rate);
  414. /*
  415. * Use direct method for supported baud rates, otherwise use divisors.
  416. */
  417. baud_sup = pl2303_get_supported_baud_rate(baud);
  418. if (baud == baud_sup)
  419. baud = pl2303_encode_baud_rate_direct(buf, baud);
  420. else
  421. baud = pl2303_encode_baud_rate_divisor(buf, baud);
  422. /* Save resulting baud rate */
  423. tty_encode_baud_rate(tty, baud, baud);
  424. dev_dbg(&port->dev, "baud set = %u\n", baud);
  425. }
  426. static int pl2303_get_line_request(struct usb_serial_port *port,
  427. unsigned char buf[7])
  428. {
  429. struct usb_device *udev = port->serial->dev;
  430. int ret;
  431. ret = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
  432. GET_LINE_REQUEST, GET_LINE_REQUEST_TYPE,
  433. 0, 0, buf, 7, 100);
  434. if (ret != 7) {
  435. dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
  436. if (ret >= 0)
  437. ret = -EIO;
  438. return ret;
  439. }
  440. dev_dbg(&port->dev, "%s - %7ph\n", __func__, buf);
  441. return 0;
  442. }
  443. static int pl2303_set_line_request(struct usb_serial_port *port,
  444. unsigned char buf[7])
  445. {
  446. struct usb_device *udev = port->serial->dev;
  447. int ret;
  448. ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
  449. SET_LINE_REQUEST, SET_LINE_REQUEST_TYPE,
  450. 0, 0, buf, 7, 100);
  451. if (ret < 0) {
  452. dev_err(&port->dev, "%s - failed: %d\n", __func__, ret);
  453. return ret;
  454. }
  455. dev_dbg(&port->dev, "%s - %7ph\n", __func__, buf);
  456. return 0;
  457. }
  458. static void pl2303_set_termios(struct tty_struct *tty,
  459. struct usb_serial_port *port, struct ktermios *old_termios)
  460. {
  461. struct usb_serial *serial = port->serial;
  462. struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
  463. struct pl2303_private *priv = usb_get_serial_port_data(port);
  464. unsigned long flags;
  465. unsigned char *buf;
  466. int ret;
  467. u8 control;
  468. if (old_termios && !tty_termios_hw_change(&tty->termios, old_termios))
  469. return;
  470. buf = kzalloc(7, GFP_KERNEL);
  471. if (!buf) {
  472. /* Report back no change occurred */
  473. if (old_termios)
  474. tty->termios = *old_termios;
  475. return;
  476. }
  477. pl2303_get_line_request(port, buf);
  478. switch (C_CSIZE(tty)) {
  479. case CS5:
  480. buf[6] = 5;
  481. break;
  482. case CS6:
  483. buf[6] = 6;
  484. break;
  485. case CS7:
  486. buf[6] = 7;
  487. break;
  488. default:
  489. case CS8:
  490. buf[6] = 8;
  491. }
  492. dev_dbg(&port->dev, "data bits = %d\n", buf[6]);
  493. /* For reference buf[0]:buf[3] baud rate value */
  494. pl2303_encode_baud_rate(tty, port, &buf[0]);
  495. /* For reference buf[4]=0 is 1 stop bits */
  496. /* For reference buf[4]=1 is 1.5 stop bits */
  497. /* For reference buf[4]=2 is 2 stop bits */
  498. if (C_CSTOPB(tty)) {
  499. /*
  500. * NOTE: Comply with "real" UARTs / RS232:
  501. * use 1.5 instead of 2 stop bits with 5 data bits
  502. */
  503. if (C_CSIZE(tty) == CS5) {
  504. buf[4] = 1;
  505. dev_dbg(&port->dev, "stop bits = 1.5\n");
  506. } else {
  507. buf[4] = 2;
  508. dev_dbg(&port->dev, "stop bits = 2\n");
  509. }
  510. } else {
  511. buf[4] = 0;
  512. dev_dbg(&port->dev, "stop bits = 1\n");
  513. }
  514. if (C_PARENB(tty)) {
  515. /* For reference buf[5]=0 is none parity */
  516. /* For reference buf[5]=1 is odd parity */
  517. /* For reference buf[5]=2 is even parity */
  518. /* For reference buf[5]=3 is mark parity */
  519. /* For reference buf[5]=4 is space parity */
  520. if (C_PARODD(tty)) {
  521. if (C_CMSPAR(tty)) {
  522. buf[5] = 3;
  523. dev_dbg(&port->dev, "parity = mark\n");
  524. } else {
  525. buf[5] = 1;
  526. dev_dbg(&port->dev, "parity = odd\n");
  527. }
  528. } else {
  529. if (C_CMSPAR(tty)) {
  530. buf[5] = 4;
  531. dev_dbg(&port->dev, "parity = space\n");
  532. } else {
  533. buf[5] = 2;
  534. dev_dbg(&port->dev, "parity = even\n");
  535. }
  536. }
  537. } else {
  538. buf[5] = 0;
  539. dev_dbg(&port->dev, "parity = none\n");
  540. }
  541. /*
  542. * Some PL2303 are known to lose bytes if you change serial settings
  543. * even to the same values as before. Thus we actually need to filter
  544. * in this specific case.
  545. *
  546. * Note that the tty_termios_hw_change check above is not sufficient
  547. * as a previously requested baud rate may differ from the one
  548. * actually used (and stored in old_termios).
  549. *
  550. * NOTE: No additional locking needed for line_settings as it is
  551. * only used in set_termios, which is serialised against itself.
  552. */
  553. if (!old_termios || memcmp(buf, priv->line_settings, 7)) {
  554. ret = pl2303_set_line_request(port, buf);
  555. if (!ret)
  556. memcpy(priv->line_settings, buf, 7);
  557. }
  558. /* change control lines if we are switching to or from B0 */
  559. spin_lock_irqsave(&priv->lock, flags);
  560. control = priv->line_control;
  561. if (C_BAUD(tty) == B0)
  562. priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
  563. else if (old_termios && (old_termios->c_cflag & CBAUD) == B0)
  564. priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
  565. if (control != priv->line_control) {
  566. control = priv->line_control;
  567. spin_unlock_irqrestore(&priv->lock, flags);
  568. pl2303_set_control_lines(port, control);
  569. } else {
  570. spin_unlock_irqrestore(&priv->lock, flags);
  571. }
  572. if (C_CRTSCTS(tty)) {
  573. if (spriv->quirks & PL2303_QUIRK_LEGACY)
  574. pl2303_vendor_write(serial, 0x0, 0x41);
  575. else
  576. pl2303_vendor_write(serial, 0x0, 0x61);
  577. } else {
  578. pl2303_vendor_write(serial, 0x0, 0x0);
  579. }
  580. kfree(buf);
  581. }
  582. static void pl2303_dtr_rts(struct usb_serial_port *port, int on)
  583. {
  584. struct pl2303_private *priv = usb_get_serial_port_data(port);
  585. unsigned long flags;
  586. u8 control;
  587. spin_lock_irqsave(&priv->lock, flags);
  588. if (on)
  589. priv->line_control |= (CONTROL_DTR | CONTROL_RTS);
  590. else
  591. priv->line_control &= ~(CONTROL_DTR | CONTROL_RTS);
  592. control = priv->line_control;
  593. spin_unlock_irqrestore(&priv->lock, flags);
  594. pl2303_set_control_lines(port, control);
  595. }
  596. static void pl2303_close(struct usb_serial_port *port)
  597. {
  598. usb_serial_generic_close(port);
  599. usb_kill_urb(port->interrupt_in_urb);
  600. pl2303_set_break(port, false);
  601. }
  602. static int pl2303_open(struct tty_struct *tty, struct usb_serial_port *port)
  603. {
  604. struct usb_serial *serial = port->serial;
  605. struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
  606. int result;
  607. if (spriv->quirks & PL2303_QUIRK_LEGACY) {
  608. usb_clear_halt(serial->dev, port->write_urb->pipe);
  609. usb_clear_halt(serial->dev, port->read_urb->pipe);
  610. } else {
  611. /* reset upstream data pipes */
  612. pl2303_vendor_write(serial, 8, 0);
  613. pl2303_vendor_write(serial, 9, 0);
  614. }
  615. /* Setup termios */
  616. if (tty)
  617. pl2303_set_termios(tty, port, NULL);
  618. result = usb_submit_urb(port->interrupt_in_urb, GFP_KERNEL);
  619. if (result) {
  620. dev_err(&port->dev, "failed to submit interrupt urb: %d\n",
  621. result);
  622. return result;
  623. }
  624. result = usb_serial_generic_open(tty, port);
  625. if (result) {
  626. usb_kill_urb(port->interrupt_in_urb);
  627. return result;
  628. }
  629. return 0;
  630. }
  631. static int pl2303_tiocmset(struct tty_struct *tty,
  632. unsigned int set, unsigned int clear)
  633. {
  634. struct usb_serial_port *port = tty->driver_data;
  635. struct pl2303_private *priv = usb_get_serial_port_data(port);
  636. unsigned long flags;
  637. u8 control;
  638. int ret;
  639. spin_lock_irqsave(&priv->lock, flags);
  640. if (set & TIOCM_RTS)
  641. priv->line_control |= CONTROL_RTS;
  642. if (set & TIOCM_DTR)
  643. priv->line_control |= CONTROL_DTR;
  644. if (clear & TIOCM_RTS)
  645. priv->line_control &= ~CONTROL_RTS;
  646. if (clear & TIOCM_DTR)
  647. priv->line_control &= ~CONTROL_DTR;
  648. control = priv->line_control;
  649. spin_unlock_irqrestore(&priv->lock, flags);
  650. ret = pl2303_set_control_lines(port, control);
  651. if (ret)
  652. return usb_translate_errors(ret);
  653. return 0;
  654. }
  655. static int pl2303_tiocmget(struct tty_struct *tty)
  656. {
  657. struct usb_serial_port *port = tty->driver_data;
  658. struct pl2303_private *priv = usb_get_serial_port_data(port);
  659. unsigned long flags;
  660. unsigned int mcr;
  661. unsigned int status;
  662. unsigned int result;
  663. spin_lock_irqsave(&priv->lock, flags);
  664. mcr = priv->line_control;
  665. status = priv->line_status;
  666. spin_unlock_irqrestore(&priv->lock, flags);
  667. result = ((mcr & CONTROL_DTR) ? TIOCM_DTR : 0)
  668. | ((mcr & CONTROL_RTS) ? TIOCM_RTS : 0)
  669. | ((status & UART_CTS) ? TIOCM_CTS : 0)
  670. | ((status & UART_DSR) ? TIOCM_DSR : 0)
  671. | ((status & UART_RING) ? TIOCM_RI : 0)
  672. | ((status & UART_DCD) ? TIOCM_CD : 0);
  673. dev_dbg(&port->dev, "%s - result = %x\n", __func__, result);
  674. return result;
  675. }
  676. static int pl2303_carrier_raised(struct usb_serial_port *port)
  677. {
  678. struct pl2303_private *priv = usb_get_serial_port_data(port);
  679. if (priv->line_status & UART_DCD)
  680. return 1;
  681. return 0;
  682. }
  683. static int pl2303_ioctl(struct tty_struct *tty,
  684. unsigned int cmd, unsigned long arg)
  685. {
  686. struct serial_struct ser;
  687. struct usb_serial_port *port = tty->driver_data;
  688. switch (cmd) {
  689. case TIOCGSERIAL:
  690. memset(&ser, 0, sizeof ser);
  691. ser.type = PORT_16654;
  692. ser.line = port->minor;
  693. ser.port = port->port_number;
  694. ser.baud_base = 460800;
  695. if (copy_to_user((void __user *)arg, &ser, sizeof ser))
  696. return -EFAULT;
  697. return 0;
  698. default:
  699. break;
  700. }
  701. return -ENOIOCTLCMD;
  702. }
  703. static void pl2303_set_break(struct usb_serial_port *port, bool enable)
  704. {
  705. struct usb_serial *serial = port->serial;
  706. u16 state;
  707. int result;
  708. if (enable)
  709. state = BREAK_ON;
  710. else
  711. state = BREAK_OFF;
  712. dev_dbg(&port->dev, "%s - turning break %s\n", __func__,
  713. state == BREAK_OFF ? "off" : "on");
  714. result = usb_control_msg(serial->dev, usb_sndctrlpipe(serial->dev, 0),
  715. BREAK_REQUEST, BREAK_REQUEST_TYPE, state,
  716. 0, NULL, 0, 100);
  717. if (result)
  718. dev_err(&port->dev, "error sending break = %d\n", result);
  719. }
  720. static void pl2303_break_ctl(struct tty_struct *tty, int state)
  721. {
  722. struct usb_serial_port *port = tty->driver_data;
  723. pl2303_set_break(port, state);
  724. }
  725. static void pl2303_update_line_status(struct usb_serial_port *port,
  726. unsigned char *data,
  727. unsigned int actual_length)
  728. {
  729. struct usb_serial *serial = port->serial;
  730. struct pl2303_serial_private *spriv = usb_get_serial_data(serial);
  731. struct pl2303_private *priv = usb_get_serial_port_data(port);
  732. struct tty_struct *tty;
  733. unsigned long flags;
  734. unsigned int status_idx = UART_STATE_INDEX;
  735. u8 status;
  736. u8 delta;
  737. if (spriv->quirks & PL2303_QUIRK_UART_STATE_IDX0)
  738. status_idx = 0;
  739. if (actual_length < status_idx + 1)
  740. return;
  741. status = data[status_idx];
  742. /* Save off the uart status for others to look at */
  743. spin_lock_irqsave(&priv->lock, flags);
  744. delta = priv->line_status ^ status;
  745. priv->line_status = status;
  746. spin_unlock_irqrestore(&priv->lock, flags);
  747. if (status & UART_BREAK_ERROR)
  748. usb_serial_handle_break(port);
  749. if (delta & UART_STATE_MSR_MASK) {
  750. if (delta & UART_CTS)
  751. port->icount.cts++;
  752. if (delta & UART_DSR)
  753. port->icount.dsr++;
  754. if (delta & UART_RING)
  755. port->icount.rng++;
  756. if (delta & UART_DCD) {
  757. port->icount.dcd++;
  758. tty = tty_port_tty_get(&port->port);
  759. if (tty) {
  760. usb_serial_handle_dcd_change(port, tty,
  761. status & UART_DCD);
  762. tty_kref_put(tty);
  763. }
  764. }
  765. wake_up_interruptible(&port->port.delta_msr_wait);
  766. }
  767. }
  768. static void pl2303_read_int_callback(struct urb *urb)
  769. {
  770. struct usb_serial_port *port = urb->context;
  771. unsigned char *data = urb->transfer_buffer;
  772. unsigned int actual_length = urb->actual_length;
  773. int status = urb->status;
  774. int retval;
  775. switch (status) {
  776. case 0:
  777. /* success */
  778. break;
  779. case -ECONNRESET:
  780. case -ENOENT:
  781. case -ESHUTDOWN:
  782. /* this urb is terminated, clean up */
  783. dev_dbg(&port->dev, "%s - urb shutting down with status: %d\n",
  784. __func__, status);
  785. return;
  786. default:
  787. dev_dbg(&port->dev, "%s - nonzero urb status received: %d\n",
  788. __func__, status);
  789. goto exit;
  790. }
  791. usb_serial_debug_data(&port->dev, __func__,
  792. urb->actual_length, urb->transfer_buffer);
  793. pl2303_update_line_status(port, data, actual_length);
  794. exit:
  795. retval = usb_submit_urb(urb, GFP_ATOMIC);
  796. if (retval) {
  797. dev_err(&port->dev,
  798. "%s - usb_submit_urb failed with result %d\n",
  799. __func__, retval);
  800. }
  801. }
  802. static void pl2303_process_read_urb(struct urb *urb)
  803. {
  804. struct usb_serial_port *port = urb->context;
  805. struct pl2303_private *priv = usb_get_serial_port_data(port);
  806. unsigned char *data = urb->transfer_buffer;
  807. char tty_flag = TTY_NORMAL;
  808. unsigned long flags;
  809. u8 line_status;
  810. int i;
  811. /* update line status */
  812. spin_lock_irqsave(&priv->lock, flags);
  813. line_status = priv->line_status;
  814. priv->line_status &= ~UART_STATE_TRANSIENT_MASK;
  815. spin_unlock_irqrestore(&priv->lock, flags);
  816. if (!urb->actual_length)
  817. return;
  818. /*
  819. * Break takes precedence over parity, which takes precedence over
  820. * framing errors.
  821. */
  822. if (line_status & UART_BREAK_ERROR)
  823. tty_flag = TTY_BREAK;
  824. else if (line_status & UART_PARITY_ERROR)
  825. tty_flag = TTY_PARITY;
  826. else if (line_status & UART_FRAME_ERROR)
  827. tty_flag = TTY_FRAME;
  828. if (tty_flag != TTY_NORMAL)
  829. dev_dbg(&port->dev, "%s - tty_flag = %d\n", __func__,
  830. tty_flag);
  831. /* overrun is special, not associated with a char */
  832. if (line_status & UART_OVERRUN_ERROR)
  833. tty_insert_flip_char(&port->port, 0, TTY_OVERRUN);
  834. if (port->port.console && port->sysrq) {
  835. for (i = 0; i < urb->actual_length; ++i)
  836. if (!usb_serial_handle_sysrq_char(port, data[i]))
  837. tty_insert_flip_char(&port->port, data[i],
  838. tty_flag);
  839. } else {
  840. tty_insert_flip_string_fixed_flag(&port->port, data, tty_flag,
  841. urb->actual_length);
  842. }
  843. tty_flip_buffer_push(&port->port);
  844. }
  845. static struct usb_serial_driver pl2303_device = {
  846. .driver = {
  847. .owner = THIS_MODULE,
  848. .name = "pl2303",
  849. },
  850. .id_table = id_table,
  851. .num_bulk_in = 1,
  852. .num_bulk_out = 1,
  853. .num_interrupt_in = 0, /* see pl2303_calc_num_ports */
  854. .bulk_in_size = 256,
  855. .bulk_out_size = 256,
  856. .open = pl2303_open,
  857. .close = pl2303_close,
  858. .dtr_rts = pl2303_dtr_rts,
  859. .carrier_raised = pl2303_carrier_raised,
  860. .ioctl = pl2303_ioctl,
  861. .break_ctl = pl2303_break_ctl,
  862. .set_termios = pl2303_set_termios,
  863. .tiocmget = pl2303_tiocmget,
  864. .tiocmset = pl2303_tiocmset,
  865. .tiocmiwait = usb_serial_generic_tiocmiwait,
  866. .process_read_urb = pl2303_process_read_urb,
  867. .read_int_callback = pl2303_read_int_callback,
  868. .probe = pl2303_probe,
  869. .calc_num_ports = pl2303_calc_num_ports,
  870. .attach = pl2303_startup,
  871. .release = pl2303_release,
  872. .port_probe = pl2303_port_probe,
  873. .port_remove = pl2303_port_remove,
  874. };
  875. static struct usb_serial_driver * const serial_drivers[] = {
  876. &pl2303_device, NULL
  877. };
  878. module_usb_serial_driver(serial_drivers, id_table);
  879. MODULE_DESCRIPTION("Prolific PL2303 USB to serial adaptor driver");
  880. MODULE_LICENSE("GPL");