/*
 * Copyright © 2014 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.
 *
 * Authors:
 *    Vinit Azad <vinit.azad@intel.com>
 *    Ben Widawsky <ben@bwidawsk.net>
 *    Dave Gordon <david.s.gordon@intel.com>
 *    Alex Dai <yu.dai@intel.com>
 */
#include "i915_drv.h"
#include "intel_uc.h"

/**
 * DOC: GuC-specific firmware loader
 *
 * intel_guc:
 * Top level structure of guc. It handles firmware loading and manages client
 * pool and doorbells. intel_guc owns a i915_guc_client to replace the legacy
 * ExecList submission.
 *
 * Firmware versioning:
 * The firmware build process will generate a version header file with major and
 * minor version defined. The versions are built into CSS header of firmware.
 * i915 kernel driver set the minimal firmware version required per platform.
 * The firmware installation package will install (symbolic link) proper version
 * of firmware.
 *
 * GuC address space:
 * GuC does not allow any gfx GGTT address that falls into range [0, WOPCM_TOP),
 * which is reserved for Boot ROM, SRAM and WOPCM. Currently this top address is
 * 512K. In order to exclude 0-512K address space from GGTT, all gfx objects
 * used by GuC is pinned with PIN_OFFSET_BIAS along with size of WOPCM.
 *
 */

#define SKL_FW_MAJOR 6
#define SKL_FW_MINOR 1

#define BXT_FW_MAJOR 8
#define BXT_FW_MINOR 7

#define KBL_FW_MAJOR 9
#define KBL_FW_MINOR 14

#define GLK_FW_MAJOR 10
#define GLK_FW_MINOR 56

#define GUC_FW_PATH(platform, major, minor) \
       "i915/" __stringify(platform) "_guc_ver" __stringify(major) "_" __stringify(minor) ".bin"

#define I915_SKL_GUC_UCODE GUC_FW_PATH(skl, SKL_FW_MAJOR, SKL_FW_MINOR)
MODULE_FIRMWARE(I915_SKL_GUC_UCODE);

#define I915_BXT_GUC_UCODE GUC_FW_PATH(bxt, BXT_FW_MAJOR, BXT_FW_MINOR)
MODULE_FIRMWARE(I915_BXT_GUC_UCODE);

#define I915_KBL_GUC_UCODE GUC_FW_PATH(kbl, KBL_FW_MAJOR, KBL_FW_MINOR)
MODULE_FIRMWARE(I915_KBL_GUC_UCODE);

#define I915_GLK_GUC_UCODE GUC_FW_PATH(glk, GLK_FW_MAJOR, GLK_FW_MINOR)


static u32 get_gttype(struct drm_i915_private *dev_priv)
{
        /* XXX: GT type based on PCI device ID? field seems unused by fw */
        return 0;
}

static u32 get_core_family(struct drm_i915_private *dev_priv)
{
        u32 gen = INTEL_GEN(dev_priv);

        switch (gen) {
        case 9:
                return GUC_CORE_FAMILY_GEN9;

        default:
                MISSING_CASE(gen);
                return GUC_CORE_FAMILY_UNKNOWN;
        }
}

/*
 * Initialise the GuC parameter block before starting the firmware
 * transfer. These parameters are read by the firmware on startup
 * and cannot be changed thereafter.
 */
static void guc_params_init(struct drm_i915_private *dev_priv)
{
        struct intel_guc *guc = &dev_priv->guc;
        u32 params[GUC_CTL_MAX_DWORDS];
        int i;

        memset(&params, 0, sizeof(params));

        params[GUC_CTL_DEVICE_INFO] |=
                (get_gttype(dev_priv) << GUC_CTL_GTTYPE_SHIFT) |
                (get_core_family(dev_priv) << GUC_CTL_COREFAMILY_SHIFT);

        /*
         * GuC ARAT increment is 10 ns. GuC default scheduler quantum is one
         * second. This ARAR is calculated by:
         * Scheduler-Quantum-in-ns / ARAT-increment-in-ns = 1000000000 / 10
         */
        params[GUC_CTL_ARAT_HIGH] = 0;
        params[GUC_CTL_ARAT_LOW] = 100000000;

        params[GUC_CTL_WA] |= GUC_CTL_WA_UK_BY_DRIVER;

        params[GUC_CTL_FEATURE] |= GUC_CTL_DISABLE_SCHEDULER |
                        GUC_CTL_VCS2_ENABLED;

        params[GUC_CTL_LOG_PARAMS] = guc->log.flags;

        if (i915.guc_log_level >= 0) {
                params[GUC_CTL_DEBUG] =
                        i915.guc_log_level << GUC_LOG_VERBOSITY_SHIFT;
        } else
                params[GUC_CTL_DEBUG] = GUC_LOG_DISABLED;

        /* If GuC submission is enabled, set up additional parameters here */
        if (i915.enable_guc_submission) {
                u32 ads = guc_ggtt_offset(guc->ads_vma) >> PAGE_SHIFT;
                u32 pgs = guc_ggtt_offset(dev_priv->guc.stage_desc_pool);
                u32 ctx_in_16 = GUC_MAX_STAGE_DESCRIPTORS / 16;

                params[GUC_CTL_DEBUG] |= ads << GUC_ADS_ADDR_SHIFT;
                params[GUC_CTL_DEBUG] |= GUC_ADS_ENABLED;

                pgs >>= PAGE_SHIFT;
                params[GUC_CTL_CTXINFO] = (pgs << GUC_CTL_BASE_ADDR_SHIFT) |
                        (ctx_in_16 << GUC_CTL_CTXNUM_IN16_SHIFT);

                params[GUC_CTL_FEATURE] |= GUC_CTL_KERNEL_SUBMISSIONS;

                /* Unmask this bit to enable the GuC's internal scheduler */
                params[GUC_CTL_FEATURE] &= ~GUC_CTL_DISABLE_SCHEDULER;
        }

        I915_WRITE(SOFT_SCRATCH(0), 0);

        for (i = 0; i < GUC_CTL_MAX_DWORDS; i++)
                I915_WRITE(SOFT_SCRATCH(1 + i), params[i]);
}

/*
 * Read the GuC status register (GUC_STATUS) and store it in the
 * specified location; then return a boolean indicating whether
 * the value matches either of two values representing completion
 * of the GuC boot process.
 *
 * This is used for polling the GuC status in a wait_for()
 * loop below.
 */
static inline bool guc_ucode_response(struct drm_i915_private *dev_priv,
                                      u32 *status)
{
        u32 val = I915_READ(GUC_STATUS);
        u32 uk_val = val & GS_UKERNEL_MASK;
        *status = val;
        return (uk_val == GS_UKERNEL_READY ||
                ((val & GS_MIA_CORE_STATE) && uk_val == GS_UKERNEL_LAPIC_DONE));
}

/*
 * Transfer the firmware image to RAM for execution by the microcontroller.
 *
 * Architecturally, the DMA engine is bidirectional, and can potentially even
 * transfer between GTT locations. This functionality is left out of the API
 * for now as there is no need for it.
 *
 * Note that GuC needs the CSS header plus uKernel code to be copied by the
 * DMA engine in one operation, whereas the RSA signature is loaded via MMIO.
 */
static int guc_ucode_xfer_dma(struct drm_i915_private *dev_priv,
                              struct i915_vma *vma)
{
        struct intel_uc_fw *guc_fw = &dev_priv->guc.fw;
        unsigned long offset;
        struct sg_table *sg = vma->pages;
        u32 status, rsa[UOS_RSA_SCRATCH_MAX_COUNT];
        int i, ret = 0;

        /* where RSA signature starts */
        offset = guc_fw->rsa_offset;

        /* Copy RSA signature from the fw image to HW for verification */
        sg_pcopy_to_buffer(sg->sgl, sg->nents, rsa, sizeof(rsa), offset);
        for (i = 0; i < UOS_RSA_SCRATCH_MAX_COUNT; i++)
                I915_WRITE(UOS_RSA_SCRATCH(i), rsa[i]);

        /* The header plus uCode will be copied to WOPCM via DMA, excluding any
         * other components */
        I915_WRITE(DMA_COPY_SIZE, guc_fw->header_size + guc_fw->ucode_size);

        /* Set the source address for the new blob */
        offset = guc_ggtt_offset(vma) + guc_fw->header_offset;
        I915_WRITE(DMA_ADDR_0_LOW, lower_32_bits(offset));
        I915_WRITE(DMA_ADDR_0_HIGH, upper_32_bits(offset) & 0xFFFF);

        /*
         * Set the DMA destination. Current uCode expects the code to be
         * loaded at 8k; locations below this are used for the stack.
         */
        I915_WRITE(DMA_ADDR_1_LOW, 0x2000);
        I915_WRITE(DMA_ADDR_1_HIGH, DMA_ADDRESS_SPACE_WOPCM);

        /* Finally start the DMA */
        I915_WRITE(DMA_CTRL, _MASKED_BIT_ENABLE(UOS_MOVE | START_DMA));

        /*
         * Wait for the DMA to complete & the GuC to start up.
         * NB: Docs recommend not using the interrupt for completion.
         * Measurements indicate this should take no more than 20ms, so a
         * timeout here indicates that the GuC has failed and is unusable.
         * (Higher levels of the driver will attempt to fall back to
         * execlist mode if this happens.)
         */
        ret = wait_for(guc_ucode_response(dev_priv, &status), 100);

        DRM_DEBUG_DRIVER("DMA status 0x%x, GuC status 0x%x\n",
                        I915_READ(DMA_CTRL), status);

        if ((status & GS_BOOTROM_MASK) == GS_BOOTROM_RSA_FAILED) {
                DRM_ERROR("GuC firmware signature verification failed\n");
                ret = -ENOEXEC;
        }

        DRM_DEBUG_DRIVER("returning %d\n", ret);

        return ret;
}

u32 intel_guc_wopcm_size(struct drm_i915_private *dev_priv)
{
        u32 wopcm_size = GUC_WOPCM_TOP;

        /* On BXT, the top of WOPCM is reserved for RC6 context */
        if (IS_GEN9_LP(dev_priv))
                wopcm_size -= BXT_GUC_WOPCM_RC6_RESERVED;

        return wopcm_size;
}

/*
 * Load the GuC firmware blob into the MinuteIA.
 */
static int guc_ucode_xfer(struct drm_i915_private *dev_priv)
{
        struct intel_uc_fw *guc_fw = &dev_priv->guc.fw;
        struct i915_vma *vma;
        int ret;

        ret = i915_gem_object_set_to_gtt_domain(guc_fw->obj, false);
        if (ret) {
                DRM_DEBUG_DRIVER("set-domain failed %d\n", ret);
                return ret;
        }

        vma = i915_gem_object_ggtt_pin(guc_fw->obj, NULL, 0, 0,
                                       PIN_OFFSET_BIAS | GUC_WOPCM_TOP);
        if (IS_ERR(vma)) {
                DRM_DEBUG_DRIVER("pin failed %d\n", (int)PTR_ERR(vma));
                return PTR_ERR(vma);
        }

        intel_uncore_forcewake_get(dev_priv, FORCEWAKE_ALL);

        /* Enable MIA caching. GuC clock gating is disabled. */
        I915_WRITE(GUC_SHIM_CONTROL, GUC_SHIM_CONTROL_VALUE);

        /* WaDisableMinuteIaClockGating:bxt */
        if (IS_BXT_REVID(dev_priv, 0, BXT_REVID_A1)) {
                I915_WRITE(GUC_SHIM_CONTROL, (I915_READ(GUC_SHIM_CONTROL) &
                                              ~GUC_ENABLE_MIA_CLOCK_GATING));
        }

        /* WaC6DisallowByGfxPause:bxt */
        if (IS_BXT_REVID(dev_priv, 0, BXT_REVID_B0))
                I915_WRITE(GEN6_GFXPAUSE, 0x30FFF);

        if (IS_GEN9_LP(dev_priv))
                I915_WRITE(GEN9LP_GT_PM_CONFIG, GT_DOORBELL_ENABLE);
        else
                I915_WRITE(GEN9_GT_PM_CONFIG, GT_DOORBELL_ENABLE);

        if (IS_GEN9(dev_priv)) {
                /* DOP Clock Gating Enable for GuC clocks */
                I915_WRITE(GEN7_MISCCPCTL, (GEN8_DOP_CLOCK_GATE_GUC_ENABLE |
                                            I915_READ(GEN7_MISCCPCTL)));

                /* allows for 5us (in 10ns units) before GT can go to RC6 */
                I915_WRITE(GUC_ARAT_C6DIS, 0x1FF);
        }

        guc_params_init(dev_priv);

        ret = guc_ucode_xfer_dma(dev_priv, vma);

        intel_uncore_forcewake_put(dev_priv, FORCEWAKE_ALL);

        /*
         * We keep the object pages for reuse during resume. But we can unpin it
         * now that DMA has completed, so it doesn't continue to take up space.
         */
        i915_vma_unpin(vma);

        return ret;
}

/**
 * intel_guc_init_hw() - finish preparing the GuC for activity
 * @guc: intel_guc structure
 *
 * Called during driver loading and also after a GPU reset.
 *
 * The main action required here it to load the GuC uCode into the device.
 * The firmware image should have already been fetched into memory by the
 * earlier call to intel_guc_init(), so here we need only check that
 * worked, and then transfer the image to the h/w.
 *
 * Return:      non-zero code on error
 */
int intel_guc_init_hw(struct intel_guc *guc)
{
        struct drm_i915_private *dev_priv = guc_to_i915(guc);
        const char *fw_path = guc->fw.path;
        int ret;

        DRM_DEBUG_DRIVER("GuC fw status: path %s, fetch %s, load %s\n",
                fw_path,
                intel_uc_fw_status_repr(guc->fw.fetch_status),
                intel_uc_fw_status_repr(guc->fw.load_status));

        if (guc->fw.fetch_status != INTEL_UC_FIRMWARE_SUCCESS)
                return -EIO;

        guc->fw.load_status = INTEL_UC_FIRMWARE_PENDING;

        DRM_DEBUG_DRIVER("GuC fw status: fetch %s, load %s\n",
                intel_uc_fw_status_repr(guc->fw.fetch_status),
                intel_uc_fw_status_repr(guc->fw.load_status));

        ret = guc_ucode_xfer(dev_priv);

        if (ret)
                return -EAGAIN;

        guc->fw.load_status = INTEL_UC_FIRMWARE_SUCCESS;

        DRM_INFO("GuC %s (firmware %s [version %u.%u])\n",
                 i915.enable_guc_submission ? "submission enabled" : "loaded",
                 guc->fw.path,
                 guc->fw.major_ver_found, guc->fw.minor_ver_found);

        return 0;
}

/**
 * intel_guc_select_fw() - selects GuC firmware for loading
 * @guc:        intel_guc struct
 *
 * Return: zero when we know firmware, non-zero in other case
 */
int intel_guc_select_fw(struct intel_guc *guc)
{
        struct drm_i915_private *dev_priv = guc_to_i915(guc);

        guc->fw.path = NULL;
        guc->fw.fetch_status = INTEL_UC_FIRMWARE_NONE;
        guc->fw.load_status = INTEL_UC_FIRMWARE_NONE;
        guc->fw.type = INTEL_UC_FW_TYPE_GUC;

        if (i915.guc_firmware_path) {
                guc->fw.path = i915.guc_firmware_path;
                guc->fw.major_ver_wanted = 0;
                guc->fw.minor_ver_wanted = 0;
        } else if (IS_SKYLAKE(dev_priv)) {
                guc->fw.path = I915_SKL_GUC_UCODE;
                guc->fw.major_ver_wanted = SKL_FW_MAJOR;
                guc->fw.minor_ver_wanted = SKL_FW_MINOR;
        } else if (IS_BROXTON(dev_priv)) {
                guc->fw.path = I915_BXT_GUC_UCODE;
                guc->fw.major_ver_wanted = BXT_FW_MAJOR;
                guc->fw.minor_ver_wanted = BXT_FW_MINOR;
        } else if (IS_KABYLAKE(dev_priv) || IS_COFFEELAKE(dev_priv)) {
                guc->fw.path = I915_KBL_GUC_UCODE;
                guc->fw.major_ver_wanted = KBL_FW_MAJOR;
                guc->fw.minor_ver_wanted = KBL_FW_MINOR;
        } else if (IS_GEMINILAKE(dev_priv)) {
                guc->fw.path = I915_GLK_GUC_UCODE;
                guc->fw.major_ver_wanted = GLK_FW_MAJOR;
                guc->fw.minor_ver_wanted = GLK_FW_MINOR;
        } else {
                DRM_ERROR("No GuC firmware known for platform with GuC!\n");
                return -ENOENT;
        }

        return 0;
}