cypress_ps2.h 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. #ifndef _CYPRESS_PS2_H
  3. #define _CYPRESS_PS2_H
  4. #include "psmouse.h"
  5. #define CMD_BITS_MASK 0x03
  6. #define COMPOSIT(x, s) (((x) & CMD_BITS_MASK) << (s))
  7. #define ENCODE_CMD(aa, bb, cc, dd) \
  8. (COMPOSIT((aa), 6) | COMPOSIT((bb), 4) | COMPOSIT((cc), 2) | COMPOSIT((dd), 0))
  9. #define CYTP_CMD_ABS_NO_PRESSURE_MODE ENCODE_CMD(0, 1, 0, 0)
  10. #define CYTP_CMD_ABS_WITH_PRESSURE_MODE ENCODE_CMD(0, 1, 0, 1)
  11. #define CYTP_CMD_SMBUS_MODE ENCODE_CMD(0, 1, 1, 0)
  12. #define CYTP_CMD_STANDARD_MODE ENCODE_CMD(0, 2, 0, 0) /* not implemented yet. */
  13. #define CYTP_CMD_CYPRESS_REL_MODE ENCODE_CMD(1, 1, 1, 1) /* not implemented yet. */
  14. #define CYTP_CMD_READ_CYPRESS_ID ENCODE_CMD(0, 0, 0, 0)
  15. #define CYTP_CMD_READ_TP_METRICS ENCODE_CMD(0, 0, 0, 1)
  16. #define CYTP_CMD_SET_HSCROLL_WIDTH(w) ENCODE_CMD(1, 1, 0, (w))
  17. #define CYTP_CMD_SET_HSCROLL_MASK ENCODE_CMD(1, 1, 0, 0)
  18. #define CYTP_CMD_SET_VSCROLL_WIDTH(w) ENCODE_CMD(1, 2, 0, (w))
  19. #define CYTP_CMD_SET_VSCROLL_MASK ENCODE_CMD(1, 2, 0, 0)
  20. #define CYTP_CMD_SET_PALM_GEOMETRY(e) ENCODE_CMD(1, 2, 1, (e))
  21. #define CYTP_CMD_PALM_GEMMETRY_MASK ENCODE_CMD(1, 2, 1, 0)
  22. #define CYTP_CMD_SET_PALM_SENSITIVITY(s) ENCODE_CMD(1, 2, 2, (s))
  23. #define CYTP_CMD_PALM_SENSITIVITY_MASK ENCODE_CMD(1, 2, 2, 0)
  24. #define CYTP_CMD_SET_MOUSE_SENSITIVITY(s) ENCODE_CMD(1, 3, ((s) >> 2), (s))
  25. #define CYTP_CMD_MOUSE_SENSITIVITY_MASK ENCODE_CMD(1, 3, 0, 0)
  26. #define CYTP_CMD_REQUEST_BASELINE_STATUS ENCODE_CMD(2, 0, 0, 1)
  27. #define CYTP_CMD_REQUEST_RECALIBRATION ENCODE_CMD(2, 0, 0, 3)
  28. #define DECODE_CMD_AA(x) (((x) >> 6) & CMD_BITS_MASK)
  29. #define DECODE_CMD_BB(x) (((x) >> 4) & CMD_BITS_MASK)
  30. #define DECODE_CMD_CC(x) (((x) >> 2) & CMD_BITS_MASK)
  31. #define DECODE_CMD_DD(x) ((x) & CMD_BITS_MASK)
  32. /* Cypress trackpad working mode. */
  33. #define CYTP_BIT_ABS_PRESSURE (1 << 3)
  34. #define CYTP_BIT_ABS_NO_PRESSURE (1 << 2)
  35. #define CYTP_BIT_CYPRESS_REL (1 << 1)
  36. #define CYTP_BIT_STANDARD_REL (1 << 0)
  37. #define CYTP_BIT_REL_MASK (CYTP_BIT_CYPRESS_REL | CYTP_BIT_STANDARD_REL)
  38. #define CYTP_BIT_ABS_MASK (CYTP_BIT_ABS_PRESSURE | CYTP_BIT_ABS_NO_PRESSURE)
  39. #define CYTP_BIT_ABS_REL_MASK (CYTP_BIT_ABS_MASK | CYTP_BIT_REL_MASK)
  40. #define CYTP_BIT_HIGH_RATE (1 << 4)
  41. /*
  42. * report mode bit is set, firmware working in Remote Mode.
  43. * report mode bit is cleared, firmware working in Stream Mode.
  44. */
  45. #define CYTP_BIT_REPORT_MODE (1 << 5)
  46. /* scrolling width values for set HSCROLL and VSCROLL width command. */
  47. #define SCROLL_WIDTH_NARROW 1
  48. #define SCROLL_WIDTH_NORMAL 2
  49. #define SCROLL_WIDTH_WIDE 3
  50. #define PALM_GEOMETRY_ENABLE 1
  51. #define PALM_GEOMETRY_DISABLE 0
  52. #define TP_METRICS_MASK 0x80
  53. #define FW_VERSION_MASX 0x7f
  54. #define FW_VER_HIGH_MASK 0x70
  55. #define FW_VER_LOW_MASK 0x0f
  56. /* Times to retry a ps2_command and millisecond delay between tries. */
  57. #define CYTP_PS2_CMD_TRIES 3
  58. #define CYTP_PS2_CMD_DELAY 500
  59. /* time out for PS/2 command only in milliseconds. */
  60. #define CYTP_CMD_TIMEOUT 200
  61. #define CYTP_DATA_TIMEOUT 30
  62. #define CYTP_EXT_CMD 0xe8
  63. #define CYTP_PS2_RETRY 0xfe
  64. #define CYTP_PS2_ERROR 0xfc
  65. #define CYTP_RESP_RETRY 0x01
  66. #define CYTP_RESP_ERROR 0xfe
  67. #define CYTP_105001_WIDTH 97 /* Dell XPS 13 */
  68. #define CYTP_105001_HIGH 59
  69. #define CYTP_DEFAULT_WIDTH (CYTP_105001_WIDTH)
  70. #define CYTP_DEFAULT_HIGH (CYTP_105001_HIGH)
  71. #define CYTP_ABS_MAX_X 1600
  72. #define CYTP_ABS_MAX_Y 900
  73. #define CYTP_MAX_PRESSURE 255
  74. #define CYTP_MIN_PRESSURE 0
  75. /* header byte bits of relative package. */
  76. #define BTN_LEFT_BIT 0x01
  77. #define BTN_RIGHT_BIT 0x02
  78. #define BTN_MIDDLE_BIT 0x04
  79. #define REL_X_SIGN_BIT 0x10
  80. #define REL_Y_SIGN_BIT 0x20
  81. /* header byte bits of absolute package. */
  82. #define ABS_VSCROLL_BIT 0x10
  83. #define ABS_HSCROLL_BIT 0x20
  84. #define ABS_MULTIFINGER_TAP 0x04
  85. #define ABS_EDGE_MOTION_MASK 0x80
  86. #define DFLT_RESP_BITS_VALID 0x88 /* SMBus bit should not be set. */
  87. #define DFLT_RESP_SMBUS_BIT 0x80
  88. #define DFLT_SMBUS_MODE 0x80
  89. #define DFLT_PS2_MODE 0x00
  90. #define DFLT_RESP_BIT_MODE 0x40
  91. #define DFLT_RESP_REMOTE_MODE 0x40
  92. #define DFLT_RESP_STREAM_MODE 0x00
  93. #define DFLT_RESP_BIT_REPORTING 0x20
  94. #define DFLT_RESP_BIT_SCALING 0x10
  95. #define TP_METRICS_BIT_PALM 0x80
  96. #define TP_METRICS_BIT_STUBBORN 0x40
  97. #define TP_METRICS_BIT_2F_JITTER 0x30
  98. #define TP_METRICS_BIT_1F_JITTER 0x0c
  99. #define TP_METRICS_BIT_APA 0x02
  100. #define TP_METRICS_BIT_MTG 0x01
  101. #define TP_METRICS_BIT_ABS_PKT_FORMAT_SET 0xf0
  102. #define TP_METRICS_BIT_2F_SPIKE 0x0c
  103. #define TP_METRICS_BIT_1F_SPIKE 0x03
  104. /* bits of first byte response of E9h-Status Request command. */
  105. #define RESP_BTN_RIGHT_BIT 0x01
  106. #define RESP_BTN_MIDDLE_BIT 0x02
  107. #define RESP_BTN_LEFT_BIT 0x04
  108. #define RESP_SCALING_BIT 0x10
  109. #define RESP_ENABLE_BIT 0x20
  110. #define RESP_REMOTE_BIT 0x40
  111. #define RESP_SMBUS_BIT 0x80
  112. #define CYTP_MAX_MT_SLOTS 2
  113. struct cytp_contact {
  114. int x;
  115. int y;
  116. int z; /* also named as touch pressure. */
  117. };
  118. /* The structure of Cypress Trackpad event data. */
  119. struct cytp_report_data {
  120. int contact_cnt;
  121. struct cytp_contact contacts[CYTP_MAX_MT_SLOTS];
  122. unsigned int left:1;
  123. unsigned int right:1;
  124. unsigned int middle:1;
  125. unsigned int tap:1; /* multi-finger tap detected. */
  126. };
  127. /* The structure of Cypress Trackpad device private data. */
  128. struct cytp_data {
  129. int fw_version;
  130. int pkt_size;
  131. int mode;
  132. int tp_min_pressure;
  133. int tp_max_pressure;
  134. int tp_width; /* X direction physical size in mm. */
  135. int tp_high; /* Y direction physical size in mm. */
  136. int tp_max_abs_x; /* Max X absolute units that can be reported. */
  137. int tp_max_abs_y; /* Max Y absolute units that can be reported. */
  138. int tp_res_x; /* X resolution in units/mm. */
  139. int tp_res_y; /* Y resolution in units/mm. */
  140. int tp_metrics_supported;
  141. };
  142. int cypress_detect(struct psmouse *psmouse, bool set_properties);
  143. int cypress_init(struct psmouse *psmouse);
  144. #endif /* _CYPRESS_PS2_H */