magellan.c 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Copyright (c) 1999-2001 Vojtech Pavlik
  4. */
  5. /*
  6. * Magellan and Space Mouse 6dof controller driver for Linux
  7. */
  8. /*
  9. */
  10. #include <linux/kernel.h>
  11. #include <linux/module.h>
  12. #include <linux/slab.h>
  13. #include <linux/input.h>
  14. #include <linux/serio.h>
  15. #define DRIVER_DESC "Magellan and SpaceMouse 6dof controller driver"
  16. MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  17. MODULE_DESCRIPTION(DRIVER_DESC);
  18. MODULE_LICENSE("GPL");
  19. /*
  20. * Definitions & global arrays.
  21. */
  22. #define MAGELLAN_MAX_LENGTH 32
  23. static int magellan_buttons[] = { BTN_0, BTN_1, BTN_2, BTN_3, BTN_4, BTN_5, BTN_6, BTN_7, BTN_8 };
  24. static int magellan_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };
  25. /*
  26. * Per-Magellan data.
  27. */
  28. struct magellan {
  29. struct input_dev *dev;
  30. int idx;
  31. unsigned char data[MAGELLAN_MAX_LENGTH];
  32. char phys[32];
  33. };
  34. /*
  35. * magellan_crunch_nibbles() verifies that the bytes sent from the Magellan
  36. * have correct upper nibbles for the lower ones, if not, the packet will
  37. * be thrown away. It also strips these upper halves to simplify further
  38. * processing.
  39. */
  40. static int magellan_crunch_nibbles(unsigned char *data, int count)
  41. {
  42. static unsigned char nibbles[16] = "0AB3D56GH9:K<MN?";
  43. do {
  44. if (data[count] == nibbles[data[count] & 0xf])
  45. data[count] = data[count] & 0xf;
  46. else
  47. return -1;
  48. } while (--count);
  49. return 0;
  50. }
  51. static void magellan_process_packet(struct magellan* magellan)
  52. {
  53. struct input_dev *dev = magellan->dev;
  54. unsigned char *data = magellan->data;
  55. int i, t;
  56. if (!magellan->idx) return;
  57. switch (magellan->data[0]) {
  58. case 'd': /* Axis data */
  59. if (magellan->idx != 25) return;
  60. if (magellan_crunch_nibbles(data, 24)) return;
  61. for (i = 0; i < 6; i++)
  62. input_report_abs(dev, magellan_axes[i],
  63. (data[(i << 2) + 1] << 12 | data[(i << 2) + 2] << 8 |
  64. data[(i << 2) + 3] << 4 | data[(i << 2) + 4]) - 32768);
  65. break;
  66. case 'k': /* Button data */
  67. if (magellan->idx != 4) return;
  68. if (magellan_crunch_nibbles(data, 3)) return;
  69. t = (data[1] << 1) | (data[2] << 5) | data[3];
  70. for (i = 0; i < 9; i++) input_report_key(dev, magellan_buttons[i], (t >> i) & 1);
  71. break;
  72. }
  73. input_sync(dev);
  74. }
  75. static irqreturn_t magellan_interrupt(struct serio *serio,
  76. unsigned char data, unsigned int flags)
  77. {
  78. struct magellan* magellan = serio_get_drvdata(serio);
  79. if (data == '\r') {
  80. magellan_process_packet(magellan);
  81. magellan->idx = 0;
  82. } else {
  83. if (magellan->idx < MAGELLAN_MAX_LENGTH)
  84. magellan->data[magellan->idx++] = data;
  85. }
  86. return IRQ_HANDLED;
  87. }
  88. /*
  89. * magellan_disconnect() is the opposite of magellan_connect()
  90. */
  91. static void magellan_disconnect(struct serio *serio)
  92. {
  93. struct magellan* magellan = serio_get_drvdata(serio);
  94. serio_close(serio);
  95. serio_set_drvdata(serio, NULL);
  96. input_unregister_device(magellan->dev);
  97. kfree(magellan);
  98. }
  99. /*
  100. * magellan_connect() is the routine that is called when someone adds a
  101. * new serio device that supports Magellan protocol and registers it as
  102. * an input device.
  103. */
  104. static int magellan_connect(struct serio *serio, struct serio_driver *drv)
  105. {
  106. struct magellan *magellan;
  107. struct input_dev *input_dev;
  108. int err = -ENOMEM;
  109. int i;
  110. magellan = kzalloc(sizeof(struct magellan), GFP_KERNEL);
  111. input_dev = input_allocate_device();
  112. if (!magellan || !input_dev)
  113. goto fail1;
  114. magellan->dev = input_dev;
  115. snprintf(magellan->phys, sizeof(magellan->phys), "%s/input0", serio->phys);
  116. input_dev->name = "LogiCad3D Magellan / SpaceMouse";
  117. input_dev->phys = magellan->phys;
  118. input_dev->id.bustype = BUS_RS232;
  119. input_dev->id.vendor = SERIO_MAGELLAN;
  120. input_dev->id.product = 0x0001;
  121. input_dev->id.version = 0x0100;
  122. input_dev->dev.parent = &serio->dev;
  123. input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
  124. for (i = 0; i < 9; i++)
  125. set_bit(magellan_buttons[i], input_dev->keybit);
  126. for (i = 0; i < 6; i++)
  127. input_set_abs_params(input_dev, magellan_axes[i], -360, 360, 0, 0);
  128. serio_set_drvdata(serio, magellan);
  129. err = serio_open(serio, drv);
  130. if (err)
  131. goto fail2;
  132. err = input_register_device(magellan->dev);
  133. if (err)
  134. goto fail3;
  135. return 0;
  136. fail3: serio_close(serio);
  137. fail2: serio_set_drvdata(serio, NULL);
  138. fail1: input_free_device(input_dev);
  139. kfree(magellan);
  140. return err;
  141. }
  142. /*
  143. * The serio driver structure.
  144. */
  145. static const struct serio_device_id magellan_serio_ids[] = {
  146. {
  147. .type = SERIO_RS232,
  148. .proto = SERIO_MAGELLAN,
  149. .id = SERIO_ANY,
  150. .extra = SERIO_ANY,
  151. },
  152. { 0 }
  153. };
  154. MODULE_DEVICE_TABLE(serio, magellan_serio_ids);
  155. static struct serio_driver magellan_drv = {
  156. .driver = {
  157. .name = "magellan",
  158. },
  159. .description = DRIVER_DESC,
  160. .id_table = magellan_serio_ids,
  161. .interrupt = magellan_interrupt,
  162. .connect = magellan_connect,
  163. .disconnect = magellan_disconnect,
  164. };
  165. module_serio_driver(magellan_drv);