11da177e4SLinus Torvalds /* 21da177e4SLinus Torvalds * ALPS touchpad PS/2 mouse driver 31da177e4SLinus Torvalds * 41da177e4SLinus Torvalds * Copyright (c) 2003 Peter Osterlund <petero2@telia.com> 51da177e4SLinus Torvalds * Copyright (c) 2005 Vojtech Pavlik <vojtech@suse.cz> 61da177e4SLinus Torvalds * 71da177e4SLinus Torvalds * This program is free software; you can redistribute it and/or modify it 81da177e4SLinus Torvalds * under the terms of the GNU General Public License version 2 as published by 91da177e4SLinus Torvalds * the Free Software Foundation. 101da177e4SLinus Torvalds */ 111da177e4SLinus Torvalds 121da177e4SLinus Torvalds #ifndef _ALPS_H 131da177e4SLinus Torvalds #define _ALPS_H 141da177e4SLinus Torvalds 1502d04254SHans de Goede #include <linux/input/mt.h> 1602d04254SHans de Goede 17d7c13d34SDmitry Torokhov #define ALPS_PROTO_V1 0x100 18d7c13d34SDmitry Torokhov #define ALPS_PROTO_V2 0x200 19d7c13d34SDmitry Torokhov #define ALPS_PROTO_V3 0x300 20fb2dd7a6SDmitry Torokhov #define ALPS_PROTO_V3_RUSHMORE 0x310 21d7c13d34SDmitry Torokhov #define ALPS_PROTO_V4 0x400 22d7c13d34SDmitry Torokhov #define ALPS_PROTO_V5 0x500 23d7c13d34SDmitry Torokhov #define ALPS_PROTO_V6 0x600 24d7c13d34SDmitry Torokhov #define ALPS_PROTO_V7 0x700 /* t3btl t4s */ 253db5b9f7SMasaki Ota #define ALPS_PROTO_V8 0x800 /* SS4btl SS4s */ 26*c9815232SPali Rohár #define ALPS_PROTO_V9 0x900 /* ss3btl */ 27fa629ef5SSeth Forshee 283db5b9f7SMasaki Ota #define MAX_TOUCHES 4 2902d04254SHans de Goede 30ee65d4b3SYunkang Tang #define DOLPHIN_COUNT_PER_ELECTRODE 64 31ee65d4b3SYunkang Tang #define DOLPHIN_PROFILE_XOFFSET 8 /* x-electrode offset */ 32ee65d4b3SYunkang Tang #define DOLPHIN_PROFILE_YOFFSET 1 /* y-electrode offset */ 33ee65d4b3SYunkang Tang 343808843cSYunkang Tang /* 353db5b9f7SMasaki Ota * enum SS4_PACKET_ID - defines the packet type for V8 363db5b9f7SMasaki Ota * SS4_PACKET_ID_IDLE: There's no finger and no button activity. 373db5b9f7SMasaki Ota * SS4_PACKET_ID_ONE: There's one finger on touchpad 383db5b9f7SMasaki Ota * or there's button activities. 393db5b9f7SMasaki Ota * SS4_PACKET_ID_TWO: There's two or more fingers on touchpad 403db5b9f7SMasaki Ota * SS4_PACKET_ID_MULTI: There's three or more fingers on touchpad 414777ac22SBen Gamari * SS4_PACKET_ID_STICK: A stick pointer packet 423db5b9f7SMasaki Ota */ 433db5b9f7SMasaki Ota enum SS4_PACKET_ID { 443db5b9f7SMasaki Ota SS4_PACKET_ID_IDLE = 0, 453db5b9f7SMasaki Ota SS4_PACKET_ID_ONE, 463db5b9f7SMasaki Ota SS4_PACKET_ID_TWO, 473db5b9f7SMasaki Ota SS4_PACKET_ID_MULTI, 484777ac22SBen Gamari SS4_PACKET_ID_STICK, 493db5b9f7SMasaki Ota }; 503db5b9f7SMasaki Ota 513db5b9f7SMasaki Ota #define SS4_COUNT_PER_ELECTRODE 256 523db5b9f7SMasaki Ota #define SS4_NUMSENSOR_XOFFSET 7 533db5b9f7SMasaki Ota #define SS4_NUMSENSOR_YOFFSET 7 543db5b9f7SMasaki Ota #define SS4_MIN_PITCH_MM 50 553db5b9f7SMasaki Ota 563db5b9f7SMasaki Ota #define SS4_MASK_NORMAL_BUTTONS 0x07 573db5b9f7SMasaki Ota 5823fce365SPaul Donohue #define SS4_IS_IDLE_V2(_b) (((_b[0]) == 0x18) && \ 5923fce365SPaul Donohue ((_b[1]) == 0x10) && \ 6023fce365SPaul Donohue ((_b[2]) == 0x00) && \ 6123fce365SPaul Donohue ((_b[3] & 0x88) == 0x08) && \ 6223fce365SPaul Donohue ((_b[4]) == 0x10) && \ 6323fce365SPaul Donohue ((_b[5]) == 0x00) \ 6423fce365SPaul Donohue ) 6523fce365SPaul Donohue 6623fce365SPaul Donohue #define SS4_1F_X_V2(_b) (((_b[0]) & 0x0007) | \ 673db5b9f7SMasaki Ota ((_b[1] << 3) & 0x0078) | \ 683db5b9f7SMasaki Ota ((_b[1] << 2) & 0x0380) | \ 693db5b9f7SMasaki Ota ((_b[2] << 5) & 0x1C00) \ 703db5b9f7SMasaki Ota ) 713db5b9f7SMasaki Ota 723db5b9f7SMasaki Ota #define SS4_1F_Y_V2(_b) (((_b[2]) & 0x000F) | \ 733db5b9f7SMasaki Ota ((_b[3] >> 2) & 0x0030) | \ 743db5b9f7SMasaki Ota ((_b[4] << 6) & 0x03C0) | \ 753db5b9f7SMasaki Ota ((_b[4] << 5) & 0x0C00) \ 763db5b9f7SMasaki Ota ) 773db5b9f7SMasaki Ota 783db5b9f7SMasaki Ota #define SS4_1F_Z_V2(_b) (((_b[5]) & 0x0F) | \ 793db5b9f7SMasaki Ota ((_b[5] >> 1) & 0x70) | \ 803db5b9f7SMasaki Ota ((_b[4]) & 0x80) \ 813db5b9f7SMasaki Ota ) 823db5b9f7SMasaki Ota 833db5b9f7SMasaki Ota #define SS4_1F_LFB_V2(_b) (((_b[2] >> 4) & 0x01) == 0x01) 843db5b9f7SMasaki Ota 853db5b9f7SMasaki Ota #define SS4_MF_LF_V2(_b, _i) ((_b[1 + (_i) * 3] & 0x0004) == 0x0004) 863db5b9f7SMasaki Ota 873db5b9f7SMasaki Ota #define SS4_BTN_V2(_b) ((_b[0] >> 5) & SS4_MASK_NORMAL_BUTTONS) 883db5b9f7SMasaki Ota 893db5b9f7SMasaki Ota #define SS4_STD_MF_X_V2(_b, _i) (((_b[0 + (_i) * 3] << 5) & 0x00E0) | \ 903db5b9f7SMasaki Ota ((_b[1 + _i * 3] << 5) & 0x1F00) \ 913db5b9f7SMasaki Ota ) 923db5b9f7SMasaki Ota 933db5b9f7SMasaki Ota #define SS4_STD_MF_Y_V2(_b, _i) (((_b[1 + (_i) * 3] << 3) & 0x0010) | \ 943db5b9f7SMasaki Ota ((_b[2 + (_i) * 3] << 5) & 0x01E0) | \ 953db5b9f7SMasaki Ota ((_b[2 + (_i) * 3] << 4) & 0x0E00) \ 963db5b9f7SMasaki Ota ) 973db5b9f7SMasaki Ota 983db5b9f7SMasaki Ota #define SS4_BTL_MF_X_V2(_b, _i) (SS4_STD_MF_X_V2(_b, _i) | \ 993db5b9f7SMasaki Ota ((_b[0 + (_i) * 3] >> 3) & 0x0010) \ 1003db5b9f7SMasaki Ota ) 1013db5b9f7SMasaki Ota 1023db5b9f7SMasaki Ota #define SS4_BTL_MF_Y_V2(_b, _i) (SS4_STD_MF_Y_V2(_b, _i) | \ 1033db5b9f7SMasaki Ota ((_b[0 + (_i) * 3] >> 3) & 0x0008) \ 1043db5b9f7SMasaki Ota ) 1053db5b9f7SMasaki Ota 1063db5b9f7SMasaki Ota #define SS4_MF_Z_V2(_b, _i) (((_b[1 + (_i) * 3]) & 0x0001) | \ 1073db5b9f7SMasaki Ota ((_b[1 + (_i) * 3] >> 1) & 0x0002) \ 1083db5b9f7SMasaki Ota ) 1093db5b9f7SMasaki Ota 1103db5b9f7SMasaki Ota #define SS4_IS_MF_CONTINUE(_b) ((_b[2] & 0x10) == 0x10) 1113db5b9f7SMasaki Ota #define SS4_IS_5F_DETECTED(_b) ((_b[2] & 0x10) == 0x10) 1123db5b9f7SMasaki Ota 11323fce365SPaul Donohue #define SS4_TS_X_V2(_b) (s8)( \ 11423fce365SPaul Donohue ((_b[0] & 0x01) << 7) | \ 11523fce365SPaul Donohue (_b[1] & 0x7F) \ 11623fce365SPaul Donohue ) 11723fce365SPaul Donohue 11847e3a5edSPaul Donohue #define SS4_TS_Y_V2(_b) -(s8)( \ 11923fce365SPaul Donohue ((_b[3] & 0x01) << 7) | \ 12023fce365SPaul Donohue (_b[2] & 0x7F) \ 12123fce365SPaul Donohue ) 12223fce365SPaul Donohue 12323fce365SPaul Donohue #define SS4_TS_Z_V2(_b) (s8)(_b[4] & 0x7F) 12423fce365SPaul Donohue 1253db5b9f7SMasaki Ota 1263db5b9f7SMasaki Ota #define SS4_MFPACKET_NO_AX 8160 /* X-Coordinate value */ 1273db5b9f7SMasaki Ota #define SS4_MFPACKET_NO_AY 4080 /* Y-Coordinate value */ 1283db5b9f7SMasaki Ota #define SS4_MFPACKET_NO_AX_BL 8176 /* Buttonless X-Coordinate value */ 1293db5b9f7SMasaki Ota #define SS4_MFPACKET_NO_AY_BL 4088 /* Buttonless Y-Coordinate value */ 1303db5b9f7SMasaki Ota 1313db5b9f7SMasaki Ota /* 1323808843cSYunkang Tang * enum V7_PACKET_ID - defines the packet type for V7 1333808843cSYunkang Tang * V7_PACKET_ID_IDLE: There's no finger and no button activity. 1343808843cSYunkang Tang * V7_PACKET_ID_TWO: There's one or two non-resting fingers on touchpad 1353808843cSYunkang Tang * or there's button activities. 1363808843cSYunkang Tang * V7_PACKET_ID_MULTI: There are at least three non-resting fingers. 1373808843cSYunkang Tang * V7_PACKET_ID_NEW: The finger position in slot is not continues from 1383808843cSYunkang Tang * previous packet. 1393808843cSYunkang Tang */ 1403808843cSYunkang Tang enum V7_PACKET_ID { 1413808843cSYunkang Tang V7_PACKET_ID_IDLE, 1423808843cSYunkang Tang V7_PACKET_ID_TWO, 1433808843cSYunkang Tang V7_PACKET_ID_MULTI, 1443808843cSYunkang Tang V7_PACKET_ID_NEW, 1453808843cSYunkang Tang V7_PACKET_ID_UNKNOWN, 1463808843cSYunkang Tang }; 1473808843cSYunkang Tang 14888a80348SKevin Cernekee /** 1498326bb57SDmitry Torokhov * struct alps_protocol_info - information about protocol used by a device 1508326bb57SDmitry Torokhov * @version: Indicates V1/V2/V3/... 1518326bb57SDmitry Torokhov * @byte0: Helps figure out whether a position report packet matches the 1528326bb57SDmitry Torokhov * known format for this model. The first byte of the report, ANDed with 1538326bb57SDmitry Torokhov * mask0, should match byte0. 1548326bb57SDmitry Torokhov * @mask0: The mask used to check the first byte of the report. 1558326bb57SDmitry Torokhov * @flags: Additional device capabilities (passthrough port, trackstick, etc.). 1568326bb57SDmitry Torokhov */ 1578326bb57SDmitry Torokhov struct alps_protocol_info { 1588326bb57SDmitry Torokhov u16 version; 1598326bb57SDmitry Torokhov u8 byte0, mask0; 1608326bb57SDmitry Torokhov unsigned int flags; 1618326bb57SDmitry Torokhov }; 1628326bb57SDmitry Torokhov 1638326bb57SDmitry Torokhov /** 16488a80348SKevin Cernekee * struct alps_model_info - touchpad ID table 16588a80348SKevin Cernekee * @signature: E7 response string to match. 16688a80348SKevin Cernekee * @command_mode_resp: For V3/V4 touchpads, the final byte of the EC response 16788a80348SKevin Cernekee * (aka command mode response) identifies the firmware minor version. This 16888a80348SKevin Cernekee * can be used to distinguish different hardware models which are not 16988a80348SKevin Cernekee * uniquely identifiable through their E7 responses. 1707343d119SMarcos Paulo de Souza * @protocol_info: information about protocol used by the device. 17188a80348SKevin Cernekee * 17288a80348SKevin Cernekee * Many (but not all) ALPS touchpads can be identified by looking at the 17388a80348SKevin Cernekee * values returned in the "E7 report" and/or the "EC report." This table 17488a80348SKevin Cernekee * lists a number of such touchpads. 17588a80348SKevin Cernekee */ 1761da177e4SLinus Torvalds struct alps_model_info { 177d7c13d34SDmitry Torokhov u8 signature[3]; 178d7c13d34SDmitry Torokhov u8 command_mode_resp; 1798326bb57SDmitry Torokhov struct alps_protocol_info protocol_info; 1801da177e4SLinus Torvalds }; 1811da177e4SLinus Torvalds 18288a80348SKevin Cernekee /** 18388a80348SKevin Cernekee * struct alps_nibble_commands - encodings for register accesses 18488a80348SKevin Cernekee * @command: PS/2 command used for the nibble 18588a80348SKevin Cernekee * @data: Data supplied as an argument to the PS/2 command, if applicable 18688a80348SKevin Cernekee * 18788a80348SKevin Cernekee * The ALPS protocol uses magic sequences to transmit binary data to the 18888a80348SKevin Cernekee * touchpad, as it is generally not OK to send arbitrary bytes out the 18988a80348SKevin Cernekee * PS/2 port. Each of the sequences in this table sends one nibble of the 19088a80348SKevin Cernekee * register address or (write) data. Different versions of the ALPS protocol 19188a80348SKevin Cernekee * use slightly different encodings. 19288a80348SKevin Cernekee */ 19325bded7cSSeth Forshee struct alps_nibble_commands { 19425bded7cSSeth Forshee int command; 19525bded7cSSeth Forshee unsigned char data; 19625bded7cSSeth Forshee }; 19725bded7cSSeth Forshee 198036e6c7bSHans de Goede struct alps_bitmap_point { 199036e6c7bSHans de Goede int start_bit; 200036e6c7bSHans de Goede int num_bits; 201036e6c7bSHans de Goede }; 202036e6c7bSHans de Goede 20388a80348SKevin Cernekee /** 204f85e5001SKevin Cernekee * struct alps_fields - decoded version of the report packet 205f85e5001SKevin Cernekee * @x_map: Bitmap of active X positions for MT. 206f85e5001SKevin Cernekee * @y_map: Bitmap of active Y positions for MT. 207f85e5001SKevin Cernekee * @fingers: Number of fingers for MT. 20802d04254SHans de Goede * @pressure: Pressure. 20902d04254SHans de Goede * @st: position for ST. 21002d04254SHans de Goede * @mt: position for MT. 211f85e5001SKevin Cernekee * @first_mp: Packet is the first of a multi-packet report. 212f85e5001SKevin Cernekee * @is_mp: Packet is part of a multi-packet report. 213f85e5001SKevin Cernekee * @left: Left touchpad button is active. 214f85e5001SKevin Cernekee * @right: Right touchpad button is active. 215f85e5001SKevin Cernekee * @middle: Middle touchpad button is active. 216f85e5001SKevin Cernekee * @ts_left: Left trackstick button is active. 217f85e5001SKevin Cernekee * @ts_right: Right trackstick button is active. 218f85e5001SKevin Cernekee * @ts_middle: Middle trackstick button is active. 219f85e5001SKevin Cernekee */ 220f85e5001SKevin Cernekee struct alps_fields { 221f85e5001SKevin Cernekee unsigned int x_map; 222f85e5001SKevin Cernekee unsigned int y_map; 223f85e5001SKevin Cernekee unsigned int fingers; 22402d04254SHans de Goede 22502d04254SHans de Goede int pressure; 22602d04254SHans de Goede struct input_mt_pos st; 22702d04254SHans de Goede struct input_mt_pos mt[MAX_TOUCHES]; 22802d04254SHans de Goede 229f85e5001SKevin Cernekee unsigned int first_mp:1; 230f85e5001SKevin Cernekee unsigned int is_mp:1; 231f85e5001SKevin Cernekee 232f85e5001SKevin Cernekee unsigned int left:1; 233f85e5001SKevin Cernekee unsigned int right:1; 234f85e5001SKevin Cernekee unsigned int middle:1; 235f85e5001SKevin Cernekee 236f85e5001SKevin Cernekee unsigned int ts_left:1; 237f85e5001SKevin Cernekee unsigned int ts_right:1; 238f85e5001SKevin Cernekee unsigned int ts_middle:1; 239f85e5001SKevin Cernekee }; 240f85e5001SKevin Cernekee 241f85e5001SKevin Cernekee /** 24288a80348SKevin Cernekee * struct alps_data - private data structure for the ALPS driver 24304aae283SPali Rohár * @psmouse: Pointer to parent psmouse device 24404aae283SPali Rohár * @dev2: Trackstick device (can be NULL). 24504aae283SPali Rohár * @dev3: Generic PS/2 mouse (can be NULL, delayed registering). 24604aae283SPali Rohár * @phys2: Physical path for the trackstick device. 24704aae283SPali Rohár * @phys3: Physical path for the generic PS/2 mouse. 24804aae283SPali Rohár * @dev3_register_work: Delayed work for registering PS/2 mouse. 24988a80348SKevin Cernekee * @nibble_commands: Command mapping used for touchpad register accesses. 25088a80348SKevin Cernekee * @addr_command: Command used to tell the touchpad that a register address 25188a80348SKevin Cernekee * follows. 25299df65e7SKevin Cernekee * @proto_version: Indicates V1/V2/V3/... 25399df65e7SKevin Cernekee * @byte0: Helps figure out whether a position report packet matches the 25499df65e7SKevin Cernekee * known format for this model. The first byte of the report, ANDed with 25599df65e7SKevin Cernekee * mask0, should match byte0. 25699df65e7SKevin Cernekee * @mask0: The mask used to check the first byte of the report. 257c0cd17f6SHans de Goede * @fw_ver: cached copy of firmware version (EC report) 25899df65e7SKevin Cernekee * @flags: Additional device capabilities (passthrough port, trackstick, etc.). 2597a9f73e7SKevin Cernekee * @x_max: Largest possible X position value. 2607a9f73e7SKevin Cernekee * @y_max: Largest possible Y position value. 2617a9f73e7SKevin Cernekee * @x_bits: Number of X bits in the MT bitmap. 2627a9f73e7SKevin Cernekee * @y_bits: Number of Y bits in the MT bitmap. 26324af5cb9SKevin Cernekee * @hw_init: Protocol-specific hardware init function. 26424af5cb9SKevin Cernekee * @process_packet: Protocol-specific function to process a report packet. 265f85e5001SKevin Cernekee * @decode_fields: Protocol-specific function to read packet bitfields. 26624af5cb9SKevin Cernekee * @set_abs_params: Protocol-specific function to configure the input_dev. 26788a80348SKevin Cernekee * @prev_fin: Finger bit from previous packet. 26888a80348SKevin Cernekee * @multi_packet: Multi-packet data in progress. 26988a80348SKevin Cernekee * @multi_data: Saved multi-packet data. 27002d04254SHans de Goede * @f: Decoded packet data fields. 27188a80348SKevin Cernekee * @quirks: Bitmap of ALPS_QUIRK_*. 27288a80348SKevin Cernekee * @timer: Timer for flushing out the final report packet in the stream. 27388a80348SKevin Cernekee */ 2741da177e4SLinus Torvalds struct alps_data { 27504aae283SPali Rohár struct psmouse *psmouse; 27688a80348SKevin Cernekee struct input_dev *dev2; 27704aae283SPali Rohár struct input_dev *dev3; 27804aae283SPali Rohár char phys2[32]; 27904aae283SPali Rohár char phys3[32]; 28004aae283SPali Rohár struct delayed_work dev3_register_work; 28199df65e7SKevin Cernekee 28299df65e7SKevin Cernekee /* these are autodetected when the device is identified */ 28325bded7cSSeth Forshee const struct alps_nibble_commands *nibble_commands; 28488a80348SKevin Cernekee int addr_command; 285d7c13d34SDmitry Torokhov u16 proto_version; 286d7c13d34SDmitry Torokhov u8 byte0, mask0; 287d7c13d34SDmitry Torokhov u8 fw_ver[3]; 28840e8f53bSHans de Goede int flags; 2897a9f73e7SKevin Cernekee int x_max; 2907a9f73e7SKevin Cernekee int y_max; 2917a9f73e7SKevin Cernekee int x_bits; 2927a9f73e7SKevin Cernekee int y_bits; 293f3f33c67SHans de Goede unsigned int x_res; 294f3f33c67SHans de Goede unsigned int y_res; 29599df65e7SKevin Cernekee 29624af5cb9SKevin Cernekee int (*hw_init)(struct psmouse *psmouse); 29724af5cb9SKevin Cernekee void (*process_packet)(struct psmouse *psmouse); 29838c11eaaSHans de Goede int (*decode_fields)(struct alps_fields *f, unsigned char *p, 299ee65d4b3SYunkang Tang struct psmouse *psmouse); 30024af5cb9SKevin Cernekee void (*set_abs_params)(struct alps_data *priv, struct input_dev *dev1); 30124af5cb9SKevin Cernekee 30288a80348SKevin Cernekee int prev_fin; 30388a80348SKevin Cernekee int multi_packet; 3044dd26573SHans de Goede int second_touch; 30588a80348SKevin Cernekee unsigned char multi_data[6]; 30602d04254SHans de Goede struct alps_fields f; 30725bded7cSSeth Forshee u8 quirks; 3081d9f2626SSebastian Kapfer struct timer_list timer; 3091da177e4SLinus Torvalds }; 3101da177e4SLinus Torvalds 31125bded7cSSeth Forshee #define ALPS_QUIRK_TRACKSTICK_BUTTONS 1 /* trakcstick buttons in trackstick packet */ 31225bded7cSSeth Forshee 31355e3d922SAndres Salomon #ifdef CONFIG_MOUSE_PS2_ALPS 314b7802c5cSDmitry Torokhov int alps_detect(struct psmouse *psmouse, bool set_properties); 31555e3d922SAndres Salomon int alps_init(struct psmouse *psmouse); 31655e3d922SAndres Salomon #else 317b7802c5cSDmitry Torokhov inline int alps_detect(struct psmouse *psmouse, bool set_properties) 31855e3d922SAndres Salomon { 31955e3d922SAndres Salomon return -ENOSYS; 32055e3d922SAndres Salomon } 32155e3d922SAndres Salomon inline int alps_init(struct psmouse *psmouse) 32255e3d922SAndres Salomon { 32355e3d922SAndres Salomon return -ENOSYS; 32455e3d922SAndres Salomon } 32555e3d922SAndres Salomon #endif /* CONFIG_MOUSE_PS2_ALPS */ 32655e3d922SAndres Salomon 3271da177e4SLinus Torvalds #endif 328