^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Elantech Touchpad driver (v6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 2007-2009 Arjan Opmeer <arjan@opmeer.net>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Trademarks are the property of their respective owners.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #ifndef _ELANTECH_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #define _ELANTECH_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) * Command values for Synaptics style queries
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #define ETP_FW_ID_QUERY 0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #define ETP_FW_VERSION_QUERY 0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #define ETP_CAPABILITIES_QUERY 0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #define ETP_SAMPLE_QUERY 0x03
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #define ETP_RESOLUTION_QUERY 0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define ETP_ICBODY_QUERY 0x05
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) * Command values for register reading or writing
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define ETP_REGISTER_READ 0x10
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define ETP_REGISTER_WRITE 0x11
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) #define ETP_REGISTER_READWRITE 0x00
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) * Hardware version 2 custom PS/2 command value
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) #define ETP_PS2_CUSTOM_COMMAND 0xf8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) * Times to retry a ps2_command and millisecond delay between tries
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) #define ETP_PS2_COMMAND_TRIES 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) #define ETP_PS2_COMMAND_DELAY 500
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) * Times to try to read back a register and millisecond delay between tries
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) #define ETP_READ_BACK_TRIES 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) #define ETP_READ_BACK_DELAY 2000
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) * Register bitmasks for hardware version 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) #define ETP_R10_ABSOLUTE_MODE 0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) #define ETP_R11_4_BYTE_MODE 0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) * Capability bitmasks
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) #define ETP_CAP_HAS_ROCKER 0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) * One hard to find application note states that X axis range is 0 to 576
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) * and Y axis range is 0 to 384 for harware version 1.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) * Edge fuzz might be necessary because of bezel around the touchpad
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) #define ETP_EDGE_FUZZ_V1 32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) #define ETP_XMIN_V1 ( 0 + ETP_EDGE_FUZZ_V1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) #define ETP_XMAX_V1 (576 - ETP_EDGE_FUZZ_V1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) #define ETP_YMIN_V1 ( 0 + ETP_EDGE_FUZZ_V1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) #define ETP_YMAX_V1 (384 - ETP_EDGE_FUZZ_V1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) * The resolution for older v2 hardware doubled.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) * (newer v2's firmware provides command so we can query)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) #define ETP_XMIN_V2 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) #define ETP_XMAX_V2 1152
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) #define ETP_YMIN_V2 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) #define ETP_YMAX_V2 768
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) #define ETP_PMIN_V2 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) #define ETP_PMAX_V2 255
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) #define ETP_WMIN_V2 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) #define ETP_WMAX_V2 15
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) * v3 hardware has 2 kinds of packet types,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) * v4 hardware has 3.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) #define PACKET_UNKNOWN 0x01
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) #define PACKET_DEBOUNCE 0x02
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) #define PACKET_V3_HEAD 0x03
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) #define PACKET_V3_TAIL 0x04
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) #define PACKET_V4_HEAD 0x05
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) #define PACKET_V4_MOTION 0x06
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) #define PACKET_V4_STATUS 0x07
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) #define PACKET_TRACKPOINT 0x08
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) * track up to 5 fingers for v4 hardware
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) #define ETP_MAX_FINGERS 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) * weight value for v4 hardware
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) #define ETP_WEIGHT_VALUE 5
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) * Bus information on 3rd byte of query ETP_RESOLUTION_QUERY(0x04)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) #define ETP_BUS_PS2_ONLY 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) #define ETP_BUS_SMB_ALERT_ONLY 1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) #define ETP_BUS_SMB_HST_NTFY_ONLY 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) #define ETP_BUS_PS2_SMB_ALERT 3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) #define ETP_BUS_PS2_SMB_HST_NTFY 4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) * New ICs are either using SMBus Host Notify or just plain PS2.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) * ETP_FW_VERSION_QUERY is:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) * Byte 1:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) * - bit 0..3: IC BODY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) * Byte 2:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) * - bit 4: HiddenButton
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) * - bit 5: PS2_SMBUS_NOTIFY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) * - bit 6: PS2CRCCheck
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) #define ETP_NEW_IC_SMBUS_HOST_NOTIFY(fw_version) \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) ((((fw_version) & 0x0f2000) == 0x0f2000) && \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) ((fw_version) & 0x0000ff) > 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) * The base position for one finger, v4 hardware
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) struct finger_pos {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) unsigned int x;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) unsigned int y;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) struct elantech_device_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) unsigned char capabilities[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) unsigned char samples[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) unsigned char debug;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) unsigned char hw_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) unsigned char pattern;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) unsigned int fw_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) unsigned int ic_version;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) unsigned int product_id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) unsigned int x_min;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) unsigned int y_min;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) unsigned int x_max;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) unsigned int y_max;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) unsigned int x_res;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) unsigned int y_res;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) unsigned int x_traces;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) unsigned int y_traces;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) unsigned int width;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) unsigned int bus;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) bool paritycheck;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) bool jumpy_cursor;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) bool reports_pressure;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) bool crc_enabled;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) bool set_hw_resolution;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) bool has_trackpoint;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) bool has_middle_button;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) int (*send_cmd)(struct psmouse *psmouse, unsigned char c,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) unsigned char *param);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) struct elantech_data {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) struct input_dev *tp_dev; /* Relative device for trackpoint */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) char tp_phys[32];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) unsigned char reg_07;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) unsigned char reg_10;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) unsigned char reg_11;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) unsigned char reg_20;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) unsigned char reg_21;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) unsigned char reg_22;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) unsigned char reg_23;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) unsigned char reg_24;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) unsigned char reg_25;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) unsigned char reg_26;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) unsigned int single_finger_reports;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) unsigned int y_max;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) unsigned int width;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) struct finger_pos mt[ETP_MAX_FINGERS];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) unsigned char parity[256];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) struct elantech_device_info info;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) void (*original_set_rate)(struct psmouse *psmouse, unsigned int rate);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) int elantech_detect(struct psmouse *psmouse, bool set_properties);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) int elantech_init_ps2(struct psmouse *psmouse);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) #ifdef CONFIG_MOUSE_PS2_ELANTECH
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) int elantech_init(struct psmouse *psmouse);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) static inline int elantech_init(struct psmouse *psmouse)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) return -ENOSYS;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) #endif /* CONFIG_MOUSE_PS2_ELANTECH */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) int elantech_init_smbus(struct psmouse *psmouse);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) #endif
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags