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