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