xref: /netbsd-src/sys/dev/pckbport/synapticsreg.h (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1 /*	$NetBSD: synapticsreg.h,v 1.8 2014/05/23 01:11:29 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 2005, Steve C. Woodford
5  * Copyright (c) 2004, Ales Krenek
6  * Copyright (c) 2004, Kentaro A. Kurahone
7  * All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  *   * Redistributions of source code must retain the above copyright
14  *     notice, this list of conditions and the following disclaimer.
15  *   * Redistributions in binary form must reproduce the above
16  *     copyright notice, this list of conditions and the following
17  *     disclaimer in the documentation and/or other materials provided
18  *     with the distribution.
19  *   * Neither the name of the Kentaro A. Kurahone nor the names of its
20  *     contributors may be used to endorse or promote products derived
21  *     from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  */
37 
38 #ifndef	_DEV_PCKBCPORT_SYNAPTICSREG_H_
39 #define	_DEV_PCKBCPORT_SYNAPTICSREG_H_
40 
41 /* Synaptics information queries. */
42 #define	SYNAPTICS_IDENTIFY_TOUCHPAD	0x0
43 #define	SYNAPTICS_READ_MODE		0x1
44 #define	SYNAPTICS_READ_CAPABILITIES	0x2
45 #define	SYNAPTICS_READ_MODEL_ID		0x3
46 #define	SYNAPTICS_EXTENDED_QUERY	0x9
47 #define	SYNAPTICS_CONTINUED_CAPABILITIES 0x0c
48 
49 /* Synaptics special commands */
50 #define	SYNAPTICS_CMD_SET_MODE2		0x14
51 #define	SYNAPTICS_CMD_CLIENT_CMD	0x28
52 
53 /* Magic numbers. */
54 #define	SYNAPTICS_MIN_VERSION		45 /* 4.5 */
55 #define	SYNAPTICS_MAGIC_BYTE		0x47
56 
57 /* Capability bits. */
58 #define	SYNAPTICS_CAP_EXTENDED		(1 << 15)
59 #define	SYNAPTICS_CAP_EXTNUM		(1 << 14 | 1 << 13 | 1 << 12)
60 #define	SYNAPTICS_CAP_MBUTTON		(1 << 10)
61 #define	SYNAPTICS_CAP_PASSTHROUGH	(1 << 7)
62 #define	SYNAPTICS_CAP_MULTIFINGERREPORT (1 << 5)
63 #define	SYNAPTICS_CAP_SLEEP		(1 << 4)
64 #define	SYNAPTICS_CAP_4BUTTON		(1 << 3)
65 #define	SYNAPTICS_CAP_MULTIDETECT	(1 << 1)
66 #define	SYNAPTICS_CAP_PALMDETECT	(1 << 0)
67 
68 /* Mode bits. */
69 #define	SYNAPTICS_MODE_ABSOLUTE		(1 << 7)
70 #define	SYNAPTICS_MODE_RATE		(1 << 6)
71 #define	SYNAPTICS_MODE_SLEEP		(1 << 3)
72 #define	SYNAPTICS_MODE_GEST		(1 << 2)
73 #define	SYNAPTICS_MODE_4BYTE_CLIENT	(1 << 1)
74 #define	SYNAPTICS_MODE_W		(1)
75 
76 /* Extended mode button masks. */
77 #define	SYN_1BUTMASK			0x1
78 #define	SYN_2BUTMASK			0x1
79 
80 /* Touchpad edge boundaries (Recommended values from Synaptics documentation) */
81 #define	SYNAPTICS_EDGE_LEFT		1632
82 #define	SYNAPTICS_EDGE_RIGHT		5312
83 #define	SYNAPTICS_EDGE_TOP		4288
84 #define	SYNAPTICS_EDGE_BOTTOM		1568
85 #define	SYNAPTICS_EDGE_MAX		6143
86 
87 /* Finger pressures */
88 #define	SYNAPTICS_FINGER_NONE		0
89 #define	SYNAPTICS_FINGER_HOVER		10
90 #define	SYNAPTICS_FINGER_LIGHT		30
91 #define	SYNAPTICS_FINGER_NORMAL		80
92 #define	SYNAPTICS_FINGER_HEAVY		110
93 #define	SYNAPTICS_FINGER_FLAT		200
94 #define	SYNAPTICS_FINGER_PALM		255
95 
96 /* Width values */
97 #define	SYNAPTICS_WIDTH_TWO_FINGERS	0
98 #define	SYNAPTICS_WIDTH_THREE_OR_MORE	1
99 #define	SYNAPTICS_WIDTH_PEN		2
100 #define	SYNAPTICS_WIDTH_ADVANCEDGESTURE	2
101 #define	SYNAPTICS_WIDTH_PASSTHROUGH	3
102 #define	SYNAPTICS_WIDTH_FINGER_MIN	4
103 #define	SYNAPTICS_WIDTH_FINGER_NORMAL	5
104 #define	SYNAPTICS_WIDTH_FINGER_MAX	7
105 #define	SYNAPTICS_WIDTH_PALM_MIN	8
106 #define	SYNAPTICS_WIDTH_PALM_MAX	14
107 #define	SYNAPTICS_WIDTH_MAX		15
108 
109 #endif	/* _DEV_PCKBCPORT_SYNAPTICSREG_H_ */
110