Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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_DIMENSIONS 0x0d
23
24/* synatics modes */
25#define SYN_BIT_ABSOLUTE_MODE (1 << 7)
26#define SYN_BIT_HIGH_RATE (1 << 6)
27#define SYN_BIT_SLEEP_MODE (1 << 3)
28#define SYN_BIT_DISABLE_GESTURE (1 << 2)
29#define SYN_BIT_FOUR_BYTE_CLIENT (1 << 1)
30#define SYN_BIT_W_MODE (1 << 0)
31
32/* synaptics model ID bits */
33#define SYN_MODEL_ROT180(m) ((m) & (1 << 23))
34#define SYN_MODEL_PORTRAIT(m) ((m) & (1 << 22))
35#define SYN_MODEL_SENSOR(m) (((m) >> 16) & 0x3f)
36#define SYN_MODEL_HARDWARE(m) (((m) >> 9) & 0x7f)
37#define SYN_MODEL_NEWABS(m) ((m) & (1 << 7))
38#define SYN_MODEL_PEN(m) ((m) & (1 << 6))
39#define SYN_MODEL_SIMPLIC(m) ((m) & (1 << 5))
40#define SYN_MODEL_GEOMETRY(m) ((m) & 0x0f)
41
42/* synaptics capability bits */
43#define SYN_CAP_EXTENDED(c) ((c) & (1 << 23))
44#define SYN_CAP_MIDDLE_BUTTON(c) ((c) & (1 << 18))
45#define SYN_CAP_PASS_THROUGH(c) ((c) & (1 << 7))
46#define SYN_CAP_SLEEP(c) ((c) & (1 << 4))
47#define SYN_CAP_FOUR_BUTTON(c) ((c) & (1 << 3))
48#define SYN_CAP_MULTIFINGER(c) ((c) & (1 << 1))
49#define SYN_CAP_PALMDETECT(c) ((c) & (1 << 0))
50#define SYN_CAP_SUBMODEL_ID(c) (((c) & 0x00ff00) >> 8)
51#define SYN_EXT_CAP_REQUESTS(c) (((c) & 0x700000) >> 20)
52#define SYN_CAP_MULTI_BUTTON_NO(ec) (((ec) & 0x00f000) >> 12)
53#define SYN_CAP_PRODUCT_ID(ec) (((ec) & 0xff0000) >> 16)
54
55/*
56 * The following describes response for the 0x0c query.
57 *
58 * byte mask name meaning
59 * ---- ---- ------- ------------
60 * 1 0x01 adjustable threshold capacitive button sensitivity
61 * can be adjusted
62 * 1 0x02 report max query 0x0d gives max coord reported
63 * 1 0x04 clearpad sensor is ClearPad product
64 * 1 0x08 advanced gesture not particularly meaningful
65 * 1 0x10 clickpad bit 0 1-button ClickPad
66 * 1 0x60 multifinger mode identifies firmware finger counting
67 * (not reporting!) algorithm.
68 * Not particularly meaningful
69 * 1 0x80 covered pad W clipped to 14, 15 == pad mostly covered
70 * 2 0x01 clickpad bit 1 2-button ClickPad
71 * 2 0x02 deluxe LED controls touchpad support LED commands
72 * ala multimedia control bar
73 * 2 0x04 reduced filtering firmware does less filtering on
74 * position data, driver should watch
75 * for noise.
76 */
77#define SYN_CAP_CLICKPAD(ex0c) ((ex0c) & 0x100000) /* 1-button ClickPad */
78#define SYN_CAP_CLICKPAD2BTN(ex0c) ((ex0c) & 0x000100) /* 2-button ClickPad */
79#define SYN_CAP_MAX_DIMENSIONS(ex0c) ((ex0c) & 0x020000)
80#define SYN_CAP_ADV_GESTURE(ex0c) ((ex0c) & 0x080000)
81
82/* synaptics modes query bits */
83#define SYN_MODE_ABSOLUTE(m) ((m) & (1 << 7))
84#define SYN_MODE_RATE(m) ((m) & (1 << 6))
85#define SYN_MODE_BAUD_SLEEP(m) ((m) & (1 << 3))
86#define SYN_MODE_DISABLE_GESTURE(m) ((m) & (1 << 2))
87#define SYN_MODE_PACKSIZE(m) ((m) & (1 << 1))
88#define SYN_MODE_WMODE(m) ((m) & (1 << 0))
89
90/* synaptics identify query bits */
91#define SYN_ID_MODEL(i) (((i) >> 4) & 0x0f)
92#define SYN_ID_MAJOR(i) ((i) & 0x0f)
93#define SYN_ID_MINOR(i) (((i) >> 16) & 0xff)
94#define SYN_ID_FULL(i) ((SYN_ID_MAJOR(i) << 8) | SYN_ID_MINOR(i))
95#define SYN_ID_IS_SYNAPTICS(i) ((((i) >> 8) & 0xff) == 0x47)
96
97/* synaptics special commands */
98#define SYN_PS_SET_MODE2 0x14
99#define SYN_PS_CLIENT_CMD 0x28
100
101/* synaptics packet types */
102#define SYN_NEWABS 0
103#define SYN_NEWABS_STRICT 1
104#define SYN_NEWABS_RELAXED 2
105#define SYN_OLDABS 3
106
107/*
108 * A structure to describe the state of the touchpad hardware (buttons and pad)
109 */
110
111struct synaptics_hw_state {
112 int x;
113 int y;
114 int z;
115 int w;
116 unsigned int left:1;
117 unsigned int right:1;
118 unsigned int middle:1;
119 unsigned int up:1;
120 unsigned int down:1;
121 unsigned char ext_buttons;
122 signed char scroll;
123};
124
125struct synaptics_data {
126 /* Data read from the touchpad */
127 unsigned long int model_id; /* Model-ID */
128 unsigned long int capabilities; /* Capabilities */
129 unsigned long int ext_cap; /* Extended Capabilities */
130 unsigned long int ext_cap_0c; /* Ext Caps from 0x0c query */
131 unsigned long int identity; /* Identification */
132 unsigned int x_res, y_res; /* X/Y resolution in units/mm */
133 unsigned int x_max, y_max; /* Max dimensions (from FW) */
134
135 unsigned char pkt_type; /* packet type - old, new, etc */
136 unsigned char mode; /* current mode byte */
137 int scroll;
138
139 struct serio *pt_port; /* Pass-through serio port */
140
141 struct synaptics_hw_state mt; /* current gesture packet */
142};
143
144void synaptics_module_init(void);
145int synaptics_detect(struct psmouse *psmouse, bool set_properties);
146int synaptics_init(struct psmouse *psmouse);
147void synaptics_reset(struct psmouse *psmouse);
148bool synaptics_supported(void);
149
150#endif /* _SYNAPTICS_H */