/*
 * IBM TrackPoint PS/2 mouse driver
 *
 * Stephen Evanchik <evanchsa@clarkson.edu>
 *
 * 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_DISABLE	(0xF5)
#define TP_ENABLE	(0xF4)

#define TP_READ_ID	(0xE1)	/* Sent for device identification */
#define TP_MAGIC_IDENT	(0x01)	/* Sent after a TP_READ_ID followed */
				/* by the firmware ID */
													
#define TP_COMMAND	(0xE2)	/* Commands start with this */


/*
 * 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 */

/*
 * Mode manipulation
 */
#define TP_SET_SOFT_TRANS (0x4E) /* Set mode */
#define TP_CAN_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_NEG_INERT	(0x4D)	/* Negative Inertia */
#define TP_SPEED	(0x60)	/* Speed of TP Cursor */
#define TP_BACKUP	(0x57)	/* Backup for Z-axis press */
#define TP_DRAG_HYST	(0x58)	/* Drag Hysteresis */
				/* (how hard it is to drag */
				/* with Z-axis pressed) */

#define TP_MIN_DRAG	(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 */

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

#define TP_TOGGLE_MB		(0x23)	/* Disable/Enable Middle Button */
#define TP_TOGGLE_DRIFT		(0x23)	/* Drift Correction */
#define TP_TOGGLE_BURST		(0x28)	/* Burst Mode */
#define TP_TOGGLE_PTS		(0x2C)	/* Press to Select */
#define TP_TOGGLE_HARD_TRANS	(0x2C)	/* Alternate method to set Hard Transparency */
#define TP_TOGGLE_TWOHAND	(0x2D)	/* Two handed */
#define TP_TOGGLE_STICKY_TWO	(0x2D)	/* Sticky two handed */
#define TP_TOGGLE_SKIP_BACK	(0x2D)	/* Suppress movement */
					/* after drag release */

/*
 * Various makses for registers 
 * XOR'd to current contents for new value
 */
#define TP_MASK_PTS		(0x01)
#define TP_MASK_SKIP_BACK	(0x08)
#define TP_MASK_TWOHAND		(0x01)
#define TP_MASK_STICKY_TWO	(0x04)
#define TP_MASK_HARD_TRANS	(0x80)
#define TP_MASK_BURST		(0x80)
#define TP_MASK_MB		(0x01)
#define TP_MASK_DRIFT		(0x80)

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

/*
 * Default power on values
 */
#define TP_DEF_SENS	(0x80)
#define TP_DEF_NEG_INT	(0x06)
#define TP_DEF_SPEED	(0x61)
#define TP_DEF_BACKUP	(0x0A)

#define TP_DEF_DRAG_HYST (0xFF)
#define TP_DEF_MIN_DRAG	 (0x14)

#define TP_DEF_THRESH     (0x08)
#define TP_DEF_UP_THRESH  (0xFF)
#define TP_DEF_Z_TIME     (0x26)
#define TP_DEF_JENKS_CURV (0x87)

/* Toggles */
#define TP_DEF_MB	 (0x00)
#define TP_DEF_PTS	 (0x00)
#define TP_DEF_SKIP_BACK (0x00)

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

enum
{ TP_SOFT_TRANS, TP_HARD_TRANS };

struct trackpoint_data
{
	unsigned char firmware_id;

	unsigned char mode;	/* Transparency mode */

	unsigned char sens, speed, inertia, reach;
	unsigned char draghys, mindrag;
	unsigned char thresh, up_thresh;
	unsigned char z_time, jenks_curv;

	unsigned char ptson; /* Press to Select */
	unsigned char twohand, skipback;
	unsigned char mb;
};

extern int trackpoint_init (struct psmouse *psmouse);


#endif /* _TRACKPOINT_H */