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, 114 insertions, 0 deletions

diff --git a/src/dev/ps2/device.cc b/src/dev/ps2/device.cc
new file mode 100644
index 000000000..deedb49bf
--- /dev/null
+++ b/src/dev/ps2/device.cc
@@ -0,0 +1,114 @@
+/*
+ * 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/device.hh"
+
+#include "base/logging.hh"
+#include "dev/ps2.hh"
+#include "params/PS2Device.hh"
+
+PS2Device::PS2Device(const PS2DeviceParams *p)
+    : SimObject(p)
+{
+}
+
+void
+PS2Device::serialize(CheckpointOut &cp) const
+{
+    std::vector<uint8_t> buffer(outBuffer.size());
+    std::copy(outBuffer.begin(), outBuffer.end(), buffer.begin());
+    arrayParamOut(cp, "outBuffer", buffer);
+}
+
+void
+PS2Device::unserialize(CheckpointIn &cp)
+{
+    std::vector<uint8_t> buffer;
+    arrayParamIn(cp, "outBuffer", buffer);
+    for (auto c : buffer)
+        outBuffer.push_back(c);
+}
+
+void
+PS2Device::hostRegDataAvailable(const std::function<void()> &c)
+{
+    fatal_if(dataAvailableCallback,
+             "A data pending callback has already been associated with this "
+             "PS/2 device.\n");
+
+    dataAvailableCallback = c;
+}
+
+uint8_t
+PS2Device::hostRead()
+{
+    uint8_t data = outBuffer.front();
+    outBuffer.pop_front();
+    return data;
+}
+
+void
+PS2Device::hostWrite(uint8_t c)
+{
+    recv(c);
+}
+
+void
+PS2Device::send(const uint8_t *data, size_t size)
+{
+    assert(data || size == 0);
+    while (size) {
+        outBuffer.push_back(*(data++));
+        size--;
+    }
+
+    // Registering a callback is optional.
+    if (dataAvailableCallback)
+        dataAvailableCallback();
+}
+
+void
+PS2Device::sendAck()
+{
+    send(Ps2::Ack);
+}