src/dev/ps2.hh

   1 /*
   2  * Copyright (c) 2011 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * Authors: Ali Saidi
  38  */
  39
  40 #ifndef __DEV_PS2_HH__
  41 #define __DEV_PS2_HH__
  42
  43 #include <stdint.h>
  44
  45 #include "base/bitunion.hh"
  46
  47 /** @file misc functions and constants required to interface with or emulate ps2
  48  * devices
  49  */
  50
  51 namespace Ps2 {
  52 enum {
  53     Ps2Reset        = 0xff,
  54     SelfTestPass    = 0xAA,
  55     SetStatusLed    = 0xed,
  56     SetResolution   = 0xe8,
  57     StatusRequest   = 0xe9,
  58     SetScaling1_2   = 0xe7,
  59     SetScaling1_1   = 0xe6,
  60     ReadId          = 0xf2,
  61     TpReadId        = 0xe1,
  62     Ack             = 0xfa,
  63     SetRate         = 0xf3,
  64     Enable          = 0xf4,
  65     Disable         = 0xf6,
  66     KeyboardId      = 0xab,
  67     TouchKitId      = 0x0a,
  68     MouseId         = 0x00,
  69 };
  70
  71 /** A bitfield that represents the first byte of a mouse movement packet
  72  */
  73 BitUnion8(Ps2MouseMovement)
  74     Bitfield<0> leftButton;
  75     Bitfield<1> rightButton;
  76     Bitfield<2> middleButton;
  77     Bitfield<3> one;
  78     Bitfield<4> xSign;
  79     Bitfield<5> ySign;
  80     Bitfield<6> xOverflow;
  81     Bitfield<7> yOverflow;
  82 EndBitUnion(Ps2MouseMovement)
  83
  84 /** Convert an x11 key symbol into a set of ps2 charecters.
  85  * @param key x11 key symbol
  86  * @param down if the key is being pressed or released
  87  * @param cur_shift if device has already sent a shift
  88  * @param keys list of keys command to send to emulate the x11 key symbol
  89  */
  90 void keySymToPs2(uint32_t key, bool down, bool &cur_shift,
  91         std::list<uint8_t> &keys);
  92
  93 } /* namespace Ps2 */
  94 #endif // __DEV_PS2_HH__