spaceorb.c 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. // SPDX-License-Identifier: GPL-2.0-or-later
  2. /*
  3. * Copyright (c) 1999-2001 Vojtech Pavlik
  4. *
  5. * Based on the work of:
  6. * David Thompson
  7. */
  8. /*
  9. * SpaceTec SpaceOrb 360 and Avenger 6dof controller driver for Linux
  10. */
  11. /*
  12. */
  13. #include <linux/kernel.h>
  14. #include <linux/slab.h>
  15. #include <linux/module.h>
  16. #include <linux/input.h>
  17. #include <linux/serio.h>
  18. #define DRIVER_DESC "SpaceTec SpaceOrb 360 and Avenger 6dof controller driver"
  19. MODULE_AUTHOR("Vojtech Pavlik <vojtech@ucw.cz>");
  20. MODULE_DESCRIPTION(DRIVER_DESC);
  21. MODULE_LICENSE("GPL");
  22. /*
  23. * Constants.
  24. */
  25. #define SPACEORB_MAX_LENGTH 64
  26. static int spaceorb_buttons[] = { BTN_TL, BTN_TR, BTN_Y, BTN_X, BTN_B, BTN_A };
  27. static int spaceorb_axes[] = { ABS_X, ABS_Y, ABS_Z, ABS_RX, ABS_RY, ABS_RZ };
  28. /*
  29. * Per-Orb data.
  30. */
  31. struct spaceorb {
  32. struct input_dev *dev;
  33. int idx;
  34. unsigned char data[SPACEORB_MAX_LENGTH];
  35. char phys[32];
  36. };
  37. static unsigned char spaceorb_xor[] = "SpaceWare";
  38. static unsigned char *spaceorb_errors[] = { "EEPROM storing 0 failed", "Receive queue overflow", "Transmit queue timeout",
  39. "Bad packet", "Power brown-out", "EEPROM checksum error", "Hardware fault" };
  40. /*
  41. * spaceorb_process_packet() decodes packets the driver receives from the
  42. * SpaceOrb.
  43. */
  44. static void spaceorb_process_packet(struct spaceorb *spaceorb)
  45. {
  46. struct input_dev *dev = spaceorb->dev;
  47. unsigned char *data = spaceorb->data;
  48. unsigned char c = 0;
  49. int axes[6];
  50. int i;
  51. if (spaceorb->idx < 2) return;
  52. for (i = 0; i < spaceorb->idx; i++) c ^= data[i];
  53. if (c) return;
  54. switch (data[0]) {
  55. case 'R': /* Reset packet */
  56. spaceorb->data[spaceorb->idx - 1] = 0;
  57. for (i = 1; i < spaceorb->idx && spaceorb->data[i] == ' '; i++);
  58. printk(KERN_INFO "input: %s [%s] is %s\n",
  59. dev->name, spaceorb->data + i, spaceorb->phys);
  60. break;
  61. case 'D': /* Ball + button data */
  62. if (spaceorb->idx != 12) return;
  63. for (i = 0; i < 9; i++) spaceorb->data[i+2] ^= spaceorb_xor[i];
  64. axes[0] = ( data[2] << 3) | (data[ 3] >> 4);
  65. axes[1] = ((data[3] & 0x0f) << 6) | (data[ 4] >> 1);
  66. axes[2] = ((data[4] & 0x01) << 9) | (data[ 5] << 2) | (data[4] >> 5);
  67. axes[3] = ((data[6] & 0x1f) << 5) | (data[ 7] >> 2);
  68. axes[4] = ((data[7] & 0x03) << 8) | (data[ 8] << 1) | (data[7] >> 6);
  69. axes[5] = ((data[9] & 0x3f) << 4) | (data[10] >> 3);
  70. for (i = 0; i < 6; i++)
  71. input_report_abs(dev, spaceorb_axes[i], axes[i] - ((axes[i] & 0x200) ? 1024 : 0));
  72. for (i = 0; i < 6; i++)
  73. input_report_key(dev, spaceorb_buttons[i], (data[1] >> i) & 1);
  74. break;
  75. case 'K': /* Button data */
  76. if (spaceorb->idx != 5) return;
  77. for (i = 0; i < 6; i++)
  78. input_report_key(dev, spaceorb_buttons[i], (data[2] >> i) & 1);
  79. break;
  80. case 'E': /* Error packet */
  81. if (spaceorb->idx != 4) return;
  82. printk(KERN_ERR "spaceorb: Device error. [ ");
  83. for (i = 0; i < 7; i++) if (data[1] & (1 << i)) printk("%s ", spaceorb_errors[i]);
  84. printk("]\n");
  85. break;
  86. }
  87. input_sync(dev);
  88. }
  89. static irqreturn_t spaceorb_interrupt(struct serio *serio,
  90. unsigned char data, unsigned int flags)
  91. {
  92. struct spaceorb* spaceorb = serio_get_drvdata(serio);
  93. if (~data & 0x80) {
  94. if (spaceorb->idx) spaceorb_process_packet(spaceorb);
  95. spaceorb->idx = 0;
  96. }
  97. if (spaceorb->idx < SPACEORB_MAX_LENGTH)
  98. spaceorb->data[spaceorb->idx++] = data & 0x7f;
  99. return IRQ_HANDLED;
  100. }
  101. /*
  102. * spaceorb_disconnect() is the opposite of spaceorb_connect()
  103. */
  104. static void spaceorb_disconnect(struct serio *serio)
  105. {
  106. struct spaceorb* spaceorb = serio_get_drvdata(serio);
  107. serio_close(serio);
  108. serio_set_drvdata(serio, NULL);
  109. input_unregister_device(spaceorb->dev);
  110. kfree(spaceorb);
  111. }
  112. /*
  113. * spaceorb_connect() is the routine that is called when someone adds a
  114. * new serio device that supports SpaceOrb/Avenger protocol and registers
  115. * it as an input device.
  116. */
  117. static int spaceorb_connect(struct serio *serio, struct serio_driver *drv)
  118. {
  119. struct spaceorb *spaceorb;
  120. struct input_dev *input_dev;
  121. int err = -ENOMEM;
  122. int i;
  123. spaceorb = kzalloc(sizeof(struct spaceorb), GFP_KERNEL);
  124. input_dev = input_allocate_device();
  125. if (!spaceorb || !input_dev)
  126. goto fail1;
  127. spaceorb->dev = input_dev;
  128. snprintf(spaceorb->phys, sizeof(spaceorb->phys), "%s/input0", serio->phys);
  129. input_dev->name = "SpaceTec SpaceOrb 360 / Avenger";
  130. input_dev->phys = spaceorb->phys;
  131. input_dev->id.bustype = BUS_RS232;
  132. input_dev->id.vendor = SERIO_SPACEORB;
  133. input_dev->id.product = 0x0001;
  134. input_dev->id.version = 0x0100;
  135. input_dev->dev.parent = &serio->dev;
  136. input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_ABS);
  137. for (i = 0; i < 6; i++)
  138. set_bit(spaceorb_buttons[i], input_dev->keybit);
  139. for (i = 0; i < 6; i++)
  140. input_set_abs_params(input_dev, spaceorb_axes[i], -508, 508, 0, 0);
  141. serio_set_drvdata(serio, spaceorb);
  142. err = serio_open(serio, drv);
  143. if (err)
  144. goto fail2;
  145. err = input_register_device(spaceorb->dev);
  146. if (err)
  147. goto fail3;
  148. return 0;
  149. fail3: serio_close(serio);
  150. fail2: serio_set_drvdata(serio, NULL);
  151. fail1: input_free_device(input_dev);
  152. kfree(spaceorb);
  153. return err;
  154. }
  155. /*
  156. * The serio driver structure.
  157. */
  158. static const struct serio_device_id spaceorb_serio_ids[] = {
  159. {
  160. .type = SERIO_RS232,
  161. .proto = SERIO_SPACEORB,
  162. .id = SERIO_ANY,
  163. .extra = SERIO_ANY,
  164. },
  165. { 0 }
  166. };
  167. MODULE_DEVICE_TABLE(serio, spaceorb_serio_ids);
  168. static struct serio_driver spaceorb_drv = {
  169. .driver = {
  170. .name = "spaceorb",
  171. },
  172. .description = DRIVER_DESC,
  173. .id_table = spaceorb_serio_ids,
  174. .interrupt = spaceorb_interrupt,
  175. .connect = spaceorb_connect,
  176. .disconnect = spaceorb_disconnect,
  177. };
  178. module_serio_driver(spaceorb_drv);