wlroots/include/backend/drm.h

#ifndef BACKEND_DRM_H
#define BACKEND_DRM_H

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <wayland-server.h>
#include <xf86drmMode.h>
#include <EGL/egl.h>
#include <gbm.h>

#include <wlr/backend/session.h>
#include <wlr/backend/drm.h>
#include <wlr/types/wlr_output.h>
#include <wlr/egl.h>
#include <wlr/util/list.h>

#include "drm-properties.h"

struct wlr_drm_plane {
	uint32_t type;
	uint32_t id;

	uint32_t possible_crtcs;

	uint32_t width, height;

	struct gbm_surface *gbm;
	EGLSurface egl;

	struct gbm_bo *front;
	struct gbm_bo *back;

	// Only used by cursor
	float matrix[16];
	struct wlr_renderer *wlr_rend;
	struct wlr_texture *wlr_tex;
	struct gbm_bo *cursor_bo;

	union wlr_drm_plane_props props;
};

struct wlr_drm_crtc {
	uint32_t id;
	uint32_t mode_id; // atomic modesetting only
	drmModeAtomicReq *atomic;

	union {
		struct {
			struct wlr_drm_plane *overlay;
			struct wlr_drm_plane *primary;
			struct wlr_drm_plane *cursor;
		};
		struct wlr_drm_plane *planes[3];
	};

	union wlr_drm_crtc_props props;

	struct wl_list connectors;
};

struct wlr_drm_connector {
	struct wlr_output *base;
	uint32_t id;
	struct wlr_drm_crtc *crtc;

	union wlr_drm_connector_props props;

	struct wl_list link;
};

struct wlr_drm_renderer {
	int fd;
	struct gbm_device *gbm;
	struct wlr_egl egl;
};

bool wlr_drm_renderer_init(struct wlr_drm_renderer *renderer, int fd);
void wlr_drm_renderer_free(struct wlr_drm_renderer *renderer);

struct wlr_drm_interface;

struct wlr_drm_backend {
	struct wlr_backend backend;

	const struct wlr_drm_interface *iface;

	int fd;

	size_t num_crtcs;
	struct wlr_drm_crtc *crtcs;
	size_t num_planes;
	struct wlr_drm_plane *planes;

	union {
		struct {
			size_t num_overlay_planes;
			size_t num_primary_planes;
			size_t num_cursor_planes;
		};
		size_t num_type_planes[3];
	};

	union {
		struct {
			struct wlr_drm_plane *overlay_planes;
			struct wlr_drm_plane *primary_planes;
			struct wlr_drm_plane *cursor_planes;
		};
		struct wlr_drm_plane *type_planes[3];
	};

	struct wl_display *display;
	struct wl_event_source *drm_event;

	struct wl_listener session_signal;
	struct wl_listener drm_invalidated;

	list_t *outputs;

	struct wlr_drm_renderer renderer;
	struct wlr_session *session;
};

enum wlr_drm_output_state {
	WLR_DRM_OUTPUT_DISCONNECTED,
	WLR_DRM_OUTPUT_NEEDS_MODESET,
	WLR_DRM_OUTPUT_CLEANUP,
	WLR_DRM_OUTPUT_CONNECTED,
};

struct wlr_drm_output_mode {
	struct wlr_output_mode wlr_mode;
	drmModeModeInfo mode;
};

struct wlr_drm_output {
	struct wlr_output output;

	enum wlr_drm_output_state state;
	uint32_t connector;

	struct wlr_drm_crtc *crtc;
	uint32_t possible_crtc;

	union wlr_drm_connector_props props;

	uint32_t width;
	uint32_t height;

	drmModeCrtc *old_crtc;

	struct wlr_drm_renderer *renderer;

	bool pageflip_pending;
	struct wl_event_source *retry_pageflip;
};

// Used to provide atomic or legacy DRM functions
struct wlr_drm_interface {
	// Enable or disable DPMS for output
	void (*conn_enable)(struct wlr_drm_backend *backend,
			struct wlr_drm_output *output, bool enable);
	// Pageflip on crtc. If mode is non-NULL perform a full modeset using it.
	bool (*crtc_pageflip)(struct wlr_drm_backend *backend,
			struct wlr_drm_output *output, struct wlr_drm_crtc *crtc,
			uint32_t fb_id, drmModeModeInfo *mode);
	// Enable the cursor buffer on crtc. Set bo to NULL to disable
	bool (*crtc_set_cursor)(struct wlr_drm_backend *backend,
			struct wlr_drm_crtc *crtc, struct gbm_bo *bo);
	// Move the cursor on crtc
	bool (*crtc_move_cursor)(struct wlr_drm_backend *backend,
			struct wlr_drm_crtc *crtc, int x, int y);
};

bool wlr_drm_check_features(struct wlr_drm_backend *drm);
bool wlr_drm_resources_init(struct wlr_drm_backend *drm);
void wlr_drm_resources_free(struct wlr_drm_backend *drm);
void wlr_drm_restore_outputs(struct wlr_drm_backend *drm);
void wlr_drm_output_cleanup(struct wlr_drm_output *output);
void wlr_drm_scan_connectors(struct wlr_drm_backend *state);
int wlr_drm_event(int fd, uint32_t mask, void *data);

void wlr_drm_output_start_renderer(struct wlr_drm_output *output);

#endif