// SPDX-License-Identifier: GPL-2.0 OR MIT
/**************************************************************************
 *
 * Copyright (c) 2011-2024 Broadcom. All Rights Reserved. The term
 * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 **************************************************************************/

#include "vmwgfx_bo.h"
#include "vmwgfx_kms.h"
#include "vmwgfx_vkms.h"

#include <drm/drm_atomic.h>
#include <drm/drm_atomic_helper.h>
#include <drm/drm_damage_helper.h>
#include <drm/drm_fourcc.h>
#include <drm/drm_vblank.h>

#define vmw_crtc_to_sou(x) \
        container_of(x, struct vmw_screen_object_unit, base.crtc)
#define vmw_encoder_to_sou(x) \
        container_of(x, struct vmw_screen_object_unit, base.encoder)
#define vmw_connector_to_sou(x) \
        container_of(x, struct vmw_screen_object_unit, base.connector)

/**
 * struct vmw_kms_sou_surface_dirty - Closure structure for
 * blit surface to screen command.
 * @base: The base type we derive from. Used by vmw_kms_helper_dirty().
 * @left: Left side of bounding box.
 * @right: Right side of bounding box.
 * @top: Top side of bounding box.
 * @bottom: Bottom side of bounding box.
 * @dst_x: Difference between source clip rects and framebuffer coordinates.
 * @dst_y: Difference between source clip rects and framebuffer coordinates.
 * @sid: Surface id of surface to copy from.
 */
struct vmw_kms_sou_surface_dirty {
        struct vmw_kms_dirty base;
        s32 left, right, top, bottom;
        s32 dst_x, dst_y;
        u32 sid;
};

/*
 * SVGA commands that are used by this code. Please see the device headers
 * for explanation.
 */
struct vmw_kms_sou_readback_blit {
        uint32 header;
        SVGAFifoCmdBlitScreenToGMRFB body;
};

struct vmw_kms_sou_bo_blit {
        uint32 header;
        SVGAFifoCmdBlitGMRFBToScreen body;
};

struct vmw_kms_sou_dirty_cmd {
        SVGA3dCmdHeader header;
        SVGA3dCmdBlitSurfaceToScreen body;
};

struct vmw_kms_sou_define_gmrfb {
        uint32_t header;
        SVGAFifoCmdDefineGMRFB body;
};

/*
 * Display unit using screen objects.
 */
struct vmw_screen_object_unit {
        struct vmw_display_unit base;

        struct vmw_bo *buffer; /**< Backing store buffer */

        bool defined;
};

static void vmw_sou_destroy(struct vmw_screen_object_unit *sou)
{
        vmw_du_cleanup(&sou->base);
        kfree(sou);
}


/*
 * Screen Object Display Unit CRTC functions
 */

static void vmw_sou_crtc_destroy(struct drm_crtc *crtc)
{
        vmw_sou_destroy(vmw_crtc_to_sou(crtc));
}

/*
 * Send the fifo command to create a screen.
 */
static int vmw_sou_fifo_create(struct vmw_private *dev_priv,
                               struct vmw_screen_object_unit *sou,
                               int x, int y,
                               struct drm_display_mode *mode)
{
        size_t fifo_size;

        struct {
                struct {
                        uint32_t cmdType;
                } header;
                SVGAScreenObject obj;
        } *cmd;

        BUG_ON(!sou->buffer);

        fifo_size = sizeof(*cmd);
        cmd = VMW_CMD_RESERVE(dev_priv, fifo_size);
        if (unlikely(cmd == NULL))
                return -ENOMEM;

        memset(cmd, 0, fifo_size);
        cmd->header.cmdType = SVGA_CMD_DEFINE_SCREEN;
        cmd->obj.structSize = sizeof(SVGAScreenObject);
        cmd->obj.id = sou->base.unit;
        cmd->obj.flags = SVGA_SCREEN_HAS_ROOT |
                (sou->base.unit == 0 ? SVGA_SCREEN_IS_PRIMARY : 0);
        cmd->obj.size.width = mode->hdisplay;
        cmd->obj.size.height = mode->vdisplay;
        cmd->obj.root.x = x;
        cmd->obj.root.y = y;
        sou->base.set_gui_x = cmd->obj.root.x;
        sou->base.set_gui_y = cmd->obj.root.y;

        /* Ok to assume that buffer is pinned in vram */
        vmw_bo_get_guest_ptr(&sou->buffer->tbo, &cmd->obj.backingStore.ptr);
        cmd->obj.backingStore.pitch = mode->hdisplay * 4;

        vmw_cmd_commit(dev_priv, fifo_size);

        sou->defined = true;

        return 0;
}

/*
 * Send the fifo command to destroy a screen.
 */
static int vmw_sou_fifo_destroy(struct vmw_private *dev_priv,
                                struct vmw_screen_object_unit *sou)
{
        size_t fifo_size;
        int ret;

        struct {
                struct {
                        uint32_t cmdType;
                } header;
                SVGAFifoCmdDestroyScreen body;
        } *cmd;

        /* no need to do anything */
        if (unlikely(!sou->defined))
                return 0;

        fifo_size = sizeof(*cmd);
        cmd = VMW_CMD_RESERVE(dev_priv, fifo_size);
        if (unlikely(cmd == NULL))
                return -ENOMEM;

        memset(cmd, 0, fifo_size);
        cmd->header.cmdType = SVGA_CMD_DESTROY_SCREEN;
        cmd->body.screenId = sou->base.unit;

        vmw_cmd_commit(dev_priv, fifo_size);

        /* Force sync */
        ret = vmw_fallback_wait(dev_priv, false, true, 0, false, 3*HZ);
        if (unlikely(ret != 0))
                DRM_ERROR("Failed to sync with HW");
        else
                sou->defined = false;

        return ret;
}

/**
 * vmw_sou_crtc_mode_set_nofb - Create new screen
 *
 * @crtc: CRTC associated with the new screen
 *
 * This function creates/destroys a screen.  This function cannot fail, so if
 * somehow we run into a failure, just do the best we can to get out.
 */
static void vmw_sou_crtc_mode_set_nofb(struct drm_crtc *crtc)
{
        struct vmw_private *dev_priv;
        struct vmw_screen_object_unit *sou;
        struct vmw_framebuffer *vfb;
        struct drm_framebuffer *fb;
        struct drm_plane_state *ps;
        struct vmw_plane_state *vps;
        int ret;

        sou = vmw_crtc_to_sou(crtc);
        dev_priv = vmw_priv(crtc->dev);
        ps = crtc->primary->state;
        fb = ps->fb;
        vps = vmw_plane_state_to_vps(ps);

        vfb = (fb) ? vmw_framebuffer_to_vfb(fb) : NULL;

        if (sou->defined) {
                ret = vmw_sou_fifo_destroy(dev_priv, sou);
                if (ret) {
                        DRM_ERROR("Failed to destroy Screen Object\n");
                        return;
                }
        }

        if (vfb) {
                struct drm_connector_state *conn_state;
                struct vmw_connector_state *vmw_conn_state;
                int x, y;

                sou->buffer = vmw_user_object_buffer(&vps->uo);

                conn_state = sou->base.connector.state;
                vmw_conn_state = vmw_connector_state_to_vcs(conn_state);

                x = vmw_conn_state->gui_x;
                y = vmw_conn_state->gui_y;

                ret = vmw_sou_fifo_create(dev_priv, sou, x, y, &crtc->mode);
                if (ret)
                        DRM_ERROR("Failed to define Screen Object %dx%d\n",
                                  crtc->x, crtc->y);

        } else {
                sou->buffer = NULL;
        }
}

/**
 * vmw_sou_crtc_helper_prepare - Noop
 *
 * @crtc:  CRTC associated with the new screen
 *
 * Prepares the CRTC for a mode set, but we don't need to do anything here.
 */
static void vmw_sou_crtc_helper_prepare(struct drm_crtc *crtc)
{
}

/**
 * vmw_sou_crtc_atomic_disable - Turns off CRTC
 *
 * @crtc: CRTC to be turned off
 * @state: Unused
 */
static void vmw_sou_crtc_atomic_disable(struct drm_crtc *crtc,
                                        struct drm_atomic_state *state)
{
        struct vmw_private *dev_priv;
        struct vmw_screen_object_unit *sou;
        int ret;


        if (!crtc) {
                DRM_ERROR("CRTC is NULL\n");
                return;
        }

        sou = vmw_crtc_to_sou(crtc);
        dev_priv = vmw_priv(crtc->dev);

        if (dev_priv->vkms_enabled)
                drm_crtc_vblank_off(crtc);

        if (sou->defined) {
                ret = vmw_sou_fifo_destroy(dev_priv, sou);
                if (ret)
                        DRM_ERROR("Failed to destroy Screen Object\n");
        }
}

static const struct drm_crtc_funcs vmw_screen_object_crtc_funcs = {
        .gamma_set = vmw_du_crtc_gamma_set,
        .destroy = vmw_sou_crtc_destroy,
        .reset = vmw_du_crtc_reset,
        .atomic_duplicate_state = vmw_du_crtc_duplicate_state,
        .atomic_destroy_state = vmw_du_crtc_destroy_state,
        .set_config = drm_atomic_helper_set_config,
        .page_flip = drm_atomic_helper_page_flip,
        .enable_vblank          = vmw_vkms_enable_vblank,
        .disable_vblank         = vmw_vkms_disable_vblank,
        .get_vblank_timestamp   = vmw_vkms_get_vblank_timestamp,
};

/*
 * Screen Object Display Unit encoder functions
 */

static void vmw_sou_encoder_destroy(struct drm_encoder *encoder)
{
        vmw_sou_destroy(vmw_encoder_to_sou(encoder));
}

static const struct drm_encoder_funcs vmw_screen_object_encoder_funcs = {
        .destroy = vmw_sou_encoder_destroy,
};

/*
 * Screen Object Display Unit connector functions
 */

static void vmw_sou_connector_destroy(struct drm_connector *connector)
{
        vmw_sou_destroy(vmw_connector_to_sou(connector));
}

static const struct drm_connector_funcs vmw_sou_connector_funcs = {
        .dpms = vmw_du_connector_dpms,
        .detect = vmw_du_connector_detect,
        .fill_modes = drm_helper_probe_single_connector_modes,
        .destroy = vmw_sou_connector_destroy,
        .reset = vmw_du_connector_reset,
        .atomic_duplicate_state = vmw_du_connector_duplicate_state,
        .atomic_destroy_state = vmw_du_connector_destroy_state,
};


static const struct
drm_connector_helper_funcs vmw_sou_connector_helper_funcs = {
        .get_modes = vmw_connector_get_modes,
        .mode_valid = vmw_connector_mode_valid
};



/*
 * Screen Object Display Plane Functions
 */

/**
 * vmw_sou_primary_plane_cleanup_fb - Frees sou backing buffer
 *
 * @plane:  display plane
 * @old_state: Contains the FB to clean up
 *
 * Unpins the display surface
 *
 * Returns 0 on success
 */
static void
vmw_sou_primary_plane_cleanup_fb(struct drm_plane *plane,
                                 struct drm_plane_state *old_state)
{
        struct vmw_plane_state *vps = vmw_plane_state_to_vps(old_state);
        struct drm_crtc *crtc = plane->state->crtc ?
                plane->state->crtc : old_state->crtc;
        struct vmw_bo *bo = vmw_user_object_buffer(&vps->uo);

        if (bo)
                vmw_bo_unpin(vmw_priv(crtc->dev), bo, false);
        vmw_user_object_unref(&vps->uo);
        vps->bo_size = 0;

        vmw_du_plane_cleanup_fb(plane, old_state);
}


/**
 * vmw_sou_primary_plane_prepare_fb - allocate backing buffer
 *
 * @plane:  display plane
 * @new_state: info on the new plane state, including the FB
 *
 * The SOU backing buffer is our equivalent of the display plane.
 *
 * Returns 0 on success
 */
static int
vmw_sou_primary_plane_prepare_fb(struct drm_plane *plane,
                                 struct drm_plane_state *new_state)
{
        struct drm_framebuffer *new_fb = new_state->fb;
        struct drm_crtc *crtc = plane->state->crtc ?: new_state->crtc;
        struct vmw_plane_state *vps = vmw_plane_state_to_vps(new_state);
        struct vmw_private *dev_priv;
        int ret;
        struct vmw_bo_params bo_params = {
                .domain = VMW_BO_DOMAIN_VRAM,
                .busy_domain = VMW_BO_DOMAIN_VRAM,
                .bo_type = ttm_bo_type_device,
                .pin = true
        };
        struct vmw_bo *bo = NULL;

        if (!new_fb) {
                vmw_user_object_unref(&vps->uo);
                vps->bo_size = 0;

                return 0;
        }

        bo_params.size = new_state->crtc_w * new_state->crtc_h * 4;
        dev_priv = vmw_priv(crtc->dev);

        bo = vmw_user_object_buffer(&vps->uo);
        if (bo) {
                if (vps->bo_size == bo_params.size) {
                        /*
                         * Note that this might temporarily up the pin-count
                         * to 2, until cleanup_fb() is called.
                         */
                        return vmw_bo_pin_in_vram(dev_priv, bo, true);
                }

                vmw_user_object_unref(&vps->uo);
                vps->bo_size = 0;
        }

        vmw_svga_enable(dev_priv);

        /* After we have alloced the backing store might not be able to
         * resume the overlays, this is preferred to failing to alloc.
         */
        vmw_overlay_pause_all(dev_priv);
        ret = vmw_bo_create(dev_priv, &bo_params, &vps->uo.buffer);
        vmw_overlay_resume_all(dev_priv);
        if (ret)
                return ret;

        vps->bo_size = bo_params.size;

        /*
         * TTM already thinks the buffer is pinned, but make sure the
         * pin_count is upped.
         */
        return vmw_bo_pin_in_vram(dev_priv, vps->uo.buffer, true);
}

static uint32_t vmw_sou_bo_fifo_size(struct vmw_du_update_plane *update,
                                     uint32_t num_hits)
{
        return sizeof(struct vmw_kms_sou_define_gmrfb) +
                sizeof(struct vmw_kms_sou_bo_blit) * num_hits;
}

static uint32_t vmw_sou_bo_define_gmrfb(struct vmw_du_update_plane *update,
                                        void *cmd)
{
        struct vmw_framebuffer_bo *vfbbo =
                container_of(update->vfb, typeof(*vfbbo), base);
        struct vmw_kms_sou_define_gmrfb *gmr = cmd;
        int depth = update->vfb->base.format->depth;

        /* Emulate RGBA support, contrary to svga_reg.h this is not
         * supported by hosts. This is only a problem if we are reading
         * this value later and expecting what we uploaded back.
         */
        if (depth == 32)
                depth = 24;

        gmr->header = SVGA_CMD_DEFINE_GMRFB;

        gmr->body.format.bitsPerPixel = update->vfb->base.format->cpp[0] * 8;
        gmr->body.format.colorDepth = depth;
        gmr->body.format.reserved = 0;
        gmr->body.bytesPerLine = update->vfb->base.pitches[0];
        vmw_bo_get_guest_ptr(&vfbbo->buffer->tbo, &gmr->body.ptr);

        return sizeof(*gmr);
}

static uint32_t vmw_sou_bo_populate_clip(struct vmw_du_update_plane  *update,
                                         void *cmd, struct drm_rect *clip,
                                         uint32_t fb_x, uint32_t fb_y)
{
        struct vmw_kms_sou_bo_blit *blit = cmd;

        blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
        blit->body.destScreenId = update->du->unit;
        blit->body.srcOrigin.x = fb_x;
        blit->body.srcOrigin.y = fb_y;
        blit->body.destRect.left = clip->x1;
        blit->body.destRect.top = clip->y1;
        blit->body.destRect.right = clip->x2;
        blit->body.destRect.bottom = clip->y2;

        return sizeof(*blit);
}

static uint32_t vmw_stud_bo_post_clip(struct vmw_du_update_plane  *update,
                                      void *cmd, struct drm_rect *bb)
{
        return 0;
}

/**
 * vmw_sou_plane_update_bo - Update display unit for bo backed fb.
 * @dev_priv: Device private.
 * @plane: Plane state.
 * @old_state: Old plane state.
 * @vfb: Framebuffer which is blitted to display unit.
 * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
 *             The returned fence pointer may be NULL in which case the device
 *             has already synchronized.
 *
 * Return: 0 on success or a negative error code on failure.
 */
static int vmw_sou_plane_update_bo(struct vmw_private *dev_priv,
                                   struct drm_plane *plane,
                                   struct drm_plane_state *old_state,
                                   struct vmw_framebuffer *vfb,
                                   struct vmw_fence_obj **out_fence)
{
        struct vmw_du_update_plane_buffer bo_update;

        memset(&bo_update, 0, sizeof(struct vmw_du_update_plane_buffer));
        bo_update.base.plane = plane;
        bo_update.base.old_state = old_state;
        bo_update.base.dev_priv = dev_priv;
        bo_update.base.du = vmw_crtc_to_du(plane->state->crtc);
        bo_update.base.vfb = vfb;
        bo_update.base.out_fence = out_fence;
        bo_update.base.mutex = NULL;
        bo_update.base.intr = true;

        bo_update.base.calc_fifo_size = vmw_sou_bo_fifo_size;
        bo_update.base.post_prepare = vmw_sou_bo_define_gmrfb;
        bo_update.base.clip = vmw_sou_bo_populate_clip;
        bo_update.base.post_clip = vmw_stud_bo_post_clip;

        return vmw_du_helper_plane_update(&bo_update.base);
}

static uint32_t vmw_sou_surface_fifo_size(struct vmw_du_update_plane *update,
                                          uint32_t num_hits)
{
        return sizeof(struct vmw_kms_sou_dirty_cmd) + sizeof(SVGASignedRect) *
                num_hits;
}

static uint32_t vmw_sou_surface_post_prepare(struct vmw_du_update_plane *update,
                                             void *cmd)
{
        struct vmw_du_update_plane_surface *srf_update;

        srf_update = container_of(update, typeof(*srf_update), base);

        /*
         * SOU SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN is special in the sense that
         * its bounding box is filled before iterating over all the clips. So
         * store the FIFO start address and revisit to fill the details.
         */
        srf_update->cmd_start = cmd;

        return 0;
}

static uint32_t vmw_sou_surface_pre_clip(struct vmw_du_update_plane *update,
                                         void *cmd, uint32_t num_hits)
{
        struct vmw_kms_sou_dirty_cmd *blit = cmd;
        struct vmw_framebuffer_surface *vfbs;
        struct vmw_surface *surf = NULL;

        vfbs = container_of(update->vfb, typeof(*vfbs), base);

        blit->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
        blit->header.size = sizeof(blit->body) + sizeof(SVGASignedRect) *
                num_hits;

        surf = vmw_user_object_surface(&vfbs->uo);
        blit->body.srcImage.sid = surf->res.id;
        blit->body.destScreenId = update->du->unit;

        /* Update the source and destination bounding box later in post_clip */
        blit->body.srcRect.left = 0;
        blit->body.srcRect.top = 0;
        blit->body.srcRect.right = 0;
        blit->body.srcRect.bottom = 0;

        blit->body.destRect.left = 0;
        blit->body.destRect.top = 0;
        blit->body.destRect.right = 0;
        blit->body.destRect.bottom = 0;

        return sizeof(*blit);
}

static uint32_t vmw_sou_surface_clip_rect(struct vmw_du_update_plane *update,
                                          void *cmd, struct drm_rect *clip,
                                          uint32_t src_x, uint32_t src_y)
{
        SVGASignedRect *rect = cmd;

        /*
         * rects are relative to dest bounding box rect on screen object, so
         * translate to it later in post_clip
         */
        rect->left = clip->x1;
        rect->top = clip->y1;
        rect->right = clip->x2;
        rect->bottom = clip->y2;

        return sizeof(*rect);
}

static uint32_t vmw_sou_surface_post_clip(struct vmw_du_update_plane *update,
                                          void *cmd, struct drm_rect *bb)
{
        struct vmw_du_update_plane_surface *srf_update;
        struct drm_plane_state *state = update->plane->state;
        struct drm_rect src_bb;
        struct vmw_kms_sou_dirty_cmd *blit;
        SVGASignedRect *rect;
        uint32_t num_hits;
        int translate_src_x;
        int translate_src_y;
        int i;

        srf_update = container_of(update, typeof(*srf_update), base);

        blit = srf_update->cmd_start;
        rect = (SVGASignedRect *)&blit[1];

        num_hits = (blit->header.size - sizeof(blit->body))/
                sizeof(SVGASignedRect);

        src_bb = *bb;

        /* To translate bb back to fb src coord */
        translate_src_x = (state->src_x >> 16) - state->crtc_x;
        translate_src_y = (state->src_y >> 16) - state->crtc_y;

        drm_rect_translate(&src_bb, translate_src_x, translate_src_y);

        blit->body.srcRect.left = src_bb.x1;
        blit->body.srcRect.top = src_bb.y1;
        blit->body.srcRect.right = src_bb.x2;
        blit->body.srcRect.bottom = src_bb.y2;

        blit->body.destRect.left = bb->x1;
        blit->body.destRect.top = bb->y1;
        blit->body.destRect.right = bb->x2;
        blit->body.destRect.bottom = bb->y2;

        /* rects are relative to dest bb rect */
        for (i = 0; i < num_hits; i++) {
                rect->left -= bb->x1;
                rect->top -= bb->y1;
                rect->right -= bb->x1;
                rect->bottom -= bb->y1;
                rect++;
        }

        return 0;
}

/**
 * vmw_sou_plane_update_surface - Update display unit for surface backed fb.
 * @dev_priv: Device private.
 * @plane: Plane state.
 * @old_state: Old plane state.
 * @vfb: Framebuffer which is blitted to display unit
 * @out_fence: If non-NULL, will return a ref-counted pointer to vmw_fence_obj.
 *             The returned fence pointer may be NULL in which case the device
 *             has already synchronized.
 *
 * Return: 0 on success or a negative error code on failure.
 */
static int vmw_sou_plane_update_surface(struct vmw_private *dev_priv,
                                        struct drm_plane *plane,
                                        struct drm_plane_state *old_state,
                                        struct vmw_framebuffer *vfb,
                                        struct vmw_fence_obj **out_fence)
{
        struct vmw_du_update_plane_surface srf_update;

        memset(&srf_update, 0, sizeof(struct vmw_du_update_plane_surface));
        srf_update.base.plane = plane;
        srf_update.base.old_state = old_state;
        srf_update.base.dev_priv = dev_priv;
        srf_update.base.du = vmw_crtc_to_du(plane->state->crtc);
        srf_update.base.vfb = vfb;
        srf_update.base.out_fence = out_fence;
        srf_update.base.mutex = &dev_priv->cmdbuf_mutex;
        srf_update.base.intr = true;

        srf_update.base.calc_fifo_size = vmw_sou_surface_fifo_size;
        srf_update.base.post_prepare = vmw_sou_surface_post_prepare;
        srf_update.base.pre_clip = vmw_sou_surface_pre_clip;
        srf_update.base.clip = vmw_sou_surface_clip_rect;
        srf_update.base.post_clip = vmw_sou_surface_post_clip;

        return vmw_du_helper_plane_update(&srf_update.base);
}

static void
vmw_sou_primary_plane_atomic_update(struct drm_plane *plane,
                                    struct drm_atomic_state *state)
{
        struct drm_plane_state *old_state = drm_atomic_get_old_plane_state(state, plane);
        struct drm_plane_state *new_state = drm_atomic_get_new_plane_state(state, plane);
        struct drm_crtc *crtc = new_state->crtc;
        struct vmw_fence_obj *fence = NULL;
        int ret;

        /* In case of device error, maintain consistent atomic state */
        if (crtc && new_state->fb) {
                struct vmw_private *dev_priv = vmw_priv(crtc->dev);
                struct vmw_framebuffer *vfb =
                        vmw_framebuffer_to_vfb(new_state->fb);

                if (vfb->bo)
                        ret = vmw_sou_plane_update_bo(dev_priv, plane,
                                                      old_state, vfb, &fence);
                else
                        ret = vmw_sou_plane_update_surface(dev_priv, plane,
                                                           old_state, vfb,
                                                           &fence);
                if (ret != 0)
                        DRM_ERROR("Failed to update screen.\n");
        } else {
                /* Do nothing when fb and crtc is NULL (blank crtc) */
                return;
        }

        if (fence)
                vmw_fence_obj_unreference(&fence);
}


static const struct drm_plane_funcs vmw_sou_plane_funcs = {
        .update_plane = drm_atomic_helper_update_plane,
        .disable_plane = drm_atomic_helper_disable_plane,
        .destroy = vmw_du_primary_plane_destroy,
        .reset = vmw_du_plane_reset,
        .atomic_duplicate_state = vmw_du_plane_duplicate_state,
        .atomic_destroy_state = vmw_du_plane_destroy_state,
};

static const struct drm_plane_funcs vmw_sou_cursor_funcs = {
        .update_plane = drm_atomic_helper_update_plane,
        .disable_plane = drm_atomic_helper_disable_plane,
        .destroy = vmw_cursor_plane_destroy,
        .reset = vmw_du_plane_reset,
        .atomic_duplicate_state = vmw_du_plane_duplicate_state,
        .atomic_destroy_state = vmw_du_plane_destroy_state,
};

/*
 * Atomic Helpers
 */
static const struct
drm_plane_helper_funcs vmw_sou_cursor_plane_helper_funcs = {
        .atomic_check = vmw_cursor_plane_atomic_check,
        .atomic_update = vmw_cursor_plane_atomic_update,
        .prepare_fb = vmw_cursor_plane_prepare_fb,
        .cleanup_fb = vmw_cursor_plane_cleanup_fb,
};

static const struct
drm_plane_helper_funcs vmw_sou_primary_plane_helper_funcs = {
        .atomic_check = vmw_du_primary_plane_atomic_check,
        .atomic_update = vmw_sou_primary_plane_atomic_update,
        .prepare_fb = vmw_sou_primary_plane_prepare_fb,
        .cleanup_fb = vmw_sou_primary_plane_cleanup_fb,
};

static const struct drm_crtc_helper_funcs vmw_sou_crtc_helper_funcs = {
        .prepare = vmw_sou_crtc_helper_prepare,
        .mode_set_nofb = vmw_sou_crtc_mode_set_nofb,
        .atomic_check = vmw_du_crtc_atomic_check,
        .atomic_begin = vmw_du_crtc_atomic_begin,
        .atomic_flush = vmw_vkms_crtc_atomic_flush,
        .atomic_enable = vmw_vkms_crtc_atomic_enable,
        .atomic_disable = vmw_sou_crtc_atomic_disable,
};


static int vmw_sou_init(struct vmw_private *dev_priv, unsigned unit)
{
        struct vmw_screen_object_unit *sou;
        struct drm_device *dev = &dev_priv->drm;
        struct drm_connector *connector;
        struct drm_encoder *encoder;
        struct drm_plane *primary;
        struct vmw_cursor_plane *cursor;
        struct drm_crtc *crtc;
        int ret;

        sou = kzalloc_obj(*sou);
        if (!sou)
                return -ENOMEM;

        sou->base.unit = unit;
        crtc = &sou->base.crtc;
        encoder = &sou->base.encoder;
        connector = &sou->base.connector;
        primary = &sou->base.primary;
        cursor = &sou->base.cursor;

        sou->base.pref_active = (unit == 0);
        sou->base.pref_width = dev_priv->initial_width;
        sou->base.pref_height = dev_priv->initial_height;

        /*
         * Remove this after enabling atomic because property values can
         * only exist in a state object
         */
        sou->base.is_implicit = false;

        /* Initialize primary plane */
        ret = drm_universal_plane_init(dev, primary,
                                       0, &vmw_sou_plane_funcs,
                                       vmw_primary_plane_formats,
                                       ARRAY_SIZE(vmw_primary_plane_formats),
                                       NULL, DRM_PLANE_TYPE_PRIMARY, NULL);
        if (ret) {
                DRM_ERROR("Failed to initialize primary plane");
                goto err_free;
        }

        drm_plane_helper_add(primary, &vmw_sou_primary_plane_helper_funcs);
        drm_plane_enable_fb_damage_clips(primary);

        /* Initialize cursor plane */
        ret = drm_universal_plane_init(dev, &cursor->base,
                        0, &vmw_sou_cursor_funcs,
                        vmw_cursor_plane_formats,
                        ARRAY_SIZE(vmw_cursor_plane_formats),
                        NULL, DRM_PLANE_TYPE_CURSOR, NULL);
        if (ret) {
                DRM_ERROR("Failed to initialize cursor plane");
                drm_plane_cleanup(&sou->base.primary);
                goto err_free;
        }

        drm_plane_helper_add(&cursor->base, &vmw_sou_cursor_plane_helper_funcs);

        ret = drm_connector_init(dev, connector, &vmw_sou_connector_funcs,
                                 DRM_MODE_CONNECTOR_VIRTUAL);
        if (ret) {
                DRM_ERROR("Failed to initialize connector\n");
                goto err_free;
        }

        drm_connector_helper_add(connector, &vmw_sou_connector_helper_funcs);

        ret = drm_encoder_init(dev, encoder, &vmw_screen_object_encoder_funcs,
                               DRM_MODE_ENCODER_VIRTUAL, NULL);
        if (ret) {
                DRM_ERROR("Failed to initialize encoder\n");
                goto err_free_connector;
        }

        (void) drm_connector_attach_encoder(connector, encoder);
        encoder->possible_crtcs = (1 << unit);
        encoder->possible_clones = 0;

        ret = drm_connector_register(connector);
        if (ret) {
                DRM_ERROR("Failed to register connector\n");
                goto err_free_encoder;
        }

        ret = drm_crtc_init_with_planes(dev, crtc, primary,
                                        &cursor->base,
                                        &vmw_screen_object_crtc_funcs, NULL);
        if (ret) {
                DRM_ERROR("Failed to initialize CRTC\n");
                goto err_free_unregister;
        }

        drm_crtc_helper_add(crtc, &vmw_sou_crtc_helper_funcs);

        drm_mode_crtc_set_gamma_size(crtc, 256);

        drm_object_attach_property(&connector->base,
                                   dev_priv->hotplug_mode_update_property, 1);
        drm_object_attach_property(&connector->base,
                                   dev->mode_config.suggested_x_property, 0);
        drm_object_attach_property(&connector->base,
                                   dev->mode_config.suggested_y_property, 0);

        vmw_du_init(&sou->base);

        return 0;

err_free_unregister:
        drm_connector_unregister(connector);
err_free_encoder:
        drm_encoder_cleanup(encoder);
err_free_connector:
        drm_connector_cleanup(connector);
err_free:
        kfree(sou);
        return ret;
}

int vmw_kms_sou_init_display(struct vmw_private *dev_priv)
{
        struct drm_device *dev = &dev_priv->drm;
        int i;

        /* Screen objects won't work if GMR's aren't available */
        if (!dev_priv->has_gmr)
                return -ENOSYS;

        if (!(dev_priv->capabilities & SVGA_CAP_SCREEN_OBJECT_2)) {
                return -ENOSYS;
        }

        for (i = 0; i < VMWGFX_NUM_DISPLAY_UNITS; ++i)
                vmw_sou_init(dev_priv, i);

        dev_priv->active_display_unit = vmw_du_screen_object;

        drm_mode_config_reset(dev);

        return 0;
}

static int do_bo_define_gmrfb(struct vmw_private *dev_priv,
                                  struct vmw_framebuffer *framebuffer)
{
        struct vmw_bo *buf =
                container_of(framebuffer, struct vmw_framebuffer_bo,
                             base)->buffer;
        int depth = framebuffer->base.format->depth;
        struct {
                uint32_t header;
                SVGAFifoCmdDefineGMRFB body;
        } *cmd;

        /* Emulate RGBA support, contrary to svga_reg.h this is not
         * supported by hosts. This is only a problem if we are reading
         * this value later and expecting what we uploaded back.
         */
        if (depth == 32)
                depth = 24;

        cmd = VMW_CMD_RESERVE(dev_priv, sizeof(*cmd));
        if (!cmd)
                return -ENOMEM;

        cmd->header = SVGA_CMD_DEFINE_GMRFB;
        cmd->body.format.bitsPerPixel = framebuffer->base.format->cpp[0] * 8;
        cmd->body.format.colorDepth = depth;
        cmd->body.format.reserved = 0;
        cmd->body.bytesPerLine = framebuffer->base.pitches[0];
        /* Buffer is reserved in vram or GMR */
        vmw_bo_get_guest_ptr(&buf->tbo, &cmd->body.ptr);
        vmw_cmd_commit(dev_priv, sizeof(*cmd));

        return 0;
}

/**
 * vmw_sou_surface_fifo_commit - Callback to fill in and submit a
 * blit surface to screen command.
 *
 * @dirty: The closure structure.
 *
 * Fills in the missing fields in the command, and translates the cliprects
 * to match the destination bounding box encoded.
 */
static void vmw_sou_surface_fifo_commit(struct vmw_kms_dirty *dirty)
{
        struct vmw_kms_sou_surface_dirty *sdirty =
                container_of(dirty, typeof(*sdirty), base);
        struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
        s32 trans_x = dirty->unit->crtc.x - sdirty->dst_x;
        s32 trans_y = dirty->unit->crtc.y - sdirty->dst_y;
        size_t region_size = dirty->num_hits * sizeof(SVGASignedRect);
        SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];
        int i;

        if (!dirty->num_hits) {
                vmw_cmd_commit(dirty->dev_priv, 0);
                return;
        }

        cmd->header.id = SVGA_3D_CMD_BLIT_SURFACE_TO_SCREEN;
        cmd->header.size = sizeof(cmd->body) + region_size;

        /*
         * Use the destination bounding box to specify destination - and
         * source bounding regions.
         */
        cmd->body.destRect.left = sdirty->left;
        cmd->body.destRect.right = sdirty->right;
        cmd->body.destRect.top = sdirty->top;
        cmd->body.destRect.bottom = sdirty->bottom;

        cmd->body.srcRect.left = sdirty->left + trans_x;
        cmd->body.srcRect.right = sdirty->right + trans_x;
        cmd->body.srcRect.top = sdirty->top + trans_y;
        cmd->body.srcRect.bottom = sdirty->bottom + trans_y;

        cmd->body.srcImage.sid = sdirty->sid;
        cmd->body.destScreenId = dirty->unit->unit;

        /* Blits are relative to the destination rect. Translate. */
        for (i = 0; i < dirty->num_hits; ++i, ++blit) {
                blit->left -= sdirty->left;
                blit->right -= sdirty->left;
                blit->top -= sdirty->top;
                blit->bottom -= sdirty->top;
        }

        vmw_cmd_commit(dirty->dev_priv, region_size + sizeof(*cmd));

        sdirty->left = sdirty->top = S32_MAX;
        sdirty->right = sdirty->bottom = S32_MIN;
}

/**
 * vmw_sou_surface_clip - Callback to encode a blit surface to screen cliprect.
 *
 * @dirty: The closure structure
 *
 * Encodes a SVGASignedRect cliprect and updates the bounding box of the
 * BLIT_SURFACE_TO_SCREEN command.
 */
static void vmw_sou_surface_clip(struct vmw_kms_dirty *dirty)
{
        struct vmw_kms_sou_surface_dirty *sdirty =
                container_of(dirty, typeof(*sdirty), base);
        struct vmw_kms_sou_dirty_cmd *cmd = dirty->cmd;
        SVGASignedRect *blit = (SVGASignedRect *) &cmd[1];

        /* Destination rect. */
        blit += dirty->num_hits;
        blit->left = dirty->unit_x1;
        blit->top = dirty->unit_y1;
        blit->right = dirty->unit_x2;
        blit->bottom = dirty->unit_y2;

        /* Destination bounding box */
        sdirty->left = min_t(s32, sdirty->left, dirty->unit_x1);
        sdirty->top = min_t(s32, sdirty->top, dirty->unit_y1);
        sdirty->right = max_t(s32, sdirty->right, dirty->unit_x2);
        sdirty->bottom = max_t(s32, sdirty->bottom, dirty->unit_y2);

        dirty->num_hits++;
}

/**
 * vmw_kms_sou_do_surface_dirty - Dirty part of a surface backed framebuffer
 *
 * @dev_priv: Pointer to the device private structure.
 * @framebuffer: Pointer to the surface-buffer backed framebuffer.
 * @clips: Array of clip rects. Either @clips or @vclips must be NULL.
 * @vclips: Alternate array of clip rects. Either @clips or @vclips must
 * be NULL.
 * @srf: Pointer to surface to blit from. If NULL, the surface attached
 * to @framebuffer will be used.
 * @dest_x: X coordinate offset to align @srf with framebuffer coordinates.
 * @dest_y: Y coordinate offset to align @srf with framebuffer coordinates.
 * @num_clips: Number of clip rects in @clips.
 * @inc: Increment to use when looping over @clips.
 * @out_fence: If non-NULL, will return a ref-counted pointer to a
 * struct vmw_fence_obj. The returned fence pointer may be NULL in which
 * case the device has already synchronized.
 * @crtc: If crtc is passed, perform surface dirty on that crtc only.
 *
 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
 * interrupted.
 */
int vmw_kms_sou_do_surface_dirty(struct vmw_private *dev_priv,
                                 struct vmw_framebuffer *framebuffer,
                                 struct drm_clip_rect *clips,
                                 struct drm_vmw_rect *vclips,
                                 struct vmw_resource *srf,
                                 s32 dest_x,
                                 s32 dest_y,
                                 unsigned num_clips, int inc,
                                 struct vmw_fence_obj **out_fence,
                                 struct drm_crtc *crtc)
{
        struct vmw_framebuffer_surface *vfbs =
                container_of(framebuffer, typeof(*vfbs), base);
        struct vmw_kms_sou_surface_dirty sdirty;
        DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
        int ret;

        if (!srf)
                srf = &vmw_user_object_surface(&vfbs->uo)->res;

        ret = vmw_validation_add_resource(&val_ctx, srf, 0, VMW_RES_DIRTY_NONE,
                                          NULL, NULL);
        if (ret)
                return ret;

        ret = vmw_validation_prepare(&val_ctx, &dev_priv->cmdbuf_mutex, true);
        if (ret)
                goto out_unref;

        sdirty.base.fifo_commit = vmw_sou_surface_fifo_commit;
        sdirty.base.clip = vmw_sou_surface_clip;
        sdirty.base.dev_priv = dev_priv;
        sdirty.base.fifo_reserve_size = sizeof(struct vmw_kms_sou_dirty_cmd) +
          sizeof(SVGASignedRect) * num_clips;
        sdirty.base.crtc = crtc;

        sdirty.sid = srf->id;
        sdirty.left = sdirty.top = S32_MAX;
        sdirty.right = sdirty.bottom = S32_MIN;
        sdirty.dst_x = dest_x;
        sdirty.dst_y = dest_y;

        ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
                                   dest_x, dest_y, num_clips, inc,
                                   &sdirty.base);
        vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
                                         NULL);

        return ret;

out_unref:
        vmw_validation_unref_lists(&val_ctx);
        return ret;
}

/**
 * vmw_sou_bo_fifo_commit - Callback to submit a set of readback clips.
 *
 * @dirty: The closure structure.
 *
 * Commits a previously built command buffer of readback clips.
 */
static void vmw_sou_bo_fifo_commit(struct vmw_kms_dirty *dirty)
{
        if (!dirty->num_hits) {
                vmw_cmd_commit(dirty->dev_priv, 0);
                return;
        }

        vmw_cmd_commit(dirty->dev_priv,
                        sizeof(struct vmw_kms_sou_bo_blit) *
                        dirty->num_hits);
}

/**
 * vmw_sou_bo_clip - Callback to encode a readback cliprect.
 *
 * @dirty: The closure structure
 *
 * Encodes a BLIT_GMRFB_TO_SCREEN cliprect.
 */
static void vmw_sou_bo_clip(struct vmw_kms_dirty *dirty)
{
        struct vmw_kms_sou_bo_blit *blit = dirty->cmd;

        blit += dirty->num_hits;
        blit->header = SVGA_CMD_BLIT_GMRFB_TO_SCREEN;
        blit->body.destScreenId = dirty->unit->unit;
        blit->body.srcOrigin.x = dirty->fb_x;
        blit->body.srcOrigin.y = dirty->fb_y;
        blit->body.destRect.left = dirty->unit_x1;
        blit->body.destRect.top = dirty->unit_y1;
        blit->body.destRect.right = dirty->unit_x2;
        blit->body.destRect.bottom = dirty->unit_y2;
        dirty->num_hits++;
}

/**
 * vmw_kms_sou_do_bo_dirty - Dirty part of a buffer-object backed framebuffer
 *
 * @dev_priv: Pointer to the device private structure.
 * @framebuffer: Pointer to the buffer-object backed framebuffer.
 * @clips: Array of clip rects.
 * @vclips: Alternate array of clip rects. Either @clips or @vclips must
 * be NULL.
 * @num_clips: Number of clip rects in @clips.
 * @increment: Increment to use when looping over @clips.
 * @interruptible: Whether to perform waits interruptible if possible.
 * @out_fence: If non-NULL, will return a ref-counted pointer to a
 * struct vmw_fence_obj. The returned fence pointer may be NULL in which
 * case the device has already synchronized.
 * @crtc: If crtc is passed, perform bo dirty on that crtc only.
 *
 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
 * interrupted.
 */
int vmw_kms_sou_do_bo_dirty(struct vmw_private *dev_priv,
                                struct vmw_framebuffer *framebuffer,
                                struct drm_clip_rect *clips,
                                struct drm_vmw_rect *vclips,
                                unsigned num_clips, int increment,
                                bool interruptible,
                                struct vmw_fence_obj **out_fence,
                                struct drm_crtc *crtc)
{
        struct vmw_bo *buf =
                container_of(framebuffer, struct vmw_framebuffer_bo,
                             base)->buffer;
        struct vmw_kms_dirty dirty;
        DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
        int ret;

        vmw_bo_placement_set(buf, VMW_BO_DOMAIN_GMR | VMW_BO_DOMAIN_VRAM,
                             VMW_BO_DOMAIN_GMR | VMW_BO_DOMAIN_VRAM);
        ret = vmw_validation_add_bo(&val_ctx, buf);
        if (ret)
                return ret;

        ret = vmw_validation_prepare(&val_ctx, NULL, interruptible);
        if (ret)
                goto out_unref;

        ret = do_bo_define_gmrfb(dev_priv, framebuffer);
        if (unlikely(ret != 0))
                goto out_revert;

        dirty.crtc = crtc;
        dirty.fifo_commit = vmw_sou_bo_fifo_commit;
        dirty.clip = vmw_sou_bo_clip;
        dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_bo_blit) *
                num_clips;
        ret = vmw_kms_helper_dirty(dev_priv, framebuffer, clips, vclips,
                                   0, 0, num_clips, increment, &dirty);
        vmw_kms_helper_validation_finish(dev_priv, NULL, &val_ctx, out_fence,
                                         NULL);

        return ret;

out_revert:
        vmw_validation_revert(&val_ctx);
out_unref:
        vmw_validation_unref_lists(&val_ctx);

        return ret;
}


/**
 * vmw_sou_readback_fifo_commit - Callback to submit a set of readback clips.
 *
 * @dirty: The closure structure.
 *
 * Commits a previously built command buffer of readback clips.
 */
static void vmw_sou_readback_fifo_commit(struct vmw_kms_dirty *dirty)
{
        if (!dirty->num_hits) {
                vmw_cmd_commit(dirty->dev_priv, 0);
                return;
        }

        vmw_cmd_commit(dirty->dev_priv,
                        sizeof(struct vmw_kms_sou_readback_blit) *
                        dirty->num_hits);
}

/**
 * vmw_sou_readback_clip - Callback to encode a readback cliprect.
 *
 * @dirty: The closure structure
 *
 * Encodes a BLIT_SCREEN_TO_GMRFB cliprect.
 */
static void vmw_sou_readback_clip(struct vmw_kms_dirty *dirty)
{
        struct vmw_kms_sou_readback_blit *blit = dirty->cmd;

        blit += dirty->num_hits;
        blit->header = SVGA_CMD_BLIT_SCREEN_TO_GMRFB;
        blit->body.srcScreenId = dirty->unit->unit;
        blit->body.destOrigin.x = dirty->fb_x;
        blit->body.destOrigin.y = dirty->fb_y;
        blit->body.srcRect.left = dirty->unit_x1;
        blit->body.srcRect.top = dirty->unit_y1;
        blit->body.srcRect.right = dirty->unit_x2;
        blit->body.srcRect.bottom = dirty->unit_y2;
        dirty->num_hits++;
}

/**
 * vmw_kms_sou_readback - Perform a readback from the screen object system to
 * a buffer-object backed framebuffer.
 *
 * @dev_priv: Pointer to the device private structure.
 * @file_priv: Pointer to a struct drm_file identifying the caller.
 * Must be set to NULL if @user_fence_rep is NULL.
 * @vfb: Pointer to the buffer-object backed framebuffer.
 * @user_fence_rep: User-space provided structure for fence information.
 * Must be set to non-NULL if @file_priv is non-NULL.
 * @vclips: Array of clip rects.
 * @num_clips: Number of clip rects in @vclips.
 * @crtc: If crtc is passed, readback on that crtc only.
 *
 * Returns 0 on success, negative error code on failure. -ERESTARTSYS if
 * interrupted.
 */
int vmw_kms_sou_readback(struct vmw_private *dev_priv,
                         struct drm_file *file_priv,
                         struct vmw_framebuffer *vfb,
                         struct drm_vmw_fence_rep __user *user_fence_rep,
                         struct drm_vmw_rect *vclips,
                         uint32_t num_clips,
                         struct drm_crtc *crtc)
{
        struct vmw_bo *buf =
                container_of(vfb, struct vmw_framebuffer_bo, base)->buffer;
        struct vmw_kms_dirty dirty;
        DECLARE_VAL_CONTEXT(val_ctx, NULL, 0);
        int ret;

        vmw_bo_placement_set(buf, VMW_BO_DOMAIN_GMR | VMW_BO_DOMAIN_VRAM,
                             VMW_BO_DOMAIN_GMR | VMW_BO_DOMAIN_VRAM);
        ret = vmw_validation_add_bo(&val_ctx, buf);
        if (ret)
                return ret;

        ret = vmw_validation_prepare(&val_ctx, NULL, true);
        if (ret)
                goto out_unref;

        ret = do_bo_define_gmrfb(dev_priv, vfb);
        if (unlikely(ret != 0))
                goto out_revert;

        dirty.crtc = crtc;
        dirty.fifo_commit = vmw_sou_readback_fifo_commit;
        dirty.clip = vmw_sou_readback_clip;
        dirty.fifo_reserve_size = sizeof(struct vmw_kms_sou_readback_blit) *
                num_clips;
        ret = vmw_kms_helper_dirty(dev_priv, vfb, NULL, vclips,
                                   0, 0, num_clips, 1, &dirty);
        vmw_kms_helper_validation_finish(dev_priv, file_priv, &val_ctx, NULL,
                                         user_fence_rep);

        return ret;

out_revert:
        vmw_validation_revert(&val_ctx);
out_unref:
        vmw_validation_unref_lists(&val_ctx);

        return ret;
}