1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**************************************************************************
3 *
4 * Copyright 2009-2015 VMware, Inc., Palo Alto, CA., USA
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/drm_encoder.h>
32 #include <drm/drm_probe_helper.h>
33
34 #include "vmwgfx_drv.h"
35
36 /**
37 * struct vmw_du_update_plane - Closure structure for vmw_du_helper_plane_update
38 * @plane: Plane which is being updated.
39 * @old_state: Old state of plane.
40 * @dev_priv: Device private.
41 * @du: Display unit on which to update the plane.
42 * @vfb: Framebuffer which is blitted to display unit.
43 * @out_fence: Out fence for resource finish.
44 * @mutex: The mutex used to protect resource reservation.
45 * @cpu_blit: True if need cpu blit.
46 * @intr: Whether to perform waits interruptible if possible.
47 *
48 * This structure loosely represent the set of operations needed to perform a
49 * plane update on a display unit. Implementer will define that functionality
50 * according to the function callbacks for this structure. In brief it involves
51 * surface/buffer object validation, populate FIFO commands and command
52 * submission to the device.
53 */
54 struct vmw_du_update_plane {
55 /**
56 * @calc_fifo_size: Calculate fifo size.
57 *
58 * Determine fifo size for the commands needed for update. The number of
59 * damage clips on display unit @num_hits will be passed to allocate
60 * sufficient fifo space.
61 *
62 * Return: Fifo size needed
63 */
64 uint32_t (*calc_fifo_size)(struct vmw_du_update_plane *update,
65 uint32_t num_hits);
66
67 /**
68 * @post_prepare: Populate fifo for resource preparation.
69 *
70 * Some surface resource or buffer object need some extra cmd submission
71 * like update GB image for proxy surface and define a GMRFB for screen
72 * object. That should should be done here as this callback will be
73 * called after FIFO allocation with the address of command buufer.
74 *
75 * This callback is optional.
76 *
77 * Return: Size of commands populated to command buffer.
78 */
79 uint32_t (*post_prepare)(struct vmw_du_update_plane *update, void *cmd);
80
81 /**
82 * @pre_clip: Populate fifo before clip.
83 *
84 * This is where pre clip related command should be populated like
85 * surface copy/DMA, etc.
86 *
87 * This callback is optional.
88 *
89 * Return: Size of commands populated to command buffer.
90 */
91 uint32_t (*pre_clip)(struct vmw_du_update_plane *update, void *cmd,
92 uint32_t num_hits);
93
94 /**
95 * @clip: Populate fifo for clip.
96 *
97 * This is where to populate clips for surface copy/dma or blit commands
98 * if needed. This will be called times have damage in display unit,
99 * which is one if doing full update. @clip is the damage in destination
100 * coordinates which is crtc/DU and @src_x, @src_y is damage clip src in
101 * framebuffer coordinate.
102 *
103 * This callback is optional.
104 *
105 * Return: Size of commands populated to command buffer.
106 */
107 uint32_t (*clip)(struct vmw_du_update_plane *update, void *cmd,
108 struct drm_rect *clip, uint32_t src_x, uint32_t src_y);
109
110 /**
111 * @post_clip: Populate fifo after clip.
112 *
113 * This is where to populate display unit update commands or blit
114 * commands.
115 *
116 * Return: Size of commands populated to command buffer.
117 */
118 uint32_t (*post_clip)(struct vmw_du_update_plane *update, void *cmd,
119 struct drm_rect *bb);
120
121 struct drm_plane *plane;
122 struct drm_plane_state *old_state;
123 struct vmw_private *dev_priv;
124 struct vmw_display_unit *du;
125 struct vmw_framebuffer *vfb;
126 struct vmw_fence_obj **out_fence;
127 struct mutex *mutex;
128 bool cpu_blit;
129 bool intr;
130 };
131
132 /**
133 * struct vmw_du_update_plane_surface - closure structure for surface
134 * @base: base closure structure.
135 * @cmd_start: FIFO command start address (used by SOU only).
136 */
137 struct vmw_du_update_plane_surface {
138 struct vmw_du_update_plane base;
139 /* This member is to handle special case SOU surface update */
140 void *cmd_start;
141 };
142
143 /**
144 * struct vmw_du_update_plane_buffer - Closure structure for buffer object
145 * @base: Base closure structure.
146 * @fb_left: x1 for fb damage bounding box.
147 * @fb_top: y1 for fb damage bounding box.
148 */
149 struct vmw_du_update_plane_buffer {
150 struct vmw_du_update_plane base;
151 int fb_left, fb_top;
152 };
153
154 /**
155 * struct vmw_kms_dirty - closure structure for the vmw_kms_helper_dirty
156 * function.
157 *
158 * @fifo_commit: Callback that is called once for each display unit after
159 * all clip rects. This function must commit the fifo space reserved by the
160 * helper. Set up by the caller.
161 * @clip: Callback that is called for each cliprect on each display unit.
162 * Set up by the caller.
163 * @fifo_reserve_size: Fifo size that the helper should try to allocat for
164 * each display unit. Set up by the caller.
165 * @dev_priv: Pointer to the device private. Set up by the helper.
166 * @unit: The current display unit. Set up by the helper before a call to @clip.
167 * @cmd: The allocated fifo space. Set up by the helper before the first @clip
168 * call.
169 * @crtc: The crtc for which to build dirty commands.
170 * @num_hits: Number of clip rect commands for this display unit.
171 * Cleared by the helper before the first @clip call. Updated by the @clip
172 * callback.
173 * @fb_x: Clip rect left side in framebuffer coordinates.
174 * @fb_y: Clip rect right side in framebuffer coordinates.
175 * @unit_x1: Clip rect left side in crtc coordinates.
176 * @unit_y1: Clip rect top side in crtc coordinates.
177 * @unit_x2: Clip rect right side in crtc coordinates.
178 * @unit_y2: Clip rect bottom side in crtc coordinates.
179 *
180 * The clip rect coordinates are updated by the helper for each @clip call.
181 * Note that this may be derived from if more info needs to be passed between
182 * helper caller and helper callbacks.
183 */
184 struct vmw_kms_dirty {
185 void (*fifo_commit)(struct vmw_kms_dirty *);
186 void (*clip)(struct vmw_kms_dirty *);
187 size_t fifo_reserve_size;
188 struct vmw_private *dev_priv;
189 struct vmw_display_unit *unit;
190 void *cmd;
191 struct drm_crtc *crtc;
192 u32 num_hits;
193 s32 fb_x;
194 s32 fb_y;
195 s32 unit_x1;
196 s32 unit_y1;
197 s32 unit_x2;
198 s32 unit_y2;
199 };
200
201 #define VMWGFX_NUM_DISPLAY_UNITS 8
202
203
204 #define vmw_framebuffer_to_vfb(x) \
205 container_of(x, struct vmw_framebuffer, base)
206 #define vmw_framebuffer_to_vfbs(x) \
207 container_of(x, struct vmw_framebuffer_surface, base.base)
208 #define vmw_framebuffer_to_vfbd(x) \
209 container_of(x, struct vmw_framebuffer_bo, base.base)
210
211 /**
212 * Base class for framebuffers
213 *
214 * @pin is called the when ever a crtc uses this framebuffer
215 * @unpin is called
216 */
217 struct vmw_framebuffer {
218 struct drm_framebuffer base;
219 int (*pin)(struct vmw_framebuffer *fb);
220 int (*unpin)(struct vmw_framebuffer *fb);
221 bool bo;
222 struct ttm_base_object *user_obj;
223 uint32_t user_handle;
224 };
225
226 /*
227 * Clip rectangle
228 */
229 struct vmw_clip_rect {
230 int x1, x2, y1, y2;
231 };
232
233 struct vmw_framebuffer_surface {
234 struct vmw_framebuffer base;
235 struct vmw_surface *surface;
236 struct vmw_buffer_object *buffer;
237 struct list_head head;
238 bool is_bo_proxy; /* true if this is proxy surface for DMA buf */
239 };
240
241
242 struct vmw_framebuffer_bo {
243 struct vmw_framebuffer base;
244 struct vmw_buffer_object *buffer;
245 };
246
247
248 static const uint32_t __maybe_unused vmw_primary_plane_formats[] = {
249 DRM_FORMAT_XRGB1555,
250 DRM_FORMAT_RGB565,
251 DRM_FORMAT_XRGB8888,
252 DRM_FORMAT_ARGB8888,
253 };
254
255 static const uint32_t __maybe_unused vmw_cursor_plane_formats[] = {
256 DRM_FORMAT_ARGB8888,
257 };
258
259
260 #define vmw_crtc_state_to_vcs(x) container_of(x, struct vmw_crtc_state, base)
261 #define vmw_plane_state_to_vps(x) container_of(x, struct vmw_plane_state, base)
262 #define vmw_connector_state_to_vcs(x) \
263 container_of(x, struct vmw_connector_state, base)
264
265 /**
266 * Derived class for crtc state object
267 *
268 * @base DRM crtc object
269 */
270 struct vmw_crtc_state {
271 struct drm_crtc_state base;
272 };
273
274 /**
275 * Derived class for plane state object
276 *
277 * @base DRM plane object
278 * @surf Display surface for STDU
279 * @bo display bo for SOU
280 * @content_fb_type Used by STDU.
281 * @bo_size Size of the bo, used by Screen Object Display Unit
282 * @pinned pin count for STDU display surface
283 */
284 struct vmw_plane_state {
285 struct drm_plane_state base;
286 struct vmw_surface *surf;
287 struct vmw_buffer_object *bo;
288
289 int content_fb_type;
290 unsigned long bo_size;
291
292 int pinned;
293
294 /* For CPU Blit */
295 unsigned int cpp;
296 };
297
298
299 /**
300 * Derived class for connector state object
301 *
302 * @base DRM connector object
303 * @is_implicit connector property
304 *
305 */
306 struct vmw_connector_state {
307 struct drm_connector_state base;
308
309 /**
310 * @gui_x:
311 *
312 * vmwgfx connector property representing the x position of this display
313 * unit (connector is synonymous to display unit) in overall topology.
314 * This is what the device expect as xRoot while creating screen.
315 */
316 int gui_x;
317
318 /**
319 * @gui_y:
320 *
321 * vmwgfx connector property representing the y position of this display
322 * unit (connector is synonymous to display unit) in overall topology.
323 * This is what the device expect as yRoot while creating screen.
324 */
325 int gui_y;
326 };
327
328 /**
329 * Base class display unit.
330 *
331 * Since the SVGA hw doesn't have a concept of a crtc, encoder or connector
332 * so the display unit is all of them at the same time. This is true for both
333 * legacy multimon and screen objects.
334 */
335 struct vmw_display_unit {
336 struct drm_crtc crtc;
337 struct drm_encoder encoder;
338 struct drm_connector connector;
339 struct drm_plane primary;
340 struct drm_plane cursor;
341
342 struct vmw_surface *cursor_surface;
343 struct vmw_buffer_object *cursor_bo;
344 size_t cursor_age;
345
346 int cursor_x;
347 int cursor_y;
348
349 int hotspot_x;
350 int hotspot_y;
351 s32 core_hotspot_x;
352 s32 core_hotspot_y;
353
354 unsigned unit;
355
356 /*
357 * Prefered mode tracking.
358 */
359 unsigned pref_width;
360 unsigned pref_height;
361 bool pref_active;
362 struct drm_display_mode *pref_mode;
363
364 /*
365 * Gui positioning
366 */
367 int gui_x;
368 int gui_y;
369 bool is_implicit;
370 int set_gui_x;
371 int set_gui_y;
372 };
373
374 struct vmw_validation_ctx {
375 struct vmw_resource *res;
376 struct vmw_buffer_object *buf;
377 };
378
379 #define vmw_crtc_to_du(x) \
380 container_of(x, struct vmw_display_unit, crtc)
381 #define vmw_connector_to_du(x) \
382 container_of(x, struct vmw_display_unit, connector)
383
384
385 /*
386 * Shared display unit functions - vmwgfx_kms.c
387 */
388 void vmw_du_cleanup(struct vmw_display_unit *du);
389 void vmw_du_crtc_save(struct drm_crtc *crtc);
390 void vmw_du_crtc_restore(struct drm_crtc *crtc);
391 int vmw_du_crtc_gamma_set(struct drm_crtc *crtc,
392 u16 *r, u16 *g, u16 *b,
393 uint32_t size,
394 struct drm_modeset_acquire_ctx *ctx);
395 int vmw_du_connector_set_property(struct drm_connector *connector,
396 struct drm_property *property,
397 uint64_t val);
398 int vmw_du_connector_atomic_set_property(struct drm_connector *connector,
399 struct drm_connector_state *state,
400 struct drm_property *property,
401 uint64_t val);
402 int
403 vmw_du_connector_atomic_get_property(struct drm_connector *connector,
404 const struct drm_connector_state *state,
405 struct drm_property *property,
406 uint64_t *val);
407 int vmw_du_connector_dpms(struct drm_connector *connector, int mode);
408 void vmw_du_connector_save(struct drm_connector *connector);
409 void vmw_du_connector_restore(struct drm_connector *connector);
410 enum drm_connector_status
411 vmw_du_connector_detect(struct drm_connector *connector, bool force);
412 int vmw_du_connector_fill_modes(struct drm_connector *connector,
413 uint32_t max_width, uint32_t max_height);
414 int vmw_kms_helper_dirty(struct vmw_private *dev_priv,
415 struct vmw_framebuffer *framebuffer,
416 const struct drm_clip_rect *clips,
417 const struct drm_vmw_rect *vclips,
418 s32 dest_x, s32 dest_y,
419 int num_clips,
420 int increment,
421 struct vmw_kms_dirty *dirty);
422
423 void vmw_kms_helper_validation_finish(struct vmw_private *dev_priv,
424 struct drm_file *file_priv,
425 struct vmw_validation_context *ctx,
426 struct vmw_fence_obj **out_fence,
427 struct drm_vmw_fence_rep __user *
428 user_fence_rep);
429 int vmw_kms_readback(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_vmw_rect *vclips,
434 uint32_t num_clips);
435 struct vmw_framebuffer *
436 vmw_kms_new_framebuffer(struct vmw_private *dev_priv,
437 struct vmw_buffer_object *bo,
438 struct vmw_surface *surface,
439 bool only_2d,
440 const struct drm_mode_fb_cmd2 *mode_cmd);
441 int vmw_kms_fbdev_init_data(struct vmw_private *dev_priv,
442 unsigned unit,
443 u32 max_width,
444 u32 max_height,
445 struct drm_connector **p_con,
446 struct drm_crtc **p_crtc,
447 struct drm_display_mode **p_mode);
448 void vmw_guess_mode_timing(struct drm_display_mode *mode);
449 void vmw_kms_update_implicit_fb(struct vmw_private *dev_priv);
450 void vmw_kms_create_implicit_placement_property(struct vmw_private *dev_priv);
451
452 /* Universal Plane Helpers */
453 void vmw_du_primary_plane_destroy(struct drm_plane *plane);
454 void vmw_du_cursor_plane_destroy(struct drm_plane *plane);
455
456 /* Atomic Helpers */
457 int vmw_du_primary_plane_atomic_check(struct drm_plane *plane,
458 struct drm_atomic_state *state);
459 int vmw_du_cursor_plane_atomic_check(struct drm_plane *plane,
460 struct drm_atomic_state *state);
461 void vmw_du_cursor_plane_atomic_update(struct drm_plane *plane,
462 struct drm_atomic_state *state);
463 int vmw_du_cursor_plane_prepare_fb(struct drm_plane *plane,
464 struct drm_plane_state *new_state);
465 void vmw_du_plane_cleanup_fb(struct drm_plane *plane,
466 struct drm_plane_state *old_state);
467 void vmw_du_plane_reset(struct drm_plane *plane);
468 struct drm_plane_state *vmw_du_plane_duplicate_state(struct drm_plane *plane);
469 void vmw_du_plane_destroy_state(struct drm_plane *plane,
470 struct drm_plane_state *state);
471 void vmw_du_plane_unpin_surf(struct vmw_plane_state *vps,
472 bool unreference);
473
474 int vmw_du_crtc_atomic_check(struct drm_crtc *crtc,
475 struct drm_atomic_state *state);
476 void vmw_du_crtc_atomic_begin(struct drm_crtc *crtc,
477 struct drm_atomic_state *state);
478 void vmw_du_crtc_atomic_flush(struct drm_crtc *crtc,
479 struct drm_atomic_state *state);
480 void vmw_du_crtc_reset(struct drm_crtc *crtc);
481 struct drm_crtc_state *vmw_du_crtc_duplicate_state(struct drm_crtc *crtc);
482 void vmw_du_crtc_destroy_state(struct drm_crtc *crtc,
483 struct drm_crtc_state *state);
484 void vmw_du_connector_reset(struct drm_connector *connector);
485 struct drm_connector_state *
486 vmw_du_connector_duplicate_state(struct drm_connector *connector);
487
488 void vmw_du_connector_destroy_state(struct drm_connector *connector,
489 struct drm_connector_state *state);
490
491 /*
492 * Legacy display unit functions - vmwgfx_ldu.c
493 */
494 int vmw_kms_ldu_init_display(struct vmw_private *dev_priv);
495 int vmw_kms_ldu_close_display(struct vmw_private *dev_priv);
496 int vmw_kms_ldu_do_bo_dirty(struct vmw_private *dev_priv,
497 struct vmw_framebuffer *framebuffer,
498 unsigned int flags, unsigned int color,
499 struct drm_clip_rect *clips,
500 unsigned int num_clips, int increment);
501 int vmw_kms_update_proxy(struct vmw_resource *res,
502 const struct drm_clip_rect *clips,
503 unsigned num_clips,
504 int increment);
505
506 /*
507 * Screen Objects display functions - vmwgfx_scrn.c
508 */
509 int vmw_kms_sou_init_display(struct vmw_private *dev_priv);
510 int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
511 struct vmw_framebuffer *framebuffer,
512 struct drm_clip_rect *clips,
513 struct drm_vmw_rect *vclips,
514 struct vmw_resource *srf,
515 s32 dest_x,
516 s32 dest_y,
517 unsigned num_clips, int inc,
518 struct vmw_fence_obj **out_fence,
519 struct drm_crtc *crtc);
520 int vmw_kms_sou_do_bo_dirty(struct vmw_private *dev_priv,
521 struct vmw_framebuffer *framebuffer,
522 struct drm_clip_rect *clips,
523 struct drm_vmw_rect *vclips,
524 unsigned int num_clips, int increment,
525 bool interruptible,
526 struct vmw_fence_obj **out_fence,
527 struct drm_crtc *crtc);
528 int vmw_kms_sou_readback(struct vmw_private *dev_priv,
529 struct drm_file *file_priv,
530 struct vmw_framebuffer *vfb,
531 struct drm_vmw_fence_rep __user *user_fence_rep,
532 struct drm_vmw_rect *vclips,
533 uint32_t num_clips,
534 struct drm_crtc *crtc);
535
536 /*
537 * Screen Target Display Unit functions - vmwgfx_stdu.c
538 */
539 int vmw_kms_stdu_init_display(struct vmw_private *dev_priv);
540 int vmw_kms_stdu_surface_dirty(struct vmw_private *dev_priv,
541 struct vmw_framebuffer *framebuffer,
542 struct drm_clip_rect *clips,
543 struct drm_vmw_rect *vclips,
544 struct vmw_resource *srf,
545 s32 dest_x,
546 s32 dest_y,
547 unsigned num_clips, int inc,
548 struct vmw_fence_obj **out_fence,
549 struct drm_crtc *crtc);
550 int vmw_kms_stdu_dma(struct vmw_private *dev_priv,
551 struct drm_file *file_priv,
552 struct vmw_framebuffer *vfb,
553 struct drm_vmw_fence_rep __user *user_fence_rep,
554 struct drm_clip_rect *clips,
555 struct drm_vmw_rect *vclips,
556 uint32_t num_clips,
557 int increment,
558 bool to_surface,
559 bool interruptible,
560 struct drm_crtc *crtc);
561
562 int vmw_du_helper_plane_update(struct vmw_du_update_plane *update);
563
564 /**
565 * vmw_du_translate_to_crtc - Translate a rect from framebuffer to crtc
566 * @state: Plane state.
567 * @r: Rectangle to translate.
568 */
vmw_du_translate_to_crtc(struct drm_plane_state * state,struct drm_rect * r)569 static inline void vmw_du_translate_to_crtc(struct drm_plane_state *state,
570 struct drm_rect *r)
571 {
572 int translate_crtc_x = -((state->src_x >> 16) - state->crtc_x);
573 int translate_crtc_y = -((state->src_y >> 16) - state->crtc_y);
574
575 drm_rect_translate(r, translate_crtc_x, translate_crtc_y);
576 }
577
578 #endif
579