drivers/input/mouse/alps.h

   1 /*
   2  * ALPS touchpad PS/2 mouse driver
   3  *
   4  * Copyright (c) 2003 Peter Osterlund <petero2@telia.com>
   5  * Copyright (c) 2005 Vojtech Pavlik <vojtech@suse.cz>
   6  *
   7  * This program is free software; you can redistribute it and/or modify it
   8  * under the terms of the GNU General Public License version 2 as published by
   9  * the Free Software Foundation.
  10  */
  11
  12 #ifndef _ALPS_H
  13 #define _ALPS_H
  14
  15 #define ALPS_PROTO_V1   0
  16 #define ALPS_PROTO_V2   1
  17 #define ALPS_PROTO_V3   2
  18 #define ALPS_PROTO_V4   3
  19
  20 /**
  21  * struct alps_model_info - touchpad ID table
  22  * @signature: E7 response string to match.
  23  * @command_mode_resp: For V3/V4 touchpads, the final byte of the EC response
  24  *   (aka command mode response) identifies the firmware minor version.  This
  25  *   can be used to distinguish different hardware models which are not
  26  *   uniquely identifiable through their E7 responses.
  27  * @proto_version: Indicates V1/V2/V3/...
  28  * @byte0: Helps figure out whether a position report packet matches the
  29  *   known format for this model.  The first byte of the report, ANDed with
  30  *   mask0, should match byte0.
  31  * @mask0: The mask used to check the first byte of the report.
  32  * @flags: Additional device capabilities (passthrough port, trackstick, etc.).
  33  *
  34  * Many (but not all) ALPS touchpads can be identified by looking at the
  35  * values returned in the "E7 report" and/or the "EC report."  This table
  36  * lists a number of such touchpads.
  37  */
  38 struct alps_model_info {
  39         unsigned char signature[3];
  40         unsigned char command_mode_resp;
  41         unsigned char proto_version;
  42         unsigned char byte0, mask0;
  43         unsigned char flags;
  44 };
  45
  46 /**
  47  * struct alps_nibble_commands - encodings for register accesses
  48  * @command: PS/2 command used for the nibble
  49  * @data: Data supplied as an argument to the PS/2 command, if applicable
  50  *
  51  * The ALPS protocol uses magic sequences to transmit binary data to the
  52  * touchpad, as it is generally not OK to send arbitrary bytes out the
  53  * PS/2 port.  Each of the sequences in this table sends one nibble of the
  54  * register address or (write) data.  Different versions of the ALPS protocol
  55  * use slightly different encodings.
  56  */
  57 struct alps_nibble_commands {
  58         int command;
  59         unsigned char data;
  60 };
  61
  62 /**
  63  * struct alps_data - private data structure for the ALPS driver
  64  * @dev2: "Relative" device used to report trackstick or mouse activity.
  65  * @phys: Physical path for the relative device.
  66  * @i: Information on the detected touchpad model.
  67  * @nibble_commands: Command mapping used for touchpad register accesses.
  68  * @addr_command: Command used to tell the touchpad that a register address
  69  *   follows.
  70  * @prev_fin: Finger bit from previous packet.
  71  * @multi_packet: Multi-packet data in progress.
  72  * @multi_data: Saved multi-packet data.
  73  * @x1: First X coordinate from last MT report.
  74  * @x2: Second X coordinate from last MT report.
  75  * @y1: First Y coordinate from last MT report.
  76  * @y2: Second Y coordinate from last MT report.
  77  * @fingers: Number of fingers from last MT report.
  78  * @quirks: Bitmap of ALPS_QUIRK_*.
  79  * @timer: Timer for flushing out the final report packet in the stream.
  80  */
  81 struct alps_data {
  82         struct input_dev *dev2;
  83         char phys[32];
  84         const struct alps_model_info *i;
  85         const struct alps_nibble_commands *nibble_commands;
  86         int addr_command;
  87         int prev_fin;
  88         int multi_packet;
  89         unsigned char multi_data[6];
  90         int x1, x2, y1, y2;
  91         int fingers;
  92         u8 quirks;
  93         struct timer_list timer;
  94 };
  95
  96 #define ALPS_QUIRK_TRACKSTICK_BUTTONS   1 /* trakcstick buttons in trackstick packet */
  97
  98 #ifdef CONFIG_MOUSE_PS2_ALPS
  99 int alps_detect(struct psmouse *psmouse, bool set_properties);
 100 int alps_init(struct psmouse *psmouse);
 101 #else
 102 inline int alps_detect(struct psmouse *psmouse, bool set_properties)
 103 {
 104         return -ENOSYS;
 105 }
 106 inline int alps_init(struct psmouse *psmouse)
 107 {
 108         return -ENOSYS;
 109 }
 110 #endif /* CONFIG_MOUSE_PS2_ALPS */
 111
 112 #endif