1 // SPDX-License-Identifier: MIT
3 * Copyright © 2016-2019 Intel Corporation
6 #include "gt/intel_gt.h"
7 #include "gt/intel_reset.h"
9 #include "intel_guc_ads.h"
10 #include "intel_guc_submission.h"
15 static const struct intel_uc_ops uc_ops_off;
16 static const struct intel_uc_ops uc_ops_on;
18 static void uc_expand_default_options(struct intel_uc *uc)
20 struct drm_i915_private *i915 = uc_to_gt(uc)->i915;
22 if (i915->params.enable_guc != -1)
25 /* Don't enable GuC/HuC on pre-Gen12 */
26 if (GRAPHICS_VER(i915) < 12) {
27 i915->params.enable_guc = 0;
31 /* Don't enable GuC/HuC on older Gen12 platforms */
32 if (IS_TIGERLAKE(i915) || IS_ROCKETLAKE(i915)) {
33 i915->params.enable_guc = 0;
37 /* Intermediate platforms are HuC authentication only */
38 if (IS_DG1(i915) || IS_ALDERLAKE_S(i915)) {
39 i915->params.enable_guc = ENABLE_GUC_LOAD_HUC;
43 /* Default: enable HuC authentication and GuC submission */
44 i915->params.enable_guc = ENABLE_GUC_LOAD_HUC | ENABLE_GUC_SUBMISSION;
47 /* Reset GuC providing us with fresh state for both GuC and HuC.
49 static int __intel_uc_reset_hw(struct intel_uc *uc)
51 struct intel_gt *gt = uc_to_gt(uc);
55 ret = i915_inject_probe_error(gt->i915, -ENXIO);
59 ret = intel_reset_guc(gt);
61 DRM_ERROR("Failed to reset GuC, ret = %d\n", ret);
65 guc_status = intel_uncore_read(gt->uncore, GUC_STATUS);
66 WARN(!(guc_status & GS_MIA_IN_RESET),
67 "GuC status: 0x%x, MIA core expected to be in reset\n",
73 static void __confirm_options(struct intel_uc *uc)
75 struct drm_i915_private *i915 = uc_to_gt(uc)->i915;
78 "enable_guc=%d (guc:%s submission:%s huc:%s slpc:%s)\n",
79 i915->params.enable_guc,
80 yesno(intel_uc_wants_guc(uc)),
81 yesno(intel_uc_wants_guc_submission(uc)),
82 yesno(intel_uc_wants_huc(uc)),
83 yesno(intel_uc_wants_guc_slpc(uc)));
85 if (i915->params.enable_guc == 0) {
86 GEM_BUG_ON(intel_uc_wants_guc(uc));
87 GEM_BUG_ON(intel_uc_wants_guc_submission(uc));
88 GEM_BUG_ON(intel_uc_wants_huc(uc));
89 GEM_BUG_ON(intel_uc_wants_guc_slpc(uc));
93 if (!intel_uc_supports_guc(uc))
95 "Incompatible option enable_guc=%d - %s\n",
96 i915->params.enable_guc, "GuC is not supported!");
98 if (i915->params.enable_guc & ENABLE_GUC_LOAD_HUC &&
99 !intel_uc_supports_huc(uc))
101 "Incompatible option enable_guc=%d - %s\n",
102 i915->params.enable_guc, "HuC is not supported!");
104 if (i915->params.enable_guc & ENABLE_GUC_SUBMISSION &&
105 !intel_uc_supports_guc_submission(uc))
107 "Incompatible option enable_guc=%d - %s\n",
108 i915->params.enable_guc, "GuC submission is N/A");
110 if (i915->params.enable_guc & ~ENABLE_GUC_MASK)
112 "Incompatible option enable_guc=%d - %s\n",
113 i915->params.enable_guc, "undocumented flag");
116 void intel_uc_init_early(struct intel_uc *uc)
118 uc_expand_default_options(uc);
120 intel_guc_init_early(&uc->guc);
121 intel_huc_init_early(&uc->huc);
123 __confirm_options(uc);
125 if (intel_uc_wants_guc(uc))
126 uc->ops = &uc_ops_on;
128 uc->ops = &uc_ops_off;
131 void intel_uc_init_late(struct intel_uc *uc)
133 intel_guc_init_late(&uc->guc);
136 void intel_uc_driver_late_release(struct intel_uc *uc)
141 * intel_uc_init_mmio - setup uC MMIO access
142 * @uc: the intel_uc structure
144 * Setup minimal state necessary for MMIO accesses later in the
145 * initialization sequence.
147 void intel_uc_init_mmio(struct intel_uc *uc)
149 intel_guc_init_send_regs(&uc->guc);
152 static void __uc_capture_load_err_log(struct intel_uc *uc)
154 struct intel_guc *guc = &uc->guc;
156 if (guc->log.vma && !uc->load_err_log)
157 uc->load_err_log = i915_gem_object_get(guc->log.vma->obj);
160 static void __uc_free_load_err_log(struct intel_uc *uc)
162 struct drm_i915_gem_object *log = fetch_and_zero(&uc->load_err_log);
165 i915_gem_object_put(log);
168 void intel_uc_driver_remove(struct intel_uc *uc)
170 intel_uc_fini_hw(uc);
172 __uc_free_load_err_log(uc);
175 static inline bool guc_communication_enabled(struct intel_guc *guc)
177 return intel_guc_ct_enabled(&guc->ct);
181 * Events triggered while CT buffers are disabled are logged in the SCRATCH_15
182 * register using the same bits used in the CT message payload. Since our
183 * communication channel with guc is turned off at this point, we can save the
184 * message and handle it after we turn it back on.
186 static void guc_clear_mmio_msg(struct intel_guc *guc)
188 intel_uncore_write(guc_to_gt(guc)->uncore, SOFT_SCRATCH(15), 0);
191 static void guc_get_mmio_msg(struct intel_guc *guc)
195 spin_lock_irq(&guc->irq_lock);
197 val = intel_uncore_read(guc_to_gt(guc)->uncore, SOFT_SCRATCH(15));
198 guc->mmio_msg |= val & guc->msg_enabled_mask;
201 * clear all events, including the ones we're not currently servicing,
202 * to make sure we don't try to process a stale message if we enable
203 * handling of more events later.
205 guc_clear_mmio_msg(guc);
207 spin_unlock_irq(&guc->irq_lock);
210 static void guc_handle_mmio_msg(struct intel_guc *guc)
212 /* we need communication to be enabled to reply to GuC */
213 GEM_BUG_ON(!guc_communication_enabled(guc));
215 spin_lock_irq(&guc->irq_lock);
217 intel_guc_to_host_process_recv_msg(guc, &guc->mmio_msg, 1);
220 spin_unlock_irq(&guc->irq_lock);
223 static int guc_enable_communication(struct intel_guc *guc)
225 struct intel_gt *gt = guc_to_gt(guc);
226 struct drm_i915_private *i915 = gt->i915;
229 GEM_BUG_ON(guc_communication_enabled(guc));
231 ret = i915_inject_probe_error(i915, -ENXIO);
235 ret = intel_guc_ct_enable(&guc->ct);
239 /* check for mmio messages received before/during the CT enable */
240 guc_get_mmio_msg(guc);
241 guc_handle_mmio_msg(guc);
243 intel_guc_enable_interrupts(guc);
245 /* check for CT messages received before we enabled interrupts */
246 spin_lock_irq(>->irq_lock);
247 intel_guc_ct_event_handler(&guc->ct);
248 spin_unlock_irq(>->irq_lock);
250 drm_dbg(&i915->drm, "GuC communication enabled\n");
255 static void guc_disable_communication(struct intel_guc *guc)
257 struct drm_i915_private *i915 = guc_to_gt(guc)->i915;
260 * Events generated during or after CT disable are logged by guc in
261 * via mmio. Make sure the register is clear before disabling CT since
262 * all events we cared about have already been processed via CT.
264 guc_clear_mmio_msg(guc);
266 intel_guc_disable_interrupts(guc);
268 intel_guc_ct_disable(&guc->ct);
271 * Check for messages received during/after the CT disable. We do not
272 * expect any messages to have arrived via CT between the interrupt
273 * disable and the CT disable because GuC should've been idle until we
274 * triggered the CT disable protocol.
276 guc_get_mmio_msg(guc);
278 drm_dbg(&i915->drm, "GuC communication disabled\n");
281 static void __uc_fetch_firmwares(struct intel_uc *uc)
285 GEM_BUG_ON(!intel_uc_wants_guc(uc));
287 err = intel_uc_fw_fetch(&uc->guc.fw);
289 /* Make sure we transition out of transient "SELECTED" state */
290 if (intel_uc_wants_huc(uc)) {
291 drm_dbg(&uc_to_gt(uc)->i915->drm,
292 "Failed to fetch GuC: %d disabling HuC\n", err);
293 intel_uc_fw_change_status(&uc->huc.fw,
294 INTEL_UC_FIRMWARE_ERROR);
300 if (intel_uc_wants_huc(uc))
301 intel_uc_fw_fetch(&uc->huc.fw);
304 static void __uc_cleanup_firmwares(struct intel_uc *uc)
306 intel_uc_fw_cleanup_fetch(&uc->huc.fw);
307 intel_uc_fw_cleanup_fetch(&uc->guc.fw);
310 static int __uc_init(struct intel_uc *uc)
312 struct intel_guc *guc = &uc->guc;
313 struct intel_huc *huc = &uc->huc;
316 GEM_BUG_ON(!intel_uc_wants_guc(uc));
318 if (!intel_uc_uses_guc(uc))
321 if (i915_inject_probe_failure(uc_to_gt(uc)->i915))
324 ret = intel_guc_init(guc);
328 if (intel_uc_uses_huc(uc)) {
329 ret = intel_huc_init(huc);
341 static void __uc_fini(struct intel_uc *uc)
343 intel_huc_fini(&uc->huc);
344 intel_guc_fini(&uc->guc);
347 static int __uc_sanitize(struct intel_uc *uc)
349 struct intel_guc *guc = &uc->guc;
350 struct intel_huc *huc = &uc->huc;
352 GEM_BUG_ON(!intel_uc_supports_guc(uc));
354 intel_huc_sanitize(huc);
355 intel_guc_sanitize(guc);
357 return __intel_uc_reset_hw(uc);
360 /* Initialize and verify the uC regs related to uC positioning in WOPCM */
361 static int uc_init_wopcm(struct intel_uc *uc)
363 struct intel_gt *gt = uc_to_gt(uc);
364 struct intel_uncore *uncore = gt->uncore;
365 u32 base = intel_wopcm_guc_base(>->i915->wopcm);
366 u32 size = intel_wopcm_guc_size(>->i915->wopcm);
367 u32 huc_agent = intel_uc_uses_huc(uc) ? HUC_LOADING_AGENT_GUC : 0;
371 if (unlikely(!base || !size)) {
372 i915_probe_error(gt->i915, "Unsuccessful WOPCM partitioning\n");
376 GEM_BUG_ON(!intel_uc_supports_guc(uc));
377 GEM_BUG_ON(!(base & GUC_WOPCM_OFFSET_MASK));
378 GEM_BUG_ON(base & ~GUC_WOPCM_OFFSET_MASK);
379 GEM_BUG_ON(!(size & GUC_WOPCM_SIZE_MASK));
380 GEM_BUG_ON(size & ~GUC_WOPCM_SIZE_MASK);
382 err = i915_inject_probe_error(gt->i915, -ENXIO);
386 mask = GUC_WOPCM_SIZE_MASK | GUC_WOPCM_SIZE_LOCKED;
387 err = intel_uncore_write_and_verify(uncore, GUC_WOPCM_SIZE, size, mask,
388 size | GUC_WOPCM_SIZE_LOCKED);
392 mask = GUC_WOPCM_OFFSET_MASK | GUC_WOPCM_OFFSET_VALID | huc_agent;
393 err = intel_uncore_write_and_verify(uncore, DMA_GUC_WOPCM_OFFSET,
394 base | huc_agent, mask,
396 GUC_WOPCM_OFFSET_VALID);
403 i915_probe_error(gt->i915, "Failed to init uC WOPCM registers!\n");
404 i915_probe_error(gt->i915, "%s(%#x)=%#x\n", "DMA_GUC_WOPCM_OFFSET",
405 i915_mmio_reg_offset(DMA_GUC_WOPCM_OFFSET),
406 intel_uncore_read(uncore, DMA_GUC_WOPCM_OFFSET));
407 i915_probe_error(gt->i915, "%s(%#x)=%#x\n", "GUC_WOPCM_SIZE",
408 i915_mmio_reg_offset(GUC_WOPCM_SIZE),
409 intel_uncore_read(uncore, GUC_WOPCM_SIZE));
414 static bool uc_is_wopcm_locked(struct intel_uc *uc)
416 struct intel_gt *gt = uc_to_gt(uc);
417 struct intel_uncore *uncore = gt->uncore;
419 return (intel_uncore_read(uncore, GUC_WOPCM_SIZE) & GUC_WOPCM_SIZE_LOCKED) ||
420 (intel_uncore_read(uncore, DMA_GUC_WOPCM_OFFSET) & GUC_WOPCM_OFFSET_VALID);
423 static int __uc_check_hw(struct intel_uc *uc)
425 if (!intel_uc_supports_guc(uc))
429 * We can silently continue without GuC only if it was never enabled
430 * before on this system after reboot, otherwise we risk GPU hangs.
431 * To check if GuC was loaded before we look at WOPCM registers.
433 if (uc_is_wopcm_locked(uc))
439 static int __uc_init_hw(struct intel_uc *uc)
441 struct drm_i915_private *i915 = uc_to_gt(uc)->i915;
442 struct intel_guc *guc = &uc->guc;
443 struct intel_huc *huc = &uc->huc;
446 GEM_BUG_ON(!intel_uc_supports_guc(uc));
447 GEM_BUG_ON(!intel_uc_wants_guc(uc));
449 if (!intel_uc_fw_is_loadable(&guc->fw)) {
450 ret = __uc_check_hw(uc) ||
451 intel_uc_fw_is_overridden(&guc->fw) ||
452 intel_uc_wants_guc_submission(uc) ?
453 intel_uc_fw_status_to_error(guc->fw.status) : 0;
457 ret = uc_init_wopcm(uc);
461 intel_guc_reset_interrupts(guc);
463 /* WaEnableuKernelHeaderValidFix:skl */
464 /* WaEnableGuCBootHashCheckNotSet:skl,bxt,kbl */
465 if (GRAPHICS_VER(i915) == 9)
472 * Always reset the GuC just before (re)loading, so
473 * that the state and timing are fairly predictable
475 ret = __uc_sanitize(uc);
479 intel_huc_fw_upload(huc);
480 intel_guc_ads_reset(guc);
481 intel_guc_write_params(guc);
482 ret = intel_guc_fw_upload(guc);
486 DRM_DEBUG_DRIVER("GuC fw load failed: %d; will reset and "
487 "retry %d more time(s)\n", ret, attempts);
490 /* Did we succeded or run out of retries? */
492 goto err_log_capture;
494 ret = guc_enable_communication(guc);
496 goto err_log_capture;
500 if (intel_uc_uses_guc_submission(uc))
501 intel_guc_submission_enable(guc);
503 if (intel_uc_uses_guc_slpc(uc)) {
504 ret = intel_guc_slpc_enable(&guc->slpc);
509 drm_info(&i915->drm, "%s firmware %s version %u.%u %s:%s\n",
510 intel_uc_fw_type_repr(INTEL_UC_FW_TYPE_GUC), guc->fw.path,
511 guc->fw.major_ver_found, guc->fw.minor_ver_found,
513 enableddisabled(intel_uc_uses_guc_submission(uc)));
515 drm_info(&i915->drm, "GuC SLPC: %s\n",
516 enableddisabled(intel_uc_uses_guc_slpc(uc)));
518 if (intel_uc_uses_huc(uc)) {
519 drm_info(&i915->drm, "%s firmware %s version %u.%u %s:%s\n",
520 intel_uc_fw_type_repr(INTEL_UC_FW_TYPE_HUC),
522 huc->fw.major_ver_found, huc->fw.minor_ver_found,
524 yesno(intel_huc_is_authenticated(huc)));
530 * We've failed to load the firmware :(
533 intel_guc_submission_disable(guc);
535 __uc_capture_load_err_log(uc);
540 drm_notice(&i915->drm, "GuC is uninitialized\n");
541 /* We want to run without GuC submission */
545 i915_probe_error(i915, "GuC initialization failed %d\n", ret);
547 /* We want to keep KMS alive */
551 static void __uc_fini_hw(struct intel_uc *uc)
553 struct intel_guc *guc = &uc->guc;
555 if (!intel_guc_is_fw_running(guc))
558 if (intel_uc_uses_guc_submission(uc))
559 intel_guc_submission_disable(guc);
565 * intel_uc_reset_prepare - Prepare for reset
566 * @uc: the intel_uc structure
568 * Preparing for full gpu reset.
570 void intel_uc_reset_prepare(struct intel_uc *uc)
572 struct intel_guc *guc = &uc->guc;
574 uc->reset_in_progress = true;
576 /* Nothing to do if GuC isn't supported */
577 if (!intel_uc_supports_guc(uc))
580 /* Firmware expected to be running when this function is called */
581 if (!intel_guc_is_ready(guc))
584 if (intel_uc_uses_guc_submission(uc))
585 intel_guc_submission_reset_prepare(guc);
591 void intel_uc_reset(struct intel_uc *uc, bool stalled)
593 struct intel_guc *guc = &uc->guc;
595 /* Firmware can not be running when this function is called */
596 if (intel_uc_uses_guc_submission(uc))
597 intel_guc_submission_reset(guc, stalled);
600 void intel_uc_reset_finish(struct intel_uc *uc)
602 struct intel_guc *guc = &uc->guc;
604 uc->reset_in_progress = false;
606 /* Firmware expected to be running when this function is called */
607 if (intel_guc_is_fw_running(guc) && intel_uc_uses_guc_submission(uc))
608 intel_guc_submission_reset_finish(guc);
611 void intel_uc_cancel_requests(struct intel_uc *uc)
613 struct intel_guc *guc = &uc->guc;
615 /* Firmware can not be running when this function is called */
616 if (intel_uc_uses_guc_submission(uc))
617 intel_guc_submission_cancel_requests(guc);
620 void intel_uc_runtime_suspend(struct intel_uc *uc)
622 struct intel_guc *guc = &uc->guc;
624 if (!intel_guc_is_ready(guc))
628 * Wait for any outstanding CTB before tearing down communication /w the
631 #define OUTSTANDING_CTB_TIMEOUT_PERIOD (HZ / 5)
632 intel_guc_wait_for_pending_msg(guc, &guc->outstanding_submission_g2h,
633 false, OUTSTANDING_CTB_TIMEOUT_PERIOD);
634 GEM_WARN_ON(atomic_read(&guc->outstanding_submission_g2h));
636 guc_disable_communication(guc);
639 void intel_uc_suspend(struct intel_uc *uc)
641 struct intel_guc *guc = &uc->guc;
642 intel_wakeref_t wakeref;
645 if (!intel_guc_is_ready(guc))
648 with_intel_runtime_pm(&uc_to_gt(uc)->i915->runtime_pm, wakeref) {
649 err = intel_guc_suspend(guc);
651 DRM_DEBUG_DRIVER("Failed to suspend GuC, err=%d", err);
655 static int __uc_resume(struct intel_uc *uc, bool enable_communication)
657 struct intel_guc *guc = &uc->guc;
658 struct intel_gt *gt = guc_to_gt(guc);
661 if (!intel_guc_is_fw_running(guc))
664 /* Make sure we enable communication if and only if it's disabled */
665 GEM_BUG_ON(enable_communication == guc_communication_enabled(guc));
667 if (enable_communication)
668 guc_enable_communication(guc);
670 /* If we are only resuming GuC communication but not reloading
671 * GuC, we need to ensure the ARAT timer interrupt is enabled
672 * again. In case of GuC reload, it is enabled during SLPC enable.
674 if (enable_communication && intel_uc_uses_guc_slpc(uc))
675 intel_guc_pm_intrmsk_enable(gt);
677 err = intel_guc_resume(guc);
679 DRM_DEBUG_DRIVER("Failed to resume GuC, err=%d", err);
686 int intel_uc_resume(struct intel_uc *uc)
689 * When coming out of S3/S4 we sanitize and re-init the HW, so
690 * communication is already re-enabled at this point.
692 return __uc_resume(uc, false);
695 int intel_uc_runtime_resume(struct intel_uc *uc)
698 * During runtime resume we don't sanitize, so we need to re-init
699 * communication as well.
701 return __uc_resume(uc, true);
704 static const struct intel_uc_ops uc_ops_off = {
705 .init_hw = __uc_check_hw,
708 static const struct intel_uc_ops uc_ops_on = {
709 .sanitize = __uc_sanitize,
711 .init_fw = __uc_fetch_firmwares,
712 .fini_fw = __uc_cleanup_firmwares,
717 .init_hw = __uc_init_hw,
718 .fini_hw = __uc_fini_hw,