ps2_mouse.c 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. /*
  2. Copyright 2011,2013 Jun Wako <wakojun@gmail.com>
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 2 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. */
  14. #include <stdbool.h>
  15. #include <avr/io.h>
  16. #include <util/delay.h>
  17. #include "ps2_mouse.h"
  18. #include "host.h"
  19. #include "timer.h"
  20. #include "print.h"
  21. #include "report.h"
  22. #include "debug.h"
  23. #include "ps2.h"
  24. /* ============================= MACROS ============================ */
  25. static report_mouse_t mouse_report = {};
  26. static inline void ps2_mouse_print_report(report_mouse_t *mouse_report);
  27. static inline void ps2_mouse_convert_report_to_hid(report_mouse_t *mouse_report);
  28. static inline void ps2_mouse_clear_report(report_mouse_t *mouse_report);
  29. static inline void ps2_mouse_enable_scrolling(void);
  30. static inline void ps2_mouse_scroll_button_task(report_mouse_t *mouse_report);
  31. /* ============================= IMPLEMENTATION ============================ */
  32. /* supports only 3 button mouse at this time */
  33. void ps2_mouse_init(void) {
  34. ps2_host_init();
  35. _delay_ms(PS2_MOUSE_INIT_DELAY); // wait for powering up
  36. PS2_MOUSE_SEND(PS2_MOUSE_RESET, "ps2_mouse_init: sending reset");
  37. PS2_MOUSE_RECEIVE("ps2_mouse_init: read BAT");
  38. PS2_MOUSE_RECEIVE("ps2_mouse_init: read DevID");
  39. #ifdef PS2_MOUSE_USE_REMOTE_MODE
  40. ps2_mouse_set_remote_mode();
  41. #else
  42. ps2_mouse_enable_data_reporting();
  43. #endif
  44. #ifdef PS2_MOUSE_ENABLE_SCROLLING
  45. ps2_mouse_enable_scrolling();
  46. #endif
  47. #ifdef PS2_MOUSE_USE_2_1_SCALING
  48. ps2_mouse_set_scaling_2_1();
  49. #endif
  50. ps2_mouse_init_user();
  51. }
  52. __attribute__((weak)) void ps2_mouse_init_user(void) {}
  53. void ps2_mouse_task(void) {
  54. static uint8_t buttons_prev = 0;
  55. extern int tp_buttons;
  56. /* receives packet from mouse */
  57. uint8_t rcv;
  58. rcv = ps2_host_send(PS2_MOUSE_READ_DATA);
  59. if (rcv == PS2_ACK) {
  60. mouse_report.buttons = ps2_host_recv_response() | tp_buttons;
  61. mouse_report.x = ps2_host_recv_response() * PS2_MOUSE_X_MULTIPLIER;
  62. mouse_report.y = ps2_host_recv_response() * PS2_MOUSE_Y_MULTIPLIER;
  63. #ifdef PS2_MOUSE_ENABLE_SCROLLING
  64. mouse_report.v = -(ps2_host_recv_response() & PS2_MOUSE_SCROLL_MASK) * PS2_MOUSE_V_MULTIPLIER;
  65. #endif
  66. } else {
  67. if (debug_mouse) print("ps2_mouse: fail to get mouse packet\n");
  68. return;
  69. }
  70. /* if mouse moves or buttons state changes */
  71. if (mouse_report.x || mouse_report.y || mouse_report.v || ((mouse_report.buttons ^ buttons_prev) & PS2_MOUSE_BTN_MASK)) {
  72. #ifdef PS2_MOUSE_DEBUG_RAW
  73. // Used to debug raw ps2 bytes from mouse
  74. ps2_mouse_print_report(&mouse_report);
  75. #endif
  76. buttons_prev = mouse_report.buttons;
  77. ps2_mouse_convert_report_to_hid(&mouse_report);
  78. #if PS2_MOUSE_SCROLL_BTN_MASK
  79. ps2_mouse_scroll_button_task(&mouse_report);
  80. #endif
  81. #ifdef PS2_MOUSE_DEBUG_HID
  82. // Used to debug the bytes sent to the host
  83. ps2_mouse_print_report(&mouse_report);
  84. #endif
  85. host_mouse_send(&mouse_report);
  86. }
  87. ps2_mouse_clear_report(&mouse_report);
  88. }
  89. void ps2_mouse_disable_data_reporting(void) { PS2_MOUSE_SEND(PS2_MOUSE_DISABLE_DATA_REPORTING, "ps2 mouse disable data reporting"); }
  90. void ps2_mouse_enable_data_reporting(void) { PS2_MOUSE_SEND(PS2_MOUSE_ENABLE_DATA_REPORTING, "ps2 mouse enable data reporting"); }
  91. void ps2_mouse_set_remote_mode(void) {
  92. PS2_MOUSE_SEND_SAFE(PS2_MOUSE_SET_REMOTE_MODE, "ps2 mouse set remote mode");
  93. ps2_mouse_mode = PS2_MOUSE_REMOTE_MODE;
  94. }
  95. void ps2_mouse_set_stream_mode(void) {
  96. PS2_MOUSE_SEND_SAFE(PS2_MOUSE_SET_STREAM_MODE, "ps2 mouse set stream mode");
  97. ps2_mouse_mode = PS2_MOUSE_STREAM_MODE;
  98. }
  99. void ps2_mouse_set_scaling_2_1(void) { PS2_MOUSE_SEND_SAFE(PS2_MOUSE_SET_SCALING_2_1, "ps2 mouse set scaling 2:1"); }
  100. void ps2_mouse_set_scaling_1_1(void) { PS2_MOUSE_SEND_SAFE(PS2_MOUSE_SET_SCALING_1_1, "ps2 mouse set scaling 1:1"); }
  101. void ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution) { PS2_MOUSE_SET_SAFE(PS2_MOUSE_SET_RESOLUTION, resolution, "ps2 mouse set resolution"); }
  102. void ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate) { PS2_MOUSE_SET_SAFE(PS2_MOUSE_SET_SAMPLE_RATE, sample_rate, "ps2 mouse set sample rate"); }
  103. /* ============================= HELPERS ============================ */
  104. #define X_IS_NEG (mouse_report->buttons & (1 << PS2_MOUSE_X_SIGN))
  105. #define Y_IS_NEG (mouse_report->buttons & (1 << PS2_MOUSE_Y_SIGN))
  106. #define X_IS_OVF (mouse_report->buttons & (1 << PS2_MOUSE_X_OVFLW))
  107. #define Y_IS_OVF (mouse_report->buttons & (1 << PS2_MOUSE_Y_OVFLW))
  108. static inline void ps2_mouse_convert_report_to_hid(report_mouse_t *mouse_report) {
  109. // PS/2 mouse data is '9-bit integer'(-256 to 255) which is comprised of sign-bit and 8-bit value.
  110. // bit: 8 7 ... 0
  111. // sign \8-bit/
  112. //
  113. // Meanwhile USB HID mouse indicates 8bit data(-127 to 127), note that -128 is not used.
  114. //
  115. // This converts PS/2 data into HID value. Use only -127-127 out of PS/2 9-bit.
  116. mouse_report->x = X_IS_NEG ? ((!X_IS_OVF && -127 <= mouse_report->x && mouse_report->x <= -1) ? mouse_report->x : -127) : ((!X_IS_OVF && 0 <= mouse_report->x && mouse_report->x <= 127) ? mouse_report->x : 127);
  117. mouse_report->y = Y_IS_NEG ? ((!Y_IS_OVF && -127 <= mouse_report->y && mouse_report->y <= -1) ? mouse_report->y : -127) : ((!Y_IS_OVF && 0 <= mouse_report->y && mouse_report->y <= 127) ? mouse_report->y : 127);
  118. // remove sign and overflow flags
  119. mouse_report->buttons &= PS2_MOUSE_BTN_MASK;
  120. #ifdef PS2_MOUSE_INVERT_X
  121. mouse_report->x = -mouse_report->x;
  122. #endif
  123. #ifndef PS2_MOUSE_INVERT_Y // NOTE if not!
  124. // invert coordinate of y to conform to USB HID mouse
  125. mouse_report->y = -mouse_report->y;
  126. #endif
  127. }
  128. static inline void ps2_mouse_clear_report(report_mouse_t *mouse_report) {
  129. mouse_report->x = 0;
  130. mouse_report->y = 0;
  131. mouse_report->v = 0;
  132. mouse_report->h = 0;
  133. mouse_report->buttons = 0;
  134. }
  135. static inline void ps2_mouse_print_report(report_mouse_t *mouse_report) {
  136. if (!debug_mouse) return;
  137. print("ps2_mouse: [");
  138. phex(mouse_report->buttons);
  139. print("|");
  140. print_hex8((uint8_t)mouse_report->x);
  141. print(" ");
  142. print_hex8((uint8_t)mouse_report->y);
  143. print(" ");
  144. print_hex8((uint8_t)mouse_report->v);
  145. print(" ");
  146. print_hex8((uint8_t)mouse_report->h);
  147. print("]\n");
  148. }
  149. static inline void ps2_mouse_enable_scrolling(void) {
  150. PS2_MOUSE_SEND(PS2_MOUSE_SET_SAMPLE_RATE, "Initiaing scroll wheel enable: Set sample rate");
  151. PS2_MOUSE_SEND(200, "200");
  152. PS2_MOUSE_SEND(PS2_MOUSE_SET_SAMPLE_RATE, "Set sample rate");
  153. PS2_MOUSE_SEND(100, "100");
  154. PS2_MOUSE_SEND(PS2_MOUSE_SET_SAMPLE_RATE, "Set sample rate");
  155. PS2_MOUSE_SEND(80, "80");
  156. PS2_MOUSE_SEND(PS2_MOUSE_GET_DEVICE_ID, "Finished enabling scroll wheel");
  157. _delay_ms(20);
  158. }
  159. #define PRESS_SCROLL_BUTTONS mouse_report->buttons |= (PS2_MOUSE_SCROLL_BTN_MASK)
  160. #define RELEASE_SCROLL_BUTTONS mouse_report->buttons &= ~(PS2_MOUSE_SCROLL_BTN_MASK)
  161. static inline void ps2_mouse_scroll_button_task(report_mouse_t *mouse_report) {
  162. static enum {
  163. SCROLL_NONE,
  164. SCROLL_BTN,
  165. SCROLL_SENT,
  166. } scroll_state = SCROLL_NONE;
  167. static uint16_t scroll_button_time = 0;
  168. if (PS2_MOUSE_SCROLL_BTN_MASK == (mouse_report->buttons & (PS2_MOUSE_SCROLL_BTN_MASK))) {
  169. // All scroll buttons are pressed
  170. if (scroll_state == SCROLL_NONE) {
  171. scroll_button_time = timer_read();
  172. scroll_state = SCROLL_BTN;
  173. }
  174. // If the mouse has moved, update the report to scroll instead of move the mouse
  175. if (mouse_report->x || mouse_report->y) {
  176. scroll_state = SCROLL_SENT;
  177. mouse_report->v = -mouse_report->y / (PS2_MOUSE_SCROLL_DIVISOR_V);
  178. mouse_report->h = mouse_report->x / (PS2_MOUSE_SCROLL_DIVISOR_H);
  179. mouse_report->x = 0;
  180. mouse_report->y = 0;
  181. #ifdef PS2_MOUSE_INVERT_H
  182. mouse_report->h = -mouse_report->h;
  183. #endif
  184. #ifdef PS2_MOUSE_INVERT_V
  185. mouse_report->v = -mouse_report->v;
  186. #endif
  187. }
  188. } else if (0 == (PS2_MOUSE_SCROLL_BTN_MASK & mouse_report->buttons)) {
  189. // None of the scroll buttons are pressed
  190. #if PS2_MOUSE_SCROLL_BTN_SEND
  191. if (scroll_state == SCROLL_BTN && timer_elapsed(scroll_button_time) < PS2_MOUSE_SCROLL_BTN_SEND) {
  192. PRESS_SCROLL_BUTTONS;
  193. host_mouse_send(mouse_report);
  194. _delay_ms(100);
  195. RELEASE_SCROLL_BUTTONS;
  196. }
  197. #endif
  198. scroll_state = SCROLL_NONE;
  199. }
  200. RELEASE_SCROLL_BUTTONS;
  201. }