xref: /linux/drivers/gpu/drm/vmwgfx/vmwgfx_kms.h (revision b9b77222d4ff6b5bb8f5d87fca20de0910618bb9)
1 /**************************************************************************
2  *
3  * Copyright © 2009-2015 VMware, Inc., Palo Alto, CA., USA
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 
31 #include <drm/drmP.h>
32 #include <drm/drm_crtc_helper.h>
33 #include <drm/drm_encoder.h>
34 #include "vmwgfx_drv.h"
35 
36 
37 
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  * @crtc: The crtc for which to build dirty commands.
54  * @num_hits: Number of clip rect commands for this display unit.
55  * Cleared by the helper before the first @clip call. Updated by the @clip
56  * callback.
57  * @fb_x: Clip rect left side in framebuffer coordinates.
58  * @fb_y: Clip rect right side in framebuffer coordinates.
59  * @unit_x1: Clip rect left side in crtc coordinates.
60  * @unit_y1: Clip rect top side in crtc coordinates.
61  * @unit_x2: Clip rect right side in crtc coordinates.
62  * @unit_y2: Clip rect bottom side in crtc coordinates.
63  *
64  * The clip rect coordinates are updated by the helper for each @clip call.
65  * Note that this may be derived from if more info needs to be passed between
66  * helper caller and helper callbacks.
67  */
68 struct vmw_kms_dirty {
69 	void (*fifo_commit)(struct vmw_kms_dirty *);
70 	void (*clip)(struct vmw_kms_dirty *);
71 	size_t fifo_reserve_size;
72 	struct vmw_private *dev_priv;
73 	struct vmw_display_unit *unit;
74 	void *cmd;
75 	struct drm_crtc *crtc;
76 	u32 num_hits;
77 	s32 fb_x;
78 	s32 fb_y;
79 	s32 unit_x1;
80 	s32 unit_y1;
81 	s32 unit_x2;
82 	s32 unit_y2;
83 };
84 
85 #define VMWGFX_NUM_DISPLAY_UNITS 8
86 
87 
88 #define vmw_framebuffer_to_vfb(x) \
89 	container_of(x, struct vmw_framebuffer, base)
90 #define vmw_framebuffer_to_vfbs(x) \
91 	container_of(x, struct vmw_framebuffer_surface, base.base)
92 #define vmw_framebuffer_to_vfbd(x) \
93 	container_of(x, struct vmw_framebuffer_dmabuf, base.base)
94 
95 /**
96  * Base class for framebuffers
97  *
98  * @pin is called the when ever a crtc uses this framebuffer
99  * @unpin is called
100  */
101 struct vmw_framebuffer {
102 	struct drm_framebuffer base;
103 	int (*pin)(struct vmw_framebuffer *fb);
104 	int (*unpin)(struct vmw_framebuffer *fb);
105 	bool dmabuf;
106 	struct ttm_base_object *user_obj;
107 	uint32_t user_handle;
108 };
109 
110 /*
111  * Clip rectangle
112  */
113 struct vmw_clip_rect {
114 	int x1, x2, y1, y2;
115 };
116 
117 struct vmw_framebuffer_surface {
118 	struct vmw_framebuffer base;
119 	struct vmw_surface *surface;
120 	struct vmw_dma_buffer *buffer;
121 	struct list_head head;
122 	bool is_dmabuf_proxy;  /* true if this is proxy surface for DMA buf */
123 };
124 
125 
126 struct vmw_framebuffer_dmabuf {
127 	struct vmw_framebuffer base;
128 	struct vmw_dma_buffer *buffer;
129 };
130 
131 
132 static const uint32_t vmw_primary_plane_formats[] = {
133 	DRM_FORMAT_XRGB1555,
134 	DRM_FORMAT_RGB565,
135 	DRM_FORMAT_RGB888,
136 	DRM_FORMAT_XRGB8888,
137 	DRM_FORMAT_ARGB8888,
138 };
139 
140 static const uint32_t vmw_cursor_plane_formats[] = {
141 	DRM_FORMAT_ARGB8888,
142 };
143 
144 
145 #define vmw_crtc_state_to_vcs(x) container_of(x, struct vmw_crtc_state, base)
146 #define vmw_plane_state_to_vps(x) container_of(x, struct vmw_plane_state, base)
147 #define vmw_connector_state_to_vcs(x) \
148 		container_of(x, struct vmw_connector_state, base)
149 
150 /**
151  * Derived class for crtc state object
152  *
153  * @base DRM crtc object
154  */
155 struct vmw_crtc_state {
156 	struct drm_crtc_state base;
157 };
158 
159 /**
160  * Derived class for plane state object
161  *
162  * @base DRM plane object
163  * @surf Display surface for STDU
164  * @dmabuf display dmabuf for SOU
165  * @content_fb_type Used by STDU.
166  * @dmabuf_size Size of the dmabuf, used by Screen Object Display Unit
167  * @pinned pin count for STDU display surface
168  */
169 struct vmw_plane_state {
170 	struct drm_plane_state base;
171 	struct vmw_surface *surf;
172 	struct vmw_dma_buffer *dmabuf;
173 
174 	int content_fb_type;
175 	unsigned long dmabuf_size;
176 
177 	int pinned;
178 
179 	/* For CPU Blit */
180 	unsigned int cpp;
181 };
182 
183 
184 /**
185  * Derived class for connector state object
186  *
187  * @base DRM connector object
188  * @is_implicit connector property
189  *
190  */
191 struct vmw_connector_state {
192 	struct drm_connector_state base;
193 
194 	bool is_implicit;
195 };
196 
197 /**
198  * Base class display unit.
199  *
200  * Since the SVGA hw doesn't have a concept of a crtc, encoder or connector
201  * so the display unit is all of them at the same time. This is true for both
202  * legacy multimon and screen objects.
203  */
204 struct vmw_display_unit {
205 	struct drm_crtc crtc;
206 	struct drm_encoder encoder;
207 	struct drm_connector connector;
208 	struct drm_plane primary;
209 	struct drm_plane cursor;
210 
211 	struct vmw_surface *cursor_surface;
212 	struct vmw_dma_buffer *cursor_dmabuf;
213 	size_t cursor_age;
214 
215 	int cursor_x;
216 	int cursor_y;
217 
218 	int hotspot_x;
219 	int hotspot_y;
220 	s32 core_hotspot_x;
221 	s32 core_hotspot_y;
222 
223 	unsigned unit;
224 
225 	/*
226 	 * Prefered mode tracking.
227 	 */
228 	unsigned pref_width;
229 	unsigned pref_height;
230 	bool pref_active;
231 	struct drm_display_mode *pref_mode;
232 
233 	/*
234 	 * Gui positioning
235 	 */
236 	int gui_x;
237 	int gui_y;
238 	bool is_implicit;
239 	bool active_implicit;
240 	int set_gui_x;
241 	int set_gui_y;
242 };
243 
244 struct vmw_validation_ctx {
245 	struct vmw_resource *res;
246 	struct vmw_dma_buffer *buf;
247 };
248 
249 #define vmw_crtc_to_du(x) \
250 	container_of(x, struct vmw_display_unit, crtc)
251 #define vmw_connector_to_du(x) \
252 	container_of(x, struct vmw_display_unit, connector)
253 
254 
255 /*
256  * Shared display unit functions - vmwgfx_kms.c
257  */
258 void vmw_du_cleanup(struct vmw_display_unit *du);
259 void vmw_du_crtc_save(struct drm_crtc *crtc);
260 void vmw_du_crtc_restore(struct drm_crtc *crtc);
261 int vmw_du_crtc_gamma_set(struct drm_crtc *crtc,
262 			   u16 *r, u16 *g, u16 *b,
263 			   uint32_t size,
264 			   struct drm_modeset_acquire_ctx *ctx);
265 int vmw_du_connector_set_property(struct drm_connector *connector,
266 				  struct drm_property *property,
267 				  uint64_t val);
268 int vmw_du_connector_atomic_set_property(struct drm_connector *connector,
269 					 struct drm_connector_state *state,
270 					 struct drm_property *property,
271 					 uint64_t val);
272 int
273 vmw_du_connector_atomic_get_property(struct drm_connector *connector,
274 				     const struct drm_connector_state *state,
275 				     struct drm_property *property,
276 				     uint64_t *val);
277 int vmw_du_connector_dpms(struct drm_connector *connector, int mode);
278 void vmw_du_connector_save(struct drm_connector *connector);
279 void vmw_du_connector_restore(struct drm_connector *connector);
280 enum drm_connector_status
281 vmw_du_connector_detect(struct drm_connector *connector, bool force);
282 int vmw_du_connector_fill_modes(struct drm_connector *connector,
283 				uint32_t max_width, uint32_t max_height);
284 int vmw_kms_helper_dirty(struct vmw_private *dev_priv,
285 			 struct vmw_framebuffer *framebuffer,
286 			 const struct drm_clip_rect *clips,
287 			 const struct drm_vmw_rect *vclips,
288 			 s32 dest_x, s32 dest_y,
289 			 int num_clips,
290 			 int increment,
291 			 struct vmw_kms_dirty *dirty);
292 
293 int vmw_kms_helper_buffer_prepare(struct vmw_private *dev_priv,
294 				  struct vmw_dma_buffer *buf,
295 				  bool interruptible,
296 				  bool validate_as_mob,
297 				  bool for_cpu_blit);
298 void vmw_kms_helper_buffer_revert(struct vmw_dma_buffer *buf);
299 void vmw_kms_helper_buffer_finish(struct vmw_private *dev_priv,
300 				  struct drm_file *file_priv,
301 				  struct vmw_dma_buffer *buf,
302 				  struct vmw_fence_obj **out_fence,
303 				  struct drm_vmw_fence_rep __user *
304 				  user_fence_rep);
305 int vmw_kms_helper_resource_prepare(struct vmw_resource *res,
306 				    bool interruptible,
307 				    struct vmw_validation_ctx *ctx);
308 void vmw_kms_helper_resource_revert(struct vmw_validation_ctx *ctx);
309 void vmw_kms_helper_resource_finish(struct vmw_validation_ctx *ctx,
310 				    struct vmw_fence_obj **out_fence);
311 int vmw_kms_readback(struct vmw_private *dev_priv,
312 		     struct drm_file *file_priv,
313 		     struct vmw_framebuffer *vfb,
314 		     struct drm_vmw_fence_rep __user *user_fence_rep,
315 		     struct drm_vmw_rect *vclips,
316 		     uint32_t num_clips);
317 struct vmw_framebuffer *
318 vmw_kms_new_framebuffer(struct vmw_private *dev_priv,
319 			struct vmw_dma_buffer *dmabuf,
320 			struct vmw_surface *surface,
321 			bool only_2d,
322 			const struct drm_mode_fb_cmd2 *mode_cmd);
323 int vmw_kms_fbdev_init_data(struct vmw_private *dev_priv,
324 			    unsigned unit,
325 			    u32 max_width,
326 			    u32 max_height,
327 			    struct drm_connector **p_con,
328 			    struct drm_crtc **p_crtc,
329 			    struct drm_display_mode **p_mode);
330 void vmw_guess_mode_timing(struct drm_display_mode *mode);
331 void vmw_kms_del_active(struct vmw_private *dev_priv,
332 			struct vmw_display_unit *du);
333 void vmw_kms_add_active(struct vmw_private *dev_priv,
334 			struct vmw_display_unit *du,
335 			struct vmw_framebuffer *vfb);
336 bool vmw_kms_crtc_flippable(struct vmw_private *dev_priv,
337 			    struct drm_crtc *crtc);
338 void vmw_kms_update_implicit_fb(struct vmw_private *dev_priv,
339 				struct drm_crtc *crtc);
340 void vmw_kms_create_implicit_placement_property(struct vmw_private *dev_priv,
341 						bool immutable);
342 
343 /* Universal Plane Helpers */
344 void vmw_du_primary_plane_destroy(struct drm_plane *plane);
345 void vmw_du_cursor_plane_destroy(struct drm_plane *plane);
346 
347 /* Atomic Helpers */
348 int vmw_du_primary_plane_atomic_check(struct drm_plane *plane,
349 				      struct drm_plane_state *state);
350 int vmw_du_cursor_plane_atomic_check(struct drm_plane *plane,
351 				     struct drm_plane_state *state);
352 void vmw_du_cursor_plane_atomic_update(struct drm_plane *plane,
353 				       struct drm_plane_state *old_state);
354 int vmw_du_cursor_plane_prepare_fb(struct drm_plane *plane,
355 				   struct drm_plane_state *new_state);
356 void vmw_du_plane_cleanup_fb(struct drm_plane *plane,
357 			     struct drm_plane_state *old_state);
358 void vmw_du_plane_reset(struct drm_plane *plane);
359 struct drm_plane_state *vmw_du_plane_duplicate_state(struct drm_plane *plane);
360 void vmw_du_plane_destroy_state(struct drm_plane *plane,
361 				struct drm_plane_state *state);
362 void vmw_du_plane_unpin_surf(struct vmw_plane_state *vps,
363 			     bool unreference);
364 
365 int vmw_du_crtc_atomic_check(struct drm_crtc *crtc,
366 			     struct drm_crtc_state *state);
367 void vmw_du_crtc_atomic_begin(struct drm_crtc *crtc,
368 			      struct drm_crtc_state *old_crtc_state);
369 void vmw_du_crtc_atomic_flush(struct drm_crtc *crtc,
370 			      struct drm_crtc_state *old_crtc_state);
371 void vmw_du_crtc_reset(struct drm_crtc *crtc);
372 struct drm_crtc_state *vmw_du_crtc_duplicate_state(struct drm_crtc *crtc);
373 void vmw_du_crtc_destroy_state(struct drm_crtc *crtc,
374 				struct drm_crtc_state *state);
375 void vmw_du_connector_reset(struct drm_connector *connector);
376 struct drm_connector_state *
377 vmw_du_connector_duplicate_state(struct drm_connector *connector);
378 
379 void vmw_du_connector_destroy_state(struct drm_connector *connector,
380 				    struct drm_connector_state *state);
381 
382 /*
383  * Legacy display unit functions - vmwgfx_ldu.c
384  */
385 int vmw_kms_ldu_init_display(struct vmw_private *dev_priv);
386 int vmw_kms_ldu_close_display(struct vmw_private *dev_priv);
387 int vmw_kms_ldu_do_dmabuf_dirty(struct vmw_private *dev_priv,
388 				struct vmw_framebuffer *framebuffer,
389 				unsigned flags, unsigned color,
390 				struct drm_clip_rect *clips,
391 				unsigned num_clips, int increment);
392 int vmw_kms_update_proxy(struct vmw_resource *res,
393 			 const struct drm_clip_rect *clips,
394 			 unsigned num_clips,
395 			 int increment);
396 
397 /*
398  * Screen Objects display functions - vmwgfx_scrn.c
399  */
400 int vmw_kms_sou_init_display(struct vmw_private *dev_priv);
401 int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
402 				 struct vmw_framebuffer *framebuffer,
403 				 struct drm_clip_rect *clips,
404 				 struct drm_vmw_rect *vclips,
405 				 struct vmw_resource *srf,
406 				 s32 dest_x,
407 				 s32 dest_y,
408 				 unsigned num_clips, int inc,
409 				 struct vmw_fence_obj **out_fence,
410 				 struct drm_crtc *crtc);
411 int vmw_kms_sou_do_dmabuf_dirty(struct vmw_private *dev_priv,
412 				struct vmw_framebuffer *framebuffer,
413 				struct drm_clip_rect *clips,
414 				struct drm_vmw_rect *vclips,
415 				unsigned num_clips, int increment,
416 				bool interruptible,
417 				struct vmw_fence_obj **out_fence,
418 				struct drm_crtc *crtc);
419 int vmw_kms_sou_readback(struct vmw_private *dev_priv,
420 			 struct drm_file *file_priv,
421 			 struct vmw_framebuffer *vfb,
422 			 struct drm_vmw_fence_rep __user *user_fence_rep,
423 			 struct drm_vmw_rect *vclips,
424 			 uint32_t num_clips,
425 			 struct drm_crtc *crtc);
426 
427 /*
428  * Screen Target Display Unit functions - vmwgfx_stdu.c
429  */
430 int vmw_kms_stdu_init_display(struct vmw_private *dev_priv);
431 int vmw_kms_stdu_surface_dirty(struct vmw_private *dev_priv,
432 			       struct vmw_framebuffer *framebuffer,
433 			       struct drm_clip_rect *clips,
434 			       struct drm_vmw_rect *vclips,
435 			       struct vmw_resource *srf,
436 			       s32 dest_x,
437 			       s32 dest_y,
438 			       unsigned num_clips, int inc,
439 			       struct vmw_fence_obj **out_fence,
440 			       struct drm_crtc *crtc);
441 int vmw_kms_stdu_dma(struct vmw_private *dev_priv,
442 		     struct drm_file *file_priv,
443 		     struct vmw_framebuffer *vfb,
444 		     struct drm_vmw_fence_rep __user *user_fence_rep,
445 		     struct drm_clip_rect *clips,
446 		     struct drm_vmw_rect *vclips,
447 		     uint32_t num_clips,
448 		     int increment,
449 		     bool to_surface,
450 		     bool interruptible,
451 		     struct drm_crtc *crtc);
452 
453 int vmw_kms_set_config(struct drm_mode_set *set,
454 		       struct drm_modeset_acquire_ctx *ctx);
455 #endif
456