ati_remote.c 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867
  1. /*
  2. * USB ATI Remote support
  3. *
  4. * Version 2.2.0 Copyright (c) 2004 Torrey Hoffman <thoffman@arnor.net>
  5. * Version 2.1.1 Copyright (c) 2002 Vladimir Dergachev
  6. *
  7. * This 2.2.0 version is a rewrite / cleanup of the 2.1.1 driver, including
  8. * porting to the 2.6 kernel interfaces, along with other modification
  9. * to better match the style of the existing usb/input drivers. However, the
  10. * protocol and hardware handling is essentially unchanged from 2.1.1.
  11. *
  12. * The 2.1.1 driver was derived from the usbati_remote and usbkbd drivers by
  13. * Vojtech Pavlik.
  14. *
  15. * Changes:
  16. *
  17. * Feb 2004: Torrey Hoffman <thoffman@arnor.net>
  18. * Version 2.2.0
  19. * Jun 2004: Torrey Hoffman <thoffman@arnor.net>
  20. * Version 2.2.1
  21. * Added key repeat support contributed by:
  22. * Vincent Vanackere <vanackere@lif.univ-mrs.fr>
  23. * Added support for the "Lola" remote contributed by:
  24. * Seth Cohn <sethcohn@yahoo.com>
  25. *
  26. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  27. *
  28. * This program is free software; you can redistribute it and/or modify
  29. * it under the terms of the GNU General Public License as published by
  30. * the Free Software Foundation; either version 2 of the License, or
  31. * (at your option) any later version.
  32. *
  33. * This program is distributed in the hope that it will be useful,
  34. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  36. * GNU General Public License for more details.
  37. *
  38. * You should have received a copy of the GNU General Public License
  39. * along with this program; if not, write to the Free Software
  40. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  41. *
  42. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  43. *
  44. * Hardware & software notes
  45. *
  46. * These remote controls are distributed by ATI as part of their
  47. * "All-In-Wonder" video card packages. The receiver self-identifies as a
  48. * "USB Receiver" with manufacturer "X10 Wireless Technology Inc".
  49. *
  50. * The "Lola" remote is available from X10. See:
  51. * http://www.x10.com/products/lola_sg1.htm
  52. * The Lola is similar to the ATI remote but has no mouse support, and slightly
  53. * different keys.
  54. *
  55. * It is possible to use multiple receivers and remotes on multiple computers
  56. * simultaneously by configuring them to use specific channels.
  57. *
  58. * The RF protocol used by the remote supports 16 distinct channels, 1 to 16.
  59. * Actually, it may even support more, at least in some revisions of the
  60. * hardware.
  61. *
  62. * Each remote can be configured to transmit on one channel as follows:
  63. * - Press and hold the "hand icon" button.
  64. * - When the red LED starts to blink, let go of the "hand icon" button.
  65. * - When it stops blinking, input the channel code as two digits, from 01
  66. * to 16, and press the hand icon again.
  67. *
  68. * The timing can be a little tricky. Try loading the module with debug=1
  69. * to have the kernel print out messages about the remote control number
  70. * and mask. Note: debugging prints remote numbers as zero-based hexadecimal.
  71. *
  72. * The driver has a "channel_mask" parameter. This bitmask specifies which
  73. * channels will be ignored by the module. To mask out channels, just add
  74. * all the 2^channel_number values together.
  75. *
  76. * For instance, set channel_mask = 2^4 = 16 (binary 10000) to make ati_remote
  77. * ignore signals coming from remote controls transmitting on channel 4, but
  78. * accept all other channels.
  79. *
  80. * Or, set channel_mask = 65533, (0xFFFD), and all channels except 1 will be
  81. * ignored.
  82. *
  83. * The default is 0 (respond to all channels). Bit 0 and bits 17-32 of this
  84. * parameter are unused.
  85. *
  86. */
  87. #include <linux/kernel.h>
  88. #include <linux/errno.h>
  89. #include <linux/init.h>
  90. #include <linux/slab.h>
  91. #include <linux/module.h>
  92. #include <linux/usb/input.h>
  93. #include <linux/wait.h>
  94. #include <linux/jiffies.h>
  95. /*
  96. * Module and Version Information, Module Parameters
  97. */
  98. #define ATI_REMOTE_VENDOR_ID 0x0bc7
  99. #define LOLA_REMOTE_PRODUCT_ID 0x0002
  100. #define LOLA2_REMOTE_PRODUCT_ID 0x0003
  101. #define ATI_REMOTE_PRODUCT_ID 0x0004
  102. #define NVIDIA_REMOTE_PRODUCT_ID 0x0005
  103. #define MEDION_REMOTE_PRODUCT_ID 0x0006
  104. #define DRIVER_VERSION "2.2.1"
  105. #define DRIVER_AUTHOR "Torrey Hoffman <thoffman@arnor.net>"
  106. #define DRIVER_DESC "ATI/X10 RF USB Remote Control"
  107. #define NAME_BUFSIZE 80 /* size of product name, path buffers */
  108. #define DATA_BUFSIZE 63 /* size of URB data buffers */
  109. /*
  110. * Duplicate event filtering time.
  111. * Sequential, identical KIND_FILTERED inputs with less than
  112. * FILTER_TIME milliseconds between them are considered as repeat
  113. * events. The hardware generates 5 events for the first keypress
  114. * and we have to take this into account for an accurate repeat
  115. * behaviour.
  116. */
  117. #define FILTER_TIME 60 /* msec */
  118. #define REPEAT_DELAY 500 /* msec */
  119. static unsigned long channel_mask;
  120. module_param(channel_mask, ulong, 0644);
  121. MODULE_PARM_DESC(channel_mask, "Bitmask of remote control channels to ignore");
  122. static int debug;
  123. module_param(debug, int, 0644);
  124. MODULE_PARM_DESC(debug, "Enable extra debug messages and information");
  125. static int repeat_filter = FILTER_TIME;
  126. module_param(repeat_filter, int, 0644);
  127. MODULE_PARM_DESC(repeat_filter, "Repeat filter time, default = 60 msec");
  128. static int repeat_delay = REPEAT_DELAY;
  129. module_param(repeat_delay, int, 0644);
  130. MODULE_PARM_DESC(repeat_delay, "Delay before sending repeats, default = 500 msec");
  131. #define dbginfo(dev, format, arg...) do { if (debug) dev_info(dev , format , ## arg); } while (0)
  132. #undef err
  133. #define err(format, arg...) printk(KERN_ERR format , ## arg)
  134. static struct usb_device_id ati_remote_table[] = {
  135. { USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA_REMOTE_PRODUCT_ID) },
  136. { USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA2_REMOTE_PRODUCT_ID) },
  137. { USB_DEVICE(ATI_REMOTE_VENDOR_ID, ATI_REMOTE_PRODUCT_ID) },
  138. { USB_DEVICE(ATI_REMOTE_VENDOR_ID, NVIDIA_REMOTE_PRODUCT_ID) },
  139. { USB_DEVICE(ATI_REMOTE_VENDOR_ID, MEDION_REMOTE_PRODUCT_ID) },
  140. {} /* Terminating entry */
  141. };
  142. MODULE_DEVICE_TABLE(usb, ati_remote_table);
  143. /* Get hi and low bytes of a 16-bits int */
  144. #define HI(a) ((unsigned char)((a) >> 8))
  145. #define LO(a) ((unsigned char)((a) & 0xff))
  146. #define SEND_FLAG_IN_PROGRESS 1
  147. #define SEND_FLAG_COMPLETE 2
  148. /* Device initialization strings */
  149. static char init1[] = { 0x01, 0x00, 0x20, 0x14 };
  150. static char init2[] = { 0x01, 0x00, 0x20, 0x14, 0x20, 0x20, 0x20 };
  151. struct ati_remote {
  152. struct input_dev *idev;
  153. struct usb_device *udev;
  154. struct usb_interface *interface;
  155. struct urb *irq_urb;
  156. struct urb *out_urb;
  157. struct usb_endpoint_descriptor *endpoint_in;
  158. struct usb_endpoint_descriptor *endpoint_out;
  159. unsigned char *inbuf;
  160. unsigned char *outbuf;
  161. dma_addr_t inbuf_dma;
  162. dma_addr_t outbuf_dma;
  163. unsigned char old_data[2]; /* Detect duplicate events */
  164. unsigned long old_jiffies;
  165. unsigned long acc_jiffies; /* handle acceleration */
  166. unsigned long first_jiffies;
  167. unsigned int repeat_count;
  168. char name[NAME_BUFSIZE];
  169. char phys[NAME_BUFSIZE];
  170. wait_queue_head_t wait;
  171. int send_flags;
  172. };
  173. /* "Kinds" of messages sent from the hardware to the driver. */
  174. #define KIND_END 0
  175. #define KIND_LITERAL 1 /* Simply pass to input system */
  176. #define KIND_FILTERED 2 /* Add artificial key-up events, drop keyrepeats */
  177. #define KIND_LU 3 /* Directional keypad diagonals - left up, */
  178. #define KIND_RU 4 /* right up, */
  179. #define KIND_LD 5 /* left down, */
  180. #define KIND_RD 6 /* right down */
  181. #define KIND_ACCEL 7 /* Directional keypad - left, right, up, down.*/
  182. /* Translation table from hardware messages to input events. */
  183. static const struct {
  184. short kind;
  185. unsigned char data1, data2;
  186. int type;
  187. unsigned int code;
  188. int value;
  189. } ati_remote_tbl[] = {
  190. /* Directional control pad axes */
  191. {KIND_ACCEL, 0x35, 0x70, EV_REL, REL_X, -1}, /* left */
  192. {KIND_ACCEL, 0x36, 0x71, EV_REL, REL_X, 1}, /* right */
  193. {KIND_ACCEL, 0x37, 0x72, EV_REL, REL_Y, -1}, /* up */
  194. {KIND_ACCEL, 0x38, 0x73, EV_REL, REL_Y, 1}, /* down */
  195. /* Directional control pad diagonals */
  196. {KIND_LU, 0x39, 0x74, EV_REL, 0, 0}, /* left up */
  197. {KIND_RU, 0x3a, 0x75, EV_REL, 0, 0}, /* right up */
  198. {KIND_LD, 0x3c, 0x77, EV_REL, 0, 0}, /* left down */
  199. {KIND_RD, 0x3b, 0x76, EV_REL, 0, 0}, /* right down */
  200. /* "Mouse button" buttons */
  201. {KIND_LITERAL, 0x3d, 0x78, EV_KEY, BTN_LEFT, 1}, /* left btn down */
  202. {KIND_LITERAL, 0x3e, 0x79, EV_KEY, BTN_LEFT, 0}, /* left btn up */
  203. {KIND_LITERAL, 0x41, 0x7c, EV_KEY, BTN_RIGHT, 1},/* right btn down */
  204. {KIND_LITERAL, 0x42, 0x7d, EV_KEY, BTN_RIGHT, 0},/* right btn up */
  205. /* Artificial "doubleclick" events are generated by the hardware.
  206. * They are mapped to the "side" and "extra" mouse buttons here. */
  207. {KIND_FILTERED, 0x3f, 0x7a, EV_KEY, BTN_SIDE, 1}, /* left dblclick */
  208. {KIND_FILTERED, 0x43, 0x7e, EV_KEY, BTN_EXTRA, 1},/* right dblclick */
  209. /* keyboard. */
  210. {KIND_FILTERED, 0xd2, 0x0d, EV_KEY, KEY_1, 1},
  211. {KIND_FILTERED, 0xd3, 0x0e, EV_KEY, KEY_2, 1},
  212. {KIND_FILTERED, 0xd4, 0x0f, EV_KEY, KEY_3, 1},
  213. {KIND_FILTERED, 0xd5, 0x10, EV_KEY, KEY_4, 1},
  214. {KIND_FILTERED, 0xd6, 0x11, EV_KEY, KEY_5, 1},
  215. {KIND_FILTERED, 0xd7, 0x12, EV_KEY, KEY_6, 1},
  216. {KIND_FILTERED, 0xd8, 0x13, EV_KEY, KEY_7, 1},
  217. {KIND_FILTERED, 0xd9, 0x14, EV_KEY, KEY_8, 1},
  218. {KIND_FILTERED, 0xda, 0x15, EV_KEY, KEY_9, 1},
  219. {KIND_FILTERED, 0xdc, 0x17, EV_KEY, KEY_0, 1},
  220. {KIND_FILTERED, 0xc5, 0x00, EV_KEY, KEY_A, 1},
  221. {KIND_FILTERED, 0xc6, 0x01, EV_KEY, KEY_B, 1},
  222. {KIND_FILTERED, 0xde, 0x19, EV_KEY, KEY_C, 1},
  223. {KIND_FILTERED, 0xe0, 0x1b, EV_KEY, KEY_D, 1},
  224. {KIND_FILTERED, 0xe6, 0x21, EV_KEY, KEY_E, 1},
  225. {KIND_FILTERED, 0xe8, 0x23, EV_KEY, KEY_F, 1},
  226. /* "special" keys */
  227. {KIND_FILTERED, 0xdd, 0x18, EV_KEY, KEY_KPENTER, 1}, /* "check" */
  228. {KIND_FILTERED, 0xdb, 0x16, EV_KEY, KEY_MENU, 1}, /* "menu" */
  229. {KIND_FILTERED, 0xc7, 0x02, EV_KEY, KEY_POWER, 1}, /* Power */
  230. {KIND_FILTERED, 0xc8, 0x03, EV_KEY, KEY_TV, 1}, /* TV */
  231. {KIND_FILTERED, 0xc9, 0x04, EV_KEY, KEY_DVD, 1}, /* DVD */
  232. {KIND_FILTERED, 0xca, 0x05, EV_KEY, KEY_WWW, 1}, /* WEB */
  233. {KIND_FILTERED, 0xcb, 0x06, EV_KEY, KEY_BOOKMARKS, 1}, /* "book" */
  234. {KIND_FILTERED, 0xcc, 0x07, EV_KEY, KEY_EDIT, 1}, /* "hand" */
  235. {KIND_FILTERED, 0xe1, 0x1c, EV_KEY, KEY_COFFEE, 1}, /* "timer" */
  236. {KIND_FILTERED, 0xe5, 0x20, EV_KEY, KEY_FRONT, 1}, /* "max" */
  237. {KIND_FILTERED, 0xe2, 0x1d, EV_KEY, KEY_LEFT, 1}, /* left */
  238. {KIND_FILTERED, 0xe4, 0x1f, EV_KEY, KEY_RIGHT, 1}, /* right */
  239. {KIND_FILTERED, 0xe7, 0x22, EV_KEY, KEY_DOWN, 1}, /* down */
  240. {KIND_FILTERED, 0xdf, 0x1a, EV_KEY, KEY_UP, 1}, /* up */
  241. {KIND_FILTERED, 0xe3, 0x1e, EV_KEY, KEY_OK, 1}, /* "OK" */
  242. {KIND_FILTERED, 0xce, 0x09, EV_KEY, KEY_VOLUMEDOWN, 1}, /* VOL + */
  243. {KIND_FILTERED, 0xcd, 0x08, EV_KEY, KEY_VOLUMEUP, 1}, /* VOL - */
  244. {KIND_FILTERED, 0xcf, 0x0a, EV_KEY, KEY_MUTE, 1}, /* MUTE */
  245. {KIND_FILTERED, 0xd0, 0x0b, EV_KEY, KEY_CHANNELUP, 1}, /* CH + */
  246. {KIND_FILTERED, 0xd1, 0x0c, EV_KEY, KEY_CHANNELDOWN, 1},/* CH - */
  247. {KIND_FILTERED, 0xec, 0x27, EV_KEY, KEY_RECORD, 1}, /* ( o) red */
  248. {KIND_FILTERED, 0xea, 0x25, EV_KEY, KEY_PLAY, 1}, /* ( >) */
  249. {KIND_FILTERED, 0xe9, 0x24, EV_KEY, KEY_REWIND, 1}, /* (<<) */
  250. {KIND_FILTERED, 0xeb, 0x26, EV_KEY, KEY_FORWARD, 1}, /* (>>) */
  251. {KIND_FILTERED, 0xed, 0x28, EV_KEY, KEY_STOP, 1}, /* ([]) */
  252. {KIND_FILTERED, 0xee, 0x29, EV_KEY, KEY_PAUSE, 1}, /* ('') */
  253. {KIND_FILTERED, 0xf0, 0x2b, EV_KEY, KEY_PREVIOUS, 1}, /* (<-) */
  254. {KIND_FILTERED, 0xef, 0x2a, EV_KEY, KEY_NEXT, 1}, /* (>+) */
  255. {KIND_FILTERED, 0xf2, 0x2D, EV_KEY, KEY_INFO, 1}, /* PLAYING */
  256. {KIND_FILTERED, 0xf3, 0x2E, EV_KEY, KEY_HOME, 1}, /* TOP */
  257. {KIND_FILTERED, 0xf4, 0x2F, EV_KEY, KEY_END, 1}, /* END */
  258. {KIND_FILTERED, 0xf5, 0x30, EV_KEY, KEY_SELECT, 1}, /* SELECT */
  259. {KIND_END, 0x00, 0x00, EV_MAX + 1, 0, 0}
  260. };
  261. /* Local function prototypes */
  262. static int ati_remote_open (struct input_dev *inputdev);
  263. static void ati_remote_close (struct input_dev *inputdev);
  264. static int ati_remote_sendpacket (struct ati_remote *ati_remote, u16 cmd, unsigned char *data);
  265. static void ati_remote_irq_out (struct urb *urb);
  266. static void ati_remote_irq_in (struct urb *urb);
  267. static void ati_remote_input_report (struct urb *urb);
  268. static int ati_remote_initialize (struct ati_remote *ati_remote);
  269. static int ati_remote_probe (struct usb_interface *interface, const struct usb_device_id *id);
  270. static void ati_remote_disconnect (struct usb_interface *interface);
  271. /* usb specific object to register with the usb subsystem */
  272. static struct usb_driver ati_remote_driver = {
  273. .name = "ati_remote",
  274. .probe = ati_remote_probe,
  275. .disconnect = ati_remote_disconnect,
  276. .id_table = ati_remote_table,
  277. };
  278. /*
  279. * ati_remote_dump_input
  280. */
  281. static void ati_remote_dump(struct device *dev, unsigned char *data,
  282. unsigned int len)
  283. {
  284. if ((len == 1) && (data[0] != (unsigned char)0xff) && (data[0] != 0x00))
  285. dev_warn(dev, "Weird byte 0x%02x\n", data[0]);
  286. else if (len == 4)
  287. dev_warn(dev, "Weird key %02x %02x %02x %02x\n",
  288. data[0], data[1], data[2], data[3]);
  289. else
  290. dev_warn(dev, "Weird data, len=%d %02x %02x %02x %02x %02x %02x ...\n",
  291. len, data[0], data[1], data[2], data[3], data[4], data[5]);
  292. }
  293. /*
  294. * ati_remote_open
  295. */
  296. static int ati_remote_open(struct input_dev *inputdev)
  297. {
  298. struct ati_remote *ati_remote = input_get_drvdata(inputdev);
  299. /* On first open, submit the read urb which was set up previously. */
  300. ati_remote->irq_urb->dev = ati_remote->udev;
  301. if (usb_submit_urb(ati_remote->irq_urb, GFP_KERNEL)) {
  302. dev_err(&ati_remote->interface->dev,
  303. "%s: usb_submit_urb failed!\n", __func__);
  304. return -EIO;
  305. }
  306. return 0;
  307. }
  308. /*
  309. * ati_remote_close
  310. */
  311. static void ati_remote_close(struct input_dev *inputdev)
  312. {
  313. struct ati_remote *ati_remote = input_get_drvdata(inputdev);
  314. usb_kill_urb(ati_remote->irq_urb);
  315. }
  316. /*
  317. * ati_remote_irq_out
  318. */
  319. static void ati_remote_irq_out(struct urb *urb)
  320. {
  321. struct ati_remote *ati_remote = urb->context;
  322. if (urb->status) {
  323. dev_dbg(&ati_remote->interface->dev, "%s: status %d\n",
  324. __func__, urb->status);
  325. return;
  326. }
  327. ati_remote->send_flags |= SEND_FLAG_COMPLETE;
  328. wmb();
  329. wake_up(&ati_remote->wait);
  330. }
  331. /*
  332. * ati_remote_sendpacket
  333. *
  334. * Used to send device initialization strings
  335. */
  336. static int ati_remote_sendpacket(struct ati_remote *ati_remote, u16 cmd, unsigned char *data)
  337. {
  338. int retval = 0;
  339. /* Set up out_urb */
  340. memcpy(ati_remote->out_urb->transfer_buffer + 1, data, LO(cmd));
  341. ((char *) ati_remote->out_urb->transfer_buffer)[0] = HI(cmd);
  342. ati_remote->out_urb->transfer_buffer_length = LO(cmd) + 1;
  343. ati_remote->out_urb->dev = ati_remote->udev;
  344. ati_remote->send_flags = SEND_FLAG_IN_PROGRESS;
  345. retval = usb_submit_urb(ati_remote->out_urb, GFP_ATOMIC);
  346. if (retval) {
  347. dev_dbg(&ati_remote->interface->dev,
  348. "sendpacket: usb_submit_urb failed: %d\n", retval);
  349. return retval;
  350. }
  351. wait_event_timeout(ati_remote->wait,
  352. ((ati_remote->out_urb->status != -EINPROGRESS) ||
  353. (ati_remote->send_flags & SEND_FLAG_COMPLETE)),
  354. HZ);
  355. usb_kill_urb(ati_remote->out_urb);
  356. return retval;
  357. }
  358. /*
  359. * ati_remote_event_lookup
  360. */
  361. static int ati_remote_event_lookup(int rem, unsigned char d1, unsigned char d2)
  362. {
  363. int i;
  364. for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++) {
  365. /*
  366. * Decide if the table entry matches the remote input.
  367. */
  368. if ((((ati_remote_tbl[i].data1 & 0x0f) == (d1 & 0x0f))) &&
  369. ((((ati_remote_tbl[i].data1 >> 4) -
  370. (d1 >> 4) + rem) & 0x0f) == 0x0f) &&
  371. (ati_remote_tbl[i].data2 == d2))
  372. return i;
  373. }
  374. return -1;
  375. }
  376. /*
  377. * ati_remote_compute_accel
  378. *
  379. * Implements acceleration curve for directional control pad
  380. * If elapsed time since last event is > 1/4 second, user "stopped",
  381. * so reset acceleration. Otherwise, user is probably holding the control
  382. * pad down, so we increase acceleration, ramping up over two seconds to
  383. * a maximum speed.
  384. */
  385. static int ati_remote_compute_accel(struct ati_remote *ati_remote)
  386. {
  387. static const char accel[] = { 1, 2, 4, 6, 9, 13, 20 };
  388. unsigned long now = jiffies;
  389. int acc;
  390. if (time_after(now, ati_remote->old_jiffies + msecs_to_jiffies(250))) {
  391. acc = 1;
  392. ati_remote->acc_jiffies = now;
  393. }
  394. else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(125)))
  395. acc = accel[0];
  396. else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(250)))
  397. acc = accel[1];
  398. else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(500)))
  399. acc = accel[2];
  400. else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(1000)))
  401. acc = accel[3];
  402. else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(1500)))
  403. acc = accel[4];
  404. else if (time_before(now, ati_remote->acc_jiffies + msecs_to_jiffies(2000)))
  405. acc = accel[5];
  406. else
  407. acc = accel[6];
  408. return acc;
  409. }
  410. /*
  411. * ati_remote_report_input
  412. */
  413. static void ati_remote_input_report(struct urb *urb)
  414. {
  415. struct ati_remote *ati_remote = urb->context;
  416. unsigned char *data= ati_remote->inbuf;
  417. struct input_dev *dev = ati_remote->idev;
  418. int index, acc;
  419. int remote_num;
  420. /* Deal with strange looking inputs */
  421. if ( (urb->actual_length != 4) || (data[0] != 0x14) ||
  422. ((data[3] & 0x0f) != 0x00) ) {
  423. ati_remote_dump(&urb->dev->dev, data, urb->actual_length);
  424. return;
  425. }
  426. /* Mask unwanted remote channels. */
  427. /* note: remote_num is 0-based, channel 1 on remote == 0 here */
  428. remote_num = (data[3] >> 4) & 0x0f;
  429. if (channel_mask & (1 << (remote_num + 1))) {
  430. dbginfo(&ati_remote->interface->dev,
  431. "Masked input from channel 0x%02x: data %02x,%02x, mask= 0x%02lx\n",
  432. remote_num, data[1], data[2], channel_mask);
  433. return;
  434. }
  435. /* Look up event code index in translation table */
  436. index = ati_remote_event_lookup(remote_num, data[1], data[2]);
  437. if (index < 0) {
  438. dev_warn(&ati_remote->interface->dev,
  439. "Unknown input from channel 0x%02x: data %02x,%02x\n",
  440. remote_num, data[1], data[2]);
  441. return;
  442. }
  443. dbginfo(&ati_remote->interface->dev,
  444. "channel 0x%02x; data %02x,%02x; index %d; keycode %d\n",
  445. remote_num, data[1], data[2], index, ati_remote_tbl[index].code);
  446. if (ati_remote_tbl[index].kind == KIND_LITERAL) {
  447. input_event(dev, ati_remote_tbl[index].type,
  448. ati_remote_tbl[index].code,
  449. ati_remote_tbl[index].value);
  450. input_sync(dev);
  451. ati_remote->old_jiffies = jiffies;
  452. return;
  453. }
  454. if (ati_remote_tbl[index].kind == KIND_FILTERED) {
  455. unsigned long now = jiffies;
  456. /* Filter duplicate events which happen "too close" together. */
  457. if (ati_remote->old_data[0] == data[1] &&
  458. ati_remote->old_data[1] == data[2] &&
  459. time_before(now, ati_remote->old_jiffies +
  460. msecs_to_jiffies(repeat_filter))) {
  461. ati_remote->repeat_count++;
  462. } else {
  463. ati_remote->repeat_count = 0;
  464. ati_remote->first_jiffies = now;
  465. }
  466. ati_remote->old_data[0] = data[1];
  467. ati_remote->old_data[1] = data[2];
  468. ati_remote->old_jiffies = now;
  469. /* Ensure we skip at least the 4 first duplicate events (generated
  470. * by a single keypress), and continue skipping until repeat_delay
  471. * msecs have passed
  472. */
  473. if (ati_remote->repeat_count > 0 &&
  474. (ati_remote->repeat_count < 5 ||
  475. time_before(now, ati_remote->first_jiffies +
  476. msecs_to_jiffies(repeat_delay))))
  477. return;
  478. input_event(dev, ati_remote_tbl[index].type,
  479. ati_remote_tbl[index].code, 1);
  480. input_sync(dev);
  481. input_event(dev, ati_remote_tbl[index].type,
  482. ati_remote_tbl[index].code, 0);
  483. input_sync(dev);
  484. } else {
  485. /*
  486. * Other event kinds are from the directional control pad, and have an
  487. * acceleration factor applied to them. Without this acceleration, the
  488. * control pad is mostly unusable.
  489. */
  490. acc = ati_remote_compute_accel(ati_remote);
  491. switch (ati_remote_tbl[index].kind) {
  492. case KIND_ACCEL:
  493. input_event(dev, ati_remote_tbl[index].type,
  494. ati_remote_tbl[index].code,
  495. ati_remote_tbl[index].value * acc);
  496. break;
  497. case KIND_LU:
  498. input_report_rel(dev, REL_X, -acc);
  499. input_report_rel(dev, REL_Y, -acc);
  500. break;
  501. case KIND_RU:
  502. input_report_rel(dev, REL_X, acc);
  503. input_report_rel(dev, REL_Y, -acc);
  504. break;
  505. case KIND_LD:
  506. input_report_rel(dev, REL_X, -acc);
  507. input_report_rel(dev, REL_Y, acc);
  508. break;
  509. case KIND_RD:
  510. input_report_rel(dev, REL_X, acc);
  511. input_report_rel(dev, REL_Y, acc);
  512. break;
  513. default:
  514. dev_dbg(&ati_remote->interface->dev, "ati_remote kind=%d\n",
  515. ati_remote_tbl[index].kind);
  516. }
  517. input_sync(dev);
  518. ati_remote->old_jiffies = jiffies;
  519. ati_remote->old_data[0] = data[1];
  520. ati_remote->old_data[1] = data[2];
  521. }
  522. }
  523. /*
  524. * ati_remote_irq_in
  525. */
  526. static void ati_remote_irq_in(struct urb *urb)
  527. {
  528. struct ati_remote *ati_remote = urb->context;
  529. int retval;
  530. switch (urb->status) {
  531. case 0: /* success */
  532. ati_remote_input_report(urb);
  533. break;
  534. case -ECONNRESET: /* unlink */
  535. case -ENOENT:
  536. case -ESHUTDOWN:
  537. dev_dbg(&ati_remote->interface->dev, "%s: urb error status, unlink? \n",
  538. __func__);
  539. return;
  540. default: /* error */
  541. dev_dbg(&ati_remote->interface->dev, "%s: Nonzero urb status %d\n",
  542. __func__, urb->status);
  543. }
  544. retval = usb_submit_urb(urb, GFP_ATOMIC);
  545. if (retval)
  546. dev_err(&ati_remote->interface->dev, "%s: usb_submit_urb()=%d\n",
  547. __func__, retval);
  548. }
  549. /*
  550. * ati_remote_alloc_buffers
  551. */
  552. static int ati_remote_alloc_buffers(struct usb_device *udev,
  553. struct ati_remote *ati_remote)
  554. {
  555. ati_remote->inbuf = usb_alloc_coherent(udev, DATA_BUFSIZE, GFP_ATOMIC,
  556. &ati_remote->inbuf_dma);
  557. if (!ati_remote->inbuf)
  558. return -1;
  559. ati_remote->outbuf = usb_alloc_coherent(udev, DATA_BUFSIZE, GFP_ATOMIC,
  560. &ati_remote->outbuf_dma);
  561. if (!ati_remote->outbuf)
  562. return -1;
  563. ati_remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
  564. if (!ati_remote->irq_urb)
  565. return -1;
  566. ati_remote->out_urb = usb_alloc_urb(0, GFP_KERNEL);
  567. if (!ati_remote->out_urb)
  568. return -1;
  569. return 0;
  570. }
  571. /*
  572. * ati_remote_free_buffers
  573. */
  574. static void ati_remote_free_buffers(struct ati_remote *ati_remote)
  575. {
  576. usb_free_urb(ati_remote->irq_urb);
  577. usb_free_urb(ati_remote->out_urb);
  578. usb_free_coherent(ati_remote->udev, DATA_BUFSIZE,
  579. ati_remote->inbuf, ati_remote->inbuf_dma);
  580. usb_free_coherent(ati_remote->udev, DATA_BUFSIZE,
  581. ati_remote->outbuf, ati_remote->outbuf_dma);
  582. }
  583. static void ati_remote_input_init(struct ati_remote *ati_remote)
  584. {
  585. struct input_dev *idev = ati_remote->idev;
  586. int i;
  587. idev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REL);
  588. idev->keybit[BIT_WORD(BTN_MOUSE)] = BIT_MASK(BTN_LEFT) |
  589. BIT_MASK(BTN_RIGHT) | BIT_MASK(BTN_SIDE) | BIT_MASK(BTN_EXTRA);
  590. idev->relbit[0] = BIT_MASK(REL_X) | BIT_MASK(REL_Y);
  591. for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++)
  592. if (ati_remote_tbl[i].type == EV_KEY)
  593. set_bit(ati_remote_tbl[i].code, idev->keybit);
  594. input_set_drvdata(idev, ati_remote);
  595. idev->open = ati_remote_open;
  596. idev->close = ati_remote_close;
  597. idev->name = ati_remote->name;
  598. idev->phys = ati_remote->phys;
  599. usb_to_input_id(ati_remote->udev, &idev->id);
  600. idev->dev.parent = &ati_remote->udev->dev;
  601. }
  602. static int ati_remote_initialize(struct ati_remote *ati_remote)
  603. {
  604. struct usb_device *udev = ati_remote->udev;
  605. int pipe, maxp;
  606. init_waitqueue_head(&ati_remote->wait);
  607. /* Set up irq_urb */
  608. pipe = usb_rcvintpipe(udev, ati_remote->endpoint_in->bEndpointAddress);
  609. maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
  610. maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
  611. usb_fill_int_urb(ati_remote->irq_urb, udev, pipe, ati_remote->inbuf,
  612. maxp, ati_remote_irq_in, ati_remote,
  613. ati_remote->endpoint_in->bInterval);
  614. ati_remote->irq_urb->transfer_dma = ati_remote->inbuf_dma;
  615. ati_remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
  616. /* Set up out_urb */
  617. pipe = usb_sndintpipe(udev, ati_remote->endpoint_out->bEndpointAddress);
  618. maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
  619. maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
  620. usb_fill_int_urb(ati_remote->out_urb, udev, pipe, ati_remote->outbuf,
  621. maxp, ati_remote_irq_out, ati_remote,
  622. ati_remote->endpoint_out->bInterval);
  623. ati_remote->out_urb->transfer_dma = ati_remote->outbuf_dma;
  624. ati_remote->out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
  625. /* send initialization strings */
  626. if ((ati_remote_sendpacket(ati_remote, 0x8004, init1)) ||
  627. (ati_remote_sendpacket(ati_remote, 0x8007, init2))) {
  628. dev_err(&ati_remote->interface->dev,
  629. "Initializing ati_remote hardware failed.\n");
  630. return -EIO;
  631. }
  632. return 0;
  633. }
  634. /*
  635. * ati_remote_probe
  636. */
  637. static int ati_remote_probe(struct usb_interface *interface, const struct usb_device_id *id)
  638. {
  639. struct usb_device *udev = interface_to_usbdev(interface);
  640. struct usb_host_interface *iface_host = interface->cur_altsetting;
  641. struct usb_endpoint_descriptor *endpoint_in, *endpoint_out;
  642. struct ati_remote *ati_remote;
  643. struct input_dev *input_dev;
  644. int err = -ENOMEM;
  645. if (iface_host->desc.bNumEndpoints != 2) {
  646. err("%s: Unexpected desc.bNumEndpoints\n", __func__);
  647. return -ENODEV;
  648. }
  649. endpoint_in = &iface_host->endpoint[0].desc;
  650. endpoint_out = &iface_host->endpoint[1].desc;
  651. if (!usb_endpoint_is_int_in(endpoint_in)) {
  652. err("%s: Unexpected endpoint_in\n", __func__);
  653. return -ENODEV;
  654. }
  655. if (le16_to_cpu(endpoint_in->wMaxPacketSize) == 0) {
  656. err("%s: endpoint_in message size==0? \n", __func__);
  657. return -ENODEV;
  658. }
  659. ati_remote = kzalloc(sizeof (struct ati_remote), GFP_KERNEL);
  660. input_dev = input_allocate_device();
  661. if (!ati_remote || !input_dev)
  662. goto fail1;
  663. /* Allocate URB buffers, URBs */
  664. if (ati_remote_alloc_buffers(udev, ati_remote))
  665. goto fail2;
  666. ati_remote->endpoint_in = endpoint_in;
  667. ati_remote->endpoint_out = endpoint_out;
  668. ati_remote->udev = udev;
  669. ati_remote->idev = input_dev;
  670. ati_remote->interface = interface;
  671. usb_make_path(udev, ati_remote->phys, sizeof(ati_remote->phys));
  672. strlcat(ati_remote->phys, "/input0", sizeof(ati_remote->phys));
  673. if (udev->manufacturer)
  674. strlcpy(ati_remote->name, udev->manufacturer, sizeof(ati_remote->name));
  675. if (udev->product)
  676. snprintf(ati_remote->name, sizeof(ati_remote->name),
  677. "%s %s", ati_remote->name, udev->product);
  678. if (!strlen(ati_remote->name))
  679. snprintf(ati_remote->name, sizeof(ati_remote->name),
  680. DRIVER_DESC "(%04x,%04x)",
  681. le16_to_cpu(ati_remote->udev->descriptor.idVendor),
  682. le16_to_cpu(ati_remote->udev->descriptor.idProduct));
  683. ati_remote_input_init(ati_remote);
  684. /* Device Hardware Initialization - fills in ati_remote->idev from udev. */
  685. err = ati_remote_initialize(ati_remote);
  686. if (err)
  687. goto fail3;
  688. /* Set up and register input device */
  689. err = input_register_device(ati_remote->idev);
  690. if (err)
  691. goto fail3;
  692. usb_set_intfdata(interface, ati_remote);
  693. return 0;
  694. fail3: usb_kill_urb(ati_remote->irq_urb);
  695. usb_kill_urb(ati_remote->out_urb);
  696. fail2: ati_remote_free_buffers(ati_remote);
  697. fail1: input_free_device(input_dev);
  698. kfree(ati_remote);
  699. return err;
  700. }
  701. /*
  702. * ati_remote_disconnect
  703. */
  704. static void ati_remote_disconnect(struct usb_interface *interface)
  705. {
  706. struct ati_remote *ati_remote;
  707. ati_remote = usb_get_intfdata(interface);
  708. usb_set_intfdata(interface, NULL);
  709. if (!ati_remote) {
  710. dev_warn(&interface->dev, "%s - null device?\n", __func__);
  711. return;
  712. }
  713. usb_kill_urb(ati_remote->irq_urb);
  714. usb_kill_urb(ati_remote->out_urb);
  715. input_unregister_device(ati_remote->idev);
  716. ati_remote_free_buffers(ati_remote);
  717. kfree(ati_remote);
  718. }
  719. /*
  720. * ati_remote_init
  721. */
  722. static int __init ati_remote_init(void)
  723. {
  724. int result;
  725. result = usb_register(&ati_remote_driver);
  726. if (result)
  727. printk(KERN_ERR KBUILD_MODNAME
  728. ": usb_register error #%d\n", result);
  729. else
  730. printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
  731. DRIVER_DESC "\n");
  732. return result;
  733. }
  734. /*
  735. * ati_remote_exit
  736. */
  737. static void __exit ati_remote_exit(void)
  738. {
  739. usb_deregister(&ati_remote_driver);
  740. }
  741. /*
  742. * module specification
  743. */
  744. module_init(ati_remote_init);
  745. module_exit(ati_remote_exit);
  746. MODULE_AUTHOR(DRIVER_AUTHOR);
  747. MODULE_DESCRIPTION(DRIVER_DESC);
  748. MODULE_LICENSE("GPL");