drivers/input/mouse/elantech.h

   1 /*
   2  * Elantech Touchpad driver (v6)
   3  *
   4  * Copyright (C) 2007-2009 Arjan Opmeer <arjan@opmeer.net>
   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
   8  * by the Free Software Foundation.
   9  *
  10  * Trademarks are the property of their respective owners.
  11  */
  12
  13 #ifndef _ELANTECH_H
  14 #define _ELANTECH_H
  15
  16 /*
  17  * Command values for Synaptics style queries
  18  */
  19 #define ETP_FW_VERSION_QUERY            0x01
  20 #define ETP_CAPABILITIES_QUERY          0x02
  21
  22 /*
  23  * Command values for register reading or writing
  24  */
  25 #define ETP_REGISTER_READ               0x10
  26 #define ETP_REGISTER_WRITE              0x11
  27
  28 /*
  29  * Hardware version 2 custom PS/2 command value
  30  */
  31 #define ETP_PS2_CUSTOM_COMMAND          0xf8
  32
  33 /*
  34  * Times to retry a ps2_command and millisecond delay between tries
  35  */
  36 #define ETP_PS2_COMMAND_TRIES           3
  37 #define ETP_PS2_COMMAND_DELAY           500
  38
  39 /*
  40  * Times to try to read back a register and millisecond delay between tries
  41  */
  42 #define ETP_READ_BACK_TRIES             5
  43 #define ETP_READ_BACK_DELAY             2000
  44
  45 /*
  46  * Register bitmasks for hardware version 1
  47  */
  48 #define ETP_R10_ABSOLUTE_MODE           0x04
  49 #define ETP_R11_4_BYTE_MODE             0x02
  50
  51 /*
  52  * Capability bitmasks
  53  */
  54 #define ETP_CAP_HAS_ROCKER              0x04
  55
  56 /*
  57  * One hard to find application note states that X axis range is 0 to 576
  58  * and Y axis range is 0 to 384 for harware version 1.
  59  * Edge fuzz might be necessary because of bezel around the touchpad
  60  */
  61 #define ETP_EDGE_FUZZ_V1                32
  62
  63 #define ETP_XMIN_V1                     (  0 + ETP_EDGE_FUZZ_V1)
  64 #define ETP_XMAX_V1                     (576 - ETP_EDGE_FUZZ_V1)
  65 #define ETP_YMIN_V1                     (  0 + ETP_EDGE_FUZZ_V1)
  66 #define ETP_YMAX_V1                     (384 - ETP_EDGE_FUZZ_V1)
  67
  68 /*
  69  * It seems the resolution for hardware version 2 doubled.
  70  * Hence the X and Y ranges are doubled too.
  71  * The bezel around the pad also appears to be smaller
  72  */
  73 #define ETP_EDGE_FUZZ_V2                8
  74
  75 #define ETP_XMIN_V2                     (   0 + ETP_EDGE_FUZZ_V2)
  76 #define ETP_XMAX_V2                     (1152 - ETP_EDGE_FUZZ_V2)
  77 #define ETP_YMIN_V2                     (   0 + ETP_EDGE_FUZZ_V2)
  78 #define ETP_YMAX_V2                     ( 768 - ETP_EDGE_FUZZ_V2)
  79
  80 #define ETP_PMIN_V2                     0
  81 #define ETP_PMAX_V2                     255
  82 #define ETP_WMIN_V2                     0
  83 #define ETP_WMAX_V2                     15
  84
  85 /*
  86  * For two finger touches the coordinate of each finger gets reported
  87  * separately but with reduced resolution.
  88  */
  89 #define ETP_2FT_FUZZ                    4
  90
  91 #define ETP_2FT_XMIN                    (  0 + ETP_2FT_FUZZ)
  92 #define ETP_2FT_XMAX                    (288 - ETP_2FT_FUZZ)
  93 #define ETP_2FT_YMIN                    (  0 + ETP_2FT_FUZZ)
  94 #define ETP_2FT_YMAX                    (192 - ETP_2FT_FUZZ)
  95
  96 struct elantech_data {
  97         unsigned char reg_10;
  98         unsigned char reg_11;
  99         unsigned char reg_20;
 100         unsigned char reg_21;
 101         unsigned char reg_22;
 102         unsigned char reg_23;
 103         unsigned char reg_24;
 104         unsigned char reg_25;
 105         unsigned char reg_26;
 106         unsigned char debug;
 107         unsigned char capabilities;
 108         bool paritycheck;
 109         bool jumpy_cursor;
 110         bool reports_pressure;
 111         unsigned char hw_version;
 112         unsigned int fw_version;
 113         unsigned int single_finger_reports;
 114         unsigned char parity[256];
 115 };
 116
 117 #ifdef CONFIG_MOUSE_PS2_ELANTECH
 118 int elantech_detect(struct psmouse *psmouse, bool set_properties);
 119 int elantech_init(struct psmouse *psmouse);
 120 #else
 121 static inline int elantech_detect(struct psmouse *psmouse, bool set_properties)
 122 {
 123         return -ENOSYS;
 124 }
 125 static inline int elantech_init(struct psmouse *psmouse)
 126 {
 127         return -ENOSYS;
 128 }
 129 #endif /* CONFIG_MOUSE_PS2_ELANTECH */
 130
 131 #endif