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: Ali Saidi
41 * William Wang
42 */
43
44#include "base/vnc/vncinput.hh"
45#include "base/trace.hh"
46#include "debug/Pl050.hh"
47#include "dev/arm/amba_device.hh"
48#include "dev/arm/kmi.hh"
49#include "dev/ps2.hh"
50#include "mem/packet.hh"
51#include "mem/packet_access.hh"
52
53Pl050::Pl050(const Params *p)
54 : AmbaIntDevice(p, 0xfff), control(0), status(0x43), clkdiv(0),
55 interrupts(0), rawInterrupts(0), ackNext(false), shiftDown(false),
56 vnc(p->vnc), driverInitialized(false), intEvent(this)
57{
58 if (vnc) {
59 if (!p->is_mouse)
60 vnc->setKeyboard(this);
61 else
62 vnc->setMouse(this);
63 }
64}
65
66Tick
67Pl050::read(PacketPtr pkt)
68{
69 assert(pkt->getAddr() >= pioAddr && pkt->getAddr() < pioAddr + pioSize);
70
71 Addr daddr = pkt->getAddr() - pioAddr;
72 pkt->allocate();
73
74
75 uint32_t data = 0;
76
77 switch (daddr) {
78 case kmiCr:
79 DPRINTF(Pl050, "Read Commmand: %#x\n", (uint32_t)control);
80 data = control;
81 break;
82 case kmiStat:
83 if (rxQueue.empty())
84 status.rxfull = 0;
85 else
86 status.rxfull = 1;
87
88 DPRINTF(Pl050, "Read Status: %#x\n", (uint32_t)status);
89 data = status;
90 break;
91 case kmiData:
92 if (rxQueue.empty()) {
93 data = 0;
94 } else {
95 data = rxQueue.front();
96 rxQueue.pop_front();
97 }
98 DPRINTF(Pl050, "Read Data: %#x\n", (uint32_t)data);
99 updateIntStatus();
100 break;
101 case kmiClkDiv:
102 data = clkdiv;
103 break;
104 case kmiISR:
105 data = interrupts;
106 DPRINTF(Pl050, "Read Interrupts: %#x\n", (uint32_t)interrupts);
107 break;
108 default:
109 if (readId(pkt, ambaId, pioAddr)) {
110 // Hack for variable size accesses
111 data = pkt->get<uint32_t>();
112 break;
113 }
114
115 warn("Tried to read PL050 at offset %#x that doesn't exist\n", daddr);
116 break;
117 }
118
119 switch(pkt->getSize()) {
120 case 1:
121 pkt->set<uint8_t>(data);
122 break;
123 case 2:
124 pkt->set<uint16_t>(data);
125 break;
126 case 4:
127 pkt->set<uint32_t>(data);
128 break;
129 default:
130 panic("KMI read size too big?\n");
131 break;
132 }
133
134 pkt->makeAtomicResponse();
135 return pioDelay;
136}
137
138Tick
139Pl050::write(PacketPtr pkt)
140{
141
142 assert(pkt->getAddr() >= pioAddr && pkt->getAddr() < pioAddr + pioSize);
143
144 Addr daddr = pkt->getAddr() - pioAddr;
145
146 assert(pkt->getSize() == sizeof(uint8_t));
147
148
149 switch (daddr) {
150 case kmiCr:
151 DPRINTF(Pl050, "Write Commmand: %#x\n", (uint32_t)pkt->get<uint8_t>());
152 control = pkt->get<uint8_t>();
153 updateIntStatus();
154 break;
155 case kmiData:
156 DPRINTF(Pl050, "Write Data: %#x\n", (uint32_t)pkt->get<uint8_t>());
157 processCommand(pkt->get<uint8_t>());
158 updateIntStatus();
159 break;
160 case kmiClkDiv:
161 clkdiv = pkt->get<uint8_t>();
162 break;
163 default:
164 warn("Tried to write PL050 at offset %#x that doesn't exist\n", daddr);
165 break;
166 }
167 pkt->makeAtomicResponse();
168 return pioDelay;
169}
170
171void
172Pl050::processCommand(uint8_t byte)
173{
174 using namespace Ps2;
175
176 if (ackNext) {
177 ackNext--;
178 rxQueue.push_back(Ack);
179 updateIntStatus();
180 return;
181 }
182
183 switch (byte) {
184 case Ps2Reset:
185 rxQueue.push_back(Ack);
186 rxQueue.push_back(SelfTestPass);
187 break;
188 case SetResolution:
189 case SetRate:
190 case SetStatusLed:
191 case SetScaling1_1:
192 case SetScaling1_2:
193 rxQueue.push_back(Ack);
194 ackNext = 1;
195 break;
196 case ReadId:
197 rxQueue.push_back(Ack);
198 if (params()->is_mouse)
199 rxQueue.push_back(MouseId);
200 else
201 rxQueue.push_back(KeyboardId);
202 break;
203 case TpReadId:
204 if (!params()->is_mouse)
205 break;
206 // We're not a trackpoint device, this should make the probe go away
207 rxQueue.push_back(Ack);
208 rxQueue.push_back(0);
209 rxQueue.push_back(0);
210 // fall through
211 case Disable:
212 case Enable:
213 case SetDefaults:
214 rxQueue.push_back(Ack);
215 break;
216 case StatusRequest:
217 rxQueue.push_back(Ack);
218 rxQueue.push_back(0);
219 rxQueue.push_back(2); // default resolution
220 rxQueue.push_back(100); // default sample rate
221 break;
222 case TouchKitId:
223 ackNext = 2;
224 rxQueue.push_back(Ack);
225 rxQueue.push_back(TouchKitId);
226 rxQueue.push_back(1);
227 rxQueue.push_back('A');
228
229 driverInitialized = true;
230 break;
231 default:
232 panic("Unknown byte received: %d\n", byte);
233 }
234
235 updateIntStatus();
236}
237
238
239void
240Pl050::updateIntStatus()
241{
242 if (!rxQueue.empty())
243 rawInterrupts.rx = 1;
244 else
245 rawInterrupts.rx = 0;
246
247 interrupts.tx = rawInterrupts.tx & control.txint_enable;
248 interrupts.rx = rawInterrupts.rx & control.rxint_enable;
249
250 DPRINTF(Pl050, "rawInterupts=%#x control=%#x interrupts=%#x\n",
251 (uint32_t)rawInterrupts, (uint32_t)control, (uint32_t)interrupts);
252
253 if (interrupts && !intEvent.scheduled())
254 schedule(intEvent, curTick() + intDelay);
255}
256
257void
258Pl050::generateInterrupt()
259{
260
261 if (interrupts) {
262 gic->sendInt(intNum);
263 DPRINTF(Pl050, "Generated interrupt\n");
264 }
265}
266
267void
268Pl050::mouseAt(uint16_t x, uint16_t y, uint8_t buttons)
269{
270 using namespace Ps2;
271
272 // If the driver hasn't initialized the device yet, no need to try and send
273 // it anything. Similarly we can get vnc mouse events orders of maginture
274 // faster than m5 can process them. Only queue up two sets mouse movements
275 // and don't add more until those are processed.
276 if (!driverInitialized || rxQueue.size() > 10)
277 return;
278
279 // We shouldn't be here unless a vnc server called us in which case
280 // we should have a pointer to it
281 assert(vnc);
282
283 // Convert screen coordinates to touchpad coordinates
284 uint16_t _x = (2047.0/vnc->videoWidth()) * x;
285 uint16_t _y = (2047.0/vnc->videoHeight()) * y;
286
287 rxQueue.push_back(buttons);
288 rxQueue.push_back(_x >> 7);
289 rxQueue.push_back(_x & 0x7f);
290 rxQueue.push_back(_y >> 7);
291 rxQueue.push_back(_y & 0x7f);
292
293 updateIntStatus();
294}
295
296
297void
298Pl050::keyPress(uint32_t key, bool down)
299{
300 using namespace Ps2;
301
302 std::list<uint8_t> keys;
303
304 // convert the X11 keysym into ps2 codes
305 keySymToPs2(key, down, shiftDown, keys);
306
307 // Insert into our queue of charecters
308 rxQueue.splice(rxQueue.end(), keys);
309 updateIntStatus();
310}
311
312void
313Pl050::serialize(std::ostream &os)
314{
315 uint8_t ctrlreg = control;
316 SERIALIZE_SCALAR(ctrlreg);
317
318 uint8_t stsreg = status;
319 SERIALIZE_SCALAR(stsreg);
320 SERIALIZE_SCALAR(clkdiv);
321
322 uint8_t ints = interrupts;
323 SERIALIZE_SCALAR(ints);
324
325 uint8_t raw_ints = rawInterrupts;
326 SERIALIZE_SCALAR(raw_ints);
327
328 SERIALIZE_SCALAR(ackNext);
329 SERIALIZE_SCALAR(shiftDown);
330 SERIALIZE_SCALAR(driverInitialized);
331
332 arrayParamOut(os, "rxQueue", rxQueue);
333}
334
335void
336Pl050::unserialize(Checkpoint *cp, const std::string &section)
337{
338 uint8_t ctrlreg;
339 UNSERIALIZE_SCALAR(ctrlreg);
340 control = ctrlreg;
341
342 uint8_t stsreg;
343 UNSERIALIZE_SCALAR(stsreg);
344 status = stsreg;
345
346 UNSERIALIZE_SCALAR(clkdiv);
347
348 uint8_t ints;
349 UNSERIALIZE_SCALAR(ints);
350 interrupts = ints;
351
352 uint8_t raw_ints;
353 UNSERIALIZE_SCALAR(raw_ints);
354 rawInterrupts = raw_ints;
355
356 UNSERIALIZE_SCALAR(ackNext);
357 UNSERIALIZE_SCALAR(shiftDown);
358 UNSERIALIZE_SCALAR(driverInitialized);
359
360 arrayParamIn(cp, section, "rxQueue", rxQueue);
361}
362
363
364
365Pl050 *
366Pl050Params::create()
367{
368 return new Pl050(this);
369}