LXR linux/drivers/input/mouse/cypress

   1/* SPDX-License-Identifier: GPL-2.0 */
   2#ifndef _CYPRESS_PS2_H
   3#define _CYPRESS_PS2_H
   4
   5#include "psmouse.h"
   6
   7#define CMD_BITS_MASK 0x03
   8#define COMPOSIT(x, s) (((x) & CMD_BITS_MASK) << (s))
   9
  10#define ENCODE_CMD(aa, bb, cc, dd) \
  11        (COMPOSIT((aa), 6) | COMPOSIT((bb), 4) | COMPOSIT((cc), 2) | COMPOSIT((dd), 0))
  12#define CYTP_CMD_ABS_NO_PRESSURE_MODE       ENCODE_CMD(0, 1, 0, 0)
  13#define CYTP_CMD_ABS_WITH_PRESSURE_MODE     ENCODE_CMD(0, 1, 0, 1)
  14#define CYTP_CMD_SMBUS_MODE                 ENCODE_CMD(0, 1, 1, 0)
  15#define CYTP_CMD_STANDARD_MODE              ENCODE_CMD(0, 2, 0, 0)  /* not implemented yet. */
  16#define CYTP_CMD_CYPRESS_REL_MODE           ENCODE_CMD(1, 1, 1, 1)  /* not implemented yet. */
  17#define CYTP_CMD_READ_CYPRESS_ID            ENCODE_CMD(0, 0, 0, 0)
  18#define CYTP_CMD_READ_TP_METRICS            ENCODE_CMD(0, 0, 0, 1)
  19#define CYTP_CMD_SET_HSCROLL_WIDTH(w)       ENCODE_CMD(1, 1, 0, (w))
  20#define     CYTP_CMD_SET_HSCROLL_MASK       ENCODE_CMD(1, 1, 0, 0)
  21#define CYTP_CMD_SET_VSCROLL_WIDTH(w)       ENCODE_CMD(1, 2, 0, (w))
  22#define     CYTP_CMD_SET_VSCROLL_MASK       ENCODE_CMD(1, 2, 0, 0)
  23#define CYTP_CMD_SET_PALM_GEOMETRY(e)       ENCODE_CMD(1, 2, 1, (e))
  24#define     CYTP_CMD_PALM_GEMMETRY_MASK     ENCODE_CMD(1, 2, 1, 0)
  25#define CYTP_CMD_SET_PALM_SENSITIVITY(s)    ENCODE_CMD(1, 2, 2, (s))
  26#define     CYTP_CMD_PALM_SENSITIVITY_MASK  ENCODE_CMD(1, 2, 2, 0)
  27#define CYTP_CMD_SET_MOUSE_SENSITIVITY(s)   ENCODE_CMD(1, 3, ((s) >> 2), (s))
  28#define     CYTP_CMD_MOUSE_SENSITIVITY_MASK ENCODE_CMD(1, 3, 0, 0)
  29#define CYTP_CMD_REQUEST_BASELINE_STATUS    ENCODE_CMD(2, 0, 0, 1)
  30#define CYTP_CMD_REQUEST_RECALIBRATION      ENCODE_CMD(2, 0, 0, 3)
  31
  32#define DECODE_CMD_AA(x) (((x) >> 6) & CMD_BITS_MASK)
  33#define DECODE_CMD_BB(x) (((x) >> 4) & CMD_BITS_MASK)
  34#define DECODE_CMD_CC(x) (((x) >> 2) & CMD_BITS_MASK)
  35#define DECODE_CMD_DD(x) ((x) & CMD_BITS_MASK)
  36
  37/* Cypress trackpad working mode. */
  38#define CYTP_BIT_ABS_PRESSURE    (1 << 3)
  39#define CYTP_BIT_ABS_NO_PRESSURE (1 << 2)
  40#define CYTP_BIT_CYPRESS_REL     (1 << 1)
  41#define CYTP_BIT_STANDARD_REL    (1 << 0)
  42#define CYTP_BIT_REL_MASK (CYTP_BIT_CYPRESS_REL | CYTP_BIT_STANDARD_REL)
  43#define CYTP_BIT_ABS_MASK (CYTP_BIT_ABS_PRESSURE | CYTP_BIT_ABS_NO_PRESSURE)
  44#define CYTP_BIT_ABS_REL_MASK (CYTP_BIT_ABS_MASK | CYTP_BIT_REL_MASK)
  45
  46#define CYTP_BIT_HIGH_RATE       (1 << 4)
  47/*
  48 * report mode bit is set, firmware working in Remote Mode.
  49 * report mode bit is cleared, firmware working in Stream Mode.
  50 */
  51#define CYTP_BIT_REPORT_MODE     (1 << 5)
  52
  53/* scrolling width values for set HSCROLL and VSCROLL width command. */
  54#define SCROLL_WIDTH_NARROW 1
  55#define SCROLL_WIDTH_NORMAL 2
  56#define SCROLL_WIDTH_WIDE   3
  57
  58#define PALM_GEOMETRY_ENABLE  1
  59#define PALM_GEOMETRY_DISABLE 0
  60
  61#define TP_METRICS_MASK  0x80
  62#define FW_VERSION_MASX    0x7f
  63#define FW_VER_HIGH_MASK 0x70
  64#define FW_VER_LOW_MASK  0x0f
  65
  66/* Times to retry a ps2_command and millisecond delay between tries. */
  67#define CYTP_PS2_CMD_TRIES 3
  68#define CYTP_PS2_CMD_DELAY 500
  69
  70/* time out for PS/2 command only in milliseconds. */
  71#define CYTP_CMD_TIMEOUT  200
  72#define CYTP_DATA_TIMEOUT 30
  73
  74#define CYTP_EXT_CMD   0xe8
  75#define CYTP_PS2_RETRY 0xfe
  76#define CYTP_PS2_ERROR 0xfc
  77
  78#define CYTP_RESP_RETRY 0x01
  79#define CYTP_RESP_ERROR 0xfe
  80
  81
  82#define CYTP_105001_WIDTH  97   /* Dell XPS 13 */
  83#define CYTP_105001_HIGH   59
  84#define CYTP_DEFAULT_WIDTH (CYTP_105001_WIDTH)
  85#define CYTP_DEFAULT_HIGH  (CYTP_105001_HIGH)
  86
  87#define CYTP_ABS_MAX_X     1600
  88#define CYTP_ABS_MAX_Y     900
  89#define CYTP_MAX_PRESSURE  255
  90#define CYTP_MIN_PRESSURE  0
  91
  92/* header byte bits of relative package. */
  93#define BTN_LEFT_BIT   0x01
  94#define BTN_RIGHT_BIT  0x02
  95#define BTN_MIDDLE_BIT 0x04
  96#define REL_X_SIGN_BIT 0x10
  97#define REL_Y_SIGN_BIT 0x20
  98
  99/* header byte bits of absolute package. */
 100#define ABS_VSCROLL_BIT 0x10
 101#define ABS_HSCROLL_BIT 0x20
 102#define ABS_MULTIFINGER_TAP 0x04
 103#define ABS_EDGE_MOTION_MASK 0x80
 104
 105#define DFLT_RESP_BITS_VALID     0x88  /* SMBus bit should not be set. */
 106#define DFLT_RESP_SMBUS_BIT      0x80
 107#define   DFLT_SMBUS_MODE        0x80
 108#define   DFLT_PS2_MODE          0x00
 109#define DFLT_RESP_BIT_MODE       0x40
 110#define   DFLT_RESP_REMOTE_MODE  0x40
 111#define   DFLT_RESP_STREAM_MODE  0x00
 112#define DFLT_RESP_BIT_REPORTING  0x20
 113#define DFLT_RESP_BIT_SCALING    0x10
 114
 115#define TP_METRICS_BIT_PALM               0x80
 116#define TP_METRICS_BIT_STUBBORN           0x40
 117#define TP_METRICS_BIT_2F_JITTER          0x30
 118#define TP_METRICS_BIT_1F_JITTER          0x0c
 119#define TP_METRICS_BIT_APA                0x02
 120#define TP_METRICS_BIT_MTG                0x01
 121#define TP_METRICS_BIT_ABS_PKT_FORMAT_SET 0xf0
 122#define TP_METRICS_BIT_2F_SPIKE           0x0c
 123#define TP_METRICS_BIT_1F_SPIKE           0x03
 124
 125/* bits of first byte response of E9h-Status Request command. */
 126#define RESP_BTN_RIGHT_BIT  0x01
 127#define RESP_BTN_MIDDLE_BIT 0x02
 128#define RESP_BTN_LEFT_BIT   0x04
 129#define RESP_SCALING_BIT    0x10
 130#define RESP_ENABLE_BIT     0x20
 131#define RESP_REMOTE_BIT     0x40
 132#define RESP_SMBUS_BIT      0x80
 133
 134#define CYTP_MAX_MT_SLOTS 2
 135
 136struct cytp_contact {
 137        int x;
 138        int y;
 139        int z;  /* also named as touch pressure. */
 140};
 141
 142/* The structure of Cypress Trackpad event data. */
 143struct cytp_report_data {
 144        int contact_cnt;
 145        struct cytp_contact contacts[CYTP_MAX_MT_SLOTS];
 146        unsigned int left:1;
 147        unsigned int right:1;
 148        unsigned int middle:1;
 149        unsigned int tap:1;  /* multi-finger tap detected. */
 150};
 151
 152/* The structure of Cypress Trackpad device private data. */
 153struct cytp_data {
 154        int fw_version;
 155
 156        int pkt_size;
 157        int mode;
 158
 159        int tp_min_pressure;
 160        int tp_max_pressure;
 161        int tp_width;  /* X direction physical size in mm. */
 162        int tp_high;  /* Y direction physical size in mm. */
 163        int tp_max_abs_x;  /* Max X absolute units that can be reported. */
 164        int tp_max_abs_y;  /* Max Y absolute units that can be reported. */
 165
 166        int tp_res_x;  /* X resolution in units/mm. */
 167        int tp_res_y;  /* Y resolution in units/mm. */
 168
 169        int tp_metrics_supported;
 170};
 171
 172
 173#ifdef CONFIG_MOUSE_PS2_CYPRESS
 174int cypress_detect(struct psmouse *psmouse, bool set_properties);
 175int cypress_init(struct psmouse *psmouse);
 176#else
 177inline int cypress_detect(struct psmouse *psmouse, bool set_properties)
 178{
 179        return -ENOSYS;
 180}
 181inline int cypress_init(struct psmouse *psmouse)
 182{
 183        return -ENOSYS;
 184}
 185#endif /* CONFIG_MOUSE_PS2_CYPRESS */
 186
 187#endif  /* _CYPRESS_PS2_H */
 188