112653Sandreas.sandberg@arm.com/* 212653Sandreas.sandberg@arm.com * Copyright (c) 2017-2018 ARM Limited 312653Sandreas.sandberg@arm.com * All rights reserved 412653Sandreas.sandberg@arm.com * 512653Sandreas.sandberg@arm.com * The license below extends only to copyright in the software and shall 612653Sandreas.sandberg@arm.com * not be construed as granting a license to any other intellectual 712653Sandreas.sandberg@arm.com * property including but not limited to intellectual property relating 812653Sandreas.sandberg@arm.com * to a hardware implementation of the functionality of the software 912653Sandreas.sandberg@arm.com * licensed hereunder. You may use the software subject to the license 1012653Sandreas.sandberg@arm.com * terms below provided that you ensure that this notice is replicated 1112653Sandreas.sandberg@arm.com * unmodified and in its entirety in all distributions of the software, 1212653Sandreas.sandberg@arm.com * modified or unmodified, in source code or in binary form. 1312653Sandreas.sandberg@arm.com * 1412653Sandreas.sandberg@arm.com * Copyright (c) 2008 The Regents of The University of Michigan 1512653Sandreas.sandberg@arm.com * All rights reserved. 1612653Sandreas.sandberg@arm.com * 1712653Sandreas.sandberg@arm.com * Redistribution and use in source and binary forms, with or without 1812653Sandreas.sandberg@arm.com * modification, are permitted provided that the following conditions are 1912653Sandreas.sandberg@arm.com * met: redistributions of source code must retain the above copyright 2012653Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer; 2112653Sandreas.sandberg@arm.com * redistributions in binary form must reproduce the above copyright 2212653Sandreas.sandberg@arm.com * notice, this list of conditions and the following disclaimer in the 2312653Sandreas.sandberg@arm.com * documentation and/or other materials provided with the distribution; 2412653Sandreas.sandberg@arm.com * neither the name of the copyright holders nor the names of its 2512653Sandreas.sandberg@arm.com * contributors may be used to endorse or promote products derived from 2612653Sandreas.sandberg@arm.com * this software without specific prior written permission. 2712653Sandreas.sandberg@arm.com * 2812653Sandreas.sandberg@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2912653Sandreas.sandberg@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 3012653Sandreas.sandberg@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 3112653Sandreas.sandberg@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 3212653Sandreas.sandberg@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3312653Sandreas.sandberg@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3412653Sandreas.sandberg@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3512653Sandreas.sandberg@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3612653Sandreas.sandberg@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3712653Sandreas.sandberg@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3812653Sandreas.sandberg@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3912653Sandreas.sandberg@arm.com * 4012653Sandreas.sandberg@arm.com * Authors: Gabe Black 4112653Sandreas.sandberg@arm.com * Andreas Sandberg 4212653Sandreas.sandberg@arm.com */ 4312653Sandreas.sandberg@arm.com 4412653Sandreas.sandberg@arm.com#include "dev/ps2/keyboard.hh" 4512653Sandreas.sandberg@arm.com 4612653Sandreas.sandberg@arm.com#include "base/logging.hh" 4712653Sandreas.sandberg@arm.com#include "debug/PS2.hh" 4812660Sandreas.sandberg@arm.com#include "dev/ps2/types.hh" 4912653Sandreas.sandberg@arm.com#include "params/PS2Keyboard.hh" 5012653Sandreas.sandberg@arm.com 5112653Sandreas.sandberg@arm.comPS2Keyboard::PS2Keyboard(const PS2KeyboardParams *p) 5212653Sandreas.sandberg@arm.com : PS2Device(p), 5312654Sandreas.sandberg@arm.com shiftDown(false), 5412654Sandreas.sandberg@arm.com enabled(false) 5512653Sandreas.sandberg@arm.com{ 5612654Sandreas.sandberg@arm.com if (p->vnc) 5712654Sandreas.sandberg@arm.com p->vnc->setKeyboard(this); 5812653Sandreas.sandberg@arm.com} 5912653Sandreas.sandberg@arm.com 6012653Sandreas.sandberg@arm.comvoid 6112653Sandreas.sandberg@arm.comPS2Keyboard::serialize(CheckpointOut &cp) const 6212653Sandreas.sandberg@arm.com{ 6312653Sandreas.sandberg@arm.com PS2Device::serialize(cp); 6412654Sandreas.sandberg@arm.com SERIALIZE_SCALAR(shiftDown); 6512654Sandreas.sandberg@arm.com SERIALIZE_SCALAR(enabled); 6612653Sandreas.sandberg@arm.com} 6712653Sandreas.sandberg@arm.com 6812653Sandreas.sandberg@arm.comvoid 6912653Sandreas.sandberg@arm.comPS2Keyboard::unserialize(CheckpointIn &cp) 7012653Sandreas.sandberg@arm.com{ 7112653Sandreas.sandberg@arm.com PS2Device::unserialize(cp); 7212654Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(shiftDown); 7312654Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(enabled); 7412653Sandreas.sandberg@arm.com} 7512653Sandreas.sandberg@arm.com 7612656Sandreas.sandberg@arm.combool 7712656Sandreas.sandberg@arm.comPS2Keyboard::recv(const std::vector<uint8_t> &data) 7812653Sandreas.sandberg@arm.com{ 7912656Sandreas.sandberg@arm.com switch (data[0]) { 8012660Sandreas.sandberg@arm.com case Ps2::ReadID: 8112660Sandreas.sandberg@arm.com DPRINTF(PS2, "Got keyboard read ID command.\n"); 8212660Sandreas.sandberg@arm.com sendAck(); 8312660Sandreas.sandberg@arm.com send(Ps2::Keyboard::ID); 8412660Sandreas.sandberg@arm.com return true; 8512660Sandreas.sandberg@arm.com case Ps2::Enable: 8612660Sandreas.sandberg@arm.com DPRINTF(PS2, "Enabling the keyboard.\n"); 8712660Sandreas.sandberg@arm.com enabled = true; 8812660Sandreas.sandberg@arm.com sendAck(); 8912660Sandreas.sandberg@arm.com return true; 9012660Sandreas.sandberg@arm.com case Ps2::Disable: 9112660Sandreas.sandberg@arm.com DPRINTF(PS2, "Disabling the keyboard.\n"); 9212660Sandreas.sandberg@arm.com enabled = false; 9312660Sandreas.sandberg@arm.com sendAck(); 9412660Sandreas.sandberg@arm.com return true; 9512660Sandreas.sandberg@arm.com case Ps2::DefaultsAndDisable: 9612660Sandreas.sandberg@arm.com DPRINTF(PS2, "Disabling and resetting the keyboard.\n"); 9712660Sandreas.sandberg@arm.com enabled = false; 9812660Sandreas.sandberg@arm.com sendAck(); 9912660Sandreas.sandberg@arm.com return true; 10012660Sandreas.sandberg@arm.com case Ps2::Reset: 10112660Sandreas.sandberg@arm.com DPRINTF(PS2, "Resetting keyboard.\n"); 10212660Sandreas.sandberg@arm.com enabled = true; 10312660Sandreas.sandberg@arm.com sendAck(); 10412660Sandreas.sandberg@arm.com send(Ps2::SelfTestPass); 10512660Sandreas.sandberg@arm.com return true; 10612660Sandreas.sandberg@arm.com case Ps2::Resend: 10712660Sandreas.sandberg@arm.com panic("Keyboard resend unimplemented.\n"); 10812660Sandreas.sandberg@arm.com 10912660Sandreas.sandberg@arm.com case Ps2::Keyboard::LEDWrite: 11012656Sandreas.sandberg@arm.com if (data.size() == 1) { 11112656Sandreas.sandberg@arm.com DPRINTF(PS2, "Got LED write command.\n"); 11212656Sandreas.sandberg@arm.com sendAck(); 11312656Sandreas.sandberg@arm.com return false; 11412656Sandreas.sandberg@arm.com } else { 11512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting LEDs: " 11612653Sandreas.sandberg@arm.com "caps lock %s, num lock %s, scroll lock %s\n", 11712656Sandreas.sandberg@arm.com bits(data[1], 2) ? "on" : "off", 11812656Sandreas.sandberg@arm.com bits(data[1], 1) ? "on" : "off", 11912656Sandreas.sandberg@arm.com bits(data[1], 0) ? "on" : "off"); 12012653Sandreas.sandberg@arm.com sendAck(); 12112656Sandreas.sandberg@arm.com return true; 12212653Sandreas.sandberg@arm.com } 12312660Sandreas.sandberg@arm.com case Ps2::Keyboard::DiagnosticEcho: 12412653Sandreas.sandberg@arm.com panic("Keyboard diagnostic echo unimplemented.\n"); 12512660Sandreas.sandberg@arm.com case Ps2::Keyboard::AlternateScanCodes: 12612653Sandreas.sandberg@arm.com panic("Accessing alternate scan codes unimplemented.\n"); 12712660Sandreas.sandberg@arm.com case Ps2::Keyboard::TypematicInfo: 12812656Sandreas.sandberg@arm.com if (data.size() == 1) { 12912656Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting typematic info.\n"); 13012656Sandreas.sandberg@arm.com sendAck(); 13112656Sandreas.sandberg@arm.com return false; 13212656Sandreas.sandberg@arm.com } else { 13312656Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting typematic info to %#02x.\n", data[1]); 13412656Sandreas.sandberg@arm.com sendAck(); 13512656Sandreas.sandberg@arm.com return true; 13612656Sandreas.sandberg@arm.com } 13712660Sandreas.sandberg@arm.com case Ps2::Keyboard::AllKeysToTypematic: 13812653Sandreas.sandberg@arm.com panic("Setting all keys to typemantic unimplemented.\n"); 13912660Sandreas.sandberg@arm.com case Ps2::Keyboard::AllKeysToMakeRelease: 14012653Sandreas.sandberg@arm.com panic("Setting all keys to make/release unimplemented.\n"); 14112660Sandreas.sandberg@arm.com case Ps2::Keyboard::AllKeysToMake: 14212653Sandreas.sandberg@arm.com panic("Setting all keys to make unimplemented.\n"); 14312660Sandreas.sandberg@arm.com case Ps2::Keyboard::AllKeysToTypematicMakeRelease: 14412653Sandreas.sandberg@arm.com panic("Setting all keys to " 14512653Sandreas.sandberg@arm.com "typematic/make/release unimplemented.\n"); 14612660Sandreas.sandberg@arm.com case Ps2::Keyboard::KeyToTypematic: 14712653Sandreas.sandberg@arm.com panic("Setting a key to typematic unimplemented.\n"); 14812660Sandreas.sandberg@arm.com case Ps2::Keyboard::KeyToMakeRelease: 14912653Sandreas.sandberg@arm.com panic("Setting a key to make/release unimplemented.\n"); 15012660Sandreas.sandberg@arm.com case Ps2::Keyboard::KeyToMakeOnly: 15112653Sandreas.sandberg@arm.com panic("Setting key to make only unimplemented.\n"); 15212653Sandreas.sandberg@arm.com default: 15312656Sandreas.sandberg@arm.com panic("Unknown keyboard command %#02x.\n", data[0]); 15412653Sandreas.sandberg@arm.com } 15512653Sandreas.sandberg@arm.com} 15612653Sandreas.sandberg@arm.com 15712654Sandreas.sandberg@arm.comvoid 15812654Sandreas.sandberg@arm.comPS2Keyboard::keyPress(uint32_t key, bool down) 15912654Sandreas.sandberg@arm.com{ 16012654Sandreas.sandberg@arm.com std::list<uint8_t> keys; 16112654Sandreas.sandberg@arm.com 16212654Sandreas.sandberg@arm.com // convert the X11 keysym into ps2 codes and update the shift 16312654Sandreas.sandberg@arm.com // state (shiftDown) 16412654Sandreas.sandberg@arm.com Ps2::keySymToPs2(key, down, shiftDown, keys); 16512654Sandreas.sandberg@arm.com 16612654Sandreas.sandberg@arm.com // Drop key presses if the keyboard hasn't been enabled by the 16712654Sandreas.sandberg@arm.com // host. We do that after translating the key code to ensure that 16812654Sandreas.sandberg@arm.com // we keep track of the shift state. 16912654Sandreas.sandberg@arm.com if (!enabled) 17012654Sandreas.sandberg@arm.com return; 17112654Sandreas.sandberg@arm.com 17212654Sandreas.sandberg@arm.com // Insert into our queue of characters 17312654Sandreas.sandberg@arm.com for (uint8_t c : keys) 17412654Sandreas.sandberg@arm.com send(c); 17512654Sandreas.sandberg@arm.com} 17612654Sandreas.sandberg@arm.com 17712654Sandreas.sandberg@arm.com 17812653Sandreas.sandberg@arm.comPS2Keyboard * 17912653Sandreas.sandberg@arm.comPS2KeyboardParams::create() 18012653Sandreas.sandberg@arm.com{ 18112653Sandreas.sandberg@arm.com return new PS2Keyboard(this); 18212653Sandreas.sandberg@arm.com} 183