src/dev/ps2/types.hh

   1 /*
   2  * Copyright (c) 2011, 2018 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 <list>
  46 #include <vector>
  47
  48 #include "base/bitunion.hh"
  49
  50 /** @file misc functions and constants required to interface with or
  51  * emulate ps2 devices
  52  */
  53
  54 namespace Ps2 {
  55
  56 enum {
  57     SelfTestPass       = 0xAA,
  58     ReadID             = 0xF2,
  59     Enable             = 0xF4,
  60     Disable            = 0xF5,
  61     DefaultsAndDisable = 0xF6,
  62     SelfTestFail       = 0xFC,
  63     Ack                = 0xFA,
  64     Resend             = 0xFE,
  65     Reset              = 0xFF,
  66 };
  67
  68 namespace Keyboard {
  69
  70 enum {
  71     LEDWrite = 0xED,
  72     DiagnosticEcho = 0xEE,
  73     AlternateScanCodes = 0xF0,
  74     TypematicInfo = 0xF3,
  75     AllKeysToTypematic = 0xF7,
  76     AllKeysToMakeRelease = 0xF8,
  77     AllKeysToMake = 0xF9,
  78     AllKeysToTypematicMakeRelease = 0xFA,
  79     KeyToTypematic = 0xFB,
  80     KeyToMakeRelease = 0xFC,
  81     KeyToMakeOnly = 0xFD,
  82 };
  83
  84 extern const std::vector<uint8_t> ID;
  85
  86 };
  87
  88 namespace Mouse {
  89
  90 enum {
  91     Scale1to1 = 0xE6,
  92     Scale2to1 = 0xE7,
  93     SetResolution = 0xE8,
  94     GetStatus = 0xE9,
  95     ReadData = 0xEB,
  96     ResetWrapMode = 0xEC,
  97     WrapMode = 0xEE,
  98     RemoteMode = 0xF0,
  99     SampleRate = 0xF3,
 100 };
 101
 102 extern const std::vector<uint8_t> ID;
 103
 104 };
 105
 106 /** A bitfield that represents the first byte of a mouse movement packet
 107  */
 108 BitUnion8(Ps2MouseMovement)
 109     Bitfield<0> leftButton;
 110     Bitfield<1> rightButton;
 111     Bitfield<2> middleButton;
 112     Bitfield<3> one;
 113     Bitfield<4> xSign;
 114     Bitfield<5> ySign;
 115     Bitfield<6> xOverflow;
 116     Bitfield<7> yOverflow;
 117 EndBitUnion(Ps2MouseMovement)
 118
 119 /** Convert an x11 key symbol into a set of ps2 charecters.
 120  * @param key x11 key symbol
 121  * @param down if the key is being pressed or released
 122  * @param cur_shift if device has already sent a shift
 123  * @param keys list of keys command to send to emulate the x11 key symbol
 124  */
 125 void keySymToPs2(uint32_t key, bool down, bool &cur_shift,
 126         std::list<uint8_t> &keys);
 127
 128 } /* namespace Ps2 */
 129 #endif // __DEV_PS2_HH__