mirror of
https://github.com/RGBCube/serenity
synced 2025-05-31 19:18:12 +00:00
8554952690
We create a base class called GenericFramebufferDevice, which defines all the virtual functions that must be implemented by a FramebufferDevice. Then, we make the VirtIO FramebufferDevice and other FramebufferDevice implementations inherit from it. The most important consequence of rearranging the classes is that we now have one IOCTL method, so all drivers should be committed to not override the IOCTL method or make their own IOCTLs of FramebufferDevice. All graphical IOCTLs are known to all FramebufferDevices, and it's up to the specific implementation whether to support them or discard them (so we require extensive usage of KResult and KResultOr, together with virtual characteristic functions). As a result, the interface is much cleaner and understandable to read.
108 lines
3.9 KiB
C++
108 lines
3.9 KiB
C++
/*
|
|
* Copyright (c) 2021, Sahan Fernando <sahan.h.fernando@gmail.com>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <Kernel/Bus/VirtIO/Device.h>
|
|
#include <Kernel/Bus/VirtIO/Queue.h>
|
|
#include <Kernel/Graphics/FramebufferDevice.h>
|
|
#include <Kernel/Graphics/GenericGraphicsAdapter.h>
|
|
#include <Kernel/Graphics/VirtIOGPU/Protocol.h>
|
|
|
|
namespace Kernel::Graphics::VirtIOGPU {
|
|
|
|
class GraphicsAdapter;
|
|
class FramebufferDevice final : public GenericFramebufferDevice {
|
|
friend class Console;
|
|
struct Buffer {
|
|
size_t framebuffer_offset { 0 };
|
|
u8* framebuffer_data { nullptr };
|
|
Protocol::Rect dirty_rect {};
|
|
ResourceID resource_id { 0 };
|
|
};
|
|
|
|
public:
|
|
FramebufferDevice(GraphicsAdapter const&, ScanoutID);
|
|
virtual ~FramebufferDevice() override;
|
|
|
|
virtual KResult try_to_initialize() override { return KSuccess; }
|
|
|
|
virtual void deactivate_writes();
|
|
virtual void activate_writes();
|
|
|
|
size_t width() const { return display_info().rect.width; }
|
|
size_t height() const { return display_info().rect.height; }
|
|
size_t pitch() const { return display_info().rect.width * 4; }
|
|
|
|
static size_t calculate_framebuffer_size(size_t width, size_t height)
|
|
{
|
|
// VirtIO resources can only map on page boundaries!
|
|
return Memory::page_round_up(sizeof(u32) * width * height);
|
|
}
|
|
|
|
u8* framebuffer_data();
|
|
|
|
private:
|
|
virtual bool multihead_support() const override { return false; }
|
|
virtual bool flushing_support() const override { return false; }
|
|
virtual bool partial_flushing_support() const override { return true; }
|
|
virtual size_t heads_count() const override { return 1; }
|
|
virtual KResultOr<size_t> buffer_length(size_t head) const override;
|
|
virtual KResultOr<size_t> pitch(size_t head) const override;
|
|
virtual KResultOr<size_t> height(size_t head) const override;
|
|
virtual KResultOr<size_t> width(size_t head) const override;
|
|
virtual KResultOr<size_t> vertical_offset(size_t head) const override;
|
|
virtual KResultOr<bool> vertical_offseted(size_t head) const override;
|
|
|
|
virtual KResult set_head_resolution(size_t head, size_t width, size_t height, size_t pitch) override;
|
|
virtual KResult set_head_buffer(size_t head, bool second_buffer) override;
|
|
virtual KResult flush_head_buffer(size_t head) override;
|
|
virtual KResult flush_rectangle(size_t head, FBRect const&) override;
|
|
|
|
void flush_dirty_window(Protocol::Rect const&, Buffer&);
|
|
void transfer_framebuffer_data_to_host(Protocol::Rect const&, Buffer&);
|
|
void flush_displayed_image(Protocol::Rect const&, Buffer&);
|
|
|
|
void draw_ntsc_test_pattern(Buffer&);
|
|
|
|
Protocol::DisplayInfoResponse::Display const& display_info() const;
|
|
Protocol::DisplayInfoResponse::Display& display_info();
|
|
|
|
void clear_to_black(Buffer&);
|
|
|
|
KResult create_framebuffer();
|
|
void create_buffer(Buffer&, size_t, size_t);
|
|
void set_buffer(int);
|
|
|
|
virtual KResultOr<Memory::Region*> mmap(Process&, OpenFileDescription&, Memory::VirtualRange const&, u64 offset, int prot, bool shared) override;
|
|
|
|
static bool is_valid_buffer_index(int buffer_index)
|
|
{
|
|
return buffer_index == 0 || buffer_index == 1;
|
|
}
|
|
|
|
Buffer& buffer_from_index(int buffer_index)
|
|
{
|
|
return buffer_index == 0 ? m_main_buffer : m_back_buffer;
|
|
}
|
|
Buffer& current_buffer() const { return *m_current_buffer; }
|
|
|
|
RefPtr<GraphicsAdapter> adapter() const;
|
|
|
|
const ScanoutID m_scanout;
|
|
Buffer* m_current_buffer { nullptr };
|
|
Atomic<int, AK::memory_order_relaxed> m_last_set_buffer_index { 0 };
|
|
Buffer m_main_buffer;
|
|
Buffer m_back_buffer;
|
|
OwnPtr<Memory::Region> m_framebuffer;
|
|
RefPtr<Memory::VMObject> m_framebuffer_sink_vmobject;
|
|
size_t m_buffer_size { 0 };
|
|
bool m_are_writes_active { true };
|
|
// FIXME: This needs to be cleaned up if the WindowServer exits while we are in a tty
|
|
WeakPtr<Memory::Region> m_userspace_mmap_region;
|
|
};
|
|
|
|
}
|