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 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#include <linux/usb/serial.h> 61 62/* 63 * Version Information 64 */ 65#define DRIVER_VERSION "v0.4" 66#define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>" 67#define DRIVER_DESC "USB IR Dongle driver" 68 69/* USB IrDA class spec information */ 70#define USB_CLASS_IRDA 0x02 71#define USB_DT_IRDA 0x21 72#define IU_REQ_GET_CLASS_DESC 0x06 73#define SPEED_2400 0x01 74#define SPEED_9600 0x02 75#define SPEED_19200 0x03 76#define SPEED_38400 0x04 77#define SPEED_57600 0x05 78#define SPEED_115200 0x06 79#define SPEED_576000 0x07 80#define SPEED_1152000 0x08 81#define SPEED_4000000 0x09 82 83struct irda_class_desc { 84 u8 bLength; 85 u8 bDescriptorType; 86 u16 bcdSpecRevision; 87 u8 bmDataSize; 88 u8 bmWindowSize; 89 u8 bmMinTurnaroundTime; 90 u16 wBaudRate; 91 u8 bmAdditionalBOFs; 92 u8 bIrdaRateSniff; 93 u8 bMaxUnicastList; 94} __attribute__ ((packed)); 95 96static int debug; 97 98/* if overridden by the user, then use their value for the size of the read and 99 * write urbs */ 100static int buffer_size; 101/* if overridden by the user, then use the specified number of XBOFs */ 102static int xbof = -1; 103 104static int ir_startup (struct usb_serial *serial); 105static int ir_open (struct usb_serial_port *port, struct file *filep); 106static void ir_close (struct usb_serial_port *port, struct file *filep); 107static int ir_write (struct usb_serial_port *port, const unsigned char *buf, int count); 108static void ir_write_bulk_callback (struct urb *urb); 109static void ir_read_bulk_callback (struct urb *urb); 110static void ir_set_termios (struct usb_serial_port *port, struct ktermios *old_termios); 111 112static u8 ir_baud = 0; 113static u8 ir_xbof = 0; 114static u8 ir_add_bof = 0; 115 116static struct usb_device_id id_table [] = { 117 { USB_DEVICE(0x050f, 0x0180) }, /* KC Technology, KC-180 */ 118 { USB_DEVICE(0x08e9, 0x0100) }, /* XTNDAccess */ 119 { USB_DEVICE(0x09c4, 0x0011) }, /* ACTiSys ACT-IR2000U */ 120 { USB_INTERFACE_INFO (USB_CLASS_APP_SPEC, USB_CLASS_IRDA, 0) }, 121 { } /* Terminating entry */ 122}; 123 124MODULE_DEVICE_TABLE (usb, id_table); 125 126static struct usb_driver ir_driver = { 127 .name = "ir-usb", 128 .probe = usb_serial_probe, 129 .disconnect = usb_serial_disconnect, 130 .id_table = id_table, 131 .no_dynamic_id = 1, 132}; 133 134 135static struct usb_serial_driver ir_device = { 136 .driver = { 137 .owner = THIS_MODULE, 138 .name = "ir-usb", 139 }, 140 .description = "IR Dongle", 141 .usb_driver = &ir_driver, 142 .id_table = id_table, 143 .num_interrupt_in = 1, 144 .num_bulk_in = 1, 145 .num_bulk_out = 1, 146 .num_ports = 1, 147 .set_termios = ir_set_termios, 148 .attach = ir_startup, 149 .open = ir_open, 150 .close = ir_close, 151 .write = ir_write, 152 .write_bulk_callback = ir_write_bulk_callback, 153 .read_bulk_callback = ir_read_bulk_callback, 154}; 155 156static inline void irda_usb_dump_class_desc(struct irda_class_desc *desc) 157{ 158 dbg("bLength=%x", desc->bLength); 159 dbg("bDescriptorType=%x", desc->bDescriptorType); 160 dbg("bcdSpecRevision=%x", desc->bcdSpecRevision); 161 dbg("bmDataSize=%x", desc->bmDataSize); 162 dbg("bmWindowSize=%x", desc->bmWindowSize); 163 dbg("bmMinTurnaroundTime=%d", desc->bmMinTurnaroundTime); 164 dbg("wBaudRate=%x", desc->wBaudRate); 165 dbg("bmAdditionalBOFs=%x", desc->bmAdditionalBOFs); 166 dbg("bIrdaRateSniff=%x", desc->bIrdaRateSniff); 167 dbg("bMaxUnicastList=%x", desc->bMaxUnicastList); 168} 169 170/*------------------------------------------------------------------*/ 171/* 172 * Function irda_usb_find_class_desc(dev, ifnum) 173 * 174 * Returns instance of IrDA class descriptor, or NULL if not found 175 * 176 * The class descriptor is some extra info that IrDA USB devices will 177 * offer to us, describing their IrDA characteristics. We will use that in 178 * irda_usb_init_qos() 179 * 180 * Based on the same function in drivers/net/irda/irda-usb.c 181 */ 182static struct irda_class_desc *irda_usb_find_class_desc(struct usb_device *dev, unsigned int ifnum) 183{ 184 struct irda_class_desc *desc; 185 int ret; 186 187 desc = kzalloc(sizeof (struct irda_class_desc), GFP_KERNEL); 188 if (desc == NULL) 189 return NULL; 190 191 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev,0), 192 IU_REQ_GET_CLASS_DESC, 193 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, 194 0, ifnum, desc, sizeof(*desc), 1000); 195 196 dbg("%s - ret=%d", __FUNCTION__, ret); 197 if (ret < sizeof(*desc)) { 198 dbg("%s - class descriptor read %s (%d)", 199 __FUNCTION__, 200 (ret<0) ? "failed" : "too short", 201 ret); 202 goto error; 203 } 204 if (desc->bDescriptorType != USB_DT_IRDA) { 205 dbg("%s - bad class descriptor type", __FUNCTION__); 206 goto error; 207 } 208 209 irda_usb_dump_class_desc(desc); 210 return desc; 211error: 212 kfree(desc); 213 return NULL; 214} 215 216 217static u8 ir_xbof_change(u8 xbof) 218{ 219 u8 result; 220 /* reference irda-usb.c */ 221 switch(xbof) { 222 case 48: result = 0x10; break; 223 case 28: 224 case 24: result = 0x20; break; 225 default: 226 case 12: result = 0x30; break; 227 case 5: 228 case 6: result = 0x40; break; 229 case 3: result = 0x50; break; 230 case 2: result = 0x60; break; 231 case 1: result = 0x70; break; 232 case 0: result = 0x80; break; 233 } 234 return(result); 235} 236 237 238static int ir_startup (struct usb_serial *serial) 239{ 240 struct irda_class_desc *irda_desc; 241 242 irda_desc = irda_usb_find_class_desc (serial->dev, 0); 243 if (irda_desc == NULL) { 244 dev_err (&serial->dev->dev, "IRDA class descriptor not found, device not bound\n"); 245 return -ENODEV; 246 } 247 248 dbg ("%s - Baud rates supported:%s%s%s%s%s%s%s%s%s", 249 __FUNCTION__, 250 (irda_desc->wBaudRate & 0x0001) ? " 2400" : "", 251 (irda_desc->wBaudRate & 0x0002) ? " 9600" : "", 252 (irda_desc->wBaudRate & 0x0004) ? " 19200" : "", 253 (irda_desc->wBaudRate & 0x0008) ? " 38400" : "", 254 (irda_desc->wBaudRate & 0x0010) ? " 57600" : "", 255 (irda_desc->wBaudRate & 0x0020) ? " 115200" : "", 256 (irda_desc->wBaudRate & 0x0040) ? " 576000" : "", 257 (irda_desc->wBaudRate & 0x0080) ? " 1152000" : "", 258 (irda_desc->wBaudRate & 0x0100) ? " 4000000" : ""); 259 260 switch( irda_desc->bmAdditionalBOFs ) { 261 case 0x01: ir_add_bof = 48; break; 262 case 0x02: ir_add_bof = 24; break; 263 case 0x04: ir_add_bof = 12; break; 264 case 0x08: ir_add_bof = 6; break; 265 case 0x10: ir_add_bof = 3; break; 266 case 0x20: ir_add_bof = 2; break; 267 case 0x40: ir_add_bof = 1; break; 268 case 0x80: ir_add_bof = 0; break; 269 default:; 270 } 271 272 kfree (irda_desc); 273 274 return 0; 275} 276 277static int ir_open (struct usb_serial_port *port, struct file *filp) 278{ 279 char *buffer; 280 int result = 0; 281 282 dbg("%s - port %d", __FUNCTION__, port->number); 283 284 if (buffer_size) { 285 /* override the default buffer sizes */ 286 buffer = kmalloc (buffer_size, GFP_KERNEL); 287 if (!buffer) { 288 dev_err (&port->dev, "%s - out of memory.\n", __FUNCTION__); 289 return -ENOMEM; 290 } 291 kfree (port->read_urb->transfer_buffer); 292 port->read_urb->transfer_buffer = buffer; 293 port->read_urb->transfer_buffer_length = buffer_size; 294 295 buffer = kmalloc (buffer_size, GFP_KERNEL); 296 if (!buffer) { 297 dev_err (&port->dev, "%s - out of memory.\n", __FUNCTION__); 298 return -ENOMEM; 299 } 300 kfree (port->write_urb->transfer_buffer); 301 port->write_urb->transfer_buffer = buffer; 302 port->write_urb->transfer_buffer_length = buffer_size; 303 port->bulk_out_size = buffer_size; 304 } 305 306 /* Start reading from the device */ 307 usb_fill_bulk_urb ( 308 port->read_urb, 309 port->serial->dev, 310 usb_rcvbulkpipe(port->serial->dev, port->bulk_in_endpointAddress), 311 port->read_urb->transfer_buffer, 312 port->read_urb->transfer_buffer_length, 313 ir_read_bulk_callback, 314 port); 315 result = usb_submit_urb(port->read_urb, GFP_KERNEL); 316 if (result) 317 dev_err(&port->dev, "%s - failed submitting read urb, error %d\n", __FUNCTION__, result); 318 319 return result; 320} 321 322static void ir_close (struct usb_serial_port *port, struct file * filp) 323{ 324 dbg("%s - port %d", __FUNCTION__, port->number); 325 326 /* shutdown our bulk read */ 327 usb_kill_urb(port->read_urb); 328} 329 330static int ir_write (struct usb_serial_port *port, const unsigned char *buf, int count) 331{ 332 unsigned char *transfer_buffer; 333 int result; 334 int transfer_size; 335 336 dbg("%s - port = %d, count = %d", __FUNCTION__, port->number, count); 337 338 if (!port->tty) { 339 dev_err (&port->dev, "%s - no tty???\n", __FUNCTION__); 340 return 0; 341 } 342 343 if (count == 0) 344 return 0; 345 346 spin_lock_bh(&port->lock); 347 if (port->write_urb_busy) { 348 spin_unlock_bh(&port->lock); 349 dbg("%s - already writing", __FUNCTION__); 350 return 0; 351 } 352 port->write_urb_busy = 1; 353 spin_unlock_bh(&port->lock); 354 355 transfer_buffer = port->write_urb->transfer_buffer; 356 transfer_size = min(count, port->bulk_out_size - 1); 357 358 /* 359 * The first byte of the packet we send to the device contains an 360 * inband header which indicates an additional number of BOFs and 361 * a baud rate change. 362 * 363 * See section 5.4.2.2 of the USB IrDA spec. 364 */ 365 *transfer_buffer = ir_xbof | ir_baud; 366 ++transfer_buffer; 367 368 memcpy (transfer_buffer, buf, transfer_size); 369 370 usb_fill_bulk_urb ( 371 port->write_urb, 372 port->serial->dev, 373 usb_sndbulkpipe(port->serial->dev, 374 port->bulk_out_endpointAddress), 375 port->write_urb->transfer_buffer, 376 transfer_size + 1, 377 ir_write_bulk_callback, 378 port); 379 380 port->write_urb->transfer_flags = URB_ZERO_PACKET; 381 382 result = usb_submit_urb (port->write_urb, GFP_ATOMIC); 383 if (result) { 384 port->write_urb_busy = 0; 385 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result); 386 } else 387 result = transfer_size; 388 389 return result; 390} 391 392static void ir_write_bulk_callback (struct urb *urb) 393{ 394 struct usb_serial_port *port = (struct usb_serial_port *)urb->context; 395 396 dbg("%s - port %d", __FUNCTION__, port->number); 397 398 port->write_urb_busy = 0; 399 if (urb->status) { 400 dbg("%s - nonzero write bulk status received: %d", __FUNCTION__, urb->status); 401 return; 402 } 403 404 usb_serial_debug_data ( 405 debug, 406 &port->dev, 407 __FUNCTION__, 408 urb->actual_length, 409 urb->transfer_buffer); 410 411 usb_serial_port_softint(port); 412} 413 414static void ir_read_bulk_callback (struct urb *urb) 415{ 416 struct usb_serial_port *port = (struct usb_serial_port *)urb->context; 417 struct tty_struct *tty; 418 unsigned char *data = urb->transfer_buffer; 419 int result; 420 421 dbg("%s - port %d", __FUNCTION__, port->number); 422 423 if (!port->open_count) { 424 dbg("%s - port closed.", __FUNCTION__); 425 return; 426 } 427 428 switch (urb->status) { 429 430 case 0: /* Successful */ 431 432 /* 433 * The first byte of the packet we get from the device 434 * contains a busy indicator and baud rate change. 435 * See section 5.4.1.2 of the USB IrDA spec. 436 */ 437 if ((*data & 0x0f) > 0) 438 ir_baud = *data & 0x0f; 439 440 usb_serial_debug_data ( 441 debug, 442 &port->dev, 443 __FUNCTION__, 444 urb->actual_length, 445 data); 446 447 /* 448 * Bypass flip-buffers, and feed the ldisc directly 449 * due to our potentially large buffer size. Since we 450 * used to set low_latency, this is exactly what the 451 * tty layer did anyway :) 452 */ 453 tty = port->tty; 454 455 tty->ldisc.receive_buf( 456 tty, 457 data+1, 458 NULL, 459 urb->actual_length-1); 460 461 /* 462 * No break here. 463 * We want to resubmit the urb so we can read 464 * again. 465 */ 466 467 case -EPROTO: /* taking inspiration from pl2303.c */ 468 469 /* Continue trying to always read */ 470 usb_fill_bulk_urb ( 471 port->read_urb, 472 port->serial->dev, 473 usb_rcvbulkpipe(port->serial->dev, 474 port->bulk_in_endpointAddress), 475 port->read_urb->transfer_buffer, 476 port->read_urb->transfer_buffer_length, 477 ir_read_bulk_callback, 478 port); 479 480 result = usb_submit_urb(port->read_urb, GFP_ATOMIC); 481 if (result) 482 dev_err(&port->dev, "%s - failed resubmitting read urb, error %d\n", 483 __FUNCTION__, result); 484 485 break ; 486 487 default: 488 dbg("%s - nonzero read bulk status received: %d", 489 __FUNCTION__, 490 urb->status); 491 break ; 492 493 } 494 495 return; 496} 497 498static void ir_set_termios (struct usb_serial_port *port, struct ktermios *old_termios) 499{ 500 unsigned char *transfer_buffer; 501 unsigned int cflag; 502 int result; 503 504 dbg("%s - port %d", __FUNCTION__, port->number); 505 506 if ((!port->tty) || (!port->tty->termios)) { 507 dbg("%s - no tty structures", __FUNCTION__); 508 return; 509 } 510 511 cflag = port->tty->termios->c_cflag; 512 /* check that they really want us to change something */ 513 if (old_termios) { 514 if ((cflag == old_termios->c_cflag) && 515 (RELEVANT_IFLAG(port->tty->termios->c_iflag) == RELEVANT_IFLAG(old_termios->c_iflag))) { 516 dbg("%s - nothing to change...", __FUNCTION__); 517 return; 518 } 519 } 520 521 /* All we can change is the baud rate */ 522 if (cflag & CBAUD) { 523 524 dbg ("%s - asking for baud %d", 525 __FUNCTION__, 526 tty_get_baud_rate(port->tty)); 527 528 switch (cflag & CBAUD) { 529 case B2400: ir_baud = SPEED_2400; break; 530 default: 531 case B9600: ir_baud = SPEED_9600; break; 532 case B19200: ir_baud = SPEED_19200; break; 533 case B38400: ir_baud = SPEED_38400; break; 534 case B57600: ir_baud = SPEED_57600; break; 535 case B115200: ir_baud = SPEED_115200; break; 536 case B576000: ir_baud = SPEED_576000; break; 537 case B1152000: ir_baud = SPEED_1152000; break; 538#ifdef B4000000 539 case B4000000: ir_baud = SPEED_4000000; break; 540#endif 541 } 542 543 if (xbof == -1) { 544 ir_xbof = ir_xbof_change(ir_add_bof); 545 } else { 546 ir_xbof = ir_xbof_change(xbof) ; 547 } 548 549 /* Notify the tty driver that the termios have changed. */ 550 port->tty->ldisc.set_termios(port->tty, NULL); 551 552 transfer_buffer = port->write_urb->transfer_buffer; 553 *transfer_buffer = ir_xbof | ir_baud; 554 555 usb_fill_bulk_urb ( 556 port->write_urb, 557 port->serial->dev, 558 usb_sndbulkpipe(port->serial->dev, 559 port->bulk_out_endpointAddress), 560 port->write_urb->transfer_buffer, 561 1, 562 ir_write_bulk_callback, 563 port); 564 565 port->write_urb->transfer_flags = URB_ZERO_PACKET; 566 567 result = usb_submit_urb (port->write_urb, GFP_KERNEL); 568 if (result) 569 dev_err(&port->dev, "%s - failed submitting write urb, error %d\n", __FUNCTION__, result); 570 } 571 return; 572} 573 574 575static int __init ir_init (void) 576{ 577 int retval; 578 retval = usb_serial_register(&ir_device); 579 if (retval) 580 goto failed_usb_serial_register; 581 retval = usb_register(&ir_driver); 582 if (retval) 583 goto failed_usb_register; 584 info(DRIVER_DESC " " DRIVER_VERSION); 585 return 0; 586failed_usb_register: 587 usb_serial_deregister(&ir_device); 588failed_usb_serial_register: 589 return retval; 590} 591 592 593static void __exit ir_exit (void) 594{ 595 usb_deregister (&ir_driver); 596 usb_serial_deregister (&ir_device); 597} 598 599 600module_init(ir_init); 601module_exit(ir_exit); 602 603MODULE_AUTHOR(DRIVER_AUTHOR); 604MODULE_DESCRIPTION(DRIVER_DESC); 605MODULE_LICENSE("GPL"); 606 607module_param(debug, bool, S_IRUGO | S_IWUSR); 608MODULE_PARM_DESC(debug, "Debug enabled or not"); 609module_param(xbof, int, 0); 610MODULE_PARM_DESC(xbof, "Force specific number of XBOFs"); 611module_param(buffer_size, int, 0); 612MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers"); 613