keyboard.cc revision 12654
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" 4812654Sandreas.sandberg@arm.com#include "dev/ps2.hh" 4912653Sandreas.sandberg@arm.com#include "params/PS2Keyboard.hh" 5012653Sandreas.sandberg@arm.com 5112653Sandreas.sandberg@arm.comconst uint8_t PS2Keyboard::ID[] = {0xab, 0x83}; 5212653Sandreas.sandberg@arm.com 5312653Sandreas.sandberg@arm.comPS2Keyboard::PS2Keyboard(const PS2KeyboardParams *p) 5412653Sandreas.sandberg@arm.com : PS2Device(p), 5512654Sandreas.sandberg@arm.com lastCommand(NoCommand), 5612654Sandreas.sandberg@arm.com shiftDown(false), 5712654Sandreas.sandberg@arm.com enabled(false) 5812653Sandreas.sandberg@arm.com{ 5912654Sandreas.sandberg@arm.com if (p->vnc) 6012654Sandreas.sandberg@arm.com p->vnc->setKeyboard(this); 6112653Sandreas.sandberg@arm.com} 6212653Sandreas.sandberg@arm.com 6312653Sandreas.sandberg@arm.comvoid 6412653Sandreas.sandberg@arm.comPS2Keyboard::serialize(CheckpointOut &cp) const 6512653Sandreas.sandberg@arm.com{ 6612653Sandreas.sandberg@arm.com PS2Device::serialize(cp); 6712653Sandreas.sandberg@arm.com SERIALIZE_SCALAR(lastCommand); 6812654Sandreas.sandberg@arm.com SERIALIZE_SCALAR(shiftDown); 6912654Sandreas.sandberg@arm.com SERIALIZE_SCALAR(enabled); 7012653Sandreas.sandberg@arm.com} 7112653Sandreas.sandberg@arm.com 7212653Sandreas.sandberg@arm.comvoid 7312653Sandreas.sandberg@arm.comPS2Keyboard::unserialize(CheckpointIn &cp) 7412653Sandreas.sandberg@arm.com{ 7512653Sandreas.sandberg@arm.com PS2Device::unserialize(cp); 7612653Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(lastCommand); 7712654Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(shiftDown); 7812654Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(enabled); 7912653Sandreas.sandberg@arm.com} 8012653Sandreas.sandberg@arm.com 8112653Sandreas.sandberg@arm.comvoid 8212653Sandreas.sandberg@arm.comPS2Keyboard::recv(uint8_t data) 8312653Sandreas.sandberg@arm.com{ 8412653Sandreas.sandberg@arm.com if (lastCommand != NoCommand) { 8512653Sandreas.sandberg@arm.com switch (lastCommand) { 8612653Sandreas.sandberg@arm.com case LEDWrite: 8712653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting LEDs: " 8812653Sandreas.sandberg@arm.com "caps lock %s, num lock %s, scroll lock %s\n", 8912653Sandreas.sandberg@arm.com bits(data, 2) ? "on" : "off", 9012653Sandreas.sandberg@arm.com bits(data, 1) ? "on" : "off", 9112653Sandreas.sandberg@arm.com bits(data, 0) ? "on" : "off"); 9212653Sandreas.sandberg@arm.com sendAck(); 9312653Sandreas.sandberg@arm.com lastCommand = NoCommand; 9412653Sandreas.sandberg@arm.com break; 9512653Sandreas.sandberg@arm.com case TypematicInfo: 9612653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting typematic info to %#02x.\n", data); 9712653Sandreas.sandberg@arm.com sendAck(); 9812653Sandreas.sandberg@arm.com lastCommand = NoCommand; 9912653Sandreas.sandberg@arm.com break; 10012653Sandreas.sandberg@arm.com } 10112653Sandreas.sandberg@arm.com return; 10212653Sandreas.sandberg@arm.com } 10312653Sandreas.sandberg@arm.com 10412653Sandreas.sandberg@arm.com switch (data) { 10512653Sandreas.sandberg@arm.com case LEDWrite: 10612653Sandreas.sandberg@arm.com DPRINTF(PS2, "Got LED write command.\n"); 10712653Sandreas.sandberg@arm.com sendAck(); 10812653Sandreas.sandberg@arm.com lastCommand = LEDWrite; 10912653Sandreas.sandberg@arm.com break; 11012653Sandreas.sandberg@arm.com case DiagnosticEcho: 11112653Sandreas.sandberg@arm.com panic("Keyboard diagnostic echo unimplemented.\n"); 11212653Sandreas.sandberg@arm.com case AlternateScanCodes: 11312653Sandreas.sandberg@arm.com panic("Accessing alternate scan codes unimplemented.\n"); 11412653Sandreas.sandberg@arm.com case ReadID: 11512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Got keyboard read ID command.\n"); 11612653Sandreas.sandberg@arm.com sendAck(); 11712653Sandreas.sandberg@arm.com send((uint8_t *)&ID, sizeof(ID)); 11812653Sandreas.sandberg@arm.com break; 11912653Sandreas.sandberg@arm.com case TypematicInfo: 12012653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting typematic info.\n"); 12112653Sandreas.sandberg@arm.com sendAck(); 12212653Sandreas.sandberg@arm.com lastCommand = TypematicInfo; 12312653Sandreas.sandberg@arm.com break; 12412653Sandreas.sandberg@arm.com case Enable: 12512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Enabling the keyboard.\n"); 12612654Sandreas.sandberg@arm.com enabled = true; 12712653Sandreas.sandberg@arm.com sendAck(); 12812653Sandreas.sandberg@arm.com break; 12912653Sandreas.sandberg@arm.com case Disable: 13012653Sandreas.sandberg@arm.com DPRINTF(PS2, "Disabling the keyboard.\n"); 13112654Sandreas.sandberg@arm.com enabled = false; 13212653Sandreas.sandberg@arm.com sendAck(); 13312653Sandreas.sandberg@arm.com break; 13412653Sandreas.sandberg@arm.com case DefaultsAndDisable: 13512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Disabling and resetting the keyboard.\n"); 13612654Sandreas.sandberg@arm.com enabled = false; 13712653Sandreas.sandberg@arm.com sendAck(); 13812653Sandreas.sandberg@arm.com break; 13912653Sandreas.sandberg@arm.com case AllKeysToTypematic: 14012653Sandreas.sandberg@arm.com panic("Setting all keys to typemantic unimplemented.\n"); 14112653Sandreas.sandberg@arm.com case AllKeysToMakeRelease: 14212653Sandreas.sandberg@arm.com panic("Setting all keys to make/release unimplemented.\n"); 14312653Sandreas.sandberg@arm.com case AllKeysToMake: 14412653Sandreas.sandberg@arm.com panic("Setting all keys to make unimplemented.\n"); 14512653Sandreas.sandberg@arm.com case AllKeysToTypematicMakeRelease: 14612653Sandreas.sandberg@arm.com panic("Setting all keys to " 14712653Sandreas.sandberg@arm.com "typematic/make/release unimplemented.\n"); 14812653Sandreas.sandberg@arm.com case KeyToTypematic: 14912653Sandreas.sandberg@arm.com panic("Setting a key to typematic unimplemented.\n"); 15012653Sandreas.sandberg@arm.com case KeyToMakeRelease: 15112653Sandreas.sandberg@arm.com panic("Setting a key to make/release unimplemented.\n"); 15212653Sandreas.sandberg@arm.com case KeyToMakeOnly: 15312653Sandreas.sandberg@arm.com panic("Setting key to make only unimplemented.\n"); 15412653Sandreas.sandberg@arm.com case Resend: 15512653Sandreas.sandberg@arm.com panic("Keyboard resend unimplemented.\n"); 15612653Sandreas.sandberg@arm.com case Reset: 15712653Sandreas.sandberg@arm.com panic("Keyboard reset unimplemented.\n"); 15812653Sandreas.sandberg@arm.com default: 15912653Sandreas.sandberg@arm.com panic("Unknown keyboard command %#02x.\n", data); 16012653Sandreas.sandberg@arm.com } 16112653Sandreas.sandberg@arm.com} 16212653Sandreas.sandberg@arm.com 16312654Sandreas.sandberg@arm.comvoid 16412654Sandreas.sandberg@arm.comPS2Keyboard::keyPress(uint32_t key, bool down) 16512654Sandreas.sandberg@arm.com{ 16612654Sandreas.sandberg@arm.com std::list<uint8_t> keys; 16712654Sandreas.sandberg@arm.com 16812654Sandreas.sandberg@arm.com // convert the X11 keysym into ps2 codes and update the shift 16912654Sandreas.sandberg@arm.com // state (shiftDown) 17012654Sandreas.sandberg@arm.com Ps2::keySymToPs2(key, down, shiftDown, keys); 17112654Sandreas.sandberg@arm.com 17212654Sandreas.sandberg@arm.com // Drop key presses if the keyboard hasn't been enabled by the 17312654Sandreas.sandberg@arm.com // host. We do that after translating the key code to ensure that 17412654Sandreas.sandberg@arm.com // we keep track of the shift state. 17512654Sandreas.sandberg@arm.com if (!enabled) 17612654Sandreas.sandberg@arm.com return; 17712654Sandreas.sandberg@arm.com 17812654Sandreas.sandberg@arm.com // Insert into our queue of characters 17912654Sandreas.sandberg@arm.com for (uint8_t c : keys) 18012654Sandreas.sandberg@arm.com send(c); 18112654Sandreas.sandberg@arm.com} 18212654Sandreas.sandberg@arm.com 18312654Sandreas.sandberg@arm.com 18412653Sandreas.sandberg@arm.comPS2Keyboard * 18512653Sandreas.sandberg@arm.comPS2KeyboardParams::create() 18612653Sandreas.sandberg@arm.com{ 18712653Sandreas.sandberg@arm.com return new PS2Keyboard(this); 18812653Sandreas.sandberg@arm.com} 189