adi.c 14 KB

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