ati_remote.c 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833
  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/config.h>
  88. #include <linux/kernel.h>
  89. #include <linux/errno.h>
  90. #include <linux/init.h>
  91. #include <linux/slab.h>
  92. #include <linux/module.h>
  93. #include <linux/moduleparam.h>
  94. #include <linux/input.h>
  95. #include <linux/usb.h>
  96. #include <linux/usb_input.h>
  97. #include <linux/wait.h>
  98. #include <linux/jiffies.h>
  99. /*
  100. * Module and Version Information, Module Parameters
  101. */
  102. #define ATI_REMOTE_VENDOR_ID 0x0bc7
  103. #define ATI_REMOTE_PRODUCT_ID 0x004
  104. #define LOLA_REMOTE_PRODUCT_ID 0x002
  105. #define MEDION_REMOTE_PRODUCT_ID 0x006
  106. #define DRIVER_VERSION "2.2.1"
  107. #define DRIVER_AUTHOR "Torrey Hoffman <thoffman@arnor.net>"
  108. #define DRIVER_DESC "ATI/X10 RF USB Remote Control"
  109. #define NAME_BUFSIZE 80 /* size of product name, path buffers */
  110. #define DATA_BUFSIZE 63 /* size of URB data buffers */
  111. static unsigned long channel_mask;
  112. module_param(channel_mask, ulong, 0444);
  113. MODULE_PARM_DESC(channel_mask, "Bitmask of remote control channels to ignore");
  114. static int debug;
  115. module_param(debug, int, 0444);
  116. MODULE_PARM_DESC(debug, "Enable extra debug messages and information");
  117. #define dbginfo(dev, format, arg...) do { if (debug) dev_info(dev , format , ## arg); } while (0)
  118. #undef err
  119. #define err(format, arg...) printk(KERN_ERR format , ## arg)
  120. static struct usb_device_id ati_remote_table[] = {
  121. { USB_DEVICE(ATI_REMOTE_VENDOR_ID, ATI_REMOTE_PRODUCT_ID) },
  122. { USB_DEVICE(ATI_REMOTE_VENDOR_ID, LOLA_REMOTE_PRODUCT_ID) },
  123. { USB_DEVICE(ATI_REMOTE_VENDOR_ID, MEDION_REMOTE_PRODUCT_ID) },
  124. {} /* Terminating entry */
  125. };
  126. MODULE_DEVICE_TABLE(usb, ati_remote_table);
  127. /* Get hi and low bytes of a 16-bits int */
  128. #define HI(a) ((unsigned char)((a) >> 8))
  129. #define LO(a) ((unsigned char)((a) & 0xff))
  130. #define SEND_FLAG_IN_PROGRESS 1
  131. #define SEND_FLAG_COMPLETE 2
  132. /* Device initialization strings */
  133. static char init1[] = { 0x01, 0x00, 0x20, 0x14 };
  134. static char init2[] = { 0x01, 0x00, 0x20, 0x14, 0x20, 0x20, 0x20 };
  135. /* Acceleration curve for directional control pad */
  136. static const char accel[] = { 1, 2, 4, 6, 9, 13, 20 };
  137. /* Duplicate event filtering time.
  138. * Sequential, identical KIND_FILTERED inputs with less than
  139. * FILTER_TIME jiffies between them are considered as repeat
  140. * events. The hardware generates 5 events for the first keypress
  141. * and we have to take this into account for an accurate repeat
  142. * behaviour.
  143. * (HZ / 20) == 50 ms and works well for me.
  144. */
  145. #define FILTER_TIME (HZ / 20)
  146. struct ati_remote {
  147. struct input_dev *idev;
  148. struct usb_device *udev;
  149. struct usb_interface *interface;
  150. struct urb *irq_urb;
  151. struct urb *out_urb;
  152. struct usb_endpoint_descriptor *endpoint_in;
  153. struct usb_endpoint_descriptor *endpoint_out;
  154. unsigned char *inbuf;
  155. unsigned char *outbuf;
  156. dma_addr_t inbuf_dma;
  157. dma_addr_t outbuf_dma;
  158. unsigned char old_data[2]; /* Detect duplicate events */
  159. unsigned long old_jiffies;
  160. unsigned long acc_jiffies; /* handle acceleration */
  161. unsigned int repeat_count;
  162. char name[NAME_BUFSIZE];
  163. char phys[NAME_BUFSIZE];
  164. wait_queue_head_t wait;
  165. int send_flags;
  166. };
  167. /* "Kinds" of messages sent from the hardware to the driver. */
  168. #define KIND_END 0
  169. #define KIND_LITERAL 1 /* Simply pass to input system */
  170. #define KIND_FILTERED 2 /* Add artificial key-up events, drop keyrepeats */
  171. #define KIND_LU 3 /* Directional keypad diagonals - left up, */
  172. #define KIND_RU 4 /* right up, */
  173. #define KIND_LD 5 /* left down, */
  174. #define KIND_RD 6 /* right down */
  175. #define KIND_ACCEL 7 /* Directional keypad - left, right, up, down.*/
  176. /* Translation table from hardware messages to input events. */
  177. static const struct {
  178. short kind;
  179. unsigned char data1, data2;
  180. int type;
  181. unsigned int code;
  182. int value;
  183. } ati_remote_tbl[] = {
  184. /* Directional control pad axes */
  185. {KIND_ACCEL, 0x35, 0x70, EV_REL, REL_X, -1}, /* left */
  186. {KIND_ACCEL, 0x36, 0x71, EV_REL, REL_X, 1}, /* right */
  187. {KIND_ACCEL, 0x37, 0x72, EV_REL, REL_Y, -1}, /* up */
  188. {KIND_ACCEL, 0x38, 0x73, EV_REL, REL_Y, 1}, /* down */
  189. /* Directional control pad diagonals */
  190. {KIND_LU, 0x39, 0x74, EV_REL, 0, 0}, /* left up */
  191. {KIND_RU, 0x3a, 0x75, EV_REL, 0, 0}, /* right up */
  192. {KIND_LD, 0x3c, 0x77, EV_REL, 0, 0}, /* left down */
  193. {KIND_RD, 0x3b, 0x76, EV_REL, 0, 0}, /* right down */
  194. /* "Mouse button" buttons */
  195. {KIND_LITERAL, 0x3d, 0x78, EV_KEY, BTN_LEFT, 1}, /* left btn down */
  196. {KIND_LITERAL, 0x3e, 0x79, EV_KEY, BTN_LEFT, 0}, /* left btn up */
  197. {KIND_LITERAL, 0x41, 0x7c, EV_KEY, BTN_RIGHT, 1},/* right btn down */
  198. {KIND_LITERAL, 0x42, 0x7d, EV_KEY, BTN_RIGHT, 0},/* right btn up */
  199. /* Artificial "doubleclick" events are generated by the hardware.
  200. * They are mapped to the "side" and "extra" mouse buttons here. */
  201. {KIND_FILTERED, 0x3f, 0x7a, EV_KEY, BTN_SIDE, 1}, /* left dblclick */
  202. {KIND_FILTERED, 0x43, 0x7e, EV_KEY, BTN_EXTRA, 1},/* right dblclick */
  203. /* keyboard. */
  204. {KIND_FILTERED, 0xd2, 0x0d, EV_KEY, KEY_1, 1},
  205. {KIND_FILTERED, 0xd3, 0x0e, EV_KEY, KEY_2, 1},
  206. {KIND_FILTERED, 0xd4, 0x0f, EV_KEY, KEY_3, 1},
  207. {KIND_FILTERED, 0xd5, 0x10, EV_KEY, KEY_4, 1},
  208. {KIND_FILTERED, 0xd6, 0x11, EV_KEY, KEY_5, 1},
  209. {KIND_FILTERED, 0xd7, 0x12, EV_KEY, KEY_6, 1},
  210. {KIND_FILTERED, 0xd8, 0x13, EV_KEY, KEY_7, 1},
  211. {KIND_FILTERED, 0xd9, 0x14, EV_KEY, KEY_8, 1},
  212. {KIND_FILTERED, 0xda, 0x15, EV_KEY, KEY_9, 1},
  213. {KIND_FILTERED, 0xdc, 0x17, EV_KEY, KEY_0, 1},
  214. {KIND_FILTERED, 0xc5, 0x00, EV_KEY, KEY_A, 1},
  215. {KIND_FILTERED, 0xc6, 0x01, EV_KEY, KEY_B, 1},
  216. {KIND_FILTERED, 0xde, 0x19, EV_KEY, KEY_C, 1},
  217. {KIND_FILTERED, 0xe0, 0x1b, EV_KEY, KEY_D, 1},
  218. {KIND_FILTERED, 0xe6, 0x21, EV_KEY, KEY_E, 1},
  219. {KIND_FILTERED, 0xe8, 0x23, EV_KEY, KEY_F, 1},
  220. /* "special" keys */
  221. {KIND_FILTERED, 0xdd, 0x18, EV_KEY, KEY_KPENTER, 1}, /* "check" */
  222. {KIND_FILTERED, 0xdb, 0x16, EV_KEY, KEY_MENU, 1}, /* "menu" */
  223. {KIND_FILTERED, 0xc7, 0x02, EV_KEY, KEY_POWER, 1}, /* Power */
  224. {KIND_FILTERED, 0xc8, 0x03, EV_KEY, KEY_TV, 1}, /* TV */
  225. {KIND_FILTERED, 0xc9, 0x04, EV_KEY, KEY_DVD, 1}, /* DVD */
  226. {KIND_FILTERED, 0xca, 0x05, EV_KEY, KEY_WWW, 1}, /* WEB */
  227. {KIND_FILTERED, 0xcb, 0x06, EV_KEY, KEY_BOOKMARKS, 1}, /* "book" */
  228. {KIND_FILTERED, 0xcc, 0x07, EV_KEY, KEY_EDIT, 1}, /* "hand" */
  229. {KIND_FILTERED, 0xe1, 0x1c, EV_KEY, KEY_COFFEE, 1}, /* "timer" */
  230. {KIND_FILTERED, 0xe5, 0x20, EV_KEY, KEY_FRONT, 1}, /* "max" */
  231. {KIND_FILTERED, 0xe2, 0x1d, EV_KEY, KEY_LEFT, 1}, /* left */
  232. {KIND_FILTERED, 0xe4, 0x1f, EV_KEY, KEY_RIGHT, 1}, /* right */
  233. {KIND_FILTERED, 0xe7, 0x22, EV_KEY, KEY_DOWN, 1}, /* down */
  234. {KIND_FILTERED, 0xdf, 0x1a, EV_KEY, KEY_UP, 1}, /* up */
  235. {KIND_FILTERED, 0xe3, 0x1e, EV_KEY, KEY_OK, 1}, /* "OK" */
  236. {KIND_FILTERED, 0xce, 0x09, EV_KEY, KEY_VOLUMEDOWN, 1}, /* VOL + */
  237. {KIND_FILTERED, 0xcd, 0x08, EV_KEY, KEY_VOLUMEUP, 1}, /* VOL - */
  238. {KIND_FILTERED, 0xcf, 0x0a, EV_KEY, KEY_MUTE, 1}, /* MUTE */
  239. {KIND_FILTERED, 0xd0, 0x0b, EV_KEY, KEY_CHANNELUP, 1}, /* CH + */
  240. {KIND_FILTERED, 0xd1, 0x0c, EV_KEY, KEY_CHANNELDOWN, 1},/* CH - */
  241. {KIND_FILTERED, 0xec, 0x27, EV_KEY, KEY_RECORD, 1}, /* ( o) red */
  242. {KIND_FILTERED, 0xea, 0x25, EV_KEY, KEY_PLAY, 1}, /* ( >) */
  243. {KIND_FILTERED, 0xe9, 0x24, EV_KEY, KEY_REWIND, 1}, /* (<<) */
  244. {KIND_FILTERED, 0xeb, 0x26, EV_KEY, KEY_FORWARD, 1}, /* (>>) */
  245. {KIND_FILTERED, 0xed, 0x28, EV_KEY, KEY_STOP, 1}, /* ([]) */
  246. {KIND_FILTERED, 0xee, 0x29, EV_KEY, KEY_PAUSE, 1}, /* ('') */
  247. {KIND_FILTERED, 0xf0, 0x2b, EV_KEY, KEY_PREVIOUS, 1}, /* (<-) */
  248. {KIND_FILTERED, 0xef, 0x2a, EV_KEY, KEY_NEXT, 1}, /* (>+) */
  249. {KIND_FILTERED, 0xf2, 0x2D, EV_KEY, KEY_INFO, 1}, /* PLAYING */
  250. {KIND_FILTERED, 0xf3, 0x2E, EV_KEY, KEY_HOME, 1}, /* TOP */
  251. {KIND_FILTERED, 0xf4, 0x2F, EV_KEY, KEY_END, 1}, /* END */
  252. {KIND_FILTERED, 0xf5, 0x30, EV_KEY, KEY_SELECT, 1}, /* SELECT */
  253. {KIND_END, 0x00, 0x00, EV_MAX + 1, 0, 0}
  254. };
  255. /* Local function prototypes */
  256. static void ati_remote_dump (unsigned char *data, unsigned int actual_length);
  257. static int ati_remote_open (struct input_dev *inputdev);
  258. static void ati_remote_close (struct input_dev *inputdev);
  259. static int ati_remote_sendpacket (struct ati_remote *ati_remote, u16 cmd, unsigned char *data);
  260. static void ati_remote_irq_out (struct urb *urb, struct pt_regs *regs);
  261. static void ati_remote_irq_in (struct urb *urb, struct pt_regs *regs);
  262. static void ati_remote_input_report (struct urb *urb, struct pt_regs *regs);
  263. static int ati_remote_initialize (struct ati_remote *ati_remote);
  264. static int ati_remote_probe (struct usb_interface *interface, const struct usb_device_id *id);
  265. static void ati_remote_disconnect (struct usb_interface *interface);
  266. /* usb specific object to register with the usb subsystem */
  267. static struct usb_driver ati_remote_driver = {
  268. .name = "ati_remote",
  269. .probe = ati_remote_probe,
  270. .disconnect = ati_remote_disconnect,
  271. .id_table = ati_remote_table,
  272. };
  273. /*
  274. * ati_remote_dump_input
  275. */
  276. static void ati_remote_dump(unsigned char *data, unsigned int len)
  277. {
  278. if ((len == 1) && (data[0] != (unsigned char)0xff) && (data[0] != 0x00))
  279. warn("Weird byte 0x%02x", data[0]);
  280. else if (len == 4)
  281. warn("Weird key %02x %02x %02x %02x",
  282. data[0], data[1], data[2], data[3]);
  283. else
  284. warn("Weird data, len=%d %02x %02x %02x %02x %02x %02x ...",
  285. len, data[0], data[1], data[2], data[3], data[4], data[5]);
  286. }
  287. /*
  288. * ati_remote_open
  289. */
  290. static int ati_remote_open(struct input_dev *inputdev)
  291. {
  292. struct ati_remote *ati_remote = inputdev->private;
  293. /* On first open, submit the read urb which was set up previously. */
  294. ati_remote->irq_urb->dev = ati_remote->udev;
  295. if (usb_submit_urb(ati_remote->irq_urb, GFP_KERNEL)) {
  296. dev_err(&ati_remote->interface->dev,
  297. "%s: usb_submit_urb failed!\n", __FUNCTION__);
  298. return -EIO;
  299. }
  300. return 0;
  301. }
  302. /*
  303. * ati_remote_close
  304. */
  305. static void ati_remote_close(struct input_dev *inputdev)
  306. {
  307. struct ati_remote *ati_remote = inputdev->private;
  308. usb_kill_urb(ati_remote->irq_urb);
  309. }
  310. /*
  311. * ati_remote_irq_out
  312. */
  313. static void ati_remote_irq_out(struct urb *urb, struct pt_regs *regs)
  314. {
  315. struct ati_remote *ati_remote = urb->context;
  316. if (urb->status) {
  317. dev_dbg(&ati_remote->interface->dev, "%s: status %d\n",
  318. __FUNCTION__, urb->status);
  319. return;
  320. }
  321. ati_remote->send_flags |= SEND_FLAG_COMPLETE;
  322. wmb();
  323. wake_up(&ati_remote->wait);
  324. }
  325. /*
  326. * ati_remote_sendpacket
  327. *
  328. * Used to send device initialization strings
  329. */
  330. static int ati_remote_sendpacket(struct ati_remote *ati_remote, u16 cmd, unsigned char *data)
  331. {
  332. int retval = 0;
  333. /* Set up out_urb */
  334. memcpy(ati_remote->out_urb->transfer_buffer + 1, data, LO(cmd));
  335. ((char *) ati_remote->out_urb->transfer_buffer)[0] = HI(cmd);
  336. ati_remote->out_urb->transfer_buffer_length = LO(cmd) + 1;
  337. ati_remote->out_urb->dev = ati_remote->udev;
  338. ati_remote->send_flags = SEND_FLAG_IN_PROGRESS;
  339. retval = usb_submit_urb(ati_remote->out_urb, GFP_ATOMIC);
  340. if (retval) {
  341. dev_dbg(&ati_remote->interface->dev,
  342. "sendpacket: usb_submit_urb failed: %d\n", retval);
  343. return retval;
  344. }
  345. wait_event_timeout(ati_remote->wait,
  346. ((ati_remote->out_urb->status != -EINPROGRESS) ||
  347. (ati_remote->send_flags & SEND_FLAG_COMPLETE)),
  348. HZ);
  349. usb_kill_urb(ati_remote->out_urb);
  350. return retval;
  351. }
  352. /*
  353. * ati_remote_event_lookup
  354. */
  355. static int ati_remote_event_lookup(int rem, unsigned char d1, unsigned char d2)
  356. {
  357. int i;
  358. for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++) {
  359. /*
  360. * Decide if the table entry matches the remote input.
  361. */
  362. if ((((ati_remote_tbl[i].data1 & 0x0f) == (d1 & 0x0f))) &&
  363. ((((ati_remote_tbl[i].data1 >> 4) -
  364. (d1 >> 4) + rem) & 0x0f) == 0x0f) &&
  365. (ati_remote_tbl[i].data2 == d2))
  366. return i;
  367. }
  368. return -1;
  369. }
  370. /*
  371. * ati_remote_report_input
  372. */
  373. static void ati_remote_input_report(struct urb *urb, struct pt_regs *regs)
  374. {
  375. struct ati_remote *ati_remote = urb->context;
  376. unsigned char *data= ati_remote->inbuf;
  377. struct input_dev *dev = ati_remote->idev;
  378. int index, acc;
  379. int remote_num;
  380. /* Deal with strange looking inputs */
  381. if ( (urb->actual_length != 4) || (data[0] != 0x14) ||
  382. ((data[3] & 0x0f) != 0x00) ) {
  383. ati_remote_dump(data, urb->actual_length);
  384. return;
  385. }
  386. /* Mask unwanted remote channels. */
  387. /* note: remote_num is 0-based, channel 1 on remote == 0 here */
  388. remote_num = (data[3] >> 4) & 0x0f;
  389. if (channel_mask & (1 << (remote_num + 1))) {
  390. dbginfo(&ati_remote->interface->dev,
  391. "Masked input from channel 0x%02x: data %02x,%02x, mask= 0x%02lx\n",
  392. remote_num, data[1], data[2], channel_mask);
  393. return;
  394. }
  395. /* Look up event code index in translation table */
  396. index = ati_remote_event_lookup(remote_num, data[1], data[2]);
  397. if (index < 0) {
  398. dev_warn(&ati_remote->interface->dev,
  399. "Unknown input from channel 0x%02x: data %02x,%02x\n",
  400. remote_num, data[1], data[2]);
  401. return;
  402. }
  403. dbginfo(&ati_remote->interface->dev,
  404. "channel 0x%02x; data %02x,%02x; index %d; keycode %d\n",
  405. remote_num, data[1], data[2], index, ati_remote_tbl[index].code);
  406. if (ati_remote_tbl[index].kind == KIND_LITERAL) {
  407. input_regs(dev, regs);
  408. input_event(dev, ati_remote_tbl[index].type,
  409. ati_remote_tbl[index].code,
  410. ati_remote_tbl[index].value);
  411. input_sync(dev);
  412. ati_remote->old_jiffies = jiffies;
  413. return;
  414. }
  415. if (ati_remote_tbl[index].kind == KIND_FILTERED) {
  416. /* Filter duplicate events which happen "too close" together. */
  417. if ((ati_remote->old_data[0] == data[1]) &&
  418. (ati_remote->old_data[1] == data[2]) &&
  419. time_before(jiffies, ati_remote->old_jiffies + FILTER_TIME)) {
  420. ati_remote->repeat_count++;
  421. } else {
  422. ati_remote->repeat_count = 0;
  423. }
  424. ati_remote->old_data[0] = data[1];
  425. ati_remote->old_data[1] = data[2];
  426. ati_remote->old_jiffies = jiffies;
  427. if ((ati_remote->repeat_count > 0)
  428. && (ati_remote->repeat_count < 5))
  429. return;
  430. input_regs(dev, regs);
  431. input_event(dev, ati_remote_tbl[index].type,
  432. ati_remote_tbl[index].code, 1);
  433. input_event(dev, ati_remote_tbl[index].type,
  434. ati_remote_tbl[index].code, 0);
  435. input_sync(dev);
  436. return;
  437. }
  438. /*
  439. * Other event kinds are from the directional control pad, and have an
  440. * acceleration factor applied to them. Without this acceleration, the
  441. * control pad is mostly unusable.
  442. *
  443. * If elapsed time since last event is > 1/4 second, user "stopped",
  444. * so reset acceleration. Otherwise, user is probably holding the control
  445. * pad down, so we increase acceleration, ramping up over two seconds to
  446. * a maximum speed. The acceleration curve is #defined above.
  447. */
  448. if (time_after(jiffies, ati_remote->old_jiffies + (HZ >> 2))) {
  449. acc = 1;
  450. ati_remote->acc_jiffies = jiffies;
  451. }
  452. else if (time_before(jiffies, ati_remote->acc_jiffies + (HZ >> 3))) acc = accel[0];
  453. else if (time_before(jiffies, ati_remote->acc_jiffies + (HZ >> 2))) acc = accel[1];
  454. else if (time_before(jiffies, ati_remote->acc_jiffies + (HZ >> 1))) acc = accel[2];
  455. else if (time_before(jiffies, ati_remote->acc_jiffies + HZ)) acc = accel[3];
  456. else if (time_before(jiffies, ati_remote->acc_jiffies + HZ+(HZ>>1))) acc = accel[4];
  457. else if (time_before(jiffies, ati_remote->acc_jiffies + (HZ << 1))) acc = accel[5];
  458. else acc = accel[6];
  459. input_regs(dev, regs);
  460. switch (ati_remote_tbl[index].kind) {
  461. case KIND_ACCEL:
  462. input_event(dev, ati_remote_tbl[index].type,
  463. ati_remote_tbl[index].code,
  464. ati_remote_tbl[index].value * acc);
  465. break;
  466. case KIND_LU:
  467. input_report_rel(dev, REL_X, -acc);
  468. input_report_rel(dev, REL_Y, -acc);
  469. break;
  470. case KIND_RU:
  471. input_report_rel(dev, REL_X, acc);
  472. input_report_rel(dev, REL_Y, -acc);
  473. break;
  474. case KIND_LD:
  475. input_report_rel(dev, REL_X, -acc);
  476. input_report_rel(dev, REL_Y, acc);
  477. break;
  478. case KIND_RD:
  479. input_report_rel(dev, REL_X, acc);
  480. input_report_rel(dev, REL_Y, acc);
  481. break;
  482. default:
  483. dev_dbg(&ati_remote->interface->dev, "ati_remote kind=%d\n",
  484. ati_remote_tbl[index].kind);
  485. }
  486. input_sync(dev);
  487. ati_remote->old_jiffies = jiffies;
  488. ati_remote->old_data[0] = data[1];
  489. ati_remote->old_data[1] = data[2];
  490. }
  491. /*
  492. * ati_remote_irq_in
  493. */
  494. static void ati_remote_irq_in(struct urb *urb, struct pt_regs *regs)
  495. {
  496. struct ati_remote *ati_remote = urb->context;
  497. int retval;
  498. switch (urb->status) {
  499. case 0: /* success */
  500. ati_remote_input_report(urb, regs);
  501. break;
  502. case -ECONNRESET: /* unlink */
  503. case -ENOENT:
  504. case -ESHUTDOWN:
  505. dev_dbg(&ati_remote->interface->dev, "%s: urb error status, unlink? \n",
  506. __FUNCTION__);
  507. return;
  508. default: /* error */
  509. dev_dbg(&ati_remote->interface->dev, "%s: Nonzero urb status %d\n",
  510. __FUNCTION__, urb->status);
  511. }
  512. retval = usb_submit_urb(urb, SLAB_ATOMIC);
  513. if (retval)
  514. dev_err(&ati_remote->interface->dev, "%s: usb_submit_urb()=%d\n",
  515. __FUNCTION__, retval);
  516. }
  517. /*
  518. * ati_remote_alloc_buffers
  519. */
  520. static int ati_remote_alloc_buffers(struct usb_device *udev,
  521. struct ati_remote *ati_remote)
  522. {
  523. ati_remote->inbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, SLAB_ATOMIC,
  524. &ati_remote->inbuf_dma);
  525. if (!ati_remote->inbuf)
  526. return -1;
  527. ati_remote->outbuf = usb_buffer_alloc(udev, DATA_BUFSIZE, SLAB_ATOMIC,
  528. &ati_remote->outbuf_dma);
  529. if (!ati_remote->outbuf)
  530. return -1;
  531. ati_remote->irq_urb = usb_alloc_urb(0, GFP_KERNEL);
  532. if (!ati_remote->irq_urb)
  533. return -1;
  534. ati_remote->out_urb = usb_alloc_urb(0, GFP_KERNEL);
  535. if (!ati_remote->out_urb)
  536. return -1;
  537. return 0;
  538. }
  539. /*
  540. * ati_remote_free_buffers
  541. */
  542. static void ati_remote_free_buffers(struct ati_remote *ati_remote)
  543. {
  544. if (ati_remote->irq_urb)
  545. usb_free_urb(ati_remote->irq_urb);
  546. if (ati_remote->out_urb)
  547. usb_free_urb(ati_remote->out_urb);
  548. if (ati_remote->inbuf)
  549. usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
  550. ati_remote->inbuf, ati_remote->inbuf_dma);
  551. if (ati_remote->outbuf)
  552. usb_buffer_free(ati_remote->udev, DATA_BUFSIZE,
  553. ati_remote->inbuf, ati_remote->outbuf_dma);
  554. }
  555. static void ati_remote_input_init(struct ati_remote *ati_remote)
  556. {
  557. struct input_dev *idev = ati_remote->idev;
  558. int i;
  559. idev->evbit[0] = BIT(EV_KEY) | BIT(EV_REL);
  560. idev->keybit[LONG(BTN_MOUSE)] = ( BIT(BTN_LEFT) | BIT(BTN_RIGHT) |
  561. BIT(BTN_SIDE) | BIT(BTN_EXTRA) );
  562. idev->relbit[0] = BIT(REL_X) | BIT(REL_Y);
  563. for (i = 0; ati_remote_tbl[i].kind != KIND_END; i++)
  564. if (ati_remote_tbl[i].type == EV_KEY)
  565. set_bit(ati_remote_tbl[i].code, idev->keybit);
  566. idev->private = ati_remote;
  567. idev->open = ati_remote_open;
  568. idev->close = ati_remote_close;
  569. idev->name = ati_remote->name;
  570. idev->phys = ati_remote->phys;
  571. usb_to_input_id(ati_remote->udev, &idev->id);
  572. idev->cdev.dev = &ati_remote->udev->dev;
  573. }
  574. static int ati_remote_initialize(struct ati_remote *ati_remote)
  575. {
  576. struct usb_device *udev = ati_remote->udev;
  577. int pipe, maxp;
  578. init_waitqueue_head(&ati_remote->wait);
  579. /* Set up irq_urb */
  580. pipe = usb_rcvintpipe(udev, ati_remote->endpoint_in->bEndpointAddress);
  581. maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
  582. maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
  583. usb_fill_int_urb(ati_remote->irq_urb, udev, pipe, ati_remote->inbuf,
  584. maxp, ati_remote_irq_in, ati_remote,
  585. ati_remote->endpoint_in->bInterval);
  586. ati_remote->irq_urb->transfer_dma = ati_remote->inbuf_dma;
  587. ati_remote->irq_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
  588. /* Set up out_urb */
  589. pipe = usb_sndintpipe(udev, ati_remote->endpoint_out->bEndpointAddress);
  590. maxp = usb_maxpacket(udev, pipe, usb_pipeout(pipe));
  591. maxp = (maxp > DATA_BUFSIZE) ? DATA_BUFSIZE : maxp;
  592. usb_fill_int_urb(ati_remote->out_urb, udev, pipe, ati_remote->outbuf,
  593. maxp, ati_remote_irq_out, ati_remote,
  594. ati_remote->endpoint_out->bInterval);
  595. ati_remote->out_urb->transfer_dma = ati_remote->outbuf_dma;
  596. ati_remote->out_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
  597. /* send initialization strings */
  598. if ((ati_remote_sendpacket(ati_remote, 0x8004, init1)) ||
  599. (ati_remote_sendpacket(ati_remote, 0x8007, init2))) {
  600. dev_err(&ati_remote->interface->dev,
  601. "Initializing ati_remote hardware failed.\n");
  602. return -EIO;
  603. }
  604. return 0;
  605. }
  606. /*
  607. * ati_remote_probe
  608. */
  609. static int ati_remote_probe(struct usb_interface *interface, const struct usb_device_id *id)
  610. {
  611. struct usb_device *udev = interface_to_usbdev(interface);
  612. struct usb_host_interface *iface_host = interface->cur_altsetting;
  613. struct usb_endpoint_descriptor *endpoint_in, *endpoint_out;
  614. struct ati_remote *ati_remote;
  615. struct input_dev *input_dev;
  616. int err = -ENOMEM;
  617. if (iface_host->desc.bNumEndpoints != 2) {
  618. err("%s: Unexpected desc.bNumEndpoints\n", __FUNCTION__);
  619. return -ENODEV;
  620. }
  621. endpoint_in = &iface_host->endpoint[0].desc;
  622. endpoint_out = &iface_host->endpoint[1].desc;
  623. if (!(endpoint_in->bEndpointAddress & USB_DIR_IN)) {
  624. err("%s: Unexpected endpoint_in->bEndpointAddress\n", __FUNCTION__);
  625. return -ENODEV;
  626. }
  627. if ((endpoint_in->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_INT) {
  628. err("%s: Unexpected endpoint_in->bmAttributes\n", __FUNCTION__);
  629. return -ENODEV;
  630. }
  631. if (le16_to_cpu(endpoint_in->wMaxPacketSize) == 0) {
  632. err("%s: endpoint_in message size==0? \n", __FUNCTION__);
  633. return -ENODEV;
  634. }
  635. ati_remote = kzalloc(sizeof (struct ati_remote), GFP_KERNEL);
  636. input_dev = input_allocate_device();
  637. if (!ati_remote || !input_dev)
  638. goto fail1;
  639. /* Allocate URB buffers, URBs */
  640. if (ati_remote_alloc_buffers(udev, ati_remote))
  641. goto fail2;
  642. ati_remote->endpoint_in = endpoint_in;
  643. ati_remote->endpoint_out = endpoint_out;
  644. ati_remote->udev = udev;
  645. ati_remote->idev = input_dev;
  646. ati_remote->interface = interface;
  647. usb_make_path(udev, ati_remote->phys, sizeof(ati_remote->phys));
  648. strlcpy(ati_remote->phys, "/input0", sizeof(ati_remote->phys));
  649. if (udev->manufacturer)
  650. strlcpy(ati_remote->name, udev->manufacturer, sizeof(ati_remote->name));
  651. if (udev->product)
  652. snprintf(ati_remote->name, sizeof(ati_remote->name),
  653. "%s %s", ati_remote->name, udev->product);
  654. if (!strlen(ati_remote->name))
  655. snprintf(ati_remote->name, sizeof(ati_remote->name),
  656. DRIVER_DESC "(%04x,%04x)",
  657. le16_to_cpu(ati_remote->udev->descriptor.idVendor),
  658. le16_to_cpu(ati_remote->udev->descriptor.idProduct));
  659. ati_remote_input_init(ati_remote);
  660. /* Device Hardware Initialization - fills in ati_remote->idev from udev. */
  661. err = ati_remote_initialize(ati_remote);
  662. if (err)
  663. goto fail3;
  664. /* Set up and register input device */
  665. input_register_device(ati_remote->idev);
  666. usb_set_intfdata(interface, ati_remote);
  667. return 0;
  668. fail3: usb_kill_urb(ati_remote->irq_urb);
  669. usb_kill_urb(ati_remote->out_urb);
  670. fail2: ati_remote_free_buffers(ati_remote);
  671. fail1: input_free_device(input_dev);
  672. kfree(ati_remote);
  673. return err;
  674. }
  675. /*
  676. * ati_remote_disconnect
  677. */
  678. static void ati_remote_disconnect(struct usb_interface *interface)
  679. {
  680. struct ati_remote *ati_remote;
  681. ati_remote = usb_get_intfdata(interface);
  682. usb_set_intfdata(interface, NULL);
  683. if (!ati_remote) {
  684. warn("%s - null device?\n", __FUNCTION__);
  685. return;
  686. }
  687. usb_kill_urb(ati_remote->irq_urb);
  688. usb_kill_urb(ati_remote->out_urb);
  689. input_unregister_device(ati_remote->idev);
  690. ati_remote_free_buffers(ati_remote);
  691. kfree(ati_remote);
  692. }
  693. /*
  694. * ati_remote_init
  695. */
  696. static int __init ati_remote_init(void)
  697. {
  698. int result;
  699. result = usb_register(&ati_remote_driver);
  700. if (result)
  701. err("usb_register error #%d\n", result);
  702. else
  703. info("Registered USB driver " DRIVER_DESC " v. " DRIVER_VERSION);
  704. return result;
  705. }
  706. /*
  707. * ati_remote_exit
  708. */
  709. static void __exit ati_remote_exit(void)
  710. {
  711. usb_deregister(&ati_remote_driver);
  712. }
  713. /*
  714. * module specification
  715. */
  716. module_init(ati_remote_init);
  717. module_exit(ati_remote_exit);
  718. MODULE_AUTHOR(DRIVER_AUTHOR);
  719. MODULE_DESCRIPTION(DRIVER_DESC);
  720. MODULE_LICENSE("GPL");