drivers/gpu/drm/i915/i915_drv.h

   1 /* i915_drv.h -- Private header for the I915 driver -*- linux-c -*-
   2  */
   3 /*
   4  *
   5  * Copyright 2003 Tungsten Graphics, Inc., Cedar Park, Texas.
   6  * All Rights Reserved.
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the
  10  * "Software"), to deal in the Software without restriction, including
  11  * without limitation the rights to use, copy, modify, merge, publish,
  12  * distribute, sub license, and/or sell copies of the Software, and to
  13  * permit persons to whom the Software is furnished to do so, subject to
  14  * the following conditions:
  15  *
  16  * The above copyright notice and this permission notice (including the
  17  * next paragraph) shall be included in all copies or substantial portions
  18  * of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  21  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  23  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  24  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  25  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  26  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27  *
  28  */
  29
  30 #ifndef _I915_DRV_H_
  31 #define _I915_DRV_H_
  32
  33 #include <uapi/drm/i915_drm.h>
  34 #include <uapi/drm/drm_fourcc.h>
  35
  36 #include <asm/hypervisor.h>
  37
  38 #include <linux/io-mapping.h>
  39 #include <linux/i2c.h>
  40 #include <linux/i2c-algo-bit.h>
  41 #include <linux/backlight.h>
  42 #include <linux/hash.h>
  43 #include <linux/intel-iommu.h>
  44 #include <linux/kref.h>
  45 #include <linux/mm_types.h>
  46 #include <linux/perf_event.h>
  47 #include <linux/pm_qos.h>
  48 #include <linux/dma-resv.h>
  49 #include <linux/shmem_fs.h>
  50 #include <linux/stackdepot.h>
  51 #include <linux/xarray.h>
  52
  53 #include <drm/intel-gtt.h>
  54 #include <drm/drm_gem.h>
  55 #include <drm/drm_auth.h>
  56 #include <drm/drm_cache.h>
  57 #include <drm/drm_util.h>
  58 #include <drm/drm_dsc.h>
  59 #include <drm/drm_atomic.h>
  60 #include <drm/drm_connector.h>
  61 #include <drm/i915_mei_hdcp_interface.h>
  62 #include <drm/ttm/ttm_device.h>
  63
  64 #include "i915_params.h"
  65 #include "i915_reg.h"
  66 #include "i915_utils.h"
  67
  68 #include "display/intel_bios.h"
  69 #include "display/intel_display.h"
  70 #include "display/intel_display_power.h"
  71 #include "display/intel_dmc.h"
  72 #include "display/intel_dpll_mgr.h"
  73 #include "display/intel_dsb.h"
  74 #include "display/intel_frontbuffer.h"
  75 #include "display/intel_global_state.h"
  76 #include "display/intel_gmbus.h"
  77 #include "display/intel_opregion.h"
  78
  79 #include "gem/i915_gem_context_types.h"
  80 #include "gem/i915_gem_shrinker.h"
  81 #include "gem/i915_gem_stolen.h"
  82 #include "gem/i915_gem_lmem.h"
  83
  84 #include "gt/intel_engine.h"
  85 #include "gt/intel_gt_types.h"
  86 #include "gt/intel_region_lmem.h"
  87 #include "gt/intel_workarounds.h"
  88 #include "gt/uc/intel_uc.h"
  89
  90 #include "intel_device_info.h"
  91 #include "intel_memory_region.h"
  92 #include "intel_pch.h"
  93 #include "intel_runtime_pm.h"
  94 #include "intel_step.h"
  95 #include "intel_uncore.h"
  96 #include "intel_wakeref.h"
  97 #include "intel_wopcm.h"
  98
  99 #include "i915_gem.h"
 100 #include "i915_gem_gtt.h"
 101 #include "i915_gpu_error.h"
 102 #include "i915_perf_types.h"
 103 #include "i915_request.h"
 104 #include "i915_scheduler.h"
 105 #include "gt/intel_timeline.h"
 106 #include "i915_vma.h"
 107 #include "i915_irq.h"
 108
 109
 110 /* General customization:
 111  */
 112
 113 #define DRIVER_NAME             "i915"
 114 #define DRIVER_DESC             "Intel Graphics"
 115 #define DRIVER_DATE             "20201103"
 116 #define DRIVER_TIMESTAMP        1604406085
 117
 118 struct drm_i915_gem_object;
 119
 120 enum hpd_pin {
 121         HPD_NONE = 0,
 122         HPD_TV = HPD_NONE,     /* TV is known to be unreliable */
 123         HPD_CRT,
 124         HPD_SDVO_B,
 125         HPD_SDVO_C,
 126         HPD_PORT_A,
 127         HPD_PORT_B,
 128         HPD_PORT_C,
 129         HPD_PORT_D,
 130         HPD_PORT_E,
 131         HPD_PORT_TC1,
 132         HPD_PORT_TC2,
 133         HPD_PORT_TC3,
 134         HPD_PORT_TC4,
 135         HPD_PORT_TC5,
 136         HPD_PORT_TC6,
 137
 138         HPD_NUM_PINS
 139 };
 140
 141 #define for_each_hpd_pin(__pin) \
 142         for ((__pin) = (HPD_NONE + 1); (__pin) < HPD_NUM_PINS; (__pin)++)
 143
 144 /* Threshold == 5 for long IRQs, 50 for short */
 145 #define HPD_STORM_DEFAULT_THRESHOLD 50
 146
 147 struct i915_hotplug {
 148         struct delayed_work hotplug_work;
 149
 150         const u32 *hpd, *pch_hpd;
 151
 152         struct {
 153                 unsigned long last_jiffies;
 154                 int count;
 155                 enum {
 156                         HPD_ENABLED = 0,
 157                         HPD_DISABLED = 1,
 158                         HPD_MARK_DISABLED = 2
 159                 } state;
 160         } stats[HPD_NUM_PINS];
 161         u32 event_bits;
 162         u32 retry_bits;
 163         struct delayed_work reenable_work;
 164
 165         u32 long_port_mask;
 166         u32 short_port_mask;
 167         struct work_struct dig_port_work;
 168
 169         struct work_struct poll_init_work;
 170         bool poll_enabled;
 171
 172         unsigned int hpd_storm_threshold;
 173         /* Whether or not to count short HPD IRQs in HPD storms */
 174         u8 hpd_short_storm_enabled;
 175
 176         /*
 177          * if we get a HPD irq from DP and a HPD irq from non-DP
 178          * the non-DP HPD could block the workqueue on a mode config
 179          * mutex getting, that userspace may have taken. However
 180          * userspace is waiting on the DP workqueue to run which is
 181          * blocked behind the non-DP one.
 182          */
 183         struct workqueue_struct *dp_wq;
 184 };
 185
 186 #define I915_GEM_GPU_DOMAINS \
 187         (I915_GEM_DOMAIN_RENDER | \
 188          I915_GEM_DOMAIN_SAMPLER | \
 189          I915_GEM_DOMAIN_COMMAND | \
 190          I915_GEM_DOMAIN_INSTRUCTION | \
 191          I915_GEM_DOMAIN_VERTEX)
 192
 193 struct drm_i915_private;
 194 struct i915_mm_struct;
 195 struct i915_mmu_object;
 196
 197 struct drm_i915_file_private {
 198         struct drm_i915_private *dev_priv;
 199
 200         union {
 201                 struct drm_file *file;
 202                 struct rcu_head rcu;
 203         };
 204
 205         struct xarray context_xa;
 206         struct xarray vm_xa;
 207
 208         unsigned int bsd_engine;
 209
 210 /*
 211  * Every context ban increments per client ban score. Also
 212  * hangs in short succession increments ban score. If ban threshold
 213  * is reached, client is considered banned and submitting more work
 214  * will fail. This is a stop gap measure to limit the badly behaving
 215  * clients access to gpu. Note that unbannable contexts never increment
 216  * the client ban score.
 217  */
 218 #define I915_CLIENT_SCORE_HANG_FAST     1
 219 #define   I915_CLIENT_FAST_HANG_JIFFIES (60 * HZ)
 220 #define I915_CLIENT_SCORE_CONTEXT_BAN   3
 221 #define I915_CLIENT_SCORE_BANNED        9
 222         /** ban_score: Accumulated score of all ctx bans and fast hangs. */
 223         atomic_t ban_score;
 224         unsigned long hang_timestamp;
 225 };
 226
 227 /* Interface history:
 228  *
 229  * 1.1: Original.
 230  * 1.2: Add Power Management
 231  * 1.3: Add vblank support
 232  * 1.4: Fix cmdbuffer path, add heap destroy
 233  * 1.5: Add vblank pipe configuration
 234  * 1.6: - New ioctl for scheduling buffer swaps on vertical blank
 235  *      - Support vertical blank on secondary display pipe
 236  */
 237 #define DRIVER_MAJOR            1
 238 #define DRIVER_MINOR            6
 239 #define DRIVER_PATCHLEVEL       0
 240
 241 struct intel_overlay;
 242 struct intel_overlay_error_state;
 243
 244 struct sdvo_device_mapping {
 245         u8 initialized;
 246         u8 dvo_port;
 247         u8 slave_addr;
 248         u8 dvo_wiring;
 249         u8 i2c_pin;
 250         u8 ddc_pin;
 251 };
 252
 253 struct intel_connector;
 254 struct intel_encoder;
 255 struct intel_atomic_state;
 256 struct intel_cdclk_config;
 257 struct intel_cdclk_state;
 258 struct intel_cdclk_vals;
 259 struct intel_initial_plane_config;
 260 struct intel_crtc;
 261 struct intel_limit;
 262 struct dpll;
 263
 264 struct drm_i915_display_funcs {
 265         void (*get_cdclk)(struct drm_i915_private *dev_priv,
 266                           struct intel_cdclk_config *cdclk_config);
 267         void (*set_cdclk)(struct drm_i915_private *dev_priv,
 268                           const struct intel_cdclk_config *cdclk_config,
 269                           enum pipe pipe);
 270         int (*bw_calc_min_cdclk)(struct intel_atomic_state *state);
 271         int (*get_fifo_size)(struct drm_i915_private *dev_priv,
 272                              enum i9xx_plane_id i9xx_plane);
 273         int (*compute_pipe_wm)(struct intel_atomic_state *state,
 274                                struct intel_crtc *crtc);
 275         int (*compute_intermediate_wm)(struct intel_atomic_state *state,
 276                                        struct intel_crtc *crtc);
 277         void (*initial_watermarks)(struct intel_atomic_state *state,
 278                                    struct intel_crtc *crtc);
 279         void (*atomic_update_watermarks)(struct intel_atomic_state *state,
 280                                          struct intel_crtc *crtc);
 281         void (*optimize_watermarks)(struct intel_atomic_state *state,
 282                                     struct intel_crtc *crtc);
 283         int (*compute_global_watermarks)(struct intel_atomic_state *state);
 284         void (*update_wm)(struct intel_crtc *crtc);
 285         int (*modeset_calc_cdclk)(struct intel_cdclk_state *state);
 286         u8 (*calc_voltage_level)(int cdclk);
 287         /* Returns the active state of the crtc, and if the crtc is active,
 288          * fills out the pipe-config with the hw state. */
 289         bool (*get_pipe_config)(struct intel_crtc *,
 290                                 struct intel_crtc_state *);
 291         void (*get_initial_plane_config)(struct intel_crtc *,
 292                                          struct intel_initial_plane_config *);
 293         int (*crtc_compute_clock)(struct intel_crtc *crtc,
 294                                   struct intel_crtc_state *crtc_state);
 295         void (*crtc_enable)(struct intel_atomic_state *state,
 296                             struct intel_crtc *crtc);
 297         void (*crtc_disable)(struct intel_atomic_state *state,
 298                              struct intel_crtc *crtc);
 299         void (*commit_modeset_enables)(struct intel_atomic_state *state);
 300         void (*commit_modeset_disables)(struct intel_atomic_state *state);
 301         void (*audio_codec_enable)(struct intel_encoder *encoder,
 302                                    const struct intel_crtc_state *crtc_state,
 303                                    const struct drm_connector_state *conn_state);
 304         void (*audio_codec_disable)(struct intel_encoder *encoder,
 305                                     const struct intel_crtc_state *old_crtc_state,
 306                                     const struct drm_connector_state *old_conn_state);
 307         void (*fdi_link_train)(struct intel_crtc *crtc,
 308                                const struct intel_crtc_state *crtc_state);
 309         void (*init_clock_gating)(struct drm_i915_private *dev_priv);
 310         void (*hpd_irq_setup)(struct drm_i915_private *dev_priv);
 311         /* clock updates for mode set */
 312         /* cursor updates */
 313         /* render clock increase/decrease */
 314         /* display clock increase/decrease */
 315         /* pll clock increase/decrease */
 316
 317         int (*color_check)(struct intel_crtc_state *crtc_state);
 318         /*
 319          * Program double buffered color management registers during
 320          * vblank evasion. The registers should then latch during the
 321          * next vblank start, alongside any other double buffered registers
 322          * involved with the same commit.
 323          */
 324         void (*color_commit)(const struct intel_crtc_state *crtc_state);
 325         /*
 326          * Load LUTs (and other single buffered color management
 327          * registers). Will (hopefully) be called during the vblank
 328          * following the latching of any double buffered registers
 329          * involved with the same commit.
 330          */
 331         void (*load_luts)(const struct intel_crtc_state *crtc_state);
 332         void (*read_luts)(struct intel_crtc_state *crtc_state);
 333 };
 334
 335 enum i915_cache_level {
 336         I915_CACHE_NONE = 0,
 337         I915_CACHE_LLC, /* also used for snoopable memory on non-LLC */
 338         I915_CACHE_L3_LLC, /* gen7+, L3 sits between the domain specifc
 339                               caches, eg sampler/render caches, and the
 340                               large Last-Level-Cache. LLC is coherent with
 341                               the CPU, but L3 is only visible to the GPU. */
 342         I915_CACHE_WT, /* hsw:gt3e WriteThrough for scanouts */
 343 };
 344
 345 #define I915_COLOR_UNEVICTABLE (-1) /* a non-vma sharing the address space */
 346
 347 struct intel_fbc {
 348         /* This is always the inner lock when overlapping with struct_mutex and
 349          * it's the outer lock when overlapping with stolen_lock. */
 350         struct mutex lock;
 351         unsigned int possible_framebuffer_bits;
 352         unsigned int busy_bits;
 353         struct intel_crtc *crtc;
 354
 355         struct drm_mm_node compressed_fb;
 356         struct drm_mm_node compressed_llb;
 357
 358         u8 limit;
 359
 360         bool false_color;
 361
 362         bool active;
 363         bool activated;
 364         bool flip_pending;
 365
 366         bool underrun_detected;
 367         struct work_struct underrun_work;
 368
 369         /*
 370          * Due to the atomic rules we can't access some structures without the
 371          * appropriate locking, so we cache information here in order to avoid
 372          * these problems.
 373          */
 374         struct intel_fbc_state_cache {
 375                 struct {
 376                         unsigned int mode_flags;
 377                         u32 hsw_bdw_pixel_rate;
 378                 } crtc;
 379
 380                 struct {
 381                         unsigned int rotation;
 382                         int src_w;
 383                         int src_h;
 384                         bool visible;
 385                         /*
 386                          * Display surface base address adjustement for
 387                          * pageflips. Note that on gen4+ this only adjusts up
 388                          * to a tile, offsets within a tile are handled in
 389                          * the hw itself (with the TILEOFF register).
 390                          */
 391                         int adjusted_x;
 392                         int adjusted_y;
 393
 394                         u16 pixel_blend_mode;
 395                 } plane;
 396
 397                 struct {
 398                         const struct drm_format_info *format;
 399                         unsigned int stride;
 400                         u64 modifier;
 401                 } fb;
 402
 403                 unsigned int fence_y_offset;
 404                 u16 gen9_wa_cfb_stride;
 405                 u16 interval;
 406                 s8 fence_id;
 407                 bool psr2_active;
 408         } state_cache;
 409
 410         /*
 411          * This structure contains everything that's relevant to program the
 412          * hardware registers. When we want to figure out if we need to disable
 413          * and re-enable FBC for a new configuration we just check if there's
 414          * something different in the struct. The genx_fbc_activate functions
 415          * are supposed to read from it in order to program the registers.
 416          */
 417         struct intel_fbc_reg_params {
 418                 struct {
 419                         enum pipe pipe;
 420                         enum i9xx_plane_id i9xx_plane;
 421                 } crtc;
 422
 423                 struct {
 424                         const struct drm_format_info *format;
 425                         unsigned int stride;
 426                         u64 modifier;
 427                 } fb;
 428
 429                 int cfb_size;
 430                 unsigned int fence_y_offset;
 431                 u16 gen9_wa_cfb_stride;
 432                 u16 interval;
 433                 s8 fence_id;
 434                 bool plane_visible;
 435         } params;
 436
 437         const char *no_fbc_reason;
 438 };
 439
 440 /*
 441  * HIGH_RR is the highest eDP panel refresh rate read from EDID
 442  * LOW_RR is the lowest eDP panel refresh rate found from EDID
 443  * parsing for same resolution.
 444  */
 445 enum drrs_refresh_rate_type {
 446         DRRS_HIGH_RR,
 447         DRRS_LOW_RR,
 448         DRRS_MAX_RR, /* RR count */
 449 };
 450
 451 enum drrs_support_type {
 452         DRRS_NOT_SUPPORTED = 0,
 453         STATIC_DRRS_SUPPORT = 1,
 454         SEAMLESS_DRRS_SUPPORT = 2
 455 };
 456
 457 struct intel_dp;
 458 struct i915_drrs {
 459         struct mutex mutex;
 460         struct delayed_work work;
 461         struct intel_dp *dp;
 462         unsigned busy_frontbuffer_bits;
 463         enum drrs_refresh_rate_type refresh_rate_type;
 464         enum drrs_support_type type;
 465 };
 466
 467 #define QUIRK_LVDS_SSC_DISABLE (1<<1)
 468 #define QUIRK_INVERT_BRIGHTNESS (1<<2)
 469 #define QUIRK_BACKLIGHT_PRESENT (1<<3)
 470 #define QUIRK_PIN_SWIZZLED_PAGES (1<<5)
 471 #define QUIRK_INCREASE_T12_DELAY (1<<6)
 472 #define QUIRK_INCREASE_DDI_DISABLED_TIME (1<<7)
 473 #define QUIRK_NO_PPS_BACKLIGHT_POWER_HOOK (1<<8)
 474
 475 struct intel_fbdev;
 476 struct intel_fbc_work;
 477
 478 struct intel_gmbus {
 479         struct i2c_adapter adapter;
 480 #define GMBUS_FORCE_BIT_RETRY (1U << 31)
 481         u32 force_bit;
 482         u32 reg0;
 483         i915_reg_t gpio_reg;
 484         struct i2c_algo_bit_data bit_algo;
 485         struct drm_i915_private *dev_priv;
 486 };
 487
 488 struct i915_suspend_saved_registers {
 489         u32 saveDSPARB;
 490         u32 saveSWF0[16];
 491         u32 saveSWF1[16];
 492         u32 saveSWF3[3];
 493         u16 saveGCDGMBUS;
 494 };
 495
 496 struct vlv_s0ix_state;
 497
 498 #define MAX_L3_SLICES 2
 499 struct intel_l3_parity {
 500         u32 *remap_info[MAX_L3_SLICES];
 501         struct work_struct error_work;
 502         int which_slice;
 503 };
 504
 505 struct i915_gem_mm {
 506         /*
 507          * Shortcut for the stolen region. This points to either
 508          * INTEL_REGION_STOLEN_SMEM for integrated platforms, or
 509          * INTEL_REGION_STOLEN_LMEM for discrete, or NULL if the device doesn't
 510          * support stolen.
 511          */
 512         struct intel_memory_region *stolen_region;
 513         /** Memory allocator for GTT stolen memory */
 514         struct drm_mm stolen;
 515         /** Protects the usage of the GTT stolen memory allocator. This is
 516          * always the inner lock when overlapping with struct_mutex. */
 517         struct mutex stolen_lock;
 518
 519         /* Protects bound_list/unbound_list and #drm_i915_gem_object.mm.link */
 520         spinlock_t obj_lock;
 521
 522         /**
 523          * List of objects which are purgeable.
 524          */
 525         struct list_head purge_list;
 526
 527         /**
 528          * List of objects which have allocated pages and are shrinkable.
 529          */
 530         struct list_head shrink_list;
 531
 532         /**
 533          * List of objects which are pending destruction.
 534          */
 535         struct llist_head free_list;
 536         struct work_struct free_work;
 537         /**
 538          * Count of objects pending destructions. Used to skip needlessly
 539          * waiting on an RCU barrier if no objects are waiting to be freed.
 540          */
 541         atomic_t free_count;
 542
 543         /**
 544          * tmpfs instance used for shmem backed objects
 545          */
 546         struct vfsmount *gemfs;
 547
 548         struct intel_memory_region *regions[INTEL_REGION_UNKNOWN];
 549
 550         struct notifier_block oom_notifier;
 551         struct notifier_block vmap_notifier;
 552         struct shrinker shrinker;
 553
 554 #ifdef CONFIG_MMU_NOTIFIER
 555         /**
 556          * notifier_lock for mmu notifiers, memory may not be allocated
 557          * while holding this lock.
 558          */
 559         spinlock_t notifier_lock;
 560 #endif
 561
 562         /* shrinker accounting, also useful for userland debugging */
 563         u64 shrink_memory;
 564         u32 shrink_count;
 565 };
 566
 567 #define I915_IDLE_ENGINES_TIMEOUT (200) /* in ms */
 568
 569 unsigned long i915_fence_context_timeout(const struct drm_i915_private *i915,
 570                                          u64 context);
 571
 572 static inline unsigned long
 573 i915_fence_timeout(const struct drm_i915_private *i915)
 574 {
 575         return i915_fence_context_timeout(i915, U64_MAX);
 576 }
 577
 578 /* Amount of SAGV/QGV points, BSpec precisely defines this */
 579 #define I915_NUM_QGV_POINTS 8
 580
 581 #define HAS_HW_SAGV_WM(i915) (DISPLAY_VER(i915) >= 13 && !IS_DGFX(i915))
 582
 583 struct ddi_vbt_port_info {
 584         /* Non-NULL if port present. */
 585         struct intel_bios_encoder_data *devdata;
 586
 587         int max_tmds_clock;
 588
 589         /* This is an index in the HDMI/DVI DDI buffer translation table. */
 590         u8 hdmi_level_shift;
 591         u8 hdmi_level_shift_set:1;
 592
 593         u8 alternate_aux_channel;
 594         u8 alternate_ddc_pin;
 595
 596         int dp_max_link_rate;           /* 0 for not limited by VBT */
 597 };
 598
 599 enum psr_lines_to_wait {
 600         PSR_0_LINES_TO_WAIT = 0,
 601         PSR_1_LINE_TO_WAIT,
 602         PSR_4_LINES_TO_WAIT,
 603         PSR_8_LINES_TO_WAIT
 604 };
 605
 606 struct intel_vbt_data {
 607         /* bdb version */
 608         u16 version;
 609
 610         struct drm_display_mode *lfp_lvds_vbt_mode; /* if any */
 611         struct drm_display_mode *sdvo_lvds_vbt_mode; /* if any */
 612
 613         /* Feature bits */
 614         unsigned int int_tv_support:1;
 615         unsigned int lvds_dither:1;
 616         unsigned int int_crt_support:1;
 617         unsigned int lvds_use_ssc:1;
 618         unsigned int int_lvds_support:1;
 619         unsigned int display_clock_mode:1;
 620         unsigned int fdi_rx_polarity_inverted:1;
 621         unsigned int panel_type:4;
 622         int lvds_ssc_freq;
 623         unsigned int bios_lvds_val; /* initial [PCH_]LVDS reg val in VBIOS */
 624         enum drm_panel_orientation orientation;
 625
 626         enum drrs_support_type drrs_type;
 627
 628         struct {
 629                 int rate;
 630                 int lanes;
 631                 int preemphasis;
 632                 int vswing;
 633                 bool low_vswing;
 634                 bool initialized;
 635                 int bpp;
 636                 struct edp_power_seq pps;
 637                 bool hobl;
 638         } edp;
 639
 640         struct {
 641                 bool enable;
 642                 bool full_link;
 643                 bool require_aux_wakeup;
 644                 int idle_frames;
 645                 enum psr_lines_to_wait lines_to_wait;
 646                 int tp1_wakeup_time_us;
 647                 int tp2_tp3_wakeup_time_us;
 648                 int psr2_tp2_tp3_wakeup_time_us;
 649         } psr;
 650
 651         struct {
 652                 u16 pwm_freq_hz;
 653                 bool present;
 654                 bool active_low_pwm;
 655                 u8 min_brightness;      /* min_brightness/255 of max */
 656                 u8 controller;          /* brightness controller number */
 657                 enum intel_backlight_type type;
 658         } backlight;
 659
 660         /* MIPI DSI */
 661         struct {
 662                 u16 panel_id;
 663                 struct mipi_config *config;
 664                 struct mipi_pps_data *pps;
 665                 u16 bl_ports;
 666                 u16 cabc_ports;
 667                 u8 seq_version;
 668                 u32 size;
 669                 u8 *data;
 670                 const u8 *sequence[MIPI_SEQ_MAX];
 671                 u8 *deassert_seq; /* Used by fixup_mipi_sequences() */
 672                 enum drm_panel_orientation orientation;
 673         } dsi;
 674
 675         int crt_ddc_pin;
 676
 677         struct list_head display_devices;
 678
 679         struct ddi_vbt_port_info ddi_port_info[I915_MAX_PORTS];
 680         struct sdvo_device_mapping sdvo_mappings[2];
 681 };
 682
 683 enum intel_ddb_partitioning {
 684         INTEL_DDB_PART_1_2,
 685         INTEL_DDB_PART_5_6, /* IVB+ */
 686 };
 687
 688 struct ilk_wm_values {
 689         u32 wm_pipe[3];
 690         u32 wm_lp[3];
 691         u32 wm_lp_spr[3];
 692         bool enable_fbc_wm;
 693         enum intel_ddb_partitioning partitioning;
 694 };
 695
 696 struct g4x_pipe_wm {
 697         u16 plane[I915_MAX_PLANES];
 698         u16 fbc;
 699 };
 700
 701 struct g4x_sr_wm {
 702         u16 plane;
 703         u16 cursor;
 704         u16 fbc;
 705 };
 706
 707 struct vlv_wm_ddl_values {
 708         u8 plane[I915_MAX_PLANES];
 709 };
 710
 711 struct vlv_wm_values {
 712         struct g4x_pipe_wm pipe[3];
 713         struct g4x_sr_wm sr;
 714         struct vlv_wm_ddl_values ddl[3];
 715         u8 level;
 716         bool cxsr;
 717 };
 718
 719 struct g4x_wm_values {
 720         struct g4x_pipe_wm pipe[2];
 721         struct g4x_sr_wm sr;
 722         struct g4x_sr_wm hpll;
 723         bool cxsr;
 724         bool hpll_en;
 725         bool fbc_en;
 726 };
 727
 728 struct skl_ddb_entry {
 729         u16 start, end; /* in number of blocks, 'end' is exclusive */
 730 };
 731
 732 static inline u16 skl_ddb_entry_size(const struct skl_ddb_entry *entry)
 733 {
 734         return entry->end - entry->start;
 735 }
 736
 737 static inline bool skl_ddb_entry_equal(const struct skl_ddb_entry *e1,
 738                                        const struct skl_ddb_entry *e2)
 739 {
 740         if (e1->start == e2->start && e1->end == e2->end)
 741                 return true;
 742
 743         return false;
 744 }
 745
 746 struct i915_frontbuffer_tracking {
 747         spinlock_t lock;
 748
 749         /*
 750          * Tracking bits for delayed frontbuffer flushing du to gpu activity or
 751          * scheduled flips.
 752          */
 753         unsigned busy_bits;
 754         unsigned flip_bits;
 755 };
 756
 757 struct i915_virtual_gpu {
 758         struct mutex lock; /* serialises sending of g2v_notify command pkts */
 759         bool active;
 760         u32 caps;
 761 };
 762
 763 struct intel_cdclk_config {
 764         unsigned int cdclk, vco, ref, bypass;
 765         u8 voltage_level;
 766 };
 767
 768 struct i915_selftest_stash {
 769         atomic_t counter;
 770         struct ida mock_region_instances;
 771 };
 772
 773 struct drm_i915_private {
 774         struct drm_device drm;
 775
 776         /* FIXME: Device release actions should all be moved to drmm_ */
 777         bool do_release;
 778
 779         /* i915 device parameters */
 780         struct i915_params params;
 781
 782         const struct intel_device_info __info; /* Use INTEL_INFO() to access. */
 783         struct intel_runtime_info __runtime; /* Use RUNTIME_INFO() to access. */
 784         struct intel_driver_caps caps;
 785
 786         /**
 787          * Data Stolen Memory - aka "i915 stolen memory" gives us the start and
 788          * end of stolen which we can optionally use to create GEM objects
 789          * backed by stolen memory. Note that stolen_usable_size tells us
 790          * exactly how much of this we are actually allowed to use, given that
 791          * some portion of it is in fact reserved for use by hardware functions.
 792          */
 793         struct resource dsm;
 794         /**
 795          * Reseved portion of Data Stolen Memory
 796          */
 797         struct resource dsm_reserved;
 798
 799         /*
 800          * Stolen memory is segmented in hardware with different portions
 801          * offlimits to certain functions.
 802          *
 803          * The drm_mm is initialised to the total accessible range, as found
 804          * from the PCI config. On Broadwell+, this is further restricted to
 805          * avoid the first page! The upper end of stolen memory is reserved for
 806          * hardware functions and similarly removed from the accessible range.
 807          */
 808         resource_size_t stolen_usable_size;     /* Total size minus reserved ranges */
 809
 810         struct intel_uncore uncore;
 811         struct intel_uncore_mmio_debug mmio_debug;
 812
 813         struct i915_virtual_gpu vgpu;
 814
 815         struct intel_gvt *gvt;
 816
 817         struct intel_wopcm wopcm;
 818
 819         struct intel_dmc dmc;
 820
 821         struct intel_gmbus gmbus[GMBUS_NUM_PINS];
 822
 823         /** gmbus_mutex protects against concurrent usage of the single hw gmbus
 824          * controller on different i2c buses. */
 825         struct mutex gmbus_mutex;
 826
 827         /**
 828          * Base address of where the gmbus and gpio blocks are located (either
 829          * on PCH or on SoC for platforms without PCH).
 830          */
 831         u32 gpio_mmio_base;
 832
 833         u32 hsw_psr_mmio_adjust;
 834
 835         /* MMIO base address for MIPI regs */
 836         u32 mipi_mmio_base;
 837
 838         u32 pps_mmio_base;
 839
 840         wait_queue_head_t gmbus_wait_queue;
 841
 842         struct pci_dev *bridge_dev;
 843
 844         struct rb_root uabi_engines;
 845
 846         struct resource mch_res;
 847
 848         /* protects the irq masks */
 849         spinlock_t irq_lock;
 850
 851         bool display_irqs_enabled;
 852
 853         /* Sideband mailbox protection */
 854         struct mutex sb_lock;
 855         struct pm_qos_request sb_qos;
 856
 857         /** Cached value of IMR to avoid reads in updating the bitfield */
 858         union {
 859                 u32 irq_mask;
 860                 u32 de_irq_mask[I915_MAX_PIPES];
 861         };
 862         u32 pipestat_irq_mask[I915_MAX_PIPES];
 863
 864         struct i915_hotplug hotplug;
 865         struct intel_fbc fbc;
 866         struct i915_drrs drrs;
 867         struct intel_opregion opregion;
 868         struct intel_vbt_data vbt;
 869
 870         bool preserve_bios_swizzle;
 871
 872         /* overlay */
 873         struct intel_overlay *overlay;
 874
 875         /* backlight registers and fields in struct intel_panel */
 876         struct mutex backlight_lock;
 877
 878         /* protects panel power sequencer state */
 879         struct mutex pps_mutex;
 880
 881         unsigned int fsb_freq, mem_freq, is_ddr3;
 882         unsigned int skl_preferred_vco_freq;
 883         unsigned int max_cdclk_freq;
 884
 885         unsigned int max_dotclk_freq;
 886         unsigned int hpll_freq;
 887         unsigned int fdi_pll_freq;
 888         unsigned int czclk_freq;
 889
 890         struct {
 891                 /* The current hardware cdclk configuration */
 892                 struct intel_cdclk_config hw;
 893
 894                 /* cdclk, divider, and ratio table from bspec */
 895                 const struct intel_cdclk_vals *table;
 896
 897                 struct intel_global_obj obj;
 898         } cdclk;
 899
 900         struct {
 901                 /* The current hardware dbuf configuration */
 902                 u8 enabled_slices;
 903
 904                 struct intel_global_obj obj;
 905         } dbuf;
 906
 907         /**
 908          * wq - Driver workqueue for GEM.
 909          *
 910          * NOTE: Work items scheduled here are not allowed to grab any modeset
 911          * locks, for otherwise the flushing done in the pageflip code will
 912          * result in deadlocks.
 913          */
 914         struct workqueue_struct *wq;
 915
 916         /* ordered wq for modesets */
 917         struct workqueue_struct *modeset_wq;
 918         /* unbound hipri wq for page flips/plane updates */
 919         struct workqueue_struct *flip_wq;
 920
 921         /* Display functions */
 922         struct drm_i915_display_funcs display;
 923
 924         /* PCH chipset type */
 925         enum intel_pch pch_type;
 926         unsigned short pch_id;
 927
 928         unsigned long quirks;
 929
 930         struct drm_atomic_state *modeset_restore_state;
 931         struct drm_modeset_acquire_ctx reset_ctx;
 932
 933         struct i915_ggtt ggtt; /* VM representing the global address space */
 934
 935         struct i915_gem_mm mm;
 936
 937         /* Kernel Modesetting */
 938
 939         struct intel_crtc *plane_to_crtc_mapping[I915_MAX_PIPES];
 940         struct intel_crtc *pipe_to_crtc_mapping[I915_MAX_PIPES];
 941
 942         /**
 943          * dpll and cdclk state is protected by connection_mutex
 944          * dpll.lock serializes intel_{prepare,enable,disable}_shared_dpll.
 945          * Must be global rather than per dpll, because on some platforms plls
 946          * share registers.
 947          */
 948         struct {
 949                 struct mutex lock;
 950
 951                 int num_shared_dpll;
 952                 struct intel_shared_dpll shared_dplls[I915_NUM_PLLS];
 953                 const struct intel_dpll_mgr *mgr;
 954
 955                 struct {
 956                         int nssc;
 957                         int ssc;
 958                 } ref_clks;
 959         } dpll;
 960
 961         struct list_head global_obj_list;
 962
 963         /*
 964          * For reading active_pipes holding any crtc lock is
 965          * sufficient, for writing must hold all of them.
 966          */
 967         u8 active_pipes;
 968
 969         struct i915_wa_list gt_wa_list;
 970
 971         struct i915_frontbuffer_tracking fb_tracking;
 972
 973         struct intel_atomic_helper {
 974                 struct llist_head free_list;
 975                 struct work_struct free_work;
 976         } atomic_helper;
 977
 978         bool mchbar_need_disable;
 979
 980         struct intel_l3_parity l3_parity;
 981
 982         /*
 983          * HTI (aka HDPORT) state read during initial hw readout.  Most
 984          * platforms don't have HTI, so this will just stay 0.  Those that do
 985          * will use this later to figure out which PLLs and PHYs are unavailable
 986          * for driver usage.
 987          */
 988         u32 hti_state;
 989
 990         /*
 991          * edram size in MB.
 992          * Cannot be determined by PCIID. You must always read a register.
 993          */
 994         u32 edram_size_mb;
 995
 996         struct i915_power_domains power_domains;
 997
 998         struct i915_gpu_error gpu_error;
 999
1000         struct drm_i915_gem_object *vlv_pctx;
1001
1002         /* list of fbdev register on this device */
1003         struct intel_fbdev *fbdev;
1004         struct work_struct fbdev_suspend_work;
1005
1006         struct drm_property *broadcast_rgb_property;
1007         struct drm_property *force_audio_property;
1008
1009         /* hda/i915 audio component */
1010         struct i915_audio_component *audio_component;
1011         bool audio_component_registered;
1012         /**
1013          * av_mutex - mutex for audio/video sync
1014          *
1015          */
1016         struct mutex av_mutex;
1017         int audio_power_refcount;
1018         u32 audio_freq_cntrl;
1019
1020         u32 fdi_rx_config;
1021
1022         /* Shadow for DISPLAY_PHY_CONTROL which can't be safely read */
1023         u32 chv_phy_control;
1024         /*
1025          * Shadows for CHV DPLL_MD regs to keep the state
1026          * checker somewhat working in the presence hardware
1027          * crappiness (can't read out DPLL_MD for pipes B & C).
1028          */
1029         u32 chv_dpll_md[I915_MAX_PIPES];
1030         u32 bxt_phy_grc;
1031
1032         u32 suspend_count;
1033         bool power_domains_suspended;
1034         struct i915_suspend_saved_registers regfile;
1035         struct vlv_s0ix_state *vlv_s0ix_state;
1036
1037         enum {
1038                 I915_SAGV_UNKNOWN = 0,
1039                 I915_SAGV_DISABLED,
1040                 I915_SAGV_ENABLED,
1041                 I915_SAGV_NOT_CONTROLLED
1042         } sagv_status;
1043
1044         u32 sagv_block_time_us;
1045
1046         struct {
1047                 /*
1048                  * Raw watermark latency values:
1049                  * in 0.1us units for WM0,
1050                  * in 0.5us units for WM1+.
1051                  */
1052                 /* primary */
1053                 u16 pri_latency[5];
1054                 /* sprite */
1055                 u16 spr_latency[5];
1056                 /* cursor */
1057                 u16 cur_latency[5];
1058                 /*
1059                  * Raw watermark memory latency values
1060                  * for SKL for all 8 levels
1061                  * in 1us units.
1062                  */
1063                 u16 skl_latency[8];
1064
1065                 /* current hardware state */
1066                 union {
1067                         struct ilk_wm_values hw;
1068                         struct vlv_wm_values vlv;
1069                         struct g4x_wm_values g4x;
1070                 };
1071
1072                 u8 max_level;
1073
1074                 /*
1075                  * Should be held around atomic WM register writing; also
1076                  * protects * intel_crtc->wm.active and
1077                  * crtc_state->wm.need_postvbl_update.
1078                  */
1079                 struct mutex wm_mutex;
1080         } wm;
1081
1082         struct dram_info {
1083                 bool wm_lv_0_adjust_needed;
1084                 u8 num_channels;
1085                 bool symmetric_memory;
1086                 enum intel_dram_type {
1087                         INTEL_DRAM_UNKNOWN,
1088                         INTEL_DRAM_DDR3,
1089                         INTEL_DRAM_DDR4,
1090                         INTEL_DRAM_LPDDR3,
1091                         INTEL_DRAM_LPDDR4,
1092                         INTEL_DRAM_DDR5,
1093                         INTEL_DRAM_LPDDR5,
1094                 } type;
1095                 u8 num_qgv_points;
1096         } dram_info;
1097
1098         struct intel_bw_info {
1099                 /* for each QGV point */
1100                 unsigned int deratedbw[I915_NUM_QGV_POINTS];
1101                 u8 num_qgv_points;
1102                 u8 num_planes;
1103         } max_bw[6];
1104
1105         struct intel_global_obj bw_obj;
1106
1107         struct intel_runtime_pm runtime_pm;
1108
1109         struct i915_perf perf;
1110
1111         /* Abstract the submission mechanism (legacy ringbuffer or execlists) away */
1112         struct intel_gt gt;
1113
1114         struct {
1115                 struct i915_gem_contexts {
1116                         spinlock_t lock; /* locks list */
1117                         struct list_head list;
1118                 } contexts;
1119
1120                 /*
1121                  * We replace the local file with a global mappings as the
1122                  * backing storage for the mmap is on the device and not
1123                  * on the struct file, and we do not want to prolong the
1124                  * lifetime of the local fd. To minimise the number of
1125                  * anonymous inodes we create, we use a global singleton to
1126                  * share the global mapping.
1127                  */
1128                 struct file *mmap_singleton;
1129         } gem;
1130
1131         u8 framestart_delay;
1132
1133         /* Window2 specifies time required to program DSB (Window2) in number of scan lines */
1134         u8 window2_delay;
1135
1136         u8 pch_ssc_use;
1137
1138         /* For i915gm/i945gm vblank irq workaround */
1139         u8 vblank_enabled;
1140
1141         bool irq_enabled;
1142
1143         /* perform PHY state sanity checks? */
1144         bool chv_phy_assert[2];
1145
1146         bool ipc_enabled;
1147
1148         /* Used to save the pipe-to-encoder mapping for audio */
1149         struct intel_encoder *av_enc_map[I915_MAX_PIPES];
1150
1151         /* necessary resource sharing with HDMI LPE audio driver. */
1152         struct {
1153                 struct platform_device *platdev;
1154                 int     irq;
1155         } lpe_audio;
1156
1157         struct i915_pmu pmu;
1158
1159         struct i915_hdcp_comp_master *hdcp_master;
1160         bool hdcp_comp_added;
1161
1162         /* Mutex to protect the above hdcp component related values. */
1163         struct mutex hdcp_comp_mutex;
1164
1165         /* The TTM device structure. */
1166         struct ttm_device bdev;
1167
1168         I915_SELFTEST_DECLARE(struct i915_selftest_stash selftest;)
1169
1170         /*
1171          * NOTE: This is the dri1/ums dungeon, don't add stuff here. Your patch
1172          * will be rejected. Instead look for a better place.
1173          */
1174 };
1175
1176 static inline struct drm_i915_private *to_i915(const struct drm_device *dev)
1177 {
1178         return container_of(dev, struct drm_i915_private, drm);
1179 }
1180
1181 static inline struct drm_i915_private *kdev_to_i915(struct device *kdev)
1182 {
1183         return dev_get_drvdata(kdev);
1184 }
1185
1186 static inline struct drm_i915_private *pdev_to_i915(struct pci_dev *pdev)
1187 {
1188         return pci_get_drvdata(pdev);
1189 }
1190
1191 /* Simple iterator over all initialised engines */
1192 #define for_each_engine(engine__, dev_priv__, id__) \
1193         for ((id__) = 0; \
1194              (id__) < I915_NUM_ENGINES; \
1195              (id__)++) \
1196                 for_each_if ((engine__) = (dev_priv__)->engine[(id__)])
1197
1198 /* Iterator over subset of engines selected by mask */
1199 #define for_each_engine_masked(engine__, gt__, mask__, tmp__) \
1200         for ((tmp__) = (mask__) & (gt__)->info.engine_mask; \
1201              (tmp__) ? \
1202              ((engine__) = (gt__)->engine[__mask_next_bit(tmp__)]), 1 : \
1203              0;)
1204
1205 #define rb_to_uabi_engine(rb) \
1206         rb_entry_safe(rb, struct intel_engine_cs, uabi_node)
1207
1208 #define for_each_uabi_engine(engine__, i915__) \
1209         for ((engine__) = rb_to_uabi_engine(rb_first(&(i915__)->uabi_engines));\
1210              (engine__); \
1211              (engine__) = rb_to_uabi_engine(rb_next(&(engine__)->uabi_node)))
1212
1213 #define for_each_uabi_class_engine(engine__, class__, i915__) \
1214         for ((engine__) = intel_engine_lookup_user((i915__), (class__), 0); \
1215              (engine__) && (engine__)->uabi_class == (class__); \
1216              (engine__) = rb_to_uabi_engine(rb_next(&(engine__)->uabi_node)))
1217
1218 #define I915_GTT_OFFSET_NONE ((u32)-1)
1219
1220 /*
1221  * Frontbuffer tracking bits. Set in obj->frontbuffer_bits while a gem bo is
1222  * considered to be the frontbuffer for the given plane interface-wise. This
1223  * doesn't mean that the hw necessarily already scans it out, but that any
1224  * rendering (by the cpu or gpu) will land in the frontbuffer eventually.
1225  *
1226  * We have one bit per pipe and per scanout plane type.
1227  */
1228 #define INTEL_FRONTBUFFER_BITS_PER_PIPE 8
1229 #define INTEL_FRONTBUFFER(pipe, plane_id) ({ \
1230         BUILD_BUG_ON(INTEL_FRONTBUFFER_BITS_PER_PIPE * I915_MAX_PIPES > 32); \
1231         BUILD_BUG_ON(I915_MAX_PLANES > INTEL_FRONTBUFFER_BITS_PER_PIPE); \
1232         BIT((plane_id) + INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe)); \
1233 })
1234 #define INTEL_FRONTBUFFER_OVERLAY(pipe) \
1235         BIT(INTEL_FRONTBUFFER_BITS_PER_PIPE - 1 + INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))
1236 #define INTEL_FRONTBUFFER_ALL_MASK(pipe) \
1237         GENMASK(INTEL_FRONTBUFFER_BITS_PER_PIPE * ((pipe) + 1) - 1, \
1238                 INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))
1239
1240 #define INTEL_INFO(dev_priv)    (&(dev_priv)->__info)
1241 #define RUNTIME_INFO(dev_priv)  (&(dev_priv)->__runtime)
1242 #define DRIVER_CAPS(dev_priv)   (&(dev_priv)->caps)
1243
1244 #define INTEL_DEVID(dev_priv)   (RUNTIME_INFO(dev_priv)->device_id)
1245
1246 #define GRAPHICS_VER(i915)              (INTEL_INFO(i915)->graphics_ver)
1247 #define IS_GRAPHICS_VER(i915, from, until) \
1248         (GRAPHICS_VER(i915) >= (from) && GRAPHICS_VER(i915) <= (until))
1249
1250 #define MEDIA_VER(i915)                 (INTEL_INFO(i915)->media_ver)
1251 #define IS_MEDIA_VER(i915, from, until) \
1252         (MEDIA_VER(i915) >= (from) && MEDIA_VER(i915) <= (until))
1253
1254 #define DISPLAY_VER(i915)       (INTEL_INFO(i915)->display.ver)
1255 #define IS_DISPLAY_VER(i915, from, until) \
1256         (DISPLAY_VER(i915) >= (from) && DISPLAY_VER(i915) <= (until))
1257
1258 #define REVID_FOREVER           0xff
1259 #define INTEL_REVID(dev_priv)   (to_pci_dev((dev_priv)->drm.dev)->revision)
1260
1261 #define HAS_DSB(dev_priv)       (INTEL_INFO(dev_priv)->display.has_dsb)
1262
1263 /*
1264  * Return true if revision is in range [since,until] inclusive.
1265  *
1266  * Use 0 for open-ended since, and REVID_FOREVER for open-ended until.
1267  */
1268 #define IS_REVID(p, since, until) \
1269         (INTEL_REVID(p) >= (since) && INTEL_REVID(p) <= (until))
1270
1271 #define INTEL_DISPLAY_STEP(__i915) (RUNTIME_INFO(__i915)->step.display_step)
1272 #define INTEL_GT_STEP(__i915) (RUNTIME_INFO(__i915)->step.gt_step)
1273
1274 #define IS_DISPLAY_STEP(__i915, since, until) \
1275         (drm_WARN_ON(&(__i915)->drm, INTEL_DISPLAY_STEP(__i915) == STEP_NONE), \
1276          INTEL_DISPLAY_STEP(__i915) >= (since) && INTEL_DISPLAY_STEP(__i915) <= (until))
1277
1278 #define IS_GT_STEP(__i915, since, until) \
1279         (drm_WARN_ON(&(__i915)->drm, INTEL_GT_STEP(__i915) == STEP_NONE), \
1280          INTEL_GT_STEP(__i915) >= (since) && INTEL_GT_STEP(__i915) <= (until))
1281
1282 static __always_inline unsigned int
1283 __platform_mask_index(const struct intel_runtime_info *info,
1284                       enum intel_platform p)
1285 {
1286         const unsigned int pbits =
1287                 BITS_PER_TYPE(info->platform_mask[0]) - INTEL_SUBPLATFORM_BITS;
1288
1289         /* Expand the platform_mask array if this fails. */
1290         BUILD_BUG_ON(INTEL_MAX_PLATFORMS >
1291                      pbits * ARRAY_SIZE(info->platform_mask));
1292
1293         return p / pbits;
1294 }
1295
1296 static __always_inline unsigned int
1297 __platform_mask_bit(const struct intel_runtime_info *info,
1298                     enum intel_platform p)
1299 {
1300         const unsigned int pbits =
1301                 BITS_PER_TYPE(info->platform_mask[0]) - INTEL_SUBPLATFORM_BITS;
1302
1303         return p % pbits + INTEL_SUBPLATFORM_BITS;
1304 }
1305
1306 static inline u32
1307 intel_subplatform(const struct intel_runtime_info *info, enum intel_platform p)
1308 {
1309         const unsigned int pi = __platform_mask_index(info, p);
1310
1311         return info->platform_mask[pi] & INTEL_SUBPLATFORM_MASK;
1312 }
1313
1314 static __always_inline bool
1315 IS_PLATFORM(const struct drm_i915_private *i915, enum intel_platform p)
1316 {
1317         const struct intel_runtime_info *info = RUNTIME_INFO(i915);
1318         const unsigned int pi = __platform_mask_index(info, p);
1319         const unsigned int pb = __platform_mask_bit(info, p);
1320
1321         BUILD_BUG_ON(!__builtin_constant_p(p));
1322
1323         return info->platform_mask[pi] & BIT(pb);
1324 }
1325
1326 static __always_inline bool
1327 IS_SUBPLATFORM(const struct drm_i915_private *i915,
1328                enum intel_platform p, unsigned int s)
1329 {
1330         const struct intel_runtime_info *info = RUNTIME_INFO(i915);
1331         const unsigned int pi = __platform_mask_index(info, p);
1332         const unsigned int pb = __platform_mask_bit(info, p);
1333         const unsigned int msb = BITS_PER_TYPE(info->platform_mask[0]) - 1;
1334         const u32 mask = info->platform_mask[pi];
1335
1336         BUILD_BUG_ON(!__builtin_constant_p(p));
1337         BUILD_BUG_ON(!__builtin_constant_p(s));
1338         BUILD_BUG_ON((s) >= INTEL_SUBPLATFORM_BITS);
1339
1340         /* Shift and test on the MSB position so sign flag can be used. */
1341         return ((mask << (msb - pb)) & (mask << (msb - s))) & BIT(msb);
1342 }
1343
1344 #define IS_MOBILE(dev_priv)     (INTEL_INFO(dev_priv)->is_mobile)
1345 #define IS_DGFX(dev_priv)   (INTEL_INFO(dev_priv)->is_dgfx)
1346
1347 #define IS_I830(dev_priv)       IS_PLATFORM(dev_priv, INTEL_I830)
1348 #define IS_I845G(dev_priv)      IS_PLATFORM(dev_priv, INTEL_I845G)
1349 #define IS_I85X(dev_priv)       IS_PLATFORM(dev_priv, INTEL_I85X)
1350 #define IS_I865G(dev_priv)      IS_PLATFORM(dev_priv, INTEL_I865G)
1351 #define IS_I915G(dev_priv)      IS_PLATFORM(dev_priv, INTEL_I915G)
1352 #define IS_I915GM(dev_priv)     IS_PLATFORM(dev_priv, INTEL_I915GM)
1353 #define IS_I945G(dev_priv)      IS_PLATFORM(dev_priv, INTEL_I945G)
1354 #define IS_I945GM(dev_priv)     IS_PLATFORM(dev_priv, INTEL_I945GM)
1355 #define IS_I965G(dev_priv)      IS_PLATFORM(dev_priv, INTEL_I965G)
1356 #define IS_I965GM(dev_priv)     IS_PLATFORM(dev_priv, INTEL_I965GM)
1357 #define IS_G45(dev_priv)        IS_PLATFORM(dev_priv, INTEL_G45)
1358 #define IS_GM45(dev_priv)       IS_PLATFORM(dev_priv, INTEL_GM45)
1359 #define IS_G4X(dev_priv)        (IS_G45(dev_priv) || IS_GM45(dev_priv))
1360 #define IS_PINEVIEW(dev_priv)   IS_PLATFORM(dev_priv, INTEL_PINEVIEW)
1361 #define IS_G33(dev_priv)        IS_PLATFORM(dev_priv, INTEL_G33)
1362 #define IS_IRONLAKE(dev_priv)   IS_PLATFORM(dev_priv, INTEL_IRONLAKE)
1363 #define IS_IRONLAKE_M(dev_priv) \
1364         (IS_PLATFORM(dev_priv, INTEL_IRONLAKE) && IS_MOBILE(dev_priv))
1365 #define IS_SANDYBRIDGE(dev_priv) IS_PLATFORM(dev_priv, INTEL_SANDYBRIDGE)
1366 #define IS_IVYBRIDGE(dev_priv)  IS_PLATFORM(dev_priv, INTEL_IVYBRIDGE)
1367 #define IS_IVB_GT1(dev_priv)    (IS_IVYBRIDGE(dev_priv) && \
1368                                  INTEL_INFO(dev_priv)->gt == 1)
1369 #define IS_VALLEYVIEW(dev_priv) IS_PLATFORM(dev_priv, INTEL_VALLEYVIEW)
1370 #define IS_CHERRYVIEW(dev_priv) IS_PLATFORM(dev_priv, INTEL_CHERRYVIEW)
1371 #define IS_HASWELL(dev_priv)    IS_PLATFORM(dev_priv, INTEL_HASWELL)
1372 #define IS_BROADWELL(dev_priv)  IS_PLATFORM(dev_priv, INTEL_BROADWELL)
1373 #define IS_SKYLAKE(dev_priv)    IS_PLATFORM(dev_priv, INTEL_SKYLAKE)
1374 #define IS_BROXTON(dev_priv)    IS_PLATFORM(dev_priv, INTEL_BROXTON)
1375 #define IS_KABYLAKE(dev_priv)   IS_PLATFORM(dev_priv, INTEL_KABYLAKE)
1376 #define IS_GEMINILAKE(dev_priv) IS_PLATFORM(dev_priv, INTEL_GEMINILAKE)
1377 #define IS_COFFEELAKE(dev_priv) IS_PLATFORM(dev_priv, INTEL_COFFEELAKE)
1378 #define IS_COMETLAKE(dev_priv)  IS_PLATFORM(dev_priv, INTEL_COMETLAKE)
1379 #define IS_CANNONLAKE(dev_priv) IS_PLATFORM(dev_priv, INTEL_CANNONLAKE)
1380 #define IS_ICELAKE(dev_priv)    IS_PLATFORM(dev_priv, INTEL_ICELAKE)
1381 #define IS_JSL_EHL(dev_priv)    (IS_PLATFORM(dev_priv, INTEL_JASPERLAKE) || \
1382                                 IS_PLATFORM(dev_priv, INTEL_ELKHARTLAKE))
1383 #define IS_TIGERLAKE(dev_priv)  IS_PLATFORM(dev_priv, INTEL_TIGERLAKE)
1384 #define IS_ROCKETLAKE(dev_priv) IS_PLATFORM(dev_priv, INTEL_ROCKETLAKE)
1385 #define IS_DG1(dev_priv)        IS_PLATFORM(dev_priv, INTEL_DG1)
1386 #define IS_ALDERLAKE_S(dev_priv) IS_PLATFORM(dev_priv, INTEL_ALDERLAKE_S)
1387 #define IS_ALDERLAKE_P(dev_priv) IS_PLATFORM(dev_priv, INTEL_ALDERLAKE_P)
1388 #define IS_HSW_EARLY_SDV(dev_priv) (IS_HASWELL(dev_priv) && \
1389                                     (INTEL_DEVID(dev_priv) & 0xFF00) == 0x0C00)
1390 #define IS_BDW_ULT(dev_priv) \
1391         IS_SUBPLATFORM(dev_priv, INTEL_BROADWELL, INTEL_SUBPLATFORM_ULT)
1392 #define IS_BDW_ULX(dev_priv) \
1393         IS_SUBPLATFORM(dev_priv, INTEL_BROADWELL, INTEL_SUBPLATFORM_ULX)
1394 #define IS_BDW_GT3(dev_priv)    (IS_BROADWELL(dev_priv) && \
1395                                  INTEL_INFO(dev_priv)->gt == 3)
1396 #define IS_HSW_ULT(dev_priv) \
1397         IS_SUBPLATFORM(dev_priv, INTEL_HASWELL, INTEL_SUBPLATFORM_ULT)
1398 #define IS_HSW_GT3(dev_priv)    (IS_HASWELL(dev_priv) && \
1399                                  INTEL_INFO(dev_priv)->gt == 3)
1400 #define IS_HSW_GT1(dev_priv)    (IS_HASWELL(dev_priv) && \
1401                                  INTEL_INFO(dev_priv)->gt == 1)
1402 /* ULX machines are also considered ULT. */
1403 #define IS_HSW_ULX(dev_priv) \
1404         IS_SUBPLATFORM(dev_priv, INTEL_HASWELL, INTEL_SUBPLATFORM_ULX)
1405 #define IS_SKL_ULT(dev_priv) \
1406         IS_SUBPLATFORM(dev_priv, INTEL_SKYLAKE, INTEL_SUBPLATFORM_ULT)
1407 #define IS_SKL_ULX(dev_priv) \
1408         IS_SUBPLATFORM(dev_priv, INTEL_SKYLAKE, INTEL_SUBPLATFORM_ULX)
1409 #define IS_KBL_ULT(dev_priv) \
1410         IS_SUBPLATFORM(dev_priv, INTEL_KABYLAKE, INTEL_SUBPLATFORM_ULT)
1411 #define IS_KBL_ULX(dev_priv) \
1412         IS_SUBPLATFORM(dev_priv, INTEL_KABYLAKE, INTEL_SUBPLATFORM_ULX)
1413 #define IS_SKL_GT2(dev_priv)    (IS_SKYLAKE(dev_priv) && \
1414                                  INTEL_INFO(dev_priv)->gt == 2)
1415 #define IS_SKL_GT3(dev_priv)    (IS_SKYLAKE(dev_priv) && \
1416                                  INTEL_INFO(dev_priv)->gt == 3)
1417 #define IS_SKL_GT4(dev_priv)    (IS_SKYLAKE(dev_priv) && \
1418                                  INTEL_INFO(dev_priv)->gt == 4)
1419 #define IS_KBL_GT2(dev_priv)    (IS_KABYLAKE(dev_priv) && \
1420                                  INTEL_INFO(dev_priv)->gt == 2)
1421 #define IS_KBL_GT3(dev_priv)    (IS_KABYLAKE(dev_priv) && \
1422                                  INTEL_INFO(dev_priv)->gt == 3)
1423 #define IS_CFL_ULT(dev_priv) \
1424         IS_SUBPLATFORM(dev_priv, INTEL_COFFEELAKE, INTEL_SUBPLATFORM_ULT)
1425 #define IS_CFL_ULX(dev_priv) \
1426         IS_SUBPLATFORM(dev_priv, INTEL_COFFEELAKE, INTEL_SUBPLATFORM_ULX)
1427 #define IS_CFL_GT2(dev_priv)    (IS_COFFEELAKE(dev_priv) && \
1428                                  INTEL_INFO(dev_priv)->gt == 2)
1429 #define IS_CFL_GT3(dev_priv)    (IS_COFFEELAKE(dev_priv) && \
1430                                  INTEL_INFO(dev_priv)->gt == 3)
1431
1432 #define IS_CML_ULT(dev_priv) \
1433         IS_SUBPLATFORM(dev_priv, INTEL_COMETLAKE, INTEL_SUBPLATFORM_ULT)
1434 #define IS_CML_ULX(dev_priv) \
1435         IS_SUBPLATFORM(dev_priv, INTEL_COMETLAKE, INTEL_SUBPLATFORM_ULX)
1436 #define IS_CML_GT2(dev_priv)    (IS_COMETLAKE(dev_priv) && \
1437                                  INTEL_INFO(dev_priv)->gt == 2)
1438
1439 #define IS_CNL_WITH_PORT_F(dev_priv) \
1440         IS_SUBPLATFORM(dev_priv, INTEL_CANNONLAKE, INTEL_SUBPLATFORM_PORTF)
1441 #define IS_ICL_WITH_PORT_F(dev_priv) \
1442         IS_SUBPLATFORM(dev_priv, INTEL_ICELAKE, INTEL_SUBPLATFORM_PORTF)
1443
1444 #define IS_TGL_U(dev_priv) \
1445         IS_SUBPLATFORM(dev_priv, INTEL_TIGERLAKE, INTEL_SUBPLATFORM_ULT)
1446
1447 #define IS_TGL_Y(dev_priv) \
1448         IS_SUBPLATFORM(dev_priv, INTEL_TIGERLAKE, INTEL_SUBPLATFORM_ULX)
1449
1450 #define SKL_REVID_A0            0x0
1451 #define SKL_REVID_B0            0x1
1452 #define SKL_REVID_C0            0x2
1453 #define SKL_REVID_D0            0x3
1454 #define SKL_REVID_E0            0x4
1455 #define SKL_REVID_F0            0x5
1456 #define SKL_REVID_G0            0x6
1457 #define SKL_REVID_H0            0x7
1458
1459 #define IS_SKL_REVID(p, since, until) (IS_SKYLAKE(p) && IS_REVID(p, since, until))
1460
1461 #define BXT_REVID_A0            0x0
1462 #define BXT_REVID_A1            0x1
1463 #define BXT_REVID_B0            0x3
1464 #define BXT_REVID_B_LAST        0x8
1465 #define BXT_REVID_C0            0x9
1466
1467 #define IS_BXT_REVID(dev_priv, since, until) \
1468         (IS_BROXTON(dev_priv) && IS_REVID(dev_priv, since, until))
1469
1470 #define IS_KBL_GT_STEP(dev_priv, since, until) \
1471         (IS_KABYLAKE(dev_priv) && IS_GT_STEP(dev_priv, since, until))
1472 #define IS_KBL_DISPLAY_STEP(dev_priv, since, until) \
1473         (IS_KABYLAKE(dev_priv) && IS_DISPLAY_STEP(dev_priv, since, until))
1474
1475 #define GLK_REVID_A0            0x0
1476 #define GLK_REVID_A1            0x1
1477 #define GLK_REVID_A2            0x2
1478 #define GLK_REVID_B0            0x3
1479
1480 #define IS_GLK_REVID(dev_priv, since, until) \
1481         (IS_GEMINILAKE(dev_priv) && IS_REVID(dev_priv, since, until))
1482
1483 #define CNL_REVID_A0            0x0
1484 #define CNL_REVID_B0            0x1
1485 #define CNL_REVID_C0            0x2
1486
1487 #define IS_CNL_REVID(p, since, until) \
1488         (IS_CANNONLAKE(p) && IS_REVID(p, since, until))
1489
1490 #define ICL_REVID_A0            0x0
1491 #define ICL_REVID_A2            0x1
1492 #define ICL_REVID_B0            0x3
1493 #define ICL_REVID_B2            0x4
1494 #define ICL_REVID_C0            0x5
1495
1496 #define IS_ICL_REVID(p, since, until) \
1497         (IS_ICELAKE(p) && IS_REVID(p, since, until))
1498
1499 #define EHL_REVID_A0            0x0
1500 #define EHL_REVID_B0            0x1
1501
1502 #define IS_JSL_EHL_REVID(p, since, until) \
1503         (IS_JSL_EHL(p) && IS_REVID(p, since, until))
1504
1505 #define IS_TGL_DISPLAY_STEP(__i915, since, until) \
1506         (IS_TIGERLAKE(__i915) && \
1507          IS_DISPLAY_STEP(__i915, since, until))
1508
1509 #define IS_TGL_UY_GT_STEP(__i915, since, until) \
1510         ((IS_TGL_U(__i915) || IS_TGL_Y(__i915)) && \
1511          IS_GT_STEP(__i915, since, until))
1512
1513 #define IS_TGL_GT_STEP(__i915, since, until) \
1514         (IS_TIGERLAKE(__i915) && !(IS_TGL_U(__i915) || IS_TGL_Y(__i915)) && \
1515          IS_GT_STEP(__i915, since, until))
1516
1517 #define RKL_REVID_A0            0x0
1518 #define RKL_REVID_B0            0x1
1519 #define RKL_REVID_C0            0x4
1520
1521 #define IS_RKL_REVID(p, since, until) \
1522         (IS_ROCKETLAKE(p) && IS_REVID(p, since, until))
1523
1524 #define DG1_REVID_A0            0x0
1525 #define DG1_REVID_B0            0x1
1526
1527 #define IS_DG1_REVID(p, since, until) \
1528         (IS_DG1(p) && IS_REVID(p, since, until))
1529
1530 #define IS_ADLS_DISPLAY_STEP(__i915, since, until) \
1531         (IS_ALDERLAKE_S(__i915) && \
1532          IS_DISPLAY_STEP(__i915, since, until))
1533
1534 #define IS_ADLS_GT_STEP(__i915, since, until) \
1535         (IS_ALDERLAKE_S(__i915) && \
1536          IS_GT_STEP(__i915, since, until))
1537
1538 #define IS_ADLP_DISPLAY_STEP(__i915, since, until) \
1539         (IS_ALDERLAKE_P(__i915) && \
1540          IS_DISPLAY_STEP(__i915, since, until))
1541
1542 #define IS_ADLP_GT_STEP(__i915, since, until) \
1543         (IS_ALDERLAKE_P(__i915) && \
1544          IS_GT_STEP(__i915, since, until))
1545
1546 #define IS_LP(dev_priv)         (INTEL_INFO(dev_priv)->is_lp)
1547 #define IS_GEN9_LP(dev_priv)    (GRAPHICS_VER(dev_priv) == 9 && IS_LP(dev_priv))
1548 #define IS_GEN9_BC(dev_priv)    (GRAPHICS_VER(dev_priv) == 9 && !IS_LP(dev_priv))
1549
1550 #define __HAS_ENGINE(engine_mask, id) ((engine_mask) & BIT(id))
1551 #define HAS_ENGINE(gt, id) __HAS_ENGINE((gt)->info.engine_mask, id)
1552
1553 #define ENGINE_INSTANCES_MASK(gt, first, count) ({              \
1554         unsigned int first__ = (first);                                 \
1555         unsigned int count__ = (count);                                 \
1556         ((gt)->info.engine_mask &                                               \
1557          GENMASK(first__ + count__ - 1, first__)) >> first__;           \
1558 })
1559 #define VDBOX_MASK(gt) \
1560         ENGINE_INSTANCES_MASK(gt, VCS0, I915_MAX_VCS)
1561 #define VEBOX_MASK(gt) \
1562         ENGINE_INSTANCES_MASK(gt, VECS0, I915_MAX_VECS)
1563
1564 /*
1565  * The Gen7 cmdparser copies the scanned buffer to the ggtt for execution
1566  * All later gens can run the final buffer from the ppgtt
1567  */
1568 #define CMDPARSER_USES_GGTT(dev_priv) (GRAPHICS_VER(dev_priv) == 7)
1569
1570 #define HAS_LLC(dev_priv)       (INTEL_INFO(dev_priv)->has_llc)
1571 #define HAS_SNOOP(dev_priv)     (INTEL_INFO(dev_priv)->has_snoop)
1572 #define HAS_EDRAM(dev_priv)     ((dev_priv)->edram_size_mb)
1573 #define HAS_SECURE_BATCHES(dev_priv) (GRAPHICS_VER(dev_priv) < 6)
1574 #define HAS_WT(dev_priv)        HAS_EDRAM(dev_priv)
1575
1576 #define HWS_NEEDS_PHYSICAL(dev_priv)    (INTEL_INFO(dev_priv)->hws_needs_physical)
1577
1578 #define HAS_LOGICAL_RING_CONTEXTS(dev_priv) \
1579                 (INTEL_INFO(dev_priv)->has_logical_ring_contexts)
1580 #define HAS_LOGICAL_RING_ELSQ(dev_priv) \
1581                 (INTEL_INFO(dev_priv)->has_logical_ring_elsq)
1582
1583 #define HAS_MASTER_UNIT_IRQ(dev_priv) (INTEL_INFO(dev_priv)->has_master_unit_irq)
1584
1585 #define HAS_EXECLISTS(dev_priv) HAS_LOGICAL_RING_CONTEXTS(dev_priv)
1586
1587 #define INTEL_PPGTT(dev_priv) (INTEL_INFO(dev_priv)->ppgtt_type)
1588 #define HAS_PPGTT(dev_priv) \
1589         (INTEL_PPGTT(dev_priv) != INTEL_PPGTT_NONE)
1590 #define HAS_FULL_PPGTT(dev_priv) \
1591         (INTEL_PPGTT(dev_priv) >= INTEL_PPGTT_FULL)
1592
1593 #define HAS_PAGE_SIZES(dev_priv, sizes) ({ \
1594         GEM_BUG_ON((sizes) == 0); \
1595         ((sizes) & ~INTEL_INFO(dev_priv)->page_sizes) == 0; \
1596 })
1597
1598 #define HAS_OVERLAY(dev_priv)            (INTEL_INFO(dev_priv)->display.has_overlay)
1599 #define OVERLAY_NEEDS_PHYSICAL(dev_priv) \
1600                 (INTEL_INFO(dev_priv)->display.overlay_needs_physical)
1601
1602 /* Early gen2 have a totally busted CS tlb and require pinned batches. */
1603 #define HAS_BROKEN_CS_TLB(dev_priv)     (IS_I830(dev_priv) || IS_I845G(dev_priv))
1604
1605 #define NEEDS_RC6_CTX_CORRUPTION_WA(dev_priv)   \
1606         (IS_BROADWELL(dev_priv) || GRAPHICS_VER(dev_priv) == 9)
1607
1608 /* WaRsDisableCoarsePowerGating:skl,cnl */
1609 #define NEEDS_WaRsDisableCoarsePowerGating(dev_priv)                    \
1610         (IS_CANNONLAKE(dev_priv) ||                                     \
1611          IS_SKL_GT3(dev_priv) ||                                        \
1612          IS_SKL_GT4(dev_priv))
1613
1614 #define HAS_GMBUS_IRQ(dev_priv) (GRAPHICS_VER(dev_priv) >= 4)
1615 #define HAS_GMBUS_BURST_READ(dev_priv) (GRAPHICS_VER(dev_priv) >= 10 || \
1616                                         IS_GEMINILAKE(dev_priv) || \
1617                                         IS_KABYLAKE(dev_priv))
1618
1619 /* With the 945 and later, Y tiling got adjusted so that it was 32 128-byte
1620  * rows, which changed the alignment requirements and fence programming.
1621  */
1622 #define HAS_128_BYTE_Y_TILING(dev_priv) (GRAPHICS_VER(dev_priv) != 2 && \
1623                                          !(IS_I915G(dev_priv) || IS_I915GM(dev_priv)))
1624 #define SUPPORTS_TV(dev_priv)           (INTEL_INFO(dev_priv)->display.supports_tv)
1625 #define I915_HAS_HOTPLUG(dev_priv)      (INTEL_INFO(dev_priv)->display.has_hotplug)
1626
1627 #define HAS_FW_BLC(dev_priv)    (GRAPHICS_VER(dev_priv) > 2)
1628 #define HAS_FBC(dev_priv)       (INTEL_INFO(dev_priv)->display.has_fbc)
1629 #define HAS_CUR_FBC(dev_priv)   (!HAS_GMCH(dev_priv) && GRAPHICS_VER(dev_priv) >= 7)
1630
1631 #define HAS_IPS(dev_priv)       (IS_HSW_ULT(dev_priv) || IS_BROADWELL(dev_priv))
1632
1633 #define HAS_DP_MST(dev_priv)    (INTEL_INFO(dev_priv)->display.has_dp_mst)
1634
1635 #define HAS_DDI(dev_priv)                (INTEL_INFO(dev_priv)->display.has_ddi)
1636 #define HAS_FPGA_DBG_UNCLAIMED(dev_priv) (INTEL_INFO(dev_priv)->display.has_fpga_dbg)
1637 #define HAS_PSR(dev_priv)                (INTEL_INFO(dev_priv)->display.has_psr)
1638 #define HAS_PSR_HW_TRACKING(dev_priv) \
1639         (INTEL_INFO(dev_priv)->display.has_psr_hw_tracking)
1640 #define HAS_PSR2_SEL_FETCH(dev_priv)     (GRAPHICS_VER(dev_priv) >= 12)
1641 #define HAS_TRANSCODER(dev_priv, trans)  ((INTEL_INFO(dev_priv)->cpu_transcoder_mask & BIT(trans)) != 0)
1642
1643 #define HAS_RC6(dev_priv)                (INTEL_INFO(dev_priv)->has_rc6)
1644 #define HAS_RC6p(dev_priv)               (INTEL_INFO(dev_priv)->has_rc6p)
1645 #define HAS_RC6pp(dev_priv)              (false) /* HW was never validated */
1646
1647 #define HAS_RPS(dev_priv)       (INTEL_INFO(dev_priv)->has_rps)
1648
1649 #define HAS_DMC(dev_priv)       (INTEL_INFO(dev_priv)->display.has_dmc)
1650
1651 #define HAS_MSO(i915)           (GRAPHICS_VER(i915) >= 12)
1652
1653 #define HAS_RUNTIME_PM(dev_priv) (INTEL_INFO(dev_priv)->has_runtime_pm)
1654 #define HAS_64BIT_RELOC(dev_priv) (INTEL_INFO(dev_priv)->has_64bit_reloc)
1655
1656 #define HAS_IPC(dev_priv)                (INTEL_INFO(dev_priv)->display.has_ipc)
1657
1658 #define HAS_REGION(i915, i) (INTEL_INFO(i915)->memory_regions & (i))
1659 #define HAS_LMEM(i915) HAS_REGION(i915, REGION_LMEM)
1660
1661 #define HAS_GT_UC(dev_priv)     (INTEL_INFO(dev_priv)->has_gt_uc)
1662
1663 #define HAS_POOLED_EU(dev_priv) (INTEL_INFO(dev_priv)->has_pooled_eu)
1664
1665 #define HAS_GLOBAL_MOCS_REGISTERS(dev_priv)     (INTEL_INFO(dev_priv)->has_global_mocs)
1666
1667
1668 #define HAS_GMCH(dev_priv) (INTEL_INFO(dev_priv)->display.has_gmch)
1669
1670 #define HAS_LSPCON(dev_priv) (IS_GRAPHICS_VER(dev_priv, 9, 10))
1671
1672 /* DPF == dynamic parity feature */
1673 #define HAS_L3_DPF(dev_priv) (INTEL_INFO(dev_priv)->has_l3_dpf)
1674 #define NUM_L3_SLICES(dev_priv) (IS_HSW_GT3(dev_priv) ? \
1675                                  2 : HAS_L3_DPF(dev_priv))
1676
1677 #define GT_FREQUENCY_MULTIPLIER 50
1678 #define GEN9_FREQ_SCALER 3
1679
1680 #define INTEL_NUM_PIPES(dev_priv) (hweight8(INTEL_INFO(dev_priv)->pipe_mask))
1681
1682 #define HAS_DISPLAY(dev_priv) (INTEL_INFO(dev_priv)->pipe_mask != 0)
1683
1684 #define HAS_VRR(i915)   (GRAPHICS_VER(i915) >= 12)
1685
1686 /* Only valid when HAS_DISPLAY() is true */
1687 #define INTEL_DISPLAY_ENABLED(dev_priv) \
1688         (drm_WARN_ON(&(dev_priv)->drm, !HAS_DISPLAY(dev_priv)), !(dev_priv)->params.disable_display)
1689
1690 static inline bool run_as_guest(void)
1691 {
1692         return !hypervisor_is_type(X86_HYPER_NATIVE);
1693 }
1694
1695 #define HAS_D12_PLANE_MINIMIZATION(dev_priv) (IS_ROCKETLAKE(dev_priv) || \
1696                                               IS_ALDERLAKE_S(dev_priv))
1697
1698 static inline bool intel_vtd_active(void)
1699 {
1700 #ifdef CONFIG_INTEL_IOMMU
1701         if (intel_iommu_gfx_mapped)
1702                 return true;
1703 #endif
1704
1705         /* Running as a guest, we assume the host is enforcing VT'd */
1706         return run_as_guest();
1707 }
1708
1709 static inline bool intel_scanout_needs_vtd_wa(struct drm_i915_private *dev_priv)
1710 {
1711         return GRAPHICS_VER(dev_priv) >= 6 && intel_vtd_active();
1712 }
1713
1714 static inline bool
1715 intel_ggtt_update_needs_vtd_wa(struct drm_i915_private *i915)
1716 {
1717         return IS_BROXTON(i915) && intel_vtd_active();
1718 }
1719
1720 static inline bool
1721 intel_vm_no_concurrent_access_wa(struct drm_i915_private *i915)
1722 {
1723         return IS_CHERRYVIEW(i915) || intel_ggtt_update_needs_vtd_wa(i915);
1724 }
1725
1726 /* i915_drv.c */
1727 extern const struct dev_pm_ops i915_pm_ops;
1728
1729 int i915_driver_probe(struct pci_dev *pdev, const struct pci_device_id *ent);
1730 void i915_driver_remove(struct drm_i915_private *i915);
1731 void i915_driver_shutdown(struct drm_i915_private *i915);
1732
1733 int i915_resume_switcheroo(struct drm_i915_private *i915);
1734 int i915_suspend_switcheroo(struct drm_i915_private *i915, pm_message_t state);
1735
1736 int i915_getparam_ioctl(struct drm_device *dev, void *data,
1737                         struct drm_file *file_priv);
1738
1739 /* i915_gem.c */
1740 int i915_gem_init_userptr(struct drm_i915_private *dev_priv);
1741 void i915_gem_cleanup_userptr(struct drm_i915_private *dev_priv);
1742 void i915_gem_init_early(struct drm_i915_private *dev_priv);
1743 void i915_gem_cleanup_early(struct drm_i915_private *dev_priv);
1744
1745 struct intel_memory_region *i915_gem_shmem_setup(struct drm_i915_private *i915,
1746                                                  u16 type, u16 instance);
1747
1748 static inline void i915_gem_drain_freed_objects(struct drm_i915_private *i915)
1749 {
1750         /*
1751          * A single pass should suffice to release all the freed objects (along
1752          * most call paths) , but be a little more paranoid in that freeing
1753          * the objects does take a little amount of time, during which the rcu
1754          * callbacks could have added new objects into the freed list, and
1755          * armed the work again.
1756          */
1757         while (atomic_read(&i915->mm.free_count)) {
1758                 flush_work(&i915->mm.free_work);
1759                 rcu_barrier();
1760         }
1761 }
1762
1763 static inline void i915_gem_drain_workqueue(struct drm_i915_private *i915)
1764 {
1765         /*
1766          * Similar to objects above (see i915_gem_drain_freed-objects), in
1767          * general we have workers that are armed by RCU and then rearm
1768          * themselves in their callbacks. To be paranoid, we need to
1769          * drain the workqueue a second time after waiting for the RCU
1770          * grace period so that we catch work queued via RCU from the first
1771          * pass. As neither drain_workqueue() nor flush_workqueue() report
1772          * a result, we make an assumption that we only don't require more
1773          * than 3 passes to catch all _recursive_ RCU delayed work.
1774          *
1775          */
1776         int pass = 3;
1777         do {
1778                 flush_workqueue(i915->wq);
1779                 rcu_barrier();
1780                 i915_gem_drain_freed_objects(i915);
1781         } while (--pass);
1782         drain_workqueue(i915->wq);
1783 }
1784
1785 struct i915_vma * __must_check
1786 i915_gem_object_ggtt_pin_ww(struct drm_i915_gem_object *obj,
1787                             struct i915_gem_ww_ctx *ww,
1788                             const struct i915_ggtt_view *view,
1789                             u64 size, u64 alignment, u64 flags);
1790
1791 static inline struct i915_vma * __must_check
1792 i915_gem_object_ggtt_pin(struct drm_i915_gem_object *obj,
1793                          const struct i915_ggtt_view *view,
1794                          u64 size, u64 alignment, u64 flags)
1795 {
1796         return i915_gem_object_ggtt_pin_ww(obj, NULL, view, size, alignment, flags);
1797 }
1798
1799 int i915_gem_object_unbind(struct drm_i915_gem_object *obj,
1800                            unsigned long flags);
1801 #define I915_GEM_OBJECT_UNBIND_ACTIVE BIT(0)
1802 #define I915_GEM_OBJECT_UNBIND_BARRIER BIT(1)
1803 #define I915_GEM_OBJECT_UNBIND_TEST BIT(2)
1804 #define I915_GEM_OBJECT_UNBIND_VM_TRYLOCK BIT(3)
1805
1806 void i915_gem_runtime_suspend(struct drm_i915_private *dev_priv);
1807
1808 int i915_gem_dumb_create(struct drm_file *file_priv,
1809                          struct drm_device *dev,
1810                          struct drm_mode_create_dumb *args);
1811
1812 int __must_check i915_gem_set_global_seqno(struct drm_device *dev, u32 seqno);
1813
1814 static inline u32 i915_reset_count(struct i915_gpu_error *error)
1815 {
1816         return atomic_read(&error->reset_count);
1817 }
1818
1819 static inline u32 i915_reset_engine_count(struct i915_gpu_error *error,
1820                                           const struct intel_engine_cs *engine)
1821 {
1822         return atomic_read(&error->reset_engine_count[engine->uabi_class]);
1823 }
1824
1825 int __must_check i915_gem_init(struct drm_i915_private *dev_priv);
1826 void i915_gem_driver_register(struct drm_i915_private *i915);
1827 void i915_gem_driver_unregister(struct drm_i915_private *i915);
1828 void i915_gem_driver_remove(struct drm_i915_private *dev_priv);
1829 void i915_gem_driver_release(struct drm_i915_private *dev_priv);
1830 void i915_gem_suspend(struct drm_i915_private *dev_priv);
1831 void i915_gem_suspend_late(struct drm_i915_private *dev_priv);
1832 void i915_gem_resume(struct drm_i915_private *dev_priv);
1833
1834 int i915_gem_open(struct drm_i915_private *i915, struct drm_file *file);
1835
1836 int i915_gem_object_set_cache_level(struct drm_i915_gem_object *obj,
1837                                     enum i915_cache_level cache_level);
1838
1839 struct drm_gem_object *i915_gem_prime_import(struct drm_device *dev,
1840                                 struct dma_buf *dma_buf);
1841
1842 struct dma_buf *i915_gem_prime_export(struct drm_gem_object *gem_obj, int flags);
1843
1844 static inline struct i915_gem_context *
1845 __i915_gem_context_lookup_rcu(struct drm_i915_file_private *file_priv, u32 id)
1846 {
1847         return xa_load(&file_priv->context_xa, id);
1848 }
1849
1850 static inline struct i915_gem_context *
1851 i915_gem_context_lookup(struct drm_i915_file_private *file_priv, u32 id)
1852 {
1853         struct i915_gem_context *ctx;
1854
1855         rcu_read_lock();
1856         ctx = __i915_gem_context_lookup_rcu(file_priv, id);
1857         if (ctx && !kref_get_unless_zero(&ctx->ref))
1858                 ctx = NULL;
1859         rcu_read_unlock();
1860
1861         return ctx;
1862 }
1863
1864 /* i915_gem_evict.c */
1865 int __must_check i915_gem_evict_something(struct i915_address_space *vm,
1866                                           u64 min_size, u64 alignment,
1867                                           unsigned long color,
1868                                           u64 start, u64 end,
1869                                           unsigned flags);
1870 int __must_check i915_gem_evict_for_node(struct i915_address_space *vm,
1871                                          struct drm_mm_node *node,
1872                                          unsigned int flags);
1873 int i915_gem_evict_vm(struct i915_address_space *vm);
1874
1875 /* i915_gem_internal.c */
1876 struct drm_i915_gem_object *
1877 i915_gem_object_create_internal(struct drm_i915_private *dev_priv,
1878                                 phys_addr_t size);
1879
1880 /* i915_gem_tiling.c */
1881 static inline bool i915_gem_object_needs_bit17_swizzle(struct drm_i915_gem_object *obj)
1882 {
1883         struct drm_i915_private *i915 = to_i915(obj->base.dev);
1884
1885         return i915->ggtt.bit_6_swizzle_x == I915_BIT_6_SWIZZLE_9_10_17 &&
1886                 i915_gem_object_is_tiled(obj);
1887 }
1888
1889 u32 i915_gem_fence_size(struct drm_i915_private *dev_priv, u32 size,
1890                         unsigned int tiling, unsigned int stride);
1891 u32 i915_gem_fence_alignment(struct drm_i915_private *dev_priv, u32 size,
1892                              unsigned int tiling, unsigned int stride);
1893
1894 const char *i915_cache_level_str(struct drm_i915_private *i915, int type);
1895
1896 /* i915_cmd_parser.c */
1897 int i915_cmd_parser_get_version(struct drm_i915_private *dev_priv);
1898 int intel_engine_init_cmd_parser(struct intel_engine_cs *engine);
1899 void intel_engine_cleanup_cmd_parser(struct intel_engine_cs *engine);
1900 unsigned long *intel_engine_cmd_parser_alloc_jump_whitelist(u32 batch_length,
1901                                                             bool trampoline);
1902
1903 int intel_engine_cmd_parser(struct intel_engine_cs *engine,
1904                             struct i915_vma *batch,
1905                             unsigned long batch_offset,
1906                             unsigned long batch_length,
1907                             struct i915_vma *shadow,
1908                             unsigned long *jump_whitelist,
1909                             void *shadow_map,
1910                             const void *batch_map);
1911 #define I915_CMD_PARSER_TRAMPOLINE_SIZE 8
1912
1913 /* intel_device_info.c */
1914 static inline struct intel_device_info *
1915 mkwrite_device_info(struct drm_i915_private *dev_priv)
1916 {
1917         return (struct intel_device_info *)INTEL_INFO(dev_priv);
1918 }
1919
1920 int i915_reg_read_ioctl(struct drm_device *dev, void *data,
1921                         struct drm_file *file);
1922
1923 /* i915_mm.c */
1924 int remap_io_mapping(struct vm_area_struct *vma,
1925                      unsigned long addr, unsigned long pfn, unsigned long size,
1926                      struct io_mapping *iomap);
1927 int remap_io_sg(struct vm_area_struct *vma,
1928                 unsigned long addr, unsigned long size,
1929                 struct scatterlist *sgl, resource_size_t iobase);
1930
1931 static inline int intel_hws_csb_write_index(struct drm_i915_private *i915)
1932 {
1933         if (GRAPHICS_VER(i915) >= 10)
1934                 return CNL_HWS_CSB_WRITE_INDEX;
1935         else
1936                 return I915_HWS_CSB_WRITE_INDEX;
1937 }
1938
1939 static inline enum i915_map_type
1940 i915_coherent_map_type(struct drm_i915_private *i915,
1941                        struct drm_i915_gem_object *obj, bool always_coherent)
1942 {
1943         if (i915_gem_object_is_lmem(obj))
1944                 return I915_MAP_WC;
1945         if (HAS_LLC(i915) || always_coherent)
1946                 return I915_MAP_WB;
1947         else
1948                 return I915_MAP_WC;
1949 }
1950
1951 #endif