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 * Copyright (C) 2010 Johan Hovold (jhovold@gmail.com) 7 * 8 * This program is free software; you can redistribute it and/or modify 9 * it under the terms of the GNU General Public License as published by 10 * the Free Software Foundation; either version 2 of the License, or 11 * (at your option) any later version. 12 * 13 * This driver allows a USB IrDA device to be used as a "dumb" serial device. 14 * This can be useful if you do not have access to a full IrDA stack on the 15 * other side of the connection. If you do have an IrDA stack on both devices, 16 * please use the usb-irda driver, as it contains the proper error checking and 17 * other goodness of a full IrDA stack. 18 * 19 * Portions of this driver were taken from drivers/net/irda/irda-usb.c, which 20 * was written by Roman Weissgaerber <weissg@vienna.at>, Dag Brattli 21 * <dag@brattli.net>, and Jean Tourrilhes <jt@hpl.hp.com> 22 * 23 * See Documentation/usb/usb-serial.txt for more information on using this 24 * driver 25 */ 26 27 #include <linux/kernel.h> 28 #include <linux/errno.h> 29 #include <linux/init.h> 30 #include <linux/slab.h> 31 #include <linux/tty.h> 32 #include <linux/tty_driver.h> 33 #include <linux/tty_flip.h> 34 #include <linux/module.h> 35 #include <linux/spinlock.h> 36 #include <linux/uaccess.h> 37 #include <linux/usb.h> 38 #include <linux/usb/serial.h> 39 #include <linux/usb/irda.h> 40 41 #define DRIVER_AUTHOR "Greg Kroah-Hartman <greg@kroah.com>, Johan Hovold <jhovold@gmail.com>" 42 #define DRIVER_DESC "USB IR Dongle driver" 43 44 /* if overridden by the user, then use their value for the size of the read and 45 * write urbs */ 46 static int buffer_size; 47 48 /* if overridden by the user, then use the specified number of XBOFs */ 49 static int xbof = -1; 50 51 static int ir_startup (struct usb_serial *serial); 52 static int ir_write(struct tty_struct *tty, struct usb_serial_port *port, 53 const unsigned char *buf, int count); 54 static int ir_write_room(struct tty_struct *tty); 55 static void ir_write_bulk_callback(struct urb *urb); 56 static void ir_process_read_urb(struct urb *urb); 57 static void ir_set_termios(struct tty_struct *tty, 58 struct usb_serial_port *port, struct ktermios *old_termios); 59 60 /* Not that this lot means you can only have one per system */ 61 static u8 ir_baud; 62 static u8 ir_xbof; 63 static u8 ir_add_bof; 64 65 static const struct usb_device_id ir_id_table[] = { 66 { USB_DEVICE(0x050f, 0x0180) }, /* KC Technology, KC-180 */ 67 { USB_DEVICE(0x08e9, 0x0100) }, /* XTNDAccess */ 68 { USB_DEVICE(0x09c4, 0x0011) }, /* ACTiSys ACT-IR2000U */ 69 { USB_INTERFACE_INFO(USB_CLASS_APP_SPEC, USB_SUBCLASS_IRDA, 0) }, 70 { } /* Terminating entry */ 71 }; 72 73 MODULE_DEVICE_TABLE(usb, ir_id_table); 74 75 static struct usb_serial_driver ir_device = { 76 .driver = { 77 .owner = THIS_MODULE, 78 .name = "ir-usb", 79 }, 80 .description = "IR Dongle", 81 .id_table = ir_id_table, 82 .num_ports = 1, 83 .set_termios = ir_set_termios, 84 .attach = ir_startup, 85 .write = ir_write, 86 .write_room = ir_write_room, 87 .write_bulk_callback = ir_write_bulk_callback, 88 .process_read_urb = ir_process_read_urb, 89 }; 90 91 static struct usb_serial_driver * const serial_drivers[] = { 92 &ir_device, NULL 93 }; 94 irda_usb_dump_class_desc(struct usb_serial * serial,struct usb_irda_cs_descriptor * desc)95 static inline void irda_usb_dump_class_desc(struct usb_serial *serial, 96 struct usb_irda_cs_descriptor *desc) 97 { 98 struct device *dev = &serial->dev->dev; 99 100 dev_dbg(dev, "bLength=%x\n", desc->bLength); 101 dev_dbg(dev, "bDescriptorType=%x\n", desc->bDescriptorType); 102 dev_dbg(dev, "bcdSpecRevision=%x\n", __le16_to_cpu(desc->bcdSpecRevision)); 103 dev_dbg(dev, "bmDataSize=%x\n", desc->bmDataSize); 104 dev_dbg(dev, "bmWindowSize=%x\n", desc->bmWindowSize); 105 dev_dbg(dev, "bmMinTurnaroundTime=%d\n", desc->bmMinTurnaroundTime); 106 dev_dbg(dev, "wBaudRate=%x\n", __le16_to_cpu(desc->wBaudRate)); 107 dev_dbg(dev, "bmAdditionalBOFs=%x\n", desc->bmAdditionalBOFs); 108 dev_dbg(dev, "bIrdaRateSniff=%x\n", desc->bIrdaRateSniff); 109 dev_dbg(dev, "bMaxUnicastList=%x\n", desc->bMaxUnicastList); 110 } 111 112 /*------------------------------------------------------------------*/ 113 /* 114 * Function irda_usb_find_class_desc(dev, ifnum) 115 * 116 * Returns instance of IrDA class descriptor, or NULL if not found 117 * 118 * The class descriptor is some extra info that IrDA USB devices will 119 * offer to us, describing their IrDA characteristics. We will use that in 120 * irda_usb_init_qos() 121 * 122 * Based on the same function in drivers/net/irda/irda-usb.c 123 */ 124 static struct usb_irda_cs_descriptor * irda_usb_find_class_desc(struct usb_serial * serial,unsigned int ifnum)125 irda_usb_find_class_desc(struct usb_serial *serial, unsigned int ifnum) 126 { 127 struct usb_device *dev = serial->dev; 128 struct usb_irda_cs_descriptor *desc; 129 int ret; 130 131 desc = kzalloc(sizeof(*desc), GFP_KERNEL); 132 if (!desc) 133 return NULL; 134 135 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), 136 USB_REQ_CS_IRDA_GET_CLASS_DESC, 137 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, 138 0, ifnum, desc, sizeof(*desc), 1000); 139 140 dev_dbg(&serial->dev->dev, "%s - ret=%d\n", __func__, ret); 141 if (ret < sizeof(*desc)) { 142 dev_dbg(&serial->dev->dev, 143 "%s - class descriptor read %s (%d)\n", __func__, 144 (ret < 0) ? "failed" : "too short", ret); 145 goto error; 146 } 147 if (desc->bDescriptorType != USB_DT_CS_IRDA) { 148 dev_dbg(&serial->dev->dev, "%s - bad class descriptor type\n", 149 __func__); 150 goto error; 151 } 152 153 irda_usb_dump_class_desc(serial, desc); 154 return desc; 155 156 error: 157 kfree(desc); 158 return NULL; 159 } 160 ir_xbof_change(u8 xbof)161 static u8 ir_xbof_change(u8 xbof) 162 { 163 u8 result; 164 165 /* reference irda-usb.c */ 166 switch (xbof) { 167 case 48: 168 result = 0x10; 169 break; 170 case 28: 171 case 24: 172 result = 0x20; 173 break; 174 default: 175 case 12: 176 result = 0x30; 177 break; 178 case 5: 179 case 6: 180 result = 0x40; 181 break; 182 case 3: 183 result = 0x50; 184 break; 185 case 2: 186 result = 0x60; 187 break; 188 case 1: 189 result = 0x70; 190 break; 191 case 0: 192 result = 0x80; 193 break; 194 } 195 196 return(result); 197 } 198 ir_startup(struct usb_serial * serial)199 static int ir_startup(struct usb_serial *serial) 200 { 201 struct usb_irda_cs_descriptor *irda_desc; 202 int rates; 203 204 if (serial->num_bulk_in < 1 || serial->num_bulk_out < 1) 205 return -ENODEV; 206 207 irda_desc = irda_usb_find_class_desc(serial, 0); 208 if (!irda_desc) { 209 dev_err(&serial->dev->dev, 210 "IRDA class descriptor not found, device not bound\n"); 211 return -ENODEV; 212 } 213 214 rates = le16_to_cpu(irda_desc->wBaudRate); 215 216 dev_dbg(&serial->dev->dev, 217 "%s - Baud rates supported:%s%s%s%s%s%s%s%s%s\n", 218 __func__, 219 (rates & USB_IRDA_BR_2400) ? " 2400" : "", 220 (rates & USB_IRDA_BR_9600) ? " 9600" : "", 221 (rates & USB_IRDA_BR_19200) ? " 19200" : "", 222 (rates & USB_IRDA_BR_38400) ? " 38400" : "", 223 (rates & USB_IRDA_BR_57600) ? " 57600" : "", 224 (rates & USB_IRDA_BR_115200) ? " 115200" : "", 225 (rates & USB_IRDA_BR_576000) ? " 576000" : "", 226 (rates & USB_IRDA_BR_1152000) ? " 1152000" : "", 227 (rates & USB_IRDA_BR_4000000) ? " 4000000" : ""); 228 229 switch (irda_desc->bmAdditionalBOFs) { 230 case USB_IRDA_AB_48: 231 ir_add_bof = 48; 232 break; 233 case USB_IRDA_AB_24: 234 ir_add_bof = 24; 235 break; 236 case USB_IRDA_AB_12: 237 ir_add_bof = 12; 238 break; 239 case USB_IRDA_AB_6: 240 ir_add_bof = 6; 241 break; 242 case USB_IRDA_AB_3: 243 ir_add_bof = 3; 244 break; 245 case USB_IRDA_AB_2: 246 ir_add_bof = 2; 247 break; 248 case USB_IRDA_AB_1: 249 ir_add_bof = 1; 250 break; 251 case USB_IRDA_AB_0: 252 ir_add_bof = 0; 253 break; 254 default: 255 break; 256 } 257 258 kfree(irda_desc); 259 260 return 0; 261 } 262 ir_write(struct tty_struct * tty,struct usb_serial_port * port,const unsigned char * buf,int count)263 static int ir_write(struct tty_struct *tty, struct usb_serial_port *port, 264 const unsigned char *buf, int count) 265 { 266 struct urb *urb = NULL; 267 unsigned long flags; 268 int ret; 269 270 if (port->bulk_out_size == 0) 271 return -EINVAL; 272 273 if (count == 0) 274 return 0; 275 276 count = min(count, port->bulk_out_size - 1); 277 278 spin_lock_irqsave(&port->lock, flags); 279 if (__test_and_clear_bit(0, &port->write_urbs_free)) { 280 urb = port->write_urbs[0]; 281 port->tx_bytes += count; 282 } 283 spin_unlock_irqrestore(&port->lock, flags); 284 285 if (!urb) 286 return 0; 287 288 /* 289 * The first byte of the packet we send to the device contains an 290 * outbound header which indicates an additional number of BOFs and 291 * a baud rate change. 292 * 293 * See section 5.4.2.2 of the USB IrDA spec. 294 */ 295 *(u8 *)urb->transfer_buffer = ir_xbof | ir_baud; 296 297 memcpy(urb->transfer_buffer + 1, buf, count); 298 299 urb->transfer_buffer_length = count + 1; 300 urb->transfer_flags = URB_ZERO_PACKET; 301 302 ret = usb_submit_urb(urb, GFP_ATOMIC); 303 if (ret) { 304 dev_err(&port->dev, "failed to submit write urb: %d\n", ret); 305 306 spin_lock_irqsave(&port->lock, flags); 307 __set_bit(0, &port->write_urbs_free); 308 port->tx_bytes -= count; 309 spin_unlock_irqrestore(&port->lock, flags); 310 311 return ret; 312 } 313 314 return count; 315 } 316 ir_write_bulk_callback(struct urb * urb)317 static void ir_write_bulk_callback(struct urb *urb) 318 { 319 struct usb_serial_port *port = urb->context; 320 int status = urb->status; 321 unsigned long flags; 322 323 spin_lock_irqsave(&port->lock, flags); 324 __set_bit(0, &port->write_urbs_free); 325 port->tx_bytes -= urb->transfer_buffer_length - 1; 326 spin_unlock_irqrestore(&port->lock, flags); 327 328 switch (status) { 329 case 0: 330 break; 331 case -ENOENT: 332 case -ECONNRESET: 333 case -ESHUTDOWN: 334 dev_dbg(&port->dev, "write urb stopped: %d\n", status); 335 return; 336 case -EPIPE: 337 dev_err(&port->dev, "write urb stopped: %d\n", status); 338 return; 339 default: 340 dev_err(&port->dev, "nonzero write-urb status: %d\n", status); 341 break; 342 } 343 344 usb_serial_port_softint(port); 345 } 346 ir_write_room(struct tty_struct * tty)347 static int ir_write_room(struct tty_struct *tty) 348 { 349 struct usb_serial_port *port = tty->driver_data; 350 int count = 0; 351 352 if (port->bulk_out_size == 0) 353 return 0; 354 355 if (test_bit(0, &port->write_urbs_free)) 356 count = port->bulk_out_size - 1; 357 358 return count; 359 } 360 ir_process_read_urb(struct urb * urb)361 static void ir_process_read_urb(struct urb *urb) 362 { 363 struct usb_serial_port *port = urb->context; 364 unsigned char *data = urb->transfer_buffer; 365 366 if (!urb->actual_length) 367 return; 368 /* 369 * The first byte of the packet we get from the device 370 * contains a busy indicator and baud rate change. 371 * See section 5.4.1.2 of the USB IrDA spec. 372 */ 373 if (*data & 0x0f) 374 ir_baud = *data & 0x0f; 375 376 if (urb->actual_length == 1) 377 return; 378 379 tty_insert_flip_string(&port->port, data + 1, urb->actual_length - 1); 380 tty_flip_buffer_push(&port->port); 381 } 382 ir_set_termios_callback(struct urb * urb)383 static void ir_set_termios_callback(struct urb *urb) 384 { 385 kfree(urb->transfer_buffer); 386 387 if (urb->status) 388 dev_dbg(&urb->dev->dev, "%s - non-zero urb status: %d\n", 389 __func__, urb->status); 390 } 391 ir_set_termios(struct tty_struct * tty,struct usb_serial_port * port,struct ktermios * old_termios)392 static void ir_set_termios(struct tty_struct *tty, 393 struct usb_serial_port *port, struct ktermios *old_termios) 394 { 395 struct urb *urb; 396 unsigned char *transfer_buffer; 397 int result; 398 speed_t baud; 399 int ir_baud; 400 401 baud = tty_get_baud_rate(tty); 402 403 /* 404 * FIXME, we should compare the baud request against the 405 * capability stated in the IR header that we got in the 406 * startup function. 407 */ 408 409 switch (baud) { 410 case 2400: 411 ir_baud = USB_IRDA_LS_2400; 412 break; 413 case 9600: 414 ir_baud = USB_IRDA_LS_9600; 415 break; 416 case 19200: 417 ir_baud = USB_IRDA_LS_19200; 418 break; 419 case 38400: 420 ir_baud = USB_IRDA_LS_38400; 421 break; 422 case 57600: 423 ir_baud = USB_IRDA_LS_57600; 424 break; 425 case 115200: 426 ir_baud = USB_IRDA_LS_115200; 427 break; 428 case 576000: 429 ir_baud = USB_IRDA_LS_576000; 430 break; 431 case 1152000: 432 ir_baud = USB_IRDA_LS_1152000; 433 break; 434 case 4000000: 435 ir_baud = USB_IRDA_LS_4000000; 436 break; 437 default: 438 ir_baud = USB_IRDA_LS_9600; 439 baud = 9600; 440 } 441 442 if (xbof == -1) 443 ir_xbof = ir_xbof_change(ir_add_bof); 444 else 445 ir_xbof = ir_xbof_change(xbof) ; 446 447 /* Only speed changes are supported */ 448 tty_termios_copy_hw(&tty->termios, old_termios); 449 tty_encode_baud_rate(tty, baud, baud); 450 451 /* 452 * send the baud change out on an "empty" data packet 453 */ 454 urb = usb_alloc_urb(0, GFP_KERNEL); 455 if (!urb) 456 return; 457 458 transfer_buffer = kmalloc(1, GFP_KERNEL); 459 if (!transfer_buffer) 460 goto err_buf; 461 462 *transfer_buffer = ir_xbof | ir_baud; 463 464 usb_fill_bulk_urb( 465 urb, 466 port->serial->dev, 467 usb_sndbulkpipe(port->serial->dev, 468 port->bulk_out_endpointAddress), 469 transfer_buffer, 470 1, 471 ir_set_termios_callback, 472 port); 473 474 urb->transfer_flags = URB_ZERO_PACKET; 475 476 result = usb_submit_urb(urb, GFP_KERNEL); 477 if (result) { 478 dev_err(&port->dev, "%s - failed to submit urb: %d\n", 479 __func__, result); 480 goto err_subm; 481 } 482 483 usb_free_urb(urb); 484 485 return; 486 err_subm: 487 kfree(transfer_buffer); 488 err_buf: 489 usb_free_urb(urb); 490 } 491 ir_init(void)492 static int __init ir_init(void) 493 { 494 if (buffer_size) { 495 ir_device.bulk_in_size = buffer_size; 496 ir_device.bulk_out_size = buffer_size; 497 } 498 499 return usb_serial_register_drivers(serial_drivers, KBUILD_MODNAME, ir_id_table); 500 } 501 ir_exit(void)502 static void __exit ir_exit(void) 503 { 504 usb_serial_deregister_drivers(serial_drivers); 505 } 506 507 508 module_init(ir_init); 509 module_exit(ir_exit); 510 511 MODULE_AUTHOR(DRIVER_AUTHOR); 512 MODULE_DESCRIPTION(DRIVER_DESC); 513 MODULE_LICENSE("GPL"); 514 515 module_param(xbof, int, 0); 516 MODULE_PARM_DESC(xbof, "Force specific number of XBOFs"); 517 module_param(buffer_size, int, 0); 518 MODULE_PARM_DESC(buffer_size, "Size of the transfer buffers"); 519 520