Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Synaptics TouchPad PS/2 mouse driver |
| 3 | * |
| 4 | * This program is free software; you can redistribute it and/or modify it |
| 5 | * under the terms of the GNU General Public License version 2 as published by |
| 6 | * the Free Software Foundation. |
| 7 | */ |
| 8 | |
| 9 | #ifndef _SYNAPTICS_H |
| 10 | #define _SYNAPTICS_H |
| 11 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 12 | /* synaptics queries */ |
| 13 | #define SYN_QUE_IDENTIFY 0x00 |
| 14 | #define SYN_QUE_MODES 0x01 |
| 15 | #define SYN_QUE_CAPABILITIES 0x02 |
| 16 | #define SYN_QUE_MODEL 0x03 |
| 17 | #define SYN_QUE_SERIAL_NUMBER_PREFIX 0x06 |
| 18 | #define SYN_QUE_SERIAL_NUMBER_SUFFIX 0x07 |
| 19 | #define SYN_QUE_RESOLUTION 0x08 |
| 20 | #define SYN_QUE_EXT_CAPAB 0x09 |
Daniel Kurtz | c6bd9d4 | 2012-07-07 18:08:51 -0700 | [diff] [blame] | 21 | #define SYN_QUE_FIRMWARE_ID 0x0a |
Takashi Iwai | 5f57d67 | 2010-04-19 10:37:21 -0700 | [diff] [blame] | 22 | #define SYN_QUE_EXT_CAPAB_0C 0x0c |
Dmitry Torokhov | a66413f | 2011-07-09 12:32:56 -0700 | [diff] [blame] | 23 | #define SYN_QUE_EXT_MAX_COORDS 0x0d |
| 24 | #define SYN_QUE_EXT_MIN_COORDS 0x0f |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | |
| 26 | /* synatics modes */ |
| 27 | #define SYN_BIT_ABSOLUTE_MODE (1 << 7) |
| 28 | #define SYN_BIT_HIGH_RATE (1 << 6) |
| 29 | #define SYN_BIT_SLEEP_MODE (1 << 3) |
| 30 | #define SYN_BIT_DISABLE_GESTURE (1 << 2) |
| 31 | #define SYN_BIT_FOUR_BYTE_CLIENT (1 << 1) |
| 32 | #define SYN_BIT_W_MODE (1 << 0) |
| 33 | |
| 34 | /* synaptics model ID bits */ |
| 35 | #define SYN_MODEL_ROT180(m) ((m) & (1 << 23)) |
| 36 | #define SYN_MODEL_PORTRAIT(m) ((m) & (1 << 22)) |
| 37 | #define SYN_MODEL_SENSOR(m) (((m) >> 16) & 0x3f) |
| 38 | #define SYN_MODEL_HARDWARE(m) (((m) >> 9) & 0x7f) |
| 39 | #define SYN_MODEL_NEWABS(m) ((m) & (1 << 7)) |
| 40 | #define SYN_MODEL_PEN(m) ((m) & (1 << 6)) |
| 41 | #define SYN_MODEL_SIMPLIC(m) ((m) & (1 << 5)) |
| 42 | #define SYN_MODEL_GEOMETRY(m) ((m) & 0x0f) |
| 43 | |
| 44 | /* synaptics capability bits */ |
| 45 | #define SYN_CAP_EXTENDED(c) ((c) & (1 << 23)) |
| 46 | #define SYN_CAP_MIDDLE_BUTTON(c) ((c) & (1 << 18)) |
| 47 | #define SYN_CAP_PASS_THROUGH(c) ((c) & (1 << 7)) |
| 48 | #define SYN_CAP_SLEEP(c) ((c) & (1 << 4)) |
| 49 | #define SYN_CAP_FOUR_BUTTON(c) ((c) & (1 << 3)) |
| 50 | #define SYN_CAP_MULTIFINGER(c) ((c) & (1 << 1)) |
| 51 | #define SYN_CAP_PALMDETECT(c) ((c) & (1 << 0)) |
Dmitry Torokhov | 3619b8f | 2010-07-21 00:01:19 -0700 | [diff] [blame] | 52 | #define SYN_CAP_SUBMODEL_ID(c) (((c) & 0x00ff00) >> 8) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 53 | #define SYN_EXT_CAP_REQUESTS(c) (((c) & 0x700000) >> 20) |
| 54 | #define SYN_CAP_MULTI_BUTTON_NO(ec) (((ec) & 0x00f000) >> 12) |
Takashi Iwai | 5f57d67 | 2010-04-19 10:37:21 -0700 | [diff] [blame] | 55 | #define SYN_CAP_PRODUCT_ID(ec) (((ec) & 0xff0000) >> 16) |
Dmitry Torokhov | 9bb794a | 2011-02-22 20:15:07 -0800 | [diff] [blame] | 56 | |
| 57 | /* |
| 58 | * The following describes response for the 0x0c query. |
| 59 | * |
| 60 | * byte mask name meaning |
| 61 | * ---- ---- ------- ------------ |
| 62 | * 1 0x01 adjustable threshold capacitive button sensitivity |
| 63 | * can be adjusted |
| 64 | * 1 0x02 report max query 0x0d gives max coord reported |
| 65 | * 1 0x04 clearpad sensor is ClearPad product |
| 66 | * 1 0x08 advanced gesture not particularly meaningful |
| 67 | * 1 0x10 clickpad bit 0 1-button ClickPad |
| 68 | * 1 0x60 multifinger mode identifies firmware finger counting |
| 69 | * (not reporting!) algorithm. |
| 70 | * Not particularly meaningful |
Daniel Kurtz | a9f0b79 | 2011-07-06 22:39:14 -0700 | [diff] [blame] | 71 | * 1 0x80 covered pad W clipped to 14, 15 == pad mostly covered |
| 72 | * 2 0x01 clickpad bit 1 2-button ClickPad |
| 73 | * 2 0x02 deluxe LED controls touchpad support LED commands |
Dmitry Torokhov | 9bb794a | 2011-02-22 20:15:07 -0800 | [diff] [blame] | 74 | * ala multimedia control bar |
| 75 | * 2 0x04 reduced filtering firmware does less filtering on |
| 76 | * position data, driver should watch |
| 77 | * for noise. |
Daniel Kurtz | 3cdfee9 | 2011-08-23 23:02:25 -0700 | [diff] [blame] | 78 | * 2 0x08 image sensor image sensor tracks 5 fingers, but only |
| 79 | * reports 2. |
Dmitry Torokhov | aa9724099 | 2014-09-02 09:49:18 -0700 | [diff] [blame] | 80 | * 2 0x01 uniform clickpad whole clickpad moves instead of being |
| 81 | * hinged at the top. |
Dmitry Torokhov | a66413f | 2011-07-09 12:32:56 -0700 | [diff] [blame] | 82 | * 2 0x20 report min query 0x0f gives min coord reported |
Dmitry Torokhov | 9bb794a | 2011-02-22 20:15:07 -0800 | [diff] [blame] | 83 | */ |
Yan Li | 3bfa321 | 2010-11-30 23:51:03 -0800 | [diff] [blame] | 84 | #define SYN_CAP_CLICKPAD(ex0c) ((ex0c) & 0x100000) /* 1-button ClickPad */ |
| 85 | #define SYN_CAP_CLICKPAD2BTN(ex0c) ((ex0c) & 0x000100) /* 2-button ClickPad */ |
Dmitry Torokhov | 83ba9ea | 2010-05-10 23:06:52 -0700 | [diff] [blame] | 86 | #define SYN_CAP_MAX_DIMENSIONS(ex0c) ((ex0c) & 0x020000) |
Dmitry Torokhov | 3c6b501 | 2011-07-25 01:36:46 -0700 | [diff] [blame] | 87 | #define SYN_CAP_MIN_DIMENSIONS(ex0c) ((ex0c) & 0x002000) |
Henrik Rydberg | fec6e52 | 2010-12-21 18:11:25 +0100 | [diff] [blame] | 88 | #define SYN_CAP_ADV_GESTURE(ex0c) ((ex0c) & 0x080000) |
Daniel Kurtz | a9f0b79 | 2011-07-06 22:39:14 -0700 | [diff] [blame] | 89 | #define SYN_CAP_REDUCED_FILTERING(ex0c) ((ex0c) & 0x000400) |
Daniel Kurtz | 3cdfee9 | 2011-08-23 23:02:25 -0700 | [diff] [blame] | 90 | #define SYN_CAP_IMAGE_SENSOR(ex0c) ((ex0c) & 0x000800) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 91 | |
| 92 | /* synaptics modes query bits */ |
| 93 | #define SYN_MODE_ABSOLUTE(m) ((m) & (1 << 7)) |
| 94 | #define SYN_MODE_RATE(m) ((m) & (1 << 6)) |
| 95 | #define SYN_MODE_BAUD_SLEEP(m) ((m) & (1 << 3)) |
| 96 | #define SYN_MODE_DISABLE_GESTURE(m) ((m) & (1 << 2)) |
| 97 | #define SYN_MODE_PACKSIZE(m) ((m) & (1 << 1)) |
| 98 | #define SYN_MODE_WMODE(m) ((m) & (1 << 0)) |
| 99 | |
| 100 | /* synaptics identify query bits */ |
Andres Salomon | 55e3d92 | 2007-03-10 01:39:54 -0500 | [diff] [blame] | 101 | #define SYN_ID_MODEL(i) (((i) >> 4) & 0x0f) |
| 102 | #define SYN_ID_MAJOR(i) ((i) & 0x0f) |
| 103 | #define SYN_ID_MINOR(i) (((i) >> 16) & 0xff) |
Dmitry Torokhov | 3619b8f | 2010-07-21 00:01:19 -0700 | [diff] [blame] | 104 | #define SYN_ID_FULL(i) ((SYN_ID_MAJOR(i) << 8) | SYN_ID_MINOR(i)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 105 | #define SYN_ID_IS_SYNAPTICS(i) ((((i) >> 8) & 0xff) == 0x47) |
Daniel Drake | 7968a5d | 2011-11-08 00:00:35 -0800 | [diff] [blame] | 106 | #define SYN_ID_DISGEST_SUPPORTED(i) (SYN_ID_MAJOR(i) >= 4) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 107 | |
| 108 | /* synaptics special commands */ |
| 109 | #define SYN_PS_SET_MODE2 0x14 |
| 110 | #define SYN_PS_CLIENT_CMD 0x28 |
| 111 | |
| 112 | /* synaptics packet types */ |
| 113 | #define SYN_NEWABS 0 |
| 114 | #define SYN_NEWABS_STRICT 1 |
| 115 | #define SYN_NEWABS_RELAXED 2 |
| 116 | #define SYN_OLDABS 3 |
| 117 | |
Daniel Kurtz | a9f0b79 | 2011-07-06 22:39:14 -0700 | [diff] [blame] | 118 | /* amount to fuzz position data when touchpad reports reduced filtering */ |
| 119 | #define SYN_REDUCED_FILTER_FUZZ 8 |
| 120 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 121 | /* |
| 122 | * A structure to describe the state of the touchpad hardware (buttons and pad) |
| 123 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 124 | struct synaptics_hw_state { |
| 125 | int x; |
| 126 | int y; |
| 127 | int z; |
| 128 | int w; |
| 129 | unsigned int left:1; |
| 130 | unsigned int right:1; |
| 131 | unsigned int middle:1; |
| 132 | unsigned int up:1; |
| 133 | unsigned int down:1; |
| 134 | unsigned char ext_buttons; |
| 135 | signed char scroll; |
| 136 | }; |
| 137 | |
| 138 | struct synaptics_data { |
| 139 | /* Data read from the touchpad */ |
| 140 | unsigned long int model_id; /* Model-ID */ |
Daniel Kurtz | c6bd9d4 | 2012-07-07 18:08:51 -0700 | [diff] [blame] | 141 | unsigned long int firmware_id; /* Firmware-ID */ |
| 142 | unsigned long int board_id; /* Board-ID */ |
Andres Salomon | 55e3d92 | 2007-03-10 01:39:54 -0500 | [diff] [blame] | 143 | unsigned long int capabilities; /* Capabilities */ |
| 144 | unsigned long int ext_cap; /* Extended Capabilities */ |
Takashi Iwai | 5f57d67 | 2010-04-19 10:37:21 -0700 | [diff] [blame] | 145 | unsigned long int ext_cap_0c; /* Ext Caps from 0x0c query */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 146 | unsigned long int identity; /* Identification */ |
Dmitry Torokhov | 83ba9ea | 2010-05-10 23:06:52 -0700 | [diff] [blame] | 147 | unsigned int x_res, y_res; /* X/Y resolution in units/mm */ |
Dmitry Torokhov | a66413f | 2011-07-09 12:32:56 -0700 | [diff] [blame] | 148 | unsigned int x_max, y_max; /* Max coordinates (from FW) */ |
| 149 | unsigned int x_min, y_min; /* Min coordinates (from FW) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | |
| 151 | unsigned char pkt_type; /* packet type - old, new, etc */ |
| 152 | unsigned char mode; /* current mode byte */ |
| 153 | int scroll; |
Dmitry Torokhov | a8b3c0f | 2010-10-04 21:46:10 -0700 | [diff] [blame] | 154 | |
Daniel Drake | 7968a5d | 2011-11-08 00:00:35 -0800 | [diff] [blame] | 155 | bool absolute_mode; /* run in Absolute mode */ |
| 156 | bool disable_gesture; /* disable gestures */ |
| 157 | |
Dmitry Torokhov | a8b3c0f | 2010-10-04 21:46:10 -0700 | [diff] [blame] | 158 | struct serio *pt_port; /* Pass-through serio port */ |
Henrik Rydberg | fec6e52 | 2010-12-21 18:11:25 +0100 | [diff] [blame] | 159 | |
Daniel Kurtz | 7afdb84 | 2011-08-23 23:00:33 -0700 | [diff] [blame] | 160 | /* |
| 161 | * Last received Advanced Gesture Mode (AGM) packet. An AGM packet |
| 162 | * contains position data for a second contact, at half resolution. |
| 163 | */ |
| 164 | struct synaptics_hw_state agm; |
Benjamin Tissoires | e9e8520 | 2014-12-29 14:15:24 -0800 | [diff] [blame] | 165 | unsigned int agm_count; /* finger count reported by agm */ |
Dmitry Torokhov | 5715fc7 | 2014-08-30 13:51:06 -0700 | [diff] [blame] | 166 | |
| 167 | /* ForcePad handling */ |
| 168 | unsigned long press_start; |
| 169 | bool press; |
| 170 | bool report_press; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 171 | }; |
| 172 | |
Dmitry Torokhov | 7705d54 | 2009-12-03 23:21:14 -0800 | [diff] [blame] | 173 | void synaptics_module_init(void); |
Dmitry Torokhov | b7802c5 | 2009-09-09 19:13:20 -0700 | [diff] [blame] | 174 | int synaptics_detect(struct psmouse *psmouse, bool set_properties); |
Andres Salomon | 55e3d92 | 2007-03-10 01:39:54 -0500 | [diff] [blame] | 175 | int synaptics_init(struct psmouse *psmouse); |
Daniel Drake | 7968a5d | 2011-11-08 00:00:35 -0800 | [diff] [blame] | 176 | int synaptics_init_relative(struct psmouse *psmouse); |
Andres Salomon | 55e3d92 | 2007-03-10 01:39:54 -0500 | [diff] [blame] | 177 | void synaptics_reset(struct psmouse *psmouse); |
Daniel Drake | e4e6efd | 2010-01-07 01:52:39 -0800 | [diff] [blame] | 178 | bool synaptics_supported(void); |
Andres Salomon | 55e3d92 | 2007-03-10 01:39:54 -0500 | [diff] [blame] | 179 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 180 | #endif /* _SYNAPTICS_H */ |