kmi.hh revision 8229:78bf55f23338 
1/*
2 * Copyright (c) 2010 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/vncserver.hh"
54#include "base/range.hh"
55#include "dev/arm/amba_device.hh"
56#include "params/Pl050.hh"
57
58class Gic;
59
60class Pl050 : public AmbaIntDevice, public VncKeyboard, public VncMouse
61{
62  protected:
63    static const int kmiCr       = 0x000;
64    static const int kmiStat     = 0x004;
65    static const int kmiData     = 0x008;
66    static const int kmiClkDiv   = 0x00C;
67    static const int kmiISR      = 0x010;
68
69    BitUnion8(ControlReg)
70        Bitfield<0> force_clock_low;
71        Bitfield<1> force_data_low;
72        Bitfield<2> enable;
73        Bitfield<3> txint_enable;
74        Bitfield<4> rxint_enable;
75        Bitfield<5> type;
76    EndBitUnion(ControlReg)
77
78    /** control register
79     */
80    ControlReg control;
81
82    /** KMI status register */
83    BitUnion8(StatusReg)
84        Bitfield<0> data_in;
85        Bitfield<1> clk_in;
86        Bitfield<2> rxparity;
87        Bitfield<3> rxbusy;
88        Bitfield<4> rxfull;
89        Bitfield<5> txbusy;
90        Bitfield<6> txempty;
91    EndBitUnion(StatusReg)
92
93    StatusReg status;
94
95    /** clock divisor register
96     * This register is just kept around to satisfy reads after driver does
97     * writes. The divsor does nothing, as we're not actually signaling ps2
98     * serial commands to anything.
99     */
100    uint8_t clkdiv;
101
102    BitUnion8(InterruptReg)
103        Bitfield<0> rx;
104        Bitfield<1> tx;
105    EndBitUnion(InterruptReg)
106
107    /** interrupt status register. */
108    InterruptReg interrupts;
109
110    /** raw interrupt register (unmasked) */
111    InterruptReg rawInterrupts;
112
113    /** If the controller should ignore the next data byte and acknowledge it.
114     * The driver is attempting to setup some feature we don't care about
115     */
116    int ackNext;
117
118    /** is the shift key currently down */
119    bool shiftDown;
120
121    /** The vnc server we're connected to (if any) */
122    VncServer *vnc;
123
124    /** If the linux driver has initialized the device yet and thus can we send
125     * mouse data */
126    bool driverInitialized;
127
128    /** Update the status of the interrupt registers and schedule an interrupt
129     * if required */
130    void updateIntStatus();
131
132    /** Function to generate interrupt */
133    void generateInterrupt();
134
135    /** Wrapper to create an event out of the thing */
136    EventWrapper<Pl050, &Pl050::generateInterrupt> intEvent;
137
138    /** Receive queue. This list contains all the pending commands that
139     * need to be sent to the driver
140     */
141    std::list<uint8_t> rxQueue;
142
143    /** Handle a command sent to the kmi and respond appropriately
144     */
145    void processCommand(uint8_t byte);
146
147  public:
148    typedef Pl050Params Params;
149    const Params *
150    params() const
151    {
152        return dynamic_cast<const Params *>(_params);
153    }
154
155    Pl050(const Params *p);
156
157    virtual Tick read(PacketPtr pkt);
158    virtual Tick write(PacketPtr pkt);
159
160    virtual void mouseAt(uint16_t x, uint16_t y, uint8_t buttons);
161    virtual void keyPress(uint32_t key, bool down);
162
163    virtual void serialize(std::ostream &os);
164    virtual void unserialize(Checkpoint *cp, const std::string &section);
165};
166
167#endif // __DEV_ARM_PL050_HH__
168