pl2303.c 27 KB

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