[mirror_ubuntu-focal-kernel.git] / drivers / gpu / drm / vmwgfx / vmwgfx_kms.h

/**************************************************************************
 *
 * Copyright © 2009-2015 VMware, Inc., Palo Alto, CA., USA
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 **************************************************************************/

#ifndef VMWGFX_KMS_H_
#define VMWGFX_KMS_H_

#include <drm/drmP.h>
#include <drm/drm_crtc_helper.h>
#include <drm/drm_encoder.h>
#include "vmwgfx_drv.h"


/**
 * struct vmw_kms_dirty - closure structure for the vmw_kms_helper_dirty
 * function.
 *
 * @fifo_commit: Callback that is called once for each display unit after
 * all clip rects. This function must commit the fifo space reserved by the
 * helper. Set up by the caller.
 * @clip: Callback that is called for each cliprect on each display unit.
 * Set up by the caller.
 * @fifo_reserve_size: Fifo size that the helper should try to allocat for
 * each display unit. Set up by the caller.
 * @dev_priv: Pointer to the device private. Set up by the helper.
 * @unit: The current display unit. Set up by the helper before a call to @clip.
 * @cmd: The allocated fifo space. Set up by the helper before the first @clip
 * call.
 * @num_hits: Number of clip rect commands for this display unit.
 * Cleared by the helper before the first @clip call. Updated by the @clip
 * callback.
 * @fb_x: Clip rect left side in framebuffer coordinates.
 * @fb_y: Clip rect right side in framebuffer coordinates.
 * @unit_x1: Clip rect left side in crtc coordinates.
 * @unit_y1: Clip rect top side in crtc coordinates.
 * @unit_x2: Clip rect right side in crtc coordinates.
 * @unit_y2: Clip rect bottom side in crtc coordinates.
 *
 * The clip rect coordinates are updated by the helper for each @clip call.
 * Note that this may be derived from if more info needs to be passed between
 * helper caller and helper callbacks.
 */
struct vmw_kms_dirty {
	void (*fifo_commit)(struct vmw_kms_dirty *);
	void (*clip)(struct vmw_kms_dirty *);
	size_t fifo_reserve_size;
	struct vmw_private *dev_priv;
	struct vmw_display_unit *unit;
	void *cmd;
	u32 num_hits;
	s32 fb_x;
	s32 fb_y;
	s32 unit_x1;
	s32 unit_y1;
	s32 unit_x2;
	s32 unit_y2;
};

#define VMWGFX_NUM_DISPLAY_UNITS 8


#define vmw_framebuffer_to_vfb(x) \
	container_of(x, struct vmw_framebuffer, base)
#define vmw_framebuffer_to_vfbs(x) \
	container_of(x, struct vmw_framebuffer_surface, base.base)
#define vmw_framebuffer_to_vfbd(x) \
	container_of(x, struct vmw_framebuffer_dmabuf, base.base)

/**
 * Base class for framebuffers
 *
 * @pin is called the when ever a crtc uses this framebuffer
 * @unpin is called
 */
struct vmw_framebuffer {
	struct drm_framebuffer base;
	int (*pin)(struct vmw_framebuffer *fb);
	int (*unpin)(struct vmw_framebuffer *fb);
	bool dmabuf;
	struct ttm_base_object *user_obj;
	uint32_t user_handle;
};

/*
 * Clip rectangle
 */
struct vmw_clip_rect {
	int x1, x2, y1, y2;
};

struct vmw_framebuffer_surface {
	struct vmw_framebuffer base;
	struct vmw_surface *surface;
	struct vmw_dma_buffer *buffer;
	struct list_head head;
	bool is_dmabuf_proxy;  /* true if this is proxy surface for DMA buf */
};


struct vmw_framebuffer_dmabuf {
	struct vmw_framebuffer base;
	struct vmw_dma_buffer *buffer;
};


static const uint32_t vmw_primary_plane_formats[] = {
	DRM_FORMAT_XRGB1555,
	DRM_FORMAT_RGB565,
	DRM_FORMAT_RGB888,
	DRM_FORMAT_XRGB8888,
	DRM_FORMAT_ARGB8888,
};

static const uint32_t vmw_cursor_plane_formats[] = {
	DRM_FORMAT_ARGB8888,
};


#define vmw_crtc_state_to_vcs(x) container_of(x, struct vmw_crtc_state, base)
#define vmw_plane_state_to_vps(x) container_of(x, struct vmw_plane_state, base)
#define vmw_connector_state_to_vcs(x) \
		container_of(x, struct vmw_connector_state, base)

/**
 * Derived class for crtc state object
 *
 * @base DRM crtc object
 */
struct vmw_crtc_state {
	struct drm_crtc_state base;
};

/**
 * Derived class for plane state object
 *
 * @base DRM plane object
 * @surf Display surface for STDU
 * @dmabuf display dmabuf for SOU
 * @content_fb_type Used by STDU.
 * @dmabuf_size Size of the dmabuf, used by Screen Object Display Unit
 * @pinned pin count for STDU display surface
 */
struct vmw_plane_state {
	struct drm_plane_state base;
	struct vmw_surface *surf;
	struct vmw_dma_buffer *dmabuf;

	int content_fb_type;
	unsigned long dmabuf_size;

	int pinned;

	/* For CPU Blit */
	struct ttm_bo_kmap_obj host_map;
	unsigned int cpp;
};


/**
 * Derived class for connector state object
 *
 * @base DRM connector object
 * @is_implicit connector property
 *
 */
struct vmw_connector_state {
	struct drm_connector_state base;

	bool is_implicit;
};

/**
 * Base class display unit.
 *
 * Since the SVGA hw doesn't have a concept of a crtc, encoder or connector
 * so the display unit is all of them at the same time. This is true for both
 * legacy multimon and screen objects.
 */
struct vmw_display_unit {
	struct drm_crtc crtc;
	struct drm_encoder encoder;
	struct drm_connector connector;
	struct drm_plane primary;
	struct drm_plane cursor;

	struct vmw_surface *cursor_surface;
	struct vmw_dma_buffer *cursor_dmabuf;
	size_t cursor_age;

	int cursor_x;
	int cursor_y;

	int hotspot_x;
	int hotspot_y;
	s32 core_hotspot_x;
	s32 core_hotspot_y;

	unsigned unit;

	/*
	 * Prefered mode tracking.
	 */
	unsigned pref_width;
	unsigned pref_height;
	bool pref_active;
	struct drm_display_mode *pref_mode;

	/*
	 * Gui positioning
	 */
	int gui_x;
	int gui_y;
	bool is_implicit;
	bool active_implicit;
	int set_gui_x;
	int set_gui_y;
};

#define vmw_crtc_to_du(x) \
	container_of(x, struct vmw_display_unit, crtc)
#define vmw_connector_to_du(x) \
	container_of(x, struct vmw_display_unit, connector)


/*
 * Shared display unit functions - vmwgfx_kms.c
 */
void vmw_du_cleanup(struct vmw_display_unit *du);
void vmw_du_crtc_save(struct drm_crtc *crtc);
void vmw_du_crtc_restore(struct drm_crtc *crtc);
int vmw_du_crtc_gamma_set(struct drm_crtc *crtc,
			   u16 *r, u16 *g, u16 *b,
			   uint32_t size,
			   struct drm_modeset_acquire_ctx *ctx);
int vmw_du_connector_set_property(struct drm_connector *connector,
				  struct drm_property *property,
				  uint64_t val);
int vmw_du_connector_atomic_set_property(struct drm_connector *connector,
					 struct drm_connector_state *state,
					 struct drm_property *property,
					 uint64_t val);
int
vmw_du_connector_atomic_get_property(struct drm_connector *connector,
				     const struct drm_connector_state *state,
				     struct drm_property *property,
				     uint64_t *val);
int vmw_du_connector_dpms(struct drm_connector *connector, int mode);
void vmw_du_connector_save(struct drm_connector *connector);
void vmw_du_connector_restore(struct drm_connector *connector);
enum drm_connector_status
vmw_du_connector_detect(struct drm_connector *connector, bool force);
int vmw_du_connector_fill_modes(struct drm_connector *connector,
				uint32_t max_width, uint32_t max_height);
int vmw_kms_helper_dirty(struct vmw_private *dev_priv,
			 struct vmw_framebuffer *framebuffer,
			 const struct drm_clip_rect *clips,
			 const struct drm_vmw_rect *vclips,
			 s32 dest_x, s32 dest_y,
			 int num_clips,
			 int increment,
			 struct vmw_kms_dirty *dirty);

int vmw_kms_helper_buffer_prepare(struct vmw_private *dev_priv,
				  struct vmw_dma_buffer *buf,
				  bool interruptible,
				  bool validate_as_mob);
void vmw_kms_helper_buffer_revert(struct vmw_dma_buffer *buf);
void vmw_kms_helper_buffer_finish(struct vmw_private *dev_priv,
				  struct drm_file *file_priv,
				  struct vmw_dma_buffer *buf,
				  struct vmw_fence_obj **out_fence,
				  struct drm_vmw_fence_rep __user *
				  user_fence_rep);
int vmw_kms_helper_resource_prepare(struct vmw_resource *res,
				    bool interruptible);
void vmw_kms_helper_resource_revert(struct vmw_resource *res);
void vmw_kms_helper_resource_finish(struct vmw_resource *res,
				    struct vmw_fence_obj **out_fence);
int vmw_kms_readback(struct vmw_private *dev_priv,
		     struct drm_file *file_priv,
		     struct vmw_framebuffer *vfb,
		     struct drm_vmw_fence_rep __user *user_fence_rep,
		     struct drm_vmw_rect *vclips,
		     uint32_t num_clips);
struct vmw_framebuffer *
vmw_kms_new_framebuffer(struct vmw_private *dev_priv,
			struct vmw_dma_buffer *dmabuf,
			struct vmw_surface *surface,
			bool only_2d,
			const struct drm_mode_fb_cmd2 *mode_cmd);
int vmw_kms_fbdev_init_data(struct vmw_private *dev_priv,
			    unsigned unit,
			    u32 max_width,
			    u32 max_height,
			    struct drm_connector **p_con,
			    struct drm_crtc **p_crtc,
			    struct drm_display_mode **p_mode);
void vmw_guess_mode_timing(struct drm_display_mode *mode);
void vmw_kms_del_active(struct vmw_private *dev_priv,
			struct vmw_display_unit *du);
void vmw_kms_add_active(struct vmw_private *dev_priv,
			struct vmw_display_unit *du,
			struct vmw_framebuffer *vfb);
bool vmw_kms_crtc_flippable(struct vmw_private *dev_priv,
			    struct drm_crtc *crtc);
void vmw_kms_update_implicit_fb(struct vmw_private *dev_priv,
				struct drm_crtc *crtc);
void vmw_kms_create_implicit_placement_property(struct vmw_private *dev_priv,
						bool immutable);

/* Universal Plane Helpers */
void vmw_du_primary_plane_destroy(struct drm_plane *plane);
void vmw_du_cursor_plane_destroy(struct drm_plane *plane);

/* Atomic Helpers */
int vmw_du_primary_plane_atomic_check(struct drm_plane *plane,
				      struct drm_plane_state *state);
int vmw_du_cursor_plane_atomic_check(struct drm_plane *plane,
				     struct drm_plane_state *state);
void vmw_du_cursor_plane_atomic_update(struct drm_plane *plane,
				       struct drm_plane_state *old_state);
int vmw_du_cursor_plane_prepare_fb(struct drm_plane *plane,
				   struct drm_plane_state *new_state);
void vmw_du_plane_cleanup_fb(struct drm_plane *plane,
			     struct drm_plane_state *old_state);
void vmw_du_plane_reset(struct drm_plane *plane);
struct drm_plane_state *vmw_du_plane_duplicate_state(struct drm_plane *plane);
void vmw_du_plane_destroy_state(struct drm_plane *plane,
				struct drm_plane_state *state);
void vmw_du_plane_unpin_surf(struct vmw_plane_state *vps,
			     bool unreference);

int vmw_du_crtc_atomic_check(struct drm_crtc *crtc,
			     struct drm_crtc_state *state);
void vmw_du_crtc_atomic_begin(struct drm_crtc *crtc,
			      struct drm_crtc_state *old_crtc_state);
void vmw_du_crtc_atomic_flush(struct drm_crtc *crtc,
			      struct drm_crtc_state *old_crtc_state);
void vmw_du_crtc_reset(struct drm_crtc *crtc);
struct drm_crtc_state *vmw_du_crtc_duplicate_state(struct drm_crtc *crtc);
void vmw_du_crtc_destroy_state(struct drm_crtc *crtc,
				struct drm_crtc_state *state);
void vmw_du_connector_reset(struct drm_connector *connector);
struct drm_connector_state *
vmw_du_connector_duplicate_state(struct drm_connector *connector);

void vmw_du_connector_destroy_state(struct drm_connector *connector,
				    struct drm_connector_state *state);

/*
 * Legacy display unit functions - vmwgfx_ldu.c
 */
int vmw_kms_ldu_init_display(struct vmw_private *dev_priv);
int vmw_kms_ldu_close_display(struct vmw_private *dev_priv);
int vmw_kms_ldu_do_dmabuf_dirty(struct vmw_private *dev_priv,
				struct vmw_framebuffer *framebuffer,
				unsigned flags, unsigned color,
				struct drm_clip_rect *clips,
				unsigned num_clips, int increment);
int vmw_kms_update_proxy(struct vmw_resource *res,
			 const struct drm_clip_rect *clips,
			 unsigned num_clips,
			 int increment);

/*
 * Screen Objects display functions - vmwgfx_scrn.c
 */
int vmw_kms_sou_init_display(struct vmw_private *dev_priv);
int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
				 struct vmw_framebuffer *framebuffer,
				 struct drm_clip_rect *clips,
				 struct drm_vmw_rect *vclips,
				 struct vmw_resource *srf,
				 s32 dest_x,
				 s32 dest_y,
				 unsigned num_clips, int inc,
				 struct vmw_fence_obj **out_fence);
int vmw_kms_sou_do_dmabuf_dirty(struct vmw_private *dev_priv,
				struct vmw_framebuffer *framebuffer,
				struct drm_clip_rect *clips,
				struct drm_vmw_rect *vclips,
				unsigned num_clips, int increment,
				bool interruptible,
				struct vmw_fence_obj **out_fence);
int vmw_kms_sou_readback(struct vmw_private *dev_priv,
			 struct drm_file *file_priv,
			 struct vmw_framebuffer *vfb,
			 struct drm_vmw_fence_rep __user *user_fence_rep,
			 struct drm_vmw_rect *vclips,
			 uint32_t num_clips);

/*
 * Screen Target Display Unit functions - vmwgfx_stdu.c
 */
int vmw_kms_stdu_init_display(struct vmw_private *dev_priv);
int vmw_kms_stdu_surface_dirty(struct vmw_private *dev_priv,
			       struct vmw_framebuffer *framebuffer,
			       struct drm_clip_rect *clips,
			       struct drm_vmw_rect *vclips,
			       struct vmw_resource *srf,
			       s32 dest_x,
			       s32 dest_y,
			       unsigned num_clips, int inc,
			       struct vmw_fence_obj **out_fence);
int vmw_kms_stdu_dma(struct vmw_private *dev_priv,
		     struct drm_file *file_priv,
		     struct vmw_framebuffer *vfb,
		     struct drm_vmw_fence_rep __user *user_fence_rep,
		     struct drm_clip_rect *clips,
		     struct drm_vmw_rect *vclips,
		     uint32_t num_clips,
		     int increment,
		     bool to_surface,
		     bool interruptible);

int vmw_kms_set_config(struct drm_mode_set *set,
		       struct drm_modeset_acquire_ctx *ctx);

#endif
Commit	Line	Data
fb1d9738 JB	1	/**************************************************************************
fb1d9738 JB	2	*
54fbde8a	3	* Copyright © 2009-2015 VMware, Inc., Palo Alto, CA., USA
fb1d9738 JB	4	* All Rights Reserved.
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a
	7	* copy of this software and associated documentation files (the
	8	* "Software"), to deal in the Software without restriction, including
	9	* without limitation the rights to use, copy, modify, merge, publish,
	10	* distribute, sub license, and/or sell copies of the Software, and to
	11	* permit persons to whom the Software is furnished to do so, subject to
	12	* the following conditions:
	13	*
	14	* The above copyright notice and this permission notice (including the
	15	* next paragraph) shall be included in all copies or substantial portions
	16	* of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
	21	* THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
	22	* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
	23	* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
	24	* USE OR OTHER DEALINGS IN THE SOFTWARE.
	25	*
	26	**************************************************************************/
	27
	28	#ifndef VMWGFX_KMS_H_
	29	#define VMWGFX_KMS_H_
	30
760285e7 DH	31	#include <drm/drmP.h>
760285e7 DH	32	#include <drm/drm_crtc_helper.h>
9338203c	33	#include <drm/drm_encoder.h>
fb1d9738 JB	34	#include "vmwgfx_drv.h"
fb1d9738 JB	35
36cc79bc SY	36
36cc79bc SY	37
1a4b172a TH	38	/**
	39	* struct vmw_kms_dirty - closure structure for the vmw_kms_helper_dirty
	40	* function.
	41	*
	42	* @fifo_commit: Callback that is called once for each display unit after
	43	* all clip rects. This function must commit the fifo space reserved by the
	44	* helper. Set up by the caller.
	45	* @clip: Callback that is called for each cliprect on each display unit.
	46	* Set up by the caller.
	47	* @fifo_reserve_size: Fifo size that the helper should try to allocat for
	48	* each display unit. Set up by the caller.
	49	* @dev_priv: Pointer to the device private. Set up by the helper.
	50	* @unit: The current display unit. Set up by the helper before a call to @clip.
	51	* @cmd: The allocated fifo space. Set up by the helper before the first @clip
	52	* call.
	53	* @num_hits: Number of clip rect commands for this display unit.
	54	* Cleared by the helper before the first @clip call. Updated by the @clip
	55	* callback.
	56	* @fb_x: Clip rect left side in framebuffer coordinates.
	57	* @fb_y: Clip rect right side in framebuffer coordinates.
	58	* @unit_x1: Clip rect left side in crtc coordinates.
	59	* @unit_y1: Clip rect top side in crtc coordinates.
	60	* @unit_x2: Clip rect right side in crtc coordinates.
	61	* @unit_y2: Clip rect bottom side in crtc coordinates.
	62	*
	63	* The clip rect coordinates are updated by the helper for each @clip call.
	64	* Note that this may be derived from if more info needs to be passed between
	65	* helper caller and helper callbacks.
	66	*/
	67	struct vmw_kms_dirty {
	68	void (fifo_commit)(struct vmw_kms_dirty );
	69	void (clip)(struct vmw_kms_dirty );
	70	size_t fifo_reserve_size;
	71	struct vmw_private *dev_priv;
	72	struct vmw_display_unit *unit;
	73	void *cmd;
	74	u32 num_hits;
	75	s32 fb_x;
	76	s32 fb_y;
	77	s32 unit_x1;
	78	s32 unit_y1;
	79	s32 unit_x2;
	80	s32 unit_y2;
	81	};
c8261a96	82
56d1c78d JB	83	#define VMWGFX_NUM_DISPLAY_UNITS 8
56d1c78d JB	84
fb1d9738 JB	85
	86	#define vmw_framebuffer_to_vfb(x) \
	87	container_of(x, struct vmw_framebuffer, base)
c8261a96 SY	88	#define vmw_framebuffer_to_vfbs(x) \
	89	container_of(x, struct vmw_framebuffer_surface, base.base)
	90	#define vmw_framebuffer_to_vfbd(x) \
	91	container_of(x, struct vmw_framebuffer_dmabuf, base.base)
fb1d9738 JB	92
	93	/**
	94	* Base class for framebuffers
	95	*
	96	* @pin is called the when ever a crtc uses this framebuffer
	97	* @unpin is called
	98	*/
	99	struct vmw_framebuffer {
	100	struct drm_framebuffer base;
	101	int (pin)(struct vmw_framebuffer fb);
	102	int (unpin)(struct vmw_framebuffer fb);
2fcd5a73	103	bool dmabuf;
90ff18bc TH	104	struct ttm_base_object *user_obj;
90ff18bc TH	105	uint32_t user_handle;
fb1d9738 JB	106	};
fb1d9738 JB	107
c8261a96 SY	108	/*
	109	* Clip rectangle
	110	*/
	111	struct vmw_clip_rect {
	112	int x1, x2, y1, y2;
	113	};
	114
	115	struct vmw_framebuffer_surface {
	116	struct vmw_framebuffer base;
	117	struct vmw_surface *surface;
	118	struct vmw_dma_buffer *buffer;
	119	struct list_head head;
f89c6c32	120	bool is_dmabuf_proxy; /* true if this is proxy surface for DMA buf */
c8261a96	121	};
fb1d9738	122
c8261a96 SY	123
	124	struct vmw_framebuffer_dmabuf {
	125	struct vmw_framebuffer base;
	126	struct vmw_dma_buffer *buffer;
	127	};
fb1d9738	128
fb1d9738	129
36cc79bc SY	130	static const uint32_t vmw_primary_plane_formats[] = {
	131	DRM_FORMAT_XRGB1555,
	132	DRM_FORMAT_RGB565,
	133	DRM_FORMAT_RGB888,
	134	DRM_FORMAT_XRGB8888,
	135	DRM_FORMAT_ARGB8888,
	136	};
fb1d9738	137
36cc79bc SY	138	static const uint32_t vmw_cursor_plane_formats[] = {
	139	DRM_FORMAT_ARGB8888,
	140	};
bfc2638d	141
9c2542a4 SY	142
9c2542a4 SY	143	#define vmw_crtc_state_to_vcs(x) container_of(x, struct vmw_crtc_state, base)
cc5ec459	144	#define vmw_plane_state_to_vps(x) container_of(x, struct vmw_plane_state, base)
d7721ca7 SY	145	#define vmw_connector_state_to_vcs(x) \
d7721ca7 SY	146	container_of(x, struct vmw_connector_state, base)
9c2542a4 SY	147
	148	/**
	149	* Derived class for crtc state object
	150	*
	151	* @base DRM crtc object
	152	*/
	153	struct vmw_crtc_state {
	154	struct drm_crtc_state base;
	155	};
	156
cc5ec459 SY	157	/**
	158	* Derived class for plane state object
	159	*
	160	* @base DRM plane object
	161	* @surf Display surface for STDU
	162	* @dmabuf display dmabuf for SOU
	163	* @content_fb_type Used by STDU.
06ec4190	164	* @dmabuf_size Size of the dmabuf, used by Screen Object Display Unit
cc5ec459 SY	165	* @pinned pin count for STDU display surface
	166	*/
	167	struct vmw_plane_state {
	168	struct drm_plane_state base;
	169	struct vmw_surface *surf;
	170	struct vmw_dma_buffer *dmabuf;
	171
	172	int content_fb_type;
06ec4190	173	unsigned long dmabuf_size;
cc5ec459 SY	174
cc5ec459 SY	175	int pinned;
810b3e16 SY	176
810b3e16 SY	177	/* For CPU Blit */
98648ae6	178	struct ttm_bo_kmap_obj host_map;
810b3e16	179	unsigned int cpp;
cc5ec459 SY	180	};
cc5ec459 SY	181
d7721ca7 SY	182
	183	/**
	184	* Derived class for connector state object
	185	*
	186	* @base DRM connector object
	187	* @is_implicit connector property
	188	*
	189	*/
	190	struct vmw_connector_state {
	191	struct drm_connector_state base;
	192
	193	bool is_implicit;
	194	};
	195
fb1d9738 JB	196	/**
	197	* Base class display unit.
	198	*
	199	* Since the SVGA hw doesn't have a concept of a crtc, encoder or connector
	200	* so the display unit is all of them at the same time. This is true for both
	201	* legacy multimon and screen objects.
	202	*/
	203	struct vmw_display_unit {
	204	struct drm_crtc crtc;
	205	struct drm_encoder encoder;
	206	struct drm_connector connector;
36cc79bc SY	207	struct drm_plane primary;
36cc79bc SY	208	struct drm_plane cursor;
fb1d9738 JB	209
	210	struct vmw_surface *cursor_surface;
	211	struct vmw_dma_buffer *cursor_dmabuf;
	212	size_t cursor_age;
	213
	214	int cursor_x;
	215	int cursor_y;
	216
	217	int hotspot_x;
	218	int hotspot_y;
8fbf9d92 TH	219	s32 core_hotspot_x;
8fbf9d92 TH	220	s32 core_hotspot_y;
fb1d9738 JB	221
fb1d9738 JB	222	unsigned unit;
626ab771 JB	223
	224	/*
	225	* Prefered mode tracking.
	226	*/
	227	unsigned pref_width;
	228	unsigned pref_height;
	229	bool pref_active;
	230	struct drm_display_mode *pref_mode;
cd2b89e7 TH	231
	232	/*
	233	* Gui positioning
	234	*/
	235	int gui_x;
	236	int gui_y;
6987427a	237	bool is_implicit;
75c06855	238	bool active_implicit;
6dd687b4 TH	239	int set_gui_x;
6dd687b4 TH	240	int set_gui_y;
fb1d9738 JB	241	};
fb1d9738 JB	242
2fcd5a73 JB	243	#define vmw_crtc_to_du(x) \
2fcd5a73 JB	244	container_of(x, struct vmw_display_unit, crtc)
626ab771 JB	245	#define vmw_connector_to_du(x) \
	246	container_of(x, struct vmw_display_unit, connector)
	247
	248
fb1d9738 JB	249	/*
	250	* Shared display unit functions - vmwgfx_kms.c
	251	*/
c8261a96	252	void vmw_du_cleanup(struct vmw_display_unit *du);
626ab771 JB	253	void vmw_du_crtc_save(struct drm_crtc *crtc);
626ab771 JB	254	void vmw_du_crtc_restore(struct drm_crtc *crtc);
7ea77283	255	int vmw_du_crtc_gamma_set(struct drm_crtc *crtc,
626ab771	256	u16 r, u16 g, u16 *b,
6d124ff8 DV	257	uint32_t size,
6d124ff8 DV	258	struct drm_modeset_acquire_ctx *ctx);
9c2542a4 SY	259	int vmw_du_connector_set_property(struct drm_connector *connector,
	260	struct drm_property *property,
	261	uint64_t val);
d7721ca7 SY	262	int vmw_du_connector_atomic_set_property(struct drm_connector *connector,
	263	struct drm_connector_state *state,
	264	struct drm_property *property,
	265	uint64_t val);
	266	int
	267	vmw_du_connector_atomic_get_property(struct drm_connector *connector,
	268	const struct drm_connector_state *state,
	269	struct drm_property *property,
	270	uint64_t *val);
9a69a9ac	271	int vmw_du_connector_dpms(struct drm_connector *connector, int mode);
626ab771 JB	272	void vmw_du_connector_save(struct drm_connector *connector);
	273	void vmw_du_connector_restore(struct drm_connector *connector);
	274	enum drm_connector_status
	275	vmw_du_connector_detect(struct drm_connector *connector, bool force);
	276	int vmw_du_connector_fill_modes(struct drm_connector *connector,
	277	uint32_t max_width, uint32_t max_height);
1a4b172a TH	278	int vmw_kms_helper_dirty(struct vmw_private *dev_priv,
	279	struct vmw_framebuffer *framebuffer,
	280	const struct drm_clip_rect *clips,
	281	const struct drm_vmw_rect *vclips,
	282	s32 dest_x, s32 dest_y,
	283	int num_clips,
	284	int increment,
	285	struct vmw_kms_dirty *dirty);
cd2b89e7	286
1a4b172a TH	287	int vmw_kms_helper_buffer_prepare(struct vmw_private *dev_priv,
	288	struct vmw_dma_buffer *buf,
	289	bool interruptible,
	290	bool validate_as_mob);
	291	void vmw_kms_helper_buffer_revert(struct vmw_dma_buffer *buf);
	292	void vmw_kms_helper_buffer_finish(struct vmw_private *dev_priv,
	293	struct drm_file *file_priv,
	294	struct vmw_dma_buffer *buf,
	295	struct vmw_fence_obj **out_fence,
	296	struct drm_vmw_fence_rep __user *
	297	user_fence_rep);
	298	int vmw_kms_helper_resource_prepare(struct vmw_resource *res,
	299	bool interruptible);
	300	void vmw_kms_helper_resource_revert(struct vmw_resource *res);
	301	void vmw_kms_helper_resource_finish(struct vmw_resource *res,
	302	struct vmw_fence_obj **out_fence);
10b1e0ca TH	303	int vmw_kms_readback(struct vmw_private *dev_priv,
	304	struct drm_file *file_priv,
	305	struct vmw_framebuffer *vfb,
	306	struct drm_vmw_fence_rep __user *user_fence_rep,
	307	struct drm_vmw_rect *vclips,
	308	uint32_t num_clips);
fd006a43 TH	309	struct vmw_framebuffer *
	310	vmw_kms_new_framebuffer(struct vmw_private *dev_priv,
	311	struct vmw_dma_buffer *dmabuf,
	312	struct vmw_surface *surface,
	313	bool only_2d,
dabdcdc9	314	const struct drm_mode_fb_cmd2 *mode_cmd);
a278724a TH	315	int vmw_kms_fbdev_init_data(struct vmw_private *dev_priv,
	316	unsigned unit,
	317	u32 max_width,
	318	u32 max_height,
	319	struct drm_connector **p_con,
	320	struct drm_crtc **p_crtc,
	321	struct drm_display_mode **p_mode);
	322	void vmw_guess_mode_timing(struct drm_display_mode *mode);
75c06855 TH	323	void vmw_kms_del_active(struct vmw_private *dev_priv,
	324	struct vmw_display_unit *du);
	325	void vmw_kms_add_active(struct vmw_private *dev_priv,
	326	struct vmw_display_unit *du,
	327	struct vmw_framebuffer *vfb);
	328	bool vmw_kms_crtc_flippable(struct vmw_private *dev_priv,
	329	struct drm_crtc *crtc);
	330	void vmw_kms_update_implicit_fb(struct vmw_private *dev_priv,
	331	struct drm_crtc *crtc);
76404ac0 TH	332	void vmw_kms_create_implicit_placement_property(struct vmw_private *dev_priv,
76404ac0 TH	333	bool immutable);
75c06855	334
36cc79bc SY	335	/* Universal Plane Helpers */
	336	void vmw_du_primary_plane_destroy(struct drm_plane *plane);
	337	void vmw_du_cursor_plane_destroy(struct drm_plane *plane);
36cc79bc	338
06ec4190	339	/* Atomic Helpers */
060e2ad5 SY	340	int vmw_du_primary_plane_atomic_check(struct drm_plane *plane,
	341	struct drm_plane_state *state);
	342	int vmw_du_cursor_plane_atomic_check(struct drm_plane *plane,
	343	struct drm_plane_state *state);
	344	void vmw_du_cursor_plane_atomic_update(struct drm_plane *plane,
	345	struct drm_plane_state *old_state);
060e2ad5 SY	346	int vmw_du_cursor_plane_prepare_fb(struct drm_plane *plane,
	347	struct drm_plane_state *new_state);
	348	void vmw_du_plane_cleanup_fb(struct drm_plane *plane,
	349	struct drm_plane_state *old_state);
cc5ec459 SY	350	void vmw_du_plane_reset(struct drm_plane *plane);
	351	struct drm_plane_state vmw_du_plane_duplicate_state(struct drm_plane plane);
	352	void vmw_du_plane_destroy_state(struct drm_plane *plane,
	353	struct drm_plane_state *state);
060e2ad5 SY	354	void vmw_du_plane_unpin_surf(struct vmw_plane_state *vps,
	355	bool unreference);
	356
06ec4190 SY	357	int vmw_du_crtc_atomic_check(struct drm_crtc *crtc,
	358	struct drm_crtc_state *state);
	359	void vmw_du_crtc_atomic_begin(struct drm_crtc *crtc,
	360	struct drm_crtc_state *old_crtc_state);
	361	void vmw_du_crtc_atomic_flush(struct drm_crtc *crtc,
	362	struct drm_crtc_state *old_crtc_state);
9c2542a4 SY	363	void vmw_du_crtc_reset(struct drm_crtc *crtc);
	364	struct drm_crtc_state vmw_du_crtc_duplicate_state(struct drm_crtc crtc);
	365	void vmw_du_crtc_destroy_state(struct drm_crtc *crtc,
	366	struct drm_crtc_state *state);
d7721ca7 SY	367	void vmw_du_connector_reset(struct drm_connector *connector);
	368	struct drm_connector_state *
	369	vmw_du_connector_duplicate_state(struct drm_connector *connector);
	370
	371	void vmw_du_connector_destroy_state(struct drm_connector *connector,
	372	struct drm_connector_state *state);
fb1d9738 JB	373
fb1d9738 JB	374	/*
d8bd19d2	375	* Legacy display unit functions - vmwgfx_ldu.c
fb1d9738	376	*/
c8261a96 SY	377	int vmw_kms_ldu_init_display(struct vmw_private *dev_priv);
	378	int vmw_kms_ldu_close_display(struct vmw_private *dev_priv);
	379	int vmw_kms_ldu_do_dmabuf_dirty(struct vmw_private *dev_priv,
	380	struct vmw_framebuffer *framebuffer,
	381	unsigned flags, unsigned color,
	382	struct drm_clip_rect *clips,
	383	unsigned num_clips, int increment);
6bf6bf03 TH	384	int vmw_kms_update_proxy(struct vmw_resource *res,
	385	const struct drm_clip_rect *clips,
	386	unsigned num_clips,
	387	int increment);
fb1d9738	388
56d1c78d JB	389	/*
	390	* Screen Objects display functions - vmwgfx_scrn.c
	391	*/
c8261a96	392	int vmw_kms_sou_init_display(struct vmw_private *dev_priv);
c8261a96	393	int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
c8261a96	394	struct vmw_framebuffer *framebuffer,
c8261a96	395	struct drm_clip_rect *clips,
10b1e0ca TH	396	struct drm_vmw_rect *vclips,
	397	struct vmw_resource *srf,
	398	s32 dest_x,
	399	s32 dest_y,
c8261a96 SY	400	unsigned num_clips, int inc,
c8261a96 SY	401	struct vmw_fence_obj **out_fence);
10b1e0ca	402	int vmw_kms_sou_do_dmabuf_dirty(struct vmw_private *dev_priv,
c8261a96	403	struct vmw_framebuffer *framebuffer,
c8261a96	404	struct drm_clip_rect *clips,
897b8180	405	struct drm_vmw_rect *vclips,
c8261a96	406	unsigned num_clips, int increment,
10b1e0ca	407	bool interruptible,
c8261a96	408	struct vmw_fence_obj **out_fence);
10b1e0ca TH	409	int vmw_kms_sou_readback(struct vmw_private *dev_priv,
	410	struct drm_file *file_priv,
	411	struct vmw_framebuffer *vfb,
	412	struct drm_vmw_fence_rep __user *user_fence_rep,
	413	struct drm_vmw_rect *vclips,
	414	uint32_t num_clips);
35c05125 SY	415
	416	/*
	417	* Screen Target Display Unit functions - vmwgfx_stdu.c
	418	*/
	419	int vmw_kms_stdu_init_display(struct vmw_private *dev_priv);
6bf6bf03 TH	420	int vmw_kms_stdu_surface_dirty(struct vmw_private *dev_priv,
	421	struct vmw_framebuffer *framebuffer,
	422	struct drm_clip_rect *clips,
	423	struct drm_vmw_rect *vclips,
	424	struct vmw_resource *srf,
	425	s32 dest_x,
	426	s32 dest_y,
	427	unsigned num_clips, int inc,
	428	struct vmw_fence_obj **out_fence);
	429	int vmw_kms_stdu_dma(struct vmw_private *dev_priv,
	430	struct drm_file *file_priv,
	431	struct vmw_framebuffer *vfb,
	432	struct drm_vmw_fence_rep __user *user_fence_rep,
	433	struct drm_clip_rect *clips,
	434	struct drm_vmw_rect *vclips,
	435	uint32_t num_clips,
	436	int increment,
	437	bool to_surface,
	438	bool interruptible);
b5ec427e	439
320d8c3d DA	440	int vmw_kms_set_config(struct drm_mode_set *set,
320d8c3d DA	441	struct drm_modeset_acquire_ctx *ctx);
56d1c78d	442
fb1d9738	443	#endif