blob: 5617ed3a7d7a15d0f9769086afb8c740b5739fcc [file] [log] [blame]
Stephen Evanchik541e3162005-08-08 01:26:18 -05001/*
2 * IBM TrackPoint PS/2 mouse driver
3 *
4 * Stephen Evanchik <evanchsa@gmail.com>
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 as published by
8 * the Free Software Foundation.
9 */
10
11#ifndef _TRACKPOINT_H
12#define _TRACKPOINT_H
13
14/*
15 * These constants are from the TrackPoint System
16 * Engineering documentation Version 4 from IBM Watson
17 * research:
18 * http://wwwcssrv.almaden.ibm.com/trackpoint/download.html
19 */
20
21#define TP_COMMAND 0xE2 /* Commands start with this */
22
23#define TP_READ_ID 0xE1 /* Sent for device identification */
24#define TP_MAGIC_IDENT 0x01 /* Sent after a TP_READ_ID followed */
25 /* by the firmware ID */
26
27
28/*
29 * Commands
30 */
31#define TP_RECALIB 0x51 /* Recalibrate */
32#define TP_POWER_DOWN 0x44 /* Can only be undone through HW reset */
33#define TP_EXT_DEV 0x21 /* Determines if external device is connected (RO) */
34#define TP_EXT_BTN 0x4B /* Read extended button status */
35#define TP_POR 0x7F /* Execute Power on Reset */
36#define TP_POR_RESULTS 0x25 /* Read Power on Self test results */
37#define TP_DISABLE_EXT 0x40 /* Disable external pointing device */
38#define TP_ENABLE_EXT 0x41 /* Enable external pointing device */
39
40/*
41 * Mode manipulation
42 */
43#define TP_SET_SOFT_TRANS 0x4E /* Set mode */
44#define TP_CANCEL_SOFT_TRANS 0xB9 /* Cancel mode */
45#define TP_SET_HARD_TRANS 0x45 /* Mode can only be set */
46
47
48/*
49 * Register oriented commands/properties
50 */
51#define TP_WRITE_MEM 0x81
52#define TP_READ_MEM 0x80 /* Not used in this implementation */
53
54/*
55* RAM Locations for properties
56 */
57#define TP_SENS 0x4A /* Sensitivity */
58#define TP_MB 0x4C /* Read Middle Button Status (RO) */
59#define TP_INERTIA 0x4D /* Negative Inertia */
60#define TP_SPEED 0x60 /* Speed of TP Cursor */
61#define TP_REACH 0x57 /* Backup for Z-axis press */
62#define TP_DRAGHYS 0x58 /* Drag Hysteresis */
63 /* (how hard it is to drag */
64 /* with Z-axis pressed) */
65
66#define TP_MINDRAG 0x59 /* Minimum amount of force needed */
67 /* to trigger dragging */
68
69#define TP_THRESH 0x5C /* Minimum value for a Z-axis press */
70#define TP_UP_THRESH 0x5A /* Used to generate a 'click' on Z-axis */
71#define TP_Z_TIME 0x5E /* How sharp of a press */
72#define TP_JENKS_CURV 0x5D /* Minimum curvature for double click */
haarp2ba35322014-12-17 15:22:08 -080073#define TP_DRIFT_TIME 0x5F /* How long a 'hands off' condition */
74 /* must last (x*107ms) for drift */
75 /* correction to occur */
Stephen Evanchik541e3162005-08-08 01:26:18 -050076
77/*
78 * Toggling Flag bits
79 */
80#define TP_TOGGLE 0x47 /* Toggle command */
81
82#define TP_TOGGLE_MB 0x23 /* Disable/Enable Middle Button */
83#define TP_MASK_MB 0x01
Dmitry Torokhovb8044c72006-02-15 00:49:09 -050084#define TP_TOGGLE_EXT_DEV 0x23 /* Disable external device */
Stephen Evanchik541e3162005-08-08 01:26:18 -050085#define TP_MASK_EXT_DEV 0x02
86#define TP_TOGGLE_DRIFT 0x23 /* Drift Correction */
87#define TP_MASK_DRIFT 0x80
88#define TP_TOGGLE_BURST 0x28 /* Burst Mode */
89#define TP_MASK_BURST 0x80
90#define TP_TOGGLE_PTSON 0x2C /* Press to Select */
91#define TP_MASK_PTSON 0x01
92#define TP_TOGGLE_HARD_TRANS 0x2C /* Alternate method to set Hard Transparency */
93#define TP_MASK_HARD_TRANS 0x80
94#define TP_TOGGLE_TWOHAND 0x2D /* Two handed */
95#define TP_MASK_TWOHAND 0x01
96#define TP_TOGGLE_STICKY_TWO 0x2D /* Sticky two handed */
97#define TP_MASK_STICKY_TWO 0x04
98#define TP_TOGGLE_SKIPBACK 0x2D /* Suppress movement after drag release */
99#define TP_MASK_SKIPBACK 0x08
100#define TP_TOGGLE_SOURCE_TAG 0x20 /* Bit 3 of the first packet will be set to
101 to the origin of the packet (external or TP) */
102#define TP_MASK_SOURCE_TAG 0x80
103#define TP_TOGGLE_EXT_TAG 0x22 /* Bit 3 of the first packet coming from the
104 external device will be forced to 1 */
105#define TP_MASK_EXT_TAG 0x04
106
107
108/* Power on Self Test Results */
109#define TP_POR_SUCCESS 0x3B
110
111/*
112 * Default power on values
113 */
114#define TP_DEF_SENS 0x80
115#define TP_DEF_INERTIA 0x06
116#define TP_DEF_SPEED 0x61
117#define TP_DEF_REACH 0x0A
118
119#define TP_DEF_DRAGHYS 0xFF
120#define TP_DEF_MINDRAG 0x14
121
122#define TP_DEF_THRESH 0x08
123#define TP_DEF_UP_THRESH 0xFF
124#define TP_DEF_Z_TIME 0x26
125#define TP_DEF_JENKS_CURV 0x87
haarp2ba35322014-12-17 15:22:08 -0800126#define TP_DEF_DRIFT_TIME 0x05
Stephen Evanchik541e3162005-08-08 01:26:18 -0500127
128/* Toggles */
129#define TP_DEF_MB 0x00
130#define TP_DEF_PTSON 0x00
131#define TP_DEF_SKIPBACK 0x00
Dmitry Torokhovb8044c72006-02-15 00:49:09 -0500132#define TP_DEF_EXT_DEV 0x00 /* 0 means enabled */
Shawn Nematbakhsh0c6a6162013-04-15 13:49:34 -0700133#define TP_DEF_TWOHAND 0x00
134#define TP_DEF_SOURCE_TAG 0x00
Stephen Evanchik541e3162005-08-08 01:26:18 -0500135
136#define MAKE_PS2_CMD(params, results, cmd) ((params<<12) | (results<<8) | (cmd))
137
138struct trackpoint_data
139{
140 unsigned char sensitivity, speed, inertia, reach;
141 unsigned char draghys, mindrag;
142 unsigned char thresh, upthresh;
143 unsigned char ztime, jenks;
haarp2ba35322014-12-17 15:22:08 -0800144 unsigned char drift_time;
Stephen Evanchik541e3162005-08-08 01:26:18 -0500145
Shawn Nematbakhsh0c6a6162013-04-15 13:49:34 -0700146 /* toggles */
Stephen Evanchik541e3162005-08-08 01:26:18 -0500147 unsigned char press_to_select;
148 unsigned char skipback;
Stephen Evanchik541e3162005-08-08 01:26:18 -0500149 unsigned char ext_dev;
150};
151
Andres Salomon55e3d922007-03-10 01:39:54 -0500152#ifdef CONFIG_MOUSE_PS2_TRACKPOINT
Dmitry Torokhovb7802c52009-09-09 19:13:20 -0700153int trackpoint_detect(struct psmouse *psmouse, bool set_properties);
Andres Salomon55e3d922007-03-10 01:39:54 -0500154#else
Dmitry Torokhovb7802c52009-09-09 19:13:20 -0700155inline int trackpoint_detect(struct psmouse *psmouse, bool set_properties)
Andres Salomon55e3d922007-03-10 01:39:54 -0500156{
157 return -ENOSYS;
158}
159#endif /* CONFIG_MOUSE_PS2_TRACKPOINT */
Stephen Evanchik541e3162005-08-08 01:26:18 -0500160
161#endif /* _TRACKPOINT_H */