kmi.cc revision 8229
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/vncserver.hh" 45#include "base/trace.hh" 46#include "dev/arm/amba_device.hh" 47#include "dev/arm/kmi.hh" 48#include "dev/ps2.hh" 49#include "mem/packet.hh" 50#include "mem/packet_access.hh" 51 52Pl050::Pl050(const Params *p) 53 : AmbaIntDevice(p), control(0), status(0x43), clkdiv(0), interrupts(0), 54 rawInterrupts(0), ackNext(false), shiftDown(false), vnc(p->vnc), 55 driverInitialized(false), intEvent(this) 56{ 57 pioSize = 0xfff; 58 59 if (vnc) { 60 if (!p->is_mouse) 61 vnc->setKeyboard(this); 62 else 63 vnc->setMouse(this); 64 } 65} 66 67Tick 68Pl050::read(PacketPtr pkt) 69{ 70 assert(pkt->getAddr() >= pioAddr && pkt->getAddr() < pioAddr + pioSize); 71 72 Addr daddr = pkt->getAddr() - pioAddr; 73 pkt->allocate(); 74 75 76 uint32_t data = 0; 77 78 switch (daddr) { 79 case kmiCr: 80 DPRINTF(Pl050, "Read Commmand: %#x\n", (uint32_t)control); 81 data = control; 82 break; 83 case kmiStat: 84 if (rxQueue.empty()) 85 status.rxfull = 0; 86 else 87 status.rxfull = 1; 88 89 DPRINTF(Pl050, "Read Status: %#x\n", (uint32_t)status); 90 data = status; 91 break; 92 case kmiData: 93 if (rxQueue.empty()) { 94 data = 0; 95 } else { 96 data = rxQueue.front(); 97 rxQueue.pop_front(); 98 } 99 DPRINTF(Pl050, "Read Data: %#x\n", (uint32_t)data); 100 updateIntStatus(); 101 break; 102 case kmiClkDiv: 103 data = clkdiv; 104 break; 105 case kmiISR: 106 data = interrupts; 107 DPRINTF(Pl050, "Read Interrupts: %#x\n", (uint32_t)interrupts); 108 break; 109 default: 110 if (AmbaDev::readId(pkt, ambaId, pioAddr)) { 111 // Hack for variable size accesses 112 data = pkt->get<uint32_t>(); 113 break; 114 } 115 116 warn("Tried to read PL050 at offset %#x that doesn't exist\n", daddr); 117 break; 118 } 119 120 switch(pkt->getSize()) { 121 case 1: 122 pkt->set<uint8_t>(data); 123 break; 124 case 2: 125 pkt->set<uint16_t>(data); 126 break; 127 case 4: 128 pkt->set<uint32_t>(data); 129 break; 130 default: 131 panic("KMI read size too big?\n"); 132 break; 133 } 134 135 pkt->makeAtomicResponse(); 136 return pioDelay; 137} 138 139Tick 140Pl050::write(PacketPtr pkt) 141{ 142 143 assert(pkt->getAddr() >= pioAddr && pkt->getAddr() < pioAddr + pioSize); 144 145 Addr daddr = pkt->getAddr() - pioAddr; 146 147 assert(pkt->getSize() == sizeof(uint8_t)); 148 149 150 switch (daddr) { 151 case kmiCr: 152 DPRINTF(Pl050, "Write Commmand: %#x\n", (uint32_t)pkt->get<uint8_t>()); 153 control = pkt->get<uint8_t>(); 154 updateIntStatus(); 155 break; 156 case kmiData: 157 DPRINTF(Pl050, "Write Data: %#x\n", (uint32_t)pkt->get<uint8_t>()); 158 processCommand(pkt->get<uint8_t>()); 159 updateIntStatus(); 160 break; 161 case kmiClkDiv: 162 clkdiv = pkt->get<uint8_t>(); 163 break; 164 default: 165 warn("Tried to write PL050 at offset %#x that doesn't exist\n", daddr); 166 break; 167 } 168 pkt->makeAtomicResponse(); 169 return pioDelay; 170} 171 172void 173Pl050::processCommand(uint8_t byte) 174{ 175 using namespace Ps2; 176 177 if (ackNext) { 178 ackNext--; 179 rxQueue.push_back(Ack); 180 updateIntStatus(); 181 return; 182 } 183 184 switch (byte) { 185 case Ps2Reset: 186 rxQueue.push_back(Ack); 187 rxQueue.push_back(SelfTestPass); 188 break; 189 case SetResolution: 190 case SetRate: 191 case SetStatusLed: 192 case SetScaling1_1: 193 case SetScaling1_2: 194 rxQueue.push_back(Ack); 195 ackNext = 1; 196 break; 197 case ReadId: 198 rxQueue.push_back(Ack); 199 if (params()->is_mouse) 200 rxQueue.push_back(MouseId); 201 else 202 rxQueue.push_back(KeyboardId); 203 break; 204 case TpReadId: 205 if (!params()->is_mouse) 206 break; 207 // We're not a trackpoint device, this should make the probe go away 208 rxQueue.push_back(Ack); 209 rxQueue.push_back(0); 210 rxQueue.push_back(0); 211 // fall through 212 case Disable: 213 case Enable: 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 §ion) 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} 370