tmk_core/protocol/ps2_mouse.h

   1 /*
   2 Copyright 2011 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #ifndef PS2_MOUSE_H
  19 #define  PS2_MOUSE_H
  20
  21 #include <stdbool.h>
  22
  23 #define PS2_MOUSE_READ_DATA     0xEB
  24
  25 /*
  26  * Data format:
  27  * byte|7       6       5       4       3       2       1       0
  28  * ----+--------------------------------------------------------------
  29  *    0|Yovflw  Xovflw  Ysign   Xsign   1       Middle  Right   Left
  30  *    1|                    X movement(0-255)
  31  *    2|                    Y movement(0-255)
  32  */
  33 #define PS2_MOUSE_BTN_MASK      0x07
  34 #define PS2_MOUSE_BTN_LEFT      0
  35 #define PS2_MOUSE_BTN_RIGHT     1
  36 #define PS2_MOUSE_BTN_MIDDLE    2
  37 #define PS2_MOUSE_X_SIGN        4
  38 #define PS2_MOUSE_Y_SIGN        5
  39 #define PS2_MOUSE_X_OVFLW       6
  40 #define PS2_MOUSE_Y_OVFLW       7
  41
  42
  43 /*
  44  * Scroll by mouse move with pressing button
  45  */
  46 /* mouse button to start scrolling; set 0 to disable scroll */
  47 #ifndef PS2_MOUSE_SCROLL_BTN_MASK
  48 #define PS2_MOUSE_SCROLL_BTN_MASK       (1<<PS2_MOUSE_BTN_MIDDLE)
  49 #endif
  50 /* send button event when button is released within this value(ms); set 0 to disable  */
  51 #ifndef PS2_MOUSE_SCROLL_BTN_SEND
  52 #define PS2_MOUSE_SCROLL_BTN_SEND       300
  53 #endif
  54 /* divide virtical and horizontal mouse move by this to convert to scroll move */
  55 #ifndef PS2_MOUSE_SCROLL_DIVISOR_V
  56 #define PS2_MOUSE_SCROLL_DIVISOR_V      2
  57 #endif
  58 #ifndef PS2_MOUSE_SCROLL_DIVISOR_H
  59 #define PS2_MOUSE_SCROLL_DIVISOR_H      2
  60 #endif
  61
  62
  63 uint8_t ps2_mouse_init(void);
  64 void ps2_mouse_task(void);
  65
  66 #endif