/*
 * Copyright © 2015 Intel Corporation
 *
 * 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, sublicense,
 * 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 NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS 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.
 */

/**
 * DOC: atomic modeset support
 *
 * The functions here implement the state management and hardware programming
 * dispatch required by the atomic modeset infrastructure.
 * See intel_atomic_plane.c for the plane-specific atomic functionality.
 */

#include <drm/drm_atomic.h>
#include <drm/drm_atomic_helper.h>
#include <drm/drm_fourcc.h>
#include <drm/drm_plane_helper.h>

#include "intel_atomic.h"
#include "intel_cdclk.h"
#include "intel_display_types.h"
#include "intel_global_state.h"
#include "intel_hdcp.h"
#include "intel_psr.h"
#include "intel_sprite.h"

/**
 * intel_digital_connector_atomic_get_property - hook for connector->atomic_get_property.
 * @connector: Connector to get the property for.
 * @state: Connector state to retrieve the property from.
 * @property: Property to retrieve.
 * @val: Return value for the property.
 *
 * Returns the atomic property value for a digital connector.
 */
int intel_digital_connector_atomic_get_property(struct drm_connector *connector,
                                                const struct drm_connector_state *state,
                                                struct drm_property *property,
                                                u64 *val)
{
        struct drm_device *dev = connector->dev;
        struct drm_i915_private *dev_priv = to_i915(dev);
        struct intel_digital_connector_state *intel_conn_state =
                to_intel_digital_connector_state(state);

        if (property == dev_priv->force_audio_property)
                *val = intel_conn_state->force_audio;
        else if (property == dev_priv->broadcast_rgb_property)
                *val = intel_conn_state->broadcast_rgb;
        else {
                drm_dbg_atomic(&dev_priv->drm,
                               "Unknown property [PROP:%d:%s]\n",
                               property->base.id, property->name);
                return -EINVAL;
        }

        return 0;
}

/**
 * intel_digital_connector_atomic_set_property - hook for connector->atomic_set_property.
 * @connector: Connector to set the property for.
 * @state: Connector state to set the property on.
 * @property: Property to set.
 * @val: New value for the property.
 *
 * Sets the atomic property value for a digital connector.
 */
int intel_digital_connector_atomic_set_property(struct drm_connector *connector,
                                                struct drm_connector_state *state,
                                                struct drm_property *property,
                                                u64 val)
{
        struct drm_device *dev = connector->dev;
        struct drm_i915_private *dev_priv = to_i915(dev);
        struct intel_digital_connector_state *intel_conn_state =
                to_intel_digital_connector_state(state);

        if (property == dev_priv->force_audio_property) {
                intel_conn_state->force_audio = val;
                return 0;
        }

        if (property == dev_priv->broadcast_rgb_property) {
                intel_conn_state->broadcast_rgb = val;
                return 0;
        }

        drm_dbg_atomic(&dev_priv->drm, "Unknown property [PROP:%d:%s]\n",
                       property->base.id, property->name);
        return -EINVAL;
}

static bool blob_equal(const struct drm_property_blob *a,
                       const struct drm_property_blob *b)
{
        if (a && b)
                return a->length == b->length &&
                        !memcmp(a->data, b->data, a->length);

        return !a == !b;
}

int intel_digital_connector_atomic_check(struct drm_connector *conn,
                                         struct drm_atomic_state *state)
{
        struct drm_connector_state *new_state =
                drm_atomic_get_new_connector_state(state, conn);
        struct intel_digital_connector_state *new_conn_state =
                to_intel_digital_connector_state(new_state);
        struct drm_connector_state *old_state =
                drm_atomic_get_old_connector_state(state, conn);
        struct intel_digital_connector_state *old_conn_state =
                to_intel_digital_connector_state(old_state);
        struct drm_crtc_state *crtc_state;

        intel_hdcp_atomic_check(conn, old_state, new_state);
        intel_psr_atomic_check(conn, old_state, new_state);

        if (!new_state->crtc)
                return 0;

        crtc_state = drm_atomic_get_new_crtc_state(state, new_state->crtc);

        /*
         * These properties are handled by fastset, and might not end
         * up in a modeset.
         */
        if (new_conn_state->force_audio != old_conn_state->force_audio ||
            new_conn_state->broadcast_rgb != old_conn_state->broadcast_rgb ||
            new_conn_state->base.colorspace != old_conn_state->base.colorspace ||
            new_conn_state->base.picture_aspect_ratio != old_conn_state->base.picture_aspect_ratio ||
            new_conn_state->base.content_type != old_conn_state->base.content_type ||
            new_conn_state->base.scaling_mode != old_conn_state->base.scaling_mode ||
            !blob_equal(new_conn_state->base.hdr_output_metadata,
                        old_conn_state->base.hdr_output_metadata))
                crtc_state->mode_changed = true;

        return 0;
}

/**
 * intel_digital_connector_duplicate_state - duplicate connector state
 * @connector: digital connector
 *
 * Allocates and returns a copy of the connector state (both common and
 * digital connector specific) for the specified connector.
 *
 * Returns: The newly allocated connector state, or NULL on failure.
 */
struct drm_connector_state *
intel_digital_connector_duplicate_state(struct drm_connector *connector)
{
        struct intel_digital_connector_state *state;

        state = kmemdup(connector->state, sizeof(*state), GFP_KERNEL);
        if (!state)
                return NULL;

        __drm_atomic_helper_connector_duplicate_state(connector, &state->base);
        return &state->base;
}

/**
 * intel_connector_needs_modeset - check if connector needs a modeset
 * @state: the atomic state corresponding to this modeset
 * @connector: the connector
 */
bool
intel_connector_needs_modeset(struct intel_atomic_state *state,
                              struct drm_connector *connector)
{
        const struct drm_connector_state *old_conn_state, *new_conn_state;

        old_conn_state = drm_atomic_get_old_connector_state(&state->base, connector);
        new_conn_state = drm_atomic_get_new_connector_state(&state->base, connector);

        return old_conn_state->crtc != new_conn_state->crtc ||
               (new_conn_state->crtc &&
                drm_atomic_crtc_needs_modeset(drm_atomic_get_new_crtc_state(&state->base,
                                                                            new_conn_state->crtc)));
}

struct intel_digital_connector_state *
intel_atomic_get_digital_connector_state(struct intel_atomic_state *state,
                                         struct intel_connector *connector)
{
        struct drm_connector_state *conn_state;

        conn_state = drm_atomic_get_connector_state(&state->base,
                                                    &connector->base);
        if (IS_ERR(conn_state))
                return ERR_CAST(conn_state);

        return to_intel_digital_connector_state(conn_state);
}

/**
 * intel_crtc_duplicate_state - duplicate crtc state
 * @crtc: drm crtc
 *
 * Allocates and returns a copy of the crtc state (both common and
 * Intel-specific) for the specified crtc.
 *
 * Returns: The newly allocated crtc state, or NULL on failure.
 */
struct drm_crtc_state *
intel_crtc_duplicate_state(struct drm_crtc *crtc)
{
        const struct intel_crtc_state *old_crtc_state = to_intel_crtc_state(crtc->state);
        struct intel_crtc_state *crtc_state;

        crtc_state = kmemdup(old_crtc_state, sizeof(*crtc_state), GFP_KERNEL);
        if (!crtc_state)
                return NULL;

        __drm_atomic_helper_crtc_duplicate_state(crtc, &crtc_state->uapi);

        /* copy color blobs */
        if (crtc_state->hw.degamma_lut)
                drm_property_blob_get(crtc_state->hw.degamma_lut);
        if (crtc_state->hw.ctm)
                drm_property_blob_get(crtc_state->hw.ctm);
        if (crtc_state->hw.gamma_lut)
                drm_property_blob_get(crtc_state->hw.gamma_lut);

        crtc_state->update_pipe = false;
        crtc_state->disable_lp_wm = false;
        crtc_state->disable_cxsr = false;
        crtc_state->update_wm_pre = false;
        crtc_state->update_wm_post = false;
        crtc_state->fifo_changed = false;
        crtc_state->preload_luts = false;
        crtc_state->inherited = false;
        crtc_state->wm.need_postvbl_update = false;
        crtc_state->fb_bits = 0;
        crtc_state->update_planes = 0;
        crtc_state->dsb = NULL;

        return &crtc_state->uapi;
}

static void intel_crtc_put_color_blobs(struct intel_crtc_state *crtc_state)
{
        drm_property_blob_put(crtc_state->hw.degamma_lut);
        drm_property_blob_put(crtc_state->hw.gamma_lut);
        drm_property_blob_put(crtc_state->hw.ctm);
}

void intel_crtc_free_hw_state(struct intel_crtc_state *crtc_state)
{
        intel_crtc_put_color_blobs(crtc_state);
}

void intel_crtc_copy_color_blobs(struct intel_crtc_state *crtc_state)
{
        drm_property_replace_blob(&crtc_state->hw.degamma_lut,
                                  crtc_state->uapi.degamma_lut);
        drm_property_replace_blob(&crtc_state->hw.gamma_lut,
                                  crtc_state->uapi.gamma_lut);
        drm_property_replace_blob(&crtc_state->hw.ctm,
                                  crtc_state->uapi.ctm);
}

/**
 * intel_crtc_destroy_state - destroy crtc state
 * @crtc: drm crtc
 * @state: the state to destroy
 *
 * Destroys the crtc state (both common and Intel-specific) for the
 * specified crtc.
 */
void
intel_crtc_destroy_state(struct drm_crtc *crtc,
                         struct drm_crtc_state *state)
{
        struct intel_crtc_state *crtc_state = to_intel_crtc_state(state);

        drm_WARN_ON(crtc->dev, crtc_state->dsb);

        __drm_atomic_helper_crtc_destroy_state(&crtc_state->uapi);
        intel_crtc_free_hw_state(crtc_state);
        kfree(crtc_state);
}

static void intel_atomic_setup_scaler(struct intel_crtc_scaler_state *scaler_state,
                                      int num_scalers_need, struct intel_crtc *intel_crtc,
                                      const char *name, int idx,
                                      struct intel_plane_state *plane_state,
                                      int *scaler_id)
{
        struct drm_i915_private *dev_priv = to_i915(intel_crtc->base.dev);
        int j;
        u32 mode;

        if (*scaler_id < 0) {
                /* find a free scaler */
                for (j = 0; j < intel_crtc->num_scalers; j++) {
                        if (scaler_state->scalers[j].in_use)
                                continue;

                        *scaler_id = j;
                        scaler_state->scalers[*scaler_id].in_use = 1;
                        break;
                }
        }

        if (drm_WARN(&dev_priv->drm, *scaler_id < 0,
                     "Cannot find scaler for %s:%d\n", name, idx))
                return;

        /* set scaler mode */
        if (plane_state && plane_state->hw.fb &&
            plane_state->hw.fb->format->is_yuv &&
            plane_state->hw.fb->format->num_planes > 1) {
                struct intel_plane *plane = to_intel_plane(plane_state->uapi.plane);
                if (IS_GEN(dev_priv, 9) &&
                    !IS_GEMINILAKE(dev_priv)) {
                        mode = SKL_PS_SCALER_MODE_NV12;
                } else if (icl_is_hdr_plane(dev_priv, plane->id)) {
                        /*
                         * On gen11+'s HDR planes we only use the scaler for
                         * scaling. They have a dedicated chroma upsampler, so
                         * we don't need the scaler to upsample the UV plane.
                         */
                        mode = PS_SCALER_MODE_NORMAL;
                } else {
                        struct intel_plane *linked =
                                plane_state->planar_linked_plane;

                        mode = PS_SCALER_MODE_PLANAR;

                        if (linked)
                                mode |= PS_PLANE_Y_SEL(linked->id);
                }
        } else if (INTEL_GEN(dev_priv) > 9 || IS_GEMINILAKE(dev_priv)) {
                mode = PS_SCALER_MODE_NORMAL;
        } else if (num_scalers_need == 1 && intel_crtc->num_scalers > 1) {
                /*
                 * when only 1 scaler is in use on a pipe with 2 scalers
                 * scaler 0 operates in high quality (HQ) mode.
                 * In this case use scaler 0 to take advantage of HQ mode
                 */
                scaler_state->scalers[*scaler_id].in_use = 0;
                *scaler_id = 0;
                scaler_state->scalers[0].in_use = 1;
                mode = SKL_PS_SCALER_MODE_HQ;
        } else {
                mode = SKL_PS_SCALER_MODE_DYN;
        }

        drm_dbg_kms(&dev_priv->drm, "Attached scaler id %u.%u to %s:%d\n",
                    intel_crtc->pipe, *scaler_id, name, idx);
        scaler_state->scalers[*scaler_id].mode = mode;
}

/**
 * intel_atomic_setup_scalers() - setup scalers for crtc per staged requests
 * @dev_priv: i915 device
 * @intel_crtc: intel crtc
 * @crtc_state: incoming crtc_state to validate and setup scalers
 *
 * This function sets up scalers based on staged scaling requests for
 * a @crtc and its planes. It is called from crtc level check path. If request
 * is a supportable request, it attaches scalers to requested planes and crtc.
 *
 * This function takes into account the current scaler(s) in use by any planes
 * not being part of this atomic state
 *
 *  Returns:
 *         0 - scalers were setup succesfully
 *         error code - otherwise
 */
int intel_atomic_setup_scalers(struct drm_i915_private *dev_priv,
                               struct intel_crtc *intel_crtc,
                               struct intel_crtc_state *crtc_state)
{
        struct drm_plane *plane = NULL;
        struct intel_plane *intel_plane;
        struct intel_plane_state *plane_state = NULL;
        struct intel_crtc_scaler_state *scaler_state =
                &crtc_state->scaler_state;
        struct drm_atomic_state *drm_state = crtc_state->uapi.state;
        struct intel_atomic_state *intel_state = to_intel_atomic_state(drm_state);
        int num_scalers_need;
        int i;

        num_scalers_need = hweight32(scaler_state->scaler_users);

        /*
         * High level flow:
         * - staged scaler requests are already in scaler_state->scaler_users
         * - check whether staged scaling requests can be supported
         * - add planes using scalers that aren't in current transaction
         * - assign scalers to requested users
         * - as part of plane commit, scalers will be committed
         *   (i.e., either attached or detached) to respective planes in hw
         * - as part of crtc_commit, scaler will be either attached or detached
         *   to crtc in hw
         */

        /* fail if required scalers > available scalers */
        if (num_scalers_need > intel_crtc->num_scalers){
                drm_dbg_kms(&dev_priv->drm,
                            "Too many scaling requests %d > %d\n",
                            num_scalers_need, intel_crtc->num_scalers);
                return -EINVAL;
        }

        /* walkthrough scaler_users bits and start assigning scalers */
        for (i = 0; i < sizeof(scaler_state->scaler_users) * 8; i++) {
                int *scaler_id;
                const char *name;
                int idx;

                /* skip if scaler not required */
                if (!(scaler_state->scaler_users & (1 << i)))
                        continue;

                if (i == SKL_CRTC_INDEX) {
                        name = "CRTC";
                        idx = intel_crtc->base.base.id;

                        /* panel fitter case: assign as a crtc scaler */
                        scaler_id = &scaler_state->scaler_id;
                } else {
                        name = "PLANE";

                        /* plane scaler case: assign as a plane scaler */
                        /* find the plane that set the bit as scaler_user */
                        plane = drm_state->planes[i].ptr;

                        /*
                         * to enable/disable hq mode, add planes that are using scaler
                         * into this transaction
                         */
                        if (!plane) {
                                struct drm_plane_state *state;

                                /*
                                 * GLK+ scalers don't have a HQ mode so it
                                 * isn't necessary to change between HQ and dyn mode
                                 * on those platforms.
                                 */
                                if (INTEL_GEN(dev_priv) >= 10 || IS_GEMINILAKE(dev_priv))
                                        continue;

                                plane = drm_plane_from_index(&dev_priv->drm, i);
                                state = drm_atomic_get_plane_state(drm_state, plane);
                                if (IS_ERR(state)) {
                                        drm_dbg_kms(&dev_priv->drm,
                                                    "Failed to add [PLANE:%d] to drm_state\n",
                                                    plane->base.id);
                                        return PTR_ERR(state);
                                }
                        }

                        intel_plane = to_intel_plane(plane);
                        idx = plane->base.id;

                        /* plane on different crtc cannot be a scaler user of this crtc */
                        if (drm_WARN_ON(&dev_priv->drm,
                                        intel_plane->pipe != intel_crtc->pipe))
                                continue;

                        plane_state = intel_atomic_get_new_plane_state(intel_state,
                                                                       intel_plane);
                        scaler_id = &plane_state->scaler_id;
                }

                intel_atomic_setup_scaler(scaler_state, num_scalers_need,
                                          intel_crtc, name, idx,
                                          plane_state, scaler_id);
        }

        return 0;
}

struct drm_atomic_state *
intel_atomic_state_alloc(struct drm_device *dev)
{
        struct intel_atomic_state *state = kzalloc(sizeof(*state), GFP_KERNEL);

        if (!state || drm_atomic_state_init(dev, &state->base) < 0) {
                kfree(state);
                return NULL;
        }

        return &state->base;
}

void intel_atomic_state_free(struct drm_atomic_state *_state)
{
        struct intel_atomic_state *state = to_intel_atomic_state(_state);

        drm_atomic_state_default_release(&state->base);
        kfree(state->global_objs);

        i915_sw_fence_fini(&state->commit_ready);

        kfree(state);
}

void intel_atomic_state_clear(struct drm_atomic_state *s)
{
        struct intel_atomic_state *state = to_intel_atomic_state(s);

        drm_atomic_state_default_clear(&state->base);
        intel_atomic_clear_global_state(state);

        state->dpll_set = state->modeset = false;
        state->global_state_changed = false;
        state->active_pipes = 0;
}

struct intel_crtc_state *
intel_atomic_get_crtc_state(struct drm_atomic_state *state,
                            struct intel_crtc *crtc)
{
        struct drm_crtc_state *crtc_state;
        crtc_state = drm_atomic_get_crtc_state(state, &crtc->base);
        if (IS_ERR(crtc_state))
                return ERR_CAST(crtc_state);

        return to_intel_crtc_state(crtc_state);
}

int _intel_atomic_lock_global_state(struct intel_atomic_state *state)
{
        struct drm_i915_private *dev_priv = to_i915(state->base.dev);
        struct intel_crtc *crtc;

        state->global_state_changed = true;

        for_each_intel_crtc(&dev_priv->drm, crtc) {
                int ret;

                ret = drm_modeset_lock(&crtc->base.mutex,
                                       state->base.acquire_ctx);
                if (ret)
                        return ret;
        }

        return 0;
}

int _intel_atomic_serialize_global_state(struct intel_atomic_state *state)
{
        struct drm_i915_private *dev_priv = to_i915(state->base.dev);
        struct intel_crtc *crtc;

        state->global_state_changed = true;

        for_each_intel_crtc(&dev_priv->drm, crtc) {
                struct intel_crtc_state *crtc_state;

                crtc_state = intel_atomic_get_crtc_state(&state->base, crtc);
                if (IS_ERR(crtc_state))
                        return PTR_ERR(crtc_state);
        }

        return 0;
}