1 /******************************************************************************
3 * COPYRIGHT © 2014-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 "device_include/svga3d_surfacedefs.h"
30 #include <drm/drm_plane_helper.h>
32 #define vmw_crtc_to_stdu(x) \
33 container_of(x, struct vmw_screen_target_display_unit, base.crtc)
34 #define vmw_encoder_to_stdu(x) \
35 container_of(x, struct vmw_screen_target_display_unit, base.encoder)
36 #define vmw_connector_to_stdu(x) \
37 container_of(x, struct vmw_screen_target_display_unit, base.connector)
41 enum stdu_content_type {
48 * struct vmw_stdu_dirty - closure structure for the update functions
50 * @base: The base type we derive from. Used by vmw_kms_helper_dirty().
51 * @transfer: Transfer direction for DMA command.
52 * @left: Left side of bounding box.
53 * @right: Right side of bounding box.
54 * @top: Top side of bounding box.
55 * @bottom: Bottom side of bounding box.
56 * @buf: DMA buffer when DMA-ing between buffer and screen targets.
57 * @sid: Surface ID when copying between surface and screen targets.
59 struct vmw_stdu_dirty {
60 struct vmw_kms_dirty base;
61 SVGA3dTransferType transfer;
62 s32 left, right, top, bottom;
65 struct vmw_dma_buffer *buf;
71 * SVGA commands that are used by this code. Please see the device headers
74 struct vmw_stdu_update {
75 SVGA3dCmdHeader header;
76 SVGA3dCmdUpdateGBScreenTarget body;
80 SVGA3dCmdHeader header;
81 SVGA3dCmdSurfaceDMA body;
84 struct vmw_stdu_surface_copy {
85 SVGA3dCmdHeader header;
86 SVGA3dCmdSurfaceCopy body;
91 * struct vmw_screen_target_display_unit
93 * @base: VMW specific DU structure
94 * @display_srf: surface to be displayed. The dimension of this will always
95 * match the display mode. If the display mode matches
96 * content_vfbs dimensions, then this is a pointer into the
97 * corresponding field in content_vfbs. If not, then this
98 * is a separate buffer to which content_vfbs will blit to.
99 * @content_type: content_fb type
100 * @defined: true if the current display unit has been initialized
102 struct vmw_screen_target_display_unit {
103 struct vmw_display_unit base;
105 struct vmw_surface *display_srf;
106 enum stdu_content_type content_fb_type;
113 static void vmw_stdu_destroy(struct vmw_screen_target_display_unit *stdu);
117 /******************************************************************************
118 * Screen Target Display Unit helper Functions
119 *****************************************************************************/
122 * vmw_stdu_unpin_display - unpins the resource associated with display surface
124 * @stdu: contains the display surface
126 * If the display surface was privatedly allocated by
127 * vmw_surface_gb_priv_define() and not registered as a framebuffer, then it
128 * won't be automatically cleaned up when all the framebuffers are freed. As
129 * such, we have to explicitly call vmw_resource_unreference() to get it freed.
131 static void vmw_stdu_unpin_display(struct vmw_screen_target_display_unit *stdu)
133 if (stdu->display_srf) {
134 struct vmw_resource *res = &stdu->display_srf->res;
136 vmw_resource_unpin(res);
137 vmw_surface_unreference(&stdu->display_srf);
143 /******************************************************************************
144 * Screen Target Display Unit CRTC Functions
145 *****************************************************************************/
149 * vmw_stdu_crtc_destroy - cleans up the STDU
151 * @crtc: used to get a reference to the containing STDU
153 static void vmw_stdu_crtc_destroy(struct drm_crtc *crtc)
155 vmw_stdu_destroy(vmw_crtc_to_stdu(crtc));
159 * vmw_stdu_define_st - Defines a Screen Target
161 * @dev_priv: VMW DRM device
162 * @stdu: display unit to create a Screen Target for
163 * @mode: The mode to set.
164 * @crtc_x: X coordinate of screen target relative to framebuffer origin.
165 * @crtc_y: Y coordinate of screen target relative to framebuffer origin.
167 * Creates a STDU that we can used later. This function is called whenever the
168 * framebuffer size changes.
171 * 0 on success, error code on failure
173 static int vmw_stdu_define_st(struct vmw_private *dev_priv,
174 struct vmw_screen_target_display_unit *stdu,
175 struct drm_display_mode *mode,
176 int crtc_x, int crtc_y)
179 SVGA3dCmdHeader header;
180 SVGA3dCmdDefineGBScreenTarget body;
183 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
185 if (unlikely(cmd == NULL)) {
186 DRM_ERROR("Out of FIFO space defining Screen Target\n");
190 cmd->header.id = SVGA_3D_CMD_DEFINE_GB_SCREENTARGET;
191 cmd->header.size = sizeof(cmd->body);
193 cmd->body.stid = stdu->base.unit;
194 cmd->body.width = mode->hdisplay;
195 cmd->body.height = mode->vdisplay;
196 cmd->body.flags = (0 == cmd->body.stid) ? SVGA_STFLAG_PRIMARY : 0;
198 if (stdu->base.is_implicit) {
199 cmd->body.xRoot = crtc_x;
200 cmd->body.yRoot = crtc_y;
202 cmd->body.xRoot = stdu->base.gui_x;
203 cmd->body.yRoot = stdu->base.gui_y;
205 stdu->base.set_gui_x = cmd->body.xRoot;
206 stdu->base.set_gui_y = cmd->body.yRoot;
208 vmw_fifo_commit(dev_priv, sizeof(*cmd));
210 stdu->defined = true;
218 * vmw_stdu_bind_st - Binds a surface to a Screen Target
220 * @dev_priv: VMW DRM device
221 * @stdu: display unit affected
222 * @res: Buffer to bind to the screen target. Set to NULL to blank screen.
224 * Binding a surface to a Screen Target the same as flipping
226 static int vmw_stdu_bind_st(struct vmw_private *dev_priv,
227 struct vmw_screen_target_display_unit *stdu,
228 struct vmw_resource *res)
230 SVGA3dSurfaceImageId image;
233 SVGA3dCmdHeader header;
234 SVGA3dCmdBindGBScreenTarget body;
238 if (!stdu->defined) {
239 DRM_ERROR("No screen target defined\n");
243 /* Set up image using information in vfb */
244 memset(&image, 0, sizeof(image));
245 image.sid = res ? res->id : SVGA3D_INVALID_ID;
247 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
249 if (unlikely(cmd == NULL)) {
250 DRM_ERROR("Out of FIFO space binding a screen target\n");
254 cmd->header.id = SVGA_3D_CMD_BIND_GB_SCREENTARGET;
255 cmd->header.size = sizeof(cmd->body);
257 cmd->body.stid = stdu->base.unit;
258 cmd->body.image = image;
260 vmw_fifo_commit(dev_priv, sizeof(*cmd));
266 * vmw_stdu_populate_update - populate an UPDATE_GB_SCREENTARGET command with a
269 * @cmd: Pointer to command stream.
270 * @unit: Screen target unit.
271 * @left: Left side of bounding box.
272 * @right: Right side of bounding box.
273 * @top: Top side of bounding box.
274 * @bottom: Bottom side of bounding box.
276 static void vmw_stdu_populate_update(void *cmd, int unit,
277 s32 left, s32 right, s32 top, s32 bottom)
279 struct vmw_stdu_update *update = cmd;
281 update->header.id = SVGA_3D_CMD_UPDATE_GB_SCREENTARGET;
282 update->header.size = sizeof(update->body);
284 update->body.stid = unit;
285 update->body.rect.x = left;
286 update->body.rect.y = top;
287 update->body.rect.w = right - left;
288 update->body.rect.h = bottom - top;
292 * vmw_stdu_update_st - Full update of a Screen Target
294 * @dev_priv: VMW DRM device
295 * @stdu: display unit affected
297 * This function needs to be called whenever the content of a screen
298 * target has changed completely. Typically as a result of a backing
302 * 0 on success, error code on failure
304 static int vmw_stdu_update_st(struct vmw_private *dev_priv,
305 struct vmw_screen_target_display_unit *stdu)
307 struct vmw_stdu_update *cmd;
308 struct drm_crtc *crtc = &stdu->base.crtc;
310 if (!stdu->defined) {
311 DRM_ERROR("No screen target defined");
315 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
317 if (unlikely(cmd == NULL)) {
318 DRM_ERROR("Out of FIFO space updating a Screen Target\n");
322 vmw_stdu_populate_update(cmd, stdu->base.unit, 0, crtc->mode.hdisplay,
323 0, crtc->mode.vdisplay);
325 vmw_fifo_commit(dev_priv, sizeof(*cmd));
333 * vmw_stdu_destroy_st - Destroy a Screen Target
335 * @dev_priv: VMW DRM device
336 * @stdu: display unit to destroy
338 static int vmw_stdu_destroy_st(struct vmw_private *dev_priv,
339 struct vmw_screen_target_display_unit *stdu)
344 SVGA3dCmdHeader header;
345 SVGA3dCmdDestroyGBScreenTarget body;
349 /* Nothing to do if not successfully defined */
350 if (unlikely(!stdu->defined))
353 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
355 if (unlikely(cmd == NULL)) {
356 DRM_ERROR("Out of FIFO space, screen target not destroyed\n");
360 cmd->header.id = SVGA_3D_CMD_DESTROY_GB_SCREENTARGET;
361 cmd->header.size = sizeof(cmd->body);
363 cmd->body.stid = stdu->base.unit;
365 vmw_fifo_commit(dev_priv, sizeof(*cmd));
368 ret = vmw_fallback_wait(dev_priv, false, true, 0, false, 3*HZ);
369 if (unlikely(ret != 0))
370 DRM_ERROR("Failed to sync with HW");
372 stdu->defined = false;
378 * vmw_stdu_bind_fb - Bind an fb to a defined screen target
380 * @dev_priv: Pointer to a device private struct.
381 * @crtc: The crtc holding the screen target.
382 * @mode: The mode currently used by the screen target. Must be non-NULL.
383 * @new_fb: The new framebuffer to bind. Must be non-NULL.
386 * 0 on success, error code on failure.
388 static int vmw_stdu_bind_fb(struct vmw_private *dev_priv,
389 struct drm_crtc *crtc,
390 struct drm_display_mode *mode,
391 struct drm_framebuffer *new_fb)
393 struct vmw_screen_target_display_unit *stdu = vmw_crtc_to_stdu(crtc);
394 struct vmw_framebuffer *vfb = vmw_framebuffer_to_vfb(new_fb);
395 struct vmw_surface *new_display_srf = NULL;
396 enum stdu_content_type new_content_type;
397 struct vmw_framebuffer_surface *new_vfbs;
400 WARN_ON_ONCE(!stdu->defined);
402 new_vfbs = (vfb->dmabuf) ? NULL : vmw_framebuffer_to_vfbs(new_fb);
404 if (new_vfbs && new_vfbs->surface->base_size.width == mode->hdisplay &&
405 new_vfbs->surface->base_size.height == mode->vdisplay)
406 new_content_type = SAME_AS_DISPLAY;
407 else if (vfb->dmabuf)
408 new_content_type = SEPARATE_DMA;
410 new_content_type = SEPARATE_SURFACE;
412 if (new_content_type != SAME_AS_DISPLAY &&
413 !stdu->display_srf) {
414 struct vmw_surface content_srf;
415 struct drm_vmw_size display_base_size = {0};
417 display_base_size.width = mode->hdisplay;
418 display_base_size.height = mode->vdisplay;
419 display_base_size.depth = 1;
422 * If content buffer is a DMA buf, then we have to construct
425 if (new_content_type == SEPARATE_DMA) {
427 switch (new_fb->format->cpp[0] * 8) {
429 content_srf.format = SVGA3D_X8R8G8B8;
433 content_srf.format = SVGA3D_R5G6B5;
437 content_srf.format = SVGA3D_P8;
441 DRM_ERROR("Invalid format\n");
445 content_srf.flags = 0;
446 content_srf.mip_levels[0] = 1;
447 content_srf.multisample_count = 0;
449 content_srf = *new_vfbs->surface;
453 ret = vmw_surface_gb_priv_define(crtc->dev,
454 0, /* because kernel visible only */
457 true, /* a scanout buffer */
458 content_srf.mip_levels[0],
459 content_srf.multisample_count,
463 if (unlikely(ret != 0)) {
464 DRM_ERROR("Could not allocate screen target surface.\n");
467 } else if (new_content_type == SAME_AS_DISPLAY) {
468 new_display_srf = vmw_surface_reference(new_vfbs->surface);
471 if (new_display_srf) {
472 /* Pin new surface before flipping */
473 ret = vmw_resource_pin(&new_display_srf->res, false);
477 ret = vmw_stdu_bind_st(dev_priv, stdu, &new_display_srf->res);
481 /* Unpin and unreference old surface */
482 vmw_stdu_unpin_display(stdu);
484 /* Transfer the reference */
485 stdu->display_srf = new_display_srf;
486 new_display_srf = NULL;
489 crtc->primary->fb = new_fb;
490 stdu->content_fb_type = new_content_type;
494 vmw_resource_unpin(&new_display_srf->res);
496 vmw_surface_unreference(&new_display_srf);
501 * vmw_stdu_crtc_set_config - Sets a mode
503 * @set: mode parameters
505 * This function is the device-specific portion of the DRM CRTC mode set.
506 * For the SVGA device, we do this by defining a Screen Target, binding a
507 * GB Surface to that target, and finally update the screen target.
510 * 0 on success, error code otherwise
512 static int vmw_stdu_crtc_set_config(struct drm_mode_set *set,
513 struct drm_modeset_acquire_ctx *ctx)
515 struct vmw_private *dev_priv;
516 struct vmw_framebuffer *vfb;
517 struct vmw_screen_target_display_unit *stdu;
518 struct drm_display_mode *mode;
519 struct drm_framebuffer *new_fb;
520 struct drm_crtc *crtc;
521 struct drm_encoder *encoder;
522 struct drm_connector *connector;
527 if (!set || !set->crtc)
531 stdu = vmw_crtc_to_stdu(crtc);
534 dev_priv = vmw_priv(crtc->dev);
535 turning_off = set->num_connectors == 0 || !mode || !new_fb;
536 vfb = (new_fb) ? vmw_framebuffer_to_vfb(new_fb) : NULL;
538 if (set->num_connectors > 1) {
539 DRM_ERROR("Too many connectors\n");
543 if (set->num_connectors == 1 &&
544 set->connectors[0] != &stdu->base.connector) {
545 DRM_ERROR("Connectors don't match %p %p\n",
546 set->connectors[0], &stdu->base.connector);
550 if (!turning_off && (set->x + mode->hdisplay > new_fb->width ||
551 set->y + mode->vdisplay > new_fb->height)) {
552 DRM_ERROR("Set outside of framebuffer\n");
556 /* Only one active implicit frame-buffer at a time. */
557 mutex_lock(&dev_priv->global_kms_state_mutex);
558 if (!turning_off && stdu->base.is_implicit && dev_priv->implicit_fb &&
559 !(dev_priv->num_implicit == 1 && stdu->base.active_implicit)
560 && dev_priv->implicit_fb != vfb) {
561 mutex_unlock(&dev_priv->global_kms_state_mutex);
562 DRM_ERROR("Multiple implicit framebuffers not supported.\n");
565 mutex_unlock(&dev_priv->global_kms_state_mutex);
567 /* Since they always map one to one these are safe */
568 connector = &stdu->base.connector;
569 encoder = &stdu->base.encoder;
572 ret = vmw_stdu_bind_st(dev_priv, stdu, NULL);
576 vmw_stdu_unpin_display(stdu);
577 (void) vmw_stdu_update_st(dev_priv, stdu);
578 vmw_kms_del_active(dev_priv, &stdu->base);
580 ret = vmw_stdu_destroy_st(dev_priv, stdu);
584 crtc->primary->fb = NULL;
585 crtc->enabled = false;
586 encoder->crtc = NULL;
587 connector->encoder = NULL;
588 stdu->content_fb_type = SAME_AS_DISPLAY;
597 * Steps to displaying a surface, assume surface is already
599 * 1. define a screen target
600 * 2. bind a fb to the screen target
601 * 3. update that screen target (this is done later by
602 * vmw_kms_stdu_do_surface_dirty_or_present)
605 * Note on error handling: We can't really restore the crtc to
606 * it's original state on error, but we at least update the
607 * current state to what's submitted to hardware to enable
610 vmw_svga_enable(dev_priv);
611 ret = vmw_stdu_define_st(dev_priv, stdu, mode, set->x, set->y);
619 ret = vmw_stdu_bind_fb(dev_priv, crtc, mode, new_fb);
623 vmw_kms_add_active(dev_priv, &stdu->base, vfb);
624 crtc->enabled = true;
625 connector->encoder = encoder;
626 encoder->crtc = crtc;
632 * vmw_stdu_crtc_page_flip - Binds a buffer to a screen target
634 * @crtc: CRTC to attach FB to
636 * @event: Event to be posted. This event should've been alloced
637 * using k[mz]alloc, and should've been completely initialized.
638 * @page_flip_flags: Input flags.
640 * If the STDU uses the same display and content buffers, i.e. a true flip,
641 * this function will replace the existing display buffer with the new content
644 * If the STDU uses different display and content buffers, i.e. a blit, then
645 * only the content buffer will be updated.
648 * 0 on success, error code on failure
650 static int vmw_stdu_crtc_page_flip(struct drm_crtc *crtc,
651 struct drm_framebuffer *new_fb,
652 struct drm_pending_vblank_event *event,
654 struct drm_modeset_acquire_ctx *ctx)
657 struct vmw_private *dev_priv = vmw_priv(crtc->dev);
658 struct vmw_screen_target_display_unit *stdu;
659 struct drm_vmw_rect vclips;
660 struct vmw_framebuffer *vfb = vmw_framebuffer_to_vfb(new_fb);
663 dev_priv = vmw_priv(crtc->dev);
664 stdu = vmw_crtc_to_stdu(crtc);
666 if (!stdu->defined || !vmw_kms_crtc_flippable(dev_priv, crtc))
669 ret = vmw_stdu_bind_fb(dev_priv, crtc, &crtc->mode, new_fb);
673 if (stdu->base.is_implicit)
674 vmw_kms_update_implicit_fb(dev_priv, crtc);
678 vclips.w = crtc->mode.hdisplay;
679 vclips.h = crtc->mode.vdisplay;
681 ret = vmw_kms_stdu_dma(dev_priv, NULL, vfb, NULL, NULL, &vclips,
684 ret = vmw_kms_stdu_surface_dirty(dev_priv, vfb, NULL, &vclips,
685 NULL, 0, 0, 1, 1, NULL);
690 struct vmw_fence_obj *fence = NULL;
691 struct drm_file *file_priv = event->base.file_priv;
693 vmw_execbuf_fence_commands(NULL, dev_priv, &fence, NULL);
697 ret = vmw_event_fence_action_queue(file_priv, fence,
699 &event->event.tv_sec,
700 &event->event.tv_usec,
702 vmw_fence_obj_unreference(&fence);
704 vmw_fifo_flush(dev_priv, false);
712 * vmw_stdu_dmabuf_clip - Callback to encode a suface DMA command cliprect
714 * @dirty: The closure structure.
716 * Encodes a surface DMA command cliprect and updates the bounding box
719 static void vmw_stdu_dmabuf_clip(struct vmw_kms_dirty *dirty)
721 struct vmw_stdu_dirty *ddirty =
722 container_of(dirty, struct vmw_stdu_dirty, base);
723 struct vmw_stdu_dma *cmd = dirty->cmd;
724 struct SVGA3dCopyBox *blit = (struct SVGA3dCopyBox *) &cmd[1];
726 blit += dirty->num_hits;
727 blit->srcx = dirty->fb_x;
728 blit->srcy = dirty->fb_y;
729 blit->x = dirty->unit_x1;
730 blit->y = dirty->unit_y1;
732 blit->w = dirty->unit_x2 - dirty->unit_x1;
733 blit->h = dirty->unit_y2 - dirty->unit_y1;
736 if (ddirty->transfer != SVGA3D_WRITE_HOST_VRAM)
739 /* Destination bounding box */
740 ddirty->left = min_t(s32, ddirty->left, dirty->unit_x1);
741 ddirty->top = min_t(s32, ddirty->top, dirty->unit_y1);
742 ddirty->right = max_t(s32, ddirty->right, dirty->unit_x2);
743 ddirty->bottom = max_t(s32, ddirty->bottom, dirty->unit_y2);
747 * vmw_stdu_dmabuf_fifo_commit - Callback to fill in and submit a DMA command.
749 * @dirty: The closure structure.
751 * Fills in the missing fields in a DMA command, and optionally encodes
752 * a screen target update command, depending on transfer direction.
754 static void vmw_stdu_dmabuf_fifo_commit(struct vmw_kms_dirty *dirty)
756 struct vmw_stdu_dirty *ddirty =
757 container_of(dirty, struct vmw_stdu_dirty, base);
758 struct vmw_screen_target_display_unit *stdu =
759 container_of(dirty->unit, typeof(*stdu), base);
760 struct vmw_stdu_dma *cmd = dirty->cmd;
761 struct SVGA3dCopyBox *blit = (struct SVGA3dCopyBox *) &cmd[1];
762 SVGA3dCmdSurfaceDMASuffix *suffix =
763 (SVGA3dCmdSurfaceDMASuffix *) &blit[dirty->num_hits];
764 size_t blit_size = sizeof(*blit) * dirty->num_hits + sizeof(*suffix);
766 if (!dirty->num_hits) {
767 vmw_fifo_commit(dirty->dev_priv, 0);
771 cmd->header.id = SVGA_3D_CMD_SURFACE_DMA;
772 cmd->header.size = sizeof(cmd->body) + blit_size;
773 vmw_bo_get_guest_ptr(&ddirty->buf->base, &cmd->body.guest.ptr);
774 cmd->body.guest.pitch = ddirty->pitch;
775 cmd->body.host.sid = stdu->display_srf->res.id;
776 cmd->body.host.face = 0;
777 cmd->body.host.mipmap = 0;
778 cmd->body.transfer = ddirty->transfer;
779 suffix->suffixSize = sizeof(*suffix);
780 suffix->maximumOffset = ddirty->buf->base.num_pages * PAGE_SIZE;
782 if (ddirty->transfer == SVGA3D_WRITE_HOST_VRAM) {
783 blit_size += sizeof(struct vmw_stdu_update);
785 vmw_stdu_populate_update(&suffix[1], stdu->base.unit,
786 ddirty->left, ddirty->right,
787 ddirty->top, ddirty->bottom);
790 vmw_fifo_commit(dirty->dev_priv, sizeof(*cmd) + blit_size);
792 ddirty->left = ddirty->top = S32_MAX;
793 ddirty->right = ddirty->bottom = S32_MIN;
797 * vmw_kms_stdu_dma - Perform a DMA transfer between a dma-buffer backed
798 * framebuffer and the screen target system.
800 * @dev_priv: Pointer to the device private structure.
801 * @file_priv: Pointer to a struct drm-file identifying the caller. May be
802 * set to NULL, but then @user_fence_rep must also be set to NULL.
803 * @vfb: Pointer to the dma-buffer backed framebuffer.
804 * @clips: Array of clip rects. Either @clips or @vclips must be NULL.
805 * @vclips: Alternate array of clip rects. Either @clips or @vclips must
807 * @num_clips: Number of clip rects in @clips or @vclips.
808 * @increment: Increment to use when looping over @clips or @vclips.
809 * @to_surface: Whether to DMA to the screen target system as opposed to
810 * from the screen target system.
811 * @interruptible: Whether to perform waits interruptible if possible.
813 * If DMA-ing till the screen target system, the function will also notify
814 * the screen target system that a bounding box of the cliprects has been
816 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
819 int vmw_kms_stdu_dma(struct vmw_private *dev_priv,
820 struct drm_file *file_priv,
821 struct vmw_framebuffer *vfb,
822 struct drm_vmw_fence_rep __user *user_fence_rep,
823 struct drm_clip_rect *clips,
824 struct drm_vmw_rect *vclips,
830 struct vmw_dma_buffer *buf =
831 container_of(vfb, struct vmw_framebuffer_dmabuf, base)->buffer;
832 struct vmw_stdu_dirty ddirty;
835 ret = vmw_kms_helper_buffer_prepare(dev_priv, buf, interruptible,
840 ddirty.transfer = (to_surface) ? SVGA3D_WRITE_HOST_VRAM :
841 SVGA3D_READ_HOST_VRAM;
842 ddirty.left = ddirty.top = S32_MAX;
843 ddirty.right = ddirty.bottom = S32_MIN;
844 ddirty.pitch = vfb->base.pitches[0];
846 ddirty.base.fifo_commit = vmw_stdu_dmabuf_fifo_commit;
847 ddirty.base.clip = vmw_stdu_dmabuf_clip;
848 ddirty.base.fifo_reserve_size = sizeof(struct vmw_stdu_dma) +
849 num_clips * sizeof(SVGA3dCopyBox) +
850 sizeof(SVGA3dCmdSurfaceDMASuffix);
852 ddirty.base.fifo_reserve_size += sizeof(struct vmw_stdu_update);
854 ret = vmw_kms_helper_dirty(dev_priv, vfb, clips, vclips,
855 0, 0, num_clips, increment, &ddirty.base);
856 vmw_kms_helper_buffer_finish(dev_priv, file_priv, buf, NULL,
863 * vmw_stdu_surface_clip - Callback to encode a surface copy command cliprect
865 * @dirty: The closure structure.
867 * Encodes a surface copy command cliprect and updates the bounding box
870 static void vmw_kms_stdu_surface_clip(struct vmw_kms_dirty *dirty)
872 struct vmw_stdu_dirty *sdirty =
873 container_of(dirty, struct vmw_stdu_dirty, base);
874 struct vmw_stdu_surface_copy *cmd = dirty->cmd;
875 struct vmw_screen_target_display_unit *stdu =
876 container_of(dirty->unit, typeof(*stdu), base);
878 if (sdirty->sid != stdu->display_srf->res.id) {
879 struct SVGA3dCopyBox *blit = (struct SVGA3dCopyBox *) &cmd[1];
881 blit += dirty->num_hits;
882 blit->srcx = dirty->fb_x;
883 blit->srcy = dirty->fb_y;
884 blit->x = dirty->unit_x1;
885 blit->y = dirty->unit_y1;
887 blit->w = dirty->unit_x2 - dirty->unit_x1;
888 blit->h = dirty->unit_y2 - dirty->unit_y1;
893 /* Destination bounding box */
894 sdirty->left = min_t(s32, sdirty->left, dirty->unit_x1);
895 sdirty->top = min_t(s32, sdirty->top, dirty->unit_y1);
896 sdirty->right = max_t(s32, sdirty->right, dirty->unit_x2);
897 sdirty->bottom = max_t(s32, sdirty->bottom, dirty->unit_y2);
901 * vmw_stdu_surface_fifo_commit - Callback to fill in and submit a surface
904 * @dirty: The closure structure.
906 * Fills in the missing fields in a surface copy command, and encodes a screen
907 * target update command.
909 static void vmw_kms_stdu_surface_fifo_commit(struct vmw_kms_dirty *dirty)
911 struct vmw_stdu_dirty *sdirty =
912 container_of(dirty, struct vmw_stdu_dirty, base);
913 struct vmw_screen_target_display_unit *stdu =
914 container_of(dirty->unit, typeof(*stdu), base);
915 struct vmw_stdu_surface_copy *cmd = dirty->cmd;
916 struct vmw_stdu_update *update;
917 size_t blit_size = sizeof(SVGA3dCopyBox) * dirty->num_hits;
920 if (!dirty->num_hits) {
921 vmw_fifo_commit(dirty->dev_priv, 0);
925 if (sdirty->sid != stdu->display_srf->res.id) {
926 struct SVGA3dCopyBox *blit = (struct SVGA3dCopyBox *) &cmd[1];
928 cmd->header.id = SVGA_3D_CMD_SURFACE_COPY;
929 cmd->header.size = sizeof(cmd->body) + blit_size;
930 cmd->body.src.sid = sdirty->sid;
931 cmd->body.dest.sid = stdu->display_srf->res.id;
932 update = (struct vmw_stdu_update *) &blit[dirty->num_hits];
933 commit_size = sizeof(*cmd) + blit_size + sizeof(*update);
936 commit_size = sizeof(*update);
939 vmw_stdu_populate_update(update, stdu->base.unit, sdirty->left,
940 sdirty->right, sdirty->top, sdirty->bottom);
942 vmw_fifo_commit(dirty->dev_priv, commit_size);
944 sdirty->left = sdirty->top = S32_MAX;
945 sdirty->right = sdirty->bottom = S32_MIN;
949 * vmw_kms_stdu_surface_dirty - Dirty part of a surface backed framebuffer
951 * @dev_priv: Pointer to the device private structure.
952 * @framebuffer: Pointer to the surface-buffer backed framebuffer.
953 * @clips: Array of clip rects. Either @clips or @vclips must be NULL.
954 * @vclips: Alternate array of clip rects. Either @clips or @vclips must
956 * @srf: Pointer to surface to blit from. If NULL, the surface attached
957 * to @framebuffer will be used.
958 * @dest_x: X coordinate offset to align @srf with framebuffer coordinates.
959 * @dest_y: Y coordinate offset to align @srf with framebuffer coordinates.
960 * @num_clips: Number of clip rects in @clips.
961 * @inc: Increment to use when looping over @clips.
962 * @out_fence: If non-NULL, will return a ref-counted pointer to a
963 * struct vmw_fence_obj. The returned fence pointer may be NULL in which
964 * case the device has already synchronized.
966 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
969 int vmw_kms_stdu_surface_dirty(struct vmw_private *dev_priv,
970 struct vmw_framebuffer *framebuffer,
971 struct drm_clip_rect *clips,
972 struct drm_vmw_rect *vclips,
973 struct vmw_resource *srf,
976 unsigned num_clips, int inc,
977 struct vmw_fence_obj **out_fence)
979 struct vmw_framebuffer_surface *vfbs =
980 container_of(framebuffer, typeof(*vfbs), base);
981 struct vmw_stdu_dirty sdirty;
985 srf = &vfbs->surface->res;
987 ret = vmw_kms_helper_resource_prepare(srf, true);
991 if (vfbs->is_dmabuf_proxy) {
992 ret = vmw_kms_update_proxy(srf, clips, num_clips, inc);
997 sdirty.base.fifo_commit = vmw_kms_stdu_surface_fifo_commit;
998 sdirty.base.clip = vmw_kms_stdu_surface_clip;
999 sdirty.base.fifo_reserve_size = sizeof(struct vmw_stdu_surface_copy) +
1000 sizeof(SVGA3dCopyBox) * num_clips +
1001 sizeof(struct vmw_stdu_update);
1002 sdirty.sid = srf->id;
1003 sdirty.left = sdirty.top = S32_MAX;
1004 sdirty.right = sdirty.bottom = S32_MIN;
1006 ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1007 dest_x, dest_y, num_clips, inc,
1010 vmw_kms_helper_resource_finish(srf, out_fence);
1017 * Screen Target CRTC dispatch table
1019 static const struct drm_crtc_funcs vmw_stdu_crtc_funcs = {
1020 .cursor_set2 = vmw_du_crtc_cursor_set2,
1021 .cursor_move = vmw_du_crtc_cursor_move,
1022 .gamma_set = vmw_du_crtc_gamma_set,
1023 .destroy = vmw_stdu_crtc_destroy,
1024 .set_config = vmw_stdu_crtc_set_config,
1025 .page_flip = vmw_stdu_crtc_page_flip,
1030 /******************************************************************************
1031 * Screen Target Display Unit Encoder Functions
1032 *****************************************************************************/
1035 * vmw_stdu_encoder_destroy - cleans up the STDU
1037 * @encoder: used the get the containing STDU
1039 * vmwgfx cleans up crtc/encoder/connector all at the same time so technically
1040 * this can be a no-op. Nevertheless, it doesn't hurt of have this in case
1041 * the common KMS code changes and somehow vmw_stdu_crtc_destroy() doesn't
1044 static void vmw_stdu_encoder_destroy(struct drm_encoder *encoder)
1046 vmw_stdu_destroy(vmw_encoder_to_stdu(encoder));
1049 static const struct drm_encoder_funcs vmw_stdu_encoder_funcs = {
1050 .destroy = vmw_stdu_encoder_destroy,
1055 /******************************************************************************
1056 * Screen Target Display Unit Connector Functions
1057 *****************************************************************************/
1060 * vmw_stdu_connector_destroy - cleans up the STDU
1062 * @connector: used to get the containing STDU
1064 * vmwgfx cleans up crtc/encoder/connector all at the same time so technically
1065 * this can be a no-op. Nevertheless, it doesn't hurt of have this in case
1066 * the common KMS code changes and somehow vmw_stdu_crtc_destroy() doesn't
1069 static void vmw_stdu_connector_destroy(struct drm_connector *connector)
1071 vmw_stdu_destroy(vmw_connector_to_stdu(connector));
1076 static const struct drm_connector_funcs vmw_stdu_connector_funcs = {
1077 .dpms = vmw_du_connector_dpms,
1078 .detect = vmw_du_connector_detect,
1079 .fill_modes = vmw_du_connector_fill_modes,
1080 .set_property = vmw_du_connector_set_property,
1081 .destroy = vmw_stdu_connector_destroy,
1087 * vmw_stdu_init - Sets up a Screen Target Display Unit
1089 * @dev_priv: VMW DRM device
1090 * @unit: unit number range from 0 to VMWGFX_NUM_DISPLAY_UNITS
1092 * This function is called once per CRTC, and allocates one Screen Target
1093 * display unit to represent that CRTC. Since the SVGA device does not separate
1094 * out encoder and connector, they are represented as part of the STDU as well.
1096 static int vmw_stdu_init(struct vmw_private *dev_priv, unsigned unit)
1098 struct vmw_screen_target_display_unit *stdu;
1099 struct drm_device *dev = dev_priv->dev;
1100 struct drm_connector *connector;
1101 struct drm_encoder *encoder;
1102 struct drm_crtc *crtc;
1105 stdu = kzalloc(sizeof(*stdu), GFP_KERNEL);
1109 stdu->base.unit = unit;
1110 crtc = &stdu->base.crtc;
1111 encoder = &stdu->base.encoder;
1112 connector = &stdu->base.connector;
1114 stdu->base.pref_active = (unit == 0);
1115 stdu->base.pref_width = dev_priv->initial_width;
1116 stdu->base.pref_height = dev_priv->initial_height;
1117 stdu->base.is_implicit = false;
1119 drm_connector_init(dev, connector, &vmw_stdu_connector_funcs,
1120 DRM_MODE_CONNECTOR_VIRTUAL);
1121 connector->status = vmw_du_connector_detect(connector, false);
1123 drm_encoder_init(dev, encoder, &vmw_stdu_encoder_funcs,
1124 DRM_MODE_ENCODER_VIRTUAL, NULL);
1125 drm_mode_connector_attach_encoder(connector, encoder);
1126 encoder->possible_crtcs = (1 << unit);
1127 encoder->possible_clones = 0;
1129 (void) drm_connector_register(connector);
1131 drm_crtc_init(dev, crtc, &vmw_stdu_crtc_funcs);
1133 drm_mode_crtc_set_gamma_size(crtc, 256);
1135 drm_object_attach_property(&connector->base,
1136 dev_priv->hotplug_mode_update_property, 1);
1137 drm_object_attach_property(&connector->base,
1138 dev->mode_config.suggested_x_property, 0);
1139 drm_object_attach_property(&connector->base,
1140 dev->mode_config.suggested_y_property, 0);
1141 if (dev_priv->implicit_placement_property)
1142 drm_object_attach_property
1144 dev_priv->implicit_placement_property,
1145 stdu->base.is_implicit);
1152 * vmw_stdu_destroy - Cleans up a vmw_screen_target_display_unit
1154 * @stdu: Screen Target Display Unit to be destroyed
1156 * Clean up after vmw_stdu_init
1158 static void vmw_stdu_destroy(struct vmw_screen_target_display_unit *stdu)
1160 vmw_stdu_unpin_display(stdu);
1162 vmw_du_cleanup(&stdu->base);
1168 /******************************************************************************
1169 * Screen Target Display KMS Functions
1171 * These functions are called by the common KMS code in vmwgfx_kms.c
1172 *****************************************************************************/
1175 * vmw_kms_stdu_init_display - Initializes a Screen Target based display
1177 * @dev_priv: VMW DRM device
1179 * This function initialize a Screen Target based display device. It checks
1180 * the capability bits to make sure the underlying hardware can support
1181 * screen targets, and then creates the maximum number of CRTCs, a.k.a Display
1182 * Units, as supported by the display hardware.
1185 * 0 on success, error code otherwise
1187 int vmw_kms_stdu_init_display(struct vmw_private *dev_priv)
1189 struct drm_device *dev = dev_priv->dev;
1193 /* Do nothing if Screen Target support is turned off */
1194 if (!VMWGFX_ENABLE_SCREEN_TARGET_OTABLE)
1197 if (!(dev_priv->capabilities & SVGA_CAP_GBOBJECTS))
1200 ret = drm_vblank_init(dev, VMWGFX_NUM_DISPLAY_UNITS);
1201 if (unlikely(ret != 0))
1204 dev_priv->active_display_unit = vmw_du_screen_target;
1206 vmw_kms_create_implicit_placement_property(dev_priv, false);
1208 for (i = 0; i < VMWGFX_NUM_DISPLAY_UNITS; ++i) {
1209 ret = vmw_stdu_init(dev_priv, i);
1211 if (unlikely(ret != 0)) {
1212 DRM_ERROR("Failed to initialize STDU %d", i);
1213 goto err_vblank_cleanup;
1217 DRM_INFO("Screen Target Display device initialized\n");
1222 drm_vblank_cleanup(dev);
1229 * vmw_kms_stdu_close_display - Cleans up after vmw_kms_stdu_init_display
1231 * @dev_priv: VMW DRM device
1233 * Frees up any resources allocated by vmw_kms_stdu_init_display
1238 int vmw_kms_stdu_close_display(struct vmw_private *dev_priv)
1240 struct drm_device *dev = dev_priv->dev;
1242 drm_vblank_cleanup(dev);