2 * Copyright (c) 2010 ARM Limited
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.
14 * Copyright (c) 2005 The Regents of The University of Michigan
15 * All rights reserved.
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.
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.
40 * Authors: William Wang
45 * Implementiation of a PL050 KMI
48 #ifndef __DEV_ARM_PL050_HH__
49 #define __DEV_ARM_PL050_HH__
53 #include "base/vnc/vncinput.hh"
54 #include "dev/arm/amba_device.hh"
55 #include "params/Pl050.hh"
57 class Pl050 : public AmbaIntDevice, public VncKeyboard, public VncMouse
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;
67 Bitfield<0> force_clock_low;
68 Bitfield<1> force_data_low;
70 Bitfield<3> txint_enable;
71 Bitfield<4> rxint_enable;
73 EndBitUnion(ControlReg)
79 /** KMI status register */
88 EndBitUnion(StatusReg)
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.
99 BitUnion8(InterruptReg)
102 EndBitUnion(InterruptReg)
104 /** interrupt status register. */
105 InterruptReg interrupts;
107 /** raw interrupt register (unmasked) */
108 InterruptReg rawInterrupts;
110 /** If the controller should ignore the next data byte and acknowledge it.
111 * The driver is attempting to setup some feature we don't care about
115 /** is the shift key currently down */
118 /** The vnc server we're connected to (if any) */
121 /** If the linux driver has initialized the device yet and thus can we send
123 bool driverInitialized;
125 /** Update the status of the interrupt registers and schedule an interrupt
127 void updateIntStatus();
129 /** Function to generate interrupt */
130 void generateInterrupt();
132 /** Wrapper to create an event out of the thing */
133 EventWrapper<Pl050, &Pl050::generateInterrupt> intEvent;
135 /** Receive queue. This list contains all the pending commands that
136 * need to be sent to the driver
138 std::list<uint8_t> rxQueue;
140 /** Handle a command sent to the kmi and respond appropriately
142 void processCommand(uint8_t byte);
145 typedef Pl050Params Params;
149 return dynamic_cast<const Params *>(_params);
152 Pl050(const Params *p);
154 virtual Tick read(PacketPtr pkt);
155 virtual Tick write(PacketPtr pkt);
157 virtual void mouseAt(uint16_t x, uint16_t y, uint8_t buttons);
158 virtual void keyPress(uint32_t key, bool down);
160 void serialize(CheckpointOut &cp) const M5_ATTR_OVERRIDE;
161 void unserialize(CheckpointIn &cp) M5_ATTR_OVERRIDE;
164 #endif // __DEV_ARM_PL050_HH__