mouse.cc revision 12653
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" 4812653Sandreas.sandberg@arm.com#include "params/PS2Mouse.hh" 4912653Sandreas.sandberg@arm.com 5012653Sandreas.sandberg@arm.comconst uint8_t PS2Mouse::ID[] = {0x00}; 5112653Sandreas.sandberg@arm.comconst uint8_t BatSuccessful = 0xaa; 5212653Sandreas.sandberg@arm.com 5312653Sandreas.sandberg@arm.comPS2Mouse::PS2Mouse(const PS2MouseParams *p) 5412653Sandreas.sandberg@arm.com : PS2Device(p), 5512653Sandreas.sandberg@arm.com lastCommand(NoCommand), 5612653Sandreas.sandberg@arm.com status(0), resolution(4), sampleRate(100) 5712653Sandreas.sandberg@arm.com{ 5812653Sandreas.sandberg@arm.com} 5912653Sandreas.sandberg@arm.com 6012653Sandreas.sandberg@arm.comvoid 6112653Sandreas.sandberg@arm.comPS2Mouse::recv(uint8_t data) 6212653Sandreas.sandberg@arm.com{ 6312653Sandreas.sandberg@arm.com if (lastCommand != NoCommand) { 6412653Sandreas.sandberg@arm.com switch(lastCommand) { 6512653Sandreas.sandberg@arm.com case SetResolution: 6612653Sandreas.sandberg@arm.com DPRINTF(PS2, "Mouse resolution set to %d.\n", data); 6712653Sandreas.sandberg@arm.com resolution = data; 6812653Sandreas.sandberg@arm.com sendAck(); 6912653Sandreas.sandberg@arm.com lastCommand = NoCommand; 7012653Sandreas.sandberg@arm.com break; 7112653Sandreas.sandberg@arm.com case SampleRate: 7212653Sandreas.sandberg@arm.com DPRINTF(PS2, "Mouse sample rate %d samples " 7312653Sandreas.sandberg@arm.com "per second.\n", data); 7412653Sandreas.sandberg@arm.com sampleRate = data; 7512653Sandreas.sandberg@arm.com sendAck(); 7612653Sandreas.sandberg@arm.com lastCommand = NoCommand; 7712653Sandreas.sandberg@arm.com break; 7812653Sandreas.sandberg@arm.com default: 7912653Sandreas.sandberg@arm.com panic("Not expecting data for a mouse command.\n"); 8012653Sandreas.sandberg@arm.com } 8112653Sandreas.sandberg@arm.com return; 8212653Sandreas.sandberg@arm.com } 8312653Sandreas.sandberg@arm.com switch (data) { 8412653Sandreas.sandberg@arm.com case Scale1to1: 8512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting mouse scale to 1:1.\n"); 8612653Sandreas.sandberg@arm.com status.twoToOne = 0; 8712653Sandreas.sandberg@arm.com sendAck(); 8812653Sandreas.sandberg@arm.com break; 8912653Sandreas.sandberg@arm.com case Scale2to1: 9012653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting mouse scale to 2:1.\n"); 9112653Sandreas.sandberg@arm.com status.twoToOne = 1; 9212653Sandreas.sandberg@arm.com sendAck(); 9312653Sandreas.sandberg@arm.com break; 9412653Sandreas.sandberg@arm.com case SetResolution: 9512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting mouse resolution.\n"); 9612653Sandreas.sandberg@arm.com lastCommand = SetResolution; 9712653Sandreas.sandberg@arm.com sendAck(); 9812653Sandreas.sandberg@arm.com break; 9912653Sandreas.sandberg@arm.com case GetStatus: 10012653Sandreas.sandberg@arm.com DPRINTF(PS2, "Getting mouse status.\n"); 10112653Sandreas.sandberg@arm.com sendAck(); 10212653Sandreas.sandberg@arm.com send((uint8_t *)&(status), 1); 10312653Sandreas.sandberg@arm.com send(&resolution, sizeof(resolution)); 10412653Sandreas.sandberg@arm.com send(&sampleRate, sizeof(sampleRate)); 10512653Sandreas.sandberg@arm.com break; 10612653Sandreas.sandberg@arm.com case ReadData: 10712653Sandreas.sandberg@arm.com panic("Reading mouse data unimplemented.\n"); 10812653Sandreas.sandberg@arm.com case ResetWrapMode: 10912653Sandreas.sandberg@arm.com panic("Resetting mouse wrap mode unimplemented.\n"); 11012653Sandreas.sandberg@arm.com case WrapMode: 11112653Sandreas.sandberg@arm.com panic("Setting mouse wrap mode unimplemented.\n"); 11212653Sandreas.sandberg@arm.com case RemoteMode: 11312653Sandreas.sandberg@arm.com panic("Setting mouse remote mode unimplemented.\n"); 11412653Sandreas.sandberg@arm.com case ReadID: 11512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Mouse ID requested.\n"); 11612653Sandreas.sandberg@arm.com sendAck(); 11712653Sandreas.sandberg@arm.com send(ID, sizeof(ID)); 11812653Sandreas.sandberg@arm.com break; 11912653Sandreas.sandberg@arm.com case SampleRate: 12012653Sandreas.sandberg@arm.com DPRINTF(PS2, "Setting mouse sample rate.\n"); 12112653Sandreas.sandberg@arm.com lastCommand = SampleRate; 12212653Sandreas.sandberg@arm.com sendAck(); 12312653Sandreas.sandberg@arm.com break; 12412653Sandreas.sandberg@arm.com case DisableReporting: 12512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Disabling data reporting.\n"); 12612653Sandreas.sandberg@arm.com status.enabled = 0; 12712653Sandreas.sandberg@arm.com sendAck(); 12812653Sandreas.sandberg@arm.com break; 12912653Sandreas.sandberg@arm.com case EnableReporting: 13012653Sandreas.sandberg@arm.com DPRINTF(PS2, "Enabling data reporting.\n"); 13112653Sandreas.sandberg@arm.com status.enabled = 1; 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 mouse.\n"); 13612653Sandreas.sandberg@arm.com sampleRate = 100; 13712653Sandreas.sandberg@arm.com resolution = 4; 13812653Sandreas.sandberg@arm.com status.twoToOne = 0; 13912653Sandreas.sandberg@arm.com status.enabled = 0; 14012653Sandreas.sandberg@arm.com sendAck(); 14112653Sandreas.sandberg@arm.com break; 14212653Sandreas.sandberg@arm.com case Resend: 14312653Sandreas.sandberg@arm.com panic("Mouse resend unimplemented.\n"); 14412653Sandreas.sandberg@arm.com case Reset: 14512653Sandreas.sandberg@arm.com DPRINTF(PS2, "Resetting the mouse.\n"); 14612653Sandreas.sandberg@arm.com sampleRate = 100; 14712653Sandreas.sandberg@arm.com resolution = 4; 14812653Sandreas.sandberg@arm.com status.twoToOne = 0; 14912653Sandreas.sandberg@arm.com status.enabled = 0; 15012653Sandreas.sandberg@arm.com sendAck(); 15112653Sandreas.sandberg@arm.com send(&BatSuccessful, sizeof(BatSuccessful)); 15212653Sandreas.sandberg@arm.com send(ID, sizeof(ID)); 15312653Sandreas.sandberg@arm.com break; 15412653Sandreas.sandberg@arm.com default: 15512653Sandreas.sandberg@arm.com warn("Unknown mouse command %#02x.\n", data); 15612653Sandreas.sandberg@arm.com send(Resend); 15712653Sandreas.sandberg@arm.com break; 15812653Sandreas.sandberg@arm.com } 15912653Sandreas.sandberg@arm.com} 16012653Sandreas.sandberg@arm.com 16112653Sandreas.sandberg@arm.comvoid 16212653Sandreas.sandberg@arm.comPS2Mouse::serialize(CheckpointOut &cp) const 16312653Sandreas.sandberg@arm.com{ 16412653Sandreas.sandberg@arm.com PS2Device::serialize(cp); 16512653Sandreas.sandberg@arm.com 16612653Sandreas.sandberg@arm.com SERIALIZE_SCALAR(lastCommand); 16712653Sandreas.sandberg@arm.com 16812653Sandreas.sandberg@arm.com SERIALIZE_SCALAR(status); 16912653Sandreas.sandberg@arm.com SERIALIZE_SCALAR(resolution); 17012653Sandreas.sandberg@arm.com SERIALIZE_SCALAR(sampleRate); 17112653Sandreas.sandberg@arm.com} 17212653Sandreas.sandberg@arm.com 17312653Sandreas.sandberg@arm.comvoid 17412653Sandreas.sandberg@arm.comPS2Mouse::unserialize(CheckpointIn &cp) 17512653Sandreas.sandberg@arm.com{ 17612653Sandreas.sandberg@arm.com PS2Device::unserialize(cp); 17712653Sandreas.sandberg@arm.com 17812653Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(lastCommand); 17912653Sandreas.sandberg@arm.com 18012653Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(status); 18112653Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(resolution); 18212653Sandreas.sandberg@arm.com UNSERIALIZE_SCALAR(sampleRate); 18312653Sandreas.sandberg@arm.com} 18412653Sandreas.sandberg@arm.com 18512653Sandreas.sandberg@arm.comPS2Mouse * 18612653Sandreas.sandberg@arm.comPS2MouseParams::create() 18712653Sandreas.sandberg@arm.com{ 18812653Sandreas.sandberg@arm.com return new PS2Mouse(this); 18912653Sandreas.sandberg@arm.com} 190