cm109.c 24 KB

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