// SPDX-License-Identifier: MIT
/*
 * Copyright © 2014-2019 Intel Corporation
 *
 * 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 "gt/intel_gt.h"
#include "gt/intel_gt_regs.h"
#include "intel_guc_fw.h"
#include "i915_drv.h"

static void guc_prepare_xfer(struct intel_uncore *uncore)
{
        u32 shim_flags = GUC_ENABLE_READ_CACHE_LOGIC |
                         GUC_ENABLE_READ_CACHE_FOR_SRAM_DATA |
                         GUC_ENABLE_READ_CACHE_FOR_WOPCM_DATA |
                         GUC_ENABLE_MIA_CLOCK_GATING;

        if (GRAPHICS_VER_FULL(uncore->i915) < IP_VER(12, 50))
                shim_flags |= GUC_DISABLE_SRAM_INIT_TO_ZEROES |
                              GUC_ENABLE_MIA_CACHING;

        /* Must program this register before loading the ucode with DMA */
        intel_uncore_write(uncore, GUC_SHIM_CONTROL, shim_flags);

        if (IS_GEN9_LP(uncore->i915))
                intel_uncore_write(uncore, GEN9LP_GT_PM_CONFIG, GT_DOORBELL_ENABLE);
        else
                intel_uncore_write(uncore, GEN9_GT_PM_CONFIG, GT_DOORBELL_ENABLE);

        if (GRAPHICS_VER(uncore->i915) == 9) {
                /* DOP Clock Gating Enable for GuC clocks */
                intel_uncore_rmw(uncore, GEN7_MISCCPCTL,
                                 0, GEN8_DOP_CLOCK_GATE_GUC_ENABLE);

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

static int guc_xfer_rsa_mmio(struct intel_uc_fw *guc_fw,
                             struct intel_uncore *uncore)
{
        u32 rsa[UOS_RSA_SCRATCH_COUNT];
        size_t copied;
        int i;

        copied = intel_uc_fw_copy_rsa(guc_fw, rsa, sizeof(rsa));
        if (copied < sizeof(rsa))
                return -ENOMEM;

        for (i = 0; i < UOS_RSA_SCRATCH_COUNT; i++)
                intel_uncore_write(uncore, UOS_RSA_SCRATCH(i), rsa[i]);

        return 0;
}

static int guc_xfer_rsa_vma(struct intel_uc_fw *guc_fw,
                            struct intel_uncore *uncore)
{
        struct intel_guc *guc = container_of(guc_fw, struct intel_guc, fw);

        intel_uncore_write(uncore, UOS_RSA_SCRATCH(0),
                           intel_guc_ggtt_offset(guc, guc_fw->rsa_data));

        return 0;
}

/* Copy RSA signature from the fw image to HW for verification */
static int guc_xfer_rsa(struct intel_uc_fw *guc_fw,
                        struct intel_uncore *uncore)
{
        if (guc_fw->rsa_data)
                return guc_xfer_rsa_vma(guc_fw, uncore);
        else
                return guc_xfer_rsa_mmio(guc_fw, uncore);
}

/*
 * 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_ready(struct intel_uncore *uncore, u32 *status)
{
        u32 val = intel_uncore_read(uncore, GUC_STATUS);
        u32 uk_val = REG_FIELD_GET(GS_UKERNEL_MASK, val);

        *status = val;
        return uk_val == INTEL_GUC_LOAD_STATUS_READY;
}

static int guc_wait_ucode(struct intel_uncore *uncore)
{
        u32 status;
        int ret;

        /*
         * Wait for the GuC to start up.
         * NB: Docs recommend not using the interrupt for completion.
         * Measurements indicate this should take no more than 20ms
         * (assuming the GT clock is at maximum frequency). So, a
         * timeout here indicates that the GuC has failed and is unusable.
         * (Higher levels of the driver may decide to reset the GuC and
         * attempt the ucode load again if this happens.)
         *
         * FIXME: There is a known (but exceedingly unlikely) race condition
         * where the asynchronous frequency management code could reduce
         * the GT clock while a GuC reload is in progress (during a full
         * GT reset). A fix is in progress but there are complex locking
         * issues to be resolved. In the meantime bump the timeout to
         * 200ms. Even at slowest clock, this should be sufficient. And
         * in the working case, a larger timeout makes no difference.
         */
        ret = wait_for(guc_ready(uncore, &status), 200);
        if (ret) {
                struct drm_device *drm = &uncore->i915->drm;

                drm_info(drm, "GuC load failed: status = 0x%08X\n", status);
                drm_info(drm, "GuC load failed: status: Reset = %d, "
                        "BootROM = 0x%02X, UKernel = 0x%02X, "
                        "MIA = 0x%02X, Auth = 0x%02X\n",
                        REG_FIELD_GET(GS_MIA_IN_RESET, status),
                        REG_FIELD_GET(GS_BOOTROM_MASK, status),
                        REG_FIELD_GET(GS_UKERNEL_MASK, status),
                        REG_FIELD_GET(GS_MIA_MASK, status),
                        REG_FIELD_GET(GS_AUTH_STATUS_MASK, status));

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

                if (REG_FIELD_GET(GS_UKERNEL_MASK, status) == INTEL_GUC_LOAD_STATUS_EXCEPTION) {
                        drm_info(drm, "GuC firmware exception. EIP: %#x\n",
                                 intel_uncore_read(uncore, SOFT_SCRATCH(13)));
                        ret = -ENXIO;
                }
        }

        return ret;
}

/**
 * intel_guc_fw_upload() - load GuC uCode to device
 * @guc: intel_guc structure
 *
 * Called from intel_uc_init_hw() during driver load, resume from sleep and
 * after a GPU reset.
 *
 * The firmware image should have already been fetched into memory, so only
 * check that fetch succeeded, and then transfer the image to the h/w.
 *
 * Return:      non-zero code on error
 */
int intel_guc_fw_upload(struct intel_guc *guc)
{
        struct intel_gt *gt = guc_to_gt(guc);
        struct intel_uncore *uncore = gt->uncore;
        int ret;

        guc_prepare_xfer(uncore);

        /*
         * 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 separately, either by copying it to the UOS_RSA_SCRATCH
         * register (if key size <= 256) or through a ggtt-pinned vma (if key
         * size > 256). The RSA size and therefore the way we provide it to the
         * HW is fixed for each platform and hard-coded in the bootrom.
         */
        ret = guc_xfer_rsa(&guc->fw, uncore);
        if (ret)
                goto out;

        /*
         * Current uCode expects the code to be loaded at 8k; locations below
         * this are used for the stack.
         */
        ret = intel_uc_fw_upload(&guc->fw, 0x2000, UOS_MOVE);
        if (ret)
                goto out;

        ret = guc_wait_ucode(uncore);
        if (ret)
                goto out;

        intel_uc_fw_change_status(&guc->fw, INTEL_UC_FIRMWARE_RUNNING);
        return 0;

out:
        intel_uc_fw_change_status(&guc->fw, INTEL_UC_FIRMWARE_LOAD_FAIL);
        return ret;
}