cypress_ps2.h

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