68fff1dcd7de654c8bd3dcc074c1010bc77c28c1
[linux-2.6.git] / drivers / input / mouse / synaptics.h
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 extern int synaptics_detect(struct psmouse *psmouse, int set_properties);
13 extern int synaptics_init(struct psmouse *psmouse);
14 extern void synaptics_reset(struct psmouse *psmouse);
15
16 /* synaptics queries */
17 #define SYN_QUE_IDENTIFY                0x00
18 #define SYN_QUE_MODES                   0x01
19 #define SYN_QUE_CAPABILITIES            0x02
20 #define SYN_QUE_MODEL                   0x03
21 #define SYN_QUE_SERIAL_NUMBER_PREFIX    0x06
22 #define SYN_QUE_SERIAL_NUMBER_SUFFIX    0x07
23 #define SYN_QUE_RESOLUTION              0x08
24 #define SYN_QUE_EXT_CAPAB               0x09
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))
52 #define SYN_CAP_VALID(c)                ((((c) & 0x00ff00) >> 8) == 0x47)
53 #define SYN_EXT_CAP_REQUESTS(c)         (((c) & 0x700000) >> 20)
54 #define SYN_CAP_MULTI_BUTTON_NO(ec)     (((ec) & 0x00f000) >> 12)
55
56 /* synaptics modes query bits */
57 #define SYN_MODE_ABSOLUTE(m)            ((m) & (1 << 7))
58 #define SYN_MODE_RATE(m)                ((m) & (1 << 6))
59 #define SYN_MODE_BAUD_SLEEP(m)          ((m) & (1 << 3))
60 #define SYN_MODE_DISABLE_GESTURE(m)     ((m) & (1 << 2))
61 #define SYN_MODE_PACKSIZE(m)            ((m) & (1 << 1))
62 #define SYN_MODE_WMODE(m)               ((m) & (1 << 0))
63
64 /* synaptics identify query bits */
65 #define SYN_ID_MODEL(i)                 (((i) >> 4) & 0x0f)
66 #define SYN_ID_MAJOR(i)                 ((i) & 0x0f)
67 #define SYN_ID_MINOR(i)                 (((i) >> 16) & 0xff)
68 #define SYN_ID_IS_SYNAPTICS(i)          ((((i) >> 8) & 0xff) == 0x47)
69
70 /* synaptics special commands */
71 #define SYN_PS_SET_MODE2                0x14
72 #define SYN_PS_CLIENT_CMD               0x28
73
74 /* synaptics packet types */
75 #define SYN_NEWABS                      0
76 #define SYN_NEWABS_STRICT               1
77 #define SYN_NEWABS_RELAXED              2
78 #define SYN_OLDABS                      3
79
80 /*
81  * A structure to describe the state of the touchpad hardware (buttons and pad)
82  */
83
84 struct synaptics_hw_state {
85         int x;
86         int y;
87         int z;
88         int w;
89         unsigned int left:1;
90         unsigned int right:1;
91         unsigned int middle:1;
92         unsigned int up:1;
93         unsigned int down:1;
94         unsigned char ext_buttons;
95         signed char scroll;
96 };
97
98 struct synaptics_data {
99         /* Data read from the touchpad */
100         unsigned long int model_id;             /* Model-ID */
101         unsigned long int capabilities;         /* Capabilities */
102         unsigned long int ext_cap;              /* Extended Capabilities */
103         unsigned long int identity;             /* Identification */
104
105         unsigned char pkt_type;                 /* packet type - old, new, etc */
106         unsigned char mode;                     /* current mode byte */
107         int scroll;
108 };
109
110 #endif /* _SYNAPTICS_H */