Kernel: Reorganize Arch/x86 directory to Arch/x86_64 after i686 removal

No functional change.

Kernel/Arch/x86_64/ISABus/HID/PS2KeyboardDevice.cpp

@@ -0,0 +1,116 @@
+/*
+ * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
+ * Copyright (c) 2021, Liav A. <liavalb@hotmail.co.il>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <AK/Types.h>
+#include <Kernel/Arch/x86_64/ISABus/HID/PS2KeyboardDevice.h>
+#include <Kernel/Debug.h>
+#include <Kernel/Devices/DeviceManagement.h>
+#include <Kernel/Devices/HID/HIDManagement.h>
+#include <Kernel/Scheduler.h>
+#include <Kernel/Sections.h>
+#include <Kernel/TTY/ConsoleManagement.h>
+#include <Kernel/WorkQueue.h>
+
+namespace Kernel {
+
+#define IRQ_KEYBOARD 1
+
+void PS2KeyboardDevice::irq_handle_byte_read(u8 byte)
+{
+    u8 ch = byte & 0x7f;
+    bool pressed = !(byte & 0x80);
+
+    m_entropy_source.add_random_event(byte);
+
+    if (byte == 0xe0) {
+        m_has_e0_prefix = true;
+        return;
+    }
+
+    if ((m_modifiers == (Mod_Alt | Mod_Shift) || m_modifiers == (Mod_Ctrl | Mod_Alt | Mod_Shift)) && byte == 0x58) {
+        // Alt+Shift+F12 pressed, dump some kernel state to the debug console.
+        ConsoleManagement::the().switch_to_debug();
+        Scheduler::dump_scheduler_state(m_modifiers == (Mod_Ctrl | Mod_Alt | Mod_Shift));
+    }
+
+    dbgln_if(KEYBOARD_DEBUG, "Keyboard::irq_handle_byte_read: {:#02x} {}", ch, (pressed ? "down" : "up"));
+    switch (ch) {
+    case 0x38:
+        if (m_has_e0_prefix)
+            update_modifier(Mod_AltGr, pressed);
+        else
+            update_modifier(Mod_Alt, pressed);
+        break;
+    case 0x1d:
+        update_modifier(Mod_Ctrl, pressed);
+        break;
+    case 0x5b:
+        m_left_super_pressed = pressed;
+        update_modifier(Mod_Super, m_left_super_pressed || m_right_super_pressed);
+        break;
+    case 0x5c:
+        m_right_super_pressed = pressed;
+        update_modifier(Mod_Super, m_left_super_pressed || m_right_super_pressed);
+        break;
+    case 0x2a:
+        m_left_shift_pressed = pressed;
+        update_modifier(Mod_Shift, m_left_shift_pressed || m_right_shift_pressed);
+        break;
+    case 0x36:
+        m_right_shift_pressed = pressed;
+        update_modifier(Mod_Shift, m_left_shift_pressed || m_right_shift_pressed);
+        break;
+    }
+    switch (ch) {
+    case I8042Response::Acknowledge:
+        break;
+    default:
+        if ((m_modifiers & Mod_Alt) != 0 && ch >= 2 && ch <= ConsoleManagement::s_max_virtual_consoles + 1) {
+            // FIXME: Do something sanely here if we can't allocate a work queue?
+            MUST(g_io_work->try_queue([ch]() {
+                ConsoleManagement::the().switch_to(ch - 0x02);
+            }));
+        }
+        key_state_changed(ch, pressed);
+    }
+}
+
+bool PS2KeyboardDevice::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(HIDDevice::Type::Keyboard);
+}
+
+UNMAP_AFTER_INIT ErrorOr<NonnullLockRefPtr<PS2KeyboardDevice>> PS2KeyboardDevice::try_to_initialize(I8042Controller const& ps2_controller)
+{
+    auto keyboard_device = TRY(DeviceManagement::try_create_device<PS2KeyboardDevice>(ps2_controller));
+
+    TRY(keyboard_device->initialize());
+
+    return keyboard_device;
+}
+
+UNMAP_AFTER_INIT ErrorOr<void> PS2KeyboardDevice::initialize()
+{
+    return m_i8042_controller->reset_device(HIDDevice::Type::Keyboard);
+}
+
+// FIXME: UNMAP_AFTER_INIT might not be correct, because in practice PS/2 devices
+// are hot pluggable.
+UNMAP_AFTER_INIT PS2KeyboardDevice::PS2KeyboardDevice(I8042Controller const& ps2_controller)
+    : IRQHandler(IRQ_KEYBOARD)
+    , KeyboardDevice()
+    , I8042Device(ps2_controller)
+{
+}
+
+// FIXME: UNMAP_AFTER_INIT might not be correct, because in practice PS/2 devices
+// are hot pluggable.
+UNMAP_AFTER_INIT PS2KeyboardDevice::~PS2KeyboardDevice() = default;
+
+}

Kernel/Arch/x86_64/ISABus/HID/PS2KeyboardDevice.h

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/CircularQueue.h>
+#include <AK/Types.h>
+#include <Kernel/API/KeyCode.h>
+#include <Kernel/Arch/x86_64/ISABus/I8042Controller.h>
+#include <Kernel/Devices/HID/KeyboardDevice.h>
+#include <Kernel/Interrupts/IRQHandler.h>
+#include <Kernel/Random.h>
+
+namespace Kernel {
+
+class PS2KeyboardDevice final : public IRQHandler
+    , public KeyboardDevice
+    , public I8042Device {
+    friend class DeviceManagement;
+
+public:
+    static ErrorOr<NonnullLockRefPtr<PS2KeyboardDevice>> try_to_initialize(I8042Controller const&);
+    virtual ~PS2KeyboardDevice() override;
+    ErrorOr<void> initialize();
+
+    virtual StringView purpose() const override { return class_name(); }
+
+    // ^I8042Device
+    virtual void irq_handle_byte_read(u8 byte) override;
+    virtual void enable_interrupts() override
+    {
+        enable_irq();
+    }
+
+private:
+    explicit PS2KeyboardDevice(I8042Controller const&);
+
+    // ^IRQHandler
+    virtual bool handle_irq(RegisterState const&) override;
+
+    // ^CharacterDevice
+    virtual StringView class_name() const override { return "KeyboardDevice"sv; }
+};
+
+}

Kernel/Arch/x86_64/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_64/Hypervisor/VMWareBackdoor.h>
+#include <Kernel/Arch/x86_64/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 {};
+}
+
+}

Kernel/Arch/x86_64/ISABus/HID/PS2MouseDevice.h

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/CircularQueue.h>
+#include <Kernel/API/MousePacket.h>
+#include <Kernel/Arch/x86_64/ISABus/I8042Controller.h>
+#include <Kernel/Devices/HID/MouseDevice.h>
+#include <Kernel/Interrupts/IRQHandler.h>
+#include <Kernel/Random.h>
+
+namespace Kernel {
+class PS2MouseDevice : public IRQHandler
+    , public MouseDevice
+    , public I8042Device {
+    friend class DeviceManagement;
+
+public:
+    static ErrorOr<NonnullLockRefPtr<PS2MouseDevice>> try_to_initialize(I8042Controller const&);
+    ErrorOr<void> initialize();
+
+    virtual ~PS2MouseDevice() override;
+
+    virtual StringView purpose() const override { return class_name(); }
+
+    // ^I8042Device
+    virtual void irq_handle_byte_read(u8 byte) override;
+    virtual void enable_interrupts() override
+    {
+        enable_irq();
+    }
+
+protected:
+    explicit PS2MouseDevice(I8042Controller const&);
+
+    // ^IRQHandler
+    virtual bool handle_irq(RegisterState const&) override;
+
+    struct RawPacket {
+        union {
+            u32 dword;
+            u8 bytes[4];
+        };
+    };
+
+    ErrorOr<u8> read_from_device();
+    ErrorOr<u8> send_command(u8 command);
+    ErrorOr<u8> send_command(u8 command, u8 data);
+    MousePacket parse_data_packet(RawPacket const&);
+    ErrorOr<void> set_sample_rate(u8);
+    ErrorOr<u8> get_device_id();
+
+    u8 m_data_state { 0 };
+    RawPacket m_data;
+    bool m_has_wheel { false };
+    bool m_has_five_buttons { false };
+};
+
+}

Kernel/Arch/x86_64/ISABus/HID/VMWareMouseDevice.cpp

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2021, Liav A. <liavalb@hotmail.co.il>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <Kernel/Arch/x86_64/Hypervisor/VMWareBackdoor.h>
+#include <Kernel/Arch/x86_64/ISABus/HID/VMWareMouseDevice.h>
+#include <Kernel/Devices/DeviceManagement.h>
+#include <Kernel/Sections.h>
+
+namespace Kernel {
+
+UNMAP_AFTER_INIT ErrorOr<NonnullLockRefPtr<VMWareMouseDevice>> VMWareMouseDevice::try_to_initialize(I8042Controller const& ps2_controller)
+{
+    // FIXME: return the correct error
+    if (!VMWareBackdoor::the())
+        return Error::from_errno(EIO);
+    if (!VMWareBackdoor::the()->vmmouse_is_absolute())
+        return Error::from_errno(EIO);
+    auto mouse_device = TRY(DeviceManagement::try_create_device<VMWareMouseDevice>(ps2_controller));
+    TRY(mouse_device->initialize());
+    return mouse_device;
+}
+
+void VMWareMouseDevice::irq_handle_byte_read(u8)
+{
+    auto backdoor = VMWareBackdoor::the();
+    VERIFY(backdoor);
+    VERIFY(backdoor->vmmouse_is_absolute());
+
+    // We will receive 4 bytes from the I8042 controller that we are going to
+    // ignore. Instead, we will check with VMWareBackdoor to see how many bytes
+    // of mouse event data are waiting for us. For each multiple of 4, we
+    // produce a mouse packet.
+    constexpr u8 max_iterations = 128;
+    u8 current_iteration = 0;
+    while (++current_iteration < max_iterations) {
+        auto number_of_mouse_event_bytes = backdoor->read_mouse_status_queue_size();
+        if (number_of_mouse_event_bytes == 0)
+            break;
+        VERIFY(number_of_mouse_event_bytes % 4 == 0);
+
+        auto mouse_packet = backdoor->receive_mouse_packet();
+        m_entropy_source.add_random_event(mouse_packet);
+        {
+            SpinlockLocker lock(m_queue_lock);
+            m_queue.enqueue(mouse_packet);
+        }
+    }
+    evaluate_block_conditions();
+}
+
+VMWareMouseDevice::VMWareMouseDevice(I8042Controller const& ps2_controller)
+    : PS2MouseDevice(ps2_controller)
+{
+}
+VMWareMouseDevice::~VMWareMouseDevice() = default;
+
+}

Kernel/Arch/x86_64/ISABus/HID/VMWareMouseDevice.h

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2021, Liav A. <liavalb@hotmail.co.il>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/CircularQueue.h>
+#include <Kernel/API/MousePacket.h>
+#include <Kernel/Arch/x86_64/ISABus/HID/PS2MouseDevice.h>
+#include <Kernel/Arch/x86_64/ISABus/I8042Controller.h>
+#include <Kernel/Interrupts/IRQHandler.h>
+#include <Kernel/Random.h>
+
+namespace Kernel {
+
+class VMWareMouseDevice final : public PS2MouseDevice {
+public:
+    friend class DeviceManagement;
+    static ErrorOr<NonnullLockRefPtr<VMWareMouseDevice>> try_to_initialize(I8042Controller const&);
+    virtual ~VMWareMouseDevice() override;
+
+    // ^I8042Device
+    virtual void irq_handle_byte_read(u8 byte) override;
+
+private:
+    explicit VMWareMouseDevice(I8042Controller const&);
+};
+
+}