adi.c 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
  1. /*
  2. * Copyright (c) 1998-2005 Vojtech Pavlik
  3. */
  4. /*
  5. * Logitech ADI joystick family driver for Linux
  6. */
  7. /*
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; either version 2 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program; if not, write to the Free Software
  20. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  21. *
  22. * Should you need to contact me, the author, you can do so either by
  23. * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
  24. * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
  25. */
  26. #include <linux/delay.h>
  27. #include <linux/kernel.h>
  28. #include <linux/module.h>
  29. #include <linux/string.h>
  30. #include <linux/slab.h>
  31. #include <linux/input.h>
  32. #include <linux/gameport.h>
  33. #include <linux/init.h>
  34. #define DRIVER_DESC "Logitech ADI joystick family driver"
  35. MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  36. MODULE_DESCRIPTION(DRIVER_DESC);
  37. MODULE_LICENSE("GPL");
  38. /*
  39. * Times, array sizes, flags, ids.
  40. */
  41. #define ADI_MAX_START 200 /* Trigger to packet timeout [200us] */
  42. #define ADI_MAX_STROBE 40 /* Single bit timeout [40us] */
  43. #define ADI_INIT_DELAY 10 /* Delay after init packet [10ms] */
  44. #define ADI_DATA_DELAY 4 /* Delay after data packet [4ms] */
  45. #define ADI_MAX_LENGTH 256
  46. #define ADI_MIN_LENGTH 8
  47. #define ADI_MIN_LEN_LENGTH 10
  48. #define ADI_MIN_ID_LENGTH 66
  49. #define ADI_MAX_NAME_LENGTH 48
  50. #define ADI_MAX_CNAME_LENGTH 16
  51. #define ADI_MAX_PHYS_LENGTH 64
  52. #define ADI_FLAG_HAT 0x04
  53. #define ADI_FLAG_10BIT 0x08
  54. #define ADI_ID_TPD 0x01
  55. #define ADI_ID_WGP 0x06
  56. #define ADI_ID_WGPE 0x08
  57. #define ADI_ID_MAX 0x0a
  58. /*
  59. * Names, buttons, axes ...
  60. */
  61. static char *adi_names[] = { "WingMan Extreme Digital", "ThunderPad Digital", "SideCar", "CyberMan 2",
  62. "WingMan Interceptor", "WingMan Formula", "WingMan GamePad",
  63. "WingMan Extreme Digital 3D", "WingMan GamePad Extreme",
  64. "WingMan GamePad USB", "Unknown Device %#x" };
  65. static char adi_wmgpe_abs[] = { ABS_X, ABS_Y, ABS_HAT0X, ABS_HAT0Y };
  66. static char adi_wmi_abs[] = { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, ABS_HAT2X, ABS_HAT2Y };
  67. static char adi_wmed3d_abs[] = { ABS_X, ABS_Y, ABS_THROTTLE, ABS_RZ, ABS_HAT0X, ABS_HAT0Y };
  68. static char adi_cm2_abs[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };
  69. static char adi_wmf_abs[] = { ABS_WHEEL, ABS_GAS, ABS_BRAKE, ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, ABS_HAT2X, ABS_HAT2Y };
  70. static short adi_wmgpe_key[] = { BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, BTN_TL, BTN_TR, BTN_START, BTN_MODE, BTN_SELECT };
  71. static short adi_wmi_key[] = { BTN_TRIGGER, BTN_TOP, BTN_THUMB, BTN_TOP2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_EXTRA };
  72. static short adi_wmed3d_key[] = { BTN_TRIGGER, BTN_THUMB, BTN_THUMB2, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2 };
  73. static short adi_cm2_key[] = { BTN_1, BTN_2, BTN_3, BTN_4, BTN_5, BTN_6, BTN_7, BTN_8 };
  74. static char* adi_abs[] = { adi_wmi_abs, adi_wmgpe_abs, adi_wmf_abs, adi_cm2_abs, adi_wmi_abs, adi_wmf_abs,
  75. adi_wmgpe_abs, adi_wmed3d_abs, adi_wmgpe_abs, adi_wmgpe_abs, adi_wmi_abs };
  76. static short* adi_key[] = { adi_wmi_key, adi_wmgpe_key, adi_cm2_key, adi_cm2_key, adi_wmi_key, adi_cm2_key,
  77. adi_wmgpe_key, adi_wmed3d_key, adi_wmgpe_key, adi_wmgpe_key, adi_wmi_key };
  78. /*
  79. * Hat to axis conversion arrays.
  80. */
  81. static struct {
  82. int x;
  83. int y;
  84. } adi_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
  85. /*
  86. * Per-port information.
  87. */
  88. struct adi {
  89. struct input_dev dev;
  90. int length;
  91. int ret;
  92. int idx;
  93. unsigned char id;
  94. char buttons;
  95. char axes10;
  96. char axes8;
  97. signed char pad;
  98. char hats;
  99. char *abs;
  100. short *key;
  101. char name[ADI_MAX_NAME_LENGTH];
  102. char cname[ADI_MAX_CNAME_LENGTH];
  103. char phys[ADI_MAX_PHYS_LENGTH];
  104. unsigned char data[ADI_MAX_LENGTH];
  105. };
  106. struct adi_port {
  107. struct gameport *gameport;
  108. struct adi adi[2];
  109. int bad;
  110. int reads;
  111. };
  112. /*
  113. * adi_read_packet() reads a Logitech ADI packet.
  114. */
  115. static void adi_read_packet(struct adi_port *port)
  116. {
  117. struct adi *adi = port->adi;
  118. struct gameport *gameport = port->gameport;
  119. unsigned char u, v, w, x, z;
  120. int t[2], s[2], i;
  121. unsigned long flags;
  122. for (i = 0; i < 2; i++) {
  123. adi[i].ret = -1;
  124. t[i] = gameport_time(gameport, ADI_MAX_START);
  125. s[i] = 0;
  126. }
  127. local_irq_save(flags);
  128. gameport_trigger(gameport);
  129. v = z = gameport_read(gameport);
  130. do {
  131. u = v;
  132. w = u ^ (v = x = gameport_read(gameport));
  133. for (i = 0; i < 2; i++, w >>= 2, x >>= 2) {
  134. t[i]--;
  135. if ((w & 0x30) && s[i]) {
  136. if ((w & 0x30) < 0x30 && adi[i].ret < ADI_MAX_LENGTH && t[i] > 0) {
  137. adi[i].data[++adi[i].ret] = w;
  138. t[i] = gameport_time(gameport, ADI_MAX_STROBE);
  139. } else t[i] = 0;
  140. } else if (!(x & 0x30)) s[i] = 1;
  141. }
  142. } while (t[0] > 0 || t[1] > 0);
  143. local_irq_restore(flags);
  144. return;
  145. }
  146. /*
  147. * adi_move_bits() detects a possible 2-stream mode, and moves
  148. * the bits accordingly.
  149. */
  150. static void adi_move_bits(struct adi_port *port, int length)
  151. {
  152. int i;
  153. struct adi *adi = port->adi;
  154. adi[0].idx = adi[1].idx = 0;
  155. if (adi[0].ret <= 0 || adi[1].ret <= 0) return;
  156. if (adi[0].data[0] & 0x20 || ~adi[1].data[0] & 0x20) return;
  157. for (i = 1; i <= adi[1].ret; i++)
  158. adi[0].data[((length - 1) >> 1) + i + 1] = adi[1].data[i];
  159. adi[0].ret += adi[1].ret;
  160. adi[1].ret = -1;
  161. }
  162. /*
  163. * adi_get_bits() gathers bits from the data packet.
  164. */
  165. static inline int adi_get_bits(struct adi *adi, int count)
  166. {
  167. int bits = 0;
  168. int i;
  169. if ((adi->idx += count) > adi->ret) return 0;
  170. for (i = 0; i < count; i++)
  171. bits |= ((adi->data[adi->idx - i] >> 5) & 1) << i;
  172. return bits;
  173. }
  174. /*
  175. * adi_decode() decodes Logitech joystick data into input events.
  176. */
  177. static int adi_decode(struct adi *adi)
  178. {
  179. struct input_dev *dev = &adi->dev;
  180. char *abs = adi->abs;
  181. short *key = adi->key;
  182. int i, t;
  183. if (adi->ret < adi->length || adi->id != (adi_get_bits(adi, 4) | (adi_get_bits(adi, 4) << 4)))
  184. return -1;
  185. for (i = 0; i < adi->axes10; i++)
  186. input_report_abs(dev, *abs++, adi_get_bits(adi, 10));
  187. for (i = 0; i < adi->axes8; i++)
  188. input_report_abs(dev, *abs++, adi_get_bits(adi, 8));
  189. for (i = 0; i < adi->buttons && i < 63; i++) {
  190. if (i == adi->pad) {
  191. t = adi_get_bits(adi, 4);
  192. input_report_abs(dev, *abs++, ((t >> 2) & 1) - ( t & 1));
  193. input_report_abs(dev, *abs++, ((t >> 1) & 1) - ((t >> 3) & 1));
  194. }
  195. input_report_key(dev, *key++, adi_get_bits(adi, 1));
  196. }
  197. for (i = 0; i < adi->hats; i++) {
  198. if ((t = adi_get_bits(adi, 4)) > 8) t = 0;
  199. input_report_abs(dev, *abs++, adi_hat_to_axis[t].x);
  200. input_report_abs(dev, *abs++, adi_hat_to_axis[t].y);
  201. }
  202. for (i = 63; i < adi->buttons; i++)
  203. input_report_key(dev, *key++, adi_get_bits(adi, 1));
  204. input_sync(dev);
  205. return 0;
  206. }
  207. /*
  208. * adi_read() reads the data packet and decodes it.
  209. */
  210. static int adi_read(struct adi_port *port)
  211. {
  212. int i;
  213. int result = 0;
  214. adi_read_packet(port);
  215. adi_move_bits(port, port->adi[0].length);
  216. for (i = 0; i < 2; i++)
  217. if (port->adi[i].length)
  218. result |= adi_decode(port->adi + i);
  219. return result;
  220. }
  221. /*
  222. * adi_poll() repeatedly polls the Logitech joysticks.
  223. */
  224. static void adi_poll(struct gameport *gameport)
  225. {
  226. struct adi_port *port = gameport_get_drvdata(gameport);
  227. port->bad -= adi_read(port);
  228. port->reads++;
  229. }
  230. /*
  231. * adi_open() is a callback from the input open routine.
  232. */
  233. static int adi_open(struct input_dev *dev)
  234. {
  235. struct adi_port *port = dev->private;
  236. gameport_start_polling(port->gameport);
  237. return 0;
  238. }
  239. /*
  240. * adi_close() is a callback from the input close routine.
  241. */
  242. static void adi_close(struct input_dev *dev)
  243. {
  244. struct adi_port *port = dev->private;
  245. gameport_stop_polling(port->gameport);
  246. }
  247. /*
  248. * adi_init_digital() sends a trigger & delay sequence
  249. * to reset and initialize a Logitech joystick into digital mode.
  250. */
  251. static void adi_init_digital(struct gameport *gameport)
  252. {
  253. int seq[] = { 4, -2, -3, 10, -6, -11, -7, -9, 11, 0 };
  254. int i;
  255. for (i = 0; seq[i]; i++) {
  256. gameport_trigger(gameport);
  257. if (seq[i] > 0) msleep(seq[i]);
  258. if (seq[i] < 0) {
  259. mdelay(-seq[i]);
  260. udelay(-seq[i]*14); /* It looks like mdelay() is off by approx 1.4% */
  261. }
  262. }
  263. }
  264. static void adi_id_decode(struct adi *adi, struct adi_port *port)
  265. {
  266. int i, t;
  267. if (adi->ret < ADI_MIN_ID_LENGTH) /* Minimum ID packet length */
  268. return;
  269. if (adi->ret < (t = adi_get_bits(adi, 10))) {
  270. printk(KERN_WARNING "adi: Short ID packet: reported: %d != read: %d\n", t, adi->ret);
  271. return;
  272. }
  273. adi->id = adi_get_bits(adi, 4) | (adi_get_bits(adi, 4) << 4);
  274. if ((t = adi_get_bits(adi, 4)) & ADI_FLAG_HAT) adi->hats++;
  275. adi->length = adi_get_bits(adi, 10);
  276. if (adi->length >= ADI_MAX_LENGTH || adi->length < ADI_MIN_LENGTH) {
  277. printk(KERN_WARNING "adi: Bad data packet length (%d).\n", adi->length);
  278. adi->length = 0;
  279. return;
  280. }
  281. adi->axes8 = adi_get_bits(adi, 4);
  282. adi->buttons = adi_get_bits(adi, 6);
  283. if (adi_get_bits(adi, 6) != 8 && adi->hats) {
  284. printk(KERN_WARNING "adi: Other than 8-dir POVs not supported yet.\n");
  285. adi->length = 0;
  286. return;
  287. }
  288. adi->buttons += adi_get_bits(adi, 6);
  289. adi->hats += adi_get_bits(adi, 4);
  290. i = adi_get_bits(adi, 4);
  291. if (t & ADI_FLAG_10BIT) {
  292. adi->axes10 = adi->axes8 - i;
  293. adi->axes8 = i;
  294. }
  295. t = adi_get_bits(adi, 4);
  296. for (i = 0; i < t; i++)
  297. adi->cname[i] = adi_get_bits(adi, 8);
  298. adi->cname[i] = 0;
  299. t = 8 + adi->buttons + adi->axes10 * 10 + adi->axes8 * 8 + adi->hats * 4;
  300. if (adi->length != t && adi->length != t + (t & 1)) {
  301. printk(KERN_WARNING "adi: Expected length %d != data length %d\n", t, adi->length);
  302. adi->length = 0;
  303. return;
  304. }
  305. switch (adi->id) {
  306. case ADI_ID_TPD:
  307. adi->pad = 4;
  308. adi->buttons -= 4;
  309. break;
  310. case ADI_ID_WGP:
  311. adi->pad = 0;
  312. adi->buttons -= 4;
  313. break;
  314. default:
  315. adi->pad = -1;
  316. break;
  317. }
  318. }
  319. static void adi_init_input(struct adi *adi, struct adi_port *port, int half)
  320. {
  321. int i, t;
  322. char buf[ADI_MAX_NAME_LENGTH];
  323. if (!adi->length) return;
  324. init_input_dev(&adi->dev);
  325. t = adi->id < ADI_ID_MAX ? adi->id : ADI_ID_MAX;
  326. snprintf(buf, ADI_MAX_PHYS_LENGTH, adi_names[t], adi->id);
  327. snprintf(adi->name, ADI_MAX_NAME_LENGTH, "Logitech %s", buf);
  328. snprintf(adi->phys, ADI_MAX_PHYS_LENGTH, "%s/input%d", port->gameport->phys, half);
  329. adi->abs = adi_abs[t];
  330. adi->key = adi_key[t];
  331. adi->dev.open = adi_open;
  332. adi->dev.close = adi_close;
  333. adi->dev.name = adi->name;
  334. adi->dev.phys = adi->phys;
  335. adi->dev.id.bustype = BUS_GAMEPORT;
  336. adi->dev.id.vendor = GAMEPORT_ID_VENDOR_LOGITECH;
  337. adi->dev.id.product = adi->id;
  338. adi->dev.id.version = 0x0100;
  339. adi->dev.private = port;
  340. adi->dev.evbit[0] = BIT(EV_KEY) | BIT(EV_ABS);
  341. for (i = 0; i < adi->axes10 + adi->axes8 + (adi->hats + (adi->pad != -1)) * 2; i++)
  342. set_bit(adi->abs[i], adi->dev.absbit);
  343. for (i = 0; i < adi->buttons; i++)
  344. set_bit(adi->key[i], adi->dev.keybit);
  345. }
  346. static void adi_init_center(struct adi *adi)
  347. {
  348. int i, t, x;
  349. if (!adi->length)
  350. return;
  351. for (i = 0; i < adi->axes10 + adi->axes8 + (adi->hats + (adi->pad != -1)) * 2; i++) {
  352. t = adi->abs[i];
  353. x = adi->dev.abs[t];
  354. if (t == ABS_THROTTLE || t == ABS_RUDDER || adi->id == ADI_ID_WGPE)
  355. x = i < adi->axes10 ? 512 : 128;
  356. if (i < adi->axes10)
  357. input_set_abs_params(&adi->dev, t, 64, x * 2 - 64, 2, 16);
  358. else if (i < adi->axes10 + adi->axes8)
  359. input_set_abs_params(&adi->dev, t, 48, x * 2 - 48, 1, 16);
  360. else
  361. input_set_abs_params(&adi->dev, t, -1, 1, 0, 0);
  362. }
  363. }
  364. /*
  365. * adi_connect() probes for Logitech ADI joysticks.
  366. */
  367. static int adi_connect(struct gameport *gameport, struct gameport_driver *drv)
  368. {
  369. struct adi_port *port;
  370. int i;
  371. int err;
  372. if (!(port = kzalloc(sizeof(struct adi_port), GFP_KERNEL)))
  373. return -ENOMEM;
  374. port->gameport = gameport;
  375. gameport_set_drvdata(gameport, port);
  376. err = gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
  377. if (err) {
  378. kfree(port);
  379. return err;
  380. }
  381. adi_init_digital(gameport);
  382. adi_read_packet(port);
  383. if (port->adi[0].ret >= ADI_MIN_LEN_LENGTH)
  384. adi_move_bits(port, adi_get_bits(port->adi, 10));
  385. for (i = 0; i < 2; i++) {
  386. adi_id_decode(port->adi + i, port);
  387. adi_init_input(port->adi + i, port, i);
  388. }
  389. if (!port->adi[0].length && !port->adi[1].length) {
  390. gameport_close(gameport);
  391. kfree(port);
  392. return -ENODEV;
  393. }
  394. gameport_set_poll_handler(gameport, adi_poll);
  395. gameport_set_poll_interval(gameport, 20);
  396. msleep(ADI_INIT_DELAY);
  397. if (adi_read(port)) {
  398. msleep(ADI_DATA_DELAY);
  399. adi_read(port);
  400. }
  401. for (i = 0; i < 2; i++)
  402. if (port->adi[i].length > 0) {
  403. adi_init_center(port->adi + i);
  404. input_register_device(&port->adi[i].dev);
  405. printk(KERN_INFO "input: %s [%s] on %s\n",
  406. port->adi[i].name, port->adi[i].cname, gameport->phys);
  407. }
  408. return 0;
  409. }
  410. static void adi_disconnect(struct gameport *gameport)
  411. {
  412. int i;
  413. struct adi_port *port = gameport_get_drvdata(gameport);
  414. for (i = 0; i < 2; i++)
  415. if (port->adi[i].length > 0)
  416. input_unregister_device(&port->adi[i].dev);
  417. gameport_close(gameport);
  418. gameport_set_drvdata(gameport, NULL);
  419. kfree(port);
  420. }
  421. /*
  422. * The gameport device structure.
  423. */
  424. static struct gameport_driver adi_drv = {
  425. .driver = {
  426. .name = "adi",
  427. },
  428. .description = DRIVER_DESC,
  429. .connect = adi_connect,
  430. .disconnect = adi_disconnect,
  431. };
  432. static int __init adi_init(void)
  433. {
  434. gameport_register_driver(&adi_drv);
  435. return 0;
  436. }
  437. static void __exit adi_exit(void)
  438. {
  439. gameport_unregister_driver(&adi_drv);
  440. }
  441. module_init(adi_init);
  442. module_exit(adi_exit);