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 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 21 #define SYN_QUE_EXT_CAPAB_0C 0x0c 22 #define SYN_QUE_EXT_MAX_COORDS 0x0d 23 #define SYN_QUE_EXT_MIN_COORDS 0x0f 24 25 /* synatics modes */ 26 #define SYN_BIT_ABSOLUTE_MODE (1 << 7) 27 #define SYN_BIT_HIGH_RATE (1 << 6) 28 #define SYN_BIT_SLEEP_MODE (1 << 3) 29 #define SYN_BIT_DISABLE_GESTURE (1 << 2) 30 #define SYN_BIT_FOUR_BYTE_CLIENT (1 << 1) 31 #define SYN_BIT_W_MODE (1 << 0) 32 33 /* synaptics model ID bits */ 34 #define SYN_MODEL_ROT180(m) ((m) & (1 << 23)) 35 #define SYN_MODEL_PORTRAIT(m) ((m) & (1 << 22)) 36 #define SYN_MODEL_SENSOR(m) (((m) >> 16) & 0x3f) 37 #define SYN_MODEL_HARDWARE(m) (((m) >> 9) & 0x7f) 38 #define SYN_MODEL_NEWABS(m) ((m) & (1 << 7)) 39 #define SYN_MODEL_PEN(m) ((m) & (1 << 6)) 40 #define SYN_MODEL_SIMPLIC(m) ((m) & (1 << 5)) 41 #define SYN_MODEL_GEOMETRY(m) ((m) & 0x0f) 42 43 /* synaptics capability bits */ 44 #define SYN_CAP_EXTENDED(c) ((c) & (1 << 23)) 45 #define SYN_CAP_MIDDLE_BUTTON(c) ((c) & (1 << 18)) 46 #define SYN_CAP_PASS_THROUGH(c) ((c) & (1 << 7)) 47 #define SYN_CAP_SLEEP(c) ((c) & (1 << 4)) 48 #define SYN_CAP_FOUR_BUTTON(c) ((c) & (1 << 3)) 49 #define SYN_CAP_MULTIFINGER(c) ((c) & (1 << 1)) 50 #define SYN_CAP_PALMDETECT(c) ((c) & (1 << 0)) 51 #define SYN_CAP_SUBMODEL_ID(c) (((c) & 0x00ff00) >> 8) 52 #define SYN_EXT_CAP_REQUESTS(c) (((c) & 0x700000) >> 20) 53 #define SYN_CAP_MULTI_BUTTON_NO(ec) (((ec) & 0x00f000) >> 12) 54 #define SYN_CAP_PRODUCT_ID(ec) (((ec) & 0xff0000) >> 16) 55 56 /* 57 * The following describes response for the 0x0c query. 58 * 59 * byte mask name meaning 60 * ---- ---- ------- ------------ 61 * 1 0x01 adjustable threshold capacitive button sensitivity 62 * can be adjusted 63 * 1 0x02 report max query 0x0d gives max coord reported 64 * 1 0x04 clearpad sensor is ClearPad product 65 * 1 0x08 advanced gesture not particularly meaningful 66 * 1 0x10 clickpad bit 0 1-button ClickPad 67 * 1 0x60 multifinger mode identifies firmware finger counting 68 * (not reporting!) algorithm. 69 * Not particularly meaningful 70 * 1 0x80 covered pad W clipped to 14, 15 == pad mostly covered 71 * 2 0x01 clickpad bit 1 2-button ClickPad 72 * 2 0x02 deluxe LED controls touchpad support LED commands 73 * ala multimedia control bar 74 * 2 0x04 reduced filtering firmware does less filtering on 75 * position data, driver should watch 76 * for noise. 77 * 2 0x08 image sensor image sensor tracks 5 fingers, but only 78 * reports 2. 79 * 2 0x20 report min query 0x0f gives min coord reported 80 */ 81 #define SYN_CAP_CLICKPAD(ex0c) ((ex0c) & 0x100000) /* 1-button ClickPad */ 82 #define SYN_CAP_CLICKPAD2BTN(ex0c) ((ex0c) & 0x000100) /* 2-button ClickPad */ 83 #define SYN_CAP_MAX_DIMENSIONS(ex0c) ((ex0c) & 0x020000) 84 #define SYN_CAP_MIN_DIMENSIONS(ex0c) ((ex0c) & 0x002000) 85 #define SYN_CAP_ADV_GESTURE(ex0c) ((ex0c) & 0x080000) 86 #define SYN_CAP_REDUCED_FILTERING(ex0c) ((ex0c) & 0x000400) 87 #define SYN_CAP_IMAGE_SENSOR(ex0c) ((ex0c) & 0x000800) 88 89 /* synaptics modes query bits */ 90 #define SYN_MODE_ABSOLUTE(m) ((m) & (1 << 7)) 91 #define SYN_MODE_RATE(m) ((m) & (1 << 6)) 92 #define SYN_MODE_BAUD_SLEEP(m) ((m) & (1 << 3)) 93 #define SYN_MODE_DISABLE_GESTURE(m) ((m) & (1 << 2)) 94 #define SYN_MODE_PACKSIZE(m) ((m) & (1 << 1)) 95 #define SYN_MODE_WMODE(m) ((m) & (1 << 0)) 96 97 /* synaptics identify query bits */ 98 #define SYN_ID_MODEL(i) (((i) >> 4) & 0x0f) 99 #define SYN_ID_MAJOR(i) ((i) & 0x0f) 100 #define SYN_ID_MINOR(i) (((i) >> 16) & 0xff) 101 #define SYN_ID_FULL(i) ((SYN_ID_MAJOR(i) << 8) | SYN_ID_MINOR(i)) 102 #define SYN_ID_IS_SYNAPTICS(i) ((((i) >> 8) & 0xff) == 0x47) 103 #define SYN_ID_DISGEST_SUPPORTED(i) (SYN_ID_MAJOR(i) >= 4) 104 105 /* synaptics special commands */ 106 #define SYN_PS_SET_MODE2 0x14 107 #define SYN_PS_CLIENT_CMD 0x28 108 109 /* synaptics packet types */ 110 #define SYN_NEWABS 0 111 #define SYN_NEWABS_STRICT 1 112 #define SYN_NEWABS_RELAXED 2 113 #define SYN_OLDABS 3 114 115 /* amount to fuzz position data when touchpad reports reduced filtering */ 116 #define SYN_REDUCED_FILTER_FUZZ 8 117 118 /* 119 * A structure to describe which internal touchpad finger slots are being 120 * reported in raw packets. 121 */ 122 struct synaptics_mt_state { 123 int count; /* num fingers being tracked */ 124 int sgm; /* which slot is reported by sgm pkt */ 125 int agm; /* which slot is reported by agm pkt*/ 126 }; 127 128 /* 129 * A structure to describe the state of the touchpad hardware (buttons and pad) 130 */ 131 struct synaptics_hw_state { 132 int x; 133 int y; 134 int z; 135 int w; 136 unsigned int left:1; 137 unsigned int right:1; 138 unsigned int middle:1; 139 unsigned int up:1; 140 unsigned int down:1; 141 unsigned char ext_buttons; 142 signed char scroll; 143 144 /* As reported in last AGM-CONTACT packets */ 145 struct synaptics_mt_state mt_state; 146 }; 147 148 struct synaptics_data { 149 /* Data read from the touchpad */ 150 unsigned long int model_id; /* Model-ID */ 151 unsigned long int capabilities; /* Capabilities */ 152 unsigned long int ext_cap; /* Extended Capabilities */ 153 unsigned long int ext_cap_0c; /* Ext Caps from 0x0c query */ 154 unsigned long int identity; /* Identification */ 155 unsigned int x_res, y_res; /* X/Y resolution in units/mm */ 156 unsigned int x_max, y_max; /* Max coordinates (from FW) */ 157 unsigned int x_min, y_min; /* Min coordinates (from FW) */ 158 159 unsigned char pkt_type; /* packet type - old, new, etc */ 160 unsigned char mode; /* current mode byte */ 161 int scroll; 162 163 bool absolute_mode; /* run in Absolute mode */ 164 bool disable_gesture; /* disable gestures */ 165 166 struct serio *pt_port; /* Pass-through serio port */ 167 168 struct synaptics_mt_state mt_state; /* Current mt finger state */ 169 bool mt_state_lost; /* mt_state may be incorrect */ 170 171 /* 172 * Last received Advanced Gesture Mode (AGM) packet. An AGM packet 173 * contains position data for a second contact, at half resolution. 174 */ 175 struct synaptics_hw_state agm; 176 bool agm_pending; /* new AGM packet received */ 177 }; 178 179 void synaptics_module_init(void); 180 int synaptics_detect(struct psmouse *psmouse, bool set_properties); 181 int synaptics_init(struct psmouse *psmouse); 182 int synaptics_init_relative(struct psmouse *psmouse); 183 void synaptics_reset(struct psmouse *psmouse); 184 bool synaptics_supported(void); 185 186 #endif /* _SYNAPTICS_H */ 187