From c85d51e6d62a9591bd5b99dcb0146aae5dbee43f Mon Sep 17 00:00:00 2001 From: Andreas Sandberg Date: Mon, 9 Apr 2018 18:38:33 +0100 Subject: ps2: Add a simple touchscreen model Add a touchscreen model that is compatible with Linux's TouchKit driver. This model is based on the model in the Arm PL050 KMI model. Change-Id: Id4d88a21a26bb42c455e4d778cd89875f650ac57 Signed-off-by: Andreas Sandberg Reviewed-by: Giacomo Travaglini Reviewed-on: https://gem5-review.googlesource.com/9764 Reviewed-by: Gabe Black Maintainer: Gabe Black --- src/dev/ps2/PS2.py | 6 ++ src/dev/ps2/SConscript | 1 + src/dev/ps2/touchkit.cc | 175 ++++++++++++++++++++++++++++++++++++++++++++++++ src/dev/ps2/touchkit.hh | 84 +++++++++++++++++++++++ 4 files changed, 266 insertions(+) create mode 100644 src/dev/ps2/touchkit.cc create mode 100644 src/dev/ps2/touchkit.hh diff --git a/src/dev/ps2/PS2.py b/src/dev/ps2/PS2.py index fcbbc28c3..55b37f2e5 100644 --- a/src/dev/ps2/PS2.py +++ b/src/dev/ps2/PS2.py @@ -53,3 +53,9 @@ class PS2Keyboard(PS2Device): class PS2Mouse(PS2Device): type = 'PS2Mouse' cxx_header = "dev/ps2/mouse.hh" + +class PS2TouchKit(PS2Device): + type = 'PS2TouchKit' + cxx_header = "dev/ps2/touchkit.hh" + + vnc = Param.VncInput(Parent.any, "VNC server providing mouse input") diff --git a/src/dev/ps2/SConscript b/src/dev/ps2/SConscript index acce7bebb..a73e47a1f 100644 --- a/src/dev/ps2/SConscript +++ b/src/dev/ps2/SConscript @@ -46,5 +46,6 @@ SimObject('PS2.py') Source('device.cc') Source('keyboard.cc') Source('mouse.cc') +Source('touchkit.cc') DebugFlag('PS2') diff --git a/src/dev/ps2/touchkit.cc b/src/dev/ps2/touchkit.cc new file mode 100644 index 000000000..96dd2e9c7 --- /dev/null +++ b/src/dev/ps2/touchkit.cc @@ -0,0 +1,175 @@ +/* + * Copyright (c) 2010, 2017-2018 ARM Limited + * All rights reserved + * + * The license below extends only to copyright in the software and shall + * not be construed as granting a license to any other intellectual + * property including but not limited to intellectual property relating + * to a hardware implementation of the functionality of the software + * licensed hereunder. You may use the software subject to the license + * terms below provided that you ensure that this notice is replicated + * unmodified and in its entirety in all distributions of the software, + * modified or unmodified, in source code or in binary form. + * + * Copyright (c) 2005 The Regents of The University of Michigan + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer; + * redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution; + * neither the name of the copyright holders nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * Authors: Ali Saidi + * William Wang + * Andreas Sandberg + */ + +#include "dev/ps2/touchkit.hh" + +#include "base/logging.hh" +#include "debug/PS2.hh" +#include "dev/ps2.hh" +#include "params/PS2TouchKit.hh" + +const uint8_t PS2TouchKit::ID[] = {0x00}; + +PS2TouchKit::PS2TouchKit(const PS2TouchKitParams *p) + : PS2Device(p), + vnc(p->vnc), + ackNext(false), + driverInitialized(false) +{ + if (vnc) + vnc->setMouse(this); +} + +void +PS2TouchKit::serialize(CheckpointOut &cp) const +{ + PS2Device::serialize(cp); + + SERIALIZE_SCALAR(ackNext); + SERIALIZE_SCALAR(driverInitialized); +} + +void +PS2TouchKit::unserialize(CheckpointIn &cp) +{ + PS2Device::unserialize(cp); + + UNSERIALIZE_SCALAR(ackNext); + UNSERIALIZE_SCALAR(driverInitialized); +} + +void +PS2TouchKit::recv(uint8_t data) +{ + if (ackNext) { + ackNext--; + sendAck(); + return; + } + + switch (data) { + case Ps2::Ps2Reset: + sendAck(); + send(Ps2::SelfTestPass); + break; + + case Ps2::SetResolution: + case Ps2::SetRate: + case Ps2::SetStatusLed: + sendAck(); + ackNext = 1; + break; + + case Ps2::ReadId: + sendAck(); + send((const uint8_t *)&ID, sizeof(ID)); + break; + + case Ps2::TpReadId: + // We're not a trackpoint device, this should make the probe + // go away + sendAck(); + send(0); + send(0); + sendAck(); + break; + + case Ps2::SetScaling1_1: + case Ps2::SetScaling1_2: + case Ps2::Disable: + case Ps2::Enable: + case Ps2::SetDefaults: + sendAck(); + break; + + case Ps2::StatusRequest: + sendAck(); + send(0); + send(2); // default resolution + send(100); // default sample rate + break; + + case Ps2::TouchKitId: + ackNext = 2; + sendAck(); + send(Ps2::TouchKitId); + send(1); + send('A'); + + driverInitialized = true; + break; + + default: + panic("Unknown byte received: %d\n", data); + } +} + +void +PS2TouchKit::mouseAt(uint16_t x, uint16_t y, uint8_t buttons) +{ + // If the driver hasn't initialized the device yet, no need to try and send + // it anything. Similarly we can get vnc mouse events orders of magnitude + // faster than m5 can process them. Only queue up two sets mouse movements + // and don't add more until those are processed. + if (!driverInitialized || sendPending() > 10) + return; + + // Convert screen coordinates to touchpad coordinates + const uint16_t _x = (2047.0 / vnc->videoWidth()) * x; + const uint16_t _y = (2047.0 / vnc->videoHeight()) * y; + + const uint8_t resp[] = { + buttons, + (uint8_t)(_x >> 7), (uint8_t)(_x & 0x7f), + (uint8_t)(_y >> 7), (uint8_t)(_y & 0x7f), + }; + + send(resp, sizeof(resp)); +} + +PS2TouchKit * +PS2TouchKitParams::create() +{ + return new PS2TouchKit(this); +} diff --git a/src/dev/ps2/touchkit.hh b/src/dev/ps2/touchkit.hh new file mode 100644 index 000000000..4541f3f29 --- /dev/null +++ b/src/dev/ps2/touchkit.hh @@ -0,0 +1,84 @@ +/* + * Copyright (c) 2010, 2017-2018 ARM Limited + * All rights reserved + * + * The license below extends only to copyright in the software and shall + * not be construed as granting a license to any other intellectual + * property including but not limited to intellectual property relating + * to a hardware implementation of the functionality of the software + * licensed hereunder. You may use the software subject to the license + * terms below provided that you ensure that this notice is replicated + * unmodified and in its entirety in all distributions of the software, + * modified or unmodified, in source code or in binary form. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer; + * redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution; + * neither the name of the copyright holders nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * Authors: Andreas Sandberg + */ + +#ifndef __DEV_PS2_TOUCHKIT_HH__ +#define __DEV_PS2_TOUCHKIT_HH__ + +#include "base/vnc/vncinput.hh" +#include "dev/ps2/device.hh" + +struct PS2TouchKitParams; + +class PS2TouchKit : public PS2Device, public VncMouse +{ + protected: + static const uint8_t ID[]; + + public: + PS2TouchKit(const PS2TouchKitParams *p); + + void serialize(CheckpointOut &cp) const override; + void unserialize(CheckpointIn &cp) override; + + protected: // PS2Device + void recv(uint8_t data) override; + + public: // VncMouse + void mouseAt(uint16_t x, uint16_t y, uint8_t buttons) override; + + protected: + /** The vnc server we're connected to (if any) */ + VncInput *const vnc; + + /** + * If the controller should ignore the next N data bytes and + * acknowledge them. This occurs when the driver is attempting to + * setup some feature we don't care about. + */ + int ackNext; + + /** + * Has the driver been initialized in TouchKit mode? The model + * suppresses touch event generation until this is true. + */ + bool driverInitialized; +}; + +#endif // __DEV_PS2_TOUCHKIT_HH__ + -- cgit v1.2.3