1 /* 2 * Driver for the VoIP USB phones with CM109 chipsets. 3 * 4 * Copyright (C) 2007 - 2008 Alfred E. Heggestad <aeh@db.org> 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License as 8 * published by the Free Software Foundation, version 2. 9 */ 10 11 /* 12 * Tested devices: 13 * - Komunikate KIP1000 14 * - Genius G-talk 15 * - Allied-Telesis Corega USBPH01 16 * - ... 17 * 18 * This driver is based on the yealink.c driver 19 * 20 * Thanks to: 21 * - Authors of yealink.c 22 * - Thomas Reitmayr 23 * - Oliver Neukum for good review comments and code 24 * - Shaun Jackman <sjackman@gmail.com> for Genius G-talk keymap 25 * - Dmitry Torokhov for valuable input and review 26 * 27 * Todo: 28 * - Read/write EEPROM 29 */ 30 31 #include <linux/kernel.h> 32 #include <linux/init.h> 33 #include <linux/slab.h> 34 #include <linux/module.h> 35 #include <linux/moduleparam.h> 36 #include <linux/rwsem.h> 37 #include <linux/usb/input.h> 38 39 #define DRIVER_VERSION "20080805" 40 #define DRIVER_AUTHOR "Alfred E. Heggestad" 41 #define DRIVER_DESC "CM109 phone driver" 42 43 static char *phone = "kip1000"; 44 module_param(phone, charp, S_IRUSR); 45 MODULE_PARM_DESC(phone, "Phone name {kip1000, gtalk, usbph01, atcom}"); 46 47 enum { 48 /* HID Registers */ 49 HID_IR0 = 0x00, /* Record/Playback-mute button, Volume up/down */ 50 HID_IR1 = 0x01, /* GPI, generic registers or EEPROM_DATA0 */ 51 HID_IR2 = 0x02, /* Generic registers or EEPROM_DATA1 */ 52 HID_IR3 = 0x03, /* Generic registers or EEPROM_CTRL */ 53 HID_OR0 = 0x00, /* Mapping control, buzzer, SPDIF (offset 0x04) */ 54 HID_OR1 = 0x01, /* GPO - General Purpose Output */ 55 HID_OR2 = 0x02, /* Set GPIO to input/output mode */ 56 HID_OR3 = 0x03, /* SPDIF status channel or EEPROM_CTRL */ 57 58 /* HID_IR0 */ 59 RECORD_MUTE = 1 << 3, 60 PLAYBACK_MUTE = 1 << 2, 61 VOLUME_DOWN = 1 << 1, 62 VOLUME_UP = 1 << 0, 63 64 /* HID_OR0 */ 65 /* bits 7-6 66 0: HID_OR1-2 are used for GPO; HID_OR0, 3 are used for buzzer 67 and SPDIF 68 1: HID_OR0-3 are used as generic HID registers 69 2: Values written to HID_OR0-3 are also mapped to MCU_CTRL, 70 EEPROM_DATA0-1, EEPROM_CTRL (see Note) 71 3: Reserved 72 */ 73 HID_OR_GPO_BUZ_SPDIF = 0 << 6, 74 HID_OR_GENERIC_HID_REG = 1 << 6, 75 HID_OR_MAP_MCU_EEPROM = 2 << 6, 76 77 BUZZER_ON = 1 << 5, 78 79 /* up to 256 normal keys, up to 15 special key combinations */ 80 KEYMAP_SIZE = 256 + 15, 81 }; 82 83 /* CM109 protocol packet */ 84 struct cm109_ctl_packet { 85 u8 byte[4]; 86 } __attribute__ ((packed)); 87 88 enum { USB_PKT_LEN = sizeof(struct cm109_ctl_packet) }; 89 90 /* CM109 device structure */ 91 struct cm109_dev { 92 struct input_dev *idev; /* input device */ 93 struct usb_device *udev; /* usb device */ 94 struct usb_interface *intf; 95 96 /* irq input channel */ 97 struct cm109_ctl_packet *irq_data; 98 dma_addr_t irq_dma; 99 struct urb *urb_irq; 100 101 /* control output channel */ 102 struct cm109_ctl_packet *ctl_data; 103 dma_addr_t ctl_dma; 104 struct usb_ctrlrequest *ctl_req; 105 struct urb *urb_ctl; 106 /* 107 * The 3 bitfields below are protected by ctl_submit_lock. 108 * They have to be separate since they are accessed from IRQ 109 * context. 110 */ 111 unsigned irq_urb_pending:1; /* irq_urb is in flight */ 112 unsigned ctl_urb_pending:1; /* ctl_urb is in flight */ 113 unsigned buzzer_pending:1; /* need to issue buzz command */ 114 spinlock_t ctl_submit_lock; 115 116 unsigned char buzzer_state; /* on/off */ 117 118 /* flags */ 119 unsigned open:1; 120 unsigned resetting:1; 121 unsigned shutdown:1; 122 123 /* This mutex protects writes to the above flags */ 124 struct mutex pm_mutex; 125 126 unsigned short keymap[KEYMAP_SIZE]; 127 128 char phys[64]; /* physical device path */ 129 int key_code; /* last reported key */ 130 int keybit; /* 0=new scan 1,2,4,8=scan columns */ 131 u8 gpi; /* Cached value of GPI (high nibble) */ 132 }; 133 134 /****************************************************************************** 135 * CM109 key interface 136 *****************************************************************************/ 137 138 static unsigned short special_keymap(int code) 139 { 140 if (code > 0xff) { 141 switch (code - 0xff) { 142 case RECORD_MUTE: return KEY_MICMUTE; 143 case PLAYBACK_MUTE: return KEY_MUTE; 144 case VOLUME_DOWN: return KEY_VOLUMEDOWN; 145 case VOLUME_UP: return KEY_VOLUMEUP; 146 } 147 } 148 return KEY_RESERVED; 149 } 150 151 /* Map device buttons to internal key events. 152 * 153 * The "up" and "down" keys, are symbolised by arrows on the button. 154 * The "pickup" and "hangup" keys are symbolised by a green and red phone 155 * on the button. 156 157 Komunikate KIP1000 Keyboard Matrix 158 159 -> -- 1 -- 2 -- 3 --> GPI pin 4 (0x10) 160 | | | | 161 <- -- 4 -- 5 -- 6 --> GPI pin 5 (0x20) 162 | | | | 163 END - 7 -- 8 -- 9 --> GPI pin 6 (0x40) 164 | | | | 165 OK -- * -- 0 -- # --> GPI pin 7 (0x80) 166 | | | | 167 168 /|\ /|\ /|\ /|\ 169 | | | | 170 GPO 171 pin: 3 2 1 0 172 0x8 0x4 0x2 0x1 173 174 */ 175 static unsigned short keymap_kip1000(int scancode) 176 { 177 switch (scancode) { /* phone key: */ 178 case 0x82: return KEY_NUMERIC_0; /* 0 */ 179 case 0x14: return KEY_NUMERIC_1; /* 1 */ 180 case 0x12: return KEY_NUMERIC_2; /* 2 */ 181 case 0x11: return KEY_NUMERIC_3; /* 3 */ 182 case 0x24: return KEY_NUMERIC_4; /* 4 */ 183 case 0x22: return KEY_NUMERIC_5; /* 5 */ 184 case 0x21: return KEY_NUMERIC_6; /* 6 */ 185 case 0x44: return KEY_NUMERIC_7; /* 7 */ 186 case 0x42: return KEY_NUMERIC_8; /* 8 */ 187 case 0x41: return KEY_NUMERIC_9; /* 9 */ 188 case 0x81: return KEY_NUMERIC_POUND; /* # */ 189 case 0x84: return KEY_NUMERIC_STAR; /* * */ 190 case 0x88: return KEY_ENTER; /* pickup */ 191 case 0x48: return KEY_ESC; /* hangup */ 192 case 0x28: return KEY_LEFT; /* IN */ 193 case 0x18: return KEY_RIGHT; /* OUT */ 194 default: return special_keymap(scancode); 195 } 196 } 197 198 /* 199 Contributed by Shaun Jackman <sjackman@gmail.com> 200 201 Genius G-Talk keyboard matrix 202 0 1 2 3 203 4: 0 4 8 Talk 204 5: 1 5 9 End 205 6: 2 6 # Up 206 7: 3 7 * Down 207 */ 208 static unsigned short keymap_gtalk(int scancode) 209 { 210 switch (scancode) { 211 case 0x11: return KEY_NUMERIC_0; 212 case 0x21: return KEY_NUMERIC_1; 213 case 0x41: return KEY_NUMERIC_2; 214 case 0x81: return KEY_NUMERIC_3; 215 case 0x12: return KEY_NUMERIC_4; 216 case 0x22: return KEY_NUMERIC_5; 217 case 0x42: return KEY_NUMERIC_6; 218 case 0x82: return KEY_NUMERIC_7; 219 case 0x14: return KEY_NUMERIC_8; 220 case 0x24: return KEY_NUMERIC_9; 221 case 0x44: return KEY_NUMERIC_POUND; /* # */ 222 case 0x84: return KEY_NUMERIC_STAR; /* * */ 223 case 0x18: return KEY_ENTER; /* Talk (green handset) */ 224 case 0x28: return KEY_ESC; /* End (red handset) */ 225 case 0x48: return KEY_UP; /* Menu up (rocker switch) */ 226 case 0x88: return KEY_DOWN; /* Menu down (rocker switch) */ 227 default: return special_keymap(scancode); 228 } 229 } 230 231 /* 232 * Keymap for Allied-Telesis Corega USBPH01 233 * http://www.alliedtelesis-corega.com/2/1344/1437/1360/chprd.html 234 * 235 * Contributed by july@nat.bg 236 */ 237 static unsigned short keymap_usbph01(int scancode) 238 { 239 switch (scancode) { 240 case 0x11: return KEY_NUMERIC_0; /* 0 */ 241 case 0x21: return KEY_NUMERIC_1; /* 1 */ 242 case 0x41: return KEY_NUMERIC_2; /* 2 */ 243 case 0x81: return KEY_NUMERIC_3; /* 3 */ 244 case 0x12: return KEY_NUMERIC_4; /* 4 */ 245 case 0x22: return KEY_NUMERIC_5; /* 5 */ 246 case 0x42: return KEY_NUMERIC_6; /* 6 */ 247 case 0x82: return KEY_NUMERIC_7; /* 7 */ 248 case 0x14: return KEY_NUMERIC_8; /* 8 */ 249 case 0x24: return KEY_NUMERIC_9; /* 9 */ 250 case 0x44: return KEY_NUMERIC_POUND; /* # */ 251 case 0x84: return KEY_NUMERIC_STAR; /* * */ 252 case 0x18: return KEY_ENTER; /* pickup */ 253 case 0x28: return KEY_ESC; /* hangup */ 254 case 0x48: return KEY_LEFT; /* IN */ 255 case 0x88: return KEY_RIGHT; /* OUT */ 256 default: return special_keymap(scancode); 257 } 258 } 259 260 /* 261 * Keymap for ATCom AU-100 262 * http://www.atcom.cn/products.html 263 * http://www.packetizer.com/products/au100/ 264 * http://www.voip-info.org/wiki/view/AU-100 265 * 266 * Contributed by daniel@gimpelevich.san-francisco.ca.us 267 */ 268 static unsigned short keymap_atcom(int scancode) 269 { 270 switch (scancode) { /* phone key: */ 271 case 0x82: return KEY_NUMERIC_0; /* 0 */ 272 case 0x11: return KEY_NUMERIC_1; /* 1 */ 273 case 0x12: return KEY_NUMERIC_2; /* 2 */ 274 case 0x14: return KEY_NUMERIC_3; /* 3 */ 275 case 0x21: return KEY_NUMERIC_4; /* 4 */ 276 case 0x22: return KEY_NUMERIC_5; /* 5 */ 277 case 0x24: return KEY_NUMERIC_6; /* 6 */ 278 case 0x41: return KEY_NUMERIC_7; /* 7 */ 279 case 0x42: return KEY_NUMERIC_8; /* 8 */ 280 case 0x44: return KEY_NUMERIC_9; /* 9 */ 281 case 0x84: return KEY_NUMERIC_POUND; /* # */ 282 case 0x81: return KEY_NUMERIC_STAR; /* * */ 283 case 0x18: return KEY_ENTER; /* pickup */ 284 case 0x28: return KEY_ESC; /* hangup */ 285 case 0x48: return KEY_LEFT; /* left arrow */ 286 case 0x88: return KEY_RIGHT; /* right arrow */ 287 default: return special_keymap(scancode); 288 } 289 } 290 291 static unsigned short (*keymap)(int) = keymap_kip1000; 292 293 /* 294 * Completes a request by converting the data into events for the 295 * input subsystem. 296 */ 297 static void report_key(struct cm109_dev *dev, int key) 298 { 299 struct input_dev *idev = dev->idev; 300 301 if (dev->key_code >= 0) { 302 /* old key up */ 303 input_report_key(idev, dev->key_code, 0); 304 } 305 306 dev->key_code = key; 307 if (key >= 0) { 308 /* new valid key */ 309 input_report_key(idev, key, 1); 310 } 311 312 input_sync(idev); 313 } 314 315 /* 316 * Converts data of special key presses (volume, mute) into events 317 * for the input subsystem, sends press-n-release for mute keys. 318 */ 319 static void cm109_report_special(struct cm109_dev *dev) 320 { 321 static const u8 autorelease = RECORD_MUTE | PLAYBACK_MUTE; 322 struct input_dev *idev = dev->idev; 323 u8 data = dev->irq_data->byte[HID_IR0]; 324 unsigned short keycode; 325 int i; 326 327 for (i = 0; i < 4; i++) { 328 keycode = dev->keymap[0xff + BIT(i)]; 329 if (keycode == KEY_RESERVED) 330 continue; 331 332 input_report_key(idev, keycode, data & BIT(i)); 333 if (data & autorelease & BIT(i)) { 334 input_sync(idev); 335 input_report_key(idev, keycode, 0); 336 } 337 } 338 input_sync(idev); 339 } 340 341 /****************************************************************************** 342 * CM109 usb communication interface 343 *****************************************************************************/ 344 345 static void cm109_submit_buzz_toggle(struct cm109_dev *dev) 346 { 347 int error; 348 349 if (dev->buzzer_state) 350 dev->ctl_data->byte[HID_OR0] |= BUZZER_ON; 351 else 352 dev->ctl_data->byte[HID_OR0] &= ~BUZZER_ON; 353 354 error = usb_submit_urb(dev->urb_ctl, GFP_ATOMIC); 355 if (error) 356 dev_err(&dev->intf->dev, 357 "%s: usb_submit_urb (urb_ctl) failed %d\n", 358 __func__, error); 359 } 360 361 /* 362 * IRQ handler 363 */ 364 static void cm109_urb_irq_callback(struct urb *urb) 365 { 366 struct cm109_dev *dev = urb->context; 367 const int status = urb->status; 368 int error; 369 370 dev_dbg(&dev->intf->dev, "### URB IRQ: [0x%02x 0x%02x 0x%02x 0x%02x] keybit=0x%02x\n", 371 dev->irq_data->byte[0], 372 dev->irq_data->byte[1], 373 dev->irq_data->byte[2], 374 dev->irq_data->byte[3], 375 dev->keybit); 376 377 if (status) { 378 if (status == -ESHUTDOWN) 379 return; 380 dev_err_ratelimited(&dev->intf->dev, "%s: urb status %d\n", 381 __func__, status); 382 goto out; 383 } 384 385 /* Special keys */ 386 cm109_report_special(dev); 387 388 /* Scan key column */ 389 if (dev->keybit == 0xf) { 390 391 /* Any changes ? */ 392 if ((dev->gpi & 0xf0) == (dev->irq_data->byte[HID_IR1] & 0xf0)) 393 goto out; 394 395 dev->gpi = dev->irq_data->byte[HID_IR1] & 0xf0; 396 dev->keybit = 0x1; 397 } else { 398 report_key(dev, dev->keymap[dev->irq_data->byte[HID_IR1]]); 399 400 dev->keybit <<= 1; 401 if (dev->keybit > 0x8) 402 dev->keybit = 0xf; 403 } 404 405 out: 406 407 spin_lock(&dev->ctl_submit_lock); 408 409 dev->irq_urb_pending = 0; 410 411 if (likely(!dev->shutdown)) { 412 413 if (dev->buzzer_state) 414 dev->ctl_data->byte[HID_OR0] |= BUZZER_ON; 415 else 416 dev->ctl_data->byte[HID_OR0] &= ~BUZZER_ON; 417 418 dev->ctl_data->byte[HID_OR1] = dev->keybit; 419 dev->ctl_data->byte[HID_OR2] = dev->keybit; 420 421 dev->buzzer_pending = 0; 422 dev->ctl_urb_pending = 1; 423 424 error = usb_submit_urb(dev->urb_ctl, GFP_ATOMIC); 425 if (error) 426 dev_err(&dev->intf->dev, 427 "%s: usb_submit_urb (urb_ctl) failed %d\n", 428 __func__, error); 429 } 430 431 spin_unlock(&dev->ctl_submit_lock); 432 } 433 434 static void cm109_urb_ctl_callback(struct urb *urb) 435 { 436 struct cm109_dev *dev = urb->context; 437 const int status = urb->status; 438 int error; 439 440 dev_dbg(&dev->intf->dev, "### URB CTL: [0x%02x 0x%02x 0x%02x 0x%02x]\n", 441 dev->ctl_data->byte[0], 442 dev->ctl_data->byte[1], 443 dev->ctl_data->byte[2], 444 dev->ctl_data->byte[3]); 445 446 if (status) { 447 if (status == -ESHUTDOWN) 448 return; 449 dev_err_ratelimited(&dev->intf->dev, "%s: urb status %d\n", 450 __func__, status); 451 } 452 453 spin_lock(&dev->ctl_submit_lock); 454 455 dev->ctl_urb_pending = 0; 456 457 if (likely(!dev->shutdown)) { 458 459 if (dev->buzzer_pending || status) { 460 dev->buzzer_pending = 0; 461 dev->ctl_urb_pending = 1; 462 cm109_submit_buzz_toggle(dev); 463 } else if (likely(!dev->irq_urb_pending)) { 464 /* ask for key data */ 465 dev->irq_urb_pending = 1; 466 error = usb_submit_urb(dev->urb_irq, GFP_ATOMIC); 467 if (error) 468 dev_err(&dev->intf->dev, 469 "%s: usb_submit_urb (urb_irq) failed %d\n", 470 __func__, error); 471 } 472 } 473 474 spin_unlock(&dev->ctl_submit_lock); 475 } 476 477 static void cm109_toggle_buzzer_async(struct cm109_dev *dev) 478 { 479 unsigned long flags; 480 481 spin_lock_irqsave(&dev->ctl_submit_lock, flags); 482 483 if (dev->ctl_urb_pending) { 484 /* URB completion will resubmit */ 485 dev->buzzer_pending = 1; 486 } else { 487 dev->ctl_urb_pending = 1; 488 cm109_submit_buzz_toggle(dev); 489 } 490 491 spin_unlock_irqrestore(&dev->ctl_submit_lock, flags); 492 } 493 494 static void cm109_toggle_buzzer_sync(struct cm109_dev *dev, int on) 495 { 496 int error; 497 498 if (on) 499 dev->ctl_data->byte[HID_OR0] |= BUZZER_ON; 500 else 501 dev->ctl_data->byte[HID_OR0] &= ~BUZZER_ON; 502 503 error = usb_control_msg(dev->udev, 504 usb_sndctrlpipe(dev->udev, 0), 505 dev->ctl_req->bRequest, 506 dev->ctl_req->bRequestType, 507 le16_to_cpu(dev->ctl_req->wValue), 508 le16_to_cpu(dev->ctl_req->wIndex), 509 dev->ctl_data, 510 USB_PKT_LEN, USB_CTRL_SET_TIMEOUT); 511 if (error < 0 && error != -EINTR) 512 dev_err(&dev->intf->dev, "%s: usb_control_msg() failed %d\n", 513 __func__, error); 514 } 515 516 static void cm109_stop_traffic(struct cm109_dev *dev) 517 { 518 dev->shutdown = 1; 519 /* 520 * Make sure other CPUs see this 521 */ 522 smp_wmb(); 523 524 usb_kill_urb(dev->urb_ctl); 525 usb_kill_urb(dev->urb_irq); 526 527 cm109_toggle_buzzer_sync(dev, 0); 528 529 dev->shutdown = 0; 530 smp_wmb(); 531 } 532 533 static void cm109_restore_state(struct cm109_dev *dev) 534 { 535 if (dev->open) { 536 /* 537 * Restore buzzer state. 538 * This will also kick regular URB submission 539 */ 540 cm109_toggle_buzzer_async(dev); 541 } 542 } 543 544 /****************************************************************************** 545 * input event interface 546 *****************************************************************************/ 547 548 static int cm109_input_open(struct input_dev *idev) 549 { 550 struct cm109_dev *dev = input_get_drvdata(idev); 551 int error; 552 553 error = usb_autopm_get_interface(dev->intf); 554 if (error < 0) { 555 dev_err(&idev->dev, "%s - cannot autoresume, result %d\n", 556 __func__, error); 557 return error; 558 } 559 560 mutex_lock(&dev->pm_mutex); 561 562 dev->buzzer_state = 0; 563 dev->key_code = -1; /* no keys pressed */ 564 dev->keybit = 0xf; 565 566 /* issue INIT */ 567 dev->ctl_data->byte[HID_OR0] = HID_OR_GPO_BUZ_SPDIF; 568 dev->ctl_data->byte[HID_OR1] = dev->keybit; 569 dev->ctl_data->byte[HID_OR2] = dev->keybit; 570 dev->ctl_data->byte[HID_OR3] = 0x00; 571 572 error = usb_submit_urb(dev->urb_ctl, GFP_KERNEL); 573 if (error) 574 dev_err(&dev->intf->dev, "%s: usb_submit_urb (urb_ctl) failed %d\n", 575 __func__, error); 576 else 577 dev->open = 1; 578 579 mutex_unlock(&dev->pm_mutex); 580 581 if (error) 582 usb_autopm_put_interface(dev->intf); 583 584 return error; 585 } 586 587 static void cm109_input_close(struct input_dev *idev) 588 { 589 struct cm109_dev *dev = input_get_drvdata(idev); 590 591 mutex_lock(&dev->pm_mutex); 592 593 /* 594 * Once we are here event delivery is stopped so we 595 * don't need to worry about someone starting buzzer 596 * again 597 */ 598 cm109_stop_traffic(dev); 599 dev->open = 0; 600 601 mutex_unlock(&dev->pm_mutex); 602 603 usb_autopm_put_interface(dev->intf); 604 } 605 606 static int cm109_input_ev(struct input_dev *idev, unsigned int type, 607 unsigned int code, int value) 608 { 609 struct cm109_dev *dev = input_get_drvdata(idev); 610 611 dev_dbg(&dev->intf->dev, 612 "input_ev: type=%u code=%u value=%d\n", type, code, value); 613 614 if (type != EV_SND) 615 return -EINVAL; 616 617 switch (code) { 618 case SND_TONE: 619 case SND_BELL: 620 dev->buzzer_state = !!value; 621 if (!dev->resetting) 622 cm109_toggle_buzzer_async(dev); 623 return 0; 624 625 default: 626 return -EINVAL; 627 } 628 } 629 630 631 /****************************************************************************** 632 * Linux interface and usb initialisation 633 *****************************************************************************/ 634 635 struct driver_info { 636 char *name; 637 }; 638 639 static const struct driver_info info_cm109 = { 640 .name = "CM109 USB driver", 641 }; 642 643 enum { 644 VENDOR_ID = 0x0d8c, /* C-Media Electronics */ 645 PRODUCT_ID_CM109 = 0x000e, /* CM109 defines range 0x0008 - 0x000f */ 646 }; 647 648 /* table of devices that work with this driver */ 649 static const struct usb_device_id cm109_usb_table[] = { 650 { 651 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | 652 USB_DEVICE_ID_MATCH_INT_INFO, 653 .idVendor = VENDOR_ID, 654 .idProduct = PRODUCT_ID_CM109, 655 .bInterfaceClass = USB_CLASS_HID, 656 .bInterfaceSubClass = 0, 657 .bInterfaceProtocol = 0, 658 .driver_info = (kernel_ulong_t) &info_cm109 659 }, 660 /* you can add more devices here with product ID 0x0008 - 0x000f */ 661 { } 662 }; 663 664 static void cm109_usb_cleanup(struct cm109_dev *dev) 665 { 666 kfree(dev->ctl_req); 667 if (dev->ctl_data) 668 usb_free_coherent(dev->udev, USB_PKT_LEN, 669 dev->ctl_data, dev->ctl_dma); 670 if (dev->irq_data) 671 usb_free_coherent(dev->udev, USB_PKT_LEN, 672 dev->irq_data, dev->irq_dma); 673 674 usb_free_urb(dev->urb_irq); /* parameter validation in core/urb */ 675 usb_free_urb(dev->urb_ctl); /* parameter validation in core/urb */ 676 kfree(dev); 677 } 678 679 static void cm109_usb_disconnect(struct usb_interface *interface) 680 { 681 struct cm109_dev *dev = usb_get_intfdata(interface); 682 683 usb_set_intfdata(interface, NULL); 684 input_unregister_device(dev->idev); 685 cm109_usb_cleanup(dev); 686 } 687 688 static int cm109_usb_probe(struct usb_interface *intf, 689 const struct usb_device_id *id) 690 { 691 struct usb_device *udev = interface_to_usbdev(intf); 692 struct driver_info *nfo = (struct driver_info *)id->driver_info; 693 struct usb_host_interface *interface; 694 struct usb_endpoint_descriptor *endpoint; 695 struct cm109_dev *dev; 696 struct input_dev *input_dev = NULL; 697 int ret, pipe, i; 698 int error = -ENOMEM; 699 700 interface = intf->cur_altsetting; 701 endpoint = &interface->endpoint[0].desc; 702 703 if (!usb_endpoint_is_int_in(endpoint)) 704 return -ENODEV; 705 706 dev = kzalloc(sizeof(*dev), GFP_KERNEL); 707 if (!dev) 708 return -ENOMEM; 709 710 spin_lock_init(&dev->ctl_submit_lock); 711 mutex_init(&dev->pm_mutex); 712 713 dev->udev = udev; 714 dev->intf = intf; 715 716 dev->idev = input_dev = input_allocate_device(); 717 if (!input_dev) 718 goto err_out; 719 720 /* allocate usb buffers */ 721 dev->irq_data = usb_alloc_coherent(udev, USB_PKT_LEN, 722 GFP_KERNEL, &dev->irq_dma); 723 if (!dev->irq_data) 724 goto err_out; 725 726 dev->ctl_data = usb_alloc_coherent(udev, USB_PKT_LEN, 727 GFP_KERNEL, &dev->ctl_dma); 728 if (!dev->ctl_data) 729 goto err_out; 730 731 dev->ctl_req = kmalloc(sizeof(*(dev->ctl_req)), GFP_KERNEL); 732 if (!dev->ctl_req) 733 goto err_out; 734 735 /* allocate urb structures */ 736 dev->urb_irq = usb_alloc_urb(0, GFP_KERNEL); 737 if (!dev->urb_irq) 738 goto err_out; 739 740 dev->urb_ctl = usb_alloc_urb(0, GFP_KERNEL); 741 if (!dev->urb_ctl) 742 goto err_out; 743 744 /* get a handle to the interrupt data pipe */ 745 pipe = usb_rcvintpipe(udev, endpoint->bEndpointAddress); 746 ret = usb_maxpacket(udev, pipe, usb_pipeout(pipe)); 747 if (ret != USB_PKT_LEN) 748 dev_err(&intf->dev, "invalid payload size %d, expected %d\n", 749 ret, USB_PKT_LEN); 750 751 /* initialise irq urb */ 752 usb_fill_int_urb(dev->urb_irq, udev, pipe, dev->irq_data, 753 USB_PKT_LEN, 754 cm109_urb_irq_callback, dev, endpoint->bInterval); 755 dev->urb_irq->transfer_dma = dev->irq_dma; 756 dev->urb_irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 757 dev->urb_irq->dev = udev; 758 759 /* initialise ctl urb */ 760 dev->ctl_req->bRequestType = USB_TYPE_CLASS | USB_RECIP_INTERFACE | 761 USB_DIR_OUT; 762 dev->ctl_req->bRequest = USB_REQ_SET_CONFIGURATION; 763 dev->ctl_req->wValue = cpu_to_le16(0x200); 764 dev->ctl_req->wIndex = cpu_to_le16(interface->desc.bInterfaceNumber); 765 dev->ctl_req->wLength = cpu_to_le16(USB_PKT_LEN); 766 767 usb_fill_control_urb(dev->urb_ctl, udev, usb_sndctrlpipe(udev, 0), 768 (void *)dev->ctl_req, dev->ctl_data, USB_PKT_LEN, 769 cm109_urb_ctl_callback, dev); 770 dev->urb_ctl->transfer_dma = dev->ctl_dma; 771 dev->urb_ctl->transfer_flags |= URB_NO_TRANSFER_DMA_MAP; 772 dev->urb_ctl->dev = udev; 773 774 /* find out the physical bus location */ 775 usb_make_path(udev, dev->phys, sizeof(dev->phys)); 776 strlcat(dev->phys, "/input0", sizeof(dev->phys)); 777 778 /* register settings for the input device */ 779 input_dev->name = nfo->name; 780 input_dev->phys = dev->phys; 781 usb_to_input_id(udev, &input_dev->id); 782 input_dev->dev.parent = &intf->dev; 783 784 input_set_drvdata(input_dev, dev); 785 input_dev->open = cm109_input_open; 786 input_dev->close = cm109_input_close; 787 input_dev->event = cm109_input_ev; 788 789 input_dev->keycode = dev->keymap; 790 input_dev->keycodesize = sizeof(unsigned char); 791 input_dev->keycodemax = ARRAY_SIZE(dev->keymap); 792 793 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_SND); 794 input_dev->sndbit[0] = BIT_MASK(SND_BELL) | BIT_MASK(SND_TONE); 795 796 /* register available key events */ 797 for (i = 0; i < KEYMAP_SIZE; i++) { 798 unsigned short k = keymap(i); 799 dev->keymap[i] = k; 800 __set_bit(k, input_dev->keybit); 801 } 802 __clear_bit(KEY_RESERVED, input_dev->keybit); 803 804 error = input_register_device(dev->idev); 805 if (error) 806 goto err_out; 807 808 usb_set_intfdata(intf, dev); 809 810 return 0; 811 812 err_out: 813 input_free_device(input_dev); 814 cm109_usb_cleanup(dev); 815 return error; 816 } 817 818 static int cm109_usb_suspend(struct usb_interface *intf, pm_message_t message) 819 { 820 struct cm109_dev *dev = usb_get_intfdata(intf); 821 822 dev_info(&intf->dev, "cm109: usb_suspend (event=%d)\n", message.event); 823 824 mutex_lock(&dev->pm_mutex); 825 cm109_stop_traffic(dev); 826 mutex_unlock(&dev->pm_mutex); 827 828 return 0; 829 } 830 831 static int cm109_usb_resume(struct usb_interface *intf) 832 { 833 struct cm109_dev *dev = usb_get_intfdata(intf); 834 835 dev_info(&intf->dev, "cm109: usb_resume\n"); 836 837 mutex_lock(&dev->pm_mutex); 838 cm109_restore_state(dev); 839 mutex_unlock(&dev->pm_mutex); 840 841 return 0; 842 } 843 844 static int cm109_usb_pre_reset(struct usb_interface *intf) 845 { 846 struct cm109_dev *dev = usb_get_intfdata(intf); 847 848 mutex_lock(&dev->pm_mutex); 849 850 /* 851 * Make sure input events don't try to toggle buzzer 852 * while we are resetting 853 */ 854 dev->resetting = 1; 855 smp_wmb(); 856 857 cm109_stop_traffic(dev); 858 859 return 0; 860 } 861 862 static int cm109_usb_post_reset(struct usb_interface *intf) 863 { 864 struct cm109_dev *dev = usb_get_intfdata(intf); 865 866 dev->resetting = 0; 867 smp_wmb(); 868 869 cm109_restore_state(dev); 870 871 mutex_unlock(&dev->pm_mutex); 872 873 return 0; 874 } 875 876 static struct usb_driver cm109_driver = { 877 .name = "cm109", 878 .probe = cm109_usb_probe, 879 .disconnect = cm109_usb_disconnect, 880 .suspend = cm109_usb_suspend, 881 .resume = cm109_usb_resume, 882 .reset_resume = cm109_usb_resume, 883 .pre_reset = cm109_usb_pre_reset, 884 .post_reset = cm109_usb_post_reset, 885 .id_table = cm109_usb_table, 886 .supports_autosuspend = 1, 887 }; 888 889 static int __init cm109_select_keymap(void) 890 { 891 /* Load the phone keymap */ 892 if (!strcasecmp(phone, "kip1000")) { 893 keymap = keymap_kip1000; 894 printk(KERN_INFO KBUILD_MODNAME ": " 895 "Keymap for Komunikate KIP1000 phone loaded\n"); 896 } else if (!strcasecmp(phone, "gtalk")) { 897 keymap = keymap_gtalk; 898 printk(KERN_INFO KBUILD_MODNAME ": " 899 "Keymap for Genius G-talk phone loaded\n"); 900 } else if (!strcasecmp(phone, "usbph01")) { 901 keymap = keymap_usbph01; 902 printk(KERN_INFO KBUILD_MODNAME ": " 903 "Keymap for Allied-Telesis Corega USBPH01 phone loaded\n"); 904 } else if (!strcasecmp(phone, "atcom")) { 905 keymap = keymap_atcom; 906 printk(KERN_INFO KBUILD_MODNAME ": " 907 "Keymap for ATCom AU-100 phone loaded\n"); 908 } else { 909 printk(KERN_ERR KBUILD_MODNAME ": " 910 "Unsupported phone: %s\n", phone); 911 return -EINVAL; 912 } 913 914 return 0; 915 } 916 917 static int __init cm109_init(void) 918 { 919 int err; 920 921 err = cm109_select_keymap(); 922 if (err) 923 return err; 924 925 err = usb_register(&cm109_driver); 926 if (err) 927 return err; 928 929 printk(KERN_INFO KBUILD_MODNAME ": " 930 DRIVER_DESC ": " DRIVER_VERSION " (C) " DRIVER_AUTHOR "\n"); 931 932 return 0; 933 } 934 935 static void __exit cm109_exit(void) 936 { 937 usb_deregister(&cm109_driver); 938 } 939 940 module_init(cm109_init); 941 module_exit(cm109_exit); 942 943 MODULE_DEVICE_TABLE(usb, cm109_usb_table); 944 945 MODULE_AUTHOR(DRIVER_AUTHOR); 946 MODULE_DESCRIPTION(DRIVER_DESC); 947 MODULE_LICENSE("GPL"); 948