kmi.cc revision 12645:65086402bfcb 
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: Ali Saidi
41 *          William Wang
42 */
43
44#include "dev/arm/kmi.hh"
45
46#include "base/trace.hh"
47#include "base/vnc/vncinput.hh"
48#include "debug/Pl050.hh"
49#include "dev/arm/amba_device.hh"
50#include "dev/ps2.hh"
51#include "mem/packet.hh"
52#include "mem/packet_access.hh"
53
54Pl050::Pl050(const Params *p)
55    : AmbaIntDevice(p, 0xfff), control(0), status(0x43), clkdiv(0),
56      rawInterrupts(0), ackNext(false), shiftDown(false),
57      vnc(p->vnc), driverInitialized(false),
58      intEvent([this]{ generateInterrupt(); }, name())
59{
60    if (vnc) {
61        if (!p->is_mouse)
62            vnc->setKeyboard(this);
63        else
64            vnc->setMouse(this);
65    }
66}
67
68Tick
69Pl050::read(PacketPtr pkt)
70{
71    assert(pkt->getAddr() >= pioAddr && pkt->getAddr() < pioAddr + pioSize);
72
73    Addr daddr = pkt->getAddr() - pioAddr;
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 = getInterrupt();
106        DPRINTF(Pl050, "Read Interrupts: %#x\n", getInterrupt());
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        rxQueue.push_back(Ack);
192        ackNext = 1;
193        break;
194      case ReadId:
195        rxQueue.push_back(Ack);
196        if (params()->is_mouse)
197            rxQueue.push_back(MouseId);
198        else
199            rxQueue.push_back(KeyboardId);
200        break;
201      case TpReadId:
202        if (!params()->is_mouse)
203            break;
204        // We're not a trackpoint device, this should make the probe go away
205        rxQueue.push_back(Ack);
206        rxQueue.push_back(0);
207        rxQueue.push_back(0);
208        // fall through
209      case Disable:
210      case Enable:
211      case SetDefaults:
212      case SetScaling1_1:
213      case SetScaling1_2:
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    const bool old_interrupt(getInterrupt());
243
244    if (!rxQueue.empty())
245        rawInterrupts.rx = 1;
246    else
247        rawInterrupts.rx = 0;
248
249    if ((!old_interrupt && getInterrupt()) && !intEvent.scheduled()) {
250        schedule(intEvent, curTick() + intDelay);
251    } else if (old_interrupt && !(getInterrupt())) {
252            gic->clearInt(intNum);
253    }
254}
255
256void
257Pl050::generateInterrupt()
258{
259    DPRINTF(Pl050, "Generate Interrupt: rawInt=%#x ctrl=%#x int=%#x\n",
260            rawInterrupts, control, getInterrupt());
261
262    if (getInterrupt()) {
263        gic->sendInt(intNum);
264        DPRINTF(Pl050, " -- Generated\n");
265    }
266}
267
268void
269Pl050::mouseAt(uint16_t x, uint16_t y, uint8_t buttons)
270{
271    using namespace Ps2;
272
273    // If the driver hasn't initialized the device yet, no need to try and send
274    // it anything. Similarly we can get vnc mouse events orders of maginture
275    // faster than m5 can process them. Only queue up two sets mouse movements
276    // and don't add more until those are processed.
277    if (!driverInitialized || rxQueue.size() > 10)
278        return;
279
280    // We shouldn't be here unless a vnc server called us in which case
281    // we should have a pointer to it
282    assert(vnc);
283
284    // Convert screen coordinates to touchpad coordinates
285    uint16_t _x = (2047.0/vnc->videoWidth()) * x;
286    uint16_t _y = (2047.0/vnc->videoHeight()) * y;
287
288    rxQueue.push_back(buttons);
289    rxQueue.push_back(_x >> 7);
290    rxQueue.push_back(_x & 0x7f);
291    rxQueue.push_back(_y >> 7);
292    rxQueue.push_back(_y & 0x7f);
293
294    updateIntStatus();
295}
296
297
298void
299Pl050::keyPress(uint32_t key, bool down)
300{
301    using namespace Ps2;
302
303    std::list<uint8_t> keys;
304
305    // convert the X11 keysym into ps2 codes
306    keySymToPs2(key, down, shiftDown, keys);
307
308    // Insert into our queue of charecters
309    rxQueue.splice(rxQueue.end(), keys);
310    updateIntStatus();
311}
312
313void
314Pl050::serialize(CheckpointOut &cp) const
315{
316    uint8_t ctrlreg = control;
317    SERIALIZE_SCALAR(ctrlreg);
318
319    uint8_t stsreg = status;
320    SERIALIZE_SCALAR(stsreg);
321    SERIALIZE_SCALAR(clkdiv);
322
323    uint8_t raw_ints = rawInterrupts;
324    SERIALIZE_SCALAR(raw_ints);
325
326    SERIALIZE_SCALAR(ackNext);
327    SERIALIZE_SCALAR(shiftDown);
328    SERIALIZE_SCALAR(driverInitialized);
329
330    SERIALIZE_CONTAINER(rxQueue);
331}
332
333void
334Pl050::unserialize(CheckpointIn &cp)
335{
336    uint8_t ctrlreg;
337    UNSERIALIZE_SCALAR(ctrlreg);
338    control = ctrlreg;
339
340    uint8_t stsreg;
341    UNSERIALIZE_SCALAR(stsreg);
342    status = stsreg;
343
344    UNSERIALIZE_SCALAR(clkdiv);
345
346    uint8_t raw_ints;
347    UNSERIALIZE_SCALAR(raw_ints);
348    rawInterrupts = raw_ints;
349
350    UNSERIALIZE_SCALAR(ackNext);
351    UNSERIALIZE_SCALAR(shiftDown);
352    UNSERIALIZE_SCALAR(driverInitialized);
353
354    UNSERIALIZE_CONTAINER(rxQueue);
355}
356
357
358
359Pl050 *
360Pl050Params::create()
361{
362    return new Pl050(this);
363}
364