drivers/gpu/drm/vmwgfx/vmwgfx_scrn.c

   1 // SPDX-License-Identifier: GPL-2.0 OR MIT
   2 /**************************************************************************
   3  *
   4  * Copyright 2011-2015 VMware, Inc., Palo Alto, CA., USA
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 #include <drm/drm_atomic.h>
  29 #include <drm/drm_atomic_helper.h>
  30 #include <drm/drm_damage_helper.h>
  31 #include <drm/drm_fourcc.h>
  32 #include <drm/drm_plane_helper.h>
  33 #include <drm/drm_vblank.h>
  34
  35 #include "vmwgfx_kms.h"
  36
  37 #define vmw_crtc_to_sou(x) \
  38         container_of(x, struct vmw_screen_object_unit, base.crtc)
  39 #define vmw_encoder_to_sou(x) \
  40         container_of(x, struct vmw_screen_object_unit, base.encoder)
  41 #define vmw_connector_to_sou(x) \
  42         container_of(x, struct vmw_screen_object_unit, base.connector)
  43
  44 /**
  45  * struct vmw_kms_sou_surface_dirty - Closure structure for
  46  * blit surface to screen command.
  47  * @base: The base type we derive from. Used by vmw_kms_helper_dirty().
  48  * @left: Left side of bounding box.
  49  * @right: Right side of bounding box.
  50  * @top: Top side of bounding box.
  51  * @bottom: Bottom side of bounding box.
  52  * @dst_x: Difference between source clip rects and framebuffer coordinates.
  53  * @dst_y: Difference between source clip rects and framebuffer coordinates.
  54  * @sid: Surface id of surface to copy from.
  55  */
  56 struct vmw_kms_sou_surface_dirty {
  57         struct vmw_kms_dirty base;
  58         s32 left, right, top, bottom;
  59         s32 dst_x, dst_y;
  60         u32 sid;
  61 };
  62
  63 /*
  64  * SVGA commands that are used by this code. Please see the device headers
  65  * for explanation.
  66  */
  67 struct vmw_kms_sou_readback_blit {
  68         uint32 header;
  69         SVGAFifoCmdBlitScreenToGMRFB body;
  70 };
  71
  72 struct vmw_kms_sou_bo_blit {
  73         uint32 header;
  74         SVGAFifoCmdBlitGMRFBToScreen body;
  75 };
  76
  77 struct vmw_kms_sou_dirty_cmd {
  78         SVGA3dCmdHeader header;
  79         SVGA3dCmdBlitSurfaceToScreen body;
  80 };
  81
  82 struct vmw_kms_sou_define_gmrfb {
  83         uint32_t header;
  84         SVGAFifoCmdDefineGMRFB body;
  85 };
  86
  87 /*
  88  * Display unit using screen objects.
  89  */
  90 struct vmw_screen_object_unit {
  91         struct vmw_display_unit base;
  92
  93         unsigned long buffer_size; /**< Size of allocated buffer */
  94         struct vmw_buffer_object *buffer; /**< Backing store buffer */
  95
  96         bool defined;
  97 };
  98
  99 static void vmw_sou_destroy(struct vmw_screen_object_unit *sou)
 100 {
 101         vmw_du_cleanup(&sou->base);
 102         kfree(sou);
 103 }
 104
 105
 106 /*
 107  * Screen Object Display Unit CRTC functions
 108  */
 109
 110 static void vmw_sou_crtc_destroy(struct drm_crtc *crtc)
 111 {
 112         vmw_sou_destroy(vmw_crtc_to_sou(crtc));
 113 }
 114
 115 /*
 116  * Send the fifo command to create a screen.
 117  */
 118 static int vmw_sou_fifo_create(struct vmw_private *dev_priv,
 119                                struct vmw_screen_object_unit *sou,
 120                                int x, int y,
 121                                struct drm_display_mode *mode)
 122 {
 123         size_t fifo_size;
 124
 125         struct {
 126                 struct {
 127                         uint32_t cmdType;
 128                 } header;
 129                 SVGAScreenObject obj;
 130         } *cmd;
 131
 132         BUG_ON(!sou->buffer);
 133
 134         fifo_size = sizeof(*cmd);
 135         cmd = VMW_CMD_RESERVE(dev_priv, fifo_size);
 136         if (unlikely(cmd == NULL))
 137                 return -ENOMEM;
 138
 139         memset(cmd, 0, fifo_size);
 140         cmd->header.cmdType = SVGA_CMD_DEFINE_SCREEN;
 141         cmd->obj.structSize = sizeof(SVGAScreenObject);
 142         cmd->obj.id = sou->base.unit;
 143         cmd->obj.flags = SVGA_SCREEN_HAS_ROOT |
 144                 (sou->base.unit == 0 ? SVGA_SCREEN_IS_PRIMARY : 0);
 145         cmd->obj.size.width = mode->hdisplay;
 146         cmd->obj.size.height = mode->vdisplay;
 147         cmd->obj.root.x = x;
 148         cmd->obj.root.y = y;
 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_cmd_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_CMD_RESERVE(dev_priv, fifo_size);
 185         if (unlikely(cmd == NULL))
 186                 return -ENOMEM;
 187
 188         memset(cmd, 0, fifo_size);
 189         cmd->header.cmdType = SVGA_CMD_DESTROY_SCREEN;
 190         cmd->body.screenId = sou->base.unit;
 191
 192         vmw_cmd_commit(dev_priv, fifo_size);
 193
 194         /* Force sync */
 195         ret = vmw_fallback_wait(dev_priv, false, true, 0, false, 3*HZ);
 196         if (unlikely(ret != 0))
 197                 DRM_ERROR("Failed to sync with HW");
 198         else
 199                 sou->defined = false;
 200
 201         return ret;
 202 }
 203
 204 /**
 205  * vmw_sou_crtc_mode_set_nofb - Create new screen
 206  *
 207  * @crtc: CRTC associated with the new screen
 208  *
 209  * This function creates/destroys a screen.  This function cannot fail, so if
 210  * somehow we run into a failure, just do the best we can to get out.
 211  */
 212 static void vmw_sou_crtc_mode_set_nofb(struct drm_crtc *crtc)
 213 {
 214         struct vmw_private *dev_priv;
 215         struct vmw_screen_object_unit *sou;
 216         struct vmw_framebuffer *vfb;
 217         struct drm_framebuffer *fb;
 218         struct drm_plane_state *ps;
 219         struct vmw_plane_state *vps;
 220         int ret;
 221
 222         sou = vmw_crtc_to_sou(crtc);
 223         dev_priv = vmw_priv(crtc->dev);
 224         ps = crtc->primary->state;
 225         fb = ps->fb;
 226         vps = vmw_plane_state_to_vps(ps);
 227
 228         vfb = (fb) ? vmw_framebuffer_to_vfb(fb) : NULL;
 229
 230         if (sou->defined) {
 231                 ret = vmw_sou_fifo_destroy(dev_priv, sou);
 232                 if (ret) {
 233                         DRM_ERROR("Failed to destroy Screen Object\n");
 234                         return;
 235                 }
 236         }
 237
 238         if (vfb) {
 239                 struct drm_connector_state *conn_state;
 240                 struct vmw_connector_state *vmw_conn_state;
 241                 int x, y;
 242
 243                 sou->buffer = vps->bo;
 244                 sou->buffer_size = vps->bo_size;
 245
 246                 conn_state = sou->base.connector.state;
 247                 vmw_conn_state = vmw_connector_state_to_vcs(conn_state);
 248
 249                 x = vmw_conn_state->gui_x;
 250                 y = vmw_conn_state->gui_y;
 251
 252                 ret = vmw_sou_fifo_create(dev_priv, sou, x, y, &crtc->mode);
 253                 if (ret)
 254                         DRM_ERROR("Failed to define Screen Object %dx%d\n",
 255                                   crtc->x, crtc->y);
 256
 257         } else {
 258                 sou->buffer = NULL;
 259                 sou->buffer_size = 0;
 260         }
 261 }
 262
 263 /**
 264  * vmw_sou_crtc_helper_prepare - Noop
 265  *
 266  * @crtc:  CRTC associated with the new screen
 267  *
 268  * Prepares the CRTC for a mode set, but we don't need to do anything here.
 269  */
 270 static void vmw_sou_crtc_helper_prepare(struct drm_crtc *crtc)
 271 {
 272 }
 273
 274 /**
 275  * vmw_sou_crtc_atomic_enable - Noop
 276  *
 277  * @crtc: CRTC associated with the new screen
 278  * @state: Unused
 279  *
 280  * This is called after a mode set has been completed.
 281  */
 282 static void vmw_sou_crtc_atomic_enable(struct drm_crtc *crtc,
 283                                        struct drm_atomic_state *state)
 284 {
 285 }
 286
 287 /**
 288  * vmw_sou_crtc_atomic_disable - Turns off CRTC
 289  *
 290  * @crtc: CRTC to be turned off
 291  * @state: Unused
 292  */
 293 static void vmw_sou_crtc_atomic_disable(struct drm_crtc *crtc,
 294                                         struct drm_atomic_state *state)
 295 {
 296         struct vmw_private *dev_priv;
 297         struct vmw_screen_object_unit *sou;
 298         int ret;
 299
 300
 301         if (!crtc) {
 302                 DRM_ERROR("CRTC is NULL\n");
 303                 return;
 304         }
 305
 306         sou = vmw_crtc_to_sou(crtc);
 307         dev_priv = vmw_priv(crtc->dev);
 308
 309         if (sou->defined) {
 310                 ret = vmw_sou_fifo_destroy(dev_priv, sou);
 311                 if (ret)
 312                         DRM_ERROR("Failed to destroy Screen Object\n");
 313         }
 314 }
 315
 316 static const struct drm_crtc_funcs vmw_screen_object_crtc_funcs = {
 317         .gamma_set = vmw_du_crtc_gamma_set,
 318         .destroy = vmw_sou_crtc_destroy,
 319         .reset = vmw_du_crtc_reset,
 320         .atomic_duplicate_state = vmw_du_crtc_duplicate_state,
 321         .atomic_destroy_state = vmw_du_crtc_destroy_state,
 322         .set_config = drm_atomic_helper_set_config,
 323         .page_flip = drm_atomic_helper_page_flip,
 324         .get_vblank_counter = vmw_get_vblank_counter,
 325         .enable_vblank = vmw_enable_vblank,
 326         .disable_vblank = vmw_disable_vblank,
 327 };
 328
 329 /*
 330  * Screen Object Display Unit encoder functions
 331  */
 332
 333 static void vmw_sou_encoder_destroy(struct drm_encoder *encoder)
 334 {
 335         vmw_sou_destroy(vmw_encoder_to_sou(encoder));
 336 }
 337
 338 static const struct drm_encoder_funcs vmw_screen_object_encoder_funcs = {
 339         .destroy = vmw_sou_encoder_destroy,
 340 };
 341
 342 /*
 343  * Screen Object Display Unit connector functions
 344  */
 345
 346 static void vmw_sou_connector_destroy(struct drm_connector *connector)
 347 {
 348         vmw_sou_destroy(vmw_connector_to_sou(connector));
 349 }
 350
 351 static const struct drm_connector_funcs vmw_sou_connector_funcs = {
 352         .dpms = vmw_du_connector_dpms,
 353         .detect = vmw_du_connector_detect,
 354         .fill_modes = vmw_du_connector_fill_modes,
 355         .destroy = vmw_sou_connector_destroy,
 356         .reset = vmw_du_connector_reset,
 357         .atomic_duplicate_state = vmw_du_connector_duplicate_state,
 358         .atomic_destroy_state = vmw_du_connector_destroy_state,
 359 };
 360
 361
 362 static const struct
 363 drm_connector_helper_funcs vmw_sou_connector_helper_funcs = {
 364 };
 365
 366
 367
 368 /*
 369  * Screen Object Display Plane Functions
 370  */
 371
 372 /**
 373  * vmw_sou_primary_plane_cleanup_fb - Frees sou backing buffer
 374  *
 375  * @plane:  display plane
 376  * @old_state: Contains the FB to clean up
 377  *
 378  * Unpins the display surface
 379  *
 380  * Returns 0 on success
 381  */
 382 static void
 383 vmw_sou_primary_plane_cleanup_fb(struct drm_plane *plane,
 384                                  struct drm_plane_state *old_state)
 385 {
 386         struct vmw_plane_state *vps = vmw_plane_state_to_vps(old_state);
 387         struct drm_crtc *crtc = plane->state->crtc ?
 388                 plane->state->crtc : old_state->crtc;
 389
 390         if (vps->bo)
 391                 vmw_bo_unpin(vmw_priv(crtc->dev), vps->bo, false);
 392         vmw_bo_unreference(&vps->bo);
 393         vps->bo_size = 0;
 394
 395         vmw_du_plane_cleanup_fb(plane, old_state);
 396 }
 397
 398
 399 /**
 400  * vmw_sou_primary_plane_prepare_fb - allocate backing buffer
 401  *
 402  * @plane:  display plane
 403  * @new_state: info on the new plane state, including the FB
 404  *
 405  * The SOU backing buffer is our equivalent of the display plane.
 406  *
 407  * Returns 0 on success
 408  */
 409 static int
 410 vmw_sou_primary_plane_prepare_fb(struct drm_plane *plane,
 411                                  struct drm_plane_state *new_state)
 412 {
 413         struct drm_framebuffer *new_fb = new_state->fb;
 414         struct drm_crtc *crtc = plane->state->crtc ?: new_state->crtc;
 415         struct vmw_plane_state *vps = vmw_plane_state_to_vps(new_state);
 416         struct vmw_private *dev_priv;
 417         size_t size;
 418         int ret;
 419
 420
 421         if (!new_fb) {
 422                 vmw_bo_unreference(&vps->bo);
 423                 vps->bo_size = 0;
 424
 425                 return 0;
 426         }
 427
 428         size = new_state->crtc_w * new_state->crtc_h * 4;
 429         dev_priv = vmw_priv(crtc->dev);
 430
 431         if (vps->bo) {
 432                 if (vps->bo_size == size) {
 433                         /*
 434                          * Note that this might temporarily up the pin-count
 435                          * to 2, until cleanup_fb() is called.
 436                          */
 437                         return vmw_bo_pin_in_vram(dev_priv, vps->bo,
 438                                                       true);
 439                 }
 440
 441                 vmw_bo_unreference(&vps->bo);
 442                 vps->bo_size = 0;
 443         }
 444
 445         vps->bo = kzalloc(sizeof(*vps->bo), GFP_KERNEL);
 446         if (!vps->bo)
 447                 return -ENOMEM;
 448
 449         vmw_svga_enable(dev_priv);
 450
 451         /* After we have alloced the backing store might not be able to
 452          * resume the overlays, this is preferred to failing to alloc.
 453          */
 454         vmw_overlay_pause_all(dev_priv);
 455         ret = vmw_bo_init(dev_priv, vps->bo, size,
 456                               &vmw_vram_placement,
 457                               false, true, &vmw_bo_bo_free);
 458         vmw_overlay_resume_all(dev_priv);
 459         if (ret) {
 460                 vps->bo = NULL; /* vmw_bo_init frees on error */
 461                 return ret;
 462         }
 463
 464         vps->bo_size = size;
 465
 466         /*
 467          * TTM already thinks the buffer is pinned, but make sure the
 468          * pin_count is upped.
 469          */
 470         return vmw_bo_pin_in_vram(dev_priv, vps->bo, true);
 471 }
 472
 473 static uint32_t vmw_sou_bo_fifo_size(struct vmw_du_update_plane *update,
 474                                      uint32_t num_hits)
 475 {
 476         return sizeof(struct vmw_kms_sou_define_gmrfb) +
 477                 sizeof(struct vmw_kms_sou_bo_blit) * num_hits;
 478 }
 479
 480 static uint32_t vmw_sou_bo_define_gmrfb(struct vmw_du_update_plane *update,
 481                                         void *cmd)
 482 {
 483         struct vmw_framebuffer_bo *vfbbo =
 484                 container_of(update->vfb, typeof(*vfbbo), base);
 485         struct vmw_kms_sou_define_gmrfb *gmr = cmd;
 486         int depth = update->vfb->base.format->depth;
 487
 488         /* Emulate RGBA support, contrary to svga_reg.h this is not
 489          * supported by hosts. This is only a problem if we are reading
 490          * this value later and expecting what we uploaded back.
 491          */
 492         if (depth == 32)
 493                 depth = 24;
 494
 495         gmr->header = SVGA_CMD_DEFINE_GMRFB;
 496
 497         gmr->body.format.bitsPerPixel = update->vfb->base.format->cpp[0] * 8;
 498         gmr->body.format.colorDepth = depth;
 499         gmr->body.format.reserved = 0;
 500         gmr->body.bytesPerLine = update->vfb->base.pitches[0];
 501         vmw_bo_get_guest_ptr(&vfbbo->buffer->base, &gmr->body.ptr);
 502
 503         return sizeof(*gmr);
 504 }
 505
 506 static uint32_t vmw_sou_bo_populate_clip(struct vmw_du_update_plane  *update,
 507                                          void *cmd, struct drm_rect *clip,
 508                                          uint32_t fb_x, uint32_t fb_y)
 509 {
 510         struct vmw_kms_sou_bo_blit *blit = cmd;
 511
 512         blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
 513         blit->body.destScreenId = update->du->unit;
 514         blit->body.srcOrigin.x = fb_x;
 515         blit->body.srcOrigin.y = fb_y;
 516         blit->body.destRect.left = clip->x1;
 517         blit->body.destRect.top = clip->y1;
 518         blit->body.destRect.right = clip->x2;
 519         blit->body.destRect.bottom = clip->y2;
 520
 521         return sizeof(*blit);
 522 }
 523
 524 static uint32_t vmw_stud_bo_post_clip(struct vmw_du_update_plane  *update,
 525                                       void *cmd, struct drm_rect *bb)
 526 {
 527         return 0;
 528 }
 529
 530 /**
 531  * vmw_sou_plane_update_bo - Update display unit for bo backed fb.
 532  * @dev_priv: Device private.
 533  * @plane: Plane state.
 534  * @old_state: Old plane state.
 535  * @vfb: Framebuffer which is blitted to display unit.
 536  * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
 537  *             The returned fence pointer may be NULL in which case the device
 538  *             has already synchronized.
 539  *
 540  * Return: 0 on success or a negative error code on failure.
 541  */
 542 static int vmw_sou_plane_update_bo(struct vmw_private *dev_priv,
 543                                    struct drm_plane *plane,
 544                                    struct drm_plane_state *old_state,
 545                                    struct vmw_framebuffer *vfb,
 546                                    struct vmw_fence_obj **out_fence)
 547 {
 548         struct vmw_du_update_plane_buffer bo_update;
 549
 550         memset(&bo_update, 0, sizeof(struct vmw_du_update_plane_buffer));
 551         bo_update.base.plane = plane;
 552         bo_update.base.old_state = old_state;
 553         bo_update.base.dev_priv = dev_priv;
 554         bo_update.base.du = vmw_crtc_to_du(plane->state->crtc);
 555         bo_update.base.vfb = vfb;
 556         bo_update.base.out_fence = out_fence;
 557         bo_update.base.mutex = NULL;
 558         bo_update.base.cpu_blit = false;
 559         bo_update.base.intr = true;
 560
 561         bo_update.base.calc_fifo_size = vmw_sou_bo_fifo_size;
 562         bo_update.base.post_prepare = vmw_sou_bo_define_gmrfb;
 563         bo_update.base.clip = vmw_sou_bo_populate_clip;
 564         bo_update.base.post_clip = vmw_stud_bo_post_clip;
 565
 566         return vmw_du_helper_plane_update(&bo_update.base);
 567 }
 568
 569 static uint32_t vmw_sou_surface_fifo_size(struct vmw_du_update_plane *update,
 570                                           uint32_t num_hits)
 571 {
 572         return sizeof(struct vmw_kms_sou_dirty_cmd) + sizeof(SVGASignedRect) *
 573                 num_hits;
 574 }
 575
 576 static uint32_t vmw_sou_surface_post_prepare(struct vmw_du_update_plane *update,
 577                                              void *cmd)
 578 {
 579         struct vmw_du_update_plane_surface *srf_update;
 580
 581         srf_update = container_of(update, typeof(*srf_update), base);
 582
 583         /*
 584          * SOU SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN is special in the sense that
 585          * its bounding box is filled before iterating over all the clips. So
 586          * store the FIFO start address and revisit to fill the details.
 587          */
 588         srf_update->cmd_start = cmd;
 589
 590         return 0;
 591 }
 592
 593 static uint32_t vmw_sou_surface_pre_clip(struct vmw_du_update_plane *update,
 594                                          void *cmd, uint32_t num_hits)
 595 {
 596         struct vmw_kms_sou_dirty_cmd *blit = cmd;
 597         struct vmw_framebuffer_surface *vfbs;
 598
 599         vfbs = container_of(update->vfb, typeof(*vfbs), base);
 600
 601         blit->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
 602         blit->header.size = sizeof(blit->body) + sizeof(SVGASignedRect) *
 603                 num_hits;
 604
 605         blit->body.srcImage.sid = vfbs->surface->res.id;
 606         blit->body.destScreenId = update->du->unit;
 607
 608         /* Update the source and destination bounding box later in post_clip */
 609         blit->body.srcRect.left = 0;
 610         blit->body.srcRect.top = 0;
 611         blit->body.srcRect.right = 0;
 612         blit->body.srcRect.bottom = 0;
 613
 614         blit->body.destRect.left = 0;
 615         blit->body.destRect.top = 0;
 616         blit->body.destRect.right = 0;
 617         blit->body.destRect.bottom = 0;
 618
 619         return sizeof(*blit);
 620 }
 621
 622 static uint32_t vmw_sou_surface_clip_rect(struct vmw_du_update_plane *update,
 623                                           void *cmd, struct drm_rect *clip,
 624                                           uint32_t src_x, uint32_t src_y)
 625 {
 626         SVGASignedRect *rect = cmd;
 627
 628         /*
 629          * rects are relative to dest bounding box rect on screen object, so
 630          * translate to it later in post_clip
 631          */
 632         rect->left = clip->x1;
 633         rect->top = clip->y1;
 634         rect->right = clip->x2;
 635         rect->bottom = clip->y2;
 636
 637         return sizeof(*rect);
 638 }
 639
 640 static uint32_t vmw_sou_surface_post_clip(struct vmw_du_update_plane *update,
 641                                           void *cmd, struct drm_rect *bb)
 642 {
 643         struct vmw_du_update_plane_surface *srf_update;
 644         struct drm_plane_state *state = update->plane->state;
 645         struct drm_rect src_bb;
 646         struct vmw_kms_sou_dirty_cmd *blit;
 647         SVGASignedRect *rect;
 648         uint32_t num_hits;
 649         int translate_src_x;
 650         int translate_src_y;
 651         int i;
 652
 653         srf_update = container_of(update, typeof(*srf_update), base);
 654
 655         blit = srf_update->cmd_start;
 656         rect = (SVGASignedRect *)&blit[1];
 657
 658         num_hits = (blit->header.size - sizeof(blit->body))/
 659                 sizeof(SVGASignedRect);
 660
 661         src_bb = *bb;
 662
 663         /* To translate bb back to fb src coord */
 664         translate_src_x = (state->src_x >> 16) - state->crtc_x;
 665         translate_src_y = (state->src_y >> 16) - state->crtc_y;
 666
 667         drm_rect_translate(&src_bb, translate_src_x, translate_src_y);
 668
 669         blit->body.srcRect.left = src_bb.x1;
 670         blit->body.srcRect.top = src_bb.y1;
 671         blit->body.srcRect.right = src_bb.x2;
 672         blit->body.srcRect.bottom = src_bb.y2;
 673
 674         blit->body.destRect.left = bb->x1;
 675         blit->body.destRect.top = bb->y1;
 676         blit->body.destRect.right = bb->x2;
 677         blit->body.destRect.bottom = bb->y2;
 678
 679         /* rects are relative to dest bb rect */
 680         for (i = 0; i < num_hits; i++) {
 681                 rect->left -= bb->x1;
 682                 rect->top -= bb->y1;
 683                 rect->right -= bb->x1;
 684                 rect->bottom -= bb->y1;
 685                 rect++;
 686         }
 687
 688         return 0;
 689 }
 690
 691 /**
 692  * vmw_sou_plane_update_surface - Update display unit for surface backed fb.
 693  * @dev_priv: Device private.
 694  * @plane: Plane state.
 695  * @old_state: Old plane state.
 696  * @vfb: Framebuffer which is blitted to display unit
 697  * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
 698  *             The returned fence pointer may be NULL in which case the device
 699  *             has already synchronized.
 700  *
 701  * Return: 0 on success or a negative error code on failure.
 702  */
 703 static int vmw_sou_plane_update_surface(struct vmw_private *dev_priv,
 704                                         struct drm_plane *plane,
 705                                         struct drm_plane_state *old_state,
 706                                         struct vmw_framebuffer *vfb,
 707                                         struct vmw_fence_obj **out_fence)
 708 {
 709         struct vmw_du_update_plane_surface srf_update;
 710
 711         memset(&srf_update, 0, sizeof(struct vmw_du_update_plane_surface));
 712         srf_update.base.plane = plane;
 713         srf_update.base.old_state = old_state;
 714         srf_update.base.dev_priv = dev_priv;
 715         srf_update.base.du = vmw_crtc_to_du(plane->state->crtc);
 716         srf_update.base.vfb = vfb;
 717         srf_update.base.out_fence = out_fence;
 718         srf_update.base.mutex = &dev_priv->cmdbuf_mutex;
 719         srf_update.base.cpu_blit = false;
 720         srf_update.base.intr = true;
 721
 722         srf_update.base.calc_fifo_size = vmw_sou_surface_fifo_size;
 723         srf_update.base.post_prepare = vmw_sou_surface_post_prepare;
 724         srf_update.base.pre_clip = vmw_sou_surface_pre_clip;
 725         srf_update.base.clip = vmw_sou_surface_clip_rect;
 726         srf_update.base.post_clip = vmw_sou_surface_post_clip;
 727
 728         return vmw_du_helper_plane_update(&srf_update.base);
 729 }
 730
 731 static void
 732 vmw_sou_primary_plane_atomic_update(struct drm_plane *plane,
 733                                     struct drm_atomic_state *state)
 734 {
 735         struct drm_plane_state *old_state = drm_atomic_get_old_plane_state(state, plane);
 736         struct drm_plane_state *new_state = drm_atomic_get_new_plane_state(state, plane);
 737         struct drm_crtc *crtc = new_state->crtc;
 738         struct drm_pending_vblank_event *event = NULL;
 739         struct vmw_fence_obj *fence = NULL;
 740         int ret;
 741
 742         /* In case of device error, maintain consistent atomic state */
 743         if (crtc && new_state->fb) {
 744                 struct vmw_private *dev_priv = vmw_priv(crtc->dev);
 745                 struct vmw_framebuffer *vfb =
 746                         vmw_framebuffer_to_vfb(new_state->fb);
 747
 748                 if (vfb->bo)
 749                         ret = vmw_sou_plane_update_bo(dev_priv, plane,
 750                                                       old_state, vfb, &fence);
 751                 else
 752                         ret = vmw_sou_plane_update_surface(dev_priv, plane,
 753                                                            old_state, vfb,
 754                                                            &fence);
 755                 if (ret != 0)
 756                         DRM_ERROR("Failed to update screen.\n");
 757         } else {
 758                 /* Do nothing when fb and crtc is NULL (blank crtc) */
 759                 return;
 760         }
 761
 762         /* For error case vblank event is send from vmw_du_crtc_atomic_flush */
 763         event = crtc->state->event;
 764         if (event && fence) {
 765                 struct drm_file *file_priv = event->base.file_priv;
 766
 767                 ret = vmw_event_fence_action_queue(file_priv,
 768                                                    fence,
 769                                                    &event->base,
 770                                                    &event->event.vbl.tv_sec,
 771                                                    &event->event.vbl.tv_usec,
 772                                                    true);
 773
 774                 if (unlikely(ret != 0))
 775                         DRM_ERROR("Failed to queue event on fence.\n");
 776                 else
 777                         crtc->state->event = NULL;
 778         }
 779
 780         if (fence)
 781                 vmw_fence_obj_unreference(&fence);
 782 }
 783
 784
 785 static const struct drm_plane_funcs vmw_sou_plane_funcs = {
 786         .update_plane = drm_atomic_helper_update_plane,
 787         .disable_plane = drm_atomic_helper_disable_plane,
 788         .destroy = vmw_du_primary_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,
 792 };
 793
 794 static const struct drm_plane_funcs vmw_sou_cursor_funcs = {
 795         .update_plane = drm_atomic_helper_update_plane,
 796         .disable_plane = drm_atomic_helper_disable_plane,
 797         .destroy = vmw_du_cursor_plane_destroy,
 798         .reset = vmw_du_plane_reset,
 799         .atomic_duplicate_state = vmw_du_plane_duplicate_state,
 800         .atomic_destroy_state = vmw_du_plane_destroy_state,
 801 };
 802
 803 /*
 804  * Atomic Helpers
 805  */
 806 static const struct
 807 drm_plane_helper_funcs vmw_sou_cursor_plane_helper_funcs = {
 808         .atomic_check = vmw_du_cursor_plane_atomic_check,
 809         .atomic_update = vmw_du_cursor_plane_atomic_update,
 810         .prepare_fb = vmw_du_cursor_plane_prepare_fb,
 811         .cleanup_fb = vmw_du_plane_cleanup_fb,
 812 };
 813
 814 static const struct
 815 drm_plane_helper_funcs vmw_sou_primary_plane_helper_funcs = {
 816         .atomic_check = vmw_du_primary_plane_atomic_check,
 817         .atomic_update = vmw_sou_primary_plane_atomic_update,
 818         .prepare_fb = vmw_sou_primary_plane_prepare_fb,
 819         .cleanup_fb = vmw_sou_primary_plane_cleanup_fb,
 820 };
 821
 822 static const struct drm_crtc_helper_funcs vmw_sou_crtc_helper_funcs = {
 823         .prepare = vmw_sou_crtc_helper_prepare,
 824         .mode_set_nofb = vmw_sou_crtc_mode_set_nofb,
 825         .atomic_check = vmw_du_crtc_atomic_check,
 826         .atomic_begin = vmw_du_crtc_atomic_begin,
 827         .atomic_flush = vmw_du_crtc_atomic_flush,
 828         .atomic_enable = vmw_sou_crtc_atomic_enable,
 829         .atomic_disable = vmw_sou_crtc_atomic_disable,
 830 };
 831
 832
 833 static int vmw_sou_init(struct vmw_private *dev_priv, unsigned unit)
 834 {
 835         struct vmw_screen_object_unit *sou;
 836         struct drm_device *dev = &dev_priv->drm;
 837         struct drm_connector *connector;
 838         struct drm_encoder *encoder;
 839         struct drm_plane *primary, *cursor;
 840         struct drm_crtc *crtc;
 841         int ret;
 842
 843         sou = kzalloc(sizeof(*sou), GFP_KERNEL);
 844         if (!sou)
 845                 return -ENOMEM;
 846
 847         sou->base.unit = unit;
 848         crtc = &sou->base.crtc;
 849         encoder = &sou->base.encoder;
 850         connector = &sou->base.connector;
 851         primary = &sou->base.primary;
 852         cursor = &sou->base.cursor;
 853
 854         sou->base.pref_active = (unit == 0);
 855         sou->base.pref_width = dev_priv->initial_width;
 856         sou->base.pref_height = dev_priv->initial_height;
 857         sou->base.pref_mode = NULL;
 858
 859         /*
 860          * Remove this after enabling atomic because property values can
 861          * only exist in a state object
 862          */
 863         sou->base.is_implicit = false;
 864
 865         /* Initialize primary plane */
 866         ret = drm_universal_plane_init(dev, &sou->base.primary,
 867                                        0, &vmw_sou_plane_funcs,
 868                                        vmw_primary_plane_formats,
 869                                        ARRAY_SIZE(vmw_primary_plane_formats),
 870                                        NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
 871         if (ret) {
 872                 DRM_ERROR("Failed to initialize primary plane");
 873                 goto err_free;
 874         }
 875
 876         drm_plane_helper_add(primary, &vmw_sou_primary_plane_helper_funcs);
 877         drm_plane_enable_fb_damage_clips(primary);
 878
 879         /* Initialize cursor plane */
 880         ret = drm_universal_plane_init(dev, &sou->base.cursor,
 881                         0, &vmw_sou_cursor_funcs,
 882                         vmw_cursor_plane_formats,
 883                         ARRAY_SIZE(vmw_cursor_plane_formats),
 884                         NULL, DRM_PLANE_TYPE_CURSOR, NULL);
 885         if (ret) {
 886                 DRM_ERROR("Failed to initialize cursor plane");
 887                 drm_plane_cleanup(&sou->base.primary);
 888                 goto err_free;
 889         }
 890
 891         drm_plane_helper_add(cursor, &vmw_sou_cursor_plane_helper_funcs);
 892
 893         ret = drm_connector_init(dev, connector, &vmw_sou_connector_funcs,
 894                                  DRM_MODE_CONNECTOR_VIRTUAL);
 895         if (ret) {
 896                 DRM_ERROR("Failed to initialize connector\n");
 897                 goto err_free;
 898         }
 899
 900         drm_connector_helper_add(connector, &vmw_sou_connector_helper_funcs);
 901         connector->status = vmw_du_connector_detect(connector, true);
 902
 903         ret = drm_encoder_init(dev, encoder, &vmw_screen_object_encoder_funcs,
 904                                DRM_MODE_ENCODER_VIRTUAL, NULL);
 905         if (ret) {
 906                 DRM_ERROR("Failed to initialize encoder\n");
 907                 goto err_free_connector;
 908         }
 909
 910         (void) drm_connector_attach_encoder(connector, encoder);
 911         encoder->possible_crtcs = (1 << unit);
 912         encoder->possible_clones = 0;
 913
 914         ret = drm_connector_register(connector);
 915         if (ret) {
 916                 DRM_ERROR("Failed to register connector\n");
 917                 goto err_free_encoder;
 918         }
 919
 920         ret = drm_crtc_init_with_planes(dev, crtc, &sou->base.primary,
 921                                         &sou->base.cursor,
 922                                         &vmw_screen_object_crtc_funcs, NULL);
 923         if (ret) {
 924                 DRM_ERROR("Failed to initialize CRTC\n");
 925                 goto err_free_unregister;
 926         }
 927
 928         drm_crtc_helper_add(crtc, &vmw_sou_crtc_helper_funcs);
 929
 930         drm_mode_crtc_set_gamma_size(crtc, 256);
 931
 932         drm_object_attach_property(&connector->base,
 933                                    dev_priv->hotplug_mode_update_property, 1);
 934         drm_object_attach_property(&connector->base,
 935                                    dev->mode_config.suggested_x_property, 0);
 936         drm_object_attach_property(&connector->base,
 937                                    dev->mode_config.suggested_y_property, 0);
 938         return 0;
 939
 940 err_free_unregister:
 941         drm_connector_unregister(connector);
 942 err_free_encoder:
 943         drm_encoder_cleanup(encoder);
 944 err_free_connector:
 945         drm_connector_cleanup(connector);
 946 err_free:
 947         kfree(sou);
 948         return ret;
 949 }
 950
 951 int vmw_kms_sou_init_display(struct vmw_private *dev_priv)
 952 {
 953         struct drm_device *dev = &dev_priv->drm;
 954         int i, ret;
 955
 956         if (!(dev_priv->capabilities & SVGA_CAP_SCREEN_OBJECT_2)) {
 957                 DRM_INFO("Not using screen objects,"
 958                          " missing cap SCREEN_OBJECT_2\n");
 959                 return -ENOSYS;
 960         }
 961
 962         ret = -ENOMEM;
 963
 964         ret = drm_vblank_init(dev, VMWGFX_NUM_DISPLAY_UNITS);
 965         if (unlikely(ret != 0))
 966                 return ret;
 967
 968         for (i = 0; i < VMWGFX_NUM_DISPLAY_UNITS; ++i)
 969                 vmw_sou_init(dev_priv, i);
 970
 971         dev_priv->active_display_unit = vmw_du_screen_object;
 972
 973         drm_mode_config_reset(dev);
 974
 975         DRM_INFO("Screen Objects Display Unit initialized\n");
 976
 977         return 0;
 978 }
 979
 980 static int do_bo_define_gmrfb(struct vmw_private *dev_priv,
 981                                   struct vmw_framebuffer *framebuffer)
 982 {
 983         struct vmw_buffer_object *buf =
 984                 container_of(framebuffer, struct vmw_framebuffer_bo,
 985                              base)->buffer;
 986         int depth = framebuffer->base.format->depth;
 987         struct {
 988                 uint32_t header;
 989                 SVGAFifoCmdDefineGMRFB body;
 990         } *cmd;
 991
 992         /* Emulate RGBA support, contrary to svga_reg.h this is not
 993          * supported by hosts. This is only a problem if we are reading
 994          * this value later and expecting what we uploaded back.
 995          */
 996         if (depth == 32)
 997                 depth = 24;
 998
 999         cmd = VMW_CMD_RESERVE(dev_priv, sizeof(*cmd));
1000         if (!cmd)
1001                 return -ENOMEM;
1002
1003         cmd->header = SVGA_CMD_DEFINE_GMRFB;
1004         cmd->body.format.bitsPerPixel = framebuffer->base.format->cpp[0] * 8;
1005         cmd->body.format.colorDepth = depth;
1006         cmd->body.format.reserved = 0;
1007         cmd->body.bytesPerLine = framebuffer->base.pitches[0];
1008         /* Buffer is reserved in vram or GMR */
1009         vmw_bo_get_guest_ptr(&buf->base, &cmd->body.ptr);
1010         vmw_cmd_commit(dev_priv, sizeof(*cmd));
1011
1012         return 0;
1013 }
1014
1015 /**
1016  * vmw_sou_surface_fifo_commit - Callback to fill in and submit a
1017  * blit surface to screen command.
1018  *
1019  * @dirty: The closure structure.
1020  *
1021  * Fills in the missing fields in the command, and translates the cliprects
1022  * to match the destination bounding box encoded.
1023  */
1024 static void vmw_sou_surface_fifo_commit(struct vmw_kms_dirty *dirty)
1025 {
1026         struct vmw_kms_sou_surface_dirty *sdirty =
1027                 container_of(dirty, typeof(*sdirty), base);
1028         struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
1029         s32 trans_x = dirty->unit->crtc.x - sdirty->dst_x;
1030         s32 trans_y = dirty->unit->crtc.y - sdirty->dst_y;
1031         size_t region_size = dirty->num_hits * sizeof(SVGASignedRect);
1032         SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
1033         int i;
1034
1035         if (!dirty->num_hits) {
1036                 vmw_cmd_commit(dirty->dev_priv, 0);
1037                 return;
1038         }
1039
1040         cmd->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
1041         cmd->header.size = sizeof(cmd->body) + region_size;
1042
1043         /*
1044          * Use the destination bounding box to specify destination - and
1045          * source bounding regions.
1046          */
1047         cmd->body.destRect.left = sdirty->left;
1048         cmd->body.destRect.right = sdirty->right;
1049         cmd->body.destRect.top = sdirty->top;
1050         cmd->body.destRect.bottom = sdirty->bottom;
1051
1052         cmd->body.srcRect.left = sdirty->left + trans_x;
1053         cmd->body.srcRect.right = sdirty->right + trans_x;
1054         cmd->body.srcRect.top = sdirty->top + trans_y;
1055         cmd->body.srcRect.bottom = sdirty->bottom + trans_y;
1056
1057         cmd->body.srcImage.sid = sdirty->sid;
1058         cmd->body.destScreenId = dirty->unit->unit;
1059
1060         /* Blits are relative to the destination rect. Translate. */
1061         for (i = 0; i < dirty->num_hits; ++i, ++blit) {
1062                 blit->left -= sdirty->left;
1063                 blit->right -= sdirty->left;
1064                 blit->top -= sdirty->top;
1065                 blit->bottom -= sdirty->top;
1066         }
1067
1068         vmw_cmd_commit(dirty->dev_priv, region_size + sizeof(*cmd));
1069
1070         sdirty->left = sdirty->top = S32_MAX;
1071         sdirty->right = sdirty->bottom = S32_MIN;
1072 }
1073
1074 /**
1075  * vmw_sou_surface_clip - Callback to encode a blit surface to screen cliprect.
1076  *
1077  * @dirty: The closure structure
1078  *
1079  * Encodes a SVGASignedRect cliprect and updates the bounding box of the
1080  * BLIT_SURFACE_TO_SCREEN command.
1081  */
1082 static void vmw_sou_surface_clip(struct vmw_kms_dirty *dirty)
1083 {
1084         struct vmw_kms_sou_surface_dirty *sdirty =
1085                 container_of(dirty, typeof(*sdirty), base);
1086         struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
1087         SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
1088
1089         /* Destination rect. */
1090         blit += dirty->num_hits;
1091         blit->left = dirty->unit_x1;
1092         blit->top = dirty->unit_y1;
1093         blit->right = dirty->unit_x2;
1094         blit->bottom = dirty->unit_y2;
1095
1096         /* Destination bounding box */
1097         sdirty->left = min_t(s32, sdirty->left, dirty->unit_x1);
1098         sdirty->top = min_t(s32, sdirty->top, dirty->unit_y1);
1099         sdirty->right = max_t(s32, sdirty->right, dirty->unit_x2);
1100         sdirty->bottom = max_t(s32, sdirty->bottom, dirty->unit_y2);
1101
1102         dirty->num_hits++;
1103 }
1104
1105 /**
1106  * vmw_kms_sou_do_surface_dirty - Dirty part of a surface backed framebuffer
1107  *
1108  * @dev_priv: Pointer to the device private structure.
1109  * @framebuffer: Pointer to the surface-buffer backed framebuffer.
1110  * @clips: Array of clip rects. Either @clips or @vclips must be NULL.
1111  * @vclips: Alternate array of clip rects. Either @clips or @vclips must
1112  * be NULL.
1113  * @srf: Pointer to surface to blit from. If NULL, the surface attached
1114  * to @framebuffer will be used.
1115  * @dest_x: X coordinate offset to align @srf with framebuffer coordinates.
1116  * @dest_y: Y coordinate offset to align @srf with framebuffer coordinates.
1117  * @num_clips: Number of clip rects in @clips.
1118  * @inc: Increment to use when looping over @clips.
1119  * @out_fence: If non-NULL, will return a ref-counted pointer to a
1120  * struct vmw_fence_obj. The returned fence pointer may be NULL in which
1121  * case the device has already synchronized.
1122  * @crtc: If crtc is passed, perform surface dirty on that crtc only.
1123  *
1124  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1125  * interrupted.
1126  */
1127 int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
1128                                  struct vmw_framebuffer *framebuffer,
1129                                  struct drm_clip_rect *clips,
1130                                  struct drm_vmw_rect *vclips,
1131                                  struct vmw_resource *srf,
1132                                  s32 dest_x,
1133                                  s32 dest_y,
1134                                  unsigned num_clips, int inc,
1135                                  struct vmw_fence_obj **out_fence,
1136                                  struct drm_crtc *crtc)
1137 {
1138         struct vmw_framebuffer_surface *vfbs =
1139                 container_of(framebuffer, typeof(*vfbs), base);
1140         struct vmw_kms_sou_surface_dirty sdirty;
1141         DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1142         int ret;
1143
1144         if (!srf)
1145                 srf = &vfbs->surface->res;
1146
1147         ret = vmw_validation_add_resource(&val_ctx, srf, 0, VMW_RES_DIRTY_NONE,
1148                                           NULL, NULL);
1149         if (ret)
1150                 return ret;
1151
1152         ret = vmw_validation_prepare(&val_ctx, &dev_priv->cmdbuf_mutex, true);
1153         if (ret)
1154                 goto out_unref;
1155
1156         sdirty.base.fifo_commit = vmw_sou_surface_fifo_commit;
1157         sdirty.base.clip = vmw_sou_surface_clip;
1158         sdirty.base.dev_priv = dev_priv;
1159         sdirty.base.fifo_reserve_size = sizeof(struct vmw_kms_sou_dirty_cmd) +
1160           sizeof(SVGASignedRect) * num_clips;
1161         sdirty.base.crtc = crtc;
1162
1163         sdirty.sid = srf->id;
1164         sdirty.left = sdirty.top = S32_MAX;
1165         sdirty.right = sdirty.bottom = S32_MIN;
1166         sdirty.dst_x = dest_x;
1167         sdirty.dst_y = dest_y;
1168
1169         ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1170                                    dest_x, dest_y, num_clips, inc,
1171                                    &sdirty.base);
1172         vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
1173                                          NULL);
1174
1175         return ret;
1176
1177 out_unref:
1178         vmw_validation_unref_lists(&val_ctx);
1179         return ret;
1180 }
1181
1182 /**
1183  * vmw_sou_bo_fifo_commit - Callback to submit a set of readback clips.
1184  *
1185  * @dirty: The closure structure.
1186  *
1187  * Commits a previously built command buffer of readback clips.
1188  */
1189 static void vmw_sou_bo_fifo_commit(struct vmw_kms_dirty *dirty)
1190 {
1191         if (!dirty->num_hits) {
1192                 vmw_cmd_commit(dirty->dev_priv, 0);
1193                 return;
1194         }
1195
1196         vmw_cmd_commit(dirty->dev_priv,
1197                         sizeof(struct vmw_kms_sou_bo_blit) *
1198                         dirty->num_hits);
1199 }
1200
1201 /**
1202  * vmw_sou_bo_clip - Callback to encode a readback cliprect.
1203  *
1204  * @dirty: The closure structure
1205  *
1206  * Encodes a BLIT_GMRFB_TO_SCREEN cliprect.
1207  */
1208 static void vmw_sou_bo_clip(struct vmw_kms_dirty *dirty)
1209 {
1210         struct vmw_kms_sou_bo_blit *blit = dirty->cmd;
1211
1212         blit += dirty->num_hits;
1213         blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
1214         blit->body.destScreenId = dirty->unit->unit;
1215         blit->body.srcOrigin.x = dirty->fb_x;
1216         blit->body.srcOrigin.y = dirty->fb_y;
1217         blit->body.destRect.left = dirty->unit_x1;
1218         blit->body.destRect.top = dirty->unit_y1;
1219         blit->body.destRect.right = dirty->unit_x2;
1220         blit->body.destRect.bottom = dirty->unit_y2;
1221         dirty->num_hits++;
1222 }
1223
1224 /**
1225  * vmw_kms_sou_do_bo_dirty - Dirty part of a buffer-object backed framebuffer
1226  *
1227  * @dev_priv: Pointer to the device private structure.
1228  * @framebuffer: Pointer to the buffer-object backed framebuffer.
1229  * @clips: Array of clip rects.
1230  * @vclips: Alternate array of clip rects. Either @clips or @vclips must
1231  * be NULL.
1232  * @num_clips: Number of clip rects in @clips.
1233  * @increment: Increment to use when looping over @clips.
1234  * @interruptible: Whether to perform waits interruptible if possible.
1235  * @out_fence: If non-NULL, will return a ref-counted pointer to a
1236  * struct vmw_fence_obj. The returned fence pointer may be NULL in which
1237  * case the device has already synchronized.
1238  * @crtc: If crtc is passed, perform bo dirty on that crtc only.
1239  *
1240  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1241  * interrupted.
1242  */
1243 int vmw_kms_sou_do_bo_dirty(struct vmw_private *dev_priv,
1244                                 struct vmw_framebuffer *framebuffer,
1245                                 struct drm_clip_rect *clips,
1246                                 struct drm_vmw_rect *vclips,
1247                                 unsigned num_clips, int increment,
1248                                 bool interruptible,
1249                                 struct vmw_fence_obj **out_fence,
1250                                 struct drm_crtc *crtc)
1251 {
1252         struct vmw_buffer_object *buf =
1253                 container_of(framebuffer, struct vmw_framebuffer_bo,
1254                              base)->buffer;
1255         struct vmw_kms_dirty dirty;
1256         DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1257         int ret;
1258
1259         ret = vmw_validation_add_bo(&val_ctx, buf, false, false);
1260         if (ret)
1261                 return ret;
1262
1263         ret = vmw_validation_prepare(&val_ctx, NULL, interruptible);
1264         if (ret)
1265                 goto out_unref;
1266
1267         ret = do_bo_define_gmrfb(dev_priv, framebuffer);
1268         if (unlikely(ret != 0))
1269                 goto out_revert;
1270
1271         dirty.crtc = crtc;
1272         dirty.fifo_commit = vmw_sou_bo_fifo_commit;
1273         dirty.clip = vmw_sou_bo_clip;
1274         dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_bo_blit) *
1275                 num_clips;
1276         ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
1277                                    0, 0, num_clips, increment, &dirty);
1278         vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
1279                                          NULL);
1280
1281         return ret;
1282
1283 out_revert:
1284         vmw_validation_revert(&val_ctx);
1285 out_unref:
1286         vmw_validation_unref_lists(&val_ctx);
1287
1288         return ret;
1289 }
1290
1291
1292 /**
1293  * vmw_sou_readback_fifo_commit - Callback to submit a set of readback clips.
1294  *
1295  * @dirty: The closure structure.
1296  *
1297  * Commits a previously built command buffer of readback clips.
1298  */
1299 static void vmw_sou_readback_fifo_commit(struct vmw_kms_dirty *dirty)
1300 {
1301         if (!dirty->num_hits) {
1302                 vmw_cmd_commit(dirty->dev_priv, 0);
1303                 return;
1304         }
1305
1306         vmw_cmd_commit(dirty->dev_priv,
1307                         sizeof(struct vmw_kms_sou_readback_blit) *
1308                         dirty->num_hits);
1309 }
1310
1311 /**
1312  * vmw_sou_readback_clip - Callback to encode a readback cliprect.
1313  *
1314  * @dirty: The closure structure
1315  *
1316  * Encodes a BLIT_SCREEN_TO_GMRFB cliprect.
1317  */
1318 static void vmw_sou_readback_clip(struct vmw_kms_dirty *dirty)
1319 {
1320         struct vmw_kms_sou_readback_blit *blit = dirty->cmd;
1321
1322         blit += dirty->num_hits;
1323         blit->header = SVGA_CMD_BLIT_SCREEN_TO_GMRFB;
1324         blit->body.srcScreenId = dirty->unit->unit;
1325         blit->body.destOrigin.x = dirty->fb_x;
1326         blit->body.destOrigin.y = dirty->fb_y;
1327         blit->body.srcRect.left = dirty->unit_x1;
1328         blit->body.srcRect.top = dirty->unit_y1;
1329         blit->body.srcRect.right = dirty->unit_x2;
1330         blit->body.srcRect.bottom = dirty->unit_y2;
1331         dirty->num_hits++;
1332 }
1333
1334 /**
1335  * vmw_kms_sou_readback - Perform a readback from the screen object system to
1336  * a buffer-object backed framebuffer.
1337  *
1338  * @dev_priv: Pointer to the device private structure.
1339  * @file_priv: Pointer to a struct drm_file identifying the caller.
1340  * Must be set to NULL if @user_fence_rep is NULL.
1341  * @vfb: Pointer to the buffer-object backed framebuffer.
1342  * @user_fence_rep: User-space provided structure for fence information.
1343  * Must be set to non-NULL if @file_priv is non-NULL.
1344  * @vclips: Array of clip rects.
1345  * @num_clips: Number of clip rects in @vclips.
1346  * @crtc: If crtc is passed, readback on that crtc only.
1347  *
1348  * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
1349  * interrupted.
1350  */
1351 int vmw_kms_sou_readback(struct vmw_private *dev_priv,
1352                          struct drm_file *file_priv,
1353                          struct vmw_framebuffer *vfb,
1354                          struct drm_vmw_fence_rep __user *user_fence_rep,
1355                          struct drm_vmw_rect *vclips,
1356                          uint32_t num_clips,
1357                          struct drm_crtc *crtc)
1358 {
1359         struct vmw_buffer_object *buf =
1360                 container_of(vfb, struct vmw_framebuffer_bo, base)->buffer;
1361         struct vmw_kms_dirty dirty;
1362         DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
1363         int ret;
1364
1365         ret = vmw_validation_add_bo(&val_ctx, buf, false, false);
1366         if (ret)
1367                 return ret;
1368
1369         ret = vmw_validation_prepare(&val_ctx, NULL, true);
1370         if (ret)
1371                 goto out_unref;
1372
1373         ret = do_bo_define_gmrfb(dev_priv, vfb);
1374         if (unlikely(ret != 0))
1375                 goto out_revert;
1376
1377         dirty.crtc = crtc;
1378         dirty.fifo_commit = vmw_sou_readback_fifo_commit;
1379         dirty.clip = vmw_sou_readback_clip;
1380         dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_readback_blit) *
1381                 num_clips;
1382         ret = vmw_kms_helper_dirty(dev_priv, vfb, NULL, vclips,
1383                                    0, 0, num_clips, 1, &dirty);
1384         vmw_kms_helper_validation_finish(dev_priv, file_priv, &val_ctx, NULL,
1385                                          user_fence_rep);
1386
1387         return ret;
1388
1389 out_revert:
1390         vmw_validation_revert(&val_ctx);
1391 out_unref:
1392         vmw_validation_unref_lists(&val_ctx);
1393
1394         return ret;
1395 }