ps2: Factor out PS/2 devices into their own subsystem

PS/2 devices are currently emulated both in the i8042 model and the
Arm KMI model. This is undesirable since it leads to code duplication.

This change introduces a common PS/2 device interface and factor out
the x86 keyboard and mouse model. A subsequent commit will implement
support for this interface in the Arm KMI model.

Change-Id: I440e83517fd9dce362fdc1676db477cc6eee5211
Signed-off-by: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-by: Giacomo Travaglini <giacomo.travaglini@arm.com>
Reviewed-on: https://gem5-review.googlesource.com/9762
Reviewed-by: Gabe Black <gabeblack@google.com>
Maintainer: Gabe Black <gabeblack@google.com>

1 files changed, 189 insertions, 0 deletions

diff --git a/src/dev/ps2/mouse.cc b/src/dev/ps2/mouse.cc
new file mode 100644
index 000000000..1bdf39c59
--- /dev/null
+++ b/src/dev/ps2/mouse.cc
@@ -0,0 +1,189 @@
+/*
+ * Copyright (c) 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) 2008 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: Gabe Black
+ *          Andreas Sandberg
+ */
+
+#include "dev/ps2/mouse.hh"
+
+#include "base/logging.hh"
+#include "debug/PS2.hh"
+#include "params/PS2Mouse.hh"
+
+const uint8_t PS2Mouse::ID[] = {0x00};
+const uint8_t BatSuccessful = 0xaa;
+
+PS2Mouse::PS2Mouse(const PS2MouseParams *p)
+    : PS2Device(p),
+      lastCommand(NoCommand),
+      status(0), resolution(4), sampleRate(100)
+{
+}
+
+void
+PS2Mouse::recv(uint8_t data)
+{
+    if (lastCommand != NoCommand) {
+        switch(lastCommand) {
+          case SetResolution:
+            DPRINTF(PS2, "Mouse resolution set to %d.\n", data);
+            resolution = data;
+            sendAck();
+            lastCommand = NoCommand;
+            break;
+          case SampleRate:
+            DPRINTF(PS2, "Mouse sample rate %d samples "
+                    "per second.\n", data);
+            sampleRate = data;
+            sendAck();
+            lastCommand = NoCommand;
+            break;
+          default:
+            panic("Not expecting data for a mouse command.\n");
+        }
+        return;
+    }
+    switch (data) {
+      case Scale1to1:
+        DPRINTF(PS2, "Setting mouse scale to 1:1.\n");
+        status.twoToOne = 0;
+        sendAck();
+        break;
+      case Scale2to1:
+        DPRINTF(PS2, "Setting mouse scale to 2:1.\n");
+        status.twoToOne = 1;
+        sendAck();
+        break;
+      case SetResolution:
+        DPRINTF(PS2, "Setting mouse resolution.\n");
+        lastCommand = SetResolution;
+        sendAck();
+        break;
+      case GetStatus:
+        DPRINTF(PS2, "Getting mouse status.\n");
+        sendAck();
+        send((uint8_t *)&(status), 1);
+        send(&resolution, sizeof(resolution));
+        send(&sampleRate, sizeof(sampleRate));
+        break;
+      case ReadData:
+        panic("Reading mouse data unimplemented.\n");
+      case ResetWrapMode:
+        panic("Resetting mouse wrap mode unimplemented.\n");
+      case WrapMode:
+        panic("Setting mouse wrap mode unimplemented.\n");
+      case RemoteMode:
+        panic("Setting mouse remote mode unimplemented.\n");
+      case ReadID:
+        DPRINTF(PS2, "Mouse ID requested.\n");
+        sendAck();
+        send(ID, sizeof(ID));
+        break;
+      case SampleRate:
+        DPRINTF(PS2, "Setting mouse sample rate.\n");
+        lastCommand = SampleRate;
+        sendAck();
+        break;
+      case DisableReporting:
+        DPRINTF(PS2, "Disabling data reporting.\n");
+        status.enabled = 0;
+        sendAck();
+        break;
+      case EnableReporting:
+        DPRINTF(PS2, "Enabling data reporting.\n");
+        status.enabled = 1;
+        sendAck();
+        break;
+      case DefaultsAndDisable:
+        DPRINTF(PS2, "Disabling and resetting mouse.\n");
+        sampleRate = 100;
+        resolution = 4;
+        status.twoToOne = 0;
+        status.enabled = 0;
+        sendAck();
+        break;
+      case Resend:
+        panic("Mouse resend unimplemented.\n");
+      case Reset:
+        DPRINTF(PS2, "Resetting the mouse.\n");
+        sampleRate = 100;
+        resolution = 4;
+        status.twoToOne = 0;
+        status.enabled = 0;
+        sendAck();
+        send(&BatSuccessful, sizeof(BatSuccessful));
+        send(ID, sizeof(ID));
+        break;
+      default:
+        warn("Unknown mouse command %#02x.\n", data);
+        send(Resend);
+        break;
+    }
+}
+
+void
+PS2Mouse::serialize(CheckpointOut &cp) const
+{
+    PS2Device::serialize(cp);
+
+    SERIALIZE_SCALAR(lastCommand);
+
+    SERIALIZE_SCALAR(status);
+    SERIALIZE_SCALAR(resolution);
+    SERIALIZE_SCALAR(sampleRate);
+}
+
+void
+PS2Mouse::unserialize(CheckpointIn &cp)
+{
+    PS2Device::unserialize(cp);
+
+    UNSERIALIZE_SCALAR(lastCommand);
+
+    UNSERIALIZE_SCALAR(status);
+    UNSERIALIZE_SCALAR(resolution);
+    UNSERIALIZE_SCALAR(sampleRate);
+}
+
+PS2Mouse *
+PS2MouseParams::create()
+{
+    return new PS2Mouse(this);
+}