grip.c 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Copyright (c) 1998-2001 Vojtech Pavlik
  4. */
  5. /*
  6. * Gravis/Kensington GrIP protocol joystick and gamepad driver for Linux
  7. */
  8. #include <linux/kernel.h>
  9. #include <linux/module.h>
  10. #include <linux/slab.h>
  11. #include <linux/gameport.h>
  12. #include <linux/input.h>
  13. #include <linux/jiffies.h>
  14. #define DRIVER_DESC "Gravis GrIP protocol joystick driver"
  15. MODULE_AUTHOR("Vojtech Pavlik <[email protected]>");
  16. MODULE_DESCRIPTION(DRIVER_DESC);
  17. MODULE_LICENSE("GPL");
  18. #define GRIP_MODE_GPP 1
  19. #define GRIP_MODE_BD 2
  20. #define GRIP_MODE_XT 3
  21. #define GRIP_MODE_DC 4
  22. #define GRIP_LENGTH_GPP 24
  23. #define GRIP_STROBE_GPP 200 /* 200 us */
  24. #define GRIP_LENGTH_XT 4
  25. #define GRIP_STROBE_XT 64 /* 64 us */
  26. #define GRIP_MAX_CHUNKS_XT 10
  27. #define GRIP_MAX_BITS_XT 30
  28. struct grip {
  29. struct gameport *gameport;
  30. struct input_dev *dev[2];
  31. unsigned char mode[2];
  32. int reads;
  33. int bads;
  34. char phys[2][32];
  35. };
  36. static int grip_btn_gpp[] = { BTN_START, BTN_SELECT, BTN_TR2, BTN_Y, 0, BTN_TL2, BTN_A, BTN_B, BTN_X, 0, BTN_TL, BTN_TR, -1 };
  37. static int grip_btn_bd[] = { BTN_THUMB, BTN_THUMB2, BTN_TRIGGER, BTN_TOP, BTN_BASE, -1 };
  38. static int grip_btn_xt[] = { BTN_TRIGGER, BTN_THUMB, BTN_A, BTN_B, BTN_C, BTN_X, BTN_Y, BTN_Z, BTN_SELECT, BTN_START, BTN_MODE, -1 };
  39. static int grip_btn_dc[] = { BTN_TRIGGER, BTN_THUMB, BTN_TOP, BTN_TOP2, BTN_BASE, BTN_BASE2, BTN_BASE3, BTN_BASE4, BTN_BASE5, -1 };
  40. static int grip_abs_gpp[] = { ABS_X, ABS_Y, -1 };
  41. static int grip_abs_bd[] = { ABS_X, ABS_Y, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
  42. static int grip_abs_xt[] = { ABS_X, ABS_Y, ABS_BRAKE, ABS_GAS, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, ABS_HAT1X, ABS_HAT1Y, -1 };
  43. static int grip_abs_dc[] = { ABS_X, ABS_Y, ABS_RX, ABS_RY, ABS_THROTTLE, ABS_HAT0X, ABS_HAT0Y, -1 };
  44. static char *grip_name[] = { NULL, "Gravis GamePad Pro", "Gravis Blackhawk Digital",
  45. "Gravis Xterminator Digital", "Gravis Xterminator DualControl" };
  46. static int *grip_abs[] = { NULL, grip_abs_gpp, grip_abs_bd, grip_abs_xt, grip_abs_dc };
  47. static int *grip_btn[] = { NULL, grip_btn_gpp, grip_btn_bd, grip_btn_xt, grip_btn_dc };
  48. static char grip_anx[] = { 0, 0, 3, 5, 5 };
  49. static char grip_cen[] = { 0, 0, 2, 2, 4 };
  50. /*
  51. * grip_gpp_read_packet() reads a Gravis GamePad Pro packet.
  52. */
  53. static int grip_gpp_read_packet(struct gameport *gameport, int shift, unsigned int *data)
  54. {
  55. unsigned long flags;
  56. unsigned char u, v;
  57. unsigned int t;
  58. int i;
  59. int strobe = gameport_time(gameport, GRIP_STROBE_GPP);
  60. data[0] = 0;
  61. t = strobe;
  62. i = 0;
  63. local_irq_save(flags);
  64. v = gameport_read(gameport) >> shift;
  65. do {
  66. t--;
  67. u = v; v = (gameport_read(gameport) >> shift) & 3;
  68. if (~v & u & 1) {
  69. data[0] |= (v >> 1) << i++;
  70. t = strobe;
  71. }
  72. } while (i < GRIP_LENGTH_GPP && t > 0);
  73. local_irq_restore(flags);
  74. if (i < GRIP_LENGTH_GPP) return -1;
  75. for (i = 0; i < GRIP_LENGTH_GPP && (data[0] & 0xfe4210) ^ 0x7c0000; i++)
  76. data[0] = data[0] >> 1 | (data[0] & 1) << (GRIP_LENGTH_GPP - 1);
  77. return -(i == GRIP_LENGTH_GPP);
  78. }
  79. /*
  80. * grip_xt_read_packet() reads a Gravis Xterminator packet.
  81. */
  82. static int grip_xt_read_packet(struct gameport *gameport, int shift, unsigned int *data)
  83. {
  84. unsigned int i, j, buf, crc;
  85. unsigned char u, v, w;
  86. unsigned long flags;
  87. unsigned int t;
  88. char status;
  89. int strobe = gameport_time(gameport, GRIP_STROBE_XT);
  90. data[0] = data[1] = data[2] = data[3] = 0;
  91. status = buf = i = j = 0;
  92. t = strobe;
  93. local_irq_save(flags);
  94. v = w = (gameport_read(gameport) >> shift) & 3;
  95. do {
  96. t--;
  97. u = (gameport_read(gameport) >> shift) & 3;
  98. if (u ^ v) {
  99. if ((u ^ v) & 1) {
  100. buf = (buf << 1) | (u >> 1);
  101. t = strobe;
  102. i++;
  103. } else
  104. if ((((u ^ v) & (v ^ w)) >> 1) & ~(u | v | w) & 1) {
  105. if (i == 20) {
  106. crc = buf ^ (buf >> 7) ^ (buf >> 14);
  107. if (!((crc ^ (0x25cb9e70 >> ((crc >> 2) & 0x1c))) & 0xf)) {
  108. data[buf >> 18] = buf >> 4;
  109. status |= 1 << (buf >> 18);
  110. }
  111. j++;
  112. }
  113. t = strobe;
  114. buf = 0;
  115. i = 0;
  116. }
  117. w = v;
  118. v = u;
  119. }
  120. } while (status != 0xf && i < GRIP_MAX_BITS_XT && j < GRIP_MAX_CHUNKS_XT && t > 0);
  121. local_irq_restore(flags);
  122. return -(status != 0xf);
  123. }
  124. /*
  125. * grip_timer() repeatedly polls the joysticks and generates events.
  126. */
  127. static void grip_poll(struct gameport *gameport)
  128. {
  129. struct grip *grip = gameport_get_drvdata(gameport);
  130. unsigned int data[GRIP_LENGTH_XT];
  131. struct input_dev *dev;
  132. int i, j;
  133. for (i = 0; i < 2; i++) {
  134. dev = grip->dev[i];
  135. if (!dev)
  136. continue;
  137. grip->reads++;
  138. switch (grip->mode[i]) {
  139. case GRIP_MODE_GPP:
  140. if (grip_gpp_read_packet(grip->gameport, (i << 1) + 4, data)) {
  141. grip->bads++;
  142. break;
  143. }
  144. input_report_abs(dev, ABS_X, ((*data >> 15) & 1) - ((*data >> 16) & 1));
  145. input_report_abs(dev, ABS_Y, ((*data >> 13) & 1) - ((*data >> 12) & 1));
  146. for (j = 0; j < 12; j++)
  147. if (grip_btn_gpp[j])
  148. input_report_key(dev, grip_btn_gpp[j], (*data >> j) & 1);
  149. break;
  150. case GRIP_MODE_BD:
  151. if (grip_xt_read_packet(grip->gameport, (i << 1) + 4, data)) {
  152. grip->bads++;
  153. break;
  154. }
  155. input_report_abs(dev, ABS_X, (data[0] >> 2) & 0x3f);
  156. input_report_abs(dev, ABS_Y, 63 - ((data[0] >> 8) & 0x3f));
  157. input_report_abs(dev, ABS_THROTTLE, (data[2] >> 8) & 0x3f);
  158. input_report_abs(dev, ABS_HAT0X, ((data[2] >> 1) & 1) - ( data[2] & 1));
  159. input_report_abs(dev, ABS_HAT0Y, ((data[2] >> 2) & 1) - ((data[2] >> 3) & 1));
  160. for (j = 0; j < 5; j++)
  161. input_report_key(dev, grip_btn_bd[j], (data[3] >> (j + 4)) & 1);
  162. break;
  163. case GRIP_MODE_XT:
  164. if (grip_xt_read_packet(grip->gameport, (i << 1) + 4, data)) {
  165. grip->bads++;
  166. break;
  167. }
  168. input_report_abs(dev, ABS_X, (data[0] >> 2) & 0x3f);
  169. input_report_abs(dev, ABS_Y, 63 - ((data[0] >> 8) & 0x3f));
  170. input_report_abs(dev, ABS_BRAKE, (data[1] >> 2) & 0x3f);
  171. input_report_abs(dev, ABS_GAS, (data[1] >> 8) & 0x3f);
  172. input_report_abs(dev, ABS_THROTTLE, (data[2] >> 8) & 0x3f);
  173. input_report_abs(dev, ABS_HAT0X, ((data[2] >> 1) & 1) - ( data[2] & 1));
  174. input_report_abs(dev, ABS_HAT0Y, ((data[2] >> 2) & 1) - ((data[2] >> 3) & 1));
  175. input_report_abs(dev, ABS_HAT1X, ((data[2] >> 5) & 1) - ((data[2] >> 4) & 1));
  176. input_report_abs(dev, ABS_HAT1Y, ((data[2] >> 6) & 1) - ((data[2] >> 7) & 1));
  177. for (j = 0; j < 11; j++)
  178. input_report_key(dev, grip_btn_xt[j], (data[3] >> (j + 3)) & 1);
  179. break;
  180. case GRIP_MODE_DC:
  181. if (grip_xt_read_packet(grip->gameport, (i << 1) + 4, data)) {
  182. grip->bads++;
  183. break;
  184. }
  185. input_report_abs(dev, ABS_X, (data[0] >> 2) & 0x3f);
  186. input_report_abs(dev, ABS_Y, (data[0] >> 8) & 0x3f);
  187. input_report_abs(dev, ABS_RX, (data[1] >> 2) & 0x3f);
  188. input_report_abs(dev, ABS_RY, (data[1] >> 8) & 0x3f);
  189. input_report_abs(dev, ABS_THROTTLE, (data[2] >> 8) & 0x3f);
  190. input_report_abs(dev, ABS_HAT0X, ((data[2] >> 1) & 1) - ( data[2] & 1));
  191. input_report_abs(dev, ABS_HAT0Y, ((data[2] >> 2) & 1) - ((data[2] >> 3) & 1));
  192. for (j = 0; j < 9; j++)
  193. input_report_key(dev, grip_btn_dc[j], (data[3] >> (j + 3)) & 1);
  194. break;
  195. }
  196. input_sync(dev);
  197. }
  198. }
  199. static int grip_open(struct input_dev *dev)
  200. {
  201. struct grip *grip = input_get_drvdata(dev);
  202. gameport_start_polling(grip->gameport);
  203. return 0;
  204. }
  205. static void grip_close(struct input_dev *dev)
  206. {
  207. struct grip *grip = input_get_drvdata(dev);
  208. gameport_stop_polling(grip->gameport);
  209. }
  210. static int grip_connect(struct gameport *gameport, struct gameport_driver *drv)
  211. {
  212. struct grip *grip;
  213. struct input_dev *input_dev;
  214. unsigned int data[GRIP_LENGTH_XT];
  215. int i, j, t;
  216. int err;
  217. if (!(grip = kzalloc(sizeof(struct grip), GFP_KERNEL)))
  218. return -ENOMEM;
  219. grip->gameport = gameport;
  220. gameport_set_drvdata(gameport, grip);
  221. err = gameport_open(gameport, drv, GAMEPORT_MODE_RAW);
  222. if (err)
  223. goto fail1;
  224. for (i = 0; i < 2; i++) {
  225. if (!grip_gpp_read_packet(gameport, (i << 1) + 4, data)) {
  226. grip->mode[i] = GRIP_MODE_GPP;
  227. continue;
  228. }
  229. if (!grip_xt_read_packet(gameport, (i << 1) + 4, data)) {
  230. if (!(data[3] & 7)) {
  231. grip->mode[i] = GRIP_MODE_BD;
  232. continue;
  233. }
  234. if (!(data[2] & 0xf0)) {
  235. grip->mode[i] = GRIP_MODE_XT;
  236. continue;
  237. }
  238. grip->mode[i] = GRIP_MODE_DC;
  239. continue;
  240. }
  241. }
  242. if (!grip->mode[0] && !grip->mode[1]) {
  243. err = -ENODEV;
  244. goto fail2;
  245. }
  246. gameport_set_poll_handler(gameport, grip_poll);
  247. gameport_set_poll_interval(gameport, 20);
  248. for (i = 0; i < 2; i++) {
  249. if (!grip->mode[i])
  250. continue;
  251. grip->dev[i] = input_dev = input_allocate_device();
  252. if (!input_dev) {
  253. err = -ENOMEM;
  254. goto fail3;
  255. }
  256. snprintf(grip->phys[i], sizeof(grip->phys[i]),
  257. "%s/input%d", gameport->phys, i);
  258. input_dev->name = grip_name[grip->mode[i]];
  259. input_dev->phys = grip->phys[i];
  260. input_dev->id.bustype = BUS_GAMEPORT;
  261. input_dev->id.vendor = GAMEPORT_ID_VENDOR_GRAVIS;
  262. input_dev->id.product = grip->mode[i];
  263. input_dev->id.version = 0x0100;
  264. input_dev->dev.parent = &gameport->dev;
  265. input_set_drvdata(input_dev, grip);
  266. input_dev->open = grip_open;
  267. input_dev->close = grip_close;
  268. input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
  269. for (j = 0; (t = grip_abs[grip->mode[i]][j]) >= 0; j++) {
  270. if (j < grip_cen[grip->mode[i]])
  271. input_set_abs_params(input_dev, t, 14, 52, 1, 2);
  272. else if (j < grip_anx[grip->mode[i]])
  273. input_set_abs_params(input_dev, t, 3, 57, 1, 0);
  274. else
  275. input_set_abs_params(input_dev, t, -1, 1, 0, 0);
  276. }
  277. for (j = 0; (t = grip_btn[grip->mode[i]][j]) >= 0; j++)
  278. if (t > 0)
  279. set_bit(t, input_dev->keybit);
  280. err = input_register_device(grip->dev[i]);
  281. if (err)
  282. goto fail4;
  283. }
  284. return 0;
  285. fail4: input_free_device(grip->dev[i]);
  286. fail3: while (--i >= 0)
  287. if (grip->dev[i])
  288. input_unregister_device(grip->dev[i]);
  289. fail2: gameport_close(gameport);
  290. fail1: gameport_set_drvdata(gameport, NULL);
  291. kfree(grip);
  292. return err;
  293. }
  294. static void grip_disconnect(struct gameport *gameport)
  295. {
  296. struct grip *grip = gameport_get_drvdata(gameport);
  297. int i;
  298. for (i = 0; i < 2; i++)
  299. if (grip->dev[i])
  300. input_unregister_device(grip->dev[i]);
  301. gameport_close(gameport);
  302. gameport_set_drvdata(gameport, NULL);
  303. kfree(grip);
  304. }
  305. static struct gameport_driver grip_drv = {
  306. .driver = {
  307. .name = "grip",
  308. .owner = THIS_MODULE,
  309. },
  310. .description = DRIVER_DESC,
  311. .connect = grip_connect,
  312. .disconnect = grip_disconnect,
  313. };
  314. module_gameport_driver(grip_drv);