Kernel/HID: Introduce initial USB mouse support

Kernel/Bus/USB/Drivers/HID/Codes.h

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2023, Liav A. <liavalb@hotmail.co.il>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/StdLibExtraDetails.h>
+#include <AK/StringView.h>
+#include <AK/Types.h>
+
+namespace Kernel::USB::HID {
+
+enum class SubclassCode : u8 {
+    BootProtocol = 0x01,
+};
+
+struct [[gnu::packed]] MouseBootProtocolPacket {
+    u8 buttons;
+    i8 x;
+    i8 y;
+    i8 z;
+    i8 reserved1;
+    i8 reserved2;
+};
+
+static_assert(AssertSize<MouseBootProtocolPacket, 6>());
+
+constexpr StringView subclass_string(SubclassCode code)
+{
+    switch (code) {
+    case SubclassCode::BootProtocol:
+        return "Boot Protocol"sv;
+    }
+
+    return "Reserved"sv;
+}
+
+enum class InterfaceProtocol : u8 {
+    Mouse = 0x02,
+};
+
+}

Kernel/Bus/USB/Drivers/HID/MouseDriver.cpp

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2023, Liav A. <liavalb@hotmail.co.il>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#include <AK/Find.h>
+#include <Kernel/Bus/USB/Drivers/HID/Codes.h>
+#include <Kernel/Bus/USB/Drivers/HID/MouseDriver.h>
+#include <Kernel/Bus/USB/USBClasses.h>
+#include <Kernel/Bus/USB/USBEndpoint.h>
+#include <Kernel/Bus/USB/USBRequest.h>
+#include <Kernel/Devices/DeviceManagement.h>
+#include <Kernel/Devices/HID/Management.h>
+
+namespace Kernel::USB {
+
+USB_DEVICE_DRIVER(MouseDriver);
+
+void MouseDriver::init()
+{
+    auto driver = MUST(adopt_nonnull_lock_ref_or_enomem(new MouseDriver()));
+    USBManagement::the().register_driver(driver);
+}
+
+ErrorOr<void> MouseDriver::checkout_interface(USB::Device& device, USBInterface const& interface)
+{
+    auto const& descriptor = interface.descriptor();
+    if (descriptor.interface_class_code == USB_CLASS_HID
+        && descriptor.interface_sub_class_code == to_underlying(HID::SubclassCode::BootProtocol)
+        && descriptor.interface_protocol == to_underlying(HID::InterfaceProtocol::Mouse)) {
+        dmesgln("USB HID Mouse Interface for device {:#04x}:{:#04x} found", device.device_descriptor().vendor_id, device.device_descriptor().product_id);
+        return initialize_device(device, interface);
+    }
+    return ENOTSUP;
+}
+
+ErrorOr<void> MouseDriver::probe(USB::Device& device)
+{
+    if (device.device_descriptor().device_class != USB_CLASS_DEVICE
+        || device.device_descriptor().device_sub_class != 0x00
+        || device.device_descriptor().device_protocol != 0x00)
+        return ENOTSUP;
+    // FIXME: Are we guaranteed to have one USB configuration for a mouse device?
+    if (device.configurations().size() != 1)
+        return ENOTSUP;
+    // FIXME: If we have multiple USB configurations for a mouse device, find the appropriate one
+    // and handle multiple interfaces for it.
+    if (device.configurations()[0].interfaces().size() != 1)
+        return ENOTSUP;
+
+    TRY(checkout_interface(device, device.configurations()[0].interfaces()[0]));
+
+    return ENOTSUP;
+}
+
+ErrorOr<void> MouseDriver::initialize_device(USB::Device& device, USBInterface const& interface)
+{
+    if (interface.endpoints().size() != 1)
+        return ENOTSUP;
+    auto const& configuration = interface.configuration();
+    // FIXME: Should we check other configurations?
+    TRY(device.control_transfer(
+        USB_REQUEST_RECIPIENT_DEVICE | USB_REQUEST_TYPE_STANDARD | USB_REQUEST_TRANSFER_DIRECTION_HOST_TO_DEVICE,
+        USB_REQUEST_SET_CONFIGURATION, configuration.configuration_id(), 0, 0, nullptr));
+
+    auto const& endpoint_descriptor = interface.endpoints()[0];
+    auto interrupt_in_pipe = TRY(USB::InterruptInPipe::create(device.controller(), endpoint_descriptor.endpoint_address, endpoint_descriptor.max_packet_size, device.address(), 10));
+    auto mouse_device = TRY(USBMouseDevice::try_create_instance(device, endpoint_descriptor.max_packet_size, move(interrupt_in_pipe)));
+    HIDManagement::the().attach_standalone_hid_device(*mouse_device);
+    m_interfaces.append(mouse_device);
+    return {};
+}
+
+void MouseDriver::detach(USB::Device& device)
+{
+    auto&& mouse_device = AK::find_if(m_interfaces.begin(), m_interfaces.end(), [&device](auto& interface) { return &interface.device() == &device; });
+
+    HIDManagement::the().detach_standalone_hid_device(*mouse_device);
+    m_interfaces.remove(*mouse_device);
+}
+
+}

Kernel/Bus/USB/Drivers/HID/MouseDriver.h

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2023, Liav A. <liavalb@hotmail.co.il>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <Kernel/Bus/USB/Drivers/USBDriver.h>
+#include <Kernel/Bus/USB/USBInterface.h>
+#include <Kernel/Bus/USB/USBManagement.h>
+#include <Kernel/Devices/HID/USB/MouseDevice.h>
+
+namespace Kernel::USB {
+
+class MouseDriver final : public Driver {
+public:
+    MouseDriver()
+        : Driver("USB Mouse"sv)
+    {
+    }
+
+    static void init();
+
+    virtual ~MouseDriver() override = default;
+
+    virtual ErrorOr<void> probe(USB::Device&) override;
+    virtual void detach(USB::Device&) override;
+
+private:
+    USBMouseDevice::List m_interfaces;
+
+    ErrorOr<void> checkout_interface(USB::Device&, USBInterface const&);
+
+    ErrorOr<void> initialize_device(USB::Device&, USBInterface const&);
+};
+
+}