drivers/gpu/drm/i915/intel_uncore.c

   1 /*
   2  * Copyright © 2013 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
  24 #include <linux/pm_runtime.h>
  25
  26 #include "gt/intel_engine_regs.h"
  27 #include "gt/intel_gt_regs.h"
  28
  29 #include "i915_drv.h"
  30 #include "i915_iosf_mbi.h"
  31 #include "i915_trace.h"
  32 #include "i915_vgpu.h"
  33 #include "intel_pm.h"
  34
  35 #define FORCEWAKE_ACK_TIMEOUT_MS 50
  36 #define GT_FIFO_TIMEOUT_MS       10
  37
  38 #define __raw_posting_read(...) ((void)__raw_uncore_read32(__VA_ARGS__))
  39
  40 static void
  41 fw_domains_get(struct intel_uncore *uncore, enum forcewake_domains fw_domains)
  42 {
  43         uncore->fw_get_funcs->force_wake_get(uncore, fw_domains);
  44 }
  45
  46 void
  47 intel_uncore_mmio_debug_init_early(struct intel_uncore_mmio_debug *mmio_debug)
  48 {
  49         spin_lock_init(&mmio_debug->lock);
  50         mmio_debug->unclaimed_mmio_check = 1;
  51 }
  52
  53 static void mmio_debug_suspend(struct intel_uncore_mmio_debug *mmio_debug)
  54 {
  55         lockdep_assert_held(&mmio_debug->lock);
  56
  57         /* Save and disable mmio debugging for the user bypass */
  58         if (!mmio_debug->suspend_count++) {
  59                 mmio_debug->saved_mmio_check = mmio_debug->unclaimed_mmio_check;
  60                 mmio_debug->unclaimed_mmio_check = 0;
  61         }
  62 }
  63
  64 static void mmio_debug_resume(struct intel_uncore_mmio_debug *mmio_debug)
  65 {
  66         lockdep_assert_held(&mmio_debug->lock);
  67
  68         if (!--mmio_debug->suspend_count)
  69                 mmio_debug->unclaimed_mmio_check = mmio_debug->saved_mmio_check;
  70 }
  71
  72 static const char * const forcewake_domain_names[] = {
  73         "render",
  74         "gt",
  75         "media",
  76         "vdbox0",
  77         "vdbox1",
  78         "vdbox2",
  79         "vdbox3",
  80         "vdbox4",
  81         "vdbox5",
  82         "vdbox6",
  83         "vdbox7",
  84         "vebox0",
  85         "vebox1",
  86         "vebox2",
  87         "vebox3",
  88 };
  89
  90 const char *
  91 intel_uncore_forcewake_domain_to_str(const enum forcewake_domain_id id)
  92 {
  93         BUILD_BUG_ON(ARRAY_SIZE(forcewake_domain_names) != FW_DOMAIN_ID_COUNT);
  94
  95         if (id >= 0 && id < FW_DOMAIN_ID_COUNT)
  96                 return forcewake_domain_names[id];
  97
  98         WARN_ON(id);
  99
 100         return "unknown";
 101 }
 102
 103 #define fw_ack(d) readl((d)->reg_ack)
 104 #define fw_set(d, val) writel(_MASKED_BIT_ENABLE((val)), (d)->reg_set)
 105 #define fw_clear(d, val) writel(_MASKED_BIT_DISABLE((val)), (d)->reg_set)
 106
 107 static inline void
 108 fw_domain_reset(const struct intel_uncore_forcewake_domain *d)
 109 {
 110         /*
 111          * We don't really know if the powerwell for the forcewake domain we are
 112          * trying to reset here does exist at this point (engines could be fused
 113          * off in ICL+), so no waiting for acks
 114          */
 115         /* WaRsClearFWBitsAtReset:bdw,skl */
 116         fw_clear(d, 0xffff);
 117 }
 118
 119 static inline void
 120 fw_domain_arm_timer(struct intel_uncore_forcewake_domain *d)
 121 {
 122         GEM_BUG_ON(d->uncore->fw_domains_timer & d->mask);
 123         d->uncore->fw_domains_timer |= d->mask;
 124         d->wake_count++;
 125         hrtimer_start_range_ns(&d->timer,
 126                                NSEC_PER_MSEC,
 127                                NSEC_PER_MSEC,
 128                                HRTIMER_MODE_REL);
 129 }
 130
 131 static inline int
 132 __wait_for_ack(const struct intel_uncore_forcewake_domain *d,
 133                const u32 ack,
 134                const u32 value)
 135 {
 136         return wait_for_atomic((fw_ack(d) & ack) == value,
 137                                FORCEWAKE_ACK_TIMEOUT_MS);
 138 }
 139
 140 static inline int
 141 wait_ack_clear(const struct intel_uncore_forcewake_domain *d,
 142                const u32 ack)
 143 {
 144         return __wait_for_ack(d, ack, 0);
 145 }
 146
 147 static inline int
 148 wait_ack_set(const struct intel_uncore_forcewake_domain *d,
 149              const u32 ack)
 150 {
 151         return __wait_for_ack(d, ack, ack);
 152 }
 153
 154 static inline void
 155 fw_domain_wait_ack_clear(const struct intel_uncore_forcewake_domain *d)
 156 {
 157         if (wait_ack_clear(d, FORCEWAKE_KERNEL)) {
 158                 DRM_ERROR("%s: timed out waiting for forcewake ack to clear.\n",
 159                           intel_uncore_forcewake_domain_to_str(d->id));
 160                 add_taint_for_CI(d->uncore->i915, TAINT_WARN); /* CI now unreliable */
 161         }
 162 }
 163
 164 enum ack_type {
 165         ACK_CLEAR = 0,
 166         ACK_SET
 167 };
 168
 169 static int
 170 fw_domain_wait_ack_with_fallback(const struct intel_uncore_forcewake_domain *d,
 171                                  const enum ack_type type)
 172 {
 173         const u32 ack_bit = FORCEWAKE_KERNEL;
 174         const u32 value = type == ACK_SET ? ack_bit : 0;
 175         unsigned int pass;
 176         bool ack_detected;
 177
 178         /*
 179          * There is a possibility of driver's wake request colliding
 180          * with hardware's own wake requests and that can cause
 181          * hardware to not deliver the driver's ack message.
 182          *
 183          * Use a fallback bit toggle to kick the gpu state machine
 184          * in the hope that the original ack will be delivered along with
 185          * the fallback ack.
 186          *
 187          * This workaround is described in HSDES #1604254524 and it's known as:
 188          * WaRsForcewakeAddDelayForAck:skl,bxt,kbl,glk,cfl,cnl,icl
 189          * although the name is a bit misleading.
 190          */
 191
 192         pass = 1;
 193         do {
 194                 wait_ack_clear(d, FORCEWAKE_KERNEL_FALLBACK);
 195
 196                 fw_set(d, FORCEWAKE_KERNEL_FALLBACK);
 197                 /* Give gt some time to relax before the polling frenzy */
 198                 udelay(10 * pass);
 199                 wait_ack_set(d, FORCEWAKE_KERNEL_FALLBACK);
 200
 201                 ack_detected = (fw_ack(d) & ack_bit) == value;
 202
 203                 fw_clear(d, FORCEWAKE_KERNEL_FALLBACK);
 204         } while (!ack_detected && pass++ < 10);
 205
 206         DRM_DEBUG_DRIVER("%s had to use fallback to %s ack, 0x%x (passes %u)\n",
 207                          intel_uncore_forcewake_domain_to_str(d->id),
 208                          type == ACK_SET ? "set" : "clear",
 209                          fw_ack(d),
 210                          pass);
 211
 212         return ack_detected ? 0 : -ETIMEDOUT;
 213 }
 214
 215 static inline void
 216 fw_domain_wait_ack_clear_fallback(const struct intel_uncore_forcewake_domain *d)
 217 {
 218         if (likely(!wait_ack_clear(d, FORCEWAKE_KERNEL)))
 219                 return;
 220
 221         if (fw_domain_wait_ack_with_fallback(d, ACK_CLEAR))
 222                 fw_domain_wait_ack_clear(d);
 223 }
 224
 225 static inline void
 226 fw_domain_get(const struct intel_uncore_forcewake_domain *d)
 227 {
 228         fw_set(d, FORCEWAKE_KERNEL);
 229 }
 230
 231 static inline void
 232 fw_domain_wait_ack_set(const struct intel_uncore_forcewake_domain *d)
 233 {
 234         if (wait_ack_set(d, FORCEWAKE_KERNEL)) {
 235                 DRM_ERROR("%s: timed out waiting for forcewake ack request.\n",
 236                           intel_uncore_forcewake_domain_to_str(d->id));
 237                 add_taint_for_CI(d->uncore->i915, TAINT_WARN); /* CI now unreliable */
 238         }
 239 }
 240
 241 static inline void
 242 fw_domain_wait_ack_set_fallback(const struct intel_uncore_forcewake_domain *d)
 243 {
 244         if (likely(!wait_ack_set(d, FORCEWAKE_KERNEL)))
 245                 return;
 246
 247         if (fw_domain_wait_ack_with_fallback(d, ACK_SET))
 248                 fw_domain_wait_ack_set(d);
 249 }
 250
 251 static inline void
 252 fw_domain_put(const struct intel_uncore_forcewake_domain *d)
 253 {
 254         fw_clear(d, FORCEWAKE_KERNEL);
 255 }
 256
 257 static void
 258 fw_domains_get_normal(struct intel_uncore *uncore, enum forcewake_domains fw_domains)
 259 {
 260         struct intel_uncore_forcewake_domain *d;
 261         unsigned int tmp;
 262
 263         GEM_BUG_ON(fw_domains & ~uncore->fw_domains);
 264
 265         for_each_fw_domain_masked(d, fw_domains, uncore, tmp) {
 266                 fw_domain_wait_ack_clear(d);
 267                 fw_domain_get(d);
 268         }
 269
 270         for_each_fw_domain_masked(d, fw_domains, uncore, tmp)
 271                 fw_domain_wait_ack_set(d);
 272
 273         uncore->fw_domains_active |= fw_domains;
 274 }
 275
 276 static void
 277 fw_domains_get_with_fallback(struct intel_uncore *uncore,
 278                              enum forcewake_domains fw_domains)
 279 {
 280         struct intel_uncore_forcewake_domain *d;
 281         unsigned int tmp;
 282
 283         GEM_BUG_ON(fw_domains & ~uncore->fw_domains);
 284
 285         for_each_fw_domain_masked(d, fw_domains, uncore, tmp) {
 286                 fw_domain_wait_ack_clear_fallback(d);
 287                 fw_domain_get(d);
 288         }
 289
 290         for_each_fw_domain_masked(d, fw_domains, uncore, tmp)
 291                 fw_domain_wait_ack_set_fallback(d);
 292
 293         uncore->fw_domains_active |= fw_domains;
 294 }
 295
 296 static void
 297 fw_domains_put(struct intel_uncore *uncore, enum forcewake_domains fw_domains)
 298 {
 299         struct intel_uncore_forcewake_domain *d;
 300         unsigned int tmp;
 301
 302         GEM_BUG_ON(fw_domains & ~uncore->fw_domains);
 303
 304         for_each_fw_domain_masked(d, fw_domains, uncore, tmp)
 305                 fw_domain_put(d);
 306
 307         uncore->fw_domains_active &= ~fw_domains;
 308 }
 309
 310 static void
 311 fw_domains_reset(struct intel_uncore *uncore,
 312                  enum forcewake_domains fw_domains)
 313 {
 314         struct intel_uncore_forcewake_domain *d;
 315         unsigned int tmp;
 316
 317         if (!fw_domains)
 318                 return;
 319
 320         GEM_BUG_ON(fw_domains & ~uncore->fw_domains);
 321
 322         for_each_fw_domain_masked(d, fw_domains, uncore, tmp)
 323                 fw_domain_reset(d);
 324 }
 325
 326 static inline u32 gt_thread_status(struct intel_uncore *uncore)
 327 {
 328         u32 val;
 329
 330         val = __raw_uncore_read32(uncore, GEN6_GT_THREAD_STATUS_REG);
 331         val &= GEN6_GT_THREAD_STATUS_CORE_MASK;
 332
 333         return val;
 334 }
 335
 336 static void __gen6_gt_wait_for_thread_c0(struct intel_uncore *uncore)
 337 {
 338         /*
 339          * w/a for a sporadic read returning 0 by waiting for the GT
 340          * thread to wake up.
 341          */
 342         drm_WARN_ONCE(&uncore->i915->drm,
 343                       wait_for_atomic_us(gt_thread_status(uncore) == 0, 5000),
 344                       "GT thread status wait timed out\n");
 345 }
 346
 347 static void fw_domains_get_with_thread_status(struct intel_uncore *uncore,
 348                                               enum forcewake_domains fw_domains)
 349 {
 350         fw_domains_get_normal(uncore, fw_domains);
 351
 352         /* WaRsForcewakeWaitTC0:snb,ivb,hsw,bdw,vlv */
 353         __gen6_gt_wait_for_thread_c0(uncore);
 354 }
 355
 356 static inline u32 fifo_free_entries(struct intel_uncore *uncore)
 357 {
 358         u32 count = __raw_uncore_read32(uncore, GTFIFOCTL);
 359
 360         return count & GT_FIFO_FREE_ENTRIES_MASK;
 361 }
 362
 363 static void __gen6_gt_wait_for_fifo(struct intel_uncore *uncore)
 364 {
 365         u32 n;
 366
 367         /* On VLV, FIFO will be shared by both SW and HW.
 368          * So, we need to read the FREE_ENTRIES everytime */
 369         if (IS_VALLEYVIEW(uncore->i915))
 370                 n = fifo_free_entries(uncore);
 371         else
 372                 n = uncore->fifo_count;
 373
 374         if (n <= GT_FIFO_NUM_RESERVED_ENTRIES) {
 375                 if (wait_for_atomic((n = fifo_free_entries(uncore)) >
 376                                     GT_FIFO_NUM_RESERVED_ENTRIES,
 377                                     GT_FIFO_TIMEOUT_MS)) {
 378                         drm_dbg(&uncore->i915->drm,
 379                                 "GT_FIFO timeout, entries: %u\n", n);
 380                         return;
 381                 }
 382         }
 383
 384         uncore->fifo_count = n - 1;
 385 }
 386
 387 static enum hrtimer_restart
 388 intel_uncore_fw_release_timer(struct hrtimer *timer)
 389 {
 390         struct intel_uncore_forcewake_domain *domain =
 391                container_of(timer, struct intel_uncore_forcewake_domain, timer);
 392         struct intel_uncore *uncore = domain->uncore;
 393         unsigned long irqflags;
 394
 395         assert_rpm_device_not_suspended(uncore->rpm);
 396
 397         if (xchg(&domain->active, false))
 398                 return HRTIMER_RESTART;
 399
 400         spin_lock_irqsave(&uncore->lock, irqflags);
 401
 402         uncore->fw_domains_timer &= ~domain->mask;
 403
 404         GEM_BUG_ON(!domain->wake_count);
 405         if (--domain->wake_count == 0)
 406                 fw_domains_put(uncore, domain->mask);
 407
 408         spin_unlock_irqrestore(&uncore->lock, irqflags);
 409
 410         return HRTIMER_NORESTART;
 411 }
 412
 413 /* Note callers must have acquired the PUNIT->PMIC bus, before calling this. */
 414 static unsigned int
 415 intel_uncore_forcewake_reset(struct intel_uncore *uncore)
 416 {
 417         unsigned long irqflags;
 418         struct intel_uncore_forcewake_domain *domain;
 419         int retry_count = 100;
 420         enum forcewake_domains fw, active_domains;
 421
 422         iosf_mbi_assert_punit_acquired();
 423
 424         /* Hold uncore.lock across reset to prevent any register access
 425          * with forcewake not set correctly. Wait until all pending
 426          * timers are run before holding.
 427          */
 428         while (1) {
 429                 unsigned int tmp;
 430
 431                 active_domains = 0;
 432
 433                 for_each_fw_domain(domain, uncore, tmp) {
 434                         smp_store_mb(domain->active, false);
 435                         if (hrtimer_cancel(&domain->timer) == 0)
 436                                 continue;
 437
 438                         intel_uncore_fw_release_timer(&domain->timer);
 439                 }
 440
 441                 spin_lock_irqsave(&uncore->lock, irqflags);
 442
 443                 for_each_fw_domain(domain, uncore, tmp) {
 444                         if (hrtimer_active(&domain->timer))
 445                                 active_domains |= domain->mask;
 446                 }
 447
 448                 if (active_domains == 0)
 449                         break;
 450
 451                 if (--retry_count == 0) {
 452                         drm_err(&uncore->i915->drm, "Timed out waiting for forcewake timers to finish\n");
 453                         break;
 454                 }
 455
 456                 spin_unlock_irqrestore(&uncore->lock, irqflags);
 457                 cond_resched();
 458         }
 459
 460         drm_WARN_ON(&uncore->i915->drm, active_domains);
 461
 462         fw = uncore->fw_domains_active;
 463         if (fw)
 464                 fw_domains_put(uncore, fw);
 465
 466         fw_domains_reset(uncore, uncore->fw_domains);
 467         assert_forcewakes_inactive(uncore);
 468
 469         spin_unlock_irqrestore(&uncore->lock, irqflags);
 470
 471         return fw; /* track the lost user forcewake domains */
 472 }
 473
 474 static bool
 475 fpga_check_for_unclaimed_mmio(struct intel_uncore *uncore)
 476 {
 477         u32 dbg;
 478
 479         dbg = __raw_uncore_read32(uncore, FPGA_DBG);
 480         if (likely(!(dbg & FPGA_DBG_RM_NOCLAIM)))
 481                 return false;
 482
 483         /*
 484          * Bugs in PCI programming (or failing hardware) can occasionally cause
 485          * us to lose access to the MMIO BAR.  When this happens, register
 486          * reads will come back with 0xFFFFFFFF for every register and things
 487          * go bad very quickly.  Let's try to detect that special case and at
 488          * least try to print a more informative message about what has
 489          * happened.
 490          *
 491          * During normal operation the FPGA_DBG register has several unused
 492          * bits that will always read back as 0's so we can use them as canaries
 493          * to recognize when MMIO accesses are just busted.
 494          */
 495         if (unlikely(dbg == ~0))
 496                 drm_err(&uncore->i915->drm,
 497                         "Lost access to MMIO BAR; all registers now read back as 0xFFFFFFFF!\n");
 498
 499         __raw_uncore_write32(uncore, FPGA_DBG, FPGA_DBG_RM_NOCLAIM);
 500
 501         return true;
 502 }
 503
 504 static bool
 505 vlv_check_for_unclaimed_mmio(struct intel_uncore *uncore)
 506 {
 507         u32 cer;
 508
 509         cer = __raw_uncore_read32(uncore, CLAIM_ER);
 510         if (likely(!(cer & (CLAIM_ER_OVERFLOW | CLAIM_ER_CTR_MASK))))
 511                 return false;
 512
 513         __raw_uncore_write32(uncore, CLAIM_ER, CLAIM_ER_CLR);
 514
 515         return true;
 516 }
 517
 518 static bool
 519 gen6_check_for_fifo_debug(struct intel_uncore *uncore)
 520 {
 521         u32 fifodbg;
 522
 523         fifodbg = __raw_uncore_read32(uncore, GTFIFODBG);
 524
 525         if (unlikely(fifodbg)) {
 526                 drm_dbg(&uncore->i915->drm, "GTFIFODBG = 0x08%x\n", fifodbg);
 527                 __raw_uncore_write32(uncore, GTFIFODBG, fifodbg);
 528         }
 529
 530         return fifodbg;
 531 }
 532
 533 static bool
 534 check_for_unclaimed_mmio(struct intel_uncore *uncore)
 535 {
 536         bool ret = false;
 537
 538         lockdep_assert_held(&uncore->debug->lock);
 539
 540         if (uncore->debug->suspend_count)
 541                 return false;
 542
 543         if (intel_uncore_has_fpga_dbg_unclaimed(uncore))
 544                 ret |= fpga_check_for_unclaimed_mmio(uncore);
 545
 546         if (intel_uncore_has_dbg_unclaimed(uncore))
 547                 ret |= vlv_check_for_unclaimed_mmio(uncore);
 548
 549         if (intel_uncore_has_fifo(uncore))
 550                 ret |= gen6_check_for_fifo_debug(uncore);
 551
 552         return ret;
 553 }
 554
 555 static void forcewake_early_sanitize(struct intel_uncore *uncore,
 556                                      unsigned int restore_forcewake)
 557 {
 558         GEM_BUG_ON(!intel_uncore_has_forcewake(uncore));
 559
 560         /* WaDisableShadowRegForCpd:chv */
 561         if (IS_CHERRYVIEW(uncore->i915)) {
 562                 __raw_uncore_write32(uncore, GTFIFOCTL,
 563                                      __raw_uncore_read32(uncore, GTFIFOCTL) |
 564                                      GT_FIFO_CTL_BLOCK_ALL_POLICY_STALL |
 565                                      GT_FIFO_CTL_RC6_POLICY_STALL);
 566         }
 567
 568         iosf_mbi_punit_acquire();
 569         intel_uncore_forcewake_reset(uncore);
 570         if (restore_forcewake) {
 571                 spin_lock_irq(&uncore->lock);
 572                 fw_domains_get(uncore, restore_forcewake);
 573
 574                 if (intel_uncore_has_fifo(uncore))
 575                         uncore->fifo_count = fifo_free_entries(uncore);
 576                 spin_unlock_irq(&uncore->lock);
 577         }
 578         iosf_mbi_punit_release();
 579 }
 580
 581 void intel_uncore_suspend(struct intel_uncore *uncore)
 582 {
 583         if (!intel_uncore_has_forcewake(uncore))
 584                 return;
 585
 586         iosf_mbi_punit_acquire();
 587         iosf_mbi_unregister_pmic_bus_access_notifier_unlocked(
 588                 &uncore->pmic_bus_access_nb);
 589         uncore->fw_domains_saved = intel_uncore_forcewake_reset(uncore);
 590         iosf_mbi_punit_release();
 591 }
 592
 593 void intel_uncore_resume_early(struct intel_uncore *uncore)
 594 {
 595         unsigned int restore_forcewake;
 596
 597         if (intel_uncore_unclaimed_mmio(uncore))
 598                 drm_dbg(&uncore->i915->drm, "unclaimed mmio detected on resume, clearing\n");
 599
 600         if (!intel_uncore_has_forcewake(uncore))
 601                 return;
 602
 603         restore_forcewake = fetch_and_zero(&uncore->fw_domains_saved);
 604         forcewake_early_sanitize(uncore, restore_forcewake);
 605
 606         iosf_mbi_register_pmic_bus_access_notifier(&uncore->pmic_bus_access_nb);
 607 }
 608
 609 void intel_uncore_runtime_resume(struct intel_uncore *uncore)
 610 {
 611         if (!intel_uncore_has_forcewake(uncore))
 612                 return;
 613
 614         iosf_mbi_register_pmic_bus_access_notifier(&uncore->pmic_bus_access_nb);
 615 }
 616
 617 static void __intel_uncore_forcewake_get(struct intel_uncore *uncore,
 618                                          enum forcewake_domains fw_domains)
 619 {
 620         struct intel_uncore_forcewake_domain *domain;
 621         unsigned int tmp;
 622
 623         fw_domains &= uncore->fw_domains;
 624
 625         for_each_fw_domain_masked(domain, fw_domains, uncore, tmp) {
 626                 if (domain->wake_count++) {
 627                         fw_domains &= ~domain->mask;
 628                         domain->active = true;
 629                 }
 630         }
 631
 632         if (fw_domains)
 633                 fw_domains_get(uncore, fw_domains);
 634 }
 635
 636 /**
 637  * intel_uncore_forcewake_get - grab forcewake domain references
 638  * @uncore: the intel_uncore structure
 639  * @fw_domains: forcewake domains to get reference on
 640  *
 641  * This function can be used get GT's forcewake domain references.
 642  * Normal register access will handle the forcewake domains automatically.
 643  * However if some sequence requires the GT to not power down a particular
 644  * forcewake domains this function should be called at the beginning of the
 645  * sequence. And subsequently the reference should be dropped by symmetric
 646  * call to intel_unforce_forcewake_put(). Usually caller wants all the domains
 647  * to be kept awake so the @fw_domains would be then FORCEWAKE_ALL.
 648  */
 649 void intel_uncore_forcewake_get(struct intel_uncore *uncore,
 650                                 enum forcewake_domains fw_domains)
 651 {
 652         unsigned long irqflags;
 653
 654         if (!uncore->fw_get_funcs)
 655                 return;
 656
 657         assert_rpm_wakelock_held(uncore->rpm);
 658
 659         spin_lock_irqsave(&uncore->lock, irqflags);
 660         __intel_uncore_forcewake_get(uncore, fw_domains);
 661         spin_unlock_irqrestore(&uncore->lock, irqflags);
 662 }
 663
 664 /**
 665  * intel_uncore_forcewake_user_get - claim forcewake on behalf of userspace
 666  * @uncore: the intel_uncore structure
 667  *
 668  * This function is a wrapper around intel_uncore_forcewake_get() to acquire
 669  * the GT powerwell and in the process disable our debugging for the
 670  * duration of userspace's bypass.
 671  */
 672 void intel_uncore_forcewake_user_get(struct intel_uncore *uncore)
 673 {
 674         spin_lock_irq(&uncore->lock);
 675         if (!uncore->user_forcewake_count++) {
 676                 intel_uncore_forcewake_get__locked(uncore, FORCEWAKE_ALL);
 677                 spin_lock(&uncore->debug->lock);
 678                 mmio_debug_suspend(uncore->debug);
 679                 spin_unlock(&uncore->debug->lock);
 680         }
 681         spin_unlock_irq(&uncore->lock);
 682 }
 683
 684 /**
 685  * intel_uncore_forcewake_user_put - release forcewake on behalf of userspace
 686  * @uncore: the intel_uncore structure
 687  *
 688  * This function complements intel_uncore_forcewake_user_get() and releases
 689  * the GT powerwell taken on behalf of the userspace bypass.
 690  */
 691 void intel_uncore_forcewake_user_put(struct intel_uncore *uncore)
 692 {
 693         spin_lock_irq(&uncore->lock);
 694         if (!--uncore->user_forcewake_count) {
 695                 spin_lock(&uncore->debug->lock);
 696                 mmio_debug_resume(uncore->debug);
 697
 698                 if (check_for_unclaimed_mmio(uncore))
 699                         drm_info(&uncore->i915->drm,
 700                                  "Invalid mmio detected during user access\n");
 701                 spin_unlock(&uncore->debug->lock);
 702
 703                 intel_uncore_forcewake_put__locked(uncore, FORCEWAKE_ALL);
 704         }
 705         spin_unlock_irq(&uncore->lock);
 706 }
 707
 708 /**
 709  * intel_uncore_forcewake_get__locked - grab forcewake domain references
 710  * @uncore: the intel_uncore structure
 711  * @fw_domains: forcewake domains to get reference on
 712  *
 713  * See intel_uncore_forcewake_get(). This variant places the onus
 714  * on the caller to explicitly handle the dev_priv->uncore.lock spinlock.
 715  */
 716 void intel_uncore_forcewake_get__locked(struct intel_uncore *uncore,
 717                                         enum forcewake_domains fw_domains)
 718 {
 719         lockdep_assert_held(&uncore->lock);
 720
 721         if (!uncore->fw_get_funcs)
 722                 return;
 723
 724         __intel_uncore_forcewake_get(uncore, fw_domains);
 725 }
 726
 727 static void __intel_uncore_forcewake_put(struct intel_uncore *uncore,
 728                                          enum forcewake_domains fw_domains,
 729                                          bool delayed)
 730 {
 731         struct intel_uncore_forcewake_domain *domain;
 732         unsigned int tmp;
 733
 734         fw_domains &= uncore->fw_domains;
 735
 736         for_each_fw_domain_masked(domain, fw_domains, uncore, tmp) {
 737                 GEM_BUG_ON(!domain->wake_count);
 738
 739                 if (--domain->wake_count) {
 740                         domain->active = true;
 741                         continue;
 742                 }
 743
 744                 if (delayed &&
 745                     !(domain->uncore->fw_domains_timer & domain->mask))
 746                         fw_domain_arm_timer(domain);
 747                 else
 748                         fw_domains_put(uncore, domain->mask);
 749         }
 750 }
 751
 752 /**
 753  * intel_uncore_forcewake_put - release a forcewake domain reference
 754  * @uncore: the intel_uncore structure
 755  * @fw_domains: forcewake domains to put references
 756  *
 757  * This function drops the device-level forcewakes for specified
 758  * domains obtained by intel_uncore_forcewake_get().
 759  */
 760 void intel_uncore_forcewake_put(struct intel_uncore *uncore,
 761                                 enum forcewake_domains fw_domains)
 762 {
 763         unsigned long irqflags;
 764
 765         if (!uncore->fw_get_funcs)
 766                 return;
 767
 768         spin_lock_irqsave(&uncore->lock, irqflags);
 769         __intel_uncore_forcewake_put(uncore, fw_domains, false);
 770         spin_unlock_irqrestore(&uncore->lock, irqflags);
 771 }
 772
 773 void intel_uncore_forcewake_put_delayed(struct intel_uncore *uncore,
 774                                         enum forcewake_domains fw_domains)
 775 {
 776         unsigned long irqflags;
 777
 778         if (!uncore->fw_get_funcs)
 779                 return;
 780
 781         spin_lock_irqsave(&uncore->lock, irqflags);
 782         __intel_uncore_forcewake_put(uncore, fw_domains, true);
 783         spin_unlock_irqrestore(&uncore->lock, irqflags);
 784 }
 785
 786 /**
 787  * intel_uncore_forcewake_flush - flush the delayed release
 788  * @uncore: the intel_uncore structure
 789  * @fw_domains: forcewake domains to flush
 790  */
 791 void intel_uncore_forcewake_flush(struct intel_uncore *uncore,
 792                                   enum forcewake_domains fw_domains)
 793 {
 794         struct intel_uncore_forcewake_domain *domain;
 795         unsigned int tmp;
 796
 797         if (!uncore->fw_get_funcs)
 798                 return;
 799
 800         fw_domains &= uncore->fw_domains;
 801         for_each_fw_domain_masked(domain, fw_domains, uncore, tmp) {
 802                 WRITE_ONCE(domain->active, false);
 803                 if (hrtimer_cancel(&domain->timer))
 804                         intel_uncore_fw_release_timer(&domain->timer);
 805         }
 806 }
 807
 808 /**
 809  * intel_uncore_forcewake_put__locked - grab forcewake domain references
 810  * @uncore: the intel_uncore structure
 811  * @fw_domains: forcewake domains to get reference on
 812  *
 813  * See intel_uncore_forcewake_put(). This variant places the onus
 814  * on the caller to explicitly handle the dev_priv->uncore.lock spinlock.
 815  */
 816 void intel_uncore_forcewake_put__locked(struct intel_uncore *uncore,
 817                                         enum forcewake_domains fw_domains)
 818 {
 819         lockdep_assert_held(&uncore->lock);
 820
 821         if (!uncore->fw_get_funcs)
 822                 return;
 823
 824         __intel_uncore_forcewake_put(uncore, fw_domains, false);
 825 }
 826
 827 void assert_forcewakes_inactive(struct intel_uncore *uncore)
 828 {
 829         if (!uncore->fw_get_funcs)
 830                 return;
 831
 832         drm_WARN(&uncore->i915->drm, uncore->fw_domains_active,
 833                  "Expected all fw_domains to be inactive, but %08x are still on\n",
 834                  uncore->fw_domains_active);
 835 }
 836
 837 void assert_forcewakes_active(struct intel_uncore *uncore,
 838                               enum forcewake_domains fw_domains)
 839 {
 840         struct intel_uncore_forcewake_domain *domain;
 841         unsigned int tmp;
 842
 843         if (!IS_ENABLED(CONFIG_DRM_I915_DEBUG_RUNTIME_PM))
 844                 return;
 845
 846         if (!uncore->fw_get_funcs)
 847                 return;
 848
 849         spin_lock_irq(&uncore->lock);
 850
 851         assert_rpm_wakelock_held(uncore->rpm);
 852
 853         fw_domains &= uncore->fw_domains;
 854         drm_WARN(&uncore->i915->drm, fw_domains & ~uncore->fw_domains_active,
 855                  "Expected %08x fw_domains to be active, but %08x are off\n",
 856                  fw_domains, fw_domains & ~uncore->fw_domains_active);
 857
 858         /*
 859          * Check that the caller has an explicit wakeref and we don't mistake
 860          * it for the auto wakeref.
 861          */
 862         for_each_fw_domain_masked(domain, fw_domains, uncore, tmp) {
 863                 unsigned int actual = READ_ONCE(domain->wake_count);
 864                 unsigned int expect = 1;
 865
 866                 if (uncore->fw_domains_timer & domain->mask)
 867                         expect++; /* pending automatic release */
 868
 869                 if (drm_WARN(&uncore->i915->drm, actual < expect,
 870                              "Expected domain %d to be held awake by caller, count=%d\n",
 871                              domain->id, actual))
 872                         break;
 873         }
 874
 875         spin_unlock_irq(&uncore->lock);
 876 }
 877
 878 /* We give fast paths for the really cool registers */
 879 #define NEEDS_FORCE_WAKE(reg) ({ \
 880         u32 __reg = (reg); \
 881         __reg < 0x40000 || __reg >= GEN11_BSD_RING_BASE; \
 882 })
 883
 884 static int fw_range_cmp(u32 offset, const struct intel_forcewake_range *entry)
 885 {
 886         if (offset < entry->start)
 887                 return -1;
 888         else if (offset > entry->end)
 889                 return 1;
 890         else
 891                 return 0;
 892 }
 893
 894 /* Copied and "macroized" from lib/bsearch.c */
 895 #define BSEARCH(key, base, num, cmp) ({                                 \
 896         unsigned int start__ = 0, end__ = (num);                        \
 897         typeof(base) result__ = NULL;                                   \
 898         while (start__ < end__) {                                       \
 899                 unsigned int mid__ = start__ + (end__ - start__) / 2;   \
 900                 int ret__ = (cmp)((key), (base) + mid__);               \
 901                 if (ret__ < 0) {                                        \
 902                         end__ = mid__;                                  \
 903                 } else if (ret__ > 0) {                                 \
 904                         start__ = mid__ + 1;                            \
 905                 } else {                                                \
 906                         result__ = (base) + mid__;                      \
 907                         break;                                          \
 908                 }                                                       \
 909         }                                                               \
 910         result__;                                                       \
 911 })
 912
 913 static enum forcewake_domains
 914 find_fw_domain(struct intel_uncore *uncore, u32 offset)
 915 {
 916         const struct intel_forcewake_range *entry;
 917
 918         entry = BSEARCH(offset,
 919                         uncore->fw_domains_table,
 920                         uncore->fw_domains_table_entries,
 921                         fw_range_cmp);
 922
 923         if (!entry)
 924                 return 0;
 925
 926         /*
 927          * The list of FW domains depends on the SKU in gen11+ so we
 928          * can't determine it statically. We use FORCEWAKE_ALL and
 929          * translate it here to the list of available domains.
 930          */
 931         if (entry->domains == FORCEWAKE_ALL)
 932                 return uncore->fw_domains;
 933
 934         drm_WARN(&uncore->i915->drm, entry->domains & ~uncore->fw_domains,
 935                  "Uninitialized forcewake domain(s) 0x%x accessed at 0x%x\n",
 936                  entry->domains & ~uncore->fw_domains, offset);
 937
 938         return entry->domains;
 939 }
 940
 941 /*
 942  * Shadowed register tables describe special register ranges that i915 is
 943  * allowed to write to without acquiring forcewake.  If these registers' power
 944  * wells are down, the hardware will save values written by i915 to a shadow
 945  * copy and automatically transfer them into the real register the next time
 946  * the power well is woken up.  Shadowing only applies to writes; forcewake
 947  * must still be acquired when reading from registers in these ranges.
 948  *
 949  * The documentation for shadowed registers is somewhat spotty on older
 950  * platforms.  However missing registers from these lists is non-fatal; it just
 951  * means we'll wake up the hardware for some register accesses where we didn't
 952  * really need to.
 953  *
 954  * The ranges listed in these tables must be sorted by offset.
 955  *
 956  * When adding new tables here, please also add them to
 957  * intel_shadow_table_check() in selftests/intel_uncore.c so that they will be
 958  * scanned for obvious mistakes or typos by the selftests.
 959  */
 960
 961 static const struct i915_range gen8_shadowed_regs[] = {
 962         { .start =  0x2030, .end =  0x2030 },
 963         { .start =  0xA008, .end =  0xA00C },
 964         { .start = 0x12030, .end = 0x12030 },
 965         { .start = 0x1a030, .end = 0x1a030 },
 966         { .start = 0x22030, .end = 0x22030 },
 967 };
 968
 969 static const struct i915_range gen11_shadowed_regs[] = {
 970         { .start =   0x2030, .end =   0x2030 },
 971         { .start =   0x2550, .end =   0x2550 },
 972         { .start =   0xA008, .end =   0xA00C },
 973         { .start =  0x22030, .end =  0x22030 },
 974         { .start =  0x22230, .end =  0x22230 },
 975         { .start =  0x22510, .end =  0x22550 },
 976         { .start = 0x1C0030, .end = 0x1C0030 },
 977         { .start = 0x1C0230, .end = 0x1C0230 },
 978         { .start = 0x1C0510, .end = 0x1C0550 },
 979         { .start = 0x1C4030, .end = 0x1C4030 },
 980         { .start = 0x1C4230, .end = 0x1C4230 },
 981         { .start = 0x1C4510, .end = 0x1C4550 },
 982         { .start = 0x1C8030, .end = 0x1C8030 },
 983         { .start = 0x1C8230, .end = 0x1C8230 },
 984         { .start = 0x1C8510, .end = 0x1C8550 },
 985         { .start = 0x1D0030, .end = 0x1D0030 },
 986         { .start = 0x1D0230, .end = 0x1D0230 },
 987         { .start = 0x1D0510, .end = 0x1D0550 },
 988         { .start = 0x1D4030, .end = 0x1D4030 },
 989         { .start = 0x1D4230, .end = 0x1D4230 },
 990         { .start = 0x1D4510, .end = 0x1D4550 },
 991         { .start = 0x1D8030, .end = 0x1D8030 },
 992         { .start = 0x1D8230, .end = 0x1D8230 },
 993         { .start = 0x1D8510, .end = 0x1D8550 },
 994 };
 995
 996 static const struct i915_range gen12_shadowed_regs[] = {
 997         { .start =   0x2030, .end =   0x2030 },
 998         { .start =   0x2510, .end =   0x2550 },
 999         { .start =   0xA008, .end =   0xA00C },
1000         { .start =   0xA188, .end =   0xA188 },
1001         { .start =   0xA278, .end =   0xA278 },
1002         { .start =   0xA540, .end =   0xA56C },
1003         { .start =   0xC4C8, .end =   0xC4C8 },
1004         { .start =   0xC4D4, .end =   0xC4D4 },
1005         { .start =   0xC600, .end =   0xC600 },
1006         { .start =  0x22030, .end =  0x22030 },
1007         { .start =  0x22510, .end =  0x22550 },
1008         { .start = 0x1C0030, .end = 0x1C0030 },
1009         { .start = 0x1C0510, .end = 0x1C0550 },
1010         { .start = 0x1C4030, .end = 0x1C4030 },
1011         { .start = 0x1C4510, .end = 0x1C4550 },
1012         { .start = 0x1C8030, .end = 0x1C8030 },
1013         { .start = 0x1C8510, .end = 0x1C8550 },
1014         { .start = 0x1D0030, .end = 0x1D0030 },
1015         { .start = 0x1D0510, .end = 0x1D0550 },
1016         { .start = 0x1D4030, .end = 0x1D4030 },
1017         { .start = 0x1D4510, .end = 0x1D4550 },
1018         { .start = 0x1D8030, .end = 0x1D8030 },
1019         { .start = 0x1D8510, .end = 0x1D8550 },
1020
1021         /*
1022          * The rest of these ranges are specific to Xe_HP and beyond, but
1023          * are reserved/unused ranges on earlier gen12 platforms, so they can
1024          * be safely added to the gen12 table.
1025          */
1026         { .start = 0x1E0030, .end = 0x1E0030 },
1027         { .start = 0x1E0510, .end = 0x1E0550 },
1028         { .start = 0x1E4030, .end = 0x1E4030 },
1029         { .start = 0x1E4510, .end = 0x1E4550 },
1030         { .start = 0x1E8030, .end = 0x1E8030 },
1031         { .start = 0x1E8510, .end = 0x1E8550 },
1032         { .start = 0x1F0030, .end = 0x1F0030 },
1033         { .start = 0x1F0510, .end = 0x1F0550 },
1034         { .start = 0x1F4030, .end = 0x1F4030 },
1035         { .start = 0x1F4510, .end = 0x1F4550 },
1036         { .start = 0x1F8030, .end = 0x1F8030 },
1037         { .start = 0x1F8510, .end = 0x1F8550 },
1038 };
1039
1040 static const struct i915_range dg2_shadowed_regs[] = {
1041         { .start =   0x2030, .end =   0x2030 },
1042         { .start =   0x2510, .end =   0x2550 },
1043         { .start =   0xA008, .end =   0xA00C },
1044         { .start =   0xA188, .end =   0xA188 },
1045         { .start =   0xA278, .end =   0xA278 },
1046         { .start =   0xA540, .end =   0xA56C },
1047         { .start =   0xC4C8, .end =   0xC4C8 },
1048         { .start =   0xC4E0, .end =   0xC4E0 },
1049         { .start =   0xC600, .end =   0xC600 },
1050         { .start =   0xC658, .end =   0xC658 },
1051         { .start =  0x22030, .end =  0x22030 },
1052         { .start =  0x22510, .end =  0x22550 },
1053         { .start = 0x1C0030, .end = 0x1C0030 },
1054         { .start = 0x1C0510, .end = 0x1C0550 },
1055         { .start = 0x1C4030, .end = 0x1C4030 },
1056         { .start = 0x1C4510, .end = 0x1C4550 },
1057         { .start = 0x1C8030, .end = 0x1C8030 },
1058         { .start = 0x1C8510, .end = 0x1C8550 },
1059         { .start = 0x1D0030, .end = 0x1D0030 },
1060         { .start = 0x1D0510, .end = 0x1D0550 },
1061         { .start = 0x1D4030, .end = 0x1D4030 },
1062         { .start = 0x1D4510, .end = 0x1D4550 },
1063         { .start = 0x1D8030, .end = 0x1D8030 },
1064         { .start = 0x1D8510, .end = 0x1D8550 },
1065         { .start = 0x1E0030, .end = 0x1E0030 },
1066         { .start = 0x1E0510, .end = 0x1E0550 },
1067         { .start = 0x1E4030, .end = 0x1E4030 },
1068         { .start = 0x1E4510, .end = 0x1E4550 },
1069         { .start = 0x1E8030, .end = 0x1E8030 },
1070         { .start = 0x1E8510, .end = 0x1E8550 },
1071         { .start = 0x1F0030, .end = 0x1F0030 },
1072         { .start = 0x1F0510, .end = 0x1F0550 },
1073         { .start = 0x1F4030, .end = 0x1F4030 },
1074         { .start = 0x1F4510, .end = 0x1F4550 },
1075         { .start = 0x1F8030, .end = 0x1F8030 },
1076         { .start = 0x1F8510, .end = 0x1F8550 },
1077 };
1078
1079 static const struct i915_range pvc_shadowed_regs[] = {
1080         { .start =   0x2030, .end =   0x2030 },
1081         { .start =   0x2510, .end =   0x2550 },
1082         { .start =   0xA008, .end =   0xA00C },
1083         { .start =   0xA188, .end =   0xA188 },
1084         { .start =   0xA278, .end =   0xA278 },
1085         { .start =   0xA540, .end =   0xA56C },
1086         { .start =   0xC4C8, .end =   0xC4C8 },
1087         { .start =   0xC4E0, .end =   0xC4E0 },
1088         { .start =   0xC600, .end =   0xC600 },
1089         { .start =   0xC658, .end =   0xC658 },
1090         { .start =  0x22030, .end =  0x22030 },
1091         { .start =  0x22510, .end =  0x22550 },
1092         { .start = 0x1C0030, .end = 0x1C0030 },
1093         { .start = 0x1C0510, .end = 0x1C0550 },
1094         { .start = 0x1C4030, .end = 0x1C4030 },
1095         { .start = 0x1C4510, .end = 0x1C4550 },
1096         { .start = 0x1C8030, .end = 0x1C8030 },
1097         { .start = 0x1C8510, .end = 0x1C8550 },
1098         { .start = 0x1D0030, .end = 0x1D0030 },
1099         { .start = 0x1D0510, .end = 0x1D0550 },
1100         { .start = 0x1D4030, .end = 0x1D4030 },
1101         { .start = 0x1D4510, .end = 0x1D4550 },
1102         { .start = 0x1D8030, .end = 0x1D8030 },
1103         { .start = 0x1D8510, .end = 0x1D8550 },
1104         { .start = 0x1E0030, .end = 0x1E0030 },
1105         { .start = 0x1E0510, .end = 0x1E0550 },
1106         { .start = 0x1E4030, .end = 0x1E4030 },
1107         { .start = 0x1E4510, .end = 0x1E4550 },
1108         { .start = 0x1E8030, .end = 0x1E8030 },
1109         { .start = 0x1E8510, .end = 0x1E8550 },
1110         { .start = 0x1F0030, .end = 0x1F0030 },
1111         { .start = 0x1F0510, .end = 0x1F0550 },
1112         { .start = 0x1F4030, .end = 0x1F4030 },
1113         { .start = 0x1F4510, .end = 0x1F4550 },
1114         { .start = 0x1F8030, .end = 0x1F8030 },
1115         { .start = 0x1F8510, .end = 0x1F8550 },
1116 };
1117
1118 static int mmio_range_cmp(u32 key, const struct i915_range *range)
1119 {
1120         if (key < range->start)
1121                 return -1;
1122         else if (key > range->end)
1123                 return 1;
1124         else
1125                 return 0;
1126 }
1127
1128 static bool is_shadowed(struct intel_uncore *uncore, u32 offset)
1129 {
1130         if (drm_WARN_ON(&uncore->i915->drm, !uncore->shadowed_reg_table))
1131                 return false;
1132
1133         return BSEARCH(offset,
1134                        uncore->shadowed_reg_table,
1135                        uncore->shadowed_reg_table_entries,
1136                        mmio_range_cmp);
1137 }
1138
1139 static enum forcewake_domains
1140 gen6_reg_write_fw_domains(struct intel_uncore *uncore, i915_reg_t reg)
1141 {
1142         return FORCEWAKE_RENDER;
1143 }
1144
1145 #define __fwtable_reg_read_fw_domains(uncore, offset) \
1146 ({ \
1147         enum forcewake_domains __fwd = 0; \
1148         if (NEEDS_FORCE_WAKE((offset))) \
1149                 __fwd = find_fw_domain(uncore, offset); \
1150         __fwd; \
1151 })
1152
1153 #define __fwtable_reg_write_fw_domains(uncore, offset) \
1154 ({ \
1155         enum forcewake_domains __fwd = 0; \
1156         const u32 __offset = (offset); \
1157         if (NEEDS_FORCE_WAKE((__offset)) && !is_shadowed(uncore, __offset)) \
1158                 __fwd = find_fw_domain(uncore, __offset); \
1159         __fwd; \
1160 })
1161
1162 #define GEN_FW_RANGE(s, e, d) \
1163         { .start = (s), .end = (e), .domains = (d) }
1164
1165 /*
1166  * All platforms' forcewake tables below must be sorted by offset ranges.
1167  * Furthermore, new forcewake tables added should be "watertight" and have
1168  * no gaps between ranges.
1169  *
1170  * When there are multiple consecutive ranges listed in the bspec with
1171  * the same forcewake domain, it is customary to combine them into a single
1172  * row in the tables below to keep the tables small and lookups fast.
1173  * Likewise, reserved/unused ranges may be combined with the preceding and/or
1174  * following ranges since the driver will never be making MMIO accesses in
1175  * those ranges.
1176  *
1177  * For example, if the bspec were to list:
1178  *
1179  *    ...
1180  *    0x1000 - 0x1fff:  GT
1181  *    0x2000 - 0x2cff:  GT
1182  *    0x2d00 - 0x2fff:  unused/reserved
1183  *    0x3000 - 0xffff:  GT
1184  *    ...
1185  *
1186  * these could all be represented by a single line in the code:
1187  *
1188  *   GEN_FW_RANGE(0x1000, 0xffff, FORCEWAKE_GT)
1189  *
1190  * When adding new forcewake tables here, please also add them to
1191  * intel_uncore_mock_selftests in selftests/intel_uncore.c so that they will be
1192  * scanned for obvious mistakes or typos by the selftests.
1193  */
1194
1195 static const struct intel_forcewake_range __gen6_fw_ranges[] = {
1196         GEN_FW_RANGE(0x0, 0x3ffff, FORCEWAKE_RENDER),
1197 };
1198
1199 static const struct intel_forcewake_range __vlv_fw_ranges[] = {
1200         GEN_FW_RANGE(0x2000, 0x3fff, FORCEWAKE_RENDER),
1201         GEN_FW_RANGE(0x5000, 0x7fff, FORCEWAKE_RENDER),
1202         GEN_FW_RANGE(0xb000, 0x11fff, FORCEWAKE_RENDER),
1203         GEN_FW_RANGE(0x12000, 0x13fff, FORCEWAKE_MEDIA),
1204         GEN_FW_RANGE(0x22000, 0x23fff, FORCEWAKE_MEDIA),
1205         GEN_FW_RANGE(0x2e000, 0x2ffff, FORCEWAKE_RENDER),
1206         GEN_FW_RANGE(0x30000, 0x3ffff, FORCEWAKE_MEDIA),
1207 };
1208
1209 static const struct intel_forcewake_range __chv_fw_ranges[] = {
1210         GEN_FW_RANGE(0x2000, 0x3fff, FORCEWAKE_RENDER),
1211         GEN_FW_RANGE(0x4000, 0x4fff, FORCEWAKE_RENDER | FORCEWAKE_MEDIA),
1212         GEN_FW_RANGE(0x5200, 0x7fff, FORCEWAKE_RENDER),
1213         GEN_FW_RANGE(0x8000, 0x82ff, FORCEWAKE_RENDER | FORCEWAKE_MEDIA),
1214         GEN_FW_RANGE(0x8300, 0x84ff, FORCEWAKE_RENDER),
1215         GEN_FW_RANGE(0x8500, 0x85ff, FORCEWAKE_RENDER | FORCEWAKE_MEDIA),
1216         GEN_FW_RANGE(0x8800, 0x88ff, FORCEWAKE_MEDIA),
1217         GEN_FW_RANGE(0x9000, 0xafff, FORCEWAKE_RENDER | FORCEWAKE_MEDIA),
1218         GEN_FW_RANGE(0xb000, 0xb47f, FORCEWAKE_RENDER),
1219         GEN_FW_RANGE(0xd000, 0xd7ff, FORCEWAKE_MEDIA),
1220         GEN_FW_RANGE(0xe000, 0xe7ff, FORCEWAKE_RENDER),
1221         GEN_FW_RANGE(0xf000, 0xffff, FORCEWAKE_RENDER | FORCEWAKE_MEDIA),
1222         GEN_FW_RANGE(0x12000, 0x13fff, FORCEWAKE_MEDIA),
1223         GEN_FW_RANGE(0x1a000, 0x1bfff, FORCEWAKE_MEDIA),
1224         GEN_FW_RANGE(0x1e800, 0x1e9ff, FORCEWAKE_MEDIA),
1225         GEN_FW_RANGE(0x30000, 0x37fff, FORCEWAKE_MEDIA),
1226 };
1227
1228 static const struct intel_forcewake_range __gen9_fw_ranges[] = {
1229         GEN_FW_RANGE(0x0, 0xaff, FORCEWAKE_GT),
1230         GEN_FW_RANGE(0xb00, 0x1fff, 0), /* uncore range */
1231         GEN_FW_RANGE(0x2000, 0x26ff, FORCEWAKE_RENDER),
1232         GEN_FW_RANGE(0x2700, 0x2fff, FORCEWAKE_GT),
1233         GEN_FW_RANGE(0x3000, 0x3fff, FORCEWAKE_RENDER),
1234         GEN_FW_RANGE(0x4000, 0x51ff, FORCEWAKE_GT),
1235         GEN_FW_RANGE(0x5200, 0x7fff, FORCEWAKE_RENDER),
1236         GEN_FW_RANGE(0x8000, 0x812f, FORCEWAKE_GT),
1237         GEN_FW_RANGE(0x8130, 0x813f, FORCEWAKE_MEDIA),
1238         GEN_FW_RANGE(0x8140, 0x815f, FORCEWAKE_RENDER),
1239         GEN_FW_RANGE(0x8160, 0x82ff, FORCEWAKE_GT),
1240         GEN_FW_RANGE(0x8300, 0x84ff, FORCEWAKE_RENDER),
1241         GEN_FW_RANGE(0x8500, 0x87ff, FORCEWAKE_GT),
1242         GEN_FW_RANGE(0x8800, 0x89ff, FORCEWAKE_MEDIA),
1243         GEN_FW_RANGE(0x8a00, 0x8bff, FORCEWAKE_GT),
1244         GEN_FW_RANGE(0x8c00, 0x8cff, FORCEWAKE_RENDER),
1245         GEN_FW_RANGE(0x8d00, 0x93ff, FORCEWAKE_GT),
1246         GEN_FW_RANGE(0x9400, 0x97ff, FORCEWAKE_RENDER | FORCEWAKE_MEDIA),
1247         GEN_FW_RANGE(0x9800, 0xafff, FORCEWAKE_GT),
1248         GEN_FW_RANGE(0xb000, 0xb47f, FORCEWAKE_RENDER),
1249         GEN_FW_RANGE(0xb480, 0xcfff, FORCEWAKE_GT),
1250         GEN_FW_RANGE(0xd000, 0xd7ff, FORCEWAKE_MEDIA),
1251         GEN_FW_RANGE(0xd800, 0xdfff, FORCEWAKE_GT),
1252         GEN_FW_RANGE(0xe000, 0xe8ff, FORCEWAKE_RENDER),
1253         GEN_FW_RANGE(0xe900, 0x11fff, FORCEWAKE_GT),
1254         GEN_FW_RANGE(0x12000, 0x13fff, FORCEWAKE_MEDIA),
1255         GEN_FW_RANGE(0x14000, 0x19fff, FORCEWAKE_GT),
1256         GEN_FW_RANGE(0x1a000, 0x1e9ff, FORCEWAKE_MEDIA),
1257         GEN_FW_RANGE(0x1ea00, 0x243ff, FORCEWAKE_GT),
1258         GEN_FW_RANGE(0x24400, 0x247ff, FORCEWAKE_RENDER),
1259         GEN_FW_RANGE(0x24800, 0x2ffff, FORCEWAKE_GT),
1260         GEN_FW_RANGE(0x30000, 0x3ffff, FORCEWAKE_MEDIA),
1261 };
1262
1263 static const struct intel_forcewake_range __gen11_fw_ranges[] = {
1264         GEN_FW_RANGE(0x0, 0x1fff, 0), /* uncore range */
1265         GEN_FW_RANGE(0x2000, 0x26ff, FORCEWAKE_RENDER),
1266         GEN_FW_RANGE(0x2700, 0x2fff, FORCEWAKE_GT),
1267         GEN_FW_RANGE(0x3000, 0x3fff, FORCEWAKE_RENDER),
1268         GEN_FW_RANGE(0x4000, 0x51ff, FORCEWAKE_GT),
1269         GEN_FW_RANGE(0x5200, 0x7fff, FORCEWAKE_RENDER),
1270         GEN_FW_RANGE(0x8000, 0x813f, FORCEWAKE_GT),
1271         GEN_FW_RANGE(0x8140, 0x815f, FORCEWAKE_RENDER),
1272         GEN_FW_RANGE(0x8160, 0x82ff, FORCEWAKE_GT),
1273         GEN_FW_RANGE(0x8300, 0x84ff, FORCEWAKE_RENDER),
1274         GEN_FW_RANGE(0x8500, 0x87ff, FORCEWAKE_GT),
1275         GEN_FW_RANGE(0x8800, 0x8bff, 0),
1276         GEN_FW_RANGE(0x8c00, 0x8cff, FORCEWAKE_RENDER),
1277         GEN_FW_RANGE(0x8d00, 0x94cf, FORCEWAKE_GT),
1278         GEN_FW_RANGE(0x94d0, 0x955f, FORCEWAKE_RENDER),
1279         GEN_FW_RANGE(0x9560, 0x95ff, 0),
1280         GEN_FW_RANGE(0x9600, 0xafff, FORCEWAKE_GT),
1281         GEN_FW_RANGE(0xb000, 0xb47f, FORCEWAKE_RENDER),
1282         GEN_FW_RANGE(0xb480, 0xdeff, FORCEWAKE_GT),
1283         GEN_FW_RANGE(0xdf00, 0xe8ff, FORCEWAKE_RENDER),
1284         GEN_FW_RANGE(0xe900, 0x16dff, FORCEWAKE_GT),
1285         GEN_FW_RANGE(0x16e00, 0x19fff, FORCEWAKE_RENDER),
1286         GEN_FW_RANGE(0x1a000, 0x23fff, FORCEWAKE_GT),
1287         GEN_FW_RANGE(0x24000, 0x2407f, 0),
1288         GEN_FW_RANGE(0x24080, 0x2417f, FORCEWAKE_GT),
1289         GEN_FW_RANGE(0x24180, 0x242ff, FORCEWAKE_RENDER),
1290         GEN_FW_RANGE(0x24300, 0x243ff, FORCEWAKE_GT),
1291         GEN_FW_RANGE(0x24400, 0x24fff, FORCEWAKE_RENDER),
1292         GEN_FW_RANGE(0x25000, 0x3ffff, FORCEWAKE_GT),
1293         GEN_FW_RANGE(0x40000, 0x1bffff, 0),
1294         GEN_FW_RANGE(0x1c0000, 0x1c3fff, FORCEWAKE_MEDIA_VDBOX0),
1295         GEN_FW_RANGE(0x1c4000, 0x1c7fff, 0),
1296         GEN_FW_RANGE(0x1c8000, 0x1cffff, FORCEWAKE_MEDIA_VEBOX0),
1297         GEN_FW_RANGE(0x1d0000, 0x1d3fff, FORCEWAKE_MEDIA_VDBOX2),
1298         GEN_FW_RANGE(0x1d4000, 0x1dbfff, 0)
1299 };
1300
1301 static const struct intel_forcewake_range __gen12_fw_ranges[] = {
1302         GEN_FW_RANGE(0x0, 0x1fff, 0), /*
1303                 0x0   -  0xaff: reserved
1304                 0xb00 - 0x1fff: always on */
1305         GEN_FW_RANGE(0x2000, 0x26ff, FORCEWAKE_RENDER),
1306         GEN_FW_RANGE(0x2700, 0x27ff, FORCEWAKE_GT),
1307         GEN_FW_RANGE(0x2800, 0x2aff, FORCEWAKE_RENDER),
1308         GEN_FW_RANGE(0x2b00, 0x2fff, FORCEWAKE_GT),
1309         GEN_FW_RANGE(0x3000, 0x3fff, FORCEWAKE_RENDER),
1310         GEN_FW_RANGE(0x4000, 0x51ff, FORCEWAKE_GT), /*
1311                 0x4000 - 0x48ff: gt
1312                 0x4900 - 0x51ff: reserved */
1313         GEN_FW_RANGE(0x5200, 0x7fff, FORCEWAKE_RENDER), /*
1314                 0x5200 - 0x53ff: render
1315                 0x5400 - 0x54ff: reserved
1316                 0x5500 - 0x7fff: render */
1317         GEN_FW_RANGE(0x8000, 0x813f, FORCEWAKE_GT),
1318         GEN_FW_RANGE(0x8140, 0x815f, FORCEWAKE_RENDER),
1319         GEN_FW_RANGE(0x8160, 0x81ff, 0), /*
1320                 0x8160 - 0x817f: reserved
1321                 0x8180 - 0x81ff: always on */
1322         GEN_FW_RANGE(0x8200, 0x82ff, FORCEWAKE_GT),
1323         GEN_FW_RANGE(0x8300, 0x84ff, FORCEWAKE_RENDER),
1324         GEN_FW_RANGE(0x8500, 0x94cf, FORCEWAKE_GT), /*
1325                 0x8500 - 0x87ff: gt
1326                 0x8800 - 0x8fff: reserved
1327                 0x9000 - 0x947f: gt
1328                 0x9480 - 0x94cf: reserved */
1329         GEN_FW_RANGE(0x94d0, 0x955f, FORCEWAKE_RENDER),
1330         GEN_FW_RANGE(0x9560, 0x97ff, 0), /*
1331                 0x9560 - 0x95ff: always on
1332                 0x9600 - 0x97ff: reserved */
1333         GEN_FW_RANGE(0x9800, 0xafff, FORCEWAKE_GT),
1334         GEN_FW_RANGE(0xb000, 0xb3ff, FORCEWAKE_RENDER),
1335         GEN_FW_RANGE(0xb400, 0xcfff, FORCEWAKE_GT), /*
1336                 0xb400 - 0xbf7f: gt
1337                 0xb480 - 0xbfff: reserved
1338                 0xc000 - 0xcfff: gt */
1339         GEN_FW_RANGE(0xd000, 0xd7ff, 0),
1340         GEN_FW_RANGE(0xd800, 0xd8ff, FORCEWAKE_RENDER),
1341         GEN_FW_RANGE(0xd900, 0xdbff, FORCEWAKE_GT),
1342         GEN_FW_RANGE(0xdc00, 0xefff, FORCEWAKE_RENDER), /*
1343                 0xdc00 - 0xddff: render
1344                 0xde00 - 0xde7f: reserved
1345                 0xde80 - 0xe8ff: render
1346                 0xe900 - 0xefff: reserved */
1347         GEN_FW_RANGE(0xf000, 0x147ff, FORCEWAKE_GT), /*
1348                  0xf000 - 0xffff: gt
1349                 0x10000 - 0x147ff: reserved */
1350         GEN_FW_RANGE(0x14800, 0x1ffff, FORCEWAKE_RENDER), /*
1351                 0x14800 - 0x14fff: render
1352                 0x15000 - 0x16dff: reserved
1353                 0x16e00 - 0x1bfff: render
1354                 0x1c000 - 0x1ffff: reserved */
1355         GEN_FW_RANGE(0x20000, 0x20fff, FORCEWAKE_MEDIA_VDBOX0),
1356         GEN_FW_RANGE(0x21000, 0x21fff, FORCEWAKE_MEDIA_VDBOX2),
1357         GEN_FW_RANGE(0x22000, 0x23fff, FORCEWAKE_GT),
1358         GEN_FW_RANGE(0x24000, 0x2417f, 0), /*
1359                 0x24000 - 0x2407f: always on
1360                 0x24080 - 0x2417f: reserved */
1361         GEN_FW_RANGE(0x24180, 0x249ff, FORCEWAKE_GT), /*
1362                 0x24180 - 0x241ff: gt
1363                 0x24200 - 0x249ff: reserved */
1364         GEN_FW_RANGE(0x24a00, 0x251ff, FORCEWAKE_RENDER), /*
1365                 0x24a00 - 0x24a7f: render
1366                 0x24a80 - 0x251ff: reserved */
1367         GEN_FW_RANGE(0x25200, 0x255ff, FORCEWAKE_GT), /*
1368                 0x25200 - 0x252ff: gt
1369                 0x25300 - 0x255ff: reserved */
1370         GEN_FW_RANGE(0x25600, 0x2567f, FORCEWAKE_MEDIA_VDBOX0),
1371         GEN_FW_RANGE(0x25680, 0x259ff, FORCEWAKE_MEDIA_VDBOX2), /*
1372                 0x25680 - 0x256ff: VD2
1373                 0x25700 - 0x259ff: reserved */
1374         GEN_FW_RANGE(0x25a00, 0x25a7f, FORCEWAKE_MEDIA_VDBOX0),
1375         GEN_FW_RANGE(0x25a80, 0x2ffff, FORCEWAKE_MEDIA_VDBOX2), /*
1376                 0x25a80 - 0x25aff: VD2
1377                 0x25b00 - 0x2ffff: reserved */
1378         GEN_FW_RANGE(0x30000, 0x3ffff, FORCEWAKE_GT),
1379         GEN_FW_RANGE(0x40000, 0x1bffff, 0),
1380         GEN_FW_RANGE(0x1c0000, 0x1c3fff, FORCEWAKE_MEDIA_VDBOX0), /*
1381                 0x1c0000 - 0x1c2bff: VD0
1382                 0x1c2c00 - 0x1c2cff: reserved
1383                 0x1c2d00 - 0x1c2dff: VD0
1384                 0x1c2e00 - 0x1c3eff: reserved
1385                 0x1c3f00 - 0x1c3fff: VD0 */
1386         GEN_FW_RANGE(0x1c4000, 0x1c7fff, 0),
1387         GEN_FW_RANGE(0x1c8000, 0x1cbfff, FORCEWAKE_MEDIA_VEBOX0), /*
1388                 0x1c8000 - 0x1ca0ff: VE0
1389                 0x1ca100 - 0x1cbeff: reserved
1390                 0x1cbf00 - 0x1cbfff: VE0 */
1391         GEN_FW_RANGE(0x1cc000, 0x1cffff, FORCEWAKE_MEDIA_VDBOX0), /*
1392                 0x1cc000 - 0x1ccfff: VD0
1393                 0x1cd000 - 0x1cffff: reserved */
1394         GEN_FW_RANGE(0x1d0000, 0x1d3fff, FORCEWAKE_MEDIA_VDBOX2), /*
1395                 0x1d0000 - 0x1d2bff: VD2
1396                 0x1d2c00 - 0x1d2cff: reserved
1397                 0x1d2d00 - 0x1d2dff: VD2
1398                 0x1d2e00 - 0x1d3eff: reserved
1399                 0x1d3f00 - 0x1d3fff: VD2 */
1400 };
1401
1402 /*
1403  * Graphics IP version 12.55 brings a slight change to the 0xd800 range,
1404  * switching it from the GT domain to the render domain.
1405  */
1406 #define XEHP_FWRANGES(FW_RANGE_D800)                                    \
1407         GEN_FW_RANGE(0x0, 0x1fff, 0), /*                                        \
1408                   0x0 -  0xaff: reserved                                        \
1409                 0xb00 - 0x1fff: always on */                                    \
1410         GEN_FW_RANGE(0x2000, 0x26ff, FORCEWAKE_RENDER),                         \
1411         GEN_FW_RANGE(0x2700, 0x4aff, FORCEWAKE_GT),                             \
1412         GEN_FW_RANGE(0x4b00, 0x51ff, 0), /*                                     \
1413                 0x4b00 - 0x4fff: reserved                                       \
1414                 0x5000 - 0x51ff: always on */                                   \
1415         GEN_FW_RANGE(0x5200, 0x7fff, FORCEWAKE_RENDER),                         \
1416         GEN_FW_RANGE(0x8000, 0x813f, FORCEWAKE_GT),                             \
1417         GEN_FW_RANGE(0x8140, 0x815f, FORCEWAKE_RENDER),                         \
1418         GEN_FW_RANGE(0x8160, 0x81ff, 0), /*                                     \
1419                 0x8160 - 0x817f: reserved                                       \
1420                 0x8180 - 0x81ff: always on */                                   \
1421         GEN_FW_RANGE(0x8200, 0x82ff, FORCEWAKE_GT),                             \
1422         GEN_FW_RANGE(0x8300, 0x84ff, FORCEWAKE_RENDER),                         \
1423         GEN_FW_RANGE(0x8500, 0x8cff, FORCEWAKE_GT), /*                          \
1424                 0x8500 - 0x87ff: gt                                             \
1425                 0x8800 - 0x8c7f: reserved                                       \
1426                 0x8c80 - 0x8cff: gt (DG2 only) */                               \
1427         GEN_FW_RANGE(0x8d00, 0x8fff, FORCEWAKE_RENDER), /*                      \
1428                 0x8d00 - 0x8dff: render (DG2 only)                              \
1429                 0x8e00 - 0x8fff: reserved */                                    \
1430         GEN_FW_RANGE(0x9000, 0x94cf, FORCEWAKE_GT), /*                          \
1431                 0x9000 - 0x947f: gt                                             \
1432                 0x9480 - 0x94cf: reserved */                                    \
1433         GEN_FW_RANGE(0x94d0, 0x955f, FORCEWAKE_RENDER),                         \
1434         GEN_FW_RANGE(0x9560, 0x967f, 0), /*                                     \
1435                 0x9560 - 0x95ff: always on                                      \
1436                 0x9600 - 0x967f: reserved */                                    \
1437         GEN_FW_RANGE(0x9680, 0x97ff, FORCEWAKE_RENDER), /*                      \
1438                 0x9680 - 0x96ff: render (DG2 only)                              \
1439                 0x9700 - 0x97ff: reserved */                                    \
1440         GEN_FW_RANGE(0x9800, 0xcfff, FORCEWAKE_GT), /*                          \
1441                 0x9800 - 0xb4ff: gt                                             \
1442                 0xb500 - 0xbfff: reserved                                       \
1443                 0xc000 - 0xcfff: gt */                                          \
1444         GEN_FW_RANGE(0xd000, 0xd7ff, 0),                                        \
1445         GEN_FW_RANGE(0xd800, 0xd87f, FW_RANGE_D800),                    \
1446         GEN_FW_RANGE(0xd880, 0xdbff, FORCEWAKE_GT),                             \
1447         GEN_FW_RANGE(0xdc00, 0xdcff, FORCEWAKE_RENDER),                         \
1448         GEN_FW_RANGE(0xdd00, 0xde7f, FORCEWAKE_GT), /*                          \
1449                 0xdd00 - 0xddff: gt                                             \
1450                 0xde00 - 0xde7f: reserved */                                    \
1451         GEN_FW_RANGE(0xde80, 0xe8ff, FORCEWAKE_RENDER), /*                      \
1452                 0xde80 - 0xdfff: render                                         \
1453                 0xe000 - 0xe0ff: reserved                                       \
1454                 0xe100 - 0xe8ff: render */                                      \
1455         GEN_FW_RANGE(0xe900, 0xffff, FORCEWAKE_GT), /*                          \
1456                 0xe900 - 0xe9ff: gt                                             \
1457                 0xea00 - 0xefff: reserved                                       \
1458                 0xf000 - 0xffff: gt */                                          \
1459         GEN_FW_RANGE(0x10000, 0x12fff, 0), /*                                   \
1460                 0x10000 - 0x11fff: reserved                                     \
1461                 0x12000 - 0x127ff: always on                                    \
1462                 0x12800 - 0x12fff: reserved */                                  \
1463         GEN_FW_RANGE(0x13000, 0x131ff, FORCEWAKE_MEDIA_VDBOX0), /* DG2 only */  \
1464         GEN_FW_RANGE(0x13200, 0x13fff, FORCEWAKE_MEDIA_VDBOX2), /*              \
1465                 0x13200 - 0x133ff: VD2 (DG2 only)                               \
1466                 0x13400 - 0x13fff: reserved */                                  \
1467         GEN_FW_RANGE(0x14000, 0x141ff, FORCEWAKE_MEDIA_VDBOX0), /* XEHPSDV only */      \
1468         GEN_FW_RANGE(0x14200, 0x143ff, FORCEWAKE_MEDIA_VDBOX2), /* XEHPSDV only */      \
1469         GEN_FW_RANGE(0x14400, 0x145ff, FORCEWAKE_MEDIA_VDBOX4), /* XEHPSDV only */      \
1470         GEN_FW_RANGE(0x14600, 0x147ff, FORCEWAKE_MEDIA_VDBOX6), /* XEHPSDV only */      \
1471         GEN_FW_RANGE(0x14800, 0x14fff, FORCEWAKE_RENDER),                       \
1472         GEN_FW_RANGE(0x15000, 0x16dff, FORCEWAKE_GT), /*                        \
1473                 0x15000 - 0x15fff: gt (DG2 only)                                \
1474                 0x16000 - 0x16dff: reserved */                                  \
1475         GEN_FW_RANGE(0x16e00, 0x1ffff, FORCEWAKE_RENDER),                       \
1476         GEN_FW_RANGE(0x20000, 0x21fff, FORCEWAKE_MEDIA_VDBOX0), /*              \
1477                 0x20000 - 0x20fff: VD0 (XEHPSDV only)                           \
1478                 0x21000 - 0x21fff: reserved */                                  \
1479         GEN_FW_RANGE(0x22000, 0x23fff, FORCEWAKE_GT),                           \
1480         GEN_FW_RANGE(0x24000, 0x2417f, 0), /*                                   \
1481                 0x24000 - 0x2407f: always on                                    \
1482                 0x24080 - 0x2417f: reserved */                                  \
1483         GEN_FW_RANGE(0x24180, 0x249ff, FORCEWAKE_GT), /*                        \
1484                 0x24180 - 0x241ff: gt                                           \
1485                 0x24200 - 0x249ff: reserved */                                  \
1486         GEN_FW_RANGE(0x24a00, 0x251ff, FORCEWAKE_RENDER), /*                    \
1487                 0x24a00 - 0x24a7f: render                                       \
1488                 0x24a80 - 0x251ff: reserved */                                  \
1489         GEN_FW_RANGE(0x25200, 0x25fff, FORCEWAKE_GT), /*                        \
1490                 0x25200 - 0x252ff: gt                                           \
1491                 0x25300 - 0x25fff: reserved */                                  \
1492         GEN_FW_RANGE(0x26000, 0x2ffff, FORCEWAKE_RENDER), /*                    \
1493                 0x26000 - 0x27fff: render                                       \
1494                 0x28000 - 0x29fff: reserved                                     \
1495                 0x2a000 - 0x2ffff: undocumented */                              \
1496         GEN_FW_RANGE(0x30000, 0x3ffff, FORCEWAKE_GT),                           \
1497         GEN_FW_RANGE(0x40000, 0x1bffff, 0),                                     \
1498         GEN_FW_RANGE(0x1c0000, 0x1c3fff, FORCEWAKE_MEDIA_VDBOX0), /*            \
1499                 0x1c0000 - 0x1c2bff: VD0                                        \
1500                 0x1c2c00 - 0x1c2cff: reserved                                   \
1501                 0x1c2d00 - 0x1c2dff: VD0                                        \
1502                 0x1c2e00 - 0x1c3eff: VD0 (DG2 only)                             \
1503                 0x1c3f00 - 0x1c3fff: VD0 */                                     \
1504         GEN_FW_RANGE(0x1c4000, 0x1c7fff, FORCEWAKE_MEDIA_VDBOX1), /*            \
1505                 0x1c4000 - 0x1c6bff: VD1                                        \
1506                 0x1c6c00 - 0x1c6cff: reserved                                   \
1507                 0x1c6d00 - 0x1c6dff: VD1                                        \
1508                 0x1c6e00 - 0x1c7fff: reserved */                                \
1509         GEN_FW_RANGE(0x1c8000, 0x1cbfff, FORCEWAKE_MEDIA_VEBOX0), /*            \
1510                 0x1c8000 - 0x1ca0ff: VE0                                        \
1511                 0x1ca100 - 0x1cbfff: reserved */                                \
1512         GEN_FW_RANGE(0x1cc000, 0x1ccfff, FORCEWAKE_MEDIA_VDBOX0),               \
1513         GEN_FW_RANGE(0x1cd000, 0x1cdfff, FORCEWAKE_MEDIA_VDBOX2),               \
1514         GEN_FW_RANGE(0x1ce000, 0x1cefff, FORCEWAKE_MEDIA_VDBOX4),               \
1515         GEN_FW_RANGE(0x1cf000, 0x1cffff, FORCEWAKE_MEDIA_VDBOX6),               \
1516         GEN_FW_RANGE(0x1d0000, 0x1d3fff, FORCEWAKE_MEDIA_VDBOX2), /*            \
1517                 0x1d0000 - 0x1d2bff: VD2                                        \
1518                 0x1d2c00 - 0x1d2cff: reserved                                   \
1519                 0x1d2d00 - 0x1d2dff: VD2                                        \
1520                 0x1d2e00 - 0x1d3dff: VD2 (DG2 only)                             \
1521                 0x1d3e00 - 0x1d3eff: reserved                                   \
1522                 0x1d3f00 - 0x1d3fff: VD2 */                                     \
1523         GEN_FW_RANGE(0x1d4000, 0x1d7fff, FORCEWAKE_MEDIA_VDBOX3), /*            \
1524                 0x1d4000 - 0x1d6bff: VD3                                        \
1525                 0x1d6c00 - 0x1d6cff: reserved                                   \
1526                 0x1d6d00 - 0x1d6dff: VD3                                        \
1527                 0x1d6e00 - 0x1d7fff: reserved */                                \
1528         GEN_FW_RANGE(0x1d8000, 0x1dffff, FORCEWAKE_MEDIA_VEBOX1), /*            \
1529                 0x1d8000 - 0x1da0ff: VE1                                        \
1530                 0x1da100 - 0x1dffff: reserved */                                \
1531         GEN_FW_RANGE(0x1e0000, 0x1e3fff, FORCEWAKE_MEDIA_VDBOX4), /*            \
1532                 0x1e0000 - 0x1e2bff: VD4                                        \
1533                 0x1e2c00 - 0x1e2cff: reserved                                   \
1534                 0x1e2d00 - 0x1e2dff: VD4                                        \
1535                 0x1e2e00 - 0x1e3eff: reserved                                   \
1536                 0x1e3f00 - 0x1e3fff: VD4 */                                     \
1537         GEN_FW_RANGE(0x1e4000, 0x1e7fff, FORCEWAKE_MEDIA_VDBOX5), /*            \
1538                 0x1e4000 - 0x1e6bff: VD5                                        \
1539                 0x1e6c00 - 0x1e6cff: reserved                                   \
1540                 0x1e6d00 - 0x1e6dff: VD5                                        \
1541                 0x1e6e00 - 0x1e7fff: reserved */                                \
1542         GEN_FW_RANGE(0x1e8000, 0x1effff, FORCEWAKE_MEDIA_VEBOX2), /*            \
1543                 0x1e8000 - 0x1ea0ff: VE2                                        \
1544                 0x1ea100 - 0x1effff: reserved */                                \
1545         GEN_FW_RANGE(0x1f0000, 0x1f3fff, FORCEWAKE_MEDIA_VDBOX6), /*            \
1546                 0x1f0000 - 0x1f2bff: VD6                                        \
1547                 0x1f2c00 - 0x1f2cff: reserved                                   \
1548                 0x1f2d00 - 0x1f2dff: VD6                                        \
1549                 0x1f2e00 - 0x1f3eff: reserved                                   \
1550                 0x1f3f00 - 0x1f3fff: VD6 */                                     \
1551         GEN_FW_RANGE(0x1f4000, 0x1f7fff, FORCEWAKE_MEDIA_VDBOX7), /*            \
1552                 0x1f4000 - 0x1f6bff: VD7                                        \
1553                 0x1f6c00 - 0x1f6cff: reserved                                   \
1554                 0x1f6d00 - 0x1f6dff: VD7                                        \
1555                 0x1f6e00 - 0x1f7fff: reserved */                                \
1556         GEN_FW_RANGE(0x1f8000, 0x1fa0ff, FORCEWAKE_MEDIA_VEBOX3),
1557
1558 static const struct intel_forcewake_range __xehp_fw_ranges[] = {
1559         XEHP_FWRANGES(FORCEWAKE_GT)
1560 };
1561
1562 static const struct intel_forcewake_range __dg2_fw_ranges[] = {
1563         XEHP_FWRANGES(FORCEWAKE_RENDER)
1564 };
1565
1566 static const struct intel_forcewake_range __pvc_fw_ranges[] = {
1567         GEN_FW_RANGE(0x0, 0xaff, 0),
1568         GEN_FW_RANGE(0xb00, 0xbff, FORCEWAKE_GT),
1569         GEN_FW_RANGE(0xc00, 0xfff, 0),
1570         GEN_FW_RANGE(0x1000, 0x1fff, FORCEWAKE_GT),
1571         GEN_FW_RANGE(0x2000, 0x26ff, FORCEWAKE_RENDER),
1572         GEN_FW_RANGE(0x2700, 0x2fff, FORCEWAKE_GT),
1573         GEN_FW_RANGE(0x3000, 0x3fff, FORCEWAKE_RENDER),
1574         GEN_FW_RANGE(0x4000, 0x813f, FORCEWAKE_GT), /*
1575                 0x4000 - 0x4aff: gt
1576                 0x4b00 - 0x4fff: reserved
1577                 0x5000 - 0x51ff: gt
1578                 0x5200 - 0x52ff: reserved
1579                 0x5300 - 0x53ff: gt
1580                 0x5400 - 0x7fff: reserved
1581                 0x8000 - 0x813f: gt */
1582         GEN_FW_RANGE(0x8140, 0x817f, FORCEWAKE_RENDER),
1583         GEN_FW_RANGE(0x8180, 0x81ff, 0),
1584         GEN_FW_RANGE(0x8200, 0x94cf, FORCEWAKE_GT), /*
1585                 0x8200 - 0x82ff: gt
1586                 0x8300 - 0x84ff: reserved
1587                 0x8500 - 0x887f: gt
1588                 0x8880 - 0x8a7f: reserved
1589                 0x8a80 - 0x8aff: gt
1590                 0x8b00 - 0x8fff: reserved
1591                 0x9000 - 0x947f: gt
1592                 0x9480 - 0x94cf: reserved */
1593         GEN_FW_RANGE(0x94d0, 0x955f, FORCEWAKE_RENDER),
1594         GEN_FW_RANGE(0x9560, 0x967f, 0), /*
1595                 0x9560 - 0x95ff: always on
1596                 0x9600 - 0x967f: reserved */
1597         GEN_FW_RANGE(0x9680, 0x97ff, FORCEWAKE_RENDER), /*
1598                 0x9680 - 0x96ff: render
1599                 0x9700 - 0x97ff: reserved */
1600         GEN_FW_RANGE(0x9800, 0xcfff, FORCEWAKE_GT), /*
1601                 0x9800 - 0xb4ff: gt
1602                 0xb500 - 0xbfff: reserved
1603                 0xc000 - 0xcfff: gt */
1604         GEN_FW_RANGE(0xd000, 0xd3ff, 0),
1605         GEN_FW_RANGE(0xd400, 0xdbff, FORCEWAKE_GT),
1606         GEN_FW_RANGE(0xdc00, 0xdcff, FORCEWAKE_RENDER),
1607         GEN_FW_RANGE(0xdd00, 0xde7f, FORCEWAKE_GT), /*
1608                 0xdd00 - 0xddff: gt
1609                 0xde00 - 0xde7f: reserved */
1610         GEN_FW_RANGE(0xde80, 0xe8ff, FORCEWAKE_RENDER), /*
1611                 0xde80 - 0xdeff: render
1612                 0xdf00 - 0xe1ff: reserved
1613                 0xe200 - 0xe7ff: render
1614                 0xe800 - 0xe8ff: reserved */
1615         GEN_FW_RANGE(0xe900, 0x11fff, FORCEWAKE_GT), /*
1616                  0xe900 -  0xe9ff: gt
1617                  0xea00 -  0xebff: reserved
1618                  0xec00 -  0xffff: gt
1619                 0x10000 - 0x11fff: reserved */
1620         GEN_FW_RANGE(0x12000, 0x12fff, 0), /*
1621                 0x12000 - 0x127ff: always on
1622                 0x12800 - 0x12fff: reserved */
1623         GEN_FW_RANGE(0x13000, 0x23fff, FORCEWAKE_GT), /*
1624                 0x13000 - 0x135ff: gt
1625                 0x13600 - 0x147ff: reserved
1626                 0x14800 - 0x153ff: gt
1627                 0x15400 - 0x19fff: reserved
1628                 0x1a000 - 0x1ffff: gt
1629                 0x20000 - 0x21fff: reserved
1630                 0x22000 - 0x23fff: gt */
1631         GEN_FW_RANGE(0x24000, 0x2417f, 0), /*
1632                 24000 - 0x2407f: always on
1633                 24080 - 0x2417f: reserved */
1634         GEN_FW_RANGE(0x24180, 0x3ffff, FORCEWAKE_GT), /*
1635                 0x24180 - 0x241ff: gt
1636                 0x24200 - 0x251ff: reserved
1637                 0x25200 - 0x252ff: gt
1638                 0x25300 - 0x25fff: reserved
1639                 0x26000 - 0x27fff: gt
1640                 0x28000 - 0x2ffff: reserved
1641                 0x30000 - 0x3ffff: gt */
1642         GEN_FW_RANGE(0x40000, 0x1bffff, 0),
1643         GEN_FW_RANGE(0x1c0000, 0x1c3fff, FORCEWAKE_MEDIA_VDBOX0), /*
1644                 0x1c0000 - 0x1c2bff: VD0
1645                 0x1c2c00 - 0x1c2cff: reserved
1646                 0x1c2d00 - 0x1c2dff: VD0
1647                 0x1c2e00 - 0x1c3eff: reserved
1648                 0x1c3f00 - 0x1c3fff: VD0 */
1649         GEN_FW_RANGE(0x1c4000, 0x1cffff, FORCEWAKE_MEDIA_VDBOX1), /*
1650                 0x1c4000 - 0x1c6aff: VD1
1651                 0x1c6b00 - 0x1c7eff: reserved
1652                 0x1c7f00 - 0x1c7fff: VD1
1653                 0x1c8000 - 0x1cffff: reserved */
1654         GEN_FW_RANGE(0x1d0000, 0x23ffff, FORCEWAKE_MEDIA_VDBOX2), /*
1655                 0x1d0000 - 0x1d2aff: VD2
1656                 0x1d2b00 - 0x1d3eff: reserved
1657                 0x1d3f00 - 0x1d3fff: VD2
1658                 0x1d4000 - 0x23ffff: reserved */
1659         GEN_FW_RANGE(0x240000, 0x3dffff, 0),
1660         GEN_FW_RANGE(0x3e0000, 0x3effff, FORCEWAKE_GT),
1661 };
1662
1663 static void
1664 ilk_dummy_write(struct intel_uncore *uncore)
1665 {
1666         /* WaIssueDummyWriteToWakeupFromRC6:ilk Issue a dummy write to wake up
1667          * the chip from rc6 before touching it for real. MI_MODE is masked,
1668          * hence harmless to write 0 into. */
1669         __raw_uncore_write32(uncore, RING_MI_MODE(RENDER_RING_BASE), 0);
1670 }
1671
1672 static void
1673 __unclaimed_reg_debug(struct intel_uncore *uncore,
1674                       const i915_reg_t reg,
1675                       const bool read)
1676 {
1677         if (drm_WARN(&uncore->i915->drm,
1678                      check_for_unclaimed_mmio(uncore),
1679                      "Unclaimed %s register 0x%x\n",
1680                      read ? "read from" : "write to",
1681                      i915_mmio_reg_offset(reg)))
1682                 /* Only report the first N failures */
1683                 uncore->i915->params.mmio_debug--;
1684 }
1685
1686 static void
1687 __unclaimed_previous_reg_debug(struct intel_uncore *uncore,
1688                                const i915_reg_t reg,
1689                                const bool read)
1690 {
1691         if (check_for_unclaimed_mmio(uncore))
1692                 drm_dbg(&uncore->i915->drm,
1693                         "Unclaimed access detected before %s register 0x%x\n",
1694                         read ? "read from" : "write to",
1695                         i915_mmio_reg_offset(reg));
1696 }
1697
1698 static inline void
1699 unclaimed_reg_debug(struct intel_uncore *uncore,
1700                     const i915_reg_t reg,
1701                     const bool read,
1702                     const bool before)
1703 {
1704         if (likely(!uncore->i915->params.mmio_debug))
1705                 return;
1706
1707         /* interrupts are disabled and re-enabled around uncore->lock usage */
1708         lockdep_assert_held(&uncore->lock);
1709
1710         if (before) {
1711                 spin_lock(&uncore->debug->lock);
1712                 __unclaimed_previous_reg_debug(uncore, reg, read);
1713         } else {
1714                 __unclaimed_reg_debug(uncore, reg, read);
1715                 spin_unlock(&uncore->debug->lock);
1716         }
1717 }
1718
1719 #define __vgpu_read(x) \
1720 static u##x \
1721 vgpu_read##x(struct intel_uncore *uncore, i915_reg_t reg, bool trace) { \
1722         u##x val = __raw_uncore_read##x(uncore, reg); \
1723         trace_i915_reg_rw(false, reg, val, sizeof(val), trace); \
1724         return val; \
1725 }
1726 __vgpu_read(8)
1727 __vgpu_read(16)
1728 __vgpu_read(32)
1729 __vgpu_read(64)
1730
1731 #define GEN2_READ_HEADER(x) \
1732         u##x val = 0; \
1733         assert_rpm_wakelock_held(uncore->rpm);
1734
1735 #define GEN2_READ_FOOTER \
1736         trace_i915_reg_rw(false, reg, val, sizeof(val), trace); \
1737         return val
1738
1739 #define __gen2_read(x) \
1740 static u##x \
1741 gen2_read##x(struct intel_uncore *uncore, i915_reg_t reg, bool trace) { \
1742         GEN2_READ_HEADER(x); \
1743         val = __raw_uncore_read##x(uncore, reg); \
1744         GEN2_READ_FOOTER; \
1745 }
1746
1747 #define __gen5_read(x) \
1748 static u##x \
1749 gen5_read##x(struct intel_uncore *uncore, i915_reg_t reg, bool trace) { \
1750         GEN2_READ_HEADER(x); \
1751         ilk_dummy_write(uncore); \
1752         val = __raw_uncore_read##x(uncore, reg); \
1753         GEN2_READ_FOOTER; \
1754 }
1755
1756 __gen5_read(8)
1757 __gen5_read(16)
1758 __gen5_read(32)
1759 __gen5_read(64)
1760 __gen2_read(8)
1761 __gen2_read(16)
1762 __gen2_read(32)
1763 __gen2_read(64)
1764
1765 #undef __gen5_read
1766 #undef __gen2_read
1767
1768 #undef GEN2_READ_FOOTER
1769 #undef GEN2_READ_HEADER
1770
1771 #define GEN6_READ_HEADER(x) \
1772         u32 offset = i915_mmio_reg_offset(reg); \
1773         unsigned long irqflags; \
1774         u##x val = 0; \
1775         assert_rpm_wakelock_held(uncore->rpm); \
1776         spin_lock_irqsave(&uncore->lock, irqflags); \
1777         unclaimed_reg_debug(uncore, reg, true, true)
1778
1779 #define GEN6_READ_FOOTER \
1780         unclaimed_reg_debug(uncore, reg, true, false); \
1781         spin_unlock_irqrestore(&uncore->lock, irqflags); \
1782         trace_i915_reg_rw(false, reg, val, sizeof(val), trace); \
1783         return val
1784
1785 static noinline void ___force_wake_auto(struct intel_uncore *uncore,
1786                                         enum forcewake_domains fw_domains)
1787 {
1788         struct intel_uncore_forcewake_domain *domain;
1789         unsigned int tmp;
1790
1791         GEM_BUG_ON(fw_domains & ~uncore->fw_domains);
1792
1793         for_each_fw_domain_masked(domain, fw_domains, uncore, tmp)
1794                 fw_domain_arm_timer(domain);
1795
1796         fw_domains_get(uncore, fw_domains);
1797 }
1798
1799 static inline void __force_wake_auto(struct intel_uncore *uncore,
1800                                      enum forcewake_domains fw_domains)
1801 {
1802         GEM_BUG_ON(!fw_domains);
1803
1804         /* Turn on all requested but inactive supported forcewake domains. */
1805         fw_domains &= uncore->fw_domains;
1806         fw_domains &= ~uncore->fw_domains_active;
1807
1808         if (fw_domains)
1809                 ___force_wake_auto(uncore, fw_domains);
1810 }
1811
1812 #define __gen_fwtable_read(x) \
1813 static u##x \
1814 fwtable_read##x(struct intel_uncore *uncore, i915_reg_t reg, bool trace) \
1815 { \
1816         enum forcewake_domains fw_engine; \
1817         GEN6_READ_HEADER(x); \
1818         fw_engine = __fwtable_reg_read_fw_domains(uncore, offset); \
1819         if (fw_engine) \
1820                 __force_wake_auto(uncore, fw_engine); \
1821         val = __raw_uncore_read##x(uncore, reg); \
1822         GEN6_READ_FOOTER; \
1823 }
1824
1825 static enum forcewake_domains
1826 fwtable_reg_read_fw_domains(struct intel_uncore *uncore, i915_reg_t reg) {
1827         return __fwtable_reg_read_fw_domains(uncore, i915_mmio_reg_offset(reg));
1828 }
1829
1830 __gen_fwtable_read(8)
1831 __gen_fwtable_read(16)
1832 __gen_fwtable_read(32)
1833 __gen_fwtable_read(64)
1834
1835 #undef __gen_fwtable_read
1836 #undef GEN6_READ_FOOTER
1837 #undef GEN6_READ_HEADER
1838
1839 #define GEN2_WRITE_HEADER \
1840         trace_i915_reg_rw(true, reg, val, sizeof(val), trace); \
1841         assert_rpm_wakelock_held(uncore->rpm); \
1842
1843 #define GEN2_WRITE_FOOTER
1844
1845 #define __gen2_write(x) \
1846 static void \
1847 gen2_write##x(struct intel_uncore *uncore, i915_reg_t reg, u##x val, bool trace) { \
1848         GEN2_WRITE_HEADER; \
1849         __raw_uncore_write##x(uncore, reg, val); \
1850         GEN2_WRITE_FOOTER; \
1851 }
1852
1853 #define __gen5_write(x) \
1854 static void \
1855 gen5_write##x(struct intel_uncore *uncore, i915_reg_t reg, u##x val, bool trace) { \
1856         GEN2_WRITE_HEADER; \
1857         ilk_dummy_write(uncore); \
1858         __raw_uncore_write##x(uncore, reg, val); \
1859         GEN2_WRITE_FOOTER; \
1860 }
1861
1862 __gen5_write(8)
1863 __gen5_write(16)
1864 __gen5_write(32)
1865 __gen2_write(8)
1866 __gen2_write(16)
1867 __gen2_write(32)
1868
1869 #undef __gen5_write
1870 #undef __gen2_write
1871
1872 #undef GEN2_WRITE_FOOTER
1873 #undef GEN2_WRITE_HEADER
1874
1875 #define GEN6_WRITE_HEADER \
1876         u32 offset = i915_mmio_reg_offset(reg); \
1877         unsigned long irqflags; \
1878         trace_i915_reg_rw(true, reg, val, sizeof(val), trace); \
1879         assert_rpm_wakelock_held(uncore->rpm); \
1880         spin_lock_irqsave(&uncore->lock, irqflags); \
1881         unclaimed_reg_debug(uncore, reg, false, true)
1882
1883 #define GEN6_WRITE_FOOTER \
1884         unclaimed_reg_debug(uncore, reg, false, false); \
1885         spin_unlock_irqrestore(&uncore->lock, irqflags)
1886
1887 #define __gen6_write(x) \
1888 static void \
1889 gen6_write##x(struct intel_uncore *uncore, i915_reg_t reg, u##x val, bool trace) { \
1890         GEN6_WRITE_HEADER; \
1891         if (NEEDS_FORCE_WAKE(offset)) \
1892                 __gen6_gt_wait_for_fifo(uncore); \
1893         __raw_uncore_write##x(uncore, reg, val); \
1894         GEN6_WRITE_FOOTER; \
1895 }
1896 __gen6_write(8)
1897 __gen6_write(16)
1898 __gen6_write(32)
1899
1900 #define __gen_fwtable_write(x) \
1901 static void \
1902 fwtable_write##x(struct intel_uncore *uncore, i915_reg_t reg, u##x val, bool trace) { \
1903         enum forcewake_domains fw_engine; \
1904         GEN6_WRITE_HEADER; \
1905         fw_engine = __fwtable_reg_write_fw_domains(uncore, offset); \
1906         if (fw_engine) \
1907                 __force_wake_auto(uncore, fw_engine); \
1908         __raw_uncore_write##x(uncore, reg, val); \
1909         GEN6_WRITE_FOOTER; \
1910 }
1911
1912 static enum forcewake_domains
1913 fwtable_reg_write_fw_domains(struct intel_uncore *uncore, i915_reg_t reg)
1914 {
1915         return __fwtable_reg_write_fw_domains(uncore, i915_mmio_reg_offset(reg));
1916 }
1917
1918 __gen_fwtable_write(8)
1919 __gen_fwtable_write(16)
1920 __gen_fwtable_write(32)
1921
1922 #undef __gen_fwtable_write
1923 #undef GEN6_WRITE_FOOTER
1924 #undef GEN6_WRITE_HEADER
1925
1926 #define __vgpu_write(x) \
1927 static void \
1928 vgpu_write##x(struct intel_uncore *uncore, i915_reg_t reg, u##x val, bool trace) { \
1929         trace_i915_reg_rw(true, reg, val, sizeof(val), trace); \
1930         __raw_uncore_write##x(uncore, reg, val); \
1931 }
1932 __vgpu_write(8)
1933 __vgpu_write(16)
1934 __vgpu_write(32)
1935
1936 #define ASSIGN_RAW_WRITE_MMIO_VFUNCS(uncore, x) \
1937 do { \
1938         (uncore)->funcs.mmio_writeb = x##_write8; \
1939         (uncore)->funcs.mmio_writew = x##_write16; \
1940         (uncore)->funcs.mmio_writel = x##_write32; \
1941 } while (0)
1942
1943 #define ASSIGN_RAW_READ_MMIO_VFUNCS(uncore, x) \
1944 do { \
1945         (uncore)->funcs.mmio_readb = x##_read8; \
1946         (uncore)->funcs.mmio_readw = x##_read16; \
1947         (uncore)->funcs.mmio_readl = x##_read32; \
1948         (uncore)->funcs.mmio_readq = x##_read64; \
1949 } while (0)
1950
1951 #define ASSIGN_WRITE_MMIO_VFUNCS(uncore, x) \
1952 do { \
1953         ASSIGN_RAW_WRITE_MMIO_VFUNCS((uncore), x); \
1954         (uncore)->funcs.write_fw_domains = x##_reg_write_fw_domains; \
1955 } while (0)
1956
1957 #define ASSIGN_READ_MMIO_VFUNCS(uncore, x) \
1958 do { \
1959         ASSIGN_RAW_READ_MMIO_VFUNCS(uncore, x); \
1960         (uncore)->funcs.read_fw_domains = x##_reg_read_fw_domains; \
1961 } while (0)
1962
1963 static int __fw_domain_init(struct intel_uncore *uncore,
1964                             enum forcewake_domain_id domain_id,
1965                             i915_reg_t reg_set,
1966                             i915_reg_t reg_ack)
1967 {
1968         struct intel_uncore_forcewake_domain *d;
1969
1970         GEM_BUG_ON(domain_id >= FW_DOMAIN_ID_COUNT);
1971         GEM_BUG_ON(uncore->fw_domain[domain_id]);
1972
1973         if (i915_inject_probe_failure(uncore->i915))
1974                 return -ENOMEM;
1975
1976         d = kzalloc(sizeof(*d), GFP_KERNEL);
1977         if (!d)
1978                 return -ENOMEM;
1979
1980         drm_WARN_ON(&uncore->i915->drm, !i915_mmio_reg_valid(reg_set));
1981         drm_WARN_ON(&uncore->i915->drm, !i915_mmio_reg_valid(reg_ack));
1982
1983         d->uncore = uncore;
1984         d->wake_count = 0;
1985         d->reg_set = uncore->regs + i915_mmio_reg_offset(reg_set);
1986         d->reg_ack = uncore->regs + i915_mmio_reg_offset(reg_ack);
1987
1988         d->id = domain_id;
1989
1990         BUILD_BUG_ON(FORCEWAKE_RENDER != (1 << FW_DOMAIN_ID_RENDER));
1991         BUILD_BUG_ON(FORCEWAKE_GT != (1 << FW_DOMAIN_ID_GT));
1992         BUILD_BUG_ON(FORCEWAKE_MEDIA != (1 << FW_DOMAIN_ID_MEDIA));
1993         BUILD_BUG_ON(FORCEWAKE_MEDIA_VDBOX0 != (1 << FW_DOMAIN_ID_MEDIA_VDBOX0));
1994         BUILD_BUG_ON(FORCEWAKE_MEDIA_VDBOX1 != (1 << FW_DOMAIN_ID_MEDIA_VDBOX1));
1995         BUILD_BUG_ON(FORCEWAKE_MEDIA_VDBOX2 != (1 << FW_DOMAIN_ID_MEDIA_VDBOX2));
1996         BUILD_BUG_ON(FORCEWAKE_MEDIA_VDBOX3 != (1 << FW_DOMAIN_ID_MEDIA_VDBOX3));
1997         BUILD_BUG_ON(FORCEWAKE_MEDIA_VDBOX4 != (1 << FW_DOMAIN_ID_MEDIA_VDBOX4));
1998         BUILD_BUG_ON(FORCEWAKE_MEDIA_VDBOX5 != (1 << FW_DOMAIN_ID_MEDIA_VDBOX5));
1999         BUILD_BUG_ON(FORCEWAKE_MEDIA_VDBOX6 != (1 << FW_DOMAIN_ID_MEDIA_VDBOX6));
2000         BUILD_BUG_ON(FORCEWAKE_MEDIA_VDBOX7 != (1 << FW_DOMAIN_ID_MEDIA_VDBOX7));
2001         BUILD_BUG_ON(FORCEWAKE_MEDIA_VEBOX0 != (1 << FW_DOMAIN_ID_MEDIA_VEBOX0));
2002         BUILD_BUG_ON(FORCEWAKE_MEDIA_VEBOX1 != (1 << FW_DOMAIN_ID_MEDIA_VEBOX1));
2003         BUILD_BUG_ON(FORCEWAKE_MEDIA_VEBOX2 != (1 << FW_DOMAIN_ID_MEDIA_VEBOX2));
2004         BUILD_BUG_ON(FORCEWAKE_MEDIA_VEBOX3 != (1 << FW_DOMAIN_ID_MEDIA_VEBOX3));
2005
2006         d->mask = BIT(domain_id);
2007
2008         hrtimer_init(&d->timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
2009         d->timer.function = intel_uncore_fw_release_timer;
2010
2011         uncore->fw_domains |= BIT(domain_id);
2012
2013         fw_domain_reset(d);
2014
2015         uncore->fw_domain[domain_id] = d;
2016
2017         return 0;
2018 }
2019
2020 static void fw_domain_fini(struct intel_uncore *uncore,
2021                            enum forcewake_domain_id domain_id)
2022 {
2023         struct intel_uncore_forcewake_domain *d;
2024
2025         GEM_BUG_ON(domain_id >= FW_DOMAIN_ID_COUNT);
2026
2027         d = fetch_and_zero(&uncore->fw_domain[domain_id]);
2028         if (!d)
2029                 return;
2030
2031         uncore->fw_domains &= ~BIT(domain_id);
2032         drm_WARN_ON(&uncore->i915->drm, d->wake_count);
2033         drm_WARN_ON(&uncore->i915->drm, hrtimer_cancel(&d->timer));
2034         kfree(d);
2035 }
2036
2037 static void intel_uncore_fw_domains_fini(struct intel_uncore *uncore)
2038 {
2039         struct intel_uncore_forcewake_domain *d;
2040         int tmp;
2041
2042         for_each_fw_domain(d, uncore, tmp)
2043                 fw_domain_fini(uncore, d->id);
2044 }
2045
2046 static const struct intel_uncore_fw_get uncore_get_fallback = {
2047         .force_wake_get = fw_domains_get_with_fallback
2048 };
2049
2050 static const struct intel_uncore_fw_get uncore_get_normal = {
2051         .force_wake_get = fw_domains_get_normal,
2052 };
2053
2054 static const struct intel_uncore_fw_get uncore_get_thread_status = {
2055         .force_wake_get = fw_domains_get_with_thread_status
2056 };
2057
2058 static int intel_uncore_fw_domains_init(struct intel_uncore *uncore)
2059 {
2060         struct drm_i915_private *i915 = uncore->i915;
2061         int ret = 0;
2062
2063         GEM_BUG_ON(!intel_uncore_has_forcewake(uncore));
2064
2065 #define fw_domain_init(uncore__, id__, set__, ack__) \
2066         (ret ?: (ret = __fw_domain_init((uncore__), (id__), (set__), (ack__))))
2067
2068         if (GRAPHICS_VER(i915) >= 11) {
2069                 /* we'll prune the domains of missing engines later */
2070                 intel_engine_mask_t emask = INTEL_INFO(i915)->platform_engine_mask;
2071                 int i;
2072
2073                 uncore->fw_get_funcs = &uncore_get_fallback;
2074                 fw_domain_init(uncore, FW_DOMAIN_ID_RENDER,
2075                                FORCEWAKE_RENDER_GEN9,
2076                                FORCEWAKE_ACK_RENDER_GEN9);
2077                 fw_domain_init(uncore, FW_DOMAIN_ID_GT,
2078                                FORCEWAKE_GT_GEN9,
2079                                FORCEWAKE_ACK_GT_GEN9);
2080
2081                 for (i = 0; i < I915_MAX_VCS; i++) {
2082                         if (!__HAS_ENGINE(emask, _VCS(i)))
2083                                 continue;
2084
2085                         fw_domain_init(uncore, FW_DOMAIN_ID_MEDIA_VDBOX0 + i,
2086                                        FORCEWAKE_MEDIA_VDBOX_GEN11(i),
2087                                        FORCEWAKE_ACK_MEDIA_VDBOX_GEN11(i));
2088                 }
2089                 for (i = 0; i < I915_MAX_VECS; i++) {
2090                         if (!__HAS_ENGINE(emask, _VECS(i)))
2091                                 continue;
2092
2093                         fw_domain_init(uncore, FW_DOMAIN_ID_MEDIA_VEBOX0 + i,
2094                                        FORCEWAKE_MEDIA_VEBOX_GEN11(i),
2095                                        FORCEWAKE_ACK_MEDIA_VEBOX_GEN11(i));
2096                 }
2097         } else if (IS_GRAPHICS_VER(i915, 9, 10)) {
2098                 uncore->fw_get_funcs = &uncore_get_fallback;
2099                 fw_domain_init(uncore, FW_DOMAIN_ID_RENDER,
2100                                FORCEWAKE_RENDER_GEN9,
2101                                FORCEWAKE_ACK_RENDER_GEN9);
2102                 fw_domain_init(uncore, FW_DOMAIN_ID_GT,
2103                                FORCEWAKE_GT_GEN9,
2104                                FORCEWAKE_ACK_GT_GEN9);
2105                 fw_domain_init(uncore, FW_DOMAIN_ID_MEDIA,
2106                                FORCEWAKE_MEDIA_GEN9, FORCEWAKE_ACK_MEDIA_GEN9);
2107         } else if (IS_VALLEYVIEW(i915) || IS_CHERRYVIEW(i915)) {
2108                 uncore->fw_get_funcs = &uncore_get_normal;
2109                 fw_domain_init(uncore, FW_DOMAIN_ID_RENDER,
2110                                FORCEWAKE_VLV, FORCEWAKE_ACK_VLV);
2111                 fw_domain_init(uncore, FW_DOMAIN_ID_MEDIA,
2112                                FORCEWAKE_MEDIA_VLV, FORCEWAKE_ACK_MEDIA_VLV);
2113         } else if (IS_HASWELL(i915) || IS_BROADWELL(i915)) {
2114                 uncore->fw_get_funcs = &uncore_get_thread_status;
2115                 fw_domain_init(uncore, FW_DOMAIN_ID_RENDER,
2116                                FORCEWAKE_MT, FORCEWAKE_ACK_HSW);
2117         } else if (IS_IVYBRIDGE(i915)) {
2118                 u32 ecobus;
2119
2120                 /* IVB configs may use multi-threaded forcewake */
2121
2122                 /* A small trick here - if the bios hasn't configured
2123                  * MT forcewake, and if the device is in RC6, then
2124                  * force_wake_mt_get will not wake the device and the
2125                  * ECOBUS read will return zero. Which will be
2126                  * (correctly) interpreted by the test below as MT
2127                  * forcewake being disabled.
2128                  */
2129                 uncore->fw_get_funcs = &uncore_get_thread_status;
2130
2131                 /* We need to init first for ECOBUS access and then
2132                  * determine later if we want to reinit, in case of MT access is
2133                  * not working. In this stage we don't know which flavour this
2134                  * ivb is, so it is better to reset also the gen6 fw registers
2135                  * before the ecobus check.
2136                  */
2137
2138                 __raw_uncore_write32(uncore, FORCEWAKE, 0);
2139                 __raw_posting_read(uncore, ECOBUS);
2140
2141                 ret = __fw_domain_init(uncore, FW_DOMAIN_ID_RENDER,
2142                                        FORCEWAKE_MT, FORCEWAKE_MT_ACK);
2143                 if (ret)
2144                         goto out;
2145
2146                 spin_lock_irq(&uncore->lock);
2147                 fw_domains_get_with_thread_status(uncore, FORCEWAKE_RENDER);
2148                 ecobus = __raw_uncore_read32(uncore, ECOBUS);
2149                 fw_domains_put(uncore, FORCEWAKE_RENDER);
2150                 spin_unlock_irq(&uncore->lock);
2151
2152                 if (!(ecobus & FORCEWAKE_MT_ENABLE)) {
2153                         drm_info(&i915->drm, "No MT forcewake available on Ivybridge, this can result in issues\n");
2154                         drm_info(&i915->drm, "when using vblank-synced partial screen updates.\n");
2155                         fw_domain_fini(uncore, FW_DOMAIN_ID_RENDER);
2156                         fw_domain_init(uncore, FW_DOMAIN_ID_RENDER,
2157                                        FORCEWAKE, FORCEWAKE_ACK);
2158                 }
2159         } else if (GRAPHICS_VER(i915) == 6) {
2160                 uncore->fw_get_funcs = &uncore_get_thread_status;
2161                 fw_domain_init(uncore, FW_DOMAIN_ID_RENDER,
2162                                FORCEWAKE, FORCEWAKE_ACK);
2163         }
2164
2165 #undef fw_domain_init
2166
2167         /* All future platforms are expected to require complex power gating */
2168         drm_WARN_ON(&i915->drm, !ret && uncore->fw_domains == 0);
2169
2170 out:
2171         if (ret)
2172                 intel_uncore_fw_domains_fini(uncore);
2173
2174         return ret;
2175 }
2176
2177 #define ASSIGN_FW_DOMAINS_TABLE(uncore, d) \
2178 { \
2179         (uncore)->fw_domains_table = \
2180                         (struct intel_forcewake_range *)(d); \
2181         (uncore)->fw_domains_table_entries = ARRAY_SIZE((d)); \
2182 }
2183
2184 #define ASSIGN_SHADOW_TABLE(uncore, d) \
2185 { \
2186         (uncore)->shadowed_reg_table = d; \
2187         (uncore)->shadowed_reg_table_entries = ARRAY_SIZE((d)); \
2188 }
2189
2190 static int i915_pmic_bus_access_notifier(struct notifier_block *nb,
2191                                          unsigned long action, void *data)
2192 {
2193         struct intel_uncore *uncore = container_of(nb,
2194                         struct intel_uncore, pmic_bus_access_nb);
2195
2196         switch (action) {
2197         case MBI_PMIC_BUS_ACCESS_BEGIN:
2198                 /*
2199                  * forcewake all now to make sure that we don't need to do a
2200                  * forcewake later which on systems where this notifier gets
2201                  * called requires the punit to access to the shared pmic i2c
2202                  * bus, which will be busy after this notification, leading to:
2203                  * "render: timed out waiting for forcewake ack request."
2204                  * errors.
2205                  *
2206                  * The notifier is unregistered during intel_runtime_suspend(),
2207                  * so it's ok to access the HW here without holding a RPM
2208                  * wake reference -> disable wakeref asserts for the time of
2209                  * the access.
2210                  */
2211                 disable_rpm_wakeref_asserts(uncore->rpm);
2212                 intel_uncore_forcewake_get(uncore, FORCEWAKE_ALL);
2213                 enable_rpm_wakeref_asserts(uncore->rpm);
2214                 break;
2215         case MBI_PMIC_BUS_ACCESS_END:
2216                 intel_uncore_forcewake_put(uncore, FORCEWAKE_ALL);
2217                 break;
2218         }
2219
2220         return NOTIFY_OK;
2221 }
2222
2223 int intel_uncore_setup_mmio(struct intel_uncore *uncore, phys_addr_t phys_addr)
2224 {
2225         struct drm_i915_private *i915 = uncore->i915;
2226         int mmio_size;
2227
2228         /*
2229          * Before gen4, the registers and the GTT are behind different BARs.
2230          * However, from gen4 onwards, the registers and the GTT are shared
2231          * in the same BAR, so we want to restrict this ioremap from
2232          * clobbering the GTT which we want ioremap_wc instead. Fortunately,
2233          * the register BAR remains the same size for all the earlier
2234          * generations up to Ironlake.
2235          * For dgfx chips register range is expanded to 4MB.
2236          */
2237         if (GRAPHICS_VER(i915) < 5)
2238                 mmio_size = 512 * 1024;
2239         else if (IS_DGFX(i915))
2240                 mmio_size = 4 * 1024 * 1024;
2241         else
2242                 mmio_size = 2 * 1024 * 1024;
2243
2244         uncore->regs = ioremap(phys_addr, mmio_size);
2245         if (uncore->regs == NULL) {
2246                 drm_err(&i915->drm, "failed to map registers\n");
2247                 return -EIO;
2248         }
2249
2250         return 0;
2251 }
2252
2253 void intel_uncore_cleanup_mmio(struct intel_uncore *uncore)
2254 {
2255         iounmap(uncore->regs);
2256 }
2257
2258 void intel_uncore_init_early(struct intel_uncore *uncore,
2259                              struct intel_gt *gt)
2260 {
2261         spin_lock_init(&uncore->lock);
2262         uncore->i915 = gt->i915;
2263         uncore->gt = gt;
2264         uncore->rpm = &gt->i915->runtime_pm;
2265         uncore->debug = &gt->i915->mmio_debug;
2266 }
2267
2268 static void uncore_raw_init(struct intel_uncore *uncore)
2269 {
2270         GEM_BUG_ON(intel_uncore_has_forcewake(uncore));
2271
2272         if (intel_vgpu_active(uncore->i915)) {
2273                 ASSIGN_RAW_WRITE_MMIO_VFUNCS(uncore, vgpu);
2274                 ASSIGN_RAW_READ_MMIO_VFUNCS(uncore, vgpu);
2275         } else if (GRAPHICS_VER(uncore->i915) == 5) {
2276                 ASSIGN_RAW_WRITE_MMIO_VFUNCS(uncore, gen5);
2277                 ASSIGN_RAW_READ_MMIO_VFUNCS(uncore, gen5);
2278         } else {
2279                 ASSIGN_RAW_WRITE_MMIO_VFUNCS(uncore, gen2);
2280                 ASSIGN_RAW_READ_MMIO_VFUNCS(uncore, gen2);
2281         }
2282 }
2283
2284 static int uncore_forcewake_init(struct intel_uncore *uncore)
2285 {
2286         struct drm_i915_private *i915 = uncore->i915;
2287         int ret;
2288
2289         GEM_BUG_ON(!intel_uncore_has_forcewake(uncore));
2290
2291         ret = intel_uncore_fw_domains_init(uncore);
2292         if (ret)
2293                 return ret;
2294         forcewake_early_sanitize(uncore, 0);
2295
2296         ASSIGN_READ_MMIO_VFUNCS(uncore, fwtable);
2297
2298         if (GRAPHICS_VER_FULL(i915) >= IP_VER(12, 60)) {
2299                 ASSIGN_FW_DOMAINS_TABLE(uncore, __pvc_fw_ranges);
2300                 ASSIGN_SHADOW_TABLE(uncore, pvc_shadowed_regs);
2301                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, fwtable);
2302         } else if (GRAPHICS_VER_FULL(i915) >= IP_VER(12, 55)) {
2303                 ASSIGN_FW_DOMAINS_TABLE(uncore, __dg2_fw_ranges);
2304                 ASSIGN_SHADOW_TABLE(uncore, dg2_shadowed_regs);
2305                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, fwtable);
2306         } else if (GRAPHICS_VER_FULL(i915) >= IP_VER(12, 50)) {
2307                 ASSIGN_FW_DOMAINS_TABLE(uncore, __xehp_fw_ranges);
2308                 ASSIGN_SHADOW_TABLE(uncore, gen12_shadowed_regs);
2309                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, fwtable);
2310         } else if (GRAPHICS_VER(i915) >= 12) {
2311                 ASSIGN_FW_DOMAINS_TABLE(uncore, __gen12_fw_ranges);
2312                 ASSIGN_SHADOW_TABLE(uncore, gen12_shadowed_regs);
2313                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, fwtable);
2314         } else if (GRAPHICS_VER(i915) == 11) {
2315                 ASSIGN_FW_DOMAINS_TABLE(uncore, __gen11_fw_ranges);
2316                 ASSIGN_SHADOW_TABLE(uncore, gen11_shadowed_regs);
2317                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, fwtable);
2318         } else if (IS_GRAPHICS_VER(i915, 9, 10)) {
2319                 ASSIGN_FW_DOMAINS_TABLE(uncore, __gen9_fw_ranges);
2320                 ASSIGN_SHADOW_TABLE(uncore, gen8_shadowed_regs);
2321                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, fwtable);
2322         } else if (IS_CHERRYVIEW(i915)) {
2323                 ASSIGN_FW_DOMAINS_TABLE(uncore, __chv_fw_ranges);
2324                 ASSIGN_SHADOW_TABLE(uncore, gen8_shadowed_regs);
2325                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, fwtable);
2326         } else if (GRAPHICS_VER(i915) == 8) {
2327                 ASSIGN_FW_DOMAINS_TABLE(uncore, __gen6_fw_ranges);
2328                 ASSIGN_SHADOW_TABLE(uncore, gen8_shadowed_regs);
2329                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, fwtable);
2330         } else if (IS_VALLEYVIEW(i915)) {
2331                 ASSIGN_FW_DOMAINS_TABLE(uncore, __vlv_fw_ranges);
2332                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, gen6);
2333         } else if (IS_GRAPHICS_VER(i915, 6, 7)) {
2334                 ASSIGN_FW_DOMAINS_TABLE(uncore, __gen6_fw_ranges);
2335                 ASSIGN_WRITE_MMIO_VFUNCS(uncore, gen6);
2336         }
2337
2338         uncore->pmic_bus_access_nb.notifier_call = i915_pmic_bus_access_notifier;
2339         iosf_mbi_register_pmic_bus_access_notifier(&uncore->pmic_bus_access_nb);
2340
2341         return 0;
2342 }
2343
2344 int intel_uncore_init_mmio(struct intel_uncore *uncore)
2345 {
2346         struct drm_i915_private *i915 = uncore->i915;
2347         int ret;
2348
2349         /*
2350          * The boot firmware initializes local memory and assesses its health.
2351          * If memory training fails, the punit will have been instructed to
2352          * keep the GT powered down; we won't be able to communicate with it
2353          * and we should not continue with driver initialization.
2354          */
2355         if (IS_DGFX(i915) &&
2356             !(__raw_uncore_read32(uncore, GU_CNTL) & LMEM_INIT)) {
2357                 drm_err(&i915->drm, "LMEM not initialized by firmware\n");
2358                 return -ENODEV;
2359         }
2360
2361         if (GRAPHICS_VER(i915) > 5 && !intel_vgpu_active(i915))
2362                 uncore->flags |= UNCORE_HAS_FORCEWAKE;
2363
2364         if (!intel_uncore_has_forcewake(uncore)) {
2365                 uncore_raw_init(uncore);
2366         } else {
2367                 ret = uncore_forcewake_init(uncore);
2368                 if (ret)
2369                         return ret;
2370         }
2371
2372         /* make sure fw funcs are set if and only if we have fw*/
2373         GEM_BUG_ON(intel_uncore_has_forcewake(uncore) != !!uncore->fw_get_funcs);
2374         GEM_BUG_ON(intel_uncore_has_forcewake(uncore) != !!uncore->funcs.read_fw_domains);
2375         GEM_BUG_ON(intel_uncore_has_forcewake(uncore) != !!uncore->funcs.write_fw_domains);
2376
2377         if (HAS_FPGA_DBG_UNCLAIMED(i915))
2378                 uncore->flags |= UNCORE_HAS_FPGA_DBG_UNCLAIMED;
2379
2380         if (IS_VALLEYVIEW(i915) || IS_CHERRYVIEW(i915))
2381                 uncore->flags |= UNCORE_HAS_DBG_UNCLAIMED;
2382
2383         if (IS_GRAPHICS_VER(i915, 6, 7))
2384                 uncore->flags |= UNCORE_HAS_FIFO;
2385
2386         /* clear out unclaimed reg detection bit */
2387         if (intel_uncore_unclaimed_mmio(uncore))
2388                 drm_dbg(&i915->drm, "unclaimed mmio detected on uncore init, clearing\n");
2389
2390         return 0;
2391 }
2392
2393 /*
2394  * We might have detected that some engines are fused off after we initialized
2395  * the forcewake domains. Prune them, to make sure they only reference existing
2396  * engines.
2397  */
2398 void intel_uncore_prune_engine_fw_domains(struct intel_uncore *uncore,
2399                                           struct intel_gt *gt)
2400 {
2401         enum forcewake_domains fw_domains = uncore->fw_domains;
2402         enum forcewake_domain_id domain_id;
2403         int i;
2404
2405         if (!intel_uncore_has_forcewake(uncore) || GRAPHICS_VER(uncore->i915) < 11)
2406                 return;
2407
2408         for (i = 0; i < I915_MAX_VCS; i++) {
2409                 domain_id = FW_DOMAIN_ID_MEDIA_VDBOX0 + i;
2410
2411                 if (HAS_ENGINE(gt, _VCS(i)))
2412                         continue;
2413
2414                 /*
2415                  * Starting with XeHP, the power well for an even-numbered
2416                  * VDBOX is also used for shared units within the
2417                  * media slice such as SFC.  So even if the engine
2418                  * itself is fused off, we still need to initialize
2419                  * the forcewake domain if any of the other engines
2420                  * in the same media slice are present.
2421                  */
2422                 if (GRAPHICS_VER_FULL(uncore->i915) >= IP_VER(12, 50) && i % 2 == 0) {
2423                         if ((i + 1 < I915_MAX_VCS) && HAS_ENGINE(gt, _VCS(i + 1)))
2424                                 continue;
2425
2426                         if (HAS_ENGINE(gt, _VECS(i / 2)))
2427                                 continue;
2428                 }
2429
2430                 if (fw_domains & BIT(domain_id))
2431                         fw_domain_fini(uncore, domain_id);
2432         }
2433
2434         for (i = 0; i < I915_MAX_VECS; i++) {
2435                 domain_id = FW_DOMAIN_ID_MEDIA_VEBOX0 + i;
2436
2437                 if (HAS_ENGINE(gt, _VECS(i)))
2438                         continue;
2439
2440                 if (fw_domains & BIT(domain_id))
2441                         fw_domain_fini(uncore, domain_id);
2442         }
2443 }
2444
2445 void intel_uncore_fini_mmio(struct intel_uncore *uncore)
2446 {
2447         if (intel_uncore_has_forcewake(uncore)) {
2448                 iosf_mbi_punit_acquire();
2449                 iosf_mbi_unregister_pmic_bus_access_notifier_unlocked(
2450                         &uncore->pmic_bus_access_nb);
2451                 intel_uncore_forcewake_reset(uncore);
2452                 intel_uncore_fw_domains_fini(uncore);
2453                 iosf_mbi_punit_release();
2454         }
2455 }
2456
2457 /**
2458  * __intel_wait_for_register_fw - wait until register matches expected state
2459  * @uncore: the struct intel_uncore
2460  * @reg: the register to read
2461  * @mask: mask to apply to register value
2462  * @value: expected value
2463  * @fast_timeout_us: fast timeout in microsecond for atomic/tight wait
2464  * @slow_timeout_ms: slow timeout in millisecond
2465  * @out_value: optional placeholder to hold registry value
2466  *
2467  * This routine waits until the target register @reg contains the expected
2468  * @value after applying the @mask, i.e. it waits until ::
2469  *
2470  *     (intel_uncore_read_fw(uncore, reg) & mask) == value
2471  *
2472  * Otherwise, the wait will timeout after @slow_timeout_ms milliseconds.
2473  * For atomic context @slow_timeout_ms must be zero and @fast_timeout_us
2474  * must be not larger than 20,0000 microseconds.
2475  *
2476  * Note that this routine assumes the caller holds forcewake asserted, it is
2477  * not suitable for very long waits. See intel_wait_for_register() if you
2478  * wish to wait without holding forcewake for the duration (i.e. you expect
2479  * the wait to be slow).
2480  *
2481  * Return: 0 if the register matches the desired condition, or -ETIMEDOUT.
2482  */
2483 int __intel_wait_for_register_fw(struct intel_uncore *uncore,
2484                                  i915_reg_t reg,
2485                                  u32 mask,
2486                                  u32 value,
2487                                  unsigned int fast_timeout_us,
2488                                  unsigned int slow_timeout_ms,
2489                                  u32 *out_value)
2490 {
2491         u32 reg_value = 0;
2492 #define done (((reg_value = intel_uncore_read_fw(uncore, reg)) & mask) == value)
2493         int ret;
2494
2495         /* Catch any overuse of this function */
2496         might_sleep_if(slow_timeout_ms);
2497         GEM_BUG_ON(fast_timeout_us > 20000);
2498         GEM_BUG_ON(!fast_timeout_us && !slow_timeout_ms);
2499
2500         ret = -ETIMEDOUT;
2501         if (fast_timeout_us && fast_timeout_us <= 20000)
2502                 ret = _wait_for_atomic(done, fast_timeout_us, 0);
2503         if (ret && slow_timeout_ms)
2504                 ret = wait_for(done, slow_timeout_ms);
2505
2506         if (out_value)
2507                 *out_value = reg_value;
2508
2509         return ret;
2510 #undef done
2511 }
2512
2513 /**
2514  * __intel_wait_for_register - wait until register matches expected state
2515  * @uncore: the struct intel_uncore
2516  * @reg: the register to read
2517  * @mask: mask to apply to register value
2518  * @value: expected value
2519  * @fast_timeout_us: fast timeout in microsecond for atomic/tight wait
2520  * @slow_timeout_ms: slow timeout in millisecond
2521  * @out_value: optional placeholder to hold registry value
2522  *
2523  * This routine waits until the target register @reg contains the expected
2524  * @value after applying the @mask, i.e. it waits until ::
2525  *
2526  *     (intel_uncore_read(uncore, reg) & mask) == value
2527  *
2528  * Otherwise, the wait will timeout after @timeout_ms milliseconds.
2529  *
2530  * Return: 0 if the register matches the desired condition, or -ETIMEDOUT.
2531  */
2532 int __intel_wait_for_register(struct intel_uncore *uncore,
2533                               i915_reg_t reg,
2534                               u32 mask,
2535                               u32 value,
2536                               unsigned int fast_timeout_us,
2537                               unsigned int slow_timeout_ms,
2538                               u32 *out_value)
2539 {
2540         unsigned fw =
2541                 intel_uncore_forcewake_for_reg(uncore, reg, FW_REG_READ);
2542         u32 reg_value;
2543         int ret;
2544
2545         might_sleep_if(slow_timeout_ms);
2546
2547         spin_lock_irq(&uncore->lock);
2548         intel_uncore_forcewake_get__locked(uncore, fw);
2549
2550         ret = __intel_wait_for_register_fw(uncore,
2551                                            reg, mask, value,
2552                                            fast_timeout_us, 0, &reg_value);
2553
2554         intel_uncore_forcewake_put__locked(uncore, fw);
2555         spin_unlock_irq(&uncore->lock);
2556
2557         if (ret && slow_timeout_ms)
2558                 ret = __wait_for(reg_value = intel_uncore_read_notrace(uncore,
2559                                                                        reg),
2560                                  (reg_value & mask) == value,
2561                                  slow_timeout_ms * 1000, 10, 1000);
2562
2563         /* just trace the final value */
2564         trace_i915_reg_rw(false, reg, reg_value, sizeof(reg_value), true);
2565
2566         if (out_value)
2567                 *out_value = reg_value;
2568
2569         return ret;
2570 }
2571
2572 bool intel_uncore_unclaimed_mmio(struct intel_uncore *uncore)
2573 {
2574         bool ret;
2575
2576         spin_lock_irq(&uncore->debug->lock);
2577         ret = check_for_unclaimed_mmio(uncore);
2578         spin_unlock_irq(&uncore->debug->lock);
2579
2580         return ret;
2581 }
2582
2583 bool
2584 intel_uncore_arm_unclaimed_mmio_detection(struct intel_uncore *uncore)
2585 {
2586         bool ret = false;
2587
2588         spin_lock_irq(&uncore->debug->lock);
2589
2590         if (unlikely(uncore->debug->unclaimed_mmio_check <= 0))
2591                 goto out;
2592
2593         if (unlikely(check_for_unclaimed_mmio(uncore))) {
2594                 if (!uncore->i915->params.mmio_debug) {
2595                         drm_dbg(&uncore->i915->drm,
2596                                 "Unclaimed register detected, "
2597                                 "enabling oneshot unclaimed register reporting. "
2598                                 "Please use i915.mmio_debug=N for more information.\n");
2599                         uncore->i915->params.mmio_debug++;
2600                 }
2601                 uncore->debug->unclaimed_mmio_check--;
2602                 ret = true;
2603         }
2604
2605 out:
2606         spin_unlock_irq(&uncore->debug->lock);
2607
2608         return ret;
2609 }
2610
2611 /**
2612  * intel_uncore_forcewake_for_reg - which forcewake domains are needed to access
2613  *                                  a register
2614  * @uncore: pointer to struct intel_uncore
2615  * @reg: register in question
2616  * @op: operation bitmask of FW_REG_READ and/or FW_REG_WRITE
2617  *
2618  * Returns a set of forcewake domains required to be taken with for example
2619  * intel_uncore_forcewake_get for the specified register to be accessible in the
2620  * specified mode (read, write or read/write) with raw mmio accessors.
2621  *
2622  * NOTE: On Gen6 and Gen7 write forcewake domain (FORCEWAKE_RENDER) requires the
2623  * callers to do FIFO management on their own or risk losing writes.
2624  */
2625 enum forcewake_domains
2626 intel_uncore_forcewake_for_reg(struct intel_uncore *uncore,
2627                                i915_reg_t reg, unsigned int op)
2628 {
2629         enum forcewake_domains fw_domains = 0;
2630
2631         drm_WARN_ON(&uncore->i915->drm, !op);
2632
2633         if (!intel_uncore_has_forcewake(uncore))
2634                 return 0;
2635
2636         if (op & FW_REG_READ)
2637                 fw_domains = uncore->funcs.read_fw_domains(uncore, reg);
2638
2639         if (op & FW_REG_WRITE)
2640                 fw_domains |= uncore->funcs.write_fw_domains(uncore, reg);
2641
2642         drm_WARN_ON(&uncore->i915->drm, fw_domains & ~uncore->fw_domains);
2643
2644         return fw_domains;
2645 }
2646
2647 #if IS_ENABLED(CONFIG_DRM_I915_SELFTEST)
2648 #include "selftests/mock_uncore.c"
2649 #include "selftests/intel_uncore.c"
2650 #endif