drivers/gpu/drm/i915/intel_guc_loader.c

   1 /*
   2  * Copyright © 2014 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Vinit Azad <vinit.azad@intel.com>
  25  *    Ben Widawsky <ben@bwidawsk.net>
  26  *    Dave Gordon <david.s.gordon@intel.com>
  27  *    Alex Dai <yu.dai@intel.com>
  28  */
  29 #include <linux/firmware.h>
  30 #include "i915_drv.h"
  31 #include "intel_guc.h"
  32
  33 /**
  34  * DOC: GuC-specific firmware loader
  35  *
  36  * intel_guc:
  37  * Top level structure of guc. It handles firmware loading and manages client
  38  * pool and doorbells. intel_guc owns a i915_guc_client to replace the legacy
  39  * ExecList submission.
  40  *
  41  * Firmware versioning:
  42  * The firmware build process will generate a version header file with major and
  43  * minor version defined. The versions are built into CSS header of firmware.
  44  * i915 kernel driver set the minimal firmware version required per platform.
  45  * The firmware installation package will install (symbolic link) proper version
  46  * of firmware.
  47  *
  48  * GuC address space:
  49  * GuC does not allow any gfx GGTT address that falls into range [0, WOPCM_TOP),
  50  * which is reserved for Boot ROM, SRAM and WOPCM. Currently this top address is
  51  * 512K. In order to exclude 0-512K address space from GGTT, all gfx objects
  52  * used by GuC is pinned with PIN_OFFSET_BIAS along with size of WOPCM.
  53  *
  54  * Firmware log:
  55  * Firmware log is enabled by setting i915.guc_log_level to non-negative level.
  56  * Log data is printed out via reading debugfs i915_guc_log_dump. Reading from
  57  * i915_guc_load_status will print out firmware loading status and scratch
  58  * registers value.
  59  *
  60  */
  61
  62 #define SKL_FW_MAJOR 6
  63 #define SKL_FW_MINOR 1
  64
  65 #define BXT_FW_MAJOR 8
  66 #define BXT_FW_MINOR 7
  67
  68 #define KBL_FW_MAJOR 9
  69 #define KBL_FW_MINOR 14
  70
  71 #define GUC_FW_PATH(platform, major, minor) \
  72        "i915/" __stringify(platform) "_guc_ver" __stringify(major) "_" __stringify(minor) ".bin"
  73
  74 #define I915_SKL_GUC_UCODE GUC_FW_PATH(skl, SKL_FW_MAJOR, SKL_FW_MINOR)
  75 MODULE_FIRMWARE(I915_SKL_GUC_UCODE);
  76
  77 #define I915_BXT_GUC_UCODE GUC_FW_PATH(bxt, BXT_FW_MAJOR, BXT_FW_MINOR)
  78 MODULE_FIRMWARE(I915_BXT_GUC_UCODE);
  79
  80 #define I915_KBL_GUC_UCODE GUC_FW_PATH(kbl, KBL_FW_MAJOR, KBL_FW_MINOR)
  81 MODULE_FIRMWARE(I915_KBL_GUC_UCODE);
  82
  83 /* User-friendly representation of an enum */
  84 const char *intel_guc_fw_status_repr(enum intel_guc_fw_status status)
  85 {
  86         switch (status) {
  87         case GUC_FIRMWARE_FAIL:
  88                 return "FAIL";
  89         case GUC_FIRMWARE_NONE:
  90                 return "NONE";
  91         case GUC_FIRMWARE_PENDING:
  92                 return "PENDING";
  93         case GUC_FIRMWARE_SUCCESS:
  94                 return "SUCCESS";
  95         default:
  96                 return "UNKNOWN!";
  97         }
  98 };
  99
 100 static void guc_interrupts_release(struct drm_i915_private *dev_priv)
 101 {
 102         struct intel_engine_cs *engine;
 103         enum intel_engine_id id;
 104         int irqs;
 105
 106         /* tell all command streamers NOT to forward interrupts or vblank to GuC */
 107         irqs = _MASKED_FIELD(GFX_FORWARD_VBLANK_MASK, GFX_FORWARD_VBLANK_NEVER);
 108         irqs |= _MASKED_BIT_DISABLE(GFX_INTERRUPT_STEERING);
 109         for_each_engine(engine, dev_priv, id)
 110                 I915_WRITE(RING_MODE_GEN7(engine), irqs);
 111
 112         /* route all GT interrupts to the host */
 113         I915_WRITE(GUC_BCS_RCS_IER, 0);
 114         I915_WRITE(GUC_VCS2_VCS1_IER, 0);
 115         I915_WRITE(GUC_WD_VECS_IER, 0);
 116 }
 117
 118 static void guc_interrupts_capture(struct drm_i915_private *dev_priv)
 119 {
 120         struct intel_engine_cs *engine;
 121         enum intel_engine_id id;
 122         int irqs;
 123         u32 tmp;
 124
 125         /* tell all command streamers to forward interrupts (but not vblank) to GuC */
 126         irqs = _MASKED_BIT_ENABLE(GFX_INTERRUPT_STEERING);
 127         for_each_engine(engine, dev_priv, id)
 128                 I915_WRITE(RING_MODE_GEN7(engine), irqs);
 129
 130         /* route USER_INTERRUPT to Host, all others are sent to GuC. */
 131         irqs = GT_RENDER_USER_INTERRUPT << GEN8_RCS_IRQ_SHIFT |
 132                GT_RENDER_USER_INTERRUPT << GEN8_BCS_IRQ_SHIFT;
 133         /* These three registers have the same bit definitions */
 134         I915_WRITE(GUC_BCS_RCS_IER, ~irqs);
 135         I915_WRITE(GUC_VCS2_VCS1_IER, ~irqs);
 136         I915_WRITE(GUC_WD_VECS_IER, ~irqs);
 137
 138         /*
 139          * The REDIRECT_TO_GUC bit of the PMINTRMSK register directs all
 140          * (unmasked) PM interrupts to the GuC. All other bits of this
 141          * register *disable* generation of a specific interrupt.
 142          *
 143          * 'pm_intr_keep' indicates bits that are NOT to be set when
 144          * writing to the PM interrupt mask register, i.e. interrupts
 145          * that must not be disabled.
 146          *
 147          * If the GuC is handling these interrupts, then we must not let
 148          * the PM code disable ANY interrupt that the GuC is expecting.
 149          * So for each ENABLED (0) bit in this register, we must SET the
 150          * bit in pm_intr_keep so that it's left enabled for the GuC.
 151          *
 152          * OTOH the REDIRECT_TO_GUC bit is initially SET in pm_intr_keep
 153          * (so interrupts go to the DISPLAY unit at first); but here we
 154          * need to CLEAR that bit, which will result in the register bit
 155          * being left SET!
 156          */
 157         tmp = I915_READ(GEN6_PMINTRMSK);
 158         if (tmp & GEN8_PMINTR_REDIRECT_TO_GUC) {
 159                 dev_priv->rps.pm_intr_keep |= ~tmp;
 160                 dev_priv->rps.pm_intr_keep &= ~GEN8_PMINTR_REDIRECT_TO_GUC;
 161         }
 162 }
 163
 164 static u32 get_gttype(struct drm_i915_private *dev_priv)
 165 {
 166         /* XXX: GT type based on PCI device ID? field seems unused by fw */
 167         return 0;
 168 }
 169
 170 static u32 get_core_family(struct drm_i915_private *dev_priv)
 171 {
 172         u32 gen = INTEL_GEN(dev_priv);
 173
 174         switch (gen) {
 175         case 9:
 176                 return GFXCORE_FAMILY_GEN9;
 177
 178         default:
 179                 WARN(1, "GEN%d does not support GuC operation!\n", gen);
 180                 return GFXCORE_FAMILY_UNKNOWN;
 181         }
 182 }
 183
 184 /*
 185  * Initialise the GuC parameter block before starting the firmware
 186  * transfer. These parameters are read by the firmware on startup
 187  * and cannot be changed thereafter.
 188  */
 189 static void guc_params_init(struct drm_i915_private *dev_priv)
 190 {
 191         struct intel_guc *guc = &dev_priv->guc;
 192         u32 params[GUC_CTL_MAX_DWORDS];
 193         int i;
 194
 195         memset(&params, 0, sizeof(params));
 196
 197         params[GUC_CTL_DEVICE_INFO] |=
 198                 (get_gttype(dev_priv) << GUC_CTL_GTTYPE_SHIFT) |
 199                 (get_core_family(dev_priv) << GUC_CTL_COREFAMILY_SHIFT);
 200
 201         /*
 202          * GuC ARAT increment is 10 ns. GuC default scheduler quantum is one
 203          * second. This ARAR is calculated by:
 204          * Scheduler-Quantum-in-ns / ARAT-increment-in-ns = 1000000000 / 10
 205          */
 206         params[GUC_CTL_ARAT_HIGH] = 0;
 207         params[GUC_CTL_ARAT_LOW] = 100000000;
 208
 209         params[GUC_CTL_WA] |= GUC_CTL_WA_UK_BY_DRIVER;
 210
 211         params[GUC_CTL_FEATURE] |= GUC_CTL_DISABLE_SCHEDULER |
 212                         GUC_CTL_VCS2_ENABLED;
 213
 214         if (i915.guc_log_level >= 0) {
 215                 params[GUC_CTL_LOG_PARAMS] = guc->log_flags;
 216                 params[GUC_CTL_DEBUG] =
 217                         i915.guc_log_level << GUC_LOG_VERBOSITY_SHIFT;
 218         }
 219
 220         if (guc->ads_vma) {
 221                 u32 ads = i915_ggtt_offset(guc->ads_vma) >> PAGE_SHIFT;
 222                 params[GUC_CTL_DEBUG] |= ads << GUC_ADS_ADDR_SHIFT;
 223                 params[GUC_CTL_DEBUG] |= GUC_ADS_ENABLED;
 224         }
 225
 226         /* If GuC submission is enabled, set up additional parameters here */
 227         if (i915.enable_guc_submission) {
 228                 u32 pgs = i915_ggtt_offset(dev_priv->guc.ctx_pool_vma);
 229                 u32 ctx_in_16 = GUC_MAX_GPU_CONTEXTS / 16;
 230
 231                 pgs >>= PAGE_SHIFT;
 232                 params[GUC_CTL_CTXINFO] = (pgs << GUC_CTL_BASE_ADDR_SHIFT) |
 233                         (ctx_in_16 << GUC_CTL_CTXNUM_IN16_SHIFT);
 234
 235                 params[GUC_CTL_FEATURE] |= GUC_CTL_KERNEL_SUBMISSIONS;
 236
 237                 /* Unmask this bit to enable the GuC's internal scheduler */
 238                 params[GUC_CTL_FEATURE] &= ~GUC_CTL_DISABLE_SCHEDULER;
 239         }
 240
 241         I915_WRITE(SOFT_SCRATCH(0), 0);
 242
 243         for (i = 0; i < GUC_CTL_MAX_DWORDS; i++)
 244                 I915_WRITE(SOFT_SCRATCH(1 + i), params[i]);
 245 }
 246
 247 /*
 248  * Read the GuC status register (GUC_STATUS) and store it in the
 249  * specified location; then return a boolean indicating whether
 250  * the value matches either of two values representing completion
 251  * of the GuC boot process.
 252  *
 253  * This is used for polling the GuC status in a wait_for()
 254  * loop below.
 255  */
 256 static inline bool guc_ucode_response(struct drm_i915_private *dev_priv,
 257                                       u32 *status)
 258 {
 259         u32 val = I915_READ(GUC_STATUS);
 260         u32 uk_val = val & GS_UKERNEL_MASK;
 261         *status = val;
 262         return (uk_val == GS_UKERNEL_READY ||
 263                 ((val & GS_MIA_CORE_STATE) && uk_val == GS_UKERNEL_LAPIC_DONE));
 264 }
 265
 266 /*
 267  * Transfer the firmware image to RAM for execution by the microcontroller.
 268  *
 269  * Architecturally, the DMA engine is bidirectional, and can potentially even
 270  * transfer between GTT locations. This functionality is left out of the API
 271  * for now as there is no need for it.
 272  *
 273  * Note that GuC needs the CSS header plus uKernel code to be copied by the
 274  * DMA engine in one operation, whereas the RSA signature is loaded via MMIO.
 275  */
 276 static int guc_ucode_xfer_dma(struct drm_i915_private *dev_priv,
 277                               struct i915_vma *vma)
 278 {
 279         struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw;
 280         unsigned long offset;
 281         struct sg_table *sg = vma->pages;
 282         u32 status, rsa[UOS_RSA_SCRATCH_MAX_COUNT];
 283         int i, ret = 0;
 284
 285         /* where RSA signature starts */
 286         offset = guc_fw->rsa_offset;
 287
 288         /* Copy RSA signature from the fw image to HW for verification */
 289         sg_pcopy_to_buffer(sg->sgl, sg->nents, rsa, sizeof(rsa), offset);
 290         for (i = 0; i < UOS_RSA_SCRATCH_MAX_COUNT; i++)
 291                 I915_WRITE(UOS_RSA_SCRATCH(i), rsa[i]);
 292
 293         /* The header plus uCode will be copied to WOPCM via DMA, excluding any
 294          * other components */
 295         I915_WRITE(DMA_COPY_SIZE, guc_fw->header_size + guc_fw->ucode_size);
 296
 297         /* Set the source address for the new blob */
 298         offset = i915_ggtt_offset(vma) + guc_fw->header_offset;
 299         I915_WRITE(DMA_ADDR_0_LOW, lower_32_bits(offset));
 300         I915_WRITE(DMA_ADDR_0_HIGH, upper_32_bits(offset) & 0xFFFF);
 301
 302         /*
 303          * Set the DMA destination. Current uCode expects the code to be
 304          * loaded at 8k; locations below this are used for the stack.
 305          */
 306         I915_WRITE(DMA_ADDR_1_LOW, 0x2000);
 307         I915_WRITE(DMA_ADDR_1_HIGH, DMA_ADDRESS_SPACE_WOPCM);
 308
 309         /* Finally start the DMA */
 310         I915_WRITE(DMA_CTRL, _MASKED_BIT_ENABLE(UOS_MOVE | START_DMA));
 311
 312         /*
 313          * Wait for the DMA to complete & the GuC to start up.
 314          * NB: Docs recommend not using the interrupt for completion.
 315          * Measurements indicate this should take no more than 20ms, so a
 316          * timeout here indicates that the GuC has failed and is unusable.
 317          * (Higher levels of the driver will attempt to fall back to
 318          * execlist mode if this happens.)
 319          */
 320         ret = wait_for(guc_ucode_response(dev_priv, &status), 100);
 321
 322         DRM_DEBUG_DRIVER("DMA status 0x%x, GuC status 0x%x\n",
 323                         I915_READ(DMA_CTRL), status);
 324
 325         if ((status & GS_BOOTROM_MASK) == GS_BOOTROM_RSA_FAILED) {
 326                 DRM_ERROR("GuC firmware signature verification failed\n");
 327                 ret = -ENOEXEC;
 328         }
 329
 330         DRM_DEBUG_DRIVER("returning %d\n", ret);
 331
 332         return ret;
 333 }
 334
 335 static u32 guc_wopcm_size(struct drm_i915_private *dev_priv)
 336 {
 337         u32 wopcm_size = GUC_WOPCM_TOP;
 338
 339         /* On BXT, the top of WOPCM is reserved for RC6 context */
 340         if (IS_BROXTON(dev_priv))
 341                 wopcm_size -= BXT_GUC_WOPCM_RC6_RESERVED;
 342
 343         return wopcm_size;
 344 }
 345
 346 /*
 347  * Load the GuC firmware blob into the MinuteIA.
 348  */
 349 static int guc_ucode_xfer(struct drm_i915_private *dev_priv)
 350 {
 351         struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw;
 352         struct i915_vma *vma;
 353         int ret;
 354
 355         ret = i915_gem_object_set_to_gtt_domain(guc_fw->guc_fw_obj, false);
 356         if (ret) {
 357                 DRM_DEBUG_DRIVER("set-domain failed %d\n", ret);
 358                 return ret;
 359         }
 360
 361         vma = i915_gem_object_ggtt_pin(guc_fw->guc_fw_obj, NULL, 0, 0, 0);
 362         if (IS_ERR(vma)) {
 363                 DRM_DEBUG_DRIVER("pin failed %d\n", (int)PTR_ERR(vma));
 364                 return PTR_ERR(vma);
 365         }
 366
 367         /* Invalidate GuC TLB to let GuC take the latest updates to GTT. */
 368         I915_WRITE(GEN8_GTCR, GEN8_GTCR_INVALIDATE);
 369
 370         intel_uncore_forcewake_get(dev_priv, FORCEWAKE_ALL);
 371
 372         /* init WOPCM */
 373         I915_WRITE(GUC_WOPCM_SIZE, guc_wopcm_size(dev_priv));
 374         I915_WRITE(DMA_GUC_WOPCM_OFFSET, GUC_WOPCM_OFFSET_VALUE);
 375
 376         /* Enable MIA caching. GuC clock gating is disabled. */
 377         I915_WRITE(GUC_SHIM_CONTROL, GUC_SHIM_CONTROL_VALUE);
 378
 379         /* WaDisableMinuteIaClockGating:bxt */
 380         if (IS_BXT_REVID(dev_priv, 0, BXT_REVID_A1)) {
 381                 I915_WRITE(GUC_SHIM_CONTROL, (I915_READ(GUC_SHIM_CONTROL) &
 382                                               ~GUC_ENABLE_MIA_CLOCK_GATING));
 383         }
 384
 385         /* WaC6DisallowByGfxPause:bxt */
 386         if (IS_BXT_REVID(dev_priv, 0, BXT_REVID_B0))
 387                 I915_WRITE(GEN6_GFXPAUSE, 0x30FFF);
 388
 389         if (IS_BROXTON(dev_priv))
 390                 I915_WRITE(GEN9LP_GT_PM_CONFIG, GT_DOORBELL_ENABLE);
 391         else
 392                 I915_WRITE(GEN9_GT_PM_CONFIG, GT_DOORBELL_ENABLE);
 393
 394         if (IS_GEN9(dev_priv)) {
 395                 /* DOP Clock Gating Enable for GuC clocks */
 396                 I915_WRITE(GEN7_MISCCPCTL, (GEN8_DOP_CLOCK_GATE_GUC_ENABLE |
 397                                             I915_READ(GEN7_MISCCPCTL)));
 398
 399                 /* allows for 5us (in 10ns units) before GT can go to RC6 */
 400                 I915_WRITE(GUC_ARAT_C6DIS, 0x1FF);
 401         }
 402
 403         guc_params_init(dev_priv);
 404
 405         ret = guc_ucode_xfer_dma(dev_priv, vma);
 406
 407         intel_uncore_forcewake_put(dev_priv, FORCEWAKE_ALL);
 408
 409         /*
 410          * We keep the object pages for reuse during resume. But we can unpin it
 411          * now that DMA has completed, so it doesn't continue to take up space.
 412          */
 413         i915_vma_unpin(vma);
 414
 415         return ret;
 416 }
 417
 418 static int guc_hw_reset(struct drm_i915_private *dev_priv)
 419 {
 420         int ret;
 421         u32 guc_status;
 422
 423         ret = intel_guc_reset(dev_priv);
 424         if (ret) {
 425                 DRM_ERROR("GuC reset failed, ret = %d\n", ret);
 426                 return ret;
 427         }
 428
 429         guc_status = I915_READ(GUC_STATUS);
 430         WARN(!(guc_status & GS_MIA_IN_RESET),
 431              "GuC status: 0x%x, MIA core expected to be in reset\n", guc_status);
 432
 433         return ret;
 434 }
 435
 436 /**
 437  * intel_guc_setup() - finish preparing the GuC for activity
 438  * @dev:        drm device
 439  *
 440  * Called from gem_init_hw() during driver loading and also after a GPU reset.
 441  *
 442  * The main action required here it to load the GuC uCode into the device.
 443  * The firmware image should have already been fetched into memory by the
 444  * earlier call to intel_guc_init(), so here we need only check that worked,
 445  * and then transfer the image to the h/w.
 446  *
 447  * Return:      non-zero code on error
 448  */
 449 int intel_guc_setup(struct drm_device *dev)
 450 {
 451         struct drm_i915_private *dev_priv = to_i915(dev);
 452         struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw;
 453         const char *fw_path = guc_fw->guc_fw_path;
 454         int retries, ret, err;
 455
 456         DRM_DEBUG_DRIVER("GuC fw status: path %s, fetch %s, load %s\n",
 457                 fw_path,
 458                 intel_guc_fw_status_repr(guc_fw->guc_fw_fetch_status),
 459                 intel_guc_fw_status_repr(guc_fw->guc_fw_load_status));
 460
 461         /* Loading forbidden, or no firmware to load? */
 462         if (!i915.enable_guc_loading) {
 463                 err = 0;
 464                 goto fail;
 465         } else if (fw_path == NULL) {
 466                 /* Device is known to have no uCode (e.g. no GuC) */
 467                 err = -ENXIO;
 468                 goto fail;
 469         } else if (*fw_path == '\0') {
 470                 /* Device has a GuC but we don't know what f/w to load? */
 471                 WARN(1, "No GuC firmware known for this platform!\n");
 472                 err = -ENODEV;
 473                 goto fail;
 474         }
 475
 476         /* Fetch failed, or already fetched but failed to load? */
 477         if (guc_fw->guc_fw_fetch_status != GUC_FIRMWARE_SUCCESS) {
 478                 err = -EIO;
 479                 goto fail;
 480         } else if (guc_fw->guc_fw_load_status == GUC_FIRMWARE_FAIL) {
 481                 err = -ENOEXEC;
 482                 goto fail;
 483         }
 484
 485         guc_interrupts_release(dev_priv);
 486
 487         guc_fw->guc_fw_load_status = GUC_FIRMWARE_PENDING;
 488
 489         DRM_DEBUG_DRIVER("GuC fw status: fetch %s, load %s\n",
 490                 intel_guc_fw_status_repr(guc_fw->guc_fw_fetch_status),
 491                 intel_guc_fw_status_repr(guc_fw->guc_fw_load_status));
 492
 493         err = i915_guc_submission_init(dev_priv);
 494         if (err)
 495                 goto fail;
 496
 497         /*
 498          * WaEnableuKernelHeaderValidFix:skl,bxt
 499          * For BXT, this is only upto B0 but below WA is required for later
 500          * steppings also so this is extended as well.
 501          */
 502         /* WaEnableGuCBootHashCheckNotSet:skl,bxt */
 503         for (retries = 3; ; ) {
 504                 /*
 505                  * Always reset the GuC just before (re)loading, so
 506                  * that the state and timing are fairly predictable
 507                  */
 508                 err = guc_hw_reset(dev_priv);
 509                 if (err)
 510                         goto fail;
 511
 512                 err = guc_ucode_xfer(dev_priv);
 513                 if (!err)
 514                         break;
 515
 516                 if (--retries == 0)
 517                         goto fail;
 518
 519                 DRM_INFO("GuC fw load failed: %d; will reset and "
 520                          "retry %d more time(s)\n", err, retries);
 521         }
 522
 523         guc_fw->guc_fw_load_status = GUC_FIRMWARE_SUCCESS;
 524
 525         DRM_DEBUG_DRIVER("GuC fw status: fetch %s, load %s\n",
 526                 intel_guc_fw_status_repr(guc_fw->guc_fw_fetch_status),
 527                 intel_guc_fw_status_repr(guc_fw->guc_fw_load_status));
 528
 529         if (i915.enable_guc_submission) {
 530                 err = i915_guc_submission_enable(dev_priv);
 531                 if (err)
 532                         goto fail;
 533                 guc_interrupts_capture(dev_priv);
 534         }
 535
 536         return 0;
 537
 538 fail:
 539         if (guc_fw->guc_fw_load_status == GUC_FIRMWARE_PENDING)
 540                 guc_fw->guc_fw_load_status = GUC_FIRMWARE_FAIL;
 541
 542         guc_interrupts_release(dev_priv);
 543         i915_guc_submission_disable(dev_priv);
 544         i915_guc_submission_fini(dev_priv);
 545
 546         /*
 547          * We've failed to load the firmware :(
 548          *
 549          * Decide whether to disable GuC submission and fall back to
 550          * execlist mode, and whether to hide the error by returning
 551          * zero or to return -EIO, which the caller will treat as a
 552          * nonfatal error (i.e. it doesn't prevent driver load, but
 553          * marks the GPU as wedged until reset).
 554          */
 555         if (i915.enable_guc_loading > 1) {
 556                 ret = -EIO;
 557         } else if (i915.enable_guc_submission > 1) {
 558                 ret = -EIO;
 559         } else {
 560                 ret = 0;
 561         }
 562
 563         if (err == 0 && !HAS_GUC_UCODE(dev))
 564                 ;       /* Don't mention the GuC! */
 565         else if (err == 0)
 566                 DRM_INFO("GuC firmware load skipped\n");
 567         else if (ret != -EIO)
 568                 DRM_NOTE("GuC firmware load failed: %d\n", err);
 569         else
 570                 DRM_WARN("GuC firmware load failed: %d\n", err);
 571
 572         if (i915.enable_guc_submission) {
 573                 if (fw_path == NULL)
 574                         DRM_INFO("GuC submission without firmware not supported\n");
 575                 if (ret == 0)
 576                         DRM_NOTE("Falling back from GuC submission to execlist mode\n");
 577                 else
 578                         DRM_ERROR("GuC init failed: %d\n", ret);
 579         }
 580         i915.enable_guc_submission = 0;
 581
 582         return ret;
 583 }
 584
 585 static void guc_fw_fetch(struct drm_device *dev, struct intel_guc_fw *guc_fw)
 586 {
 587         struct pci_dev *pdev = dev->pdev;
 588         struct drm_i915_gem_object *obj;
 589         const struct firmware *fw;
 590         struct guc_css_header *css;
 591         size_t size;
 592         int err;
 593
 594         DRM_DEBUG_DRIVER("before requesting firmware: GuC fw fetch status %s\n",
 595                 intel_guc_fw_status_repr(guc_fw->guc_fw_fetch_status));
 596
 597         err = request_firmware(&fw, guc_fw->guc_fw_path, &pdev->dev);
 598         if (err)
 599                 goto fail;
 600         if (!fw)
 601                 goto fail;
 602
 603         DRM_DEBUG_DRIVER("fetch GuC fw from %s succeeded, fw %p\n",
 604                 guc_fw->guc_fw_path, fw);
 605
 606         /* Check the size of the blob before examining buffer contents */
 607         if (fw->size < sizeof(struct guc_css_header)) {
 608                 DRM_NOTE("Firmware header is missing\n");
 609                 goto fail;
 610         }
 611
 612         css = (struct guc_css_header *)fw->data;
 613
 614         /* Firmware bits always start from header */
 615         guc_fw->header_offset = 0;
 616         guc_fw->header_size = (css->header_size_dw - css->modulus_size_dw -
 617                 css->key_size_dw - css->exponent_size_dw) * sizeof(u32);
 618
 619         if (guc_fw->header_size != sizeof(struct guc_css_header)) {
 620                 DRM_NOTE("CSS header definition mismatch\n");
 621                 goto fail;
 622         }
 623
 624         /* then, uCode */
 625         guc_fw->ucode_offset = guc_fw->header_offset + guc_fw->header_size;
 626         guc_fw->ucode_size = (css->size_dw - css->header_size_dw) * sizeof(u32);
 627
 628         /* now RSA */
 629         if (css->key_size_dw != UOS_RSA_SCRATCH_MAX_COUNT) {
 630                 DRM_NOTE("RSA key size is bad\n");
 631                 goto fail;
 632         }
 633         guc_fw->rsa_offset = guc_fw->ucode_offset + guc_fw->ucode_size;
 634         guc_fw->rsa_size = css->key_size_dw * sizeof(u32);
 635
 636         /* At least, it should have header, uCode and RSA. Size of all three. */
 637         size = guc_fw->header_size + guc_fw->ucode_size + guc_fw->rsa_size;
 638         if (fw->size < size) {
 639                 DRM_NOTE("Missing firmware components\n");
 640                 goto fail;
 641         }
 642
 643         /* Header and uCode will be loaded to WOPCM. Size of the two. */
 644         size = guc_fw->header_size + guc_fw->ucode_size;
 645         if (size > guc_wopcm_size(to_i915(dev))) {
 646                 DRM_NOTE("Firmware is too large to fit in WOPCM\n");
 647                 goto fail;
 648         }
 649
 650         /*
 651          * The GuC firmware image has the version number embedded at a well-known
 652          * offset within the firmware blob; note that major / minor version are
 653          * TWO bytes each (i.e. u16), although all pointers and offsets are defined
 654          * in terms of bytes (u8).
 655          */
 656         guc_fw->guc_fw_major_found = css->guc_sw_version >> 16;
 657         guc_fw->guc_fw_minor_found = css->guc_sw_version & 0xFFFF;
 658
 659         if (guc_fw->guc_fw_major_found != guc_fw->guc_fw_major_wanted ||
 660             guc_fw->guc_fw_minor_found < guc_fw->guc_fw_minor_wanted) {
 661                 DRM_NOTE("GuC firmware version %d.%d, required %d.%d\n",
 662                         guc_fw->guc_fw_major_found, guc_fw->guc_fw_minor_found,
 663                         guc_fw->guc_fw_major_wanted, guc_fw->guc_fw_minor_wanted);
 664                 err = -ENOEXEC;
 665                 goto fail;
 666         }
 667
 668         DRM_DEBUG_DRIVER("firmware version %d.%d OK (minimum %d.%d)\n",
 669                         guc_fw->guc_fw_major_found, guc_fw->guc_fw_minor_found,
 670                         guc_fw->guc_fw_major_wanted, guc_fw->guc_fw_minor_wanted);
 671
 672         mutex_lock(&dev->struct_mutex);
 673         obj = i915_gem_object_create_from_data(dev, fw->data, fw->size);
 674         mutex_unlock(&dev->struct_mutex);
 675         if (IS_ERR_OR_NULL(obj)) {
 676                 err = obj ? PTR_ERR(obj) : -ENOMEM;
 677                 goto fail;
 678         }
 679
 680         guc_fw->guc_fw_obj = obj;
 681         guc_fw->guc_fw_size = fw->size;
 682
 683         DRM_DEBUG_DRIVER("GuC fw fetch status SUCCESS, obj %p\n",
 684                         guc_fw->guc_fw_obj);
 685
 686         release_firmware(fw);
 687         guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_SUCCESS;
 688         return;
 689
 690 fail:
 691         DRM_WARN("Failed to fetch valid GuC firmware from %s (error %d)\n",
 692                  guc_fw->guc_fw_path, err);
 693         DRM_DEBUG_DRIVER("GuC fw fetch status FAIL; err %d, fw %p, obj %p\n",
 694                 err, fw, guc_fw->guc_fw_obj);
 695
 696         mutex_lock(&dev->struct_mutex);
 697         obj = guc_fw->guc_fw_obj;
 698         if (obj)
 699                 i915_gem_object_put(obj);
 700         guc_fw->guc_fw_obj = NULL;
 701         mutex_unlock(&dev->struct_mutex);
 702
 703         release_firmware(fw);           /* OK even if fw is NULL */
 704         guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_FAIL;
 705 }
 706
 707 /**
 708  * intel_guc_init() - define parameters and fetch firmware
 709  * @dev:        drm device
 710  *
 711  * Called early during driver load, but after GEM is initialised.
 712  *
 713  * The firmware will be transferred to the GuC's memory later,
 714  * when intel_guc_setup() is called.
 715  */
 716 void intel_guc_init(struct drm_device *dev)
 717 {
 718         struct drm_i915_private *dev_priv = to_i915(dev);
 719         struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw;
 720         const char *fw_path;
 721
 722         if (!HAS_GUC(dev)) {
 723                 i915.enable_guc_loading = 0;
 724                 i915.enable_guc_submission = 0;
 725         } else {
 726                 /* A negative value means "use platform default" */
 727                 if (i915.enable_guc_loading < 0)
 728                         i915.enable_guc_loading = HAS_GUC_UCODE(dev);
 729                 if (i915.enable_guc_submission < 0)
 730                         i915.enable_guc_submission = HAS_GUC_SCHED(dev);
 731         }
 732
 733         if (!HAS_GUC_UCODE(dev)) {
 734                 fw_path = NULL;
 735         } else if (IS_SKYLAKE(dev_priv)) {
 736                 fw_path = I915_SKL_GUC_UCODE;
 737                 guc_fw->guc_fw_major_wanted = SKL_FW_MAJOR;
 738                 guc_fw->guc_fw_minor_wanted = SKL_FW_MINOR;
 739         } else if (IS_BROXTON(dev_priv)) {
 740                 fw_path = I915_BXT_GUC_UCODE;
 741                 guc_fw->guc_fw_major_wanted = BXT_FW_MAJOR;
 742                 guc_fw->guc_fw_minor_wanted = BXT_FW_MINOR;
 743         } else if (IS_KABYLAKE(dev_priv)) {
 744                 fw_path = I915_KBL_GUC_UCODE;
 745                 guc_fw->guc_fw_major_wanted = KBL_FW_MAJOR;
 746                 guc_fw->guc_fw_minor_wanted = KBL_FW_MINOR;
 747         } else {
 748                 fw_path = "";   /* unknown device */
 749         }
 750
 751         guc_fw->guc_dev = dev;
 752         guc_fw->guc_fw_path = fw_path;
 753         guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_NONE;
 754         guc_fw->guc_fw_load_status = GUC_FIRMWARE_NONE;
 755
 756         /* Early (and silent) return if GuC loading is disabled */
 757         if (!i915.enable_guc_loading)
 758                 return;
 759         if (fw_path == NULL)
 760                 return;
 761         if (*fw_path == '\0')
 762                 return;
 763
 764         guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_PENDING;
 765         DRM_DEBUG_DRIVER("GuC firmware pending, path %s\n", fw_path);
 766         guc_fw_fetch(dev, guc_fw);
 767         /* status must now be FAIL or SUCCESS */
 768 }
 769
 770 /**
 771  * intel_guc_fini() - clean up all allocated resources
 772  * @dev:        drm device
 773  */
 774 void intel_guc_fini(struct drm_device *dev)
 775 {
 776         struct drm_i915_private *dev_priv = to_i915(dev);
 777         struct intel_guc_fw *guc_fw = &dev_priv->guc.guc_fw;
 778
 779         mutex_lock(&dev->struct_mutex);
 780         guc_interrupts_release(dev_priv);
 781         i915_guc_submission_disable(dev_priv);
 782         i915_guc_submission_fini(dev_priv);
 783
 784         if (guc_fw->guc_fw_obj)
 785                 i915_gem_object_put(guc_fw->guc_fw_obj);
 786         guc_fw->guc_fw_obj = NULL;
 787         mutex_unlock(&dev->struct_mutex);
 788
 789         guc_fw->guc_fw_fetch_status = GUC_FIRMWARE_NONE;
 790 }