Backmerge tag 'v4.16-rc7' into drm-next
[linux-2.6-microblaze.git] / drivers / gpu / drm / vmwgfx / vmwgfx_scrn.c
1 /**************************************************************************
2  *
3  * Copyright © 2011-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 #include "vmwgfx_kms.h"
29 #include <drm/drm_plane_helper.h>
30 #include <drm/drm_atomic.h>
31 #include <drm/drm_atomic_helper.h>
32
33
34 #define vmw_crtc_to_sou(x) \
35         container_of(x, struct vmw_screen_object_unit, base.crtc)
36 #define vmw_encoder_to_sou(x) \
37         container_of(x, struct vmw_screen_object_unit, base.encoder)
38 #define vmw_connector_to_sou(x) \
39         container_of(x, struct vmw_screen_object_unit, base.connector)
40
41 /**
42  * struct vmw_kms_sou_surface_dirty - Closure structure for
43  * blit surface to screen command.
44  * @base: The base type we derive from. Used by vmw_kms_helper_dirty().
45  * @left: Left side of bounding box.
46  * @right: Right side of bounding box.
47  * @top: Top side of bounding box.
48  * @bottom: Bottom side of bounding box.
49  * @dst_x: Difference between source clip rects and framebuffer coordinates.
50  * @dst_y: Difference between source clip rects and framebuffer coordinates.
51  * @sid: Surface id of surface to copy from.
52  */
53 struct vmw_kms_sou_surface_dirty {
54         struct vmw_kms_dirty base;
55         s32 left, right, top, bottom;
56         s32 dst_x, dst_y;
57         u32 sid;
58 };
59
60 /*
61  * SVGA commands that are used by this code. Please see the device headers
62  * for explanation.
63  */
64 struct vmw_kms_sou_readback_blit {
65         uint32 header;
66         SVGAFifoCmdBlitScreenToGMRFB body;
67 };
68
69 struct vmw_kms_sou_dmabuf_blit {
70         uint32 header;
71         SVGAFifoCmdBlitGMRFBToScreen body;
72 };
73
74 struct vmw_kms_sou_dirty_cmd {
75         SVGA3dCmdHeader header;
76         SVGA3dCmdBlitSurfaceToScreen body;
77 };
78
79 /**
80  * Display unit using screen objects.
81  */
82 struct vmw_screen_object_unit {
83         struct vmw_display_unit base;
84
85         unsigned long buffer_size; /**< Size of allocated buffer */
86         struct vmw_dma_buffer *buffer; /**< Backing store buffer */
87
88         bool defined;
89 };
90
91 static void vmw_sou_destroy(struct vmw_screen_object_unit *sou)
92 {
93         vmw_du_cleanup(&sou->base);
94         kfree(sou);
95 }
96
97
98 /*
99  * Screen Object Display Unit CRTC functions
100  */
101
102 static void vmw_sou_crtc_destroy(struct drm_crtc *crtc)
103 {
104         vmw_sou_destroy(vmw_crtc_to_sou(crtc));
105 }
106
107 /**
108  * Send the fifo command to create a screen.
109  */
110 static int vmw_sou_fifo_create(struct vmw_private *dev_priv,
111                                struct vmw_screen_object_unit *sou,
112                                uint32_t x, uint32_t y,
113                                struct drm_display_mode *mode)
114 {
115         size_t fifo_size;
116
117         struct {
118                 struct {
119                         uint32_t cmdType;
120                 } header;
121                 SVGAScreenObject obj;
122         } *cmd;
123
124         BUG_ON(!sou->buffer);
125
126         fifo_size = sizeof(*cmd);
127         cmd = vmw_fifo_reserve(dev_priv, fifo_size);
128         /* The hardware has hung, nothing we can do about it here. */
129         if (unlikely(cmd == NULL)) {
130                 DRM_ERROR("Fifo reserve failed.\n");
131                 return -ENOMEM;
132         }
133
134         memset(cmd, 0, fifo_size);
135         cmd->header.cmdType = SVGA_CMD_DEFINE_SCREEN;
136         cmd->obj.structSize = sizeof(SVGAScreenObject);
137         cmd->obj.id = sou->base.unit;
138         cmd->obj.flags = SVGA_SCREEN_HAS_ROOT |
139                 (sou->base.unit == 0 ? SVGA_SCREEN_IS_PRIMARY : 0);
140         cmd->obj.size.width = mode->hdisplay;
141         cmd->obj.size.height = mode->vdisplay;
142         if (sou->base.is_implicit) {
143                 cmd->obj.root.x = x;
144                 cmd->obj.root.y = y;
145         } else {
146                 cmd->obj.root.x = sou->base.gui_x;
147                 cmd->obj.root.y = sou->base.gui_y;
148         }
149         sou->base.set_gui_x = cmd->obj.root.x;
150         sou->base.set_gui_y = cmd->obj.root.y;
151
152         /* Ok to assume that buffer is pinned in vram */
153         vmw_bo_get_guest_ptr(&sou->buffer->base, &cmd->obj.backingStore.ptr);
154         cmd->obj.backingStore.pitch = mode->hdisplay * 4;
155
156         vmw_fifo_commit(dev_priv, fifo_size);
157
158         sou->defined = true;
159
160         return 0;
161 }
162
163 /**
164  * Send the fifo command to destroy a screen.
165  */
166 static int vmw_sou_fifo_destroy(struct vmw_private *dev_priv,
167                                 struct vmw_screen_object_unit *sou)
168 {
169         size_t fifo_size;
170         int ret;
171
172         struct {
173                 struct {
174                         uint32_t cmdType;
175                 } header;
176                 SVGAFifoCmdDestroyScreen body;
177         } *cmd;
178
179         /* no need to do anything */
180         if (unlikely(!sou->defined))
181                 return 0;
182
183         fifo_size = sizeof(*cmd);
184         cmd = vmw_fifo_reserve(dev_priv, fifo_size);
185         /* the hardware has hung, nothing we can do about it here */
186         if (unlikely(cmd == NULL)) {
187                 DRM_ERROR("Fifo reserve failed.\n");
188                 return -ENOMEM;
189         }
190
191         memset(cmd, 0, fifo_size);
192         cmd->header.cmdType = SVGA_CMD_DESTROY_SCREEN;
193         cmd->body.screenId = sou->base.unit;
194
195         vmw_fifo_commit(dev_priv, fifo_size);
196
197         /* Force sync */
198         ret = vmw_fallback_wait(dev_priv, false, true, 0, false, 3*HZ);
199         if (unlikely(ret != 0))
200                 DRM_ERROR("Failed to sync with HW");
201         else
202                 sou->defined = false;
203
204         return ret;
205 }
206
207 /**
208  * vmw_sou_crtc_mode_set_nofb - Create new screen
209  *
210  * @crtc: CRTC associated with the new screen
211  *
212  * This function creates/destroys a screen.  This function cannot fail, so if
213  * somehow we run into a failure, just do the best we can to get out.
214  */
215 static void vmw_sou_crtc_mode_set_nofb(struct drm_crtc *crtc)
216 {
217         struct vmw_private *dev_priv;
218         struct vmw_screen_object_unit *sou;
219         struct vmw_framebuffer *vfb;
220         struct drm_framebuffer *fb;
221         struct drm_plane_state *ps;
222         struct vmw_plane_state *vps;
223         int ret;
224
225
226         sou      = vmw_crtc_to_sou(crtc);
227         dev_priv = vmw_priv(crtc->dev);
228         ps       = crtc->primary->state;
229         fb       = ps->fb;
230         vps      = vmw_plane_state_to_vps(ps);
231
232         vfb = (fb) ? vmw_framebuffer_to_vfb(fb) : NULL;
233
234         if (sou->defined) {
235                 ret = vmw_sou_fifo_destroy(dev_priv, sou);
236                 if (ret) {
237                         DRM_ERROR("Failed to destroy Screen Object\n");
238                         return;
239                 }
240         }
241
242         if (vfb) {
243                 sou->buffer = vps->dmabuf;
244                 sou->buffer_size = vps->dmabuf_size;
245
246                 ret = vmw_sou_fifo_create(dev_priv, sou, crtc->x, crtc->y,
247                                           &crtc->mode);
248                 if (ret)
249                         DRM_ERROR("Failed to define Screen Object %dx%d\n",
250                                   crtc->x, crtc->y);
251
252                 vmw_kms_add_active(dev_priv, &sou->base, vfb);
253         } else {
254                 sou->buffer = NULL;
255                 sou->buffer_size = 0;
256
257                 vmw_kms_del_active(dev_priv, &sou->base);
258         }
259 }
260
261 /**
262  * vmw_sou_crtc_helper_prepare - Noop
263  *
264  * @crtc: CRTC associated with the new screen
265  *
266  * Prepares the CRTC for a mode set, but we don't need to do anything here.
267  */
268 static void vmw_sou_crtc_helper_prepare(struct drm_crtc *crtc)
269 {
270 }
271
272 /**
273  * vmw_sou_crtc_atomic_enable - Noop
274  *
275  * @crtc: CRTC associated with the new screen
276  *
277  * This is called after a mode set has been completed.
278  */
279 static void vmw_sou_crtc_atomic_enable(struct drm_crtc *crtc,
280                                        struct drm_crtc_state *old_state)
281 {
282 }
283
284 /**
285  * vmw_sou_crtc_atomic_disable - Turns off CRTC
286  *
287  * @crtc: CRTC to be turned off
288  */
289 static void vmw_sou_crtc_atomic_disable(struct drm_crtc *crtc,
290                                         struct drm_crtc_state *old_state)
291 {
292         struct vmw_private *dev_priv;
293         struct vmw_screen_object_unit *sou;
294         int ret;
295
296
297         if (!crtc) {
298                 DRM_ERROR("CRTC is NULL\n");
299                 return;
300         }
301
302         sou = vmw_crtc_to_sou(crtc);
303         dev_priv = vmw_priv(crtc->dev);
304
305         if (sou->defined) {
306                 ret = vmw_sou_fifo_destroy(dev_priv, sou);
307                 if (ret)
308                         DRM_ERROR("Failed to destroy Screen Object\n");
309         }
310 }
311
312 static int vmw_sou_crtc_page_flip(struct drm_crtc *crtc,
313                                   struct drm_framebuffer *new_fb,
314                                   struct drm_pending_vblank_event *event,
315                                   uint32_t flags,
316                                   struct drm_modeset_acquire_ctx *ctx)
317 {
318         struct vmw_private *dev_priv = vmw_priv(crtc->dev);
319         int ret;
320
321         if (!vmw_kms_crtc_flippable(dev_priv, crtc))
322                 return -EINVAL;
323
324         ret = drm_atomic_helper_page_flip(crtc, new_fb, event, flags, ctx);
325         if (ret) {
326                 DRM_ERROR("Page flip error %d.\n", ret);
327                 return ret;
328         }
329
330         if (vmw_crtc_to_du(crtc)->is_implicit)
331                 vmw_kms_update_implicit_fb(dev_priv, crtc);
332
333         return ret;
334 }
335
336 static const struct drm_crtc_funcs vmw_screen_object_crtc_funcs = {
337         .gamma_set = vmw_du_crtc_gamma_set,
338         .destroy = vmw_sou_crtc_destroy,
339         .reset = vmw_du_crtc_reset,
340         .atomic_duplicate_state = vmw_du_crtc_duplicate_state,
341         .atomic_destroy_state = vmw_du_crtc_destroy_state,
342         .set_config = vmw_kms_set_config,
343         .page_flip = vmw_sou_crtc_page_flip,
344 };
345
346 /*
347  * Screen Object Display Unit encoder functions
348  */
349
350 static void vmw_sou_encoder_destroy(struct drm_encoder *encoder)
351 {
352         vmw_sou_destroy(vmw_encoder_to_sou(encoder));
353 }
354
355 static const struct drm_encoder_funcs vmw_screen_object_encoder_funcs = {
356         .destroy = vmw_sou_encoder_destroy,
357 };
358
359 /*
360  * Screen Object Display Unit connector functions
361  */
362
363 static void vmw_sou_connector_destroy(struct drm_connector *connector)
364 {
365         vmw_sou_destroy(vmw_connector_to_sou(connector));
366 }
367
368 static const struct drm_connector_funcs vmw_sou_connector_funcs = {
369         .dpms = vmw_du_connector_dpms,
370         .detect = vmw_du_connector_detect,
371         .fill_modes = vmw_du_connector_fill_modes,
372         .set_property = vmw_du_connector_set_property,
373         .destroy = vmw_sou_connector_destroy,
374         .reset = vmw_du_connector_reset,
375         .atomic_duplicate_state = vmw_du_connector_duplicate_state,
376         .atomic_destroy_state = vmw_du_connector_destroy_state,
377         .atomic_set_property = vmw_du_connector_atomic_set_property,
378         .atomic_get_property = vmw_du_connector_atomic_get_property,
379 };
380
381
382 static const struct
383 drm_connector_helper_funcs vmw_sou_connector_helper_funcs = {
384         .best_encoder = drm_atomic_helper_best_encoder,
385 };
386
387
388
389 /*
390  * Screen Object Display Plane Functions
391  */
392
393 /**
394  * vmw_sou_primary_plane_cleanup_fb - Frees sou backing buffer
395  *
396  * @plane:  display plane
397  * @old_state: Contains the FB to clean up
398  *
399  * Unpins the display surface
400  *
401  * Returns 0 on success
402  */
403 static void
404 vmw_sou_primary_plane_cleanup_fb(struct drm_plane *plane,
405                                  struct drm_plane_state *old_state)
406 {
407         struct vmw_plane_state *vps = vmw_plane_state_to_vps(old_state);
408         struct drm_crtc *crtc = plane->state->crtc ?
409                 plane->state->crtc : old_state->crtc;
410
411         if (vps->dmabuf)
412                 vmw_dmabuf_unpin(vmw_priv(crtc->dev), vps->dmabuf, false);
413         vmw_dmabuf_unreference(&vps->dmabuf);
414         vps->dmabuf_size = 0;
415
416         vmw_du_plane_cleanup_fb(plane, old_state);
417 }
418
419
420 /**
421  * vmw_sou_primary_plane_prepare_fb - allocate backing buffer
422  *
423  * @plane:  display plane
424  * @new_state: info on the new plane state, including the FB
425  *
426  * The SOU backing buffer is our equivalent of the display plane.
427  *
428  * Returns 0 on success
429  */
430 static int
431 vmw_sou_primary_plane_prepare_fb(struct drm_plane *plane,
432                                  struct drm_plane_state *new_state)
433 {
434         struct drm_framebuffer *new_fb = new_state->fb;
435         struct drm_crtc *crtc = plane->state->crtc ?: new_state->crtc;
436         struct vmw_plane_state *vps = vmw_plane_state_to_vps(new_state);
437         struct vmw_private *dev_priv;
438         size_t size;
439         int ret;
440
441
442         if (!new_fb) {
443                 vmw_dmabuf_unreference(&vps->dmabuf);
444                 vps->dmabuf_size = 0;
445
446                 return 0;
447         }
448
449         size = new_state->crtc_w * new_state->crtc_h * 4;
450         dev_priv = vmw_priv(crtc->dev);
451
452         if (vps->dmabuf) {
453                 if (vps->dmabuf_size == size) {
454                         /*
455                          * Note that this might temporarily up the pin-count
456                          * to 2, until cleanup_fb() is called.
457                          */
458                         return vmw_dmabuf_pin_in_vram(dev_priv, vps->dmabuf,
459                                                       true);
460                 }
461
462                 vmw_dmabuf_unreference(&vps->dmabuf);
463                 vps->dmabuf_size = 0;
464         }
465
466         vps->dmabuf = kzalloc(sizeof(*vps->dmabuf), GFP_KERNEL);
467         if (!vps->dmabuf)
468                 return -ENOMEM;
469
470         vmw_svga_enable(dev_priv);
471
472         /* After we have alloced the backing store might not be able to
473          * resume the overlays, this is preferred to failing to alloc.
474          */
475         vmw_overlay_pause_all(dev_priv);
476         ret = vmw_dmabuf_init(dev_priv, vps->dmabuf, size,
477                               &vmw_vram_ne_placement,
478                               false, &vmw_dmabuf_bo_free);
479         vmw_overlay_resume_all(dev_priv);
480         if (ret) {
481                 vps->dmabuf = NULL; /* vmw_dmabuf_init frees on error */
482                 return ret;
483         }
484
485         /*
486          * TTM already thinks the buffer is pinned, but make sure the
487          * pin_count is upped.
488          */
489         return vmw_dmabuf_pin_in_vram(dev_priv, vps->dmabuf, true);
490 }
491
492
493 static void
494 vmw_sou_primary_plane_atomic_update(struct drm_plane *plane,
495                                     struct drm_plane_state *old_state)
496 {
497         struct drm_crtc *crtc = plane->state->crtc;
498         struct drm_pending_vblank_event *event = NULL;
499         struct vmw_fence_obj *fence = NULL;
500         int ret;
501
502         if (crtc && plane->state->fb) {
503                 struct vmw_private *dev_priv = vmw_priv(crtc->dev);
504                 struct vmw_framebuffer *vfb =
505                         vmw_framebuffer_to_vfb(plane->state->fb);
506                 struct drm_vmw_rect vclips;
507
508                 vclips.x = crtc->x;
509                 vclips.y = crtc->y;
510                 vclips.w = crtc->mode.hdisplay;
511                 vclips.h = crtc->mode.vdisplay;
512
513                 if (vfb->dmabuf)
514                         ret = vmw_kms_sou_do_dmabuf_dirty(dev_priv, vfb, NULL,
515                                                           &vclips, 1, 1, true,
516                                                           &fence, crtc);
517                 else
518                         ret = vmw_kms_sou_do_surface_dirty(dev_priv, vfb, NULL,
519                                                            &vclips, NULL, 0, 0,
520                                                            1, 1, &fence, crtc);
521
522                 /*
523                  * We cannot really fail this function, so if we do, then output
524                  * an error and maintain consistent atomic state.
525                  */
526                 if (ret != 0)
527                         DRM_ERROR("Failed to update screen.\n");
528
529                 crtc->primary->fb = plane->state->fb;
530         } else {
531                 /*
532                  * When disabling a plane, CRTC and FB should always be NULL
533                  * together, otherwise it's an error.
534                  * Here primary plane is being disable so should really blank
535                  * the screen object display unit, if not already done.
536                  */
537                 return;
538         }
539
540         event = crtc->state->event;
541         /*
542          * In case of failure and other cases, vblank event will be sent in
543          * vmw_du_crtc_atomic_flush.
544          */
545         if (event && fence) {
546                 struct drm_file *file_priv = event->base.file_priv;
547
548                 ret = vmw_event_fence_action_queue(file_priv,
549                                                    fence,
550                                                    &event->base,
551                                                    &event->event.vbl.tv_sec,
552                                                    &event->event.vbl.tv_usec,
553                                                    true);
554
555                 if (unlikely(ret != 0))
556                         DRM_ERROR("Failed to queue event on fence.\n");
557                 else
558                         crtc->state->event = NULL;
559         }
560
561         if (fence)
562                 vmw_fence_obj_unreference(&fence);
563 }
564
565
566 static const struct drm_plane_funcs vmw_sou_plane_funcs = {
567         .update_plane = drm_atomic_helper_update_plane,
568         .disable_plane = drm_atomic_helper_disable_plane,
569         .destroy = vmw_du_primary_plane_destroy,
570         .reset = vmw_du_plane_reset,
571         .atomic_duplicate_state = vmw_du_plane_duplicate_state,
572         .atomic_destroy_state = vmw_du_plane_destroy_state,
573 };
574
575 static const struct drm_plane_funcs vmw_sou_cursor_funcs = {
576         .update_plane = drm_atomic_helper_update_plane,
577         .disable_plane = drm_atomic_helper_disable_plane,
578         .destroy = vmw_du_cursor_plane_destroy,
579         .reset = vmw_du_plane_reset,
580         .atomic_duplicate_state = vmw_du_plane_duplicate_state,
581         .atomic_destroy_state = vmw_du_plane_destroy_state,
582 };
583
584 /*
585  * Atomic Helpers
586  */
587 static const struct
588 drm_plane_helper_funcs vmw_sou_cursor_plane_helper_funcs = {
589         .atomic_check = vmw_du_cursor_plane_atomic_check,
590         .atomic_update = vmw_du_cursor_plane_atomic_update,
591         .prepare_fb = vmw_du_cursor_plane_prepare_fb,
592         .cleanup_fb = vmw_du_plane_cleanup_fb,
593 };
594
595 static const struct
596 drm_plane_helper_funcs vmw_sou_primary_plane_helper_funcs = {
597         .atomic_check = vmw_du_primary_plane_atomic_check,
598         .atomic_update = vmw_sou_primary_plane_atomic_update,
599         .prepare_fb = vmw_sou_primary_plane_prepare_fb,
600         .cleanup_fb = vmw_sou_primary_plane_cleanup_fb,
601 };
602
603 static const struct drm_crtc_helper_funcs vmw_sou_crtc_helper_funcs = {
604         .prepare = vmw_sou_crtc_helper_prepare,
605         .mode_set_nofb = vmw_sou_crtc_mode_set_nofb,
606         .atomic_check = vmw_du_crtc_atomic_check,
607         .atomic_begin = vmw_du_crtc_atomic_begin,
608         .atomic_flush = vmw_du_crtc_atomic_flush,
609         .atomic_enable = vmw_sou_crtc_atomic_enable,
610         .atomic_disable = vmw_sou_crtc_atomic_disable,
611 };
612
613
614 static int vmw_sou_init(struct vmw_private *dev_priv, unsigned unit)
615 {
616         struct vmw_screen_object_unit *sou;
617         struct drm_device *dev = dev_priv->dev;
618         struct drm_connector *connector;
619         struct drm_encoder *encoder;
620         struct drm_plane *primary, *cursor;
621         struct drm_crtc *crtc;
622         int ret;
623
624         sou = kzalloc(sizeof(*sou), GFP_KERNEL);
625         if (!sou)
626                 return -ENOMEM;
627
628         sou->base.unit = unit;
629         crtc = &sou->base.crtc;
630         encoder = &sou->base.encoder;
631         connector = &sou->base.connector;
632         primary = &sou->base.primary;
633         cursor = &sou->base.cursor;
634
635         sou->base.active_implicit = false;
636         sou->base.pref_active = (unit == 0);
637         sou->base.pref_width = dev_priv->initial_width;
638         sou->base.pref_height = dev_priv->initial_height;
639         sou->base.pref_mode = NULL;
640
641         /*
642          * Remove this after enabling atomic because property values can
643          * only exist in a state object
644          */
645         sou->base.is_implicit = false;
646
647         /* Initialize primary plane */
648         vmw_du_plane_reset(primary);
649
650         ret = drm_universal_plane_init(dev, &sou->base.primary,
651                                        0, &vmw_sou_plane_funcs,
652                                        vmw_primary_plane_formats,
653                                        ARRAY_SIZE(vmw_primary_plane_formats),
654                                        NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
655         if (ret) {
656                 DRM_ERROR("Failed to initialize primary plane");
657                 goto err_free;
658         }
659
660         drm_plane_helper_add(primary, &vmw_sou_primary_plane_helper_funcs);
661
662         /* Initialize cursor plane */
663         vmw_du_plane_reset(cursor);
664
665         ret = drm_universal_plane_init(dev, &sou->base.cursor,
666                         0, &vmw_sou_cursor_funcs,
667                         vmw_cursor_plane_formats,
668                         ARRAY_SIZE(vmw_cursor_plane_formats),
669                         NULL, DRM_PLANE_TYPE_CURSOR, NULL);
670         if (ret) {
671                 DRM_ERROR("Failed to initialize cursor plane");
672                 drm_plane_cleanup(&sou->base.primary);
673                 goto err_free;
674         }
675
676         drm_plane_helper_add(cursor, &vmw_sou_cursor_plane_helper_funcs);
677
678         vmw_du_connector_reset(connector);
679         ret = drm_connector_init(dev, connector, &vmw_sou_connector_funcs,
680                                  DRM_MODE_CONNECTOR_VIRTUAL);
681         if (ret) {
682                 DRM_ERROR("Failed to initialize connector\n");
683                 goto err_free;
684         }
685
686         drm_connector_helper_add(connector, &vmw_sou_connector_helper_funcs);
687         connector->status = vmw_du_connector_detect(connector, true);
688         vmw_connector_state_to_vcs(connector->state)->is_implicit = false;
689
690
691         ret = drm_encoder_init(dev, encoder, &vmw_screen_object_encoder_funcs,
692                                DRM_MODE_ENCODER_VIRTUAL, NULL);
693         if (ret) {
694                 DRM_ERROR("Failed to initialize encoder\n");
695                 goto err_free_connector;
696         }
697
698         (void) drm_mode_connector_attach_encoder(connector, encoder);
699         encoder->possible_crtcs = (1 << unit);
700         encoder->possible_clones = 0;
701
702         ret = drm_connector_register(connector);
703         if (ret) {
704                 DRM_ERROR("Failed to register connector\n");
705                 goto err_free_encoder;
706         }
707
708
709         vmw_du_crtc_reset(crtc);
710         ret = drm_crtc_init_with_planes(dev, crtc, &sou->base.primary,
711                                         &sou->base.cursor,
712                                         &vmw_screen_object_crtc_funcs, NULL);
713         if (ret) {
714                 DRM_ERROR("Failed to initialize CRTC\n");
715                 goto err_free_unregister;
716         }
717
718         drm_crtc_helper_add(crtc, &vmw_sou_crtc_helper_funcs);
719
720         drm_mode_crtc_set_gamma_size(crtc, 256);
721
722         drm_object_attach_property(&connector->base,
723                                    dev_priv->hotplug_mode_update_property, 1);
724         drm_object_attach_property(&connector->base,
725                                    dev->mode_config.suggested_x_property, 0);
726         drm_object_attach_property(&connector->base,
727                                    dev->mode_config.suggested_y_property, 0);
728         if (dev_priv->implicit_placement_property)
729                 drm_object_attach_property
730                         (&connector->base,
731                          dev_priv->implicit_placement_property,
732                          sou->base.is_implicit);
733
734         return 0;
735
736 err_free_unregister:
737         drm_connector_unregister(connector);
738 err_free_encoder:
739         drm_encoder_cleanup(encoder);
740 err_free_connector:
741         drm_connector_cleanup(connector);
742 err_free:
743         kfree(sou);
744         return ret;
745 }
746
747 int vmw_kms_sou_init_display(struct vmw_private *dev_priv)
748 {
749         struct drm_device *dev = dev_priv->dev;
750         int i, ret;
751
752         if (!(dev_priv->capabilities & SVGA_CAP_SCREEN_OBJECT_2)) {
753                 DRM_INFO("Not using screen objects,"
754                          " missing cap SCREEN_OBJECT_2\n");
755                 return -ENOSYS;
756         }
757
758         ret = -ENOMEM;
759         dev_priv->num_implicit = 0;
760         dev_priv->implicit_fb = NULL;
761
762         ret = drm_vblank_init(dev, VMWGFX_NUM_DISPLAY_UNITS);
763         if (unlikely(ret != 0))
764                 return ret;
765
766         vmw_kms_create_implicit_placement_property(dev_priv, false);
767
768         for (i = 0; i < VMWGFX_NUM_DISPLAY_UNITS; ++i)
769                 vmw_sou_init(dev_priv, i);
770
771         dev_priv->active_display_unit = vmw_du_screen_object;
772
773         DRM_INFO("Screen Objects Display Unit initialized\n");
774
775         return 0;
776 }
777
778 static int do_dmabuf_define_gmrfb(struct vmw_private *dev_priv,
779                                   struct vmw_framebuffer *framebuffer)
780 {
781         struct vmw_dma_buffer *buf =
782                 container_of(framebuffer, struct vmw_framebuffer_dmabuf,
783                              base)->buffer;
784         int depth = framebuffer->base.format->depth;
785         struct {
786                 uint32_t header;
787                 SVGAFifoCmdDefineGMRFB body;
788         } *cmd;
789
790         /* Emulate RGBA support, contrary to svga_reg.h this is not
791          * supported by hosts. This is only a problem if we are reading
792          * this value later and expecting what we uploaded back.
793          */
794         if (depth == 32)
795                 depth = 24;
796
797         cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
798         if (!cmd) {
799                 DRM_ERROR("Out of fifo space for dirty framebuffer command.\n");
800                 return -ENOMEM;
801         }
802
803         cmd->header = SVGA_CMD_DEFINE_GMRFB;
804         cmd->body.format.bitsPerPixel = framebuffer->base.format->cpp[0] * 8;
805         cmd->body.format.colorDepth = depth;
806         cmd->body.format.reserved = 0;
807         cmd->body.bytesPerLine = framebuffer->base.pitches[0];
808         /* Buffer is reserved in vram or GMR */
809         vmw_bo_get_guest_ptr(&buf->base, &cmd->body.ptr);
810         vmw_fifo_commit(dev_priv, sizeof(*cmd));
811
812         return 0;
813 }
814
815 /**
816  * vmw_sou_surface_fifo_commit - Callback to fill in and submit a
817  * blit surface to screen command.
818  *
819  * @dirty: The closure structure.
820  *
821  * Fills in the missing fields in the command, and translates the cliprects
822  * to match the destination bounding box encoded.
823  */
824 static void vmw_sou_surface_fifo_commit(struct vmw_kms_dirty *dirty)
825 {
826         struct vmw_kms_sou_surface_dirty *sdirty =
827                 container_of(dirty, typeof(*sdirty), base);
828         struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
829         s32 trans_x = dirty->unit->crtc.x - sdirty->dst_x;
830         s32 trans_y = dirty->unit->crtc.y - sdirty->dst_y;
831         size_t region_size = dirty->num_hits * sizeof(SVGASignedRect);
832         SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
833         int i;
834
835         if (!dirty->num_hits) {
836                 vmw_fifo_commit(dirty->dev_priv, 0);
837                 return;
838         }
839
840         cmd->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
841         cmd->header.size = sizeof(cmd->body) + region_size;
842
843         /*
844          * Use the destination bounding box to specify destination - and
845          * source bounding regions.
846          */
847         cmd->body.destRect.left = sdirty->left;
848         cmd->body.destRect.right = sdirty->right;
849         cmd->body.destRect.top = sdirty->top;
850         cmd->body.destRect.bottom = sdirty->bottom;
851
852         cmd->body.srcRect.left = sdirty->left + trans_x;
853         cmd->body.srcRect.right = sdirty->right + trans_x;
854         cmd->body.srcRect.top = sdirty->top + trans_y;
855         cmd->body.srcRect.bottom = sdirty->bottom + trans_y;
856
857         cmd->body.srcImage.sid = sdirty->sid;
858         cmd->body.destScreenId = dirty->unit->unit;
859
860         /* Blits are relative to the destination rect. Translate. */
861         for (i = 0; i < dirty->num_hits; ++i, ++blit) {
862                 blit->left -= sdirty->left;
863                 blit->right -= sdirty->left;
864                 blit->top -= sdirty->top;
865                 blit->bottom -= sdirty->top;
866         }
867
868         vmw_fifo_commit(dirty->dev_priv, region_size + sizeof(*cmd));
869
870         sdirty->left = sdirty->top = S32_MAX;
871         sdirty->right = sdirty->bottom = S32_MIN;
872 }
873
874 /**
875  * vmw_sou_surface_clip - Callback to encode a blit surface to screen cliprect.
876  *
877  * @dirty: The closure structure
878  *
879  * Encodes a SVGASignedRect cliprect and updates the bounding box of the
880  * BLIT_SURFACE_TO_SCREEN command.
881  */
882 static void vmw_sou_surface_clip(struct vmw_kms_dirty *dirty)
883 {
884         struct vmw_kms_sou_surface_dirty *sdirty =
885                 container_of(dirty, typeof(*sdirty), base);
886         struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
887         SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
888
889         /* Destination rect. */
890         blit += dirty->num_hits;
891         blit->left = dirty->unit_x1;
892         blit->top = dirty->unit_y1;
893         blit->right = dirty->unit_x2;
894         blit->bottom = dirty->unit_y2;
895
896         /* Destination bounding box */
897         sdirty->left = min_t(s32, sdirty->left, dirty->unit_x1);
898         sdirty->top = min_t(s32, sdirty->top, dirty->unit_y1);
899         sdirty->right = max_t(s32, sdirty->right, dirty->unit_x2);
900         sdirty->bottom = max_t(s32, sdirty->bottom, dirty->unit_y2);
901
902         dirty->num_hits++;
903 }
904
905 /**
906  * vmw_kms_sou_do_surface_dirty - Dirty part of a surface backed framebuffer
907  *
908  * @dev_priv: Pointer to the device private structure.
909  * @framebuffer: Pointer to the surface-buffer backed framebuffer.
910  * @clips: Array of clip rects. Either @clips or @vclips must be NULL.
911  * @vclips: Alternate array of clip rects. Either @clips or @vclips must
912  * be NULL.
913  * @srf: Pointer to surface to blit from. If NULL, the surface attached
914  * to @framebuffer will be used.
915  * @dest_x: X coordinate offset to align @srf with framebuffer coordinates.
916  * @dest_y: Y coordinate offset to align @srf with framebuffer coordinates.
917  * @num_clips: Number of clip rects in @clips.
918  * @inc: Increment to use when looping over @clips.
919  * @out_fence: If non-NULL, will return a ref-counted pointer to a
920  * struct vmw_fence_obj. The returned fence pointer may be NULL in which
921  * case the device has already synchronized.
922  * @crtc: If crtc is passed, perform surface dirty on that crtc only.
923  *
924  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
925  * interrupted.
926  */
927 int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
928                                  struct vmw_framebuffer *framebuffer,
929                                  struct drm_clip_rect *clips,
930                                  struct drm_vmw_rect *vclips,
931                                  struct vmw_resource *srf,
932                                  s32 dest_x,
933                                  s32 dest_y,
934                                  unsigned num_clips, int inc,
935                                  struct vmw_fence_obj **out_fence,
936                                  struct drm_crtc *crtc)
937 {
938         struct vmw_framebuffer_surface *vfbs =
939                 container_of(framebuffer, typeof(*vfbs), base);
940         struct vmw_kms_sou_surface_dirty sdirty;
941         struct vmw_validation_ctx ctx;
942         int ret;
943
944         if (!srf)
945                 srf = &vfbs->surface->res;
946
947         ret = vmw_kms_helper_resource_prepare(srf, true, &ctx);
948         if (ret)
949                 return ret;
950
951         sdirty.base.fifo_commit = vmw_sou_surface_fifo_commit;
952         sdirty.base.clip = vmw_sou_surface_clip;
953         sdirty.base.dev_priv = dev_priv;
954         sdirty.base.fifo_reserve_size = sizeof(struct vmw_kms_sou_dirty_cmd) +
955           sizeof(SVGASignedRect) * num_clips;
956         sdirty.base.crtc = crtc;
957
958         sdirty.sid = srf->id;
959         sdirty.left = sdirty.top = S32_MAX;
960         sdirty.right = sdirty.bottom = S32_MIN;
961         sdirty.dst_x = dest_x;
962         sdirty.dst_y = dest_y;
963
964         ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
965                                    dest_x, dest_y, num_clips, inc,
966                                    &sdirty.base);
967         vmw_kms_helper_resource_finish(&ctx, out_fence);
968
969         return ret;
970 }
971
972 /**
973  * vmw_sou_dmabuf_fifo_commit - Callback to submit a set of readback clips.
974  *
975  * @dirty: The closure structure.
976  *
977  * Commits a previously built command buffer of readback clips.
978  */
979 static void vmw_sou_dmabuf_fifo_commit(struct vmw_kms_dirty *dirty)
980 {
981         if (!dirty->num_hits) {
982                 vmw_fifo_commit(dirty->dev_priv, 0);
983                 return;
984         }
985
986         vmw_fifo_commit(dirty->dev_priv,
987                         sizeof(struct vmw_kms_sou_dmabuf_blit) *
988                         dirty->num_hits);
989 }
990
991 /**
992  * vmw_sou_dmabuf_clip - Callback to encode a readback cliprect.
993  *
994  * @dirty: The closure structure
995  *
996  * Encodes a BLIT_GMRFB_TO_SCREEN cliprect.
997  */
998 static void vmw_sou_dmabuf_clip(struct vmw_kms_dirty *dirty)
999 {
1000         struct vmw_kms_sou_dmabuf_blit *blit = dirty->cmd;
1001
1002         blit += dirty->num_hits;
1003         blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
1004         blit->body.destScreenId = dirty->unit->unit;
1005         blit->body.srcOrigin.x = dirty->fb_x;
1006         blit->body.srcOrigin.y = dirty->fb_y;
1007         blit->body.destRect.left = dirty->unit_x1;
1008         blit->body.destRect.top = dirty->unit_y1;
1009         blit->body.destRect.right = dirty->unit_x2;
1010         blit->body.destRect.bottom = dirty->unit_y2;
1011         dirty->num_hits++;
1012 }
1013
1014 /**
1015  * vmw_kms_do_dmabuf_dirty - Dirty part of a dma-buffer backed framebuffer
1016  *
1017  * @dev_priv: Pointer to the device private structure.
1018  * @framebuffer: Pointer to the dma-buffer backed framebuffer.
1019  * @clips: Array of clip rects.
1020  * @vclips: Alternate array of clip rects. Either @clips or @vclips must
1021  * be NULL.
1022  * @num_clips: Number of clip rects in @clips.
1023  * @increment: Increment to use when looping over @clips.
1024  * @interruptible: Whether to perform waits interruptible if possible.
1025  * @out_fence: If non-NULL, will return a ref-counted pointer to a
1026  * struct vmw_fence_obj. The returned fence pointer may be NULL in which
1027  * case the device has already synchronized.
1028  * @crtc: If crtc is passed, perform dmabuf dirty on that crtc only.
1029  *
1030  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1031  * interrupted.
1032  */
1033 int vmw_kms_sou_do_dmabuf_dirty(struct vmw_private *dev_priv,
1034                                 struct vmw_framebuffer *framebuffer,
1035                                 struct drm_clip_rect *clips,
1036                                 struct drm_vmw_rect *vclips,
1037                                 unsigned num_clips, int increment,
1038                                 bool interruptible,
1039                                 struct vmw_fence_obj **out_fence,
1040                                 struct drm_crtc *crtc)
1041 {
1042         struct vmw_dma_buffer *buf =
1043                 container_of(framebuffer, struct vmw_framebuffer_dmabuf,
1044                              base)->buffer;
1045         struct vmw_kms_dirty dirty;
1046         int ret;
1047
1048         ret = vmw_kms_helper_buffer_prepare(dev_priv, buf, interruptible,
1049                                             false, false);
1050         if (ret)
1051                 return ret;
1052
1053         ret = do_dmabuf_define_gmrfb(dev_priv, framebuffer);
1054         if (unlikely(ret != 0))
1055                 goto out_revert;
1056
1057         dirty.crtc = crtc;
1058         dirty.fifo_commit = vmw_sou_dmabuf_fifo_commit;
1059         dirty.clip = vmw_sou_dmabuf_clip;
1060         dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_dmabuf_blit) *
1061                 num_clips;
1062         ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1063                                    0, 0, num_clips, increment, &dirty);
1064         vmw_kms_helper_buffer_finish(dev_priv, NULL, buf, out_fence, NULL);
1065
1066         return ret;
1067
1068 out_revert:
1069         vmw_kms_helper_buffer_revert(buf);
1070
1071         return ret;
1072 }
1073
1074
1075 /**
1076  * vmw_sou_readback_fifo_commit - Callback to submit a set of readback clips.
1077  *
1078  * @dirty: The closure structure.
1079  *
1080  * Commits a previously built command buffer of readback clips.
1081  */
1082 static void vmw_sou_readback_fifo_commit(struct vmw_kms_dirty *dirty)
1083 {
1084         if (!dirty->num_hits) {
1085                 vmw_fifo_commit(dirty->dev_priv, 0);
1086                 return;
1087         }
1088
1089         vmw_fifo_commit(dirty->dev_priv,
1090                         sizeof(struct vmw_kms_sou_readback_blit) *
1091                         dirty->num_hits);
1092 }
1093
1094 /**
1095  * vmw_sou_readback_clip - Callback to encode a readback cliprect.
1096  *
1097  * @dirty: The closure structure
1098  *
1099  * Encodes a BLIT_SCREEN_TO_GMRFB cliprect.
1100  */
1101 static void vmw_sou_readback_clip(struct vmw_kms_dirty *dirty)
1102 {
1103         struct vmw_kms_sou_readback_blit *blit = dirty->cmd;
1104
1105         blit += dirty->num_hits;
1106         blit->header = SVGA_CMD_BLIT_SCREEN_TO_GMRFB;
1107         blit->body.srcScreenId = dirty->unit->unit;
1108         blit->body.destOrigin.x = dirty->fb_x;
1109         blit->body.destOrigin.y = dirty->fb_y;
1110         blit->body.srcRect.left = dirty->unit_x1;
1111         blit->body.srcRect.top = dirty->unit_y1;
1112         blit->body.srcRect.right = dirty->unit_x2;
1113         blit->body.srcRect.bottom = dirty->unit_y2;
1114         dirty->num_hits++;
1115 }
1116
1117 /**
1118  * vmw_kms_sou_readback - Perform a readback from the screen object system to
1119  * a dma-buffer backed framebuffer.
1120  *
1121  * @dev_priv: Pointer to the device private structure.
1122  * @file_priv: Pointer to a struct drm_file identifying the caller.
1123  * Must be set to NULL if @user_fence_rep is NULL.
1124  * @vfb: Pointer to the dma-buffer backed framebuffer.
1125  * @user_fence_rep: User-space provided structure for fence information.
1126  * Must be set to non-NULL if @file_priv is non-NULL.
1127  * @vclips: Array of clip rects.
1128  * @num_clips: Number of clip rects in @vclips.
1129  * @crtc: If crtc is passed, readback on that crtc only.
1130  *
1131  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1132  * interrupted.
1133  */
1134 int vmw_kms_sou_readback(struct vmw_private *dev_priv,
1135                          struct drm_file *file_priv,
1136                          struct vmw_framebuffer *vfb,
1137                          struct drm_vmw_fence_rep __user *user_fence_rep,
1138                          struct drm_vmw_rect *vclips,
1139                          uint32_t num_clips,
1140                          struct drm_crtc *crtc)
1141 {
1142         struct vmw_dma_buffer *buf =
1143                 container_of(vfb, struct vmw_framebuffer_dmabuf, base)->buffer;
1144         struct vmw_kms_dirty dirty;
1145         int ret;
1146
1147         ret = vmw_kms_helper_buffer_prepare(dev_priv, buf, true, false,
1148                                             false);
1149         if (ret)
1150                 return ret;
1151
1152         ret = do_dmabuf_define_gmrfb(dev_priv, vfb);
1153         if (unlikely(ret != 0))
1154                 goto out_revert;
1155
1156         dirty.crtc = crtc;
1157         dirty.fifo_commit = vmw_sou_readback_fifo_commit;
1158         dirty.clip = vmw_sou_readback_clip;
1159         dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_readback_blit) *
1160                 num_clips;
1161         ret = vmw_kms_helper_dirty(dev_priv, vfb, NULL, vclips,
1162                                    0, 0, num_clips, 1, &dirty);
1163         vmw_kms_helper_buffer_finish(dev_priv, file_priv, buf, NULL,
1164                                      user_fence_rep);
1165
1166         return ret;
1167
1168 out_revert:
1169         vmw_kms_helper_buffer_revert(buf);
1170
1171         return ret;
1172 }