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/mouse.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/PS2Mouse.hh" 5012653Sandreas.sandberg@arm.com 5112653Sandreas.sandberg@arm.comPS2Mouse::PS2Mouse(const PS2MouseParams *p) 5212653Sandreas.sandberg@arm.com : PS2Device(p), 5312653Sandreas.sandberg@arm.com status(0), resolution(4), sampleRate(100) 5412653Sandreas.sandberg@arm.com{ 5512653Sandreas.sandberg@arm.com} 5612653Sandreas.sandberg@arm.com 5712656Sandreas.sandberg@arm.combool 5812656Sandreas.sandberg@arm.comPS2Mouse::recv(const std::vector<uint8_t> &data) 5912653Sandreas.sandberg@arm.com{ 6012656Sandreas.sandberg@arm.com switch (data[0]) { 6112660Sandreas.sandberg@arm.com case Ps2::ReadID: 6212660Sandreas.sandberg@arm.com DPRINTF(PS2, "Mouse ID requested.\n"); 6312660Sandreas.sandberg@arm.com sendAck(); 6412660Sandreas.sandberg@arm.com send(Ps2::Mouse::ID); 6512660Sandreas.sandberg@arm.com return true; 6612660Sandreas.sandberg@arm.com case Ps2::Disable: 6712660Sandreas.sandberg@arm.com DPRINTF(PS2, "Disabling data reporting.\n"); 6812660Sandreas.sandberg@arm.com status.enabled = 0; 6912660Sandreas.sandberg@arm.com sendAck(); 7012660Sandreas.sandberg@arm.com return true; 7112660Sandreas.sandberg@arm.com case Ps2::Enable: 7212660Sandreas.sandberg@arm.com DPRINTF(PS2, "Enabling data reporting.\n"); 7312660Sandreas.sandberg@arm.com status.enabled = 1; 7412660Sandreas.sandberg@arm.com sendAck(); 7512660Sandreas.sandberg@arm.com return true; 7612660Sandreas.sandberg@arm.com case Ps2::Resend: 7712660Sandreas.sandberg@arm.com panic("Mouse resend unimplemented.\n"); 7812660Sandreas.sandberg@arm.com case Ps2::Reset: 7912660Sandreas.sandberg@arm.com DPRINTF(PS2, "Resetting the mouse.\n"); 8012660Sandreas.sandberg@arm.com sampleRate = 100; 8112660Sandreas.sandberg@arm.com resolution = 4; 8212660Sandreas.sandberg@arm.com status.twoToOne = 0; 8312660Sandreas.sandberg@arm.com status.enabled = 0; 8412660Sandreas.sandberg@arm.com sendAck(); 8512660Sandreas.sandberg@arm.com send(Ps2::SelfTestPass); 8612660Sandreas.sandberg@arm.com send(Ps2::Mouse::ID); 8712660Sandreas.sandberg@arm.com return true; 8812660Sandreas.sandberg@arm.com 8912660Sandreas.sandberg@arm.com case Ps2::Mouse::Scale1to1: 9012653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting mouse scale to 1:1.\n"); 9112653Sandreas.sandberg@arm.com status.twoToOne = 0; 9212653Sandreas.sandberg@arm.com sendAck(); 9312656Sandreas.sandberg@arm.com return true; 9412660Sandreas.sandberg@arm.com case Ps2::Mouse::Scale2to1: 9512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting mouse scale to 2:1.\n"); 9612653Sandreas.sandberg@arm.com status.twoToOne = 1; 9712653Sandreas.sandberg@arm.com sendAck(); 9812656Sandreas.sandberg@arm.com return true; 9912660Sandreas.sandberg@arm.com case Ps2::Mouse::SetResolution: 10012656Sandreas.sandberg@arm.com if (data.size() == 1) { 10112656Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting mouse resolution.\n"); 10212656Sandreas.sandberg@arm.com sendAck(); 10312656Sandreas.sandberg@arm.com return false; 10412656Sandreas.sandberg@arm.com } else { 10512656Sandreas.sandberg@arm.com DPRINTF(PS2, "Mouse resolution set to %d.\n", data[1]); 10612656Sandreas.sandberg@arm.com resolution = data[1]; 10712656Sandreas.sandberg@arm.com sendAck(); 10812656Sandreas.sandberg@arm.com return true; 10912656Sandreas.sandberg@arm.com } 11012660Sandreas.sandberg@arm.com case Ps2::Mouse::GetStatus: 11112653Sandreas.sandberg@arm.com DPRINTF(PS2, "Getting mouse status.\n"); 11212653Sandreas.sandberg@arm.com sendAck(); 11312653Sandreas.sandberg@arm.com send((uint8_t *)&(status), 1); 11412653Sandreas.sandberg@arm.com send(&resolution, sizeof(resolution)); 11512653Sandreas.sandberg@arm.com send(&sampleRate, sizeof(sampleRate)); 11612656Sandreas.sandberg@arm.com return true; 11712660Sandreas.sandberg@arm.com case Ps2::Mouse::ReadData: 11812653Sandreas.sandberg@arm.com panic("Reading mouse data unimplemented.\n"); 11912660Sandreas.sandberg@arm.com case Ps2::Mouse::ResetWrapMode: 12012653Sandreas.sandberg@arm.com panic("Resetting mouse wrap mode unimplemented.\n"); 12112660Sandreas.sandberg@arm.com case Ps2::Mouse::WrapMode: 12212653Sandreas.sandberg@arm.com panic("Setting mouse wrap mode unimplemented.\n"); 12312660Sandreas.sandberg@arm.com case Ps2::Mouse::RemoteMode: 12412653Sandreas.sandberg@arm.com panic("Setting mouse remote mode unimplemented.\n"); 12512660Sandreas.sandberg@arm.com case Ps2::Mouse::SampleRate: 12612656Sandreas.sandberg@arm.com if (data.size() == 1) { 12712656Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting mouse sample rate.\n"); 12812656Sandreas.sandberg@arm.com sendAck(); 12912656Sandreas.sandberg@arm.com return false; 13012656Sandreas.sandberg@arm.com } else { 13112656Sandreas.sandberg@arm.com DPRINTF(PS2, "Mouse sample rate %d samples " 13212656Sandreas.sandberg@arm.com "per second.\n", data[1]); 13312656Sandreas.sandberg@arm.com sampleRate = data[1]; 13412656Sandreas.sandberg@arm.com sendAck(); 13512656Sandreas.sandberg@arm.com return true; 13612656Sandreas.sandberg@arm.com } 13712660Sandreas.sandberg@arm.com case Ps2::DefaultsAndDisable: 13812653Sandreas.sandberg@arm.com DPRINTF(PS2, "Disabling and resetting mouse.\n"); 13912653Sandreas.sandberg@arm.com sampleRate = 100; 14012653Sandreas.sandberg@arm.com resolution = 4; 14112653Sandreas.sandberg@arm.com status.twoToOne = 0; 14212653Sandreas.sandberg@arm.com status.enabled = 0; 14312653Sandreas.sandberg@arm.com sendAck(); 14412656Sandreas.sandberg@arm.com return true; 14512653Sandreas.sandberg@arm.com default: 14612656Sandreas.sandberg@arm.com warn("Unknown mouse command %#02x.\n", data[0]); 14712660Sandreas.sandberg@arm.com send(Ps2::Resend); 14812656Sandreas.sandberg@arm.com return true; 14912653Sandreas.sandberg@arm.com } 15012653Sandreas.sandberg@arm.com} 15112653Sandreas.sandberg@arm.com 15212653Sandreas.sandberg@arm.comvoid 15312653Sandreas.sandberg@arm.comPS2Mouse::serialize(CheckpointOut &cp) const 15412653Sandreas.sandberg@arm.com{ 15512653Sandreas.sandberg@arm.com PS2Device::serialize(cp); 15612653Sandreas.sandberg@arm.com 15712653Sandreas.sandberg@arm.com SERIALIZE_SCALAR(status); 15812653Sandreas.sandberg@arm.com SERIALIZE_SCALAR(resolution); 15912653Sandreas.sandberg@arm.com SERIALIZE_SCALAR(sampleRate); 16012653Sandreas.sandberg@arm.com} 16112653Sandreas.sandberg@arm.com 16212653Sandreas.sandberg@arm.comvoid 16312653Sandreas.sandberg@arm.comPS2Mouse::unserialize(CheckpointIn &cp) 16412653Sandreas.sandberg@arm.com{ 16512653Sandreas.sandberg@arm.com PS2Device::unserialize(cp); 16612653Sandreas.sandberg@arm.com 16712653Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(status); 16812653Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(resolution); 16912653Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(sampleRate); 17012653Sandreas.sandberg@arm.com} 17112653Sandreas.sandberg@arm.com 17212653Sandreas.sandberg@arm.comPS2Mouse * 17312653Sandreas.sandberg@arm.comPS2MouseParams::create() 17412653Sandreas.sandberg@arm.com{ 17512653Sandreas.sandberg@arm.com return new PS2Mouse(this); 17612653Sandreas.sandberg@arm.com} 177