logo

qmk_firmware

custom branch of QMK firmware git clone https://anongit.hacktivis.me/git/qmk_firmware.git

pointing_device.h (5702B)

    

  1. /*
  2. Copyright 2017 Joshua Broekhuijsen <snipeye+qmk@gmail.com>
  4. This program is free software: you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation, either version 2 of the License, or
  7. (at your option) any later version.
  9. This program is distributed in the hope that it will be useful,
  10. but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12. GNU General Public License for more details.
  14. You should have received a copy of the GNU General Public License
  15. along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16. */
  18. #pragma once
  20. #include <stdbool.h>
  21. #include <stdint.h>
  22. #include "host.h"
  23. #include "report.h"
  25. typedef struct {
  26.     void (*init)(void);
  27.     report_mouse_t (*get_report)(report_mouse_t mouse_report);
  28.     void (*set_cpi)(uint16_t);
  29.     uint16_t (*get_cpi)(void);
  30. } pointing_device_driver_t;
  32. #ifdef POINTING_DEVICE_AUTO_MOUSE_ENABLE
  33. #    include "pointing_device_auto_mouse.h"
  34. #endif
  36. #if defined(POINTING_DEVICE_DRIVER_adns5050)
  37. #    include "drivers/sensors/adns5050.h"
  38. #    define POINTING_DEVICE_MOTION_PIN_ACTIVE_LOW
  39. #elif defined(POINTING_DEVICE_DRIVER_pmw3320)
  40. #    include "drivers/sensors/pmw3320.h"
  41. #    define POINTING_DEVICE_MOTION_PIN_ACTIVE_LOW
  42. #elif defined(POINTING_DEVICE_DRIVER_adns9800)
  43. #    include "spi_master.h"
  44. #    include "drivers/sensors/adns9800.h"
  45. #    define POINTING_DEVICE_MOTION_PIN_ACTIVE_LOW
  46. #elif defined(POINTING_DEVICE_DRIVER_analog_joystick)
  47. #    include "analog.h"
  48. #    include "drivers/sensors/analog_joystick.h"
  49. #    define POINTING_DEVICE_MOTION_PIN_ACTIVE_LOW
  50. #elif defined(POINTING_DEVICE_DRIVER_azoteq_iqs5xx)
  51. #    include "i2c_master.h"
  52. #    include "drivers/sensors/azoteq_iqs5xx.h"
  53. #elif defined(POINTING_DEVICE_DRIVER_cirque_pinnacle_i2c) || defined(POINTING_DEVICE_DRIVER_cirque_pinnacle_spi)
  54. #    include "drivers/sensors/cirque_pinnacle.h"
  55. #    include "pointing_device_gestures.h"
  56. #elif defined(POINTING_DEVICE_DRIVER_paw3204)
  57. #    include "drivers/sensors/paw3204.h"
  58. #    define POINTING_DEVICE_MOTION_PIN_ACTIVE_LOW
  59. #elif defined(POINTING_DEVICE_DRIVER_pimoroni_trackball)
  60. #    include "i2c_master.h"
  61. #    include "drivers/sensors/pimoroni_trackball.h"
  62. // support for legacy pimoroni defines
  63. #    ifdef PIMORONI_TRACKBALL_INVERT_X
  64. #        define POINTING_DEVICE_INVERT_X
  65. #    endif
  66. #    ifdef PIMORONI_TRACKBALL_INVERT_Y
  67. #        define POINTING_DEVICE_INVERT_Y
  68. #    endif
  69. #    ifdef PIMORONI_TRACKBALL_ROTATE
  70. #        define POINTING_DEVICE_ROTATION_90
  71. #    endif
  72. #    define POINTING_DEVICE_MOTION_PIN_ACTIVE_LOW
  73. #elif defined(POINTING_DEVICE_DRIVER_pmw3360) || defined(POINTING_DEVICE_DRIVER_pmw3389)
  74. #    include "spi_master.h"
  75. #    include "drivers/sensors/pmw33xx_common.h"
  76. #    define POINTING_DEVICE_MOTION_PIN_ACTIVE_LOW
  77. #else
  78. void           pointing_device_driver_init(void);
  79. report_mouse_t pointing_device_driver_get_report(report_mouse_t mouse_report);
  80. uint16_t       pointing_device_driver_get_cpi(void);
  81. void           pointing_device_driver_set_cpi(uint16_t cpi);
  82. #endif
  84. typedef enum {
  85.     POINTING_DEVICE_BUTTON1,
  86.     POINTING_DEVICE_BUTTON2,
  87.     POINTING_DEVICE_BUTTON3,
  88.     POINTING_DEVICE_BUTTON4,
  89.     POINTING_DEVICE_BUTTON5,
  90.     POINTING_DEVICE_BUTTON6,
  91.     POINTING_DEVICE_BUTTON7,
  92.     POINTING_DEVICE_BUTTON8,
  93. } pointing_device_buttons_t;
  95. #ifdef MOUSE_EXTENDED_REPORT
  96. typedef int32_t xy_clamp_range_t;
  97. #else
  98. typedef int16_t xy_clamp_range_t;
  99. #endif
  101. #ifdef WHEEL_EXTENDED_REPORT
  102. typedef int32_t hv_clamp_range_t;
  103. #else
  104. typedef int16_t hv_clamp_range_t;
  105. #endif
  107. #define CONSTRAIN_HID(amt) ((amt) < INT8_MIN ? INT8_MIN : ((amt) > INT8_MAX ? INT8_MAX : (amt)))
  108. #define CONSTRAIN_HID_XY(amt) ((amt) < MOUSE_REPORT_XY_MIN ? MOUSE_REPORT_XY_MIN : ((amt) > MOUSE_REPORT_XY_MAX ? MOUSE_REPORT_XY_MAX : (amt)))
  110. void           pointing_device_init(void);
  111. bool           pointing_device_task(void);
  112. bool           pointing_device_send(void);
  113. report_mouse_t pointing_device_get_report(void);
  114. void           pointing_device_set_report(report_mouse_t mouse_report);
  115. uint16_t       pointing_device_get_cpi(void);
  116. void           pointing_device_set_cpi(uint16_t cpi);
  118. void           pointing_device_init_kb(void);
  119. void           pointing_device_init_user(void);
  120. report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report);
  121. report_mouse_t pointing_device_task_user(report_mouse_t mouse_report);
  122. uint8_t        pointing_device_handle_buttons(uint8_t buttons, bool pressed, pointing_device_buttons_t button);
  123. report_mouse_t pointing_device_adjust_by_defines(report_mouse_t mouse_report);
  124. void           pointing_device_keycode_handler(uint16_t keycode, bool pressed);
  126. #ifdef POINTING_DEVICE_HIRES_SCROLL_ENABLE
  127. uint16_t pointing_device_get_hires_scroll_resolution(void);
  128. #endif
  130. #if defined(SPLIT_POINTING_ENABLE)
  131. void     pointing_device_set_shared_report(report_mouse_t report);
  132. uint16_t pointing_device_get_shared_cpi(void);
  133. #    if !defined(POINTING_DEVICE_TASK_THROTTLE_MS)
  134. #        define POINTING_DEVICE_TASK_THROTTLE_MS 1
  135. #    endif
  136. #    if defined(POINTING_DEVICE_COMBINED)
  137. void           pointing_device_set_cpi_on_side(bool left, uint16_t cpi);
  138. report_mouse_t pointing_device_combine_reports(report_mouse_t left_report, report_mouse_t right_report);
  139. report_mouse_t pointing_device_task_combined_kb(report_mouse_t left_report, report_mouse_t right_report);
  140. report_mouse_t pointing_device_task_combined_user(report_mouse_t left_report, report_mouse_t right_report);
  141. report_mouse_t pointing_device_adjust_by_defines_right(report_mouse_t mouse_report);
  142. #    endif // defined(POINTING_DEVICE_COMBINED)
  143. #endif     // defined(SPLIT_POINTING_ENABLE)