1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * IBM TrackPoint PS/2 mouse driver 4*4882a593Smuzhiyun * 5*4882a593Smuzhiyun * Stephen Evanchik <evanchsa@gmail.com> 6*4882a593Smuzhiyun */ 7*4882a593Smuzhiyun 8*4882a593Smuzhiyun #ifndef _TRACKPOINT_H 9*4882a593Smuzhiyun #define _TRACKPOINT_H 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun /* 12*4882a593Smuzhiyun * These constants are from the TrackPoint System 13*4882a593Smuzhiyun * Engineering documentation Version 4 from IBM Watson 14*4882a593Smuzhiyun * research: 15*4882a593Smuzhiyun * http://wwwcssrv.almaden.ibm.com/trackpoint/download.html 16*4882a593Smuzhiyun */ 17*4882a593Smuzhiyun 18*4882a593Smuzhiyun #define TP_COMMAND 0xE2 /* Commands start with this */ 19*4882a593Smuzhiyun 20*4882a593Smuzhiyun #define TP_READ_ID 0xE1 /* Sent for device identification */ 21*4882a593Smuzhiyun 22*4882a593Smuzhiyun /* 23*4882a593Smuzhiyun * Valid first byte responses to the "Read Secondary ID" (0xE1) command. 24*4882a593Smuzhiyun * 0x01 was the original IBM trackpoint, others implement very limited 25*4882a593Smuzhiyun * subset of trackpoint features. 26*4882a593Smuzhiyun */ 27*4882a593Smuzhiyun #define TP_VARIANT_IBM 0x01 28*4882a593Smuzhiyun #define TP_VARIANT_ALPS 0x02 29*4882a593Smuzhiyun #define TP_VARIANT_ELAN 0x03 30*4882a593Smuzhiyun #define TP_VARIANT_NXP 0x04 31*4882a593Smuzhiyun #define TP_VARIANT_JYT_SYNAPTICS 0x05 32*4882a593Smuzhiyun #define TP_VARIANT_SYNAPTICS 0x06 33*4882a593Smuzhiyun 34*4882a593Smuzhiyun /* 35*4882a593Smuzhiyun * Commands 36*4882a593Smuzhiyun */ 37*4882a593Smuzhiyun #define TP_RECALIB 0x51 /* Recalibrate */ 38*4882a593Smuzhiyun #define TP_POWER_DOWN 0x44 /* Can only be undone through HW reset */ 39*4882a593Smuzhiyun #define TP_EXT_DEV 0x21 /* Determines if external device is connected (RO) */ 40*4882a593Smuzhiyun #define TP_EXT_BTN 0x4B /* Read extended button status */ 41*4882a593Smuzhiyun #define TP_POR 0x7F /* Execute Power on Reset */ 42*4882a593Smuzhiyun #define TP_POR_RESULTS 0x25 /* Read Power on Self test results */ 43*4882a593Smuzhiyun #define TP_DISABLE_EXT 0x40 /* Disable external pointing device */ 44*4882a593Smuzhiyun #define TP_ENABLE_EXT 0x41 /* Enable external pointing device */ 45*4882a593Smuzhiyun 46*4882a593Smuzhiyun /* 47*4882a593Smuzhiyun * Mode manipulation 48*4882a593Smuzhiyun */ 49*4882a593Smuzhiyun #define TP_SET_SOFT_TRANS 0x4E /* Set mode */ 50*4882a593Smuzhiyun #define TP_CANCEL_SOFT_TRANS 0xB9 /* Cancel mode */ 51*4882a593Smuzhiyun #define TP_SET_HARD_TRANS 0x45 /* Mode can only be set */ 52*4882a593Smuzhiyun 53*4882a593Smuzhiyun 54*4882a593Smuzhiyun /* 55*4882a593Smuzhiyun * Register oriented commands/properties 56*4882a593Smuzhiyun */ 57*4882a593Smuzhiyun #define TP_WRITE_MEM 0x81 58*4882a593Smuzhiyun #define TP_READ_MEM 0x80 /* Not used in this implementation */ 59*4882a593Smuzhiyun 60*4882a593Smuzhiyun /* 61*4882a593Smuzhiyun * RAM Locations for properties 62*4882a593Smuzhiyun */ 63*4882a593Smuzhiyun #define TP_SENS 0x4A /* Sensitivity */ 64*4882a593Smuzhiyun #define TP_MB 0x4C /* Read Middle Button Status (RO) */ 65*4882a593Smuzhiyun #define TP_INERTIA 0x4D /* Negative Inertia */ 66*4882a593Smuzhiyun #define TP_SPEED 0x60 /* Speed of TP Cursor */ 67*4882a593Smuzhiyun #define TP_REACH 0x57 /* Backup for Z-axis press */ 68*4882a593Smuzhiyun #define TP_DRAGHYS 0x58 /* Drag Hysteresis */ 69*4882a593Smuzhiyun /* (how hard it is to drag */ 70*4882a593Smuzhiyun /* with Z-axis pressed) */ 71*4882a593Smuzhiyun 72*4882a593Smuzhiyun #define TP_MINDRAG 0x59 /* Minimum amount of force needed */ 73*4882a593Smuzhiyun /* to trigger dragging */ 74*4882a593Smuzhiyun 75*4882a593Smuzhiyun #define TP_THRESH 0x5C /* Minimum value for a Z-axis press */ 76*4882a593Smuzhiyun #define TP_UP_THRESH 0x5A /* Used to generate a 'click' on Z-axis */ 77*4882a593Smuzhiyun #define TP_Z_TIME 0x5E /* How sharp of a press */ 78*4882a593Smuzhiyun #define TP_JENKS_CURV 0x5D /* Minimum curvature for double click */ 79*4882a593Smuzhiyun #define TP_DRIFT_TIME 0x5F /* How long a 'hands off' condition */ 80*4882a593Smuzhiyun /* must last (x*107ms) for drift */ 81*4882a593Smuzhiyun /* correction to occur */ 82*4882a593Smuzhiyun 83*4882a593Smuzhiyun /* 84*4882a593Smuzhiyun * Toggling Flag bits 85*4882a593Smuzhiyun */ 86*4882a593Smuzhiyun #define TP_TOGGLE 0x47 /* Toggle command */ 87*4882a593Smuzhiyun 88*4882a593Smuzhiyun #define TP_TOGGLE_MB 0x23 /* Disable/Enable Middle Button */ 89*4882a593Smuzhiyun #define TP_MASK_MB 0x01 90*4882a593Smuzhiyun #define TP_TOGGLE_EXT_DEV 0x23 /* Disable external device */ 91*4882a593Smuzhiyun #define TP_MASK_EXT_DEV 0x02 92*4882a593Smuzhiyun #define TP_TOGGLE_DRIFT 0x23 /* Drift Correction */ 93*4882a593Smuzhiyun #define TP_MASK_DRIFT 0x80 94*4882a593Smuzhiyun #define TP_TOGGLE_BURST 0x28 /* Burst Mode */ 95*4882a593Smuzhiyun #define TP_MASK_BURST 0x80 96*4882a593Smuzhiyun #define TP_TOGGLE_PTSON 0x2C /* Press to Select */ 97*4882a593Smuzhiyun #define TP_MASK_PTSON 0x01 98*4882a593Smuzhiyun #define TP_TOGGLE_HARD_TRANS 0x2C /* Alternate method to set Hard Transparency */ 99*4882a593Smuzhiyun #define TP_MASK_HARD_TRANS 0x80 100*4882a593Smuzhiyun #define TP_TOGGLE_TWOHAND 0x2D /* Two handed */ 101*4882a593Smuzhiyun #define TP_MASK_TWOHAND 0x01 102*4882a593Smuzhiyun #define TP_TOGGLE_STICKY_TWO 0x2D /* Sticky two handed */ 103*4882a593Smuzhiyun #define TP_MASK_STICKY_TWO 0x04 104*4882a593Smuzhiyun #define TP_TOGGLE_SKIPBACK 0x2D /* Suppress movement after drag release */ 105*4882a593Smuzhiyun #define TP_MASK_SKIPBACK 0x08 106*4882a593Smuzhiyun #define TP_TOGGLE_SOURCE_TAG 0x20 /* Bit 3 of the first packet will be set to 107*4882a593Smuzhiyun to the origin of the packet (external or TP) */ 108*4882a593Smuzhiyun #define TP_MASK_SOURCE_TAG 0x80 109*4882a593Smuzhiyun #define TP_TOGGLE_EXT_TAG 0x22 /* Bit 3 of the first packet coming from the 110*4882a593Smuzhiyun external device will be forced to 1 */ 111*4882a593Smuzhiyun #define TP_MASK_EXT_TAG 0x04 112*4882a593Smuzhiyun 113*4882a593Smuzhiyun 114*4882a593Smuzhiyun /* Power on Self Test Results */ 115*4882a593Smuzhiyun #define TP_POR_SUCCESS 0x3B 116*4882a593Smuzhiyun 117*4882a593Smuzhiyun /* 118*4882a593Smuzhiyun * Default power on values 119*4882a593Smuzhiyun */ 120*4882a593Smuzhiyun #define TP_DEF_SENS 0x80 121*4882a593Smuzhiyun #define TP_DEF_INERTIA 0x06 122*4882a593Smuzhiyun #define TP_DEF_SPEED 0x61 123*4882a593Smuzhiyun #define TP_DEF_REACH 0x0A 124*4882a593Smuzhiyun 125*4882a593Smuzhiyun #define TP_DEF_DRAGHYS 0xFF 126*4882a593Smuzhiyun #define TP_DEF_MINDRAG 0x14 127*4882a593Smuzhiyun 128*4882a593Smuzhiyun #define TP_DEF_THRESH 0x08 129*4882a593Smuzhiyun #define TP_DEF_UP_THRESH 0xFF 130*4882a593Smuzhiyun #define TP_DEF_Z_TIME 0x26 131*4882a593Smuzhiyun #define TP_DEF_JENKS_CURV 0x87 132*4882a593Smuzhiyun #define TP_DEF_DRIFT_TIME 0x05 133*4882a593Smuzhiyun 134*4882a593Smuzhiyun /* Toggles */ 135*4882a593Smuzhiyun #define TP_DEF_MB 0x00 136*4882a593Smuzhiyun #define TP_DEF_PTSON 0x00 137*4882a593Smuzhiyun #define TP_DEF_SKIPBACK 0x00 138*4882a593Smuzhiyun #define TP_DEF_EXT_DEV 0x00 /* 0 means enabled */ 139*4882a593Smuzhiyun #define TP_DEF_TWOHAND 0x00 140*4882a593Smuzhiyun #define TP_DEF_SOURCE_TAG 0x00 141*4882a593Smuzhiyun 142*4882a593Smuzhiyun #define MAKE_PS2_CMD(params, results, cmd) ((params<<12) | (results<<8) | (cmd)) 143*4882a593Smuzhiyun 144*4882a593Smuzhiyun struct trackpoint_data { 145*4882a593Smuzhiyun u8 variant_id; 146*4882a593Smuzhiyun u8 firmware_id; 147*4882a593Smuzhiyun 148*4882a593Smuzhiyun u8 sensitivity, speed, inertia, reach; 149*4882a593Smuzhiyun u8 draghys, mindrag; 150*4882a593Smuzhiyun u8 thresh, upthresh; 151*4882a593Smuzhiyun u8 ztime, jenks; 152*4882a593Smuzhiyun u8 drift_time; 153*4882a593Smuzhiyun 154*4882a593Smuzhiyun /* toggles */ 155*4882a593Smuzhiyun bool press_to_select; 156*4882a593Smuzhiyun bool skipback; 157*4882a593Smuzhiyun bool ext_dev; 158*4882a593Smuzhiyun }; 159*4882a593Smuzhiyun 160*4882a593Smuzhiyun int trackpoint_detect(struct psmouse *psmouse, bool set_properties); 161*4882a593Smuzhiyun 162*4882a593Smuzhiyun #endif /* _TRACKPOINT_H */ 163