1 // SPDX-License-Identifier: GPL-2.0 OR MIT
2 /**************************************************************************
4 * Copyright 2011-2015 VMware, Inc., Palo Alto, CA., USA
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
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 #include <drm/drm_damage_helper.h>
35 #define vmw_crtc_to_sou(x) \
36 container_of(x, struct vmw_screen_object_unit, base.crtc)
37 #define vmw_encoder_to_sou(x) \
38 container_of(x, struct vmw_screen_object_unit, base.encoder)
39 #define vmw_connector_to_sou(x) \
40 container_of(x, struct vmw_screen_object_unit, base.connector)
43 * struct vmw_kms_sou_surface_dirty - Closure structure for
44 * blit surface to screen command.
45 * @base: The base type we derive from. Used by vmw_kms_helper_dirty().
46 * @left: Left side of bounding box.
47 * @right: Right side of bounding box.
48 * @top: Top side of bounding box.
49 * @bottom: Bottom side of bounding box.
50 * @dst_x: Difference between source clip rects and framebuffer coordinates.
51 * @dst_y: Difference between source clip rects and framebuffer coordinates.
52 * @sid: Surface id of surface to copy from.
54 struct vmw_kms_sou_surface_dirty {
55 struct vmw_kms_dirty base;
56 s32 left, right, top, bottom;
62 * SVGA commands that are used by this code. Please see the device headers
65 struct vmw_kms_sou_readback_blit {
67 SVGAFifoCmdBlitScreenToGMRFB body;
70 struct vmw_kms_sou_bo_blit {
72 SVGAFifoCmdBlitGMRFBToScreen body;
75 struct vmw_kms_sou_dirty_cmd {
76 SVGA3dCmdHeader header;
77 SVGA3dCmdBlitSurfaceToScreen body;
80 struct vmw_kms_sou_define_gmrfb {
82 SVGAFifoCmdDefineGMRFB body;
86 * Display unit using screen objects.
88 struct vmw_screen_object_unit {
89 struct vmw_display_unit base;
91 unsigned long buffer_size; /**< Size of allocated buffer */
92 struct vmw_buffer_object *buffer; /**< Backing store buffer */
97 static void vmw_sou_destroy(struct vmw_screen_object_unit *sou)
99 vmw_du_cleanup(&sou->base);
105 * Screen Object Display Unit CRTC functions
108 static void vmw_sou_crtc_destroy(struct drm_crtc *crtc)
110 vmw_sou_destroy(vmw_crtc_to_sou(crtc));
114 * Send the fifo command to create a screen.
116 static int vmw_sou_fifo_create(struct vmw_private *dev_priv,
117 struct vmw_screen_object_unit *sou,
119 struct drm_display_mode *mode)
127 SVGAScreenObject obj;
130 BUG_ON(!sou->buffer);
132 fifo_size = sizeof(*cmd);
133 cmd = VMW_FIFO_RESERVE(dev_priv, fifo_size);
134 if (unlikely(cmd == NULL))
137 memset(cmd, 0, fifo_size);
138 cmd->header.cmdType = SVGA_CMD_DEFINE_SCREEN;
139 cmd->obj.structSize = sizeof(SVGAScreenObject);
140 cmd->obj.id = sou->base.unit;
141 cmd->obj.flags = SVGA_SCREEN_HAS_ROOT |
142 (sou->base.unit == 0 ? SVGA_SCREEN_IS_PRIMARY : 0);
143 cmd->obj.size.width = mode->hdisplay;
144 cmd->obj.size.height = mode->vdisplay;
147 sou->base.set_gui_x = cmd->obj.root.x;
148 sou->base.set_gui_y = cmd->obj.root.y;
150 /* Ok to assume that buffer is pinned in vram */
151 vmw_bo_get_guest_ptr(&sou->buffer->base, &cmd->obj.backingStore.ptr);
152 cmd->obj.backingStore.pitch = mode->hdisplay * 4;
154 vmw_fifo_commit(dev_priv, fifo_size);
162 * Send the fifo command to destroy a screen.
164 static int vmw_sou_fifo_destroy(struct vmw_private *dev_priv,
165 struct vmw_screen_object_unit *sou)
174 SVGAFifoCmdDestroyScreen body;
177 /* no need to do anything */
178 if (unlikely(!sou->defined))
181 fifo_size = sizeof(*cmd);
182 cmd = VMW_FIFO_RESERVE(dev_priv, fifo_size);
183 if (unlikely(cmd == NULL))
186 memset(cmd, 0, fifo_size);
187 cmd->header.cmdType = SVGA_CMD_DESTROY_SCREEN;
188 cmd->body.screenId = sou->base.unit;
190 vmw_fifo_commit(dev_priv, fifo_size);
193 ret = vmw_fallback_wait(dev_priv, false, true, 0, false, 3*HZ);
194 if (unlikely(ret != 0))
195 DRM_ERROR("Failed to sync with HW");
197 sou->defined = false;
203 * vmw_sou_crtc_mode_set_nofb - Create new screen
205 * @crtc: CRTC associated with the new screen
207 * This function creates/destroys a screen. This function cannot fail, so if
208 * somehow we run into a failure, just do the best we can to get out.
210 static void vmw_sou_crtc_mode_set_nofb(struct drm_crtc *crtc)
212 struct vmw_private *dev_priv;
213 struct vmw_screen_object_unit *sou;
214 struct vmw_framebuffer *vfb;
215 struct drm_framebuffer *fb;
216 struct drm_plane_state *ps;
217 struct vmw_plane_state *vps;
220 sou = vmw_crtc_to_sou(crtc);
221 dev_priv = vmw_priv(crtc->dev);
222 ps = crtc->primary->state;
224 vps = vmw_plane_state_to_vps(ps);
226 vfb = (fb) ? vmw_framebuffer_to_vfb(fb) : NULL;
229 ret = vmw_sou_fifo_destroy(dev_priv, sou);
231 DRM_ERROR("Failed to destroy Screen Object\n");
237 struct drm_connector_state *conn_state;
238 struct vmw_connector_state *vmw_conn_state;
241 sou->buffer = vps->bo;
242 sou->buffer_size = vps->bo_size;
244 conn_state = sou->base.connector.state;
245 vmw_conn_state = vmw_connector_state_to_vcs(conn_state);
247 x = vmw_conn_state->gui_x;
248 y = vmw_conn_state->gui_y;
250 ret = vmw_sou_fifo_create(dev_priv, sou, x, y, &crtc->mode);
252 DRM_ERROR("Failed to define Screen Object %dx%d\n",
257 sou->buffer_size = 0;
262 * vmw_sou_crtc_helper_prepare - Noop
264 * @crtc: CRTC associated with the new screen
266 * Prepares the CRTC for a mode set, but we don't need to do anything here.
268 static void vmw_sou_crtc_helper_prepare(struct drm_crtc *crtc)
273 * vmw_sou_crtc_atomic_enable - Noop
275 * @crtc: CRTC associated with the new screen
277 * This is called after a mode set has been completed.
279 static void vmw_sou_crtc_atomic_enable(struct drm_crtc *crtc,
280 struct drm_crtc_state *old_state)
285 * vmw_sou_crtc_atomic_disable - Turns off CRTC
287 * @crtc: CRTC to be turned off
289 static void vmw_sou_crtc_atomic_disable(struct drm_crtc *crtc,
290 struct drm_crtc_state *old_state)
292 struct vmw_private *dev_priv;
293 struct vmw_screen_object_unit *sou;
298 DRM_ERROR("CRTC is NULL\n");
302 sou = vmw_crtc_to_sou(crtc);
303 dev_priv = vmw_priv(crtc->dev);
306 ret = vmw_sou_fifo_destroy(dev_priv, sou);
308 DRM_ERROR("Failed to destroy Screen Object\n");
312 static const struct drm_crtc_funcs vmw_screen_object_crtc_funcs = {
313 .gamma_set = vmw_du_crtc_gamma_set,
314 .destroy = vmw_sou_crtc_destroy,
315 .reset = vmw_du_crtc_reset,
316 .atomic_duplicate_state = vmw_du_crtc_duplicate_state,
317 .atomic_destroy_state = vmw_du_crtc_destroy_state,
318 .set_config = drm_atomic_helper_set_config,
319 .page_flip = drm_atomic_helper_page_flip,
323 * Screen Object Display Unit encoder functions
326 static void vmw_sou_encoder_destroy(struct drm_encoder *encoder)
328 vmw_sou_destroy(vmw_encoder_to_sou(encoder));
331 static const struct drm_encoder_funcs vmw_screen_object_encoder_funcs = {
332 .destroy = vmw_sou_encoder_destroy,
336 * Screen Object Display Unit connector functions
339 static void vmw_sou_connector_destroy(struct drm_connector *connector)
341 vmw_sou_destroy(vmw_connector_to_sou(connector));
344 static const struct drm_connector_funcs vmw_sou_connector_funcs = {
345 .dpms = vmw_du_connector_dpms,
346 .detect = vmw_du_connector_detect,
347 .fill_modes = vmw_du_connector_fill_modes,
348 .destroy = vmw_sou_connector_destroy,
349 .reset = vmw_du_connector_reset,
350 .atomic_duplicate_state = vmw_du_connector_duplicate_state,
351 .atomic_destroy_state = vmw_du_connector_destroy_state,
356 drm_connector_helper_funcs vmw_sou_connector_helper_funcs = {
362 * Screen Object Display Plane Functions
366 * vmw_sou_primary_plane_cleanup_fb - Frees sou backing buffer
368 * @plane: display plane
369 * @old_state: Contains the FB to clean up
371 * Unpins the display surface
373 * Returns 0 on success
376 vmw_sou_primary_plane_cleanup_fb(struct drm_plane *plane,
377 struct drm_plane_state *old_state)
379 struct vmw_plane_state *vps = vmw_plane_state_to_vps(old_state);
380 struct drm_crtc *crtc = plane->state->crtc ?
381 plane->state->crtc : old_state->crtc;
384 vmw_bo_unpin(vmw_priv(crtc->dev), vps->bo, false);
385 vmw_bo_unreference(&vps->bo);
388 vmw_du_plane_cleanup_fb(plane, old_state);
393 * vmw_sou_primary_plane_prepare_fb - allocate backing buffer
395 * @plane: display plane
396 * @new_state: info on the new plane state, including the FB
398 * The SOU backing buffer is our equivalent of the display plane.
400 * Returns 0 on success
403 vmw_sou_primary_plane_prepare_fb(struct drm_plane *plane,
404 struct drm_plane_state *new_state)
406 struct drm_framebuffer *new_fb = new_state->fb;
407 struct drm_crtc *crtc = plane->state->crtc ?: new_state->crtc;
408 struct vmw_plane_state *vps = vmw_plane_state_to_vps(new_state);
409 struct vmw_private *dev_priv;
415 vmw_bo_unreference(&vps->bo);
421 size = new_state->crtc_w * new_state->crtc_h * 4;
422 dev_priv = vmw_priv(crtc->dev);
425 if (vps->bo_size == size) {
427 * Note that this might temporarily up the pin-count
428 * to 2, until cleanup_fb() is called.
430 return vmw_bo_pin_in_vram(dev_priv, vps->bo,
434 vmw_bo_unreference(&vps->bo);
438 vps->bo = kzalloc(sizeof(*vps->bo), GFP_KERNEL);
442 vmw_svga_enable(dev_priv);
444 /* After we have alloced the backing store might not be able to
445 * resume the overlays, this is preferred to failing to alloc.
447 vmw_overlay_pause_all(dev_priv);
448 ret = vmw_bo_init(dev_priv, vps->bo, size,
449 &vmw_vram_ne_placement,
450 false, &vmw_bo_bo_free);
451 vmw_overlay_resume_all(dev_priv);
453 vps->bo = NULL; /* vmw_bo_init frees on error */
460 * TTM already thinks the buffer is pinned, but make sure the
461 * pin_count is upped.
463 return vmw_bo_pin_in_vram(dev_priv, vps->bo, true);
466 static uint32_t vmw_sou_bo_fifo_size(struct vmw_du_update_plane *update,
469 return sizeof(struct vmw_kms_sou_define_gmrfb) +
470 sizeof(struct vmw_kms_sou_bo_blit) * num_hits;
473 static uint32_t vmw_sou_bo_define_gmrfb(struct vmw_du_update_plane *update,
476 struct vmw_framebuffer_bo *vfbbo =
477 container_of(update->vfb, typeof(*vfbbo), base);
478 struct vmw_kms_sou_define_gmrfb *gmr = cmd;
479 int depth = update->vfb->base.format->depth;
481 /* Emulate RGBA support, contrary to svga_reg.h this is not
482 * supported by hosts. This is only a problem if we are reading
483 * this value later and expecting what we uploaded back.
488 gmr->header = SVGA_CMD_DEFINE_GMRFB;
490 gmr->body.format.bitsPerPixel = update->vfb->base.format->cpp[0] * 8;
491 gmr->body.format.colorDepth = depth;
492 gmr->body.format.reserved = 0;
493 gmr->body.bytesPerLine = update->vfb->base.pitches[0];
494 vmw_bo_get_guest_ptr(&vfbbo->buffer->base, &gmr->body.ptr);
499 static uint32_t vmw_sou_bo_populate_clip(struct vmw_du_update_plane *update,
500 void *cmd, struct drm_rect *clip,
501 uint32_t fb_x, uint32_t fb_y)
503 struct vmw_kms_sou_bo_blit *blit = cmd;
505 blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
506 blit->body.destScreenId = update->du->unit;
507 blit->body.srcOrigin.x = fb_x;
508 blit->body.srcOrigin.y = fb_y;
509 blit->body.destRect.left = clip->x1;
510 blit->body.destRect.top = clip->y1;
511 blit->body.destRect.right = clip->x2;
512 blit->body.destRect.bottom = clip->y2;
514 return sizeof(*blit);
517 static uint32_t vmw_stud_bo_post_clip(struct vmw_du_update_plane *update,
518 void *cmd, struct drm_rect *bb)
524 * vmw_sou_plane_update_bo - Update display unit for bo backed fb.
525 * @dev_priv: Device private.
526 * @plane: Plane state.
527 * @old_state: Old plane state.
528 * @vfb: Framebuffer which is blitted to display unit.
529 * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
530 * The returned fence pointer may be NULL in which case the device
531 * has already synchronized.
533 * Return: 0 on success or a negative error code on failure.
535 static int vmw_sou_plane_update_bo(struct vmw_private *dev_priv,
536 struct drm_plane *plane,
537 struct drm_plane_state *old_state,
538 struct vmw_framebuffer *vfb,
539 struct vmw_fence_obj **out_fence)
541 struct vmw_du_update_plane_buffer bo_update;
543 memset(&bo_update, 0, sizeof(struct vmw_du_update_plane_buffer));
544 bo_update.base.plane = plane;
545 bo_update.base.old_state = old_state;
546 bo_update.base.dev_priv = dev_priv;
547 bo_update.base.du = vmw_crtc_to_du(plane->state->crtc);
548 bo_update.base.vfb = vfb;
549 bo_update.base.out_fence = out_fence;
550 bo_update.base.mutex = NULL;
551 bo_update.base.cpu_blit = false;
552 bo_update.base.intr = true;
554 bo_update.base.calc_fifo_size = vmw_sou_bo_fifo_size;
555 bo_update.base.post_prepare = vmw_sou_bo_define_gmrfb;
556 bo_update.base.clip = vmw_sou_bo_populate_clip;
557 bo_update.base.post_clip = vmw_stud_bo_post_clip;
559 return vmw_du_helper_plane_update(&bo_update.base);
562 static uint32_t vmw_sou_surface_fifo_size(struct vmw_du_update_plane *update,
565 return sizeof(struct vmw_kms_sou_dirty_cmd) + sizeof(SVGASignedRect) *
569 static uint32_t vmw_sou_surface_post_prepare(struct vmw_du_update_plane *update,
572 struct vmw_du_update_plane_surface *srf_update;
574 srf_update = container_of(update, typeof(*srf_update), base);
577 * SOU SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN is special in the sense that
578 * its bounding box is filled before iterating over all the clips. So
579 * store the FIFO start address and revisit to fill the details.
581 srf_update->cmd_start = cmd;
586 static uint32_t vmw_sou_surface_pre_clip(struct vmw_du_update_plane *update,
587 void *cmd, uint32_t num_hits)
589 struct vmw_kms_sou_dirty_cmd *blit = cmd;
590 struct vmw_framebuffer_surface *vfbs;
592 vfbs = container_of(update->vfb, typeof(*vfbs), base);
594 blit->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
595 blit->header.size = sizeof(blit->body) + sizeof(SVGASignedRect) *
598 blit->body.srcImage.sid = vfbs->surface->res.id;
599 blit->body.destScreenId = update->du->unit;
601 /* Update the source and destination bounding box later in post_clip */
602 blit->body.srcRect.left = 0;
603 blit->body.srcRect.top = 0;
604 blit->body.srcRect.right = 0;
605 blit->body.srcRect.bottom = 0;
607 blit->body.destRect.left = 0;
608 blit->body.destRect.top = 0;
609 blit->body.destRect.right = 0;
610 blit->body.destRect.bottom = 0;
612 return sizeof(*blit);
615 static uint32_t vmw_sou_surface_clip_rect(struct vmw_du_update_plane *update,
616 void *cmd, struct drm_rect *clip,
617 uint32_t src_x, uint32_t src_y)
619 SVGASignedRect *rect = cmd;
622 * rects are relative to dest bounding box rect on screen object, so
623 * translate to it later in post_clip
625 rect->left = clip->x1;
626 rect->top = clip->y1;
627 rect->right = clip->x2;
628 rect->bottom = clip->y2;
630 return sizeof(*rect);
633 static uint32_t vmw_sou_surface_post_clip(struct vmw_du_update_plane *update,
634 void *cmd, struct drm_rect *bb)
636 struct vmw_du_update_plane_surface *srf_update;
637 struct drm_plane_state *state = update->plane->state;
638 struct drm_rect src_bb;
639 struct vmw_kms_sou_dirty_cmd *blit;
640 SVGASignedRect *rect;
646 srf_update = container_of(update, typeof(*srf_update), base);
648 blit = srf_update->cmd_start;
649 rect = (SVGASignedRect *)&blit[1];
651 num_hits = (blit->header.size - sizeof(blit->body))/
652 sizeof(SVGASignedRect);
656 /* To translate bb back to fb src coord */
657 translate_src_x = (state->src_x >> 16) - state->crtc_x;
658 translate_src_y = (state->src_y >> 16) - state->crtc_y;
660 drm_rect_translate(&src_bb, translate_src_x, translate_src_y);
662 blit->body.srcRect.left = src_bb.x1;
663 blit->body.srcRect.top = src_bb.y1;
664 blit->body.srcRect.right = src_bb.x2;
665 blit->body.srcRect.bottom = src_bb.y2;
667 blit->body.destRect.left = bb->x1;
668 blit->body.destRect.top = bb->y1;
669 blit->body.destRect.right = bb->x2;
670 blit->body.destRect.bottom = bb->y2;
672 /* rects are relative to dest bb rect */
673 for (i = 0; i < num_hits; i++) {
674 rect->left -= bb->x1;
676 rect->right -= bb->x1;
677 rect->bottom -= bb->y1;
685 * vmw_sou_plane_update_surface - Update display unit for surface backed fb.
686 * @dev_priv: Device private.
687 * @plane: Plane state.
688 * @old_state: Old plane state.
689 * @vfb: Framebuffer which is blitted to display unit
690 * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
691 * The returned fence pointer may be NULL in which case the device
692 * has already synchronized.
694 * Return: 0 on success or a negative error code on failure.
696 static int vmw_sou_plane_update_surface(struct vmw_private *dev_priv,
697 struct drm_plane *plane,
698 struct drm_plane_state *old_state,
699 struct vmw_framebuffer *vfb,
700 struct vmw_fence_obj **out_fence)
702 struct vmw_du_update_plane_surface srf_update;
704 memset(&srf_update, 0, sizeof(struct vmw_du_update_plane_surface));
705 srf_update.base.plane = plane;
706 srf_update.base.old_state = old_state;
707 srf_update.base.dev_priv = dev_priv;
708 srf_update.base.du = vmw_crtc_to_du(plane->state->crtc);
709 srf_update.base.vfb = vfb;
710 srf_update.base.out_fence = out_fence;
711 srf_update.base.mutex = &dev_priv->cmdbuf_mutex;
712 srf_update.base.cpu_blit = false;
713 srf_update.base.intr = true;
715 srf_update.base.calc_fifo_size = vmw_sou_surface_fifo_size;
716 srf_update.base.post_prepare = vmw_sou_surface_post_prepare;
717 srf_update.base.pre_clip = vmw_sou_surface_pre_clip;
718 srf_update.base.clip = vmw_sou_surface_clip_rect;
719 srf_update.base.post_clip = vmw_sou_surface_post_clip;
721 return vmw_du_helper_plane_update(&srf_update.base);
725 vmw_sou_primary_plane_atomic_update(struct drm_plane *plane,
726 struct drm_plane_state *old_state)
728 struct drm_crtc *crtc = plane->state->crtc;
729 struct drm_pending_vblank_event *event = NULL;
730 struct vmw_fence_obj *fence = NULL;
733 /* In case of device error, maintain consistent atomic state */
734 if (crtc && plane->state->fb) {
735 struct vmw_private *dev_priv = vmw_priv(crtc->dev);
736 struct vmw_framebuffer *vfb =
737 vmw_framebuffer_to_vfb(plane->state->fb);
740 ret = vmw_sou_plane_update_bo(dev_priv, plane,
741 old_state, vfb, &fence);
743 ret = vmw_sou_plane_update_surface(dev_priv, plane,
747 DRM_ERROR("Failed to update screen.\n");
749 /* Do nothing when fb and crtc is NULL (blank crtc) */
753 /* For error case vblank event is send from vmw_du_crtc_atomic_flush */
754 event = crtc->state->event;
755 if (event && fence) {
756 struct drm_file *file_priv = event->base.file_priv;
758 ret = vmw_event_fence_action_queue(file_priv,
761 &event->event.vbl.tv_sec,
762 &event->event.vbl.tv_usec,
765 if (unlikely(ret != 0))
766 DRM_ERROR("Failed to queue event on fence.\n");
768 crtc->state->event = NULL;
772 vmw_fence_obj_unreference(&fence);
776 static const struct drm_plane_funcs vmw_sou_plane_funcs = {
777 .update_plane = drm_atomic_helper_update_plane,
778 .disable_plane = drm_atomic_helper_disable_plane,
779 .destroy = vmw_du_primary_plane_destroy,
780 .reset = vmw_du_plane_reset,
781 .atomic_duplicate_state = vmw_du_plane_duplicate_state,
782 .atomic_destroy_state = vmw_du_plane_destroy_state,
785 static const struct drm_plane_funcs vmw_sou_cursor_funcs = {
786 .update_plane = drm_atomic_helper_update_plane,
787 .disable_plane = drm_atomic_helper_disable_plane,
788 .destroy = vmw_du_cursor_plane_destroy,
789 .reset = vmw_du_plane_reset,
790 .atomic_duplicate_state = vmw_du_plane_duplicate_state,
791 .atomic_destroy_state = vmw_du_plane_destroy_state,
798 drm_plane_helper_funcs vmw_sou_cursor_plane_helper_funcs = {
799 .atomic_check = vmw_du_cursor_plane_atomic_check,
800 .atomic_update = vmw_du_cursor_plane_atomic_update,
801 .prepare_fb = vmw_du_cursor_plane_prepare_fb,
802 .cleanup_fb = vmw_du_plane_cleanup_fb,
806 drm_plane_helper_funcs vmw_sou_primary_plane_helper_funcs = {
807 .atomic_check = vmw_du_primary_plane_atomic_check,
808 .atomic_update = vmw_sou_primary_plane_atomic_update,
809 .prepare_fb = vmw_sou_primary_plane_prepare_fb,
810 .cleanup_fb = vmw_sou_primary_plane_cleanup_fb,
813 static const struct drm_crtc_helper_funcs vmw_sou_crtc_helper_funcs = {
814 .prepare = vmw_sou_crtc_helper_prepare,
815 .mode_set_nofb = vmw_sou_crtc_mode_set_nofb,
816 .atomic_check = vmw_du_crtc_atomic_check,
817 .atomic_begin = vmw_du_crtc_atomic_begin,
818 .atomic_flush = vmw_du_crtc_atomic_flush,
819 .atomic_enable = vmw_sou_crtc_atomic_enable,
820 .atomic_disable = vmw_sou_crtc_atomic_disable,
824 static int vmw_sou_init(struct vmw_private *dev_priv, unsigned unit)
826 struct vmw_screen_object_unit *sou;
827 struct drm_device *dev = dev_priv->dev;
828 struct drm_connector *connector;
829 struct drm_encoder *encoder;
830 struct drm_plane *primary, *cursor;
831 struct drm_crtc *crtc;
834 sou = kzalloc(sizeof(*sou), GFP_KERNEL);
838 sou->base.unit = unit;
839 crtc = &sou->base.crtc;
840 encoder = &sou->base.encoder;
841 connector = &sou->base.connector;
842 primary = &sou->base.primary;
843 cursor = &sou->base.cursor;
845 sou->base.pref_active = (unit == 0);
846 sou->base.pref_width = dev_priv->initial_width;
847 sou->base.pref_height = dev_priv->initial_height;
848 sou->base.pref_mode = NULL;
851 * Remove this after enabling atomic because property values can
852 * only exist in a state object
854 sou->base.is_implicit = false;
856 /* Initialize primary plane */
857 vmw_du_plane_reset(primary);
859 ret = drm_universal_plane_init(dev, &sou->base.primary,
860 0, &vmw_sou_plane_funcs,
861 vmw_primary_plane_formats,
862 ARRAY_SIZE(vmw_primary_plane_formats),
863 NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
865 DRM_ERROR("Failed to initialize primary plane");
869 drm_plane_helper_add(primary, &vmw_sou_primary_plane_helper_funcs);
870 drm_plane_enable_fb_damage_clips(primary);
872 /* Initialize cursor plane */
873 vmw_du_plane_reset(cursor);
875 ret = drm_universal_plane_init(dev, &sou->base.cursor,
876 0, &vmw_sou_cursor_funcs,
877 vmw_cursor_plane_formats,
878 ARRAY_SIZE(vmw_cursor_plane_formats),
879 NULL, DRM_PLANE_TYPE_CURSOR, NULL);
881 DRM_ERROR("Failed to initialize cursor plane");
882 drm_plane_cleanup(&sou->base.primary);
886 drm_plane_helper_add(cursor, &vmw_sou_cursor_plane_helper_funcs);
888 vmw_du_connector_reset(connector);
889 ret = drm_connector_init(dev, connector, &vmw_sou_connector_funcs,
890 DRM_MODE_CONNECTOR_VIRTUAL);
892 DRM_ERROR("Failed to initialize connector\n");
896 drm_connector_helper_add(connector, &vmw_sou_connector_helper_funcs);
897 connector->status = vmw_du_connector_detect(connector, true);
899 ret = drm_encoder_init(dev, encoder, &vmw_screen_object_encoder_funcs,
900 DRM_MODE_ENCODER_VIRTUAL, NULL);
902 DRM_ERROR("Failed to initialize encoder\n");
903 goto err_free_connector;
906 (void) drm_connector_attach_encoder(connector, encoder);
907 encoder->possible_crtcs = (1 << unit);
908 encoder->possible_clones = 0;
910 ret = drm_connector_register(connector);
912 DRM_ERROR("Failed to register connector\n");
913 goto err_free_encoder;
917 vmw_du_crtc_reset(crtc);
918 ret = drm_crtc_init_with_planes(dev, crtc, &sou->base.primary,
920 &vmw_screen_object_crtc_funcs, NULL);
922 DRM_ERROR("Failed to initialize CRTC\n");
923 goto err_free_unregister;
926 drm_crtc_helper_add(crtc, &vmw_sou_crtc_helper_funcs);
928 drm_mode_crtc_set_gamma_size(crtc, 256);
930 drm_object_attach_property(&connector->base,
931 dev_priv->hotplug_mode_update_property, 1);
932 drm_object_attach_property(&connector->base,
933 dev->mode_config.suggested_x_property, 0);
934 drm_object_attach_property(&connector->base,
935 dev->mode_config.suggested_y_property, 0);
939 drm_connector_unregister(connector);
941 drm_encoder_cleanup(encoder);
943 drm_connector_cleanup(connector);
949 int vmw_kms_sou_init_display(struct vmw_private *dev_priv)
951 struct drm_device *dev = dev_priv->dev;
954 if (!(dev_priv->capabilities & SVGA_CAP_SCREEN_OBJECT_2)) {
955 DRM_INFO("Not using screen objects,"
956 " missing cap SCREEN_OBJECT_2\n");
962 ret = drm_vblank_init(dev, VMWGFX_NUM_DISPLAY_UNITS);
963 if (unlikely(ret != 0))
966 for (i = 0; i < VMWGFX_NUM_DISPLAY_UNITS; ++i)
967 vmw_sou_init(dev_priv, i);
969 dev_priv->active_display_unit = vmw_du_screen_object;
971 DRM_INFO("Screen Objects Display Unit initialized\n");
976 static int do_bo_define_gmrfb(struct vmw_private *dev_priv,
977 struct vmw_framebuffer *framebuffer)
979 struct vmw_buffer_object *buf =
980 container_of(framebuffer, struct vmw_framebuffer_bo,
982 int depth = framebuffer->base.format->depth;
985 SVGAFifoCmdDefineGMRFB body;
988 /* Emulate RGBA support, contrary to svga_reg.h this is not
989 * supported by hosts. This is only a problem if we are reading
990 * this value later and expecting what we uploaded back.
995 cmd = VMW_FIFO_RESERVE(dev_priv, sizeof(*cmd));
999 cmd->header = SVGA_CMD_DEFINE_GMRFB;
1000 cmd->body.format.bitsPerPixel = framebuffer->base.format->cpp[0] * 8;
1001 cmd->body.format.colorDepth = depth;
1002 cmd->body.format.reserved = 0;
1003 cmd->body.bytesPerLine = framebuffer->base.pitches[0];
1004 /* Buffer is reserved in vram or GMR */
1005 vmw_bo_get_guest_ptr(&buf->base, &cmd->body.ptr);
1006 vmw_fifo_commit(dev_priv, sizeof(*cmd));
1012 * vmw_sou_surface_fifo_commit - Callback to fill in and submit a
1013 * blit surface to screen command.
1015 * @dirty: The closure structure.
1017 * Fills in the missing fields in the command, and translates the cliprects
1018 * to match the destination bounding box encoded.
1020 static void vmw_sou_surface_fifo_commit(struct vmw_kms_dirty *dirty)
1022 struct vmw_kms_sou_surface_dirty *sdirty =
1023 container_of(dirty, typeof(*sdirty), base);
1024 struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
1025 s32 trans_x = dirty->unit->crtc.x - sdirty->dst_x;
1026 s32 trans_y = dirty->unit->crtc.y - sdirty->dst_y;
1027 size_t region_size = dirty->num_hits * sizeof(SVGASignedRect);
1028 SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
1031 if (!dirty->num_hits) {
1032 vmw_fifo_commit(dirty->dev_priv, 0);
1036 cmd->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
1037 cmd->header.size = sizeof(cmd->body) + region_size;
1040 * Use the destination bounding box to specify destination - and
1041 * source bounding regions.
1043 cmd->body.destRect.left = sdirty->left;
1044 cmd->body.destRect.right = sdirty->right;
1045 cmd->body.destRect.top = sdirty->top;
1046 cmd->body.destRect.bottom = sdirty->bottom;
1048 cmd->body.srcRect.left = sdirty->left + trans_x;
1049 cmd->body.srcRect.right = sdirty->right + trans_x;
1050 cmd->body.srcRect.top = sdirty->top + trans_y;
1051 cmd->body.srcRect.bottom = sdirty->bottom + trans_y;
1053 cmd->body.srcImage.sid = sdirty->sid;
1054 cmd->body.destScreenId = dirty->unit->unit;
1056 /* Blits are relative to the destination rect. Translate. */
1057 for (i = 0; i < dirty->num_hits; ++i, ++blit) {
1058 blit->left -= sdirty->left;
1059 blit->right -= sdirty->left;
1060 blit->top -= sdirty->top;
1061 blit->bottom -= sdirty->top;
1064 vmw_fifo_commit(dirty->dev_priv, region_size + sizeof(*cmd));
1066 sdirty->left = sdirty->top = S32_MAX;
1067 sdirty->right = sdirty->bottom = S32_MIN;
1071 * vmw_sou_surface_clip - Callback to encode a blit surface to screen cliprect.
1073 * @dirty: The closure structure
1075 * Encodes a SVGASignedRect cliprect and updates the bounding box of the
1076 * BLIT_SURFACE_TO_SCREEN command.
1078 static void vmw_sou_surface_clip(struct vmw_kms_dirty *dirty)
1080 struct vmw_kms_sou_surface_dirty *sdirty =
1081 container_of(dirty, typeof(*sdirty), base);
1082 struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
1083 SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
1085 /* Destination rect. */
1086 blit += dirty->num_hits;
1087 blit->left = dirty->unit_x1;
1088 blit->top = dirty->unit_y1;
1089 blit->right = dirty->unit_x2;
1090 blit->bottom = dirty->unit_y2;
1092 /* Destination bounding box */
1093 sdirty->left = min_t(s32, sdirty->left, dirty->unit_x1);
1094 sdirty->top = min_t(s32, sdirty->top, dirty->unit_y1);
1095 sdirty->right = max_t(s32, sdirty->right, dirty->unit_x2);
1096 sdirty->bottom = max_t(s32, sdirty->bottom, dirty->unit_y2);
1102 * vmw_kms_sou_do_surface_dirty - Dirty part of a surface backed framebuffer
1104 * @dev_priv: Pointer to the device private structure.
1105 * @framebuffer: Pointer to the surface-buffer backed framebuffer.
1106 * @clips: Array of clip rects. Either @clips or @vclips must be NULL.
1107 * @vclips: Alternate array of clip rects. Either @clips or @vclips must
1109 * @srf: Pointer to surface to blit from. If NULL, the surface attached
1110 * to @framebuffer will be used.
1111 * @dest_x: X coordinate offset to align @srf with framebuffer coordinates.
1112 * @dest_y: Y coordinate offset to align @srf with framebuffer coordinates.
1113 * @num_clips: Number of clip rects in @clips.
1114 * @inc: Increment to use when looping over @clips.
1115 * @out_fence: If non-NULL, will return a ref-counted pointer to a
1116 * struct vmw_fence_obj. The returned fence pointer may be NULL in which
1117 * case the device has already synchronized.
1118 * @crtc: If crtc is passed, perform surface dirty on that crtc only.
1120 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1123 int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
1124 struct vmw_framebuffer *framebuffer,
1125 struct drm_clip_rect *clips,
1126 struct drm_vmw_rect *vclips,
1127 struct vmw_resource *srf,
1130 unsigned num_clips, int inc,
1131 struct vmw_fence_obj **out_fence,
1132 struct drm_crtc *crtc)
1134 struct vmw_framebuffer_surface *vfbs =
1135 container_of(framebuffer, typeof(*vfbs), base);
1136 struct vmw_kms_sou_surface_dirty sdirty;
1137 DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1141 srf = &vfbs->surface->res;
1143 ret = vmw_validation_add_resource(&val_ctx, srf, 0, VMW_RES_DIRTY_NONE,
1148 ret = vmw_validation_prepare(&val_ctx, &dev_priv->cmdbuf_mutex, true);
1152 sdirty.base.fifo_commit = vmw_sou_surface_fifo_commit;
1153 sdirty.base.clip = vmw_sou_surface_clip;
1154 sdirty.base.dev_priv = dev_priv;
1155 sdirty.base.fifo_reserve_size = sizeof(struct vmw_kms_sou_dirty_cmd) +
1156 sizeof(SVGASignedRect) * num_clips;
1157 sdirty.base.crtc = crtc;
1159 sdirty.sid = srf->id;
1160 sdirty.left = sdirty.top = S32_MAX;
1161 sdirty.right = sdirty.bottom = S32_MIN;
1162 sdirty.dst_x = dest_x;
1163 sdirty.dst_y = dest_y;
1165 ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1166 dest_x, dest_y, num_clips, inc,
1168 vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
1174 vmw_validation_unref_lists(&val_ctx);
1179 * vmw_sou_bo_fifo_commit - Callback to submit a set of readback clips.
1181 * @dirty: The closure structure.
1183 * Commits a previously built command buffer of readback clips.
1185 static void vmw_sou_bo_fifo_commit(struct vmw_kms_dirty *dirty)
1187 if (!dirty->num_hits) {
1188 vmw_fifo_commit(dirty->dev_priv, 0);
1192 vmw_fifo_commit(dirty->dev_priv,
1193 sizeof(struct vmw_kms_sou_bo_blit) *
1198 * vmw_sou_bo_clip - Callback to encode a readback cliprect.
1200 * @dirty: The closure structure
1202 * Encodes a BLIT_GMRFB_TO_SCREEN cliprect.
1204 static void vmw_sou_bo_clip(struct vmw_kms_dirty *dirty)
1206 struct vmw_kms_sou_bo_blit *blit = dirty->cmd;
1208 blit += dirty->num_hits;
1209 blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
1210 blit->body.destScreenId = dirty->unit->unit;
1211 blit->body.srcOrigin.x = dirty->fb_x;
1212 blit->body.srcOrigin.y = dirty->fb_y;
1213 blit->body.destRect.left = dirty->unit_x1;
1214 blit->body.destRect.top = dirty->unit_y1;
1215 blit->body.destRect.right = dirty->unit_x2;
1216 blit->body.destRect.bottom = dirty->unit_y2;
1221 * vmw_kms_do_bo_dirty - Dirty part of a buffer-object backed framebuffer
1223 * @dev_priv: Pointer to the device private structure.
1224 * @framebuffer: Pointer to the buffer-object backed framebuffer.
1225 * @clips: Array of clip rects.
1226 * @vclips: Alternate array of clip rects. Either @clips or @vclips must
1228 * @num_clips: Number of clip rects in @clips.
1229 * @increment: Increment to use when looping over @clips.
1230 * @interruptible: Whether to perform waits interruptible if possible.
1231 * @out_fence: If non-NULL, will return a ref-counted pointer to a
1232 * struct vmw_fence_obj. The returned fence pointer may be NULL in which
1233 * case the device has already synchronized.
1234 * @crtc: If crtc is passed, perform bo dirty on that crtc only.
1236 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1239 int vmw_kms_sou_do_bo_dirty(struct vmw_private *dev_priv,
1240 struct vmw_framebuffer *framebuffer,
1241 struct drm_clip_rect *clips,
1242 struct drm_vmw_rect *vclips,
1243 unsigned num_clips, int increment,
1245 struct vmw_fence_obj **out_fence,
1246 struct drm_crtc *crtc)
1248 struct vmw_buffer_object *buf =
1249 container_of(framebuffer, struct vmw_framebuffer_bo,
1251 struct vmw_kms_dirty dirty;
1252 DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1255 ret = vmw_validation_add_bo(&val_ctx, buf, false, false);
1259 ret = vmw_validation_prepare(&val_ctx, NULL, interruptible);
1263 ret = do_bo_define_gmrfb(dev_priv, framebuffer);
1264 if (unlikely(ret != 0))
1268 dirty.fifo_commit = vmw_sou_bo_fifo_commit;
1269 dirty.clip = vmw_sou_bo_clip;
1270 dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_bo_blit) *
1272 ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1273 0, 0, num_clips, increment, &dirty);
1274 vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
1280 vmw_validation_revert(&val_ctx);
1282 vmw_validation_unref_lists(&val_ctx);
1289 * vmw_sou_readback_fifo_commit - Callback to submit a set of readback clips.
1291 * @dirty: The closure structure.
1293 * Commits a previously built command buffer of readback clips.
1295 static void vmw_sou_readback_fifo_commit(struct vmw_kms_dirty *dirty)
1297 if (!dirty->num_hits) {
1298 vmw_fifo_commit(dirty->dev_priv, 0);
1302 vmw_fifo_commit(dirty->dev_priv,
1303 sizeof(struct vmw_kms_sou_readback_blit) *
1308 * vmw_sou_readback_clip - Callback to encode a readback cliprect.
1310 * @dirty: The closure structure
1312 * Encodes a BLIT_SCREEN_TO_GMRFB cliprect.
1314 static void vmw_sou_readback_clip(struct vmw_kms_dirty *dirty)
1316 struct vmw_kms_sou_readback_blit *blit = dirty->cmd;
1318 blit += dirty->num_hits;
1319 blit->header = SVGA_CMD_BLIT_SCREEN_TO_GMRFB;
1320 blit->body.srcScreenId = dirty->unit->unit;
1321 blit->body.destOrigin.x = dirty->fb_x;
1322 blit->body.destOrigin.y = dirty->fb_y;
1323 blit->body.srcRect.left = dirty->unit_x1;
1324 blit->body.srcRect.top = dirty->unit_y1;
1325 blit->body.srcRect.right = dirty->unit_x2;
1326 blit->body.srcRect.bottom = dirty->unit_y2;
1331 * vmw_kms_sou_readback - Perform a readback from the screen object system to
1332 * a buffer-object backed framebuffer.
1334 * @dev_priv: Pointer to the device private structure.
1335 * @file_priv: Pointer to a struct drm_file identifying the caller.
1336 * Must be set to NULL if @user_fence_rep is NULL.
1337 * @vfb: Pointer to the buffer-object backed framebuffer.
1338 * @user_fence_rep: User-space provided structure for fence information.
1339 * Must be set to non-NULL if @file_priv is non-NULL.
1340 * @vclips: Array of clip rects.
1341 * @num_clips: Number of clip rects in @vclips.
1342 * @crtc: If crtc is passed, readback on that crtc only.
1344 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1347 int vmw_kms_sou_readback(struct vmw_private *dev_priv,
1348 struct drm_file *file_priv,
1349 struct vmw_framebuffer *vfb,
1350 struct drm_vmw_fence_rep __user *user_fence_rep,
1351 struct drm_vmw_rect *vclips,
1353 struct drm_crtc *crtc)
1355 struct vmw_buffer_object *buf =
1356 container_of(vfb, struct vmw_framebuffer_bo, base)->buffer;
1357 struct vmw_kms_dirty dirty;
1358 DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1361 ret = vmw_validation_add_bo(&val_ctx, buf, false, false);
1365 ret = vmw_validation_prepare(&val_ctx, NULL, true);
1369 ret = do_bo_define_gmrfb(dev_priv, vfb);
1370 if (unlikely(ret != 0))
1374 dirty.fifo_commit = vmw_sou_readback_fifo_commit;
1375 dirty.clip = vmw_sou_readback_clip;
1376 dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_readback_blit) *
1378 ret = vmw_kms_helper_dirty(dev_priv, vfb, NULL, vclips,
1379 0, 0, num_clips, 1, &dirty);
1380 vmw_kms_helper_validation_finish(dev_priv, file_priv, &val_ctx, NULL,
1386 vmw_validation_revert(&val_ctx);
1388 vmw_validation_unref_lists(&val_ctx);