1 /* 2 * imon.c: input and display driver for SoundGraph iMON IR/VFD/LCD 3 * 4 * Copyright(C) 2010 Jarod Wilson <jarod@wilsonet.com> 5 * Portions based on the original lirc_imon driver, 6 * Copyright(C) 2004 Venky Raju(dev@venky.ws) 7 * 8 * Huge thanks to R. Geoff Newbury for invaluable debugging on the 9 * 0xffdc iMON devices, and for sending me one to hack on, without 10 * which the support for them wouldn't be nearly as good. Thanks 11 * also to the numerous 0xffdc device owners that tested auto-config 12 * support for me and provided debug dumps from their devices. 13 * 14 * imon is free software; you can redistribute it and/or modify 15 * it under the terms of the GNU General Public License as published by 16 * the Free Software Foundation; either version 2 of the License, or 17 * (at your option) any later version. 18 * 19 * This program is distributed in the hope that it will be useful, 20 * but WITHOUT ANY WARRANTY; without even the implied warranty of 21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 * GNU General Public License for more details. 23 * 24 * You should have received a copy of the GNU General Public License 25 * along with this program; if not, write to the Free Software 26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 27 */ 28 29 #define pr_fmt(fmt) KBUILD_MODNAME ":%s: " fmt, __func__ 30 31 #include <linux/errno.h> 32 #include <linux/init.h> 33 #include <linux/kernel.h> 34 #include <linux/module.h> 35 #include <linux/slab.h> 36 #include <linux/uaccess.h> 37 #include <linux/ratelimit.h> 38 39 #include <linux/input.h> 40 #include <linux/usb.h> 41 #include <linux/usb/input.h> 42 #include <media/rc-core.h> 43 44 #include <linux/time.h> 45 #include <linux/timer.h> 46 47 #define MOD_AUTHOR "Jarod Wilson <jarod@wilsonet.com>" 48 #define MOD_DESC "Driver for SoundGraph iMON MultiMedia IR/Display" 49 #define MOD_NAME "imon" 50 #define MOD_VERSION "0.9.4" 51 52 #define DISPLAY_MINOR_BASE 144 53 #define DEVICE_NAME "lcd%d" 54 55 #define BUF_CHUNK_SIZE 8 56 #define BUF_SIZE 128 57 58 #define BIT_DURATION 250 /* each bit received is 250us */ 59 60 #define IMON_CLOCK_ENABLE_PACKETS 2 61 62 /*** P R O T O T Y P E S ***/ 63 64 /* USB Callback prototypes */ 65 static int imon_probe(struct usb_interface *interface, 66 const struct usb_device_id *id); 67 static void imon_disconnect(struct usb_interface *interface); 68 static void usb_rx_callback_intf0(struct urb *urb); 69 static void usb_rx_callback_intf1(struct urb *urb); 70 static void usb_tx_callback(struct urb *urb); 71 72 /* suspend/resume support */ 73 static int imon_resume(struct usb_interface *intf); 74 static int imon_suspend(struct usb_interface *intf, pm_message_t message); 75 76 /* Display file_operations function prototypes */ 77 static int display_open(struct inode *inode, struct file *file); 78 static int display_close(struct inode *inode, struct file *file); 79 80 /* VFD write operation */ 81 static ssize_t vfd_write(struct file *file, const char __user *buf, 82 size_t n_bytes, loff_t *pos); 83 84 /* LCD file_operations override function prototypes */ 85 static ssize_t lcd_write(struct file *file, const char __user *buf, 86 size_t n_bytes, loff_t *pos); 87 88 /*** G L O B A L S ***/ 89 90 struct imon_context { 91 struct device *dev; 92 /* Newer devices have two interfaces */ 93 struct usb_device *usbdev_intf0; 94 struct usb_device *usbdev_intf1; 95 96 bool display_supported; /* not all controllers do */ 97 bool display_isopen; /* display port has been opened */ 98 bool rf_device; /* true if iMON 2.4G LT/DT RF device */ 99 bool rf_isassociating; /* RF remote associating */ 100 bool dev_present_intf0; /* USB device presence, interface 0 */ 101 bool dev_present_intf1; /* USB device presence, interface 1 */ 102 103 struct mutex lock; /* to lock this object */ 104 wait_queue_head_t remove_ok; /* For unexpected USB disconnects */ 105 106 struct usb_endpoint_descriptor *rx_endpoint_intf0; 107 struct usb_endpoint_descriptor *rx_endpoint_intf1; 108 struct usb_endpoint_descriptor *tx_endpoint; 109 struct urb *rx_urb_intf0; 110 struct urb *rx_urb_intf1; 111 struct urb *tx_urb; 112 bool tx_control; 113 unsigned char usb_rx_buf[8]; 114 unsigned char usb_tx_buf[8]; 115 unsigned int send_packet_delay; 116 117 struct tx_t { 118 unsigned char data_buf[35]; /* user data buffer */ 119 struct completion finished; /* wait for write to finish */ 120 bool busy; /* write in progress */ 121 int status; /* status of tx completion */ 122 } tx; 123 124 u16 vendor; /* usb vendor ID */ 125 u16 product; /* usb product ID */ 126 127 struct rc_dev *rdev; /* rc-core device for remote */ 128 struct input_dev *idev; /* input device for panel & IR mouse */ 129 struct input_dev *touch; /* input device for touchscreen */ 130 131 spinlock_t kc_lock; /* make sure we get keycodes right */ 132 u32 kc; /* current input keycode */ 133 u32 last_keycode; /* last reported input keycode */ 134 u32 rc_scancode; /* the computed remote scancode */ 135 u8 rc_toggle; /* the computed remote toggle bit */ 136 u64 rc_type; /* iMON or MCE (RC6) IR protocol? */ 137 bool release_code; /* some keys send a release code */ 138 139 u8 display_type; /* store the display type */ 140 bool pad_mouse; /* toggle kbd(0)/mouse(1) mode */ 141 142 char name_rdev[128]; /* rc input device name */ 143 char phys_rdev[64]; /* rc input device phys path */ 144 145 char name_idev[128]; /* input device name */ 146 char phys_idev[64]; /* input device phys path */ 147 148 char name_touch[128]; /* touch screen name */ 149 char phys_touch[64]; /* touch screen phys path */ 150 struct timer_list ttimer; /* touch screen timer */ 151 int touch_x; /* x coordinate on touchscreen */ 152 int touch_y; /* y coordinate on touchscreen */ 153 }; 154 155 #define TOUCH_TIMEOUT (HZ/30) 156 157 /* vfd character device file operations */ 158 static const struct file_operations vfd_fops = { 159 .owner = THIS_MODULE, 160 .open = &display_open, 161 .write = &vfd_write, 162 .release = &display_close, 163 .llseek = noop_llseek, 164 }; 165 166 /* lcd character device file operations */ 167 static const struct file_operations lcd_fops = { 168 .owner = THIS_MODULE, 169 .open = &display_open, 170 .write = &lcd_write, 171 .release = &display_close, 172 .llseek = noop_llseek, 173 }; 174 175 enum { 176 IMON_DISPLAY_TYPE_AUTO = 0, 177 IMON_DISPLAY_TYPE_VFD = 1, 178 IMON_DISPLAY_TYPE_LCD = 2, 179 IMON_DISPLAY_TYPE_VGA = 3, 180 IMON_DISPLAY_TYPE_NONE = 4, 181 }; 182 183 enum { 184 IMON_KEY_IMON = 0, 185 IMON_KEY_MCE = 1, 186 IMON_KEY_PANEL = 2, 187 }; 188 189 enum { 190 IMON_NEED_20MS_PKT_DELAY = 1 191 }; 192 193 /* 194 * USB Device ID for iMON USB Control Boards 195 * 196 * The Windows drivers contain 6 different inf files, more or less one for 197 * each new device until the 0x0034-0x0046 devices, which all use the same 198 * driver. Some of the devices in the 34-46 range haven't been definitively 199 * identified yet. Early devices have either a TriGem Computer, Inc. or a 200 * Samsung vendor ID (0x0aa8 and 0x04e8 respectively), while all later 201 * devices use the SoundGraph vendor ID (0x15c2). This driver only supports 202 * the ffdc and later devices, which do onboard decoding. 203 */ 204 static struct usb_device_id imon_usb_id_table[] = { 205 /* 206 * Several devices with this same device ID, all use iMON_PAD.inf 207 * SoundGraph iMON PAD (IR & VFD) 208 * SoundGraph iMON PAD (IR & LCD) 209 * SoundGraph iMON Knob (IR only) 210 */ 211 { USB_DEVICE(0x15c2, 0xffdc) }, 212 213 /* 214 * Newer devices, all driven by the latest iMON Windows driver, full 215 * list of device IDs extracted via 'strings Setup/data1.hdr |grep 15c2' 216 * Need user input to fill in details on unknown devices. 217 */ 218 /* SoundGraph iMON OEM Touch LCD (IR & 7" VGA LCD) */ 219 { USB_DEVICE(0x15c2, 0x0034) }, 220 /* SoundGraph iMON OEM Touch LCD (IR & 4.3" VGA LCD) */ 221 { USB_DEVICE(0x15c2, 0x0035) }, 222 /* SoundGraph iMON OEM VFD (IR & VFD) */ 223 { USB_DEVICE(0x15c2, 0x0036), .driver_info = IMON_NEED_20MS_PKT_DELAY }, 224 /* device specifics unknown */ 225 { USB_DEVICE(0x15c2, 0x0037) }, 226 /* SoundGraph iMON OEM LCD (IR & LCD) */ 227 { USB_DEVICE(0x15c2, 0x0038) }, 228 /* SoundGraph iMON UltraBay (IR & LCD) */ 229 { USB_DEVICE(0x15c2, 0x0039) }, 230 /* device specifics unknown */ 231 { USB_DEVICE(0x15c2, 0x003a) }, 232 /* device specifics unknown */ 233 { USB_DEVICE(0x15c2, 0x003b) }, 234 /* SoundGraph iMON OEM Inside (IR only) */ 235 { USB_DEVICE(0x15c2, 0x003c) }, 236 /* device specifics unknown */ 237 { USB_DEVICE(0x15c2, 0x003d) }, 238 /* device specifics unknown */ 239 { USB_DEVICE(0x15c2, 0x003e) }, 240 /* device specifics unknown */ 241 { USB_DEVICE(0x15c2, 0x003f) }, 242 /* device specifics unknown */ 243 { USB_DEVICE(0x15c2, 0x0040) }, 244 /* SoundGraph iMON MINI (IR only) */ 245 { USB_DEVICE(0x15c2, 0x0041) }, 246 /* Antec Veris Multimedia Station EZ External (IR only) */ 247 { USB_DEVICE(0x15c2, 0x0042) }, 248 /* Antec Veris Multimedia Station Basic Internal (IR only) */ 249 { USB_DEVICE(0x15c2, 0x0043) }, 250 /* Antec Veris Multimedia Station Elite (IR & VFD) */ 251 { USB_DEVICE(0x15c2, 0x0044) }, 252 /* Antec Veris Multimedia Station Premiere (IR & LCD) */ 253 { USB_DEVICE(0x15c2, 0x0045) }, 254 /* device specifics unknown */ 255 { USB_DEVICE(0x15c2, 0x0046) }, 256 {} 257 }; 258 259 /* USB Device data */ 260 static struct usb_driver imon_driver = { 261 .name = MOD_NAME, 262 .probe = imon_probe, 263 .disconnect = imon_disconnect, 264 .suspend = imon_suspend, 265 .resume = imon_resume, 266 .id_table = imon_usb_id_table, 267 }; 268 269 static struct usb_class_driver imon_vfd_class = { 270 .name = DEVICE_NAME, 271 .fops = &vfd_fops, 272 .minor_base = DISPLAY_MINOR_BASE, 273 }; 274 275 static struct usb_class_driver imon_lcd_class = { 276 .name = DEVICE_NAME, 277 .fops = &lcd_fops, 278 .minor_base = DISPLAY_MINOR_BASE, 279 }; 280 281 /* imon receiver front panel/knob key table */ 282 static const struct { 283 u64 hw_code; 284 u32 keycode; 285 } imon_panel_key_table[] = { 286 { 0x000000000f00ffeell, KEY_MEDIA }, /* Go */ 287 { 0x000000001200ffeell, KEY_UP }, 288 { 0x000000001300ffeell, KEY_DOWN }, 289 { 0x000000001400ffeell, KEY_LEFT }, 290 { 0x000000001500ffeell, KEY_RIGHT }, 291 { 0x000000001600ffeell, KEY_ENTER }, 292 { 0x000000001700ffeell, KEY_ESC }, 293 { 0x000000001f00ffeell, KEY_AUDIO }, 294 { 0x000000002000ffeell, KEY_VIDEO }, 295 { 0x000000002100ffeell, KEY_CAMERA }, 296 { 0x000000002700ffeell, KEY_DVD }, 297 { 0x000000002300ffeell, KEY_TV }, 298 { 0x000000002b00ffeell, KEY_EXIT }, 299 { 0x000000002c00ffeell, KEY_SELECT }, 300 { 0x000000002d00ffeell, KEY_MENU }, 301 { 0x000000000500ffeell, KEY_PREVIOUS }, 302 { 0x000000000700ffeell, KEY_REWIND }, 303 { 0x000000000400ffeell, KEY_STOP }, 304 { 0x000000003c00ffeell, KEY_PLAYPAUSE }, 305 { 0x000000000800ffeell, KEY_FASTFORWARD }, 306 { 0x000000000600ffeell, KEY_NEXT }, 307 { 0x000000010000ffeell, KEY_RIGHT }, 308 { 0x000001000000ffeell, KEY_LEFT }, 309 { 0x000000003d00ffeell, KEY_SELECT }, 310 { 0x000100000000ffeell, KEY_VOLUMEUP }, 311 { 0x010000000000ffeell, KEY_VOLUMEDOWN }, 312 { 0x000000000100ffeell, KEY_MUTE }, 313 /* 0xffdc iMON MCE VFD */ 314 { 0x00010000ffffffeell, KEY_VOLUMEUP }, 315 { 0x01000000ffffffeell, KEY_VOLUMEDOWN }, 316 { 0x00000001ffffffeell, KEY_MUTE }, 317 { 0x0000000fffffffeell, KEY_MEDIA }, 318 { 0x00000012ffffffeell, KEY_UP }, 319 { 0x00000013ffffffeell, KEY_DOWN }, 320 { 0x00000014ffffffeell, KEY_LEFT }, 321 { 0x00000015ffffffeell, KEY_RIGHT }, 322 { 0x00000016ffffffeell, KEY_ENTER }, 323 { 0x00000017ffffffeell, KEY_ESC }, 324 /* iMON Knob values */ 325 { 0x000100ffffffffeell, KEY_VOLUMEUP }, 326 { 0x010000ffffffffeell, KEY_VOLUMEDOWN }, 327 { 0x000008ffffffffeell, KEY_MUTE }, 328 }; 329 330 /* to prevent races between open() and disconnect(), probing, etc */ 331 static DEFINE_MUTEX(driver_lock); 332 333 /* Module bookkeeping bits */ 334 MODULE_AUTHOR(MOD_AUTHOR); 335 MODULE_DESCRIPTION(MOD_DESC); 336 MODULE_VERSION(MOD_VERSION); 337 MODULE_LICENSE("GPL"); 338 MODULE_DEVICE_TABLE(usb, imon_usb_id_table); 339 340 static bool debug; 341 module_param(debug, bool, S_IRUGO | S_IWUSR); 342 MODULE_PARM_DESC(debug, "Debug messages: 0=no, 1=yes (default: no)"); 343 344 /* lcd, vfd, vga or none? should be auto-detected, but can be overridden... */ 345 static int display_type; 346 module_param(display_type, int, S_IRUGO); 347 MODULE_PARM_DESC(display_type, "Type of attached display. 0=autodetect, " 348 "1=vfd, 2=lcd, 3=vga, 4=none (default: autodetect)"); 349 350 static int pad_stabilize = 1; 351 module_param(pad_stabilize, int, S_IRUGO | S_IWUSR); 352 MODULE_PARM_DESC(pad_stabilize, "Apply stabilization algorithm to iMON PAD " 353 "presses in arrow key mode. 0=disable, 1=enable (default)."); 354 355 /* 356 * In certain use cases, mouse mode isn't really helpful, and could actually 357 * cause confusion, so allow disabling it when the IR device is open. 358 */ 359 static bool nomouse; 360 module_param(nomouse, bool, S_IRUGO | S_IWUSR); 361 MODULE_PARM_DESC(nomouse, "Disable mouse input device mode when IR device is " 362 "open. 0=don't disable, 1=disable. (default: don't disable)"); 363 364 /* threshold at which a pad push registers as an arrow key in kbd mode */ 365 static int pad_thresh; 366 module_param(pad_thresh, int, S_IRUGO | S_IWUSR); 367 MODULE_PARM_DESC(pad_thresh, "Threshold at which a pad push registers as an " 368 "arrow key in kbd mode (default: 28)"); 369 370 371 static void free_imon_context(struct imon_context *ictx) 372 { 373 struct device *dev = ictx->dev; 374 375 usb_free_urb(ictx->tx_urb); 376 usb_free_urb(ictx->rx_urb_intf0); 377 usb_free_urb(ictx->rx_urb_intf1); 378 kfree(ictx); 379 380 dev_dbg(dev, "%s: iMON context freed\n", __func__); 381 } 382 383 /** 384 * Called when the Display device (e.g. /dev/lcd0) 385 * is opened by the application. 386 */ 387 static int display_open(struct inode *inode, struct file *file) 388 { 389 struct usb_interface *interface; 390 struct imon_context *ictx = NULL; 391 int subminor; 392 int retval = 0; 393 394 /* prevent races with disconnect */ 395 mutex_lock(&driver_lock); 396 397 subminor = iminor(inode); 398 interface = usb_find_interface(&imon_driver, subminor); 399 if (!interface) { 400 pr_err("could not find interface for minor %d\n", subminor); 401 retval = -ENODEV; 402 goto exit; 403 } 404 ictx = usb_get_intfdata(interface); 405 406 if (!ictx) { 407 pr_err("no context found for minor %d\n", subminor); 408 retval = -ENODEV; 409 goto exit; 410 } 411 412 mutex_lock(&ictx->lock); 413 414 if (!ictx->display_supported) { 415 pr_err("display not supported by device\n"); 416 retval = -ENODEV; 417 } else if (ictx->display_isopen) { 418 pr_err("display port is already open\n"); 419 retval = -EBUSY; 420 } else { 421 ictx->display_isopen = true; 422 file->private_data = ictx; 423 dev_dbg(ictx->dev, "display port opened\n"); 424 } 425 426 mutex_unlock(&ictx->lock); 427 428 exit: 429 mutex_unlock(&driver_lock); 430 return retval; 431 } 432 433 /** 434 * Called when the display device (e.g. /dev/lcd0) 435 * is closed by the application. 436 */ 437 static int display_close(struct inode *inode, struct file *file) 438 { 439 struct imon_context *ictx = NULL; 440 int retval = 0; 441 442 ictx = file->private_data; 443 444 if (!ictx) { 445 pr_err("no context for device\n"); 446 return -ENODEV; 447 } 448 449 mutex_lock(&ictx->lock); 450 451 if (!ictx->display_supported) { 452 pr_err("display not supported by device\n"); 453 retval = -ENODEV; 454 } else if (!ictx->display_isopen) { 455 pr_err("display is not open\n"); 456 retval = -EIO; 457 } else { 458 ictx->display_isopen = false; 459 dev_dbg(ictx->dev, "display port closed\n"); 460 } 461 462 mutex_unlock(&ictx->lock); 463 return retval; 464 } 465 466 /** 467 * Sends a packet to the device -- this function must be called with 468 * ictx->lock held, or its unlock/lock sequence while waiting for tx 469 * to complete can/will lead to a deadlock. 470 */ 471 static int send_packet(struct imon_context *ictx) 472 { 473 unsigned int pipe; 474 unsigned long timeout; 475 int interval = 0; 476 int retval = 0; 477 struct usb_ctrlrequest *control_req = NULL; 478 479 /* Check if we need to use control or interrupt urb */ 480 if (!ictx->tx_control) { 481 pipe = usb_sndintpipe(ictx->usbdev_intf0, 482 ictx->tx_endpoint->bEndpointAddress); 483 interval = ictx->tx_endpoint->bInterval; 484 485 usb_fill_int_urb(ictx->tx_urb, ictx->usbdev_intf0, pipe, 486 ictx->usb_tx_buf, 487 sizeof(ictx->usb_tx_buf), 488 usb_tx_callback, ictx, interval); 489 490 ictx->tx_urb->actual_length = 0; 491 } else { 492 /* fill request into kmalloc'ed space: */ 493 control_req = kmalloc(sizeof(struct usb_ctrlrequest), 494 GFP_KERNEL); 495 if (control_req == NULL) 496 return -ENOMEM; 497 498 /* setup packet is '21 09 0200 0001 0008' */ 499 control_req->bRequestType = 0x21; 500 control_req->bRequest = 0x09; 501 control_req->wValue = cpu_to_le16(0x0200); 502 control_req->wIndex = cpu_to_le16(0x0001); 503 control_req->wLength = cpu_to_le16(0x0008); 504 505 /* control pipe is endpoint 0x00 */ 506 pipe = usb_sndctrlpipe(ictx->usbdev_intf0, 0); 507 508 /* build the control urb */ 509 usb_fill_control_urb(ictx->tx_urb, ictx->usbdev_intf0, 510 pipe, (unsigned char *)control_req, 511 ictx->usb_tx_buf, 512 sizeof(ictx->usb_tx_buf), 513 usb_tx_callback, ictx); 514 ictx->tx_urb->actual_length = 0; 515 } 516 517 init_completion(&ictx->tx.finished); 518 ictx->tx.busy = true; 519 smp_rmb(); /* ensure later readers know we're busy */ 520 521 retval = usb_submit_urb(ictx->tx_urb, GFP_KERNEL); 522 if (retval) { 523 ictx->tx.busy = false; 524 smp_rmb(); /* ensure later readers know we're not busy */ 525 pr_err_ratelimited("error submitting urb(%d)\n", retval); 526 } else { 527 /* Wait for transmission to complete (or abort) */ 528 mutex_unlock(&ictx->lock); 529 retval = wait_for_completion_interruptible( 530 &ictx->tx.finished); 531 if (retval) { 532 usb_kill_urb(ictx->tx_urb); 533 pr_err_ratelimited("task interrupted\n"); 534 } 535 mutex_lock(&ictx->lock); 536 537 retval = ictx->tx.status; 538 if (retval) 539 pr_err_ratelimited("packet tx failed (%d)\n", retval); 540 } 541 542 kfree(control_req); 543 544 /* 545 * Induce a mandatory delay before returning, as otherwise, 546 * send_packet can get called so rapidly as to overwhelm the device, 547 * particularly on faster systems and/or those with quirky usb. 548 */ 549 timeout = msecs_to_jiffies(ictx->send_packet_delay); 550 set_current_state(TASK_INTERRUPTIBLE); 551 schedule_timeout(timeout); 552 553 return retval; 554 } 555 556 /** 557 * Sends an associate packet to the iMON 2.4G. 558 * 559 * This might not be such a good idea, since it has an id collision with 560 * some versions of the "IR & VFD" combo. The only way to determine if it 561 * is an RF version is to look at the product description string. (Which 562 * we currently do not fetch). 563 */ 564 static int send_associate_24g(struct imon_context *ictx) 565 { 566 int retval; 567 const unsigned char packet[8] = { 0x01, 0x00, 0x00, 0x00, 568 0x00, 0x00, 0x00, 0x20 }; 569 570 if (!ictx) { 571 pr_err("no context for device\n"); 572 return -ENODEV; 573 } 574 575 if (!ictx->dev_present_intf0) { 576 pr_err("no iMON device present\n"); 577 return -ENODEV; 578 } 579 580 memcpy(ictx->usb_tx_buf, packet, sizeof(packet)); 581 retval = send_packet(ictx); 582 583 return retval; 584 } 585 586 /** 587 * Sends packets to setup and show clock on iMON display 588 * 589 * Arguments: year - last 2 digits of year, month - 1..12, 590 * day - 1..31, dow - day of the week (0-Sun...6-Sat), 591 * hour - 0..23, minute - 0..59, second - 0..59 592 */ 593 static int send_set_imon_clock(struct imon_context *ictx, 594 unsigned int year, unsigned int month, 595 unsigned int day, unsigned int dow, 596 unsigned int hour, unsigned int minute, 597 unsigned int second) 598 { 599 unsigned char clock_enable_pkt[IMON_CLOCK_ENABLE_PACKETS][8]; 600 int retval = 0; 601 int i; 602 603 if (!ictx) { 604 pr_err("no context for device\n"); 605 return -ENODEV; 606 } 607 608 switch (ictx->display_type) { 609 case IMON_DISPLAY_TYPE_LCD: 610 clock_enable_pkt[0][0] = 0x80; 611 clock_enable_pkt[0][1] = year; 612 clock_enable_pkt[0][2] = month-1; 613 clock_enable_pkt[0][3] = day; 614 clock_enable_pkt[0][4] = hour; 615 clock_enable_pkt[0][5] = minute; 616 clock_enable_pkt[0][6] = second; 617 618 clock_enable_pkt[1][0] = 0x80; 619 clock_enable_pkt[1][1] = 0; 620 clock_enable_pkt[1][2] = 0; 621 clock_enable_pkt[1][3] = 0; 622 clock_enable_pkt[1][4] = 0; 623 clock_enable_pkt[1][5] = 0; 624 clock_enable_pkt[1][6] = 0; 625 626 if (ictx->product == 0xffdc) { 627 clock_enable_pkt[0][7] = 0x50; 628 clock_enable_pkt[1][7] = 0x51; 629 } else { 630 clock_enable_pkt[0][7] = 0x88; 631 clock_enable_pkt[1][7] = 0x8a; 632 } 633 634 break; 635 636 case IMON_DISPLAY_TYPE_VFD: 637 clock_enable_pkt[0][0] = year; 638 clock_enable_pkt[0][1] = month-1; 639 clock_enable_pkt[0][2] = day; 640 clock_enable_pkt[0][3] = dow; 641 clock_enable_pkt[0][4] = hour; 642 clock_enable_pkt[0][5] = minute; 643 clock_enable_pkt[0][6] = second; 644 clock_enable_pkt[0][7] = 0x40; 645 646 clock_enable_pkt[1][0] = 0; 647 clock_enable_pkt[1][1] = 0; 648 clock_enable_pkt[1][2] = 1; 649 clock_enable_pkt[1][3] = 0; 650 clock_enable_pkt[1][4] = 0; 651 clock_enable_pkt[1][5] = 0; 652 clock_enable_pkt[1][6] = 0; 653 clock_enable_pkt[1][7] = 0x42; 654 655 break; 656 657 default: 658 return -ENODEV; 659 } 660 661 for (i = 0; i < IMON_CLOCK_ENABLE_PACKETS; i++) { 662 memcpy(ictx->usb_tx_buf, clock_enable_pkt[i], 8); 663 retval = send_packet(ictx); 664 if (retval) { 665 pr_err("send_packet failed for packet %d\n", i); 666 break; 667 } 668 } 669 670 return retval; 671 } 672 673 /** 674 * These are the sysfs functions to handle the association on the iMON 2.4G LT. 675 */ 676 static ssize_t show_associate_remote(struct device *d, 677 struct device_attribute *attr, 678 char *buf) 679 { 680 struct imon_context *ictx = dev_get_drvdata(d); 681 682 if (!ictx) 683 return -ENODEV; 684 685 mutex_lock(&ictx->lock); 686 if (ictx->rf_isassociating) 687 strcpy(buf, "associating\n"); 688 else 689 strcpy(buf, "closed\n"); 690 691 dev_info(d, "Visit http://www.lirc.org/html/imon-24g.html for " 692 "instructions on how to associate your iMON 2.4G DT/LT " 693 "remote\n"); 694 mutex_unlock(&ictx->lock); 695 return strlen(buf); 696 } 697 698 static ssize_t store_associate_remote(struct device *d, 699 struct device_attribute *attr, 700 const char *buf, size_t count) 701 { 702 struct imon_context *ictx; 703 704 ictx = dev_get_drvdata(d); 705 706 if (!ictx) 707 return -ENODEV; 708 709 mutex_lock(&ictx->lock); 710 ictx->rf_isassociating = true; 711 send_associate_24g(ictx); 712 mutex_unlock(&ictx->lock); 713 714 return count; 715 } 716 717 /** 718 * sysfs functions to control internal imon clock 719 */ 720 static ssize_t show_imon_clock(struct device *d, 721 struct device_attribute *attr, char *buf) 722 { 723 struct imon_context *ictx = dev_get_drvdata(d); 724 size_t len; 725 726 if (!ictx) 727 return -ENODEV; 728 729 mutex_lock(&ictx->lock); 730 731 if (!ictx->display_supported) { 732 len = snprintf(buf, PAGE_SIZE, "Not supported."); 733 } else { 734 len = snprintf(buf, PAGE_SIZE, 735 "To set the clock on your iMON display:\n" 736 "# date \"+%%y %%m %%d %%w %%H %%M %%S\" > imon_clock\n" 737 "%s", ictx->display_isopen ? 738 "\nNOTE: imon device must be closed\n" : ""); 739 } 740 741 mutex_unlock(&ictx->lock); 742 743 return len; 744 } 745 746 static ssize_t store_imon_clock(struct device *d, 747 struct device_attribute *attr, 748 const char *buf, size_t count) 749 { 750 struct imon_context *ictx = dev_get_drvdata(d); 751 ssize_t retval; 752 unsigned int year, month, day, dow, hour, minute, second; 753 754 if (!ictx) 755 return -ENODEV; 756 757 mutex_lock(&ictx->lock); 758 759 if (!ictx->display_supported) { 760 retval = -ENODEV; 761 goto exit; 762 } else if (ictx->display_isopen) { 763 retval = -EBUSY; 764 goto exit; 765 } 766 767 if (sscanf(buf, "%u %u %u %u %u %u %u", &year, &month, &day, &dow, 768 &hour, &minute, &second) != 7) { 769 retval = -EINVAL; 770 goto exit; 771 } 772 773 if ((month < 1 || month > 12) || 774 (day < 1 || day > 31) || (dow > 6) || 775 (hour > 23) || (minute > 59) || (second > 59)) { 776 retval = -EINVAL; 777 goto exit; 778 } 779 780 retval = send_set_imon_clock(ictx, year, month, day, dow, 781 hour, minute, second); 782 if (retval) 783 goto exit; 784 785 retval = count; 786 exit: 787 mutex_unlock(&ictx->lock); 788 789 return retval; 790 } 791 792 793 static DEVICE_ATTR(imon_clock, S_IWUSR | S_IRUGO, show_imon_clock, 794 store_imon_clock); 795 796 static DEVICE_ATTR(associate_remote, S_IWUSR | S_IRUGO, show_associate_remote, 797 store_associate_remote); 798 799 static struct attribute *imon_display_sysfs_entries[] = { 800 &dev_attr_imon_clock.attr, 801 NULL 802 }; 803 804 static struct attribute_group imon_display_attr_group = { 805 .attrs = imon_display_sysfs_entries 806 }; 807 808 static struct attribute *imon_rf_sysfs_entries[] = { 809 &dev_attr_associate_remote.attr, 810 NULL 811 }; 812 813 static struct attribute_group imon_rf_attr_group = { 814 .attrs = imon_rf_sysfs_entries 815 }; 816 817 /** 818 * Writes data to the VFD. The iMON VFD is 2x16 characters 819 * and requires data in 5 consecutive USB interrupt packets, 820 * each packet but the last carrying 7 bytes. 821 * 822 * I don't know if the VFD board supports features such as 823 * scrolling, clearing rows, blanking, etc. so at 824 * the caller must provide a full screen of data. If fewer 825 * than 32 bytes are provided spaces will be appended to 826 * generate a full screen. 827 */ 828 static ssize_t vfd_write(struct file *file, const char __user *buf, 829 size_t n_bytes, loff_t *pos) 830 { 831 int i; 832 int offset; 833 int seq; 834 int retval = 0; 835 struct imon_context *ictx; 836 const unsigned char vfd_packet6[] = { 837 0x01, 0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF }; 838 839 ictx = file->private_data; 840 if (!ictx) { 841 pr_err_ratelimited("no context for device\n"); 842 return -ENODEV; 843 } 844 845 mutex_lock(&ictx->lock); 846 847 if (!ictx->dev_present_intf0) { 848 pr_err_ratelimited("no iMON device present\n"); 849 retval = -ENODEV; 850 goto exit; 851 } 852 853 if (n_bytes <= 0 || n_bytes > 32) { 854 pr_err_ratelimited("invalid payload size\n"); 855 retval = -EINVAL; 856 goto exit; 857 } 858 859 if (copy_from_user(ictx->tx.data_buf, buf, n_bytes)) { 860 retval = -EFAULT; 861 goto exit; 862 } 863 864 /* Pad with spaces */ 865 for (i = n_bytes; i < 32; ++i) 866 ictx->tx.data_buf[i] = ' '; 867 868 for (i = 32; i < 35; ++i) 869 ictx->tx.data_buf[i] = 0xFF; 870 871 offset = 0; 872 seq = 0; 873 874 do { 875 memcpy(ictx->usb_tx_buf, ictx->tx.data_buf + offset, 7); 876 ictx->usb_tx_buf[7] = (unsigned char) seq; 877 878 retval = send_packet(ictx); 879 if (retval) { 880 pr_err_ratelimited("send packet #%d failed\n", seq / 2); 881 goto exit; 882 } else { 883 seq += 2; 884 offset += 7; 885 } 886 887 } while (offset < 35); 888 889 /* Send packet #6 */ 890 memcpy(ictx->usb_tx_buf, &vfd_packet6, sizeof(vfd_packet6)); 891 ictx->usb_tx_buf[7] = (unsigned char) seq; 892 retval = send_packet(ictx); 893 if (retval) 894 pr_err_ratelimited("send packet #%d failed\n", seq / 2); 895 896 exit: 897 mutex_unlock(&ictx->lock); 898 899 return (!retval) ? n_bytes : retval; 900 } 901 902 /** 903 * Writes data to the LCD. The iMON OEM LCD screen expects 8-byte 904 * packets. We accept data as 16 hexadecimal digits, followed by a 905 * newline (to make it easy to drive the device from a command-line 906 * -- even though the actual binary data is a bit complicated). 907 * 908 * The device itself is not a "traditional" text-mode display. It's 909 * actually a 16x96 pixel bitmap display. That means if you want to 910 * display text, you've got to have your own "font" and translate the 911 * text into bitmaps for display. This is really flexible (you can 912 * display whatever diacritics you need, and so on), but it's also 913 * a lot more complicated than most LCDs... 914 */ 915 static ssize_t lcd_write(struct file *file, const char __user *buf, 916 size_t n_bytes, loff_t *pos) 917 { 918 int retval = 0; 919 struct imon_context *ictx; 920 921 ictx = file->private_data; 922 if (!ictx) { 923 pr_err_ratelimited("no context for device\n"); 924 return -ENODEV; 925 } 926 927 mutex_lock(&ictx->lock); 928 929 if (!ictx->display_supported) { 930 pr_err_ratelimited("no iMON display present\n"); 931 retval = -ENODEV; 932 goto exit; 933 } 934 935 if (n_bytes != 8) { 936 pr_err_ratelimited("invalid payload size: %d (expected 8)\n", 937 (int)n_bytes); 938 retval = -EINVAL; 939 goto exit; 940 } 941 942 if (copy_from_user(ictx->usb_tx_buf, buf, 8)) { 943 retval = -EFAULT; 944 goto exit; 945 } 946 947 retval = send_packet(ictx); 948 if (retval) { 949 pr_err_ratelimited("send packet failed!\n"); 950 goto exit; 951 } else { 952 dev_dbg(ictx->dev, "%s: write %d bytes to LCD\n", 953 __func__, (int) n_bytes); 954 } 955 exit: 956 mutex_unlock(&ictx->lock); 957 return (!retval) ? n_bytes : retval; 958 } 959 960 /** 961 * Callback function for USB core API: transmit data 962 */ 963 static void usb_tx_callback(struct urb *urb) 964 { 965 struct imon_context *ictx; 966 967 if (!urb) 968 return; 969 ictx = (struct imon_context *)urb->context; 970 if (!ictx) 971 return; 972 973 ictx->tx.status = urb->status; 974 975 /* notify waiters that write has finished */ 976 ictx->tx.busy = false; 977 smp_rmb(); /* ensure later readers know we're not busy */ 978 complete(&ictx->tx.finished); 979 } 980 981 /** 982 * report touchscreen input 983 */ 984 static void imon_touch_display_timeout(unsigned long data) 985 { 986 struct imon_context *ictx = (struct imon_context *)data; 987 988 if (ictx->display_type != IMON_DISPLAY_TYPE_VGA) 989 return; 990 991 input_report_abs(ictx->touch, ABS_X, ictx->touch_x); 992 input_report_abs(ictx->touch, ABS_Y, ictx->touch_y); 993 input_report_key(ictx->touch, BTN_TOUCH, 0x00); 994 input_sync(ictx->touch); 995 } 996 997 /** 998 * iMON IR receivers support two different signal sets -- those used by 999 * the iMON remotes, and those used by the Windows MCE remotes (which is 1000 * really just RC-6), but only one or the other at a time, as the signals 1001 * are decoded onboard the receiver. 1002 * 1003 * This function gets called two different ways, one way is from 1004 * rc_register_device, for initial protocol selection/setup, and the other is 1005 * via a userspace-initiated protocol change request, either by direct sysfs 1006 * prodding or by something like ir-keytable. In the rc_register_device case, 1007 * the imon context lock is already held, but when initiated from userspace, 1008 * it is not, so we must acquire it prior to calling send_packet, which 1009 * requires that the lock is held. 1010 */ 1011 static int imon_ir_change_protocol(struct rc_dev *rc, u64 *rc_type) 1012 { 1013 int retval; 1014 struct imon_context *ictx = rc->priv; 1015 struct device *dev = ictx->dev; 1016 bool unlock = false; 1017 unsigned char ir_proto_packet[] = { 1018 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x86 }; 1019 1020 if (*rc_type && !(*rc_type & rc->allowed_protocols)) 1021 dev_warn(dev, "Looks like you're trying to use an IR protocol " 1022 "this device does not support\n"); 1023 1024 if (*rc_type & RC_BIT_RC6_MCE) { 1025 dev_dbg(dev, "Configuring IR receiver for MCE protocol\n"); 1026 ir_proto_packet[0] = 0x01; 1027 *rc_type = RC_BIT_RC6_MCE; 1028 } else if (*rc_type & RC_BIT_OTHER) { 1029 dev_dbg(dev, "Configuring IR receiver for iMON protocol\n"); 1030 if (!pad_stabilize) 1031 dev_dbg(dev, "PAD stabilize functionality disabled\n"); 1032 /* ir_proto_packet[0] = 0x00; // already the default */ 1033 *rc_type = RC_BIT_OTHER; 1034 } else { 1035 dev_warn(dev, "Unsupported IR protocol specified, overriding " 1036 "to iMON IR protocol\n"); 1037 if (!pad_stabilize) 1038 dev_dbg(dev, "PAD stabilize functionality disabled\n"); 1039 /* ir_proto_packet[0] = 0x00; // already the default */ 1040 *rc_type = RC_BIT_OTHER; 1041 } 1042 1043 memcpy(ictx->usb_tx_buf, &ir_proto_packet, sizeof(ir_proto_packet)); 1044 1045 if (!mutex_is_locked(&ictx->lock)) { 1046 unlock = true; 1047 mutex_lock(&ictx->lock); 1048 } 1049 1050 retval = send_packet(ictx); 1051 if (retval) 1052 goto out; 1053 1054 ictx->rc_type = *rc_type; 1055 ictx->pad_mouse = false; 1056 1057 out: 1058 if (unlock) 1059 mutex_unlock(&ictx->lock); 1060 1061 return retval; 1062 } 1063 1064 static inline int tv2int(const struct timeval *a, const struct timeval *b) 1065 { 1066 int usecs = 0; 1067 int sec = 0; 1068 1069 if (b->tv_usec > a->tv_usec) { 1070 usecs = 1000000; 1071 sec--; 1072 } 1073 1074 usecs += a->tv_usec - b->tv_usec; 1075 1076 sec += a->tv_sec - b->tv_sec; 1077 sec *= 1000; 1078 usecs /= 1000; 1079 sec += usecs; 1080 1081 if (sec < 0) 1082 sec = 1000; 1083 1084 return sec; 1085 } 1086 1087 /** 1088 * The directional pad behaves a bit differently, depending on whether this is 1089 * one of the older ffdc devices or a newer device. Newer devices appear to 1090 * have a higher resolution matrix for more precise mouse movement, but it 1091 * makes things overly sensitive in keyboard mode, so we do some interesting 1092 * contortions to make it less touchy. Older devices run through the same 1093 * routine with shorter timeout and a smaller threshold. 1094 */ 1095 static int stabilize(int a, int b, u16 timeout, u16 threshold) 1096 { 1097 struct timeval ct; 1098 static struct timeval prev_time = {0, 0}; 1099 static struct timeval hit_time = {0, 0}; 1100 static int x, y, prev_result, hits; 1101 int result = 0; 1102 int msec, msec_hit; 1103 1104 do_gettimeofday(&ct); 1105 msec = tv2int(&ct, &prev_time); 1106 msec_hit = tv2int(&ct, &hit_time); 1107 1108 if (msec > 100) { 1109 x = 0; 1110 y = 0; 1111 hits = 0; 1112 } 1113 1114 x += a; 1115 y += b; 1116 1117 prev_time = ct; 1118 1119 if (abs(x) > threshold || abs(y) > threshold) { 1120 if (abs(y) > abs(x)) 1121 result = (y > 0) ? 0x7F : 0x80; 1122 else 1123 result = (x > 0) ? 0x7F00 : 0x8000; 1124 1125 x = 0; 1126 y = 0; 1127 1128 if (result == prev_result) { 1129 hits++; 1130 1131 if (hits > 3) { 1132 switch (result) { 1133 case 0x7F: 1134 y = 17 * threshold / 30; 1135 break; 1136 case 0x80: 1137 y -= 17 * threshold / 30; 1138 break; 1139 case 0x7F00: 1140 x = 17 * threshold / 30; 1141 break; 1142 case 0x8000: 1143 x -= 17 * threshold / 30; 1144 break; 1145 } 1146 } 1147 1148 if (hits == 2 && msec_hit < timeout) { 1149 result = 0; 1150 hits = 1; 1151 } 1152 } else { 1153 prev_result = result; 1154 hits = 1; 1155 hit_time = ct; 1156 } 1157 } 1158 1159 return result; 1160 } 1161 1162 static u32 imon_remote_key_lookup(struct imon_context *ictx, u32 scancode) 1163 { 1164 u32 keycode; 1165 u32 release; 1166 bool is_release_code = false; 1167 1168 /* Look for the initial press of a button */ 1169 keycode = rc_g_keycode_from_table(ictx->rdev, scancode); 1170 ictx->rc_toggle = 0x0; 1171 ictx->rc_scancode = scancode; 1172 1173 /* Look for the release of a button */ 1174 if (keycode == KEY_RESERVED) { 1175 release = scancode & ~0x4000; 1176 keycode = rc_g_keycode_from_table(ictx->rdev, release); 1177 if (keycode != KEY_RESERVED) 1178 is_release_code = true; 1179 } 1180 1181 ictx->release_code = is_release_code; 1182 1183 return keycode; 1184 } 1185 1186 static u32 imon_mce_key_lookup(struct imon_context *ictx, u32 scancode) 1187 { 1188 u32 keycode; 1189 1190 #define MCE_KEY_MASK 0x7000 1191 #define MCE_TOGGLE_BIT 0x8000 1192 1193 /* 1194 * On some receivers, mce keys decode to 0x8000f04xx and 0x8000f84xx 1195 * (the toggle bit flipping between alternating key presses), while 1196 * on other receivers, we see 0x8000f74xx and 0x8000ff4xx. To keep 1197 * the table trim, we always or in the bits to look up 0x8000ff4xx, 1198 * but we can't or them into all codes, as some keys are decoded in 1199 * a different way w/o the same use of the toggle bit... 1200 */ 1201 if (scancode & 0x80000000) 1202 scancode = scancode | MCE_KEY_MASK | MCE_TOGGLE_BIT; 1203 1204 ictx->rc_scancode = scancode; 1205 keycode = rc_g_keycode_from_table(ictx->rdev, scancode); 1206 1207 /* not used in mce mode, but make sure we know its false */ 1208 ictx->release_code = false; 1209 1210 return keycode; 1211 } 1212 1213 static u32 imon_panel_key_lookup(u64 code) 1214 { 1215 int i; 1216 u32 keycode = KEY_RESERVED; 1217 1218 for (i = 0; i < ARRAY_SIZE(imon_panel_key_table); i++) { 1219 if (imon_panel_key_table[i].hw_code == (code | 0xffee)) { 1220 keycode = imon_panel_key_table[i].keycode; 1221 break; 1222 } 1223 } 1224 1225 return keycode; 1226 } 1227 1228 static bool imon_mouse_event(struct imon_context *ictx, 1229 unsigned char *buf, int len) 1230 { 1231 signed char rel_x = 0x00, rel_y = 0x00; 1232 u8 right_shift = 1; 1233 bool mouse_input = true; 1234 int dir = 0; 1235 unsigned long flags; 1236 1237 spin_lock_irqsave(&ictx->kc_lock, flags); 1238 1239 /* newer iMON device PAD or mouse button */ 1240 if (ictx->product != 0xffdc && (buf[0] & 0x01) && len == 5) { 1241 rel_x = buf[2]; 1242 rel_y = buf[3]; 1243 right_shift = 1; 1244 /* 0xffdc iMON PAD or mouse button input */ 1245 } else if (ictx->product == 0xffdc && (buf[0] & 0x40) && 1246 !((buf[1] & 0x01) || ((buf[1] >> 2) & 0x01))) { 1247 rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 | 1248 (buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6; 1249 if (buf[0] & 0x02) 1250 rel_x |= ~0x0f; 1251 rel_x = rel_x + rel_x / 2; 1252 rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 | 1253 (buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6; 1254 if (buf[0] & 0x01) 1255 rel_y |= ~0x0f; 1256 rel_y = rel_y + rel_y / 2; 1257 right_shift = 2; 1258 /* some ffdc devices decode mouse buttons differently... */ 1259 } else if (ictx->product == 0xffdc && (buf[0] == 0x68)) { 1260 right_shift = 2; 1261 /* ch+/- buttons, which we use for an emulated scroll wheel */ 1262 } else if (ictx->kc == KEY_CHANNELUP && (buf[2] & 0x40) != 0x40) { 1263 dir = 1; 1264 } else if (ictx->kc == KEY_CHANNELDOWN && (buf[2] & 0x40) != 0x40) { 1265 dir = -1; 1266 } else 1267 mouse_input = false; 1268 1269 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1270 1271 if (mouse_input) { 1272 dev_dbg(ictx->dev, "sending mouse data via input subsystem\n"); 1273 1274 if (dir) { 1275 input_report_rel(ictx->idev, REL_WHEEL, dir); 1276 } else if (rel_x || rel_y) { 1277 input_report_rel(ictx->idev, REL_X, rel_x); 1278 input_report_rel(ictx->idev, REL_Y, rel_y); 1279 } else { 1280 input_report_key(ictx->idev, BTN_LEFT, buf[1] & 0x1); 1281 input_report_key(ictx->idev, BTN_RIGHT, 1282 buf[1] >> right_shift & 0x1); 1283 } 1284 input_sync(ictx->idev); 1285 spin_lock_irqsave(&ictx->kc_lock, flags); 1286 ictx->last_keycode = ictx->kc; 1287 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1288 } 1289 1290 return mouse_input; 1291 } 1292 1293 static void imon_touch_event(struct imon_context *ictx, unsigned char *buf) 1294 { 1295 mod_timer(&ictx->ttimer, jiffies + TOUCH_TIMEOUT); 1296 ictx->touch_x = (buf[0] << 4) | (buf[1] >> 4); 1297 ictx->touch_y = 0xfff - ((buf[2] << 4) | (buf[1] & 0xf)); 1298 input_report_abs(ictx->touch, ABS_X, ictx->touch_x); 1299 input_report_abs(ictx->touch, ABS_Y, ictx->touch_y); 1300 input_report_key(ictx->touch, BTN_TOUCH, 0x01); 1301 input_sync(ictx->touch); 1302 } 1303 1304 static void imon_pad_to_keys(struct imon_context *ictx, unsigned char *buf) 1305 { 1306 int dir = 0; 1307 signed char rel_x = 0x00, rel_y = 0x00; 1308 u16 timeout, threshold; 1309 u32 scancode = KEY_RESERVED; 1310 unsigned long flags; 1311 1312 /* 1313 * The imon directional pad functions more like a touchpad. Bytes 3 & 4 1314 * contain a position coordinate (x,y), with each component ranging 1315 * from -14 to 14. We want to down-sample this to only 4 discrete values 1316 * for up/down/left/right arrow keys. Also, when you get too close to 1317 * diagonals, it has a tendency to jump back and forth, so lets try to 1318 * ignore when they get too close. 1319 */ 1320 if (ictx->product != 0xffdc) { 1321 /* first, pad to 8 bytes so it conforms with everything else */ 1322 buf[5] = buf[6] = buf[7] = 0; 1323 timeout = 500; /* in msecs */ 1324 /* (2*threshold) x (2*threshold) square */ 1325 threshold = pad_thresh ? pad_thresh : 28; 1326 rel_x = buf[2]; 1327 rel_y = buf[3]; 1328 1329 if (ictx->rc_type == RC_BIT_OTHER && pad_stabilize) { 1330 if ((buf[1] == 0) && ((rel_x != 0) || (rel_y != 0))) { 1331 dir = stabilize((int)rel_x, (int)rel_y, 1332 timeout, threshold); 1333 if (!dir) { 1334 spin_lock_irqsave(&ictx->kc_lock, 1335 flags); 1336 ictx->kc = KEY_UNKNOWN; 1337 spin_unlock_irqrestore(&ictx->kc_lock, 1338 flags); 1339 return; 1340 } 1341 buf[2] = dir & 0xFF; 1342 buf[3] = (dir >> 8) & 0xFF; 1343 scancode = be32_to_cpu(*((u32 *)buf)); 1344 } 1345 } else { 1346 /* 1347 * Hack alert: instead of using keycodes, we have 1348 * to use hard-coded scancodes here... 1349 */ 1350 if (abs(rel_y) > abs(rel_x)) { 1351 buf[2] = (rel_y > 0) ? 0x7F : 0x80; 1352 buf[3] = 0; 1353 if (rel_y > 0) 1354 scancode = 0x01007f00; /* KEY_DOWN */ 1355 else 1356 scancode = 0x01008000; /* KEY_UP */ 1357 } else { 1358 buf[2] = 0; 1359 buf[3] = (rel_x > 0) ? 0x7F : 0x80; 1360 if (rel_x > 0) 1361 scancode = 0x0100007f; /* KEY_RIGHT */ 1362 else 1363 scancode = 0x01000080; /* KEY_LEFT */ 1364 } 1365 } 1366 1367 /* 1368 * Handle on-board decoded pad events for e.g. older VFD/iMON-Pad 1369 * device (15c2:ffdc). The remote generates various codes from 1370 * 0x68nnnnB7 to 0x6AnnnnB7, the left mouse button generates 1371 * 0x688301b7 and the right one 0x688481b7. All other keys generate 1372 * 0x2nnnnnnn. Position coordinate is encoded in buf[1] and buf[2] with 1373 * reversed endianness. Extract direction from buffer, rotate endianness, 1374 * adjust sign and feed the values into stabilize(). The resulting codes 1375 * will be 0x01008000, 0x01007F00, which match the newer devices. 1376 */ 1377 } else { 1378 timeout = 10; /* in msecs */ 1379 /* (2*threshold) x (2*threshold) square */ 1380 threshold = pad_thresh ? pad_thresh : 15; 1381 1382 /* buf[1] is x */ 1383 rel_x = (buf[1] & 0x08) | (buf[1] & 0x10) >> 2 | 1384 (buf[1] & 0x20) >> 4 | (buf[1] & 0x40) >> 6; 1385 if (buf[0] & 0x02) 1386 rel_x |= ~0x10+1; 1387 /* buf[2] is y */ 1388 rel_y = (buf[2] & 0x08) | (buf[2] & 0x10) >> 2 | 1389 (buf[2] & 0x20) >> 4 | (buf[2] & 0x40) >> 6; 1390 if (buf[0] & 0x01) 1391 rel_y |= ~0x10+1; 1392 1393 buf[0] = 0x01; 1394 buf[1] = buf[4] = buf[5] = buf[6] = buf[7] = 0; 1395 1396 if (ictx->rc_type == RC_BIT_OTHER && pad_stabilize) { 1397 dir = stabilize((int)rel_x, (int)rel_y, 1398 timeout, threshold); 1399 if (!dir) { 1400 spin_lock_irqsave(&ictx->kc_lock, flags); 1401 ictx->kc = KEY_UNKNOWN; 1402 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1403 return; 1404 } 1405 buf[2] = dir & 0xFF; 1406 buf[3] = (dir >> 8) & 0xFF; 1407 scancode = be32_to_cpu(*((u32 *)buf)); 1408 } else { 1409 /* 1410 * Hack alert: instead of using keycodes, we have 1411 * to use hard-coded scancodes here... 1412 */ 1413 if (abs(rel_y) > abs(rel_x)) { 1414 buf[2] = (rel_y > 0) ? 0x7F : 0x80; 1415 buf[3] = 0; 1416 if (rel_y > 0) 1417 scancode = 0x01007f00; /* KEY_DOWN */ 1418 else 1419 scancode = 0x01008000; /* KEY_UP */ 1420 } else { 1421 buf[2] = 0; 1422 buf[3] = (rel_x > 0) ? 0x7F : 0x80; 1423 if (rel_x > 0) 1424 scancode = 0x0100007f; /* KEY_RIGHT */ 1425 else 1426 scancode = 0x01000080; /* KEY_LEFT */ 1427 } 1428 } 1429 } 1430 1431 if (scancode) { 1432 spin_lock_irqsave(&ictx->kc_lock, flags); 1433 ictx->kc = imon_remote_key_lookup(ictx, scancode); 1434 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1435 } 1436 } 1437 1438 /** 1439 * figure out if these is a press or a release. We don't actually 1440 * care about repeats, as those will be auto-generated within the IR 1441 * subsystem for repeating scancodes. 1442 */ 1443 static int imon_parse_press_type(struct imon_context *ictx, 1444 unsigned char *buf, u8 ktype) 1445 { 1446 int press_type = 0; 1447 unsigned long flags; 1448 1449 spin_lock_irqsave(&ictx->kc_lock, flags); 1450 1451 /* key release of 0x02XXXXXX key */ 1452 if (ictx->kc == KEY_RESERVED && buf[0] == 0x02 && buf[3] == 0x00) 1453 ictx->kc = ictx->last_keycode; 1454 1455 /* mouse button release on (some) 0xffdc devices */ 1456 else if (ictx->kc == KEY_RESERVED && buf[0] == 0x68 && buf[1] == 0x82 && 1457 buf[2] == 0x81 && buf[3] == 0xb7) 1458 ictx->kc = ictx->last_keycode; 1459 1460 /* mouse button release on (some other) 0xffdc devices */ 1461 else if (ictx->kc == KEY_RESERVED && buf[0] == 0x01 && buf[1] == 0x00 && 1462 buf[2] == 0x81 && buf[3] == 0xb7) 1463 ictx->kc = ictx->last_keycode; 1464 1465 /* mce-specific button handling, no keyup events */ 1466 else if (ktype == IMON_KEY_MCE) { 1467 ictx->rc_toggle = buf[2]; 1468 press_type = 1; 1469 1470 /* incoherent or irrelevant data */ 1471 } else if (ictx->kc == KEY_RESERVED) 1472 press_type = -EINVAL; 1473 1474 /* key release of 0xXXXXXXb7 key */ 1475 else if (ictx->release_code) 1476 press_type = 0; 1477 1478 /* this is a button press */ 1479 else 1480 press_type = 1; 1481 1482 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1483 1484 return press_type; 1485 } 1486 1487 /** 1488 * Process the incoming packet 1489 */ 1490 static void imon_incoming_packet(struct imon_context *ictx, 1491 struct urb *urb, int intf) 1492 { 1493 int len = urb->actual_length; 1494 unsigned char *buf = urb->transfer_buffer; 1495 struct device *dev = ictx->dev; 1496 unsigned long flags; 1497 u32 kc; 1498 int i; 1499 u64 scancode; 1500 int press_type = 0; 1501 int msec; 1502 struct timeval t; 1503 static struct timeval prev_time = { 0, 0 }; 1504 u8 ktype; 1505 1506 /* filter out junk data on the older 0xffdc imon devices */ 1507 if ((buf[0] == 0xff) && (buf[1] == 0xff) && (buf[2] == 0xff)) 1508 return; 1509 1510 /* Figure out what key was pressed */ 1511 if (len == 8 && buf[7] == 0xee) { 1512 scancode = be64_to_cpu(*((u64 *)buf)); 1513 ktype = IMON_KEY_PANEL; 1514 kc = imon_panel_key_lookup(scancode); 1515 } else { 1516 scancode = be32_to_cpu(*((u32 *)buf)); 1517 if (ictx->rc_type == RC_BIT_RC6_MCE) { 1518 ktype = IMON_KEY_IMON; 1519 if (buf[0] == 0x80) 1520 ktype = IMON_KEY_MCE; 1521 kc = imon_mce_key_lookup(ictx, scancode); 1522 } else { 1523 ktype = IMON_KEY_IMON; 1524 kc = imon_remote_key_lookup(ictx, scancode); 1525 } 1526 } 1527 1528 spin_lock_irqsave(&ictx->kc_lock, flags); 1529 /* keyboard/mouse mode toggle button */ 1530 if (kc == KEY_KEYBOARD && !ictx->release_code) { 1531 ictx->last_keycode = kc; 1532 if (!nomouse) { 1533 ictx->pad_mouse = ~(ictx->pad_mouse) & 0x1; 1534 dev_dbg(dev, "toggling to %s mode\n", 1535 ictx->pad_mouse ? "mouse" : "keyboard"); 1536 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1537 return; 1538 } else { 1539 ictx->pad_mouse = false; 1540 dev_dbg(dev, "mouse mode disabled, passing key value\n"); 1541 } 1542 } 1543 1544 ictx->kc = kc; 1545 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1546 1547 /* send touchscreen events through input subsystem if touchpad data */ 1548 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA && len == 8 && 1549 buf[7] == 0x86) { 1550 imon_touch_event(ictx, buf); 1551 return; 1552 1553 /* look for mouse events with pad in mouse mode */ 1554 } else if (ictx->pad_mouse) { 1555 if (imon_mouse_event(ictx, buf, len)) 1556 return; 1557 } 1558 1559 /* Now for some special handling to convert pad input to arrow keys */ 1560 if (((len == 5) && (buf[0] == 0x01) && (buf[4] == 0x00)) || 1561 ((len == 8) && (buf[0] & 0x40) && 1562 !(buf[1] & 0x1 || buf[1] >> 2 & 0x1))) { 1563 len = 8; 1564 imon_pad_to_keys(ictx, buf); 1565 } 1566 1567 if (debug) { 1568 printk(KERN_INFO "intf%d decoded packet: ", intf); 1569 for (i = 0; i < len; ++i) 1570 printk("%02x ", buf[i]); 1571 printk("\n"); 1572 } 1573 1574 press_type = imon_parse_press_type(ictx, buf, ktype); 1575 if (press_type < 0) 1576 goto not_input_data; 1577 1578 if (ktype != IMON_KEY_PANEL) { 1579 if (press_type == 0) 1580 rc_keyup(ictx->rdev); 1581 else { 1582 if (ictx->rc_type == RC_BIT_RC6_MCE) 1583 rc_keydown(ictx->rdev, 1584 ictx->rc_type == RC_BIT_RC6_MCE ? RC_TYPE_RC6_MCE : RC_TYPE_OTHER, 1585 ictx->rc_scancode, ictx->rc_toggle); 1586 spin_lock_irqsave(&ictx->kc_lock, flags); 1587 ictx->last_keycode = ictx->kc; 1588 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1589 } 1590 return; 1591 } 1592 1593 /* Only panel type events left to process now */ 1594 spin_lock_irqsave(&ictx->kc_lock, flags); 1595 1596 do_gettimeofday(&t); 1597 /* KEY_MUTE repeats from knob need to be suppressed */ 1598 if (ictx->kc == KEY_MUTE && ictx->kc == ictx->last_keycode) { 1599 msec = tv2int(&t, &prev_time); 1600 if (msec < ictx->idev->rep[REP_DELAY]) { 1601 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1602 return; 1603 } 1604 } 1605 prev_time = t; 1606 kc = ictx->kc; 1607 1608 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1609 1610 input_report_key(ictx->idev, kc, press_type); 1611 input_sync(ictx->idev); 1612 1613 /* panel keys don't generate a release */ 1614 input_report_key(ictx->idev, kc, 0); 1615 input_sync(ictx->idev); 1616 1617 spin_lock_irqsave(&ictx->kc_lock, flags); 1618 ictx->last_keycode = kc; 1619 spin_unlock_irqrestore(&ictx->kc_lock, flags); 1620 1621 return; 1622 1623 not_input_data: 1624 if (len != 8) { 1625 dev_warn(dev, "imon %s: invalid incoming packet " 1626 "size (len = %d, intf%d)\n", __func__, len, intf); 1627 return; 1628 } 1629 1630 /* iMON 2.4G associate frame */ 1631 if (buf[0] == 0x00 && 1632 buf[2] == 0xFF && /* REFID */ 1633 buf[3] == 0xFF && 1634 buf[4] == 0xFF && 1635 buf[5] == 0xFF && /* iMON 2.4G */ 1636 ((buf[6] == 0x4E && buf[7] == 0xDF) || /* LT */ 1637 (buf[6] == 0x5E && buf[7] == 0xDF))) { /* DT */ 1638 dev_warn(dev, "%s: remote associated refid=%02X\n", 1639 __func__, buf[1]); 1640 ictx->rf_isassociating = false; 1641 } 1642 } 1643 1644 /** 1645 * Callback function for USB core API: receive data 1646 */ 1647 static void usb_rx_callback_intf0(struct urb *urb) 1648 { 1649 struct imon_context *ictx; 1650 int intfnum = 0; 1651 1652 if (!urb) 1653 return; 1654 1655 ictx = (struct imon_context *)urb->context; 1656 if (!ictx) 1657 return; 1658 1659 /* 1660 * if we get a callback before we're done configuring the hardware, we 1661 * can't yet process the data, as there's nowhere to send it, but we 1662 * still need to submit a new rx URB to avoid wedging the hardware 1663 */ 1664 if (!ictx->dev_present_intf0) 1665 goto out; 1666 1667 switch (urb->status) { 1668 case -ENOENT: /* usbcore unlink successful! */ 1669 return; 1670 1671 case -ESHUTDOWN: /* transport endpoint was shut down */ 1672 break; 1673 1674 case 0: 1675 imon_incoming_packet(ictx, urb, intfnum); 1676 break; 1677 1678 default: 1679 dev_warn(ictx->dev, "imon %s: status(%d): ignored\n", 1680 __func__, urb->status); 1681 break; 1682 } 1683 1684 out: 1685 usb_submit_urb(ictx->rx_urb_intf0, GFP_ATOMIC); 1686 } 1687 1688 static void usb_rx_callback_intf1(struct urb *urb) 1689 { 1690 struct imon_context *ictx; 1691 int intfnum = 1; 1692 1693 if (!urb) 1694 return; 1695 1696 ictx = (struct imon_context *)urb->context; 1697 if (!ictx) 1698 return; 1699 1700 /* 1701 * if we get a callback before we're done configuring the hardware, we 1702 * can't yet process the data, as there's nowhere to send it, but we 1703 * still need to submit a new rx URB to avoid wedging the hardware 1704 */ 1705 if (!ictx->dev_present_intf1) 1706 goto out; 1707 1708 switch (urb->status) { 1709 case -ENOENT: /* usbcore unlink successful! */ 1710 return; 1711 1712 case -ESHUTDOWN: /* transport endpoint was shut down */ 1713 break; 1714 1715 case 0: 1716 imon_incoming_packet(ictx, urb, intfnum); 1717 break; 1718 1719 default: 1720 dev_warn(ictx->dev, "imon %s: status(%d): ignored\n", 1721 __func__, urb->status); 1722 break; 1723 } 1724 1725 out: 1726 usb_submit_urb(ictx->rx_urb_intf1, GFP_ATOMIC); 1727 } 1728 1729 /* 1730 * The 0x15c2:0xffdc device ID was used for umpteen different imon 1731 * devices, and all of them constantly spew interrupts, even when there 1732 * is no actual data to report. However, byte 6 of this buffer looks like 1733 * its unique across device variants, so we're trying to key off that to 1734 * figure out which display type (if any) and what IR protocol the device 1735 * actually supports. These devices have their IR protocol hard-coded into 1736 * their firmware, they can't be changed on the fly like the newer hardware. 1737 */ 1738 static void imon_get_ffdc_type(struct imon_context *ictx) 1739 { 1740 u8 ffdc_cfg_byte = ictx->usb_rx_buf[6]; 1741 u8 detected_display_type = IMON_DISPLAY_TYPE_NONE; 1742 u64 allowed_protos = RC_BIT_OTHER; 1743 1744 switch (ffdc_cfg_byte) { 1745 /* iMON Knob, no display, iMON IR + vol knob */ 1746 case 0x21: 1747 dev_info(ictx->dev, "0xffdc iMON Knob, iMON IR"); 1748 ictx->display_supported = false; 1749 break; 1750 /* iMON 2.4G LT (usb stick), no display, iMON RF */ 1751 case 0x4e: 1752 dev_info(ictx->dev, "0xffdc iMON 2.4G LT, iMON RF"); 1753 ictx->display_supported = false; 1754 ictx->rf_device = true; 1755 break; 1756 /* iMON VFD, no IR (does have vol knob tho) */ 1757 case 0x35: 1758 dev_info(ictx->dev, "0xffdc iMON VFD + knob, no IR"); 1759 detected_display_type = IMON_DISPLAY_TYPE_VFD; 1760 break; 1761 /* iMON VFD, iMON IR */ 1762 case 0x24: 1763 case 0x85: 1764 dev_info(ictx->dev, "0xffdc iMON VFD, iMON IR"); 1765 detected_display_type = IMON_DISPLAY_TYPE_VFD; 1766 break; 1767 /* iMON VFD, MCE IR */ 1768 case 0x46: 1769 case 0x7e: 1770 case 0x9e: 1771 dev_info(ictx->dev, "0xffdc iMON VFD, MCE IR"); 1772 detected_display_type = IMON_DISPLAY_TYPE_VFD; 1773 allowed_protos = RC_BIT_RC6_MCE; 1774 break; 1775 /* iMON LCD, MCE IR */ 1776 case 0x9f: 1777 dev_info(ictx->dev, "0xffdc iMON LCD, MCE IR"); 1778 detected_display_type = IMON_DISPLAY_TYPE_LCD; 1779 allowed_protos = RC_BIT_RC6_MCE; 1780 break; 1781 default: 1782 dev_info(ictx->dev, "Unknown 0xffdc device, " 1783 "defaulting to VFD and iMON IR"); 1784 detected_display_type = IMON_DISPLAY_TYPE_VFD; 1785 /* We don't know which one it is, allow user to set the 1786 * RC6 one from userspace if OTHER wasn't correct. */ 1787 allowed_protos |= RC_BIT_RC6_MCE; 1788 break; 1789 } 1790 1791 printk(KERN_CONT " (id 0x%02x)\n", ffdc_cfg_byte); 1792 1793 ictx->display_type = detected_display_type; 1794 ictx->rc_type = allowed_protos; 1795 } 1796 1797 static void imon_set_display_type(struct imon_context *ictx) 1798 { 1799 u8 configured_display_type = IMON_DISPLAY_TYPE_VFD; 1800 1801 /* 1802 * Try to auto-detect the type of display if the user hasn't set 1803 * it by hand via the display_type modparam. Default is VFD. 1804 */ 1805 1806 if (display_type == IMON_DISPLAY_TYPE_AUTO) { 1807 switch (ictx->product) { 1808 case 0xffdc: 1809 /* set in imon_get_ffdc_type() */ 1810 configured_display_type = ictx->display_type; 1811 break; 1812 case 0x0034: 1813 case 0x0035: 1814 configured_display_type = IMON_DISPLAY_TYPE_VGA; 1815 break; 1816 case 0x0038: 1817 case 0x0039: 1818 case 0x0045: 1819 configured_display_type = IMON_DISPLAY_TYPE_LCD; 1820 break; 1821 case 0x003c: 1822 case 0x0041: 1823 case 0x0042: 1824 case 0x0043: 1825 configured_display_type = IMON_DISPLAY_TYPE_NONE; 1826 ictx->display_supported = false; 1827 break; 1828 case 0x0036: 1829 case 0x0044: 1830 default: 1831 configured_display_type = IMON_DISPLAY_TYPE_VFD; 1832 break; 1833 } 1834 } else { 1835 configured_display_type = display_type; 1836 if (display_type == IMON_DISPLAY_TYPE_NONE) 1837 ictx->display_supported = false; 1838 else 1839 ictx->display_supported = true; 1840 dev_info(ictx->dev, "%s: overriding display type to %d via " 1841 "modparam\n", __func__, display_type); 1842 } 1843 1844 ictx->display_type = configured_display_type; 1845 } 1846 1847 static struct rc_dev *imon_init_rdev(struct imon_context *ictx) 1848 { 1849 struct rc_dev *rdev; 1850 int ret; 1851 const unsigned char fp_packet[] = { 0x40, 0x00, 0x00, 0x00, 1852 0x00, 0x00, 0x00, 0x88 }; 1853 1854 rdev = rc_allocate_device(); 1855 if (!rdev) { 1856 dev_err(ictx->dev, "remote control dev allocation failed\n"); 1857 goto out; 1858 } 1859 1860 snprintf(ictx->name_rdev, sizeof(ictx->name_rdev), 1861 "iMON Remote (%04x:%04x)", ictx->vendor, ictx->product); 1862 usb_make_path(ictx->usbdev_intf0, ictx->phys_rdev, 1863 sizeof(ictx->phys_rdev)); 1864 strlcat(ictx->phys_rdev, "/input0", sizeof(ictx->phys_rdev)); 1865 1866 rdev->input_name = ictx->name_rdev; 1867 rdev->input_phys = ictx->phys_rdev; 1868 usb_to_input_id(ictx->usbdev_intf0, &rdev->input_id); 1869 rdev->dev.parent = ictx->dev; 1870 1871 rdev->priv = ictx; 1872 rdev->driver_type = RC_DRIVER_SCANCODE; 1873 rdev->allowed_protocols = RC_BIT_OTHER | RC_BIT_RC6_MCE; /* iMON PAD or MCE */ 1874 rdev->change_protocol = imon_ir_change_protocol; 1875 rdev->driver_name = MOD_NAME; 1876 1877 /* Enable front-panel buttons and/or knobs */ 1878 memcpy(ictx->usb_tx_buf, &fp_packet, sizeof(fp_packet)); 1879 ret = send_packet(ictx); 1880 /* Not fatal, but warn about it */ 1881 if (ret) 1882 dev_info(ictx->dev, "panel buttons/knobs setup failed\n"); 1883 1884 if (ictx->product == 0xffdc) { 1885 imon_get_ffdc_type(ictx); 1886 rdev->allowed_protocols = ictx->rc_type; 1887 } 1888 1889 imon_set_display_type(ictx); 1890 1891 if (ictx->rc_type == RC_BIT_RC6_MCE) 1892 rdev->map_name = RC_MAP_IMON_MCE; 1893 else 1894 rdev->map_name = RC_MAP_IMON_PAD; 1895 1896 ret = rc_register_device(rdev); 1897 if (ret < 0) { 1898 dev_err(ictx->dev, "remote input dev register failed\n"); 1899 goto out; 1900 } 1901 1902 return rdev; 1903 1904 out: 1905 rc_free_device(rdev); 1906 return NULL; 1907 } 1908 1909 static struct input_dev *imon_init_idev(struct imon_context *ictx) 1910 { 1911 struct input_dev *idev; 1912 int ret, i; 1913 1914 idev = input_allocate_device(); 1915 if (!idev) 1916 goto out; 1917 1918 snprintf(ictx->name_idev, sizeof(ictx->name_idev), 1919 "iMON Panel, Knob and Mouse(%04x:%04x)", 1920 ictx->vendor, ictx->product); 1921 idev->name = ictx->name_idev; 1922 1923 usb_make_path(ictx->usbdev_intf0, ictx->phys_idev, 1924 sizeof(ictx->phys_idev)); 1925 strlcat(ictx->phys_idev, "/input1", sizeof(ictx->phys_idev)); 1926 idev->phys = ictx->phys_idev; 1927 1928 idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) | BIT_MASK(EV_REL); 1929 1930 idev->keybit[BIT_WORD(BTN_MOUSE)] = 1931 BIT_MASK(BTN_LEFT) | BIT_MASK(BTN_RIGHT); 1932 idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y) | 1933 BIT_MASK(REL_WHEEL); 1934 1935 /* panel and/or knob code support */ 1936 for (i = 0; i < ARRAY_SIZE(imon_panel_key_table); i++) { 1937 u32 kc = imon_panel_key_table[i].keycode; 1938 __set_bit(kc, idev->keybit); 1939 } 1940 1941 usb_to_input_id(ictx->usbdev_intf0, &idev->id); 1942 idev->dev.parent = ictx->dev; 1943 input_set_drvdata(idev, ictx); 1944 1945 ret = input_register_device(idev); 1946 if (ret < 0) { 1947 dev_err(ictx->dev, "input dev register failed\n"); 1948 goto out; 1949 } 1950 1951 return idev; 1952 1953 out: 1954 input_free_device(idev); 1955 return NULL; 1956 } 1957 1958 static struct input_dev *imon_init_touch(struct imon_context *ictx) 1959 { 1960 struct input_dev *touch; 1961 int ret; 1962 1963 touch = input_allocate_device(); 1964 if (!touch) 1965 goto touch_alloc_failed; 1966 1967 snprintf(ictx->name_touch, sizeof(ictx->name_touch), 1968 "iMON USB Touchscreen (%04x:%04x)", 1969 ictx->vendor, ictx->product); 1970 touch->name = ictx->name_touch; 1971 1972 usb_make_path(ictx->usbdev_intf1, ictx->phys_touch, 1973 sizeof(ictx->phys_touch)); 1974 strlcat(ictx->phys_touch, "/input2", sizeof(ictx->phys_touch)); 1975 touch->phys = ictx->phys_touch; 1976 1977 touch->evbit[0] = 1978 BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS); 1979 touch->keybit[BIT_WORD(BTN_TOUCH)] = 1980 BIT_MASK(BTN_TOUCH); 1981 input_set_abs_params(touch, ABS_X, 1982 0x00, 0xfff, 0, 0); 1983 input_set_abs_params(touch, ABS_Y, 1984 0x00, 0xfff, 0, 0); 1985 1986 input_set_drvdata(touch, ictx); 1987 1988 usb_to_input_id(ictx->usbdev_intf1, &touch->id); 1989 touch->dev.parent = ictx->dev; 1990 ret = input_register_device(touch); 1991 if (ret < 0) { 1992 dev_info(ictx->dev, "touchscreen input dev register failed\n"); 1993 goto touch_register_failed; 1994 } 1995 1996 return touch; 1997 1998 touch_register_failed: 1999 input_free_device(touch); 2000 2001 touch_alloc_failed: 2002 return NULL; 2003 } 2004 2005 static bool imon_find_endpoints(struct imon_context *ictx, 2006 struct usb_host_interface *iface_desc) 2007 { 2008 struct usb_endpoint_descriptor *ep; 2009 struct usb_endpoint_descriptor *rx_endpoint = NULL; 2010 struct usb_endpoint_descriptor *tx_endpoint = NULL; 2011 int ifnum = iface_desc->desc.bInterfaceNumber; 2012 int num_endpts = iface_desc->desc.bNumEndpoints; 2013 int i, ep_dir, ep_type; 2014 bool ir_ep_found = false; 2015 bool display_ep_found = false; 2016 bool tx_control = false; 2017 2018 /* 2019 * Scan the endpoint list and set: 2020 * first input endpoint = IR endpoint 2021 * first output endpoint = display endpoint 2022 */ 2023 for (i = 0; i < num_endpts && !(ir_ep_found && display_ep_found); ++i) { 2024 ep = &iface_desc->endpoint[i].desc; 2025 ep_dir = ep->bEndpointAddress & USB_ENDPOINT_DIR_MASK; 2026 ep_type = ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK; 2027 2028 if (!ir_ep_found && ep_dir == USB_DIR_IN && 2029 ep_type == USB_ENDPOINT_XFER_INT) { 2030 2031 rx_endpoint = ep; 2032 ir_ep_found = true; 2033 dev_dbg(ictx->dev, "%s: found IR endpoint\n", __func__); 2034 2035 } else if (!display_ep_found && ep_dir == USB_DIR_OUT && 2036 ep_type == USB_ENDPOINT_XFER_INT) { 2037 tx_endpoint = ep; 2038 display_ep_found = true; 2039 dev_dbg(ictx->dev, "%s: found display endpoint\n", __func__); 2040 } 2041 } 2042 2043 if (ifnum == 0) { 2044 ictx->rx_endpoint_intf0 = rx_endpoint; 2045 /* 2046 * tx is used to send characters to lcd/vfd, associate RF 2047 * remotes, set IR protocol, and maybe more... 2048 */ 2049 ictx->tx_endpoint = tx_endpoint; 2050 } else { 2051 ictx->rx_endpoint_intf1 = rx_endpoint; 2052 } 2053 2054 /* 2055 * If we didn't find a display endpoint, this is probably one of the 2056 * newer iMON devices that use control urb instead of interrupt 2057 */ 2058 if (!display_ep_found) { 2059 tx_control = true; 2060 display_ep_found = true; 2061 dev_dbg(ictx->dev, "%s: device uses control endpoint, not " 2062 "interface OUT endpoint\n", __func__); 2063 } 2064 2065 /* 2066 * Some iMON receivers have no display. Unfortunately, it seems 2067 * that SoundGraph recycles device IDs between devices both with 2068 * and without... :\ 2069 */ 2070 if (ictx->display_type == IMON_DISPLAY_TYPE_NONE) { 2071 display_ep_found = false; 2072 dev_dbg(ictx->dev, "%s: device has no display\n", __func__); 2073 } 2074 2075 /* 2076 * iMON Touch devices have a VGA touchscreen, but no "display", as 2077 * that refers to e.g. /dev/lcd0 (a character device LCD or VFD). 2078 */ 2079 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) { 2080 display_ep_found = false; 2081 dev_dbg(ictx->dev, "%s: iMON Touch device found\n", __func__); 2082 } 2083 2084 /* Input endpoint is mandatory */ 2085 if (!ir_ep_found) 2086 pr_err("no valid input (IR) endpoint found\n"); 2087 2088 ictx->tx_control = tx_control; 2089 2090 if (display_ep_found) 2091 ictx->display_supported = true; 2092 2093 return ir_ep_found; 2094 2095 } 2096 2097 static struct imon_context *imon_init_intf0(struct usb_interface *intf, 2098 const struct usb_device_id *id) 2099 { 2100 struct imon_context *ictx; 2101 struct urb *rx_urb; 2102 struct urb *tx_urb; 2103 struct device *dev = &intf->dev; 2104 struct usb_host_interface *iface_desc; 2105 int ret = -ENOMEM; 2106 2107 ictx = kzalloc(sizeof(struct imon_context), GFP_KERNEL); 2108 if (!ictx) { 2109 dev_err(dev, "%s: kzalloc failed for context", __func__); 2110 goto exit; 2111 } 2112 rx_urb = usb_alloc_urb(0, GFP_KERNEL); 2113 if (!rx_urb) { 2114 dev_err(dev, "%s: usb_alloc_urb failed for IR urb", __func__); 2115 goto rx_urb_alloc_failed; 2116 } 2117 tx_urb = usb_alloc_urb(0, GFP_KERNEL); 2118 if (!tx_urb) { 2119 dev_err(dev, "%s: usb_alloc_urb failed for display urb", 2120 __func__); 2121 goto tx_urb_alloc_failed; 2122 } 2123 2124 mutex_init(&ictx->lock); 2125 spin_lock_init(&ictx->kc_lock); 2126 2127 mutex_lock(&ictx->lock); 2128 2129 ictx->dev = dev; 2130 ictx->usbdev_intf0 = usb_get_dev(interface_to_usbdev(intf)); 2131 ictx->rx_urb_intf0 = rx_urb; 2132 ictx->tx_urb = tx_urb; 2133 ictx->rf_device = false; 2134 2135 ictx->vendor = le16_to_cpu(ictx->usbdev_intf0->descriptor.idVendor); 2136 ictx->product = le16_to_cpu(ictx->usbdev_intf0->descriptor.idProduct); 2137 2138 /* default send_packet delay is 5ms but some devices need more */ 2139 ictx->send_packet_delay = id->driver_info & IMON_NEED_20MS_PKT_DELAY ? 2140 20 : 5; 2141 2142 ret = -ENODEV; 2143 iface_desc = intf->cur_altsetting; 2144 if (!imon_find_endpoints(ictx, iface_desc)) { 2145 goto find_endpoint_failed; 2146 } 2147 2148 usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0, 2149 usb_rcvintpipe(ictx->usbdev_intf0, 2150 ictx->rx_endpoint_intf0->bEndpointAddress), 2151 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf), 2152 usb_rx_callback_intf0, ictx, 2153 ictx->rx_endpoint_intf0->bInterval); 2154 2155 ret = usb_submit_urb(ictx->rx_urb_intf0, GFP_KERNEL); 2156 if (ret) { 2157 pr_err("usb_submit_urb failed for intf0 (%d)\n", ret); 2158 goto urb_submit_failed; 2159 } 2160 2161 ictx->idev = imon_init_idev(ictx); 2162 if (!ictx->idev) { 2163 dev_err(dev, "%s: input device setup failed\n", __func__); 2164 goto idev_setup_failed; 2165 } 2166 2167 ictx->rdev = imon_init_rdev(ictx); 2168 if (!ictx->rdev) { 2169 dev_err(dev, "%s: rc device setup failed\n", __func__); 2170 goto rdev_setup_failed; 2171 } 2172 2173 ictx->dev_present_intf0 = true; 2174 2175 mutex_unlock(&ictx->lock); 2176 return ictx; 2177 2178 rdev_setup_failed: 2179 input_unregister_device(ictx->idev); 2180 idev_setup_failed: 2181 usb_kill_urb(ictx->rx_urb_intf0); 2182 urb_submit_failed: 2183 find_endpoint_failed: 2184 mutex_unlock(&ictx->lock); 2185 usb_free_urb(tx_urb); 2186 tx_urb_alloc_failed: 2187 usb_free_urb(rx_urb); 2188 rx_urb_alloc_failed: 2189 kfree(ictx); 2190 exit: 2191 dev_err(dev, "unable to initialize intf0, err %d\n", ret); 2192 2193 return NULL; 2194 } 2195 2196 static struct imon_context *imon_init_intf1(struct usb_interface *intf, 2197 struct imon_context *ictx) 2198 { 2199 struct urb *rx_urb; 2200 struct usb_host_interface *iface_desc; 2201 int ret = -ENOMEM; 2202 2203 rx_urb = usb_alloc_urb(0, GFP_KERNEL); 2204 if (!rx_urb) { 2205 pr_err("usb_alloc_urb failed for IR urb\n"); 2206 goto rx_urb_alloc_failed; 2207 } 2208 2209 mutex_lock(&ictx->lock); 2210 2211 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) { 2212 init_timer(&ictx->ttimer); 2213 ictx->ttimer.data = (unsigned long)ictx; 2214 ictx->ttimer.function = imon_touch_display_timeout; 2215 } 2216 2217 ictx->usbdev_intf1 = usb_get_dev(interface_to_usbdev(intf)); 2218 ictx->rx_urb_intf1 = rx_urb; 2219 2220 ret = -ENODEV; 2221 iface_desc = intf->cur_altsetting; 2222 if (!imon_find_endpoints(ictx, iface_desc)) 2223 goto find_endpoint_failed; 2224 2225 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) { 2226 ictx->touch = imon_init_touch(ictx); 2227 if (!ictx->touch) 2228 goto touch_setup_failed; 2229 } else 2230 ictx->touch = NULL; 2231 2232 usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1, 2233 usb_rcvintpipe(ictx->usbdev_intf1, 2234 ictx->rx_endpoint_intf1->bEndpointAddress), 2235 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf), 2236 usb_rx_callback_intf1, ictx, 2237 ictx->rx_endpoint_intf1->bInterval); 2238 2239 ret = usb_submit_urb(ictx->rx_urb_intf1, GFP_KERNEL); 2240 2241 if (ret) { 2242 pr_err("usb_submit_urb failed for intf1 (%d)\n", ret); 2243 goto urb_submit_failed; 2244 } 2245 2246 ictx->dev_present_intf1 = true; 2247 2248 mutex_unlock(&ictx->lock); 2249 return ictx; 2250 2251 urb_submit_failed: 2252 if (ictx->touch) 2253 input_unregister_device(ictx->touch); 2254 touch_setup_failed: 2255 find_endpoint_failed: 2256 mutex_unlock(&ictx->lock); 2257 usb_free_urb(rx_urb); 2258 rx_urb_alloc_failed: 2259 dev_err(ictx->dev, "unable to initialize intf1, err %d\n", ret); 2260 2261 return NULL; 2262 } 2263 2264 static void imon_init_display(struct imon_context *ictx, 2265 struct usb_interface *intf) 2266 { 2267 int ret; 2268 2269 dev_dbg(ictx->dev, "Registering iMON display with sysfs\n"); 2270 2271 /* set up sysfs entry for built-in clock */ 2272 ret = sysfs_create_group(&intf->dev.kobj, &imon_display_attr_group); 2273 if (ret) 2274 dev_err(ictx->dev, "Could not create display sysfs " 2275 "entries(%d)", ret); 2276 2277 if (ictx->display_type == IMON_DISPLAY_TYPE_LCD) 2278 ret = usb_register_dev(intf, &imon_lcd_class); 2279 else 2280 ret = usb_register_dev(intf, &imon_vfd_class); 2281 if (ret) 2282 /* Not a fatal error, so ignore */ 2283 dev_info(ictx->dev, "could not get a minor number for " 2284 "display\n"); 2285 2286 } 2287 2288 /** 2289 * Callback function for USB core API: Probe 2290 */ 2291 static int imon_probe(struct usb_interface *interface, 2292 const struct usb_device_id *id) 2293 { 2294 struct usb_device *usbdev = NULL; 2295 struct usb_host_interface *iface_desc = NULL; 2296 struct usb_interface *first_if; 2297 struct device *dev = &interface->dev; 2298 int ifnum, sysfs_err; 2299 int ret = 0; 2300 struct imon_context *ictx = NULL; 2301 struct imon_context *first_if_ctx = NULL; 2302 u16 vendor, product; 2303 2304 usbdev = usb_get_dev(interface_to_usbdev(interface)); 2305 iface_desc = interface->cur_altsetting; 2306 ifnum = iface_desc->desc.bInterfaceNumber; 2307 vendor = le16_to_cpu(usbdev->descriptor.idVendor); 2308 product = le16_to_cpu(usbdev->descriptor.idProduct); 2309 2310 dev_dbg(dev, "%s: found iMON device (%04x:%04x, intf%d)\n", 2311 __func__, vendor, product, ifnum); 2312 2313 /* prevent races probing devices w/multiple interfaces */ 2314 mutex_lock(&driver_lock); 2315 2316 first_if = usb_ifnum_to_if(usbdev, 0); 2317 first_if_ctx = usb_get_intfdata(first_if); 2318 2319 if (ifnum == 0) { 2320 ictx = imon_init_intf0(interface, id); 2321 if (!ictx) { 2322 pr_err("failed to initialize context!\n"); 2323 ret = -ENODEV; 2324 goto fail; 2325 } 2326 2327 } else { 2328 /* this is the secondary interface on the device */ 2329 2330 /* fail early if first intf failed to register */ 2331 if (!first_if_ctx) { 2332 ret = -ENODEV; 2333 goto fail; 2334 } 2335 2336 ictx = imon_init_intf1(interface, first_if_ctx); 2337 if (!ictx) { 2338 pr_err("failed to attach to context!\n"); 2339 ret = -ENODEV; 2340 goto fail; 2341 } 2342 2343 } 2344 2345 usb_set_intfdata(interface, ictx); 2346 2347 if (ifnum == 0) { 2348 mutex_lock(&ictx->lock); 2349 2350 if (product == 0xffdc && ictx->rf_device) { 2351 sysfs_err = sysfs_create_group(&interface->dev.kobj, 2352 &imon_rf_attr_group); 2353 if (sysfs_err) 2354 pr_err("Could not create RF sysfs entries(%d)\n", 2355 sysfs_err); 2356 } 2357 2358 if (ictx->display_supported) 2359 imon_init_display(ictx, interface); 2360 2361 mutex_unlock(&ictx->lock); 2362 } 2363 2364 dev_info(dev, "iMON device (%04x:%04x, intf%d) on " 2365 "usb<%d:%d> initialized\n", vendor, product, ifnum, 2366 usbdev->bus->busnum, usbdev->devnum); 2367 2368 mutex_unlock(&driver_lock); 2369 2370 return 0; 2371 2372 fail: 2373 mutex_unlock(&driver_lock); 2374 dev_err(dev, "unable to register, err %d\n", ret); 2375 2376 return ret; 2377 } 2378 2379 /** 2380 * Callback function for USB core API: disconnect 2381 */ 2382 static void imon_disconnect(struct usb_interface *interface) 2383 { 2384 struct imon_context *ictx; 2385 struct device *dev; 2386 int ifnum; 2387 2388 /* prevent races with multi-interface device probing and display_open */ 2389 mutex_lock(&driver_lock); 2390 2391 ictx = usb_get_intfdata(interface); 2392 dev = ictx->dev; 2393 ifnum = interface->cur_altsetting->desc.bInterfaceNumber; 2394 2395 /* 2396 * sysfs_remove_group is safe to call even if sysfs_create_group 2397 * hasn't been called 2398 */ 2399 sysfs_remove_group(&interface->dev.kobj, &imon_display_attr_group); 2400 sysfs_remove_group(&interface->dev.kobj, &imon_rf_attr_group); 2401 2402 usb_set_intfdata(interface, NULL); 2403 2404 /* Abort ongoing write */ 2405 if (ictx->tx.busy) { 2406 usb_kill_urb(ictx->tx_urb); 2407 complete_all(&ictx->tx.finished); 2408 } 2409 2410 if (ifnum == 0) { 2411 ictx->dev_present_intf0 = false; 2412 usb_kill_urb(ictx->rx_urb_intf0); 2413 input_unregister_device(ictx->idev); 2414 rc_unregister_device(ictx->rdev); 2415 if (ictx->display_supported) { 2416 if (ictx->display_type == IMON_DISPLAY_TYPE_LCD) 2417 usb_deregister_dev(interface, &imon_lcd_class); 2418 else if (ictx->display_type == IMON_DISPLAY_TYPE_VFD) 2419 usb_deregister_dev(interface, &imon_vfd_class); 2420 } 2421 } else { 2422 ictx->dev_present_intf1 = false; 2423 usb_kill_urb(ictx->rx_urb_intf1); 2424 if (ictx->display_type == IMON_DISPLAY_TYPE_VGA) { 2425 input_unregister_device(ictx->touch); 2426 del_timer_sync(&ictx->ttimer); 2427 } 2428 } 2429 2430 if (!ictx->dev_present_intf0 && !ictx->dev_present_intf1) 2431 free_imon_context(ictx); 2432 2433 mutex_unlock(&driver_lock); 2434 2435 dev_dbg(dev, "%s: iMON device (intf%d) disconnected\n", 2436 __func__, ifnum); 2437 } 2438 2439 static int imon_suspend(struct usb_interface *intf, pm_message_t message) 2440 { 2441 struct imon_context *ictx = usb_get_intfdata(intf); 2442 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber; 2443 2444 if (ifnum == 0) 2445 usb_kill_urb(ictx->rx_urb_intf0); 2446 else 2447 usb_kill_urb(ictx->rx_urb_intf1); 2448 2449 return 0; 2450 } 2451 2452 static int imon_resume(struct usb_interface *intf) 2453 { 2454 int rc = 0; 2455 struct imon_context *ictx = usb_get_intfdata(intf); 2456 int ifnum = intf->cur_altsetting->desc.bInterfaceNumber; 2457 2458 if (ifnum == 0) { 2459 usb_fill_int_urb(ictx->rx_urb_intf0, ictx->usbdev_intf0, 2460 usb_rcvintpipe(ictx->usbdev_intf0, 2461 ictx->rx_endpoint_intf0->bEndpointAddress), 2462 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf), 2463 usb_rx_callback_intf0, ictx, 2464 ictx->rx_endpoint_intf0->bInterval); 2465 2466 rc = usb_submit_urb(ictx->rx_urb_intf0, GFP_ATOMIC); 2467 2468 } else { 2469 usb_fill_int_urb(ictx->rx_urb_intf1, ictx->usbdev_intf1, 2470 usb_rcvintpipe(ictx->usbdev_intf1, 2471 ictx->rx_endpoint_intf1->bEndpointAddress), 2472 ictx->usb_rx_buf, sizeof(ictx->usb_rx_buf), 2473 usb_rx_callback_intf1, ictx, 2474 ictx->rx_endpoint_intf1->bInterval); 2475 2476 rc = usb_submit_urb(ictx->rx_urb_intf1, GFP_ATOMIC); 2477 } 2478 2479 return rc; 2480 } 2481 2482 module_usb_driver(imon_driver); 2483