1/* SPDX-License-Identifier: GPL-2.0+ */
  2
  3#ifndef _VKMS_DRV_H_
  4#define _VKMS_DRV_H_
  5
  6#include <linux/hrtimer.h>
  7
  8#include <drm/drm.h>
  9#include <drm/drm_framebuffer.h>
 10#include <drm/drm_gem.h>
 11#include <drm/drm_gem_atomic_helper.h>
 12#include <drm/drm_encoder.h>
 13#include <drm/drm_writeback.h>
 14
 15#define XRES_MIN    20
 16#define YRES_MIN    20
 17
 18#define XRES_DEF  1024
 19#define YRES_DEF   768
 20
 21#define XRES_MAX  8192
 22#define YRES_MAX  8192
 23
 24#define NUM_OVERLAY_PLANES 8
 25
 26struct vkms_frame_info {
 27	struct drm_framebuffer *fb;
 28	struct drm_rect src, dst;
 29	struct iosys_map map[DRM_FORMAT_MAX_PLANES];
 30	unsigned int offset;
 31	unsigned int pitch;
 32	unsigned int cpp;
 33};
 34
 35struct pixel_argb_u16 {
 36	u16 a, r, g, b;
 37};
 38
 39struct line_buffer {
 40	size_t n_pixels;
 41	struct pixel_argb_u16 *pixels;
 42};
 43
 44struct vkms_writeback_job {
 45	struct iosys_map data[DRM_FORMAT_MAX_PLANES];
 46	struct vkms_frame_info wb_frame_info;
 47	void (*wb_write)(struct vkms_frame_info *frame_info,
 48			 const struct line_buffer *buffer, int y);
 49};
 50
 51/**
 52 * vkms_plane_state - Driver specific plane state
 53 * @base: base plane state
 54 * @frame_info: data required for composing computation
 55 */
 56struct vkms_plane_state {
 57	struct drm_shadow_plane_state base;
 58	struct vkms_frame_info *frame_info;
 59	void (*plane_read)(struct line_buffer *buffer,
 60			   const struct vkms_frame_info *frame_info, int y);
 61};
 62
 63struct vkms_plane {
 64	struct drm_plane base;
 65};
 66
 67/**
 68 * vkms_crtc_state - Driver specific CRTC state
 69 * @base: base CRTC state
 70 * @composer_work: work struct to compose and add CRC entries
 71 * @n_frame_start: start frame number for computed CRC
 72 * @n_frame_end: end frame number for computed CRC
 73 */
 74struct vkms_crtc_state {
 75	struct drm_crtc_state base;
 76	struct work_struct composer_work;
 77
 78	int num_active_planes;
 79	/* stack of active planes for crc computation, should be in z order */
 80	struct vkms_plane_state **active_planes;
 81	struct vkms_writeback_job *active_writeback;
 82
 83	/* below four are protected by vkms_output.composer_lock */
 84	bool crc_pending;
 85	bool wb_pending;
 86	u64 frame_start;
 87	u64 frame_end;
 88};
 89
 90struct vkms_output {
 91	struct drm_crtc crtc;
 92	struct drm_encoder encoder;
 93	struct drm_connector connector;
 94	struct drm_writeback_connector wb_connector;
 95	struct hrtimer vblank_hrtimer;
 96	ktime_t period_ns;
 97	struct drm_pending_vblank_event *event;
 98	/* ordered wq for composer_work */
 99	struct workqueue_struct *composer_workq;
100	/* protects concurrent access to composer */
101	spinlock_t lock;
102
103	/* protected by @lock */
104	bool composer_enabled;
105	struct vkms_crtc_state *composer_state;
106
107	spinlock_t composer_lock;
108};
109
110struct vkms_device;
111
112struct vkms_config {
113	bool writeback;
114	bool cursor;
115	bool overlay;
116	/* only set when instantiated */
117	struct vkms_device *dev;
118};
119
120struct vkms_device {
121	struct drm_device drm;
122	struct platform_device *platform;
123	struct vkms_output output;
124	const struct vkms_config *config;
125};
126
127#define drm_crtc_to_vkms_output(target) \
128	container_of(target, struct vkms_output, crtc)
129
130#define drm_device_to_vkms_device(target) \
131	container_of(target, struct vkms_device, drm)
132
133#define to_vkms_crtc_state(target)\
134	container_of(target, struct vkms_crtc_state, base)
135
136#define to_vkms_plane_state(target)\
137	container_of(target, struct vkms_plane_state, base.base)
138
139/* CRTC */
140int vkms_crtc_init(struct drm_device *dev, struct drm_crtc *crtc,
141		   struct drm_plane *primary, struct drm_plane *cursor);
142
143int vkms_output_init(struct vkms_device *vkmsdev, int index);
144
145struct vkms_plane *vkms_plane_init(struct vkms_device *vkmsdev,
146				   enum drm_plane_type type, int index);
147
148/* CRC Support */
149const char *const *vkms_get_crc_sources(struct drm_crtc *crtc,
150					size_t *count);
151int vkms_set_crc_source(struct drm_crtc *crtc, const char *src_name);
152int vkms_verify_crc_source(struct drm_crtc *crtc, const char *source_name,
153			   size_t *values_cnt);
154
155/* Composer Support */
156void vkms_composer_worker(struct work_struct *work);
157void vkms_set_composer(struct vkms_output *out, bool enabled);
158
159/* Writeback */
160int vkms_enable_writeback_connector(struct vkms_device *vkmsdev);
161
162#endif /* _VKMS_DRV_H_ */