Kernel: Move x86-specific HID code to the Arch/x86 directory

The i8042 controller with its attached devices, the PS2 keyboard and
mouse, rely on x86-specific IO instructions to work. Therefore, move
them to the Arch/x86 directory to make it easier to omit the handling
code of these devices.

Kernel/Arch/x86/ISABus/HID/PS2MouseDevice.cpp

@@ -0,0 +1,223 @@
+/*
+ * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <AK/Memory.h>
+#include <Kernel/Arch/x86/Hypervisor/VMWareBackdoor.h>
+#include <Kernel/Arch/x86/ISABus/HID/PS2MouseDevice.h>
+#include <Kernel/Debug.h>
+#include <Kernel/Devices/DeviceManagement.h>
+#include <Kernel/Sections.h>
+
+namespace Kernel {
+
+#define IRQ_MOUSE 12
+
+#define PS2MOUSE_INTELLIMOUSE_ID 0x03
+#define PS2MOUSE_INTELLIMOUSE_EXPLORER_ID 0x04
+
+UNMAP_AFTER_INIT PS2MouseDevice::PS2MouseDevice(I8042Controller const& ps2_controller)
+    : IRQHandler(IRQ_MOUSE)
+    , MouseDevice()
+    , I8042Device(ps2_controller)
+{
+}
+
+UNMAP_AFTER_INIT PS2MouseDevice::~PS2MouseDevice() = default;
+
+bool PS2MouseDevice::handle_irq(RegisterState const&)
+{
+    // The controller will read the data and call irq_handle_byte_read
+    // for the appropriate device
+    return m_i8042_controller->irq_process_input_buffer(instrument_type());
+}
+
+void PS2MouseDevice::irq_handle_byte_read(u8 byte)
+{
+    auto commit_packet = [&] {
+        m_data_state = 0;
+        dbgln_if(PS2MOUSE_DEBUG, "PS2Mouse: {}, {} {} {}",
+            m_data.bytes[1],
+            m_data.bytes[2],
+            (m_data.bytes[0] & 1) ? "Left" : "",
+            (m_data.bytes[0] & 2) ? "Right" : "");
+
+        m_entropy_source.add_random_event(m_data.dword);
+
+        {
+            SpinlockLocker lock(m_queue_lock);
+            m_queue.enqueue(parse_data_packet(m_data));
+        }
+        evaluate_block_conditions();
+    };
+
+    VERIFY(m_data_state < sizeof(m_data.bytes) / sizeof(m_data.bytes[0]));
+    m_data.bytes[m_data_state] = byte;
+
+    switch (m_data_state) {
+    case 0:
+        if (!(byte & 0x08)) {
+            dbgln("PS2Mouse: Stream out of sync.");
+            break;
+        }
+        ++m_data_state;
+        break;
+    case 1:
+        ++m_data_state;
+        break;
+    case 2:
+        if (m_has_wheel) {
+            ++m_data_state;
+            break;
+        }
+        commit_packet();
+        break;
+    case 3:
+        VERIFY(m_has_wheel);
+        commit_packet();
+        break;
+    }
+}
+
+MousePacket PS2MouseDevice::parse_data_packet(RawPacket const& raw_packet)
+{
+    int x = raw_packet.bytes[1];
+    int y = raw_packet.bytes[2];
+    int z = 0;
+    int w = 0;
+    if (m_has_wheel) {
+        // FIXME: For non-Intellimouse, this is a full byte.
+        //        However, for now, m_has_wheel is only set for Intellimouse.
+        z = (char)(raw_packet.bytes[3] & 0x0f);
+
+        // -1 in 4 bits
+        if (z == 15)
+            z = -1;
+
+        if ((raw_packet.bytes[3] & 0xc0) == 0x40) {
+            // FIXME: Scroll only functions correctly when the sign is flipped there
+            w = -z;
+            z = 0;
+        } else {
+            w = 0;
+        }
+    }
+    bool x_overflow = raw_packet.bytes[0] & 0x40;
+    bool y_overflow = raw_packet.bytes[0] & 0x80;
+    bool x_sign = raw_packet.bytes[0] & 0x10;
+    bool y_sign = raw_packet.bytes[0] & 0x20;
+    if (x && x_sign)
+        x -= 0x100;
+    if (y && y_sign)
+        y -= 0x100;
+    if (x_overflow || y_overflow) {
+        x = 0;
+        y = 0;
+    }
+    MousePacket packet;
+    packet.x = x;
+    packet.y = y;
+    packet.z = z;
+    packet.w = w;
+    packet.buttons = raw_packet.bytes[0] & 0x07;
+
+    if (m_has_five_buttons) {
+        if (raw_packet.bytes[3] & 0x10)
+            packet.buttons |= MousePacket::BackwardButton;
+        if (raw_packet.bytes[3] & 0x20)
+            packet.buttons |= MousePacket::ForwardButton;
+    }
+
+    packet.is_relative = true;
+    dbgln_if(PS2MOUSE_DEBUG, "PS2 Relative Mouse: Buttons {:x}", packet.buttons);
+    dbgln_if(PS2MOUSE_DEBUG, "Mouse: X {}, Y {}, Z {}, W {}", packet.x, packet.y, packet.z, packet.w);
+    return packet;
+}
+
+ErrorOr<u8> PS2MouseDevice::get_device_id()
+{
+    TRY(send_command(I8042Command::GetDeviceID));
+    return read_from_device();
+}
+
+ErrorOr<u8> PS2MouseDevice::read_from_device()
+{
+    return m_i8042_controller->read_from_device(instrument_type());
+}
+
+ErrorOr<u8> PS2MouseDevice::send_command(u8 command)
+{
+    u8 response = TRY(m_i8042_controller->send_command(instrument_type(), command));
+
+    if (response != I8042Response::Acknowledge) {
+        dbgln("PS2MouseDevice: Command {} got {} but expected ack: {}", command, response, static_cast<u8>(I8042Response::Acknowledge));
+        return Error::from_errno(EIO);
+    }
+    return response;
+}
+
+ErrorOr<u8> PS2MouseDevice::send_command(u8 command, u8 data)
+{
+    u8 response = TRY(m_i8042_controller->send_command(instrument_type(), command, data));
+    if (response != I8042Response::Acknowledge) {
+        dbgln("PS2MouseDevice: Command {} got {} but expected ack: {}", command, response, static_cast<u8>(I8042Response::Acknowledge));
+        return Error::from_errno(EIO);
+    }
+    return response;
+}
+
+ErrorOr<void> PS2MouseDevice::set_sample_rate(u8 rate)
+{
+    TRY(send_command(I8042Command::SetSampleRate, rate));
+    return {};
+}
+
+UNMAP_AFTER_INIT ErrorOr<NonnullLockRefPtr<PS2MouseDevice>> PS2MouseDevice::try_to_initialize(I8042Controller const& ps2_controller)
+{
+    auto mouse_device = TRY(DeviceManagement::try_create_device<PS2MouseDevice>(ps2_controller));
+    TRY(mouse_device->initialize());
+    return mouse_device;
+}
+
+UNMAP_AFTER_INIT ErrorOr<void> PS2MouseDevice::initialize()
+{
+    TRY(m_i8042_controller->reset_device(instrument_type()));
+
+    u8 device_id = TRY(read_from_device());
+
+    TRY(send_command(I8042Command::SetDefaults));
+
+    TRY(send_command(I8042Command::EnablePacketStreaming));
+
+    if (device_id != PS2MOUSE_INTELLIMOUSE_ID) {
+        // Send magical wheel initiation sequence.
+        TRY(set_sample_rate(200));
+        TRY(set_sample_rate(100));
+        TRY(set_sample_rate(80));
+        device_id = TRY(get_device_id());
+    }
+    if (device_id == PS2MOUSE_INTELLIMOUSE_ID) {
+        m_has_wheel = true;
+        dmesgln("PS2MouseDevice: Mouse wheel enabled!");
+    } else {
+        dmesgln("PS2MouseDevice: No mouse wheel detected!");
+    }
+
+    if (device_id == PS2MOUSE_INTELLIMOUSE_ID) {
+        // Try to enable 5 buttons as well!
+        TRY(set_sample_rate(200));
+        TRY(set_sample_rate(200));
+        TRY(set_sample_rate(80));
+        device_id = TRY(get_device_id());
+    }
+
+    if (device_id == PS2MOUSE_INTELLIMOUSE_EXPLORER_ID) {
+        m_has_five_buttons = true;
+        dmesgln("PS2MouseDevice: 5 buttons enabled!");
+    }
+    return {};
+}
+
+}