1 files changed, 219 insertions, 0 deletions
diff --git a/Kernel/Graphics/VirtIOGPU/VirtIOGPU.h b/Kernel/Graphics/VirtIOGPU/VirtIOGPU.h
new file mode 100644
index 0000000000..c2e0e588ba
--- /dev/null
+++ b/Kernel/Graphics/VirtIOGPU/VirtIOGPU.h
@@ -0,0 +1,219 @@
+/*
+ * Copyright (c) 2021, Sahan Fernando <sahan.h.fernando@gmail.com>
+ *
+ * SPDX-License-Identifier: BSD-2-Clause
+ */
+
+#pragma once
+
+#include <AK/DistinctNumeric.h>
+#include <Kernel/Devices/BlockDevice.h>
+#include <Kernel/VirtIO/VirtIO.h>
+#include <Kernel/VirtIO/VirtIOQueue.h>
+
+#define VIRTIO_GPU_F_VIRGL (1 << 0)
+#define VIRTIO_GPU_F_EDID (1 << 1)
+
+#define VIRTIO_GPU_FLAG_FENCE (1 << 0)
+
+#define VIRTIO_GPU_MAX_SCANOUTS 16
+
+#define CONTROLQ 0
+#define CURSORQ 1
+
+#define MAX_VIRTIOGPU_RESOLUTION_WIDTH 3840
+#define MAX_VIRTIOGPU_RESOLUTION_HEIGHT 2160
+
+namespace Kernel::Graphics {
+
+TYPEDEF_DISTINCT_ORDERED_ID(u32, VirtIOGPUResourceID);
+TYPEDEF_DISTINCT_ORDERED_ID(u32, VirtIOGPUScanoutID);
+
+enum class VirtIOGPUCtrlType : u32 {
+    /* 2d commands */
+    VIRTIO_GPU_CMD_GET_DISPLAY_INFO = 0x0100,
+    VIRTIO_GPU_CMD_RESOURCE_CREATE_2D,
+    VIRTIO_GPU_CMD_RESOURCE_UNREF,
+    VIRTIO_GPU_CMD_SET_SCANOUT,
+    VIRTIO_GPU_CMD_RESOURCE_FLUSH,
+    VIRTIO_GPU_CMD_TRANSFER_TO_HOST_2D,
+    VIRTIO_GPU_CMD_RESOURCE_ATTACH_BACKING,
+    VIRTIO_GPU_CMD_RESOURCE_DETACH_BACKING,
+    VIRTIO_GPU_CMD_GET_CAPSET_INFO,
+    VIRTIO_GPU_CMD_GET_CAPSET,
+    VIRTIO_GPU_CMD_GET_EDID,
+
+    /* cursor commands */
+    VIRTIO_GPU_CMD_UPDATE_CURSOR = 0x0300,
+    VIRTIO_GPU_CMD_MOVE_CURSOR,
+
+    /* success responses */
+    VIRTIO_GPU_RESP_OK_NODATA = 0x1100,
+    VIRTIO_GPU_RESP_OK_DISPLAY_INFO,
+    VIRTIO_GPU_RESP_OK_CAPSET_INFO,
+    VIRTIO_GPU_RESP_OK_CAPSET,
+    VIRTIO_GPU_RESP_OK_EDID,
+
+    /* error responses */
+    VIRTIO_GPU_RESP_ERR_UNSPEC = 0x1200,
+    VIRTIO_GPU_RESP_ERR_OUT_OF_MEMORY,
+    VIRTIO_GPU_RESP_ERR_INVALID_SCANOUT_ID,
+    VIRTIO_GPU_RESP_ERR_INVALID_RESOURCE_ID,
+    VIRTIO_GPU_RESP_ERR_INVALID_CONTEXT_ID,
+    VIRTIO_GPU_RESP_ERR_INVALID_PARAMETER,
+};
+
+struct VirtIOGPUCtrlHeader {
+    u32 type;
+    u32 flags;
+    u64 fence_id;
+    u32 context_id;
+    u32 padding;
+};
+
+struct VirtIOGPURect {
+    u32 x;
+    u32 y;
+    u32 width;
+    u32 height;
+};
+
+struct VirtIOGPURespDisplayInfo {
+    VirtIOGPUCtrlHeader header;
+    struct VirtIOGPUDisplayOne {
+        VirtIOGPURect rect;
+        u32 enabled;
+        u32 flags;
+    } scanout_modes[VIRTIO_GPU_MAX_SCANOUTS];
+};
+
+enum class VirtIOGPUFormats : u32 {
+    VIRTIO_GPU_FORMAT_B8G8R8A8_UNORM = 1,
+    VIRTIO_GPU_FORMAT_B8G8R8X8_UNORM = 2,
+    VIRTIO_GPU_FORMAT_A8R8G8B8_UNORM = 3,
+    VIRTIO_GPU_FORMAT_X8R8G8B8_UNORM = 4,
+
+    VIRTIO_GPU_FORMAT_R8G8B8A8_UNORM = 67,
+    VIRTIO_GPU_FORMAT_X8B8G8R8_UNORM = 68,
+
+    VIRTIO_GPU_FORMAT_A8B8G8R8_UNORM = 121,
+    VIRTIO_GPU_FORMAT_R8G8B8X8_UNORM = 134,
+};
+
+struct VirtIOGPUResourceCreate2D {
+    VirtIOGPUCtrlHeader header;
+    u32 resource_id;
+    u32 format;
+    u32 width;
+    u32 height;
+};
+
+struct VirtioGPUResourceUnref {
+    VirtIOGPUCtrlHeader header;
+    u32 resource_id;
+    u32 padding;
+};
+
+struct VirtIOGPUSetScanOut {
+    VirtIOGPUCtrlHeader header;
+    VirtIOGPURect rect;
+    u32 scanout_id;
+    u32 resource_id;
+};
+
+struct VirtIOGPUMemEntry {
+    u64 address;
+    u32 length;
+    u32 padding;
+};
+
+struct VirtIOGPUResourceAttachBacking {
+    VirtIOGPUCtrlHeader header;
+    u32 resource_id;
+    u32 num_entries;
+    VirtIOGPUMemEntry entries[];
+};
+
+struct VirtIOGPUResourceDetachBacking {
+    VirtIOGPUCtrlHeader header;
+    u32 resource_id;
+    u32 padding;
+};
+
+struct VirtIOGPUTransferToHost2D {
+    VirtIOGPUCtrlHeader header;
+    VirtIOGPURect rect;
+    u64 offset;
+    u32 resource_id;
+    u32 padding;
+};
+
+struct VirtIOGPUResourceFlush {
+    VirtIOGPUCtrlHeader header;
+    VirtIOGPURect rect;
+    u32 resource_id;
+    u32 padding;
+};
+
+class VirtIOGPU final
+    : public VirtIODevice
+    , public RefCounted<VirtIOGPU> {
+public:
+    VirtIOGPU(PCI::Address);
+    virtual ~VirtIOGPU() override;
+
+    bool try_to_set_resolution(size_t width, size_t height);
+    void clear_to_black();
+
+    VMObject& framebuffer_vm_object() { return m_framebuffer->vmobject(); }
+    Region& framebuffer_region() { return *m_framebuffer; }
+
+    size_t framebuffer_width() { return m_display_info.rect.width; }
+    size_t framebuffer_height() { return m_display_info.rect.height; }
+    size_t framebuffer_pitch() { return m_display_info.rect.width * 4; }
+
+    size_t framebuffer_size_in_bytes() const;
+    size_t calculate_framebuffer_size(size_t width, size_t height) const
+    {
+        return sizeof(u32) * width * height;
+    }
+
+    void flush_dirty_window(VirtIOGPURect dirty_rect);
+
+private:
+    virtual bool handle_device_config_change() override;
+    virtual void handle_queue_update(u16 queue_index) override;
+
+    u32 get_pending_events();
+    void clear_pending_events(u32 event_bitmask);
+
+    VirtIOGPUResourceID allocate_resource_id();
+    PhysicalAddress start_of_scratch_space() const { return m_scratch_space->physical_page(0)->paddr(); }
+    void synchronous_virtio_gpu_command(PhysicalAddress buffer_start, size_t request_size, size_t response_size);
+    void populate_virtio_gpu_request_header(VirtIOGPUCtrlHeader& header, VirtIOGPUCtrlType ctrl_type, u32 flags = 0);
+
+    void query_display_information();
+    VirtIOGPUResourceID create_2d_resource(VirtIOGPURect rect);
+    void delete_resource(VirtIOGPUResourceID resource_id);
+    void ensure_backing_storage(Region& region, size_t buffer_length, VirtIOGPUResourceID resource_id);
+    void detach_backing_storage(VirtIOGPUResourceID resource_id);
+    void set_scanout_resource(VirtIOGPUScanoutID scanout, VirtIOGPUResourceID resource_id, VirtIOGPURect rect);
+    void draw_ntsc_test_pattern();
+    void transfer_framebuffer_data_to_host(VirtIOGPURect rect);
+    void flush_displayed_image(VirtIOGPURect dirty_rect);
+
+    VirtIOGPURespDisplayInfo::VirtIOGPUDisplayOne m_display_info;
+    Optional<VirtIOGPUScanoutID> m_chosen_scanout;
+    VirtIOGPUResourceID m_framebuffer_id { 0 };
+    Configuration const* m_device_configuration { nullptr };
+    size_t m_num_scanouts { 0 };
+    OwnPtr<Region> m_framebuffer;
+    VirtIOGPUResourceID m_resource_id_counter { 0 };
+
+    // Synchronous commands
+    WaitQueue m_outstanding_request;
+    Lock m_operation_lock;
+    OwnPtr<Region> m_scratch_space;
+};
+
+}