src/dev/arm/kmi.hh

   1 /*
   2  * Copyright (c) 2010, 2017 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  * Copyright (c) 2005 The Regents of The University of Michigan
  15  * All rights reserved.
  16  *
  17  * Redistribution and use in source and binary forms, with or without
  18  * modification, are permitted provided that the following conditions are
  19  * met: redistributions of source code must retain the above copyright
  20  * notice, this list of conditions and the following disclaimer;
  21  * redistributions in binary form must reproduce the above copyright
  22  * notice, this list of conditions and the following disclaimer in the
  23  * documentation and/or other materials provided with the distribution;
  24  * neither the name of the copyright holders nor the names of its
  25  * contributors may be used to endorse or promote products derived from
  26  * this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39  *
  40  * Authors: William Wang
  41  */
  42
  43
  44 /** @file
  45  * Implementiation of a PL050 KMI
  46  */
  47
  48 #ifndef __DEV_ARM_PL050_HH__
  49 #define __DEV_ARM_PL050_HH__
  50
  51 #include <list>
  52
  53 #include "base/vnc/vncinput.hh"
  54 #include "dev/arm/amba_device.hh"
  55 #include "params/Pl050.hh"
  56
  57 class Pl050 : public AmbaIntDevice, public VncKeyboard, public VncMouse
  58 {
  59   protected:
  60     static const int kmiCr       = 0x000;
  61     static const int kmiStat     = 0x004;
  62     static const int kmiData     = 0x008;
  63     static const int kmiClkDiv   = 0x00C;
  64     static const int kmiISR      = 0x010;
  65
  66     BitUnion8(ControlReg)
  67         Bitfield<0> force_clock_low;
  68         Bitfield<1> force_data_low;
  69         Bitfield<2> enable;
  70         Bitfield<3> txint_enable;
  71         Bitfield<4> rxint_enable;
  72         Bitfield<5> type;
  73     EndBitUnion(ControlReg)
  74
  75     /** control register
  76      */
  77     ControlReg control;
  78
  79     /** KMI status register */
  80     BitUnion8(StatusReg)
  81         Bitfield<0> data_in;
  82         Bitfield<1> clk_in;
  83         Bitfield<2> rxparity;
  84         Bitfield<3> rxbusy;
  85         Bitfield<4> rxfull;
  86         Bitfield<5> txbusy;
  87         Bitfield<6> txempty;
  88     EndBitUnion(StatusReg)
  89
  90     StatusReg status;
  91
  92     /** clock divisor register
  93      * This register is just kept around to satisfy reads after driver does
  94      * writes. The divsor does nothing, as we're not actually signaling ps2
  95      * serial commands to anything.
  96      */
  97     uint8_t clkdiv;
  98
  99     BitUnion8(InterruptReg)
 100         Bitfield<0> rx;
 101         Bitfield<1> tx;
 102     EndBitUnion(InterruptReg)
 103
 104     /** raw interrupt register (unmasked) */
 105     InterruptReg rawInterrupts;
 106
 107     /** If the controller should ignore the next data byte and acknowledge it.
 108      * The driver is attempting to setup some feature we don't care about
 109      */
 110     int ackNext;
 111
 112     /** is the shift key currently down */
 113     bool shiftDown;
 114
 115     /** The vnc server we're connected to (if any) */
 116     VncInput *vnc;
 117
 118     /** If the linux driver has initialized the device yet and thus can we send
 119      * mouse data */
 120     bool driverInitialized;
 121
 122     /** Update the status of the interrupt registers and schedule an interrupt
 123      * if required */
 124     void updateIntStatus();
 125
 126     /** Function to generate interrupt */
 127     void generateInterrupt();
 128
 129     /** Get interrupt value */
 130     InterruptReg getInterrupt() const {
 131         InterruptReg tmp_interrupt(0);
 132         tmp_interrupt.tx = rawInterrupts.tx & control.txint_enable;
 133         tmp_interrupt.rx = rawInterrupts.rx & control.rxint_enable;
 134         return tmp_interrupt;
 135     }
 136     /** Wrapper to create an event out of the thing */
 137     EventFunctionWrapper intEvent;
 138
 139     /** Receive queue. This list contains all the pending commands that
 140      * need to be sent to the driver
 141      */
 142     std::list<uint8_t> rxQueue;
 143
 144     /** Handle a command sent to the kmi and respond appropriately
 145      */
 146     void processCommand(uint8_t byte);
 147
 148   public:
 149     typedef Pl050Params Params;
 150     const Params *
 151     params() const
 152     {
 153         return dynamic_cast<const Params *>(_params);
 154     }
 155
 156     Pl050(const Params *p);
 157
 158     Tick read(PacketPtr pkt) override;
 159     Tick write(PacketPtr pkt) override;
 160
 161     void mouseAt(uint16_t x, uint16_t y, uint8_t buttons) override;
 162     void keyPress(uint32_t key, bool down) override;
 163
 164     void serialize(CheckpointOut &cp) const override;
 165     void unserialize(CheckpointIn &cp) override;
 166 };
 167
 168 #endif // __DEV_ARM_PL050_HH__