[mirror_ubuntu-artful-kernel.git] / drivers / input / mouse / trackpoint.h

/*
 * IBM TrackPoint PS/2 mouse driver
 *
 * Stephen Evanchik <evanchsa@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 */

#ifndef _TRACKPOINT_H
#define _TRACKPOINT_H

/*
 * These constants are from the TrackPoint System
 * Engineering documentation Version 4 from IBM Watson
 * research:
 *	http://wwwcssrv.almaden.ibm.com/trackpoint/download.html
 */

#define TP_COMMAND		0xE2	/* Commands start with this */

#define TP_READ_ID		0xE1	/* Sent for device identification */
#define TP_MAGIC_IDENT		0x03	/* Sent after a TP_READ_ID followed */
					/* by the firmware ID */
					/* Firmware ID includes 0x1, 0x2, 0x3 */


/*
 * Commands
 */
#define TP_RECALIB		0x51	/* Recalibrate */
#define TP_POWER_DOWN		0x44	/* Can only be undone through HW reset */
#define TP_EXT_DEV		0x21	/* Determines if external device is connected (RO) */
#define TP_EXT_BTN		0x4B	/* Read extended button status */
#define TP_POR			0x7F	/* Execute Power on Reset */
#define TP_POR_RESULTS		0x25	/* Read Power on Self test results */
#define TP_DISABLE_EXT		0x40	/* Disable external pointing device */
#define TP_ENABLE_EXT		0x41	/* Enable external pointing device */

/*
 * Mode manipulation
 */
#define TP_SET_SOFT_TRANS	0x4E	/* Set mode */
#define TP_CANCEL_SOFT_TRANS	0xB9	/* Cancel mode */
#define TP_SET_HARD_TRANS	0x45	/* Mode can only be set */


/*
 * Register oriented commands/properties
 */
#define TP_WRITE_MEM		0x81
#define TP_READ_MEM		0x80	/* Not used in this implementation */

/*
* RAM Locations for properties
 */
#define TP_SENS			0x4A	/* Sensitivity */
#define TP_MB			0x4C	/* Read Middle Button Status (RO) */
#define TP_INERTIA		0x4D	/* Negative Inertia */
#define TP_SPEED		0x60	/* Speed of TP Cursor */
#define TP_REACH		0x57	/* Backup for Z-axis press */
#define TP_DRAGHYS		0x58	/* Drag Hysteresis */
					/* (how hard it is to drag */
					/* with Z-axis pressed) */

#define TP_MINDRAG		0x59	/* Minimum amount of force needed */
					/* to trigger dragging */

#define TP_THRESH		0x5C	/* Minimum value for a Z-axis press */
#define TP_UP_THRESH		0x5A	/* Used to generate a 'click' on Z-axis */
#define TP_Z_TIME		0x5E	/* How sharp of a press */
#define TP_JENKS_CURV		0x5D	/* Minimum curvature for double click */
#define TP_DRIFT_TIME		0x5F	/* How long a 'hands off' condition */
					/* must last (x*107ms) for drift */
					/* correction to occur */

/*
 * Toggling Flag bits
 */
#define TP_TOGGLE		0x47	/* Toggle command */

#define TP_TOGGLE_MB		0x23	/* Disable/Enable Middle Button */
#define TP_MASK_MB			0x01
#define TP_TOGGLE_EXT_DEV	0x23	/* Disable external device */
#define TP_MASK_EXT_DEV			0x02
#define TP_TOGGLE_DRIFT		0x23	/* Drift Correction */
#define TP_MASK_DRIFT			0x80
#define TP_TOGGLE_BURST		0x28	/* Burst Mode */
#define TP_MASK_BURST			0x80
#define TP_TOGGLE_PTSON		0x2C	/* Press to Select */
#define TP_MASK_PTSON			0x01
#define TP_TOGGLE_HARD_TRANS	0x2C	/* Alternate method to set Hard Transparency */
#define TP_MASK_HARD_TRANS		0x80
#define TP_TOGGLE_TWOHAND	0x2D	/* Two handed */
#define TP_MASK_TWOHAND			0x01
#define TP_TOGGLE_STICKY_TWO	0x2D	/* Sticky two handed */
#define TP_MASK_STICKY_TWO		0x04
#define TP_TOGGLE_SKIPBACK	0x2D	/* Suppress movement after drag release */
#define TP_MASK_SKIPBACK		0x08
#define TP_TOGGLE_SOURCE_TAG	0x20	/* Bit 3 of the first packet will be set to
					   to the origin of the packet (external or TP) */
#define TP_MASK_SOURCE_TAG		0x80
#define TP_TOGGLE_EXT_TAG	0x22	/* Bit 3 of the first packet coming from the
					   external device will be forced to 1 */
#define TP_MASK_EXT_TAG			0x04


/* Power on Self Test Results */
#define TP_POR_SUCCESS		0x3B

/*
 * Default power on values
 */
#define TP_DEF_SENS		0x80
#define TP_DEF_INERTIA		0x06
#define TP_DEF_SPEED		0x61
#define TP_DEF_REACH		0x0A

#define TP_DEF_DRAGHYS		0xFF
#define TP_DEF_MINDRAG		0x14

#define TP_DEF_THRESH		0x08
#define TP_DEF_UP_THRESH	0xFF
#define TP_DEF_Z_TIME		0x26
#define TP_DEF_JENKS_CURV	0x87
#define TP_DEF_DRIFT_TIME	0x05

/* Toggles */
#define TP_DEF_MB		0x00
#define TP_DEF_PTSON		0x00
#define TP_DEF_SKIPBACK		0x00
#define TP_DEF_EXT_DEV		0x00	/* 0 means enabled */
#define TP_DEF_TWOHAND		0x00
#define TP_DEF_SOURCE_TAG	0x00

#define MAKE_PS2_CMD(params, results, cmd) ((params<<12) | (results<<8) | (cmd))

struct trackpoint_data
{
	unsigned char sensitivity, speed, inertia, reach;
	unsigned char draghys, mindrag;
	unsigned char thresh, upthresh;
	unsigned char ztime, jenks;
	unsigned char drift_time;

	/* toggles */
	unsigned char press_to_select;
	unsigned char skipback;
	unsigned char ext_dev;
};

#ifdef CONFIG_MOUSE_PS2_TRACKPOINT
int trackpoint_detect(struct psmouse *psmouse, bool set_properties);
#else
inline int trackpoint_detect(struct psmouse *psmouse, bool set_properties)
{
	return -ENOSYS;
}
#endif /* CONFIG_MOUSE_PS2_TRACKPOINT */

#endif /* _TRACKPOINT_H */
Commit	Line	Data
541e316a SE	1	/*
	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 */
ec667683	24	#define TP_MAGIC_IDENT 0x03 /* Sent after a TP_READ_ID followed */
541e316a	25	/* by the firmware ID */
ec667683	26	/* Firmware ID includes 0x1, 0x2, 0x3 */
541e316a SE	27
	28
	29	/*
	30	* Commands
	31	*/
	32	#define TP_RECALIB 0x51 /* Recalibrate */
	33	#define TP_POWER_DOWN 0x44 /* Can only be undone through HW reset */
	34	#define TP_EXT_DEV 0x21 /* Determines if external device is connected (RO) */
	35	#define TP_EXT_BTN 0x4B /* Read extended button status */
	36	#define TP_POR 0x7F /* Execute Power on Reset */
	37	#define TP_POR_RESULTS 0x25 /* Read Power on Self test results */
	38	#define TP_DISABLE_EXT 0x40 /* Disable external pointing device */
	39	#define TP_ENABLE_EXT 0x41 /* Enable external pointing device */
	40
	41	/*
	42	* Mode manipulation
	43	*/
	44	#define TP_SET_SOFT_TRANS 0x4E /* Set mode */
	45	#define TP_CANCEL_SOFT_TRANS 0xB9 /* Cancel mode */
	46	#define TP_SET_HARD_TRANS 0x45 /* Mode can only be set */
	47
	48
	49	/*
	50	* Register oriented commands/properties
	51	*/
	52	#define TP_WRITE_MEM 0x81
	53	#define TP_READ_MEM 0x80 /* Not used in this implementation */
	54
	55	/*
	56	* RAM Locations for properties
	57	*/
	58	#define TP_SENS 0x4A /* Sensitivity */
	59	#define TP_MB 0x4C /* Read Middle Button Status (RO) */
	60	#define TP_INERTIA 0x4D /* Negative Inertia */
	61	#define TP_SPEED 0x60 /* Speed of TP Cursor */
	62	#define TP_REACH 0x57 /* Backup for Z-axis press */
	63	#define TP_DRAGHYS 0x58 /* Drag Hysteresis */
	64	/* (how hard it is to drag */
	65	/* with Z-axis pressed) */
	66
	67	#define TP_MINDRAG 0x59 /* Minimum amount of force needed */
	68	/* to trigger dragging */
	69
	70	#define TP_THRESH 0x5C /* Minimum value for a Z-axis press */
	71	#define TP_UP_THRESH 0x5A /* Used to generate a 'click' on Z-axis */
	72	#define TP_Z_TIME 0x5E /* How sharp of a press */
	73	#define TP_JENKS_CURV 0x5D /* Minimum curvature for double click */
2ba35320	74	#define TP_DRIFT_TIME 0x5F /* How long a 'hands off' condition */
	75	/* must last (x107ms) for drift /
	76	/* correction to occur */
541e316a SE	77
	78	/*
	79	* Toggling Flag bits
	80	*/
	81	#define TP_TOGGLE 0x47 /* Toggle command */
	82
	83	#define TP_TOGGLE_MB 0x23 /* Disable/Enable Middle Button */
	84	#define TP_MASK_MB 0x01
b8044c74	85	#define TP_TOGGLE_EXT_DEV 0x23 /* Disable external device */
541e316a SE	86	#define TP_MASK_EXT_DEV 0x02
	87	#define TP_TOGGLE_DRIFT 0x23 /* Drift Correction */
	88	#define TP_MASK_DRIFT 0x80
	89	#define TP_TOGGLE_BURST 0x28 /* Burst Mode */
	90	#define TP_MASK_BURST 0x80
	91	#define TP_TOGGLE_PTSON 0x2C /* Press to Select */
	92	#define TP_MASK_PTSON 0x01
	93	#define TP_TOGGLE_HARD_TRANS 0x2C /* Alternate method to set Hard Transparency */
	94	#define TP_MASK_HARD_TRANS 0x80
	95	#define TP_TOGGLE_TWOHAND 0x2D /* Two handed */
	96	#define TP_MASK_TWOHAND 0x01
	97	#define TP_TOGGLE_STICKY_TWO 0x2D /* Sticky two handed */
	98	#define TP_MASK_STICKY_TWO 0x04
	99	#define TP_TOGGLE_SKIPBACK 0x2D /* Suppress movement after drag release */
	100	#define TP_MASK_SKIPBACK 0x08
	101	#define TP_TOGGLE_SOURCE_TAG 0x20 /* Bit 3 of the first packet will be set to
	102	to the origin of the packet (external or TP) */
	103	#define TP_MASK_SOURCE_TAG 0x80
	104	#define TP_TOGGLE_EXT_TAG 0x22 /* Bit 3 of the first packet coming from the
	105	external device will be forced to 1 */
	106	#define TP_MASK_EXT_TAG 0x04
	107
	108
	109	/* Power on Self Test Results */
	110	#define TP_POR_SUCCESS 0x3B
	111
	112	/*
	113	* Default power on values
	114	*/
	115	#define TP_DEF_SENS 0x80
	116	#define TP_DEF_INERTIA 0x06
	117	#define TP_DEF_SPEED 0x61
	118	#define TP_DEF_REACH 0x0A
	119
	120	#define TP_DEF_DRAGHYS 0xFF
	121	#define TP_DEF_MINDRAG 0x14
	122
	123	#define TP_DEF_THRESH 0x08
	124	#define TP_DEF_UP_THRESH 0xFF
	125	#define TP_DEF_Z_TIME 0x26
	126	#define TP_DEF_JENKS_CURV 0x87
2ba35320	127	#define TP_DEF_DRIFT_TIME 0x05
541e316a SE	128
	129	/* Toggles */
	130	#define TP_DEF_MB 0x00
	131	#define TP_DEF_PTSON 0x00
	132	#define TP_DEF_SKIPBACK 0x00
b8044c74	133	#define TP_DEF_EXT_DEV 0x00 /* 0 means enabled */
0c6a6165 SN	134	#define TP_DEF_TWOHAND 0x00
0c6a6165 SN	135	#define TP_DEF_SOURCE_TAG 0x00
541e316a SE	136
	137	#define MAKE_PS2_CMD(params, results, cmd) ((params<<12) \| (results<<8) \| (cmd))
	138
	139	struct trackpoint_data
	140	{
	141	unsigned char sensitivity, speed, inertia, reach;
	142	unsigned char draghys, mindrag;
	143	unsigned char thresh, upthresh;
	144	unsigned char ztime, jenks;
2ba35320	145	unsigned char drift_time;
541e316a	146
0c6a6165	147	/* toggles */
541e316a SE	148	unsigned char press_to_select;
541e316a SE	149	unsigned char skipback;
541e316a SE	150	unsigned char ext_dev;
	151	};
	152
55e3d922	153	#ifdef CONFIG_MOUSE_PS2_TRACKPOINT
b7802c5c	154	int trackpoint_detect(struct psmouse *psmouse, bool set_properties);
55e3d922	155	#else
b7802c5c	156	inline int trackpoint_detect(struct psmouse *psmouse, bool set_properties)
55e3d922 AS	157	{
	158	return -ENOSYS;
	159	}
	160	#endif /* CONFIG_MOUSE_PS2_TRACKPOINT */
541e316a SE	161
541e316a SE	162	#endif /* _TRACKPOINT_H */