ir-usb.c
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:17k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

  1. /*
  2.  * USB IR Dongle driver
  3.  *
  4.  * Copyright (C) 2001-2002 Greg Kroah-Hartman (greg@kroah.com)
  5.  * Copyright (C) 2002 Gary Brubaker (xavyer@ix.netcom.com)
  6.  *
  7.  * This program is free software; you can redistribute it and/or modify
  8.  * it under the terms of the GNU General Public License as published by
  9.  * the Free Software Foundation; either version 2 of the License, or
  10.  * (at your option) any later version.
  11.  *
  12.  * This driver allows a USB IrDA device to be used as a "dumb" serial device.
  13.  * This can be useful if you do not have access to a full IrDA stack on the
  14.  * other side of the connection.  If you do have an IrDA stack on both devices,
  15.  * please use the usb-irda driver, as it contains the proper error checking and
  16.  * other goodness of a full IrDA stack.
  17.  *
  18.  * Portions of this driver were taken from drivers/net/irda/irda-usb.c, which
  19.  * was written by Roman Weissgaerber <weissg@vienna.at>, Dag Brattli
  20.  * <dag@brattli.net>, and Jean Tourrilhes <jt@hpl.hp.com>
  21.  *
  22.  * See Documentation/usb/usb-serial.txt for more information on using this driver
  23.  *
  24.  * 2002_Mar_07 greg kh
  25.  * moved some needed structures and #define values from the
  26.  * net/irda/irda-usb.h file into our file, as we don't want to depend on
  27.  * that codebase compiling correctly :)
  28.  *
  29.  * 2002_Jan_14  gb
  30.  * Added module parameter to force specific number of XBOFs.
  31.  * Added ir_xbof_change().
  32.  * Reorganized read_bulk_callback error handling.
  33.  * Switched from FILL_BULK_URB() to usb_fill_bulk_urb().
  34.  *
  35.  * 2001_Nov_08  greg kh
  36.  * Changed the irda_usb_find_class_desc() function based on comments and
  37.  * code from Martin Diehl.
  38.  *
  39.  * 2001_Nov_01 greg kh
  40.  * Added support for more IrDA USB devices.
  41.  * Added support for zero packet.  Added buffer override paramater, so
  42.  * users can transfer larger packets at once if they wish.  Both patches
  43.  * came from Dag Brattli <dag@obexcode.com>.
  44.  *
  45.  * 2001_Oct_07 greg kh
  46.  * initial version released.
  47.  */
  48. #include <linux/config.h>
  49. #include <linux/kernel.h>
  50. #include <linux/errno.h>
  51. #include <linux/init.h>
  52. #include <linux/slab.h>
  53. #include <linux/tty.h>
  54. #include <linux/tty_driver.h>
  55. #include <linux/tty_flip.h>
  56. #include <linux/module.h>
  57. #include <linux/spinlock.h>
  58. #include <asm/uaccess.h>
  59. #include <linux/usb.h>
  60. #ifdef CONFIG_USB_SERIAL_DEBUG
  61. static int debug = 1;
  62. #else
  63. static int debug;
  64. #endif
  65. #include "usb-serial.h"
  66. /*
  67.  * Version Information
  68.  */
  69. #define DRIVER_VERSION "v0.4"
  70. #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>"
  71. #define DRIVER_DESC "USB IR Dongle driver"
  72. /* USB IrDA class spec information */
  73. #define USB_CLASS_IRDA 0x02
  74. #define USB_DT_IRDA 0x21
  75. #define IU_REQ_GET_CLASS_DESC 0x06
  76. #define SPEED_2400 0x01
  77. #define SPEED_9600 0x02
  78. #define SPEED_19200 0x03
  79. #define SPEED_38400 0x04
  80. #define SPEED_57600 0x05
  81. #define SPEED_115200 0x06
  82. #define SPEED_576000 0x07
  83. #define SPEED_1152000 0x08
  84. #define SPEED_4000000 0x09
  85. struct irda_class_desc {
  86. u8 bLength;
  87. u8 bDescriptorType;
  88. u16 bcdSpecRevision;
  89. u8 bmDataSize;
  90. u8 bmWindowSize;
  91. u8 bmMinTurnaroundTime;
  92. u16 wBaudRate;
  93. u8 bmAdditionalBOFs;
  94. u8 bIrdaRateSniff;
  95. u8 bMaxUnicastList;
  96. } __attribute__ ((packed));
  97. /* if overridden by the user, then use their value for the size of the read and
  98.  * write urbs */
  99. static int buffer_size = 0;
  100. /* if overridden by the user, then use the specified number of XBOFs */
  101. static int xbof = -1;
  102. static int  ir_startup (struct usb_serial *serial);
  103. static int  ir_open (struct usb_serial_port *port, struct file *filep);
  104. static void ir_close (struct usb_serial_port *port, struct file *filep);
  105. static int  ir_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count);
  106. static void ir_write_bulk_callback (struct urb *urb);
  107. static void ir_read_bulk_callback (struct urb *urb);
  108. static void ir_set_termios (struct usb_serial_port *port, struct termios *old_termios);
  109. static u8 ir_baud = 0;
  110. static u8 ir_xbof = 0;
  111. static u8 ir_add_bof = 0;
  112. static struct usb_device_id id_table [] = {
  113. { USB_DEVICE(0x050f, 0x0180) }, /* KC Technology, KC-180 */
  114. { USB_DEVICE(0x08e9, 0x0100) }, /* XTNDAccess */
  115. { USB_DEVICE(0x09c4, 0x0011) }, /* ACTiSys ACT-IR2000U */
  116. { USB_INTERFACE_INFO (USB_CLASS_APP_SPEC, USB_CLASS_IRDA, 0) },
  117. { } /* Terminating entry */
  118. };
  119. MODULE_DEVICE_TABLE (usb, id_table);
  120. struct usb_serial_device_type ir_device = {
  121. .owner = THIS_MODULE,
  122. .name = "IR Dongle",
  123. .id_table = id_table,
  124. .num_interrupt_in = 1,
  125. .num_bulk_in = 1,
  126. .num_bulk_out = 1,
  127. .num_ports = 1,
  128. .set_termios = ir_set_termios,
  129. .startup = ir_startup,
  130. .open = ir_open,
  131. .close = ir_close,
  132. .write = ir_write,
  133. .write_bulk_callback = ir_write_bulk_callback,
  134. .read_bulk_callback = ir_read_bulk_callback,
  135. };
  136. static inline void irda_usb_dump_class_desc(struct irda_class_desc *desc)
  137. {
  138. dbg("bLength=%x", desc->bLength);
  139. dbg("bDescriptorType=%x", desc->bDescriptorType);
  140. dbg("bcdSpecRevision=%x", desc->bcdSpecRevision); 
  141. dbg("bmDataSize=%x", desc->bmDataSize);
  142. dbg("bmWindowSize=%x", desc->bmWindowSize);
  143. dbg("bmMinTurnaroundTime=%d", desc->bmMinTurnaroundTime);
  144. dbg("wBaudRate=%x", desc->wBaudRate);
  145. dbg("bmAdditionalBOFs=%x", desc->bmAdditionalBOFs);
  146. dbg("bIrdaRateSniff=%x", desc->bIrdaRateSniff);
  147. dbg("bMaxUnicastList=%x", desc->bMaxUnicastList);
  148. }
  149. /*------------------------------------------------------------------*/
  150. /*
  151.  * Function irda_usb_find_class_desc(dev, ifnum)
  152.  *
  153.  *    Returns instance of IrDA class descriptor, or NULL if not found
  154.  *
  155.  * The class descriptor is some extra info that IrDA USB devices will
  156.  * offer to us, describing their IrDA characteristics. We will use that in
  157.  * irda_usb_init_qos()
  158.  *
  159.  * Based on the same function in drivers/net/irda/irda-usb.c
  160.  */
  161. static struct irda_class_desc *irda_usb_find_class_desc(struct usb_device *dev, unsigned int ifnum)
  162. {
  163. struct irda_class_desc *desc;
  164. int ret;
  165. desc = kmalloc(sizeof (struct irda_class_desc), GFP_KERNEL);
  166. if (desc == NULL) 
  167. return NULL;
  168. memset(desc, 0, sizeof(struct irda_class_desc));
  169. ret = usb_control_msg(dev, usb_rcvctrlpipe(dev,0),
  170. IU_REQ_GET_CLASS_DESC,
  171. USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  172. 0, ifnum, desc, sizeof(*desc), HZ);
  173. dbg("%s -  ret=%d", __FUNCTION__, ret);
  174. if (ret < sizeof(*desc)) {
  175. dbg("%s - class descriptor read %s (%d)",
  176. __FUNCTION__, 
  177. (ret<0) ? "failed" : "too short",
  178. ret);
  179. goto error;
  180. }
  181. if (desc->bDescriptorType != USB_DT_IRDA) {
  182. dbg("%s - bad class descriptor type", __FUNCTION__);
  183. goto error;
  184. }
  185. irda_usb_dump_class_desc(desc);
  186. return desc;
  187. error:
  188. kfree(desc);
  189. return NULL;
  190. }
  191. static u8 ir_xbof_change(u8 xbof)
  192. {
  193. u8 result;
  194. /* reference irda-usb.c */
  195. switch(xbof) {
  196. case 48: result = 0x10; break;
  197. case 28:
  198. case 24: result = 0x20; break;
  199. default:
  200. case 12: result = 0x30; break;
  201. case  5:
  202. case  6: result = 0x40; break;
  203. case  3: result = 0x50; break;
  204. case  2: result = 0x60; break;
  205. case  1: result = 0x70; break;
  206. case  0: result = 0x80; break;
  207. }
  208. return(result);
  209. }
  210. static int ir_startup (struct usb_serial *serial)
  211. {
  212. struct irda_class_desc *irda_desc;
  213. irda_desc = irda_usb_find_class_desc (serial->dev, 0);
  214. if (irda_desc == NULL) {
  215. err ("IRDA class descriptor not found, device not bound");
  216. return -ENODEV;
  217. }
  218. dbg ("%s - Baud rates supported:%s%s%s%s%s%s%s%s%s",
  219. __FUNCTION__,
  220. (irda_desc->wBaudRate & 0x0001) ? " 2400"    : "",
  221. (irda_desc->wBaudRate & 0x0002) ? " 9600"    : "",
  222. (irda_desc->wBaudRate & 0x0004) ? " 19200"   : "",
  223. (irda_desc->wBaudRate & 0x0008) ? " 38400"   : "",
  224. (irda_desc->wBaudRate & 0x0010) ? " 57600"   : "",
  225. (irda_desc->wBaudRate & 0x0020) ? " 115200"  : "",
  226. (irda_desc->wBaudRate & 0x0040) ? " 576000"  : "",
  227. (irda_desc->wBaudRate & 0x0080) ? " 1152000" : "",
  228. (irda_desc->wBaudRate & 0x0100) ? " 4000000" : "");
  229. switch( irda_desc->bmAdditionalBOFs ) {
  230. case 0x01: ir_add_bof = 48; break;
  231. case 0x02: ir_add_bof = 24; break;
  232. case 0x04: ir_add_bof = 12; break;
  233. case 0x08: ir_add_bof =  6; break;
  234. case 0x10: ir_add_bof =  3; break;
  235. case 0x20: ir_add_bof =  2; break;
  236. case 0x40: ir_add_bof =  1; break;
  237. case 0x80: ir_add_bof =  0; break;
  238. default:;
  239. }
  240. kfree (irda_desc);
  241. return 0;
  242. }
  243. static int ir_open (struct usb_serial_port *port, struct file *filp)
  244. {
  245. struct usb_serial *serial = port->serial;
  246. char *buffer;
  247. int result = 0;
  248. if (port_paranoia_check (port, __FUNCTION__))
  249. return -ENODEV;
  250. dbg("%s - port %d", __FUNCTION__, port->number);
  251. if (buffer_size) {
  252. /* override the default buffer sizes */
  253. buffer = kmalloc (buffer_size, GFP_KERNEL);
  254. if (!buffer) {
  255. err ("%s - out of memory.", __FUNCTION__);
  256. return -ENOMEM;
  257. }
  258. kfree (port->read_urb->transfer_buffer);
  259. port->read_urb->transfer_buffer = buffer;
  260. port->read_urb->transfer_buffer_length = buffer_size;
  261. buffer = kmalloc (buffer_size, GFP_KERNEL);
  262. if (!buffer) {
  263. err ("%s - out of memory.", __FUNCTION__);
  264. return -ENOMEM;
  265. }
  266. kfree (port->write_urb->transfer_buffer);
  267. port->write_urb->transfer_buffer = buffer;
  268. port->write_urb->transfer_buffer_length = buffer_size;
  269. port->bulk_out_size = buffer_size;
  270. }
  271. /* Start reading from the device */
  272. usb_fill_bulk_urb (
  273. port->read_urb,
  274. serial->dev, 
  275. usb_rcvbulkpipe(serial->dev, port->bulk_in_endpointAddress),
  276. port->read_urb->transfer_buffer,
  277. port->read_urb->transfer_buffer_length,
  278. ir_read_bulk_callback,
  279. port);
  280. port->read_urb->transfer_flags = USB_QUEUE_BULK;
  281. result = usb_submit_urb(port->read_urb);
  282. if (result)
  283. err("%s - failed submitting read urb, error %d", __FUNCTION__, result);
  284. return result;
  285. }
  286. static void ir_close (struct usb_serial_port *port, struct file * filp)
  287. {
  288. struct usb_serial *serial;
  289. if (port_paranoia_check (port, __FUNCTION__))
  290. return;
  291. dbg("%s - port %d", __FUNCTION__, port->number);
  292.  
  293. serial = get_usb_serial (port, __FUNCTION__);
  294. if (!serial)
  295. return;
  296. if (serial->dev) {
  297. /* shutdown our bulk read */
  298. usb_unlink_urb (port->read_urb);
  299. }
  300. }
  301. static int ir_write (struct usb_serial_port *port, int from_user, const unsigned char *buf, int count)
  302. {
  303. unsigned char *transfer_buffer;
  304. int result;
  305. int transfer_size;
  306. dbg("%s - port = %d, count = %d", __FUNCTION__, port->number, count);
  307. if (!port->tty) {
  308. err ("%s - no tty???", __FUNCTION__);
  309. return 0;
  310. }
  311. if (count == 0)
  312. return 0;
  313. if (port->write_urb->status == -EINPROGRESS) {
  314. dbg ("%s - already writing", __FUNCTION__);
  315. return 0;
  316. }
  317. transfer_buffer = port->write_urb->transfer_buffer;
  318. transfer_size = min(count, port->bulk_out_size - 1);
  319. /*
  320.  * The first byte of the packet we send to the device contains an
  321.  * inband header which indicates an additional number of BOFs and
  322.  * a baud rate change.
  323.  *
  324.  * See section 5.4.2.2 of the USB IrDA spec.
  325.  */
  326. *transfer_buffer = ir_xbof | ir_baud;
  327. ++transfer_buffer;
  328. if (from_user) {
  329. if (copy_from_user (transfer_buffer, buf, transfer_size))
  330. return -EFAULT;
  331. } else {
  332. memcpy (transfer_buffer, buf, transfer_size);
  333. }
  334. usb_fill_bulk_urb (
  335. port->write_urb,
  336. port->serial->dev,
  337. usb_sndbulkpipe(port->serial->dev,
  338. port->bulk_out_endpointAddress),
  339. port->write_urb->transfer_buffer,
  340. transfer_size + 1,
  341. ir_write_bulk_callback,
  342. port);
  343. port->write_urb->transfer_flags
  344. = USB_QUEUE_BULK
  345. | USB_ZERO_PACKET;
  346. result = usb_submit_urb (port->write_urb);
  347. if (result)
  348. err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
  349. else
  350. result = transfer_size;
  351. return result;
  352. }
  353. static void ir_write_bulk_callback (struct urb *urb)
  354. {
  355. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  356. if (port_paranoia_check (port, __FUNCTION__))
  357. return;
  358. dbg("%s - port %d", __FUNCTION__, port->number);
  359. if (urb->status) {
  360. dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status);
  361. return;
  362. }
  363. usb_serial_debug_data (
  364. __FILE__,
  365. __FUNCTION__,
  366. urb->actual_length,
  367. urb->transfer_buffer);
  368. queue_task(&port->tqueue, &tq_immediate);
  369. mark_bh(IMMEDIATE_BH);
  370. return;
  371. }
  372. static void ir_read_bulk_callback (struct urb *urb)
  373. {
  374. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  375. struct usb_serial *serial = get_usb_serial (port, __FUNCTION__);
  376. struct tty_struct *tty;
  377. unsigned char *data = urb->transfer_buffer;
  378. int result;
  379. if (port_paranoia_check (port, __FUNCTION__))
  380. return;
  381. dbg("%s - port %d", __FUNCTION__, port->number);
  382. if (!serial) {
  383. dbg("%s - bad serial pointer, exiting", __FUNCTION__);
  384. return;
  385. }
  386. if (!port->open_count) {
  387. dbg("%s - port closed.", __FUNCTION__);
  388. return;
  389. }
  390. switch (urb->status) {
  391. case 0: /* Successful */
  392. /*
  393.  * The first byte of the packet we get from the device
  394.  * contains a busy indicator and baud rate change.
  395.  * See section 5.4.1.2 of the USB IrDA spec.
  396.  */
  397. if((*data & 0x0f) > 0) ir_baud = *data & 0x0f;
  398. usb_serial_debug_data (
  399. __FILE__,
  400. __FUNCTION__,
  401. urb->actual_length,
  402. data);
  403. /*
  404.  * Bypass flip-buffers, and feed the ldisc directly
  405.  * due to our potentally large buffer size.  Since we
  406.  * used to set low_latency, this is exactly what the
  407.  * tty layer did anyway :)
  408.  */
  409. tty = port->tty;
  410. tty->ldisc.receive_buf(
  411. tty,
  412. data+1,
  413. NULL,
  414. urb->actual_length-1);
  415. /*
  416.  * No break here.
  417.  * We want to resubmit the urb so we can read
  418.  * again.
  419.  */
  420. case -EPROTO: /* taking inspiration from pl2303.c */
  421. /* Continue trying to always read */
  422. usb_fill_bulk_urb (
  423. port->read_urb,
  424. serial->dev, 
  425. usb_rcvbulkpipe(serial->dev,
  426. port->bulk_in_endpointAddress),
  427. port->read_urb->transfer_buffer,
  428. port->read_urb->transfer_buffer_length,
  429. ir_read_bulk_callback,
  430. port);
  431. port->read_urb->transfer_flags = USB_QUEUE_BULK;
  432. result = usb_submit_urb(port->read_urb);
  433. if (result)
  434. err("%s - failed resubmitting read urb, error %d",
  435. __FUNCTION__, 
  436. result);
  437. break ;
  438. default:
  439. dbg("%s - nonzero read bulk status received: %d",
  440. __FUNCTION__, 
  441. urb->status);
  442. break ;
  443. }
  444. return;
  445. }
  446. static void ir_set_termios (struct usb_serial_port *port, struct termios *old_termios)
  447. {
  448. unsigned char *transfer_buffer;
  449. unsigned int cflag;
  450. int result;
  451. dbg("%s - port %d", __FUNCTION__, port->number);
  452. if ((!port->tty) || (!port->tty->termios)) {
  453. dbg("%s - no tty structures", __FUNCTION__);
  454. return;
  455. }
  456. cflag = port->tty->termios->c_cflag;
  457. /* check that they really want us to change something */
  458. if (old_termios) {
  459. if ((cflag == old_termios->c_cflag) &&
  460.     (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) {
  461. dbg("%s - nothing to change...", __FUNCTION__);
  462. return;
  463. }
  464. }
  465. /* All we can change is the baud rate */
  466. if (cflag & CBAUD) {
  467. dbg ("%s - asking for baud %d",
  468. __FUNCTION__,
  469. tty_get_baud_rate(port->tty));
  470. /* 
  471.  * FIXME, we should compare the baud request against the
  472.  * capability stated in the IR header that we got in the
  473.  * startup funtion.
  474.  */
  475. switch (cflag & CBAUD) {
  476. case B2400:    ir_baud = SPEED_2400;    break;
  477. default:
  478. case B9600:    ir_baud = SPEED_9600;    break;
  479. case B19200:   ir_baud = SPEED_19200;   break;
  480. case B38400:   ir_baud = SPEED_38400;   break;
  481. case B57600:   ir_baud = SPEED_57600;   break;
  482. case B115200:  ir_baud = SPEED_115200;  break;
  483. case B576000:  ir_baud = SPEED_576000;  break;
  484. case B1152000: ir_baud = SPEED_1152000; break;
  485. case B4000000: ir_baud = SPEED_4000000; break;
  486. }
  487. if (xbof == -1) {
  488. ir_xbof = ir_xbof_change(ir_add_bof);
  489. } else {
  490. ir_xbof = ir_xbof_change(xbof) ;
  491. }
  492. /* Notify the tty driver that the termios have changed. */
  493. port->tty->ldisc.set_termios(port->tty, NULL);
  494. /* FIXME need to check to see if our write urb is busy right
  495.  * now, or use a urb pool.
  496.  *
  497.  * send the baud change out on an "empty" data packet
  498.  */
  499. transfer_buffer = port->write_urb->transfer_buffer;
  500. *transfer_buffer = ir_xbof | ir_baud;
  501. usb_fill_bulk_urb (
  502. port->write_urb,
  503. port->serial->dev,
  504. usb_sndbulkpipe(port->serial->dev,
  505. port->bulk_out_endpointAddress),
  506. port->write_urb->transfer_buffer,
  507. 1,
  508. ir_write_bulk_callback,
  509. port);
  510. port->write_urb->transfer_flags
  511. = USB_QUEUE_BULK
  512. | USB_ZERO_PACKET;
  513. result = usb_submit_urb (port->write_urb);
  514. if (result)
  515. err("%s - failed submitting write urb, error %d", __FUNCTION__, result);
  516. }
  517. return;
  518. }
  519. static int __init ir_init (void)
  520. {
  521. usb_serial_register (&ir_device);
  522. info(DRIVER_DESC " " DRIVER_VERSION);
  523. return 0;
  524. }
  525. static void __exit ir_exit (void)
  526. {
  527. usb_serial_deregister (&ir_device);
  528. }
  529. module_init(ir_init);
  530. module_exit(ir_exit);
  531. MODULE_AUTHOR(DRIVER_AUTHOR);
  532. MODULE_DESCRIPTION(DRIVER_DESC);
  533. MODULE_LICENSE("GPL");
  534. MODULE_PARM(debug, "i");
  535. MODULE_PARM_DESC(debug, "Debug enabled or not");
  536. MODULE_PARM(xbof, "i");
  537. MODULE_PARM_DESC(xbof, "Force specific number of XBOFs");
  538. MODULE_PARM(buffer_size, "i");
  539. MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers");