adi.c 13 KB

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