Back to home page

OSCL-LXR

 
 

    


0001 /* i915_drv.h -- Private header for the I915 driver -*- linux-c -*-
0002  */
0003 /*
0004  *
0005  * Copyright 2003 Tungsten Graphics, Inc., Cedar Park, Texas.
0006  * All Rights Reserved.
0007  *
0008  * Permission is hereby granted, free of charge, to any person obtaining a
0009  * copy of this software and associated documentation files (the
0010  * "Software"), to deal in the Software without restriction, including
0011  * without limitation the rights to use, copy, modify, merge, publish,
0012  * distribute, sub license, and/or sell copies of the Software, and to
0013  * permit persons to whom the Software is furnished to do so, subject to
0014  * the following conditions:
0015  *
0016  * The above copyright notice and this permission notice (including the
0017  * next paragraph) shall be included in all copies or substantial portions
0018  * of the Software.
0019  *
0020  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
0021  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
0022  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
0023  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
0024  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
0025  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
0026  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0027  *
0028  */
0029 
0030 #ifndef _I915_DRV_H_
0031 #define _I915_DRV_H_
0032 
0033 #include <uapi/drm/i915_drm.h>
0034 
0035 #include <linux/pm_qos.h>
0036 
0037 #include <drm/drm_connector.h>
0038 #include <drm/ttm/ttm_device.h>
0039 
0040 #include "display/intel_cdclk.h"
0041 #include "display/intel_display.h"
0042 #include "display/intel_display_power.h"
0043 #include "display/intel_dmc.h"
0044 #include "display/intel_dpll_mgr.h"
0045 #include "display/intel_dsb.h"
0046 #include "display/intel_fbc.h"
0047 #include "display/intel_frontbuffer.h"
0048 #include "display/intel_global_state.h"
0049 #include "display/intel_gmbus.h"
0050 #include "display/intel_opregion.h"
0051 
0052 #include "gem/i915_gem_context_types.h"
0053 #include "gem/i915_gem_lmem.h"
0054 #include "gem/i915_gem_shrinker.h"
0055 #include "gem/i915_gem_stolen.h"
0056 
0057 #include "gt/intel_engine.h"
0058 #include "gt/intel_gt_types.h"
0059 #include "gt/intel_region_lmem.h"
0060 #include "gt/intel_workarounds.h"
0061 #include "gt/uc/intel_uc.h"
0062 
0063 #include "i915_drm_client.h"
0064 #include "i915_gem.h"
0065 #include "i915_gpu_error.h"
0066 #include "i915_params.h"
0067 #include "i915_perf_types.h"
0068 #include "i915_scheduler.h"
0069 #include "i915_utils.h"
0070 #include "intel_device_info.h"
0071 #include "intel_memory_region.h"
0072 #include "intel_pch.h"
0073 #include "intel_pm_types.h"
0074 #include "intel_runtime_pm.h"
0075 #include "intel_step.h"
0076 #include "intel_uncore.h"
0077 #include "intel_wopcm.h"
0078 
0079 struct dpll;
0080 struct drm_i915_clock_gating_funcs;
0081 struct drm_i915_gem_object;
0082 struct drm_i915_private;
0083 struct intel_atomic_state;
0084 struct intel_audio_funcs;
0085 struct intel_cdclk_config;
0086 struct intel_cdclk_funcs;
0087 struct intel_cdclk_state;
0088 struct intel_cdclk_vals;
0089 struct intel_color_funcs;
0090 struct intel_connector;
0091 struct intel_crtc;
0092 struct intel_dp;
0093 struct intel_dpll_funcs;
0094 struct intel_encoder;
0095 struct intel_fbdev;
0096 struct intel_fdi_funcs;
0097 struct intel_gmbus;
0098 struct intel_hotplug_funcs;
0099 struct intel_initial_plane_config;
0100 struct intel_limit;
0101 struct intel_overlay;
0102 struct intel_overlay_error_state;
0103 struct vlv_s0ix_state;
0104 
0105 /* Threshold == 5 for long IRQs, 50 for short */
0106 #define HPD_STORM_DEFAULT_THRESHOLD 50
0107 
0108 struct i915_hotplug {
0109     struct delayed_work hotplug_work;
0110 
0111     const u32 *hpd, *pch_hpd;
0112 
0113     struct {
0114         unsigned long last_jiffies;
0115         int count;
0116         enum {
0117             HPD_ENABLED = 0,
0118             HPD_DISABLED = 1,
0119             HPD_MARK_DISABLED = 2
0120         } state;
0121     } stats[HPD_NUM_PINS];
0122     u32 event_bits;
0123     u32 retry_bits;
0124     struct delayed_work reenable_work;
0125 
0126     u32 long_port_mask;
0127     u32 short_port_mask;
0128     struct work_struct dig_port_work;
0129 
0130     struct work_struct poll_init_work;
0131     bool poll_enabled;
0132 
0133     unsigned int hpd_storm_threshold;
0134     /* Whether or not to count short HPD IRQs in HPD storms */
0135     u8 hpd_short_storm_enabled;
0136 
0137     /*
0138      * if we get a HPD irq from DP and a HPD irq from non-DP
0139      * the non-DP HPD could block the workqueue on a mode config
0140      * mutex getting, that userspace may have taken. However
0141      * userspace is waiting on the DP workqueue to run which is
0142      * blocked behind the non-DP one.
0143      */
0144     struct workqueue_struct *dp_wq;
0145 };
0146 
0147 #define I915_GEM_GPU_DOMAINS \
0148     (I915_GEM_DOMAIN_RENDER | \
0149      I915_GEM_DOMAIN_SAMPLER | \
0150      I915_GEM_DOMAIN_COMMAND | \
0151      I915_GEM_DOMAIN_INSTRUCTION | \
0152      I915_GEM_DOMAIN_VERTEX)
0153 
0154 struct sdvo_device_mapping {
0155     u8 initialized;
0156     u8 dvo_port;
0157     u8 slave_addr;
0158     u8 dvo_wiring;
0159     u8 i2c_pin;
0160     u8 ddc_pin;
0161 };
0162 
0163 /* functions used for watermark calcs for display. */
0164 struct drm_i915_wm_disp_funcs {
0165     /* update_wm is for legacy wm management */
0166     void (*update_wm)(struct drm_i915_private *dev_priv);
0167     int (*compute_pipe_wm)(struct intel_atomic_state *state,
0168                    struct intel_crtc *crtc);
0169     int (*compute_intermediate_wm)(struct intel_atomic_state *state,
0170                        struct intel_crtc *crtc);
0171     void (*initial_watermarks)(struct intel_atomic_state *state,
0172                    struct intel_crtc *crtc);
0173     void (*atomic_update_watermarks)(struct intel_atomic_state *state,
0174                      struct intel_crtc *crtc);
0175     void (*optimize_watermarks)(struct intel_atomic_state *state,
0176                     struct intel_crtc *crtc);
0177     int (*compute_global_watermarks)(struct intel_atomic_state *state);
0178 };
0179 
0180 struct drm_i915_display_funcs {
0181     /* Returns the active state of the crtc, and if the crtc is active,
0182      * fills out the pipe-config with the hw state. */
0183     bool (*get_pipe_config)(struct intel_crtc *,
0184                 struct intel_crtc_state *);
0185     void (*get_initial_plane_config)(struct intel_crtc *,
0186                      struct intel_initial_plane_config *);
0187     void (*crtc_enable)(struct intel_atomic_state *state,
0188                 struct intel_crtc *crtc);
0189     void (*crtc_disable)(struct intel_atomic_state *state,
0190                  struct intel_crtc *crtc);
0191     void (*commit_modeset_enables)(struct intel_atomic_state *state);
0192 };
0193 
0194 #define I915_COLOR_UNEVICTABLE (-1) /* a non-vma sharing the address space */
0195 
0196 #define QUIRK_LVDS_SSC_DISABLE (1<<1)
0197 #define QUIRK_INVERT_BRIGHTNESS (1<<2)
0198 #define QUIRK_BACKLIGHT_PRESENT (1<<3)
0199 #define QUIRK_PIN_SWIZZLED_PAGES (1<<5)
0200 #define QUIRK_INCREASE_T12_DELAY (1<<6)
0201 #define QUIRK_INCREASE_DDI_DISABLED_TIME (1<<7)
0202 #define QUIRK_NO_PPS_BACKLIGHT_POWER_HOOK (1<<8)
0203 
0204 struct i915_suspend_saved_registers {
0205     u32 saveDSPARB;
0206     u32 saveSWF0[16];
0207     u32 saveSWF1[16];
0208     u32 saveSWF3[3];
0209     u16 saveGCDGMBUS;
0210 };
0211 
0212 #define MAX_L3_SLICES 2
0213 struct intel_l3_parity {
0214     u32 *remap_info[MAX_L3_SLICES];
0215     struct work_struct error_work;
0216     int which_slice;
0217 };
0218 
0219 struct i915_gem_mm {
0220     /*
0221      * Shortcut for the stolen region. This points to either
0222      * INTEL_REGION_STOLEN_SMEM for integrated platforms, or
0223      * INTEL_REGION_STOLEN_LMEM for discrete, or NULL if the device doesn't
0224      * support stolen.
0225      */
0226     struct intel_memory_region *stolen_region;
0227     /** Memory allocator for GTT stolen memory */
0228     struct drm_mm stolen;
0229     /** Protects the usage of the GTT stolen memory allocator. This is
0230      * always the inner lock when overlapping with struct_mutex. */
0231     struct mutex stolen_lock;
0232 
0233     /* Protects bound_list/unbound_list and #drm_i915_gem_object.mm.link */
0234     spinlock_t obj_lock;
0235 
0236     /**
0237      * List of objects which are purgeable.
0238      */
0239     struct list_head purge_list;
0240 
0241     /**
0242      * List of objects which have allocated pages and are shrinkable.
0243      */
0244     struct list_head shrink_list;
0245 
0246     /**
0247      * List of objects which are pending destruction.
0248      */
0249     struct llist_head free_list;
0250     struct work_struct free_work;
0251     /**
0252      * Count of objects pending destructions. Used to skip needlessly
0253      * waiting on an RCU barrier if no objects are waiting to be freed.
0254      */
0255     atomic_t free_count;
0256 
0257     /**
0258      * tmpfs instance used for shmem backed objects
0259      */
0260     struct vfsmount *gemfs;
0261 
0262     struct intel_memory_region *regions[INTEL_REGION_UNKNOWN];
0263 
0264     struct notifier_block oom_notifier;
0265     struct notifier_block vmap_notifier;
0266     struct shrinker shrinker;
0267 
0268 #ifdef CONFIG_MMU_NOTIFIER
0269     /**
0270      * notifier_lock for mmu notifiers, memory may not be allocated
0271      * while holding this lock.
0272      */
0273     rwlock_t notifier_lock;
0274 #endif
0275 
0276     /* shrinker accounting, also useful for userland debugging */
0277     u64 shrink_memory;
0278     u32 shrink_count;
0279 };
0280 
0281 #define I915_IDLE_ENGINES_TIMEOUT (200) /* in ms */
0282 
0283 unsigned long i915_fence_context_timeout(const struct drm_i915_private *i915,
0284                      u64 context);
0285 
0286 static inline unsigned long
0287 i915_fence_timeout(const struct drm_i915_private *i915)
0288 {
0289     return i915_fence_context_timeout(i915, U64_MAX);
0290 }
0291 
0292 /* Amount of SAGV/QGV points, BSpec precisely defines this */
0293 #define I915_NUM_QGV_POINTS 8
0294 
0295 #define HAS_HW_SAGV_WM(i915) (DISPLAY_VER(i915) >= 13 && !IS_DGFX(i915))
0296 
0297 /* Amount of PSF GV points, BSpec precisely defines this */
0298 #define I915_NUM_PSF_GV_POINTS 3
0299 
0300 struct intel_vbt_data {
0301     /* bdb version */
0302     u16 version;
0303 
0304     /* Feature bits */
0305     unsigned int int_tv_support:1;
0306     unsigned int int_crt_support:1;
0307     unsigned int lvds_use_ssc:1;
0308     unsigned int int_lvds_support:1;
0309     unsigned int display_clock_mode:1;
0310     unsigned int fdi_rx_polarity_inverted:1;
0311     int lvds_ssc_freq;
0312     enum drm_panel_orientation orientation;
0313 
0314     bool override_afc_startup;
0315     u8 override_afc_startup_val;
0316 
0317     int crt_ddc_pin;
0318 
0319     struct list_head display_devices;
0320     struct list_head bdb_blocks;
0321 
0322     struct intel_bios_encoder_data *ports[I915_MAX_PORTS]; /* Non-NULL if port present. */
0323     struct sdvo_device_mapping sdvo_mappings[2];
0324 };
0325 
0326 struct i915_frontbuffer_tracking {
0327     spinlock_t lock;
0328 
0329     /*
0330      * Tracking bits for delayed frontbuffer flushing du to gpu activity or
0331      * scheduled flips.
0332      */
0333     unsigned busy_bits;
0334     unsigned flip_bits;
0335 };
0336 
0337 struct i915_virtual_gpu {
0338     struct mutex lock; /* serialises sending of g2v_notify command pkts */
0339     bool active;
0340     u32 caps;
0341     u32 *initial_mmio;
0342     u8 *initial_cfg_space;
0343     struct list_head entry;
0344 };
0345 
0346 struct i915_selftest_stash {
0347     atomic_t counter;
0348     struct ida mock_region_instances;
0349 };
0350 
0351 /* intel_audio.c private */
0352 struct intel_audio_private {
0353     /* Display internal audio functions */
0354     const struct intel_audio_funcs *funcs;
0355 
0356     /* hda/i915 audio component */
0357     struct i915_audio_component *component;
0358     bool component_registered;
0359     /* mutex for audio/video sync */
0360     struct mutex mutex;
0361     int power_refcount;
0362     u32 freq_cntrl;
0363 
0364     /* Used to save the pipe-to-encoder mapping for audio */
0365     struct intel_encoder *encoder_map[I915_MAX_PIPES];
0366 
0367     /* necessary resource sharing with HDMI LPE audio driver. */
0368     struct {
0369         struct platform_device *platdev;
0370         int irq;
0371     } lpe;
0372 };
0373 
0374 struct drm_i915_private {
0375     struct drm_device drm;
0376 
0377     /* FIXME: Device release actions should all be moved to drmm_ */
0378     bool do_release;
0379 
0380     /* i915 device parameters */
0381     struct i915_params params;
0382 
0383     const struct intel_device_info __info; /* Use INTEL_INFO() to access. */
0384     struct intel_runtime_info __runtime; /* Use RUNTIME_INFO() to access. */
0385     struct intel_driver_caps caps;
0386 
0387     /**
0388      * Data Stolen Memory - aka "i915 stolen memory" gives us the start and
0389      * end of stolen which we can optionally use to create GEM objects
0390      * backed by stolen memory. Note that stolen_usable_size tells us
0391      * exactly how much of this we are actually allowed to use, given that
0392      * some portion of it is in fact reserved for use by hardware functions.
0393      */
0394     struct resource dsm;
0395     /**
0396      * Reseved portion of Data Stolen Memory
0397      */
0398     struct resource dsm_reserved;
0399 
0400     /*
0401      * Stolen memory is segmented in hardware with different portions
0402      * offlimits to certain functions.
0403      *
0404      * The drm_mm is initialised to the total accessible range, as found
0405      * from the PCI config. On Broadwell+, this is further restricted to
0406      * avoid the first page! The upper end of stolen memory is reserved for
0407      * hardware functions and similarly removed from the accessible range.
0408      */
0409     resource_size_t stolen_usable_size; /* Total size minus reserved ranges */
0410 
0411     struct intel_uncore uncore;
0412     struct intel_uncore_mmio_debug mmio_debug;
0413 
0414     struct i915_virtual_gpu vgpu;
0415 
0416     struct intel_gvt *gvt;
0417 
0418     struct intel_wopcm wopcm;
0419 
0420     struct intel_dmc dmc;
0421 
0422     struct intel_gmbus *gmbus[GMBUS_NUM_PINS];
0423 
0424     /** gmbus_mutex protects against concurrent usage of the single hw gmbus
0425      * controller on different i2c buses. */
0426     struct mutex gmbus_mutex;
0427 
0428     /**
0429      * Base address of where the gmbus and gpio blocks are located (either
0430      * on PCH or on SoC for platforms without PCH).
0431      */
0432     u32 gpio_mmio_base;
0433 
0434     /* MMIO base address for MIPI regs */
0435     u32 mipi_mmio_base;
0436 
0437     u32 pps_mmio_base;
0438 
0439     wait_queue_head_t gmbus_wait_queue;
0440 
0441     struct pci_dev *bridge_dev;
0442 
0443     struct rb_root uabi_engines;
0444     unsigned int engine_uabi_class_count[I915_LAST_UABI_ENGINE_CLASS + 1];
0445 
0446     struct resource mch_res;
0447 
0448     /* protects the irq masks */
0449     spinlock_t irq_lock;
0450 
0451     bool display_irqs_enabled;
0452 
0453     /* Sideband mailbox protection */
0454     struct mutex sb_lock;
0455     struct pm_qos_request sb_qos;
0456 
0457     /** Cached value of IMR to avoid reads in updating the bitfield */
0458     union {
0459         u32 irq_mask;
0460         u32 de_irq_mask[I915_MAX_PIPES];
0461     };
0462     u32 pipestat_irq_mask[I915_MAX_PIPES];
0463 
0464     struct i915_hotplug hotplug;
0465     struct intel_fbc *fbc[I915_MAX_FBCS];
0466     struct intel_opregion opregion;
0467     struct intel_vbt_data vbt;
0468 
0469     bool preserve_bios_swizzle;
0470 
0471     /* overlay */
0472     struct intel_overlay *overlay;
0473 
0474     /* backlight registers and fields in struct intel_panel */
0475     struct mutex backlight_lock;
0476 
0477     /* protects panel power sequencer state */
0478     struct mutex pps_mutex;
0479 
0480     unsigned int fsb_freq, mem_freq, is_ddr3;
0481     unsigned int skl_preferred_vco_freq;
0482     unsigned int max_cdclk_freq;
0483 
0484     unsigned int max_dotclk_freq;
0485     unsigned int hpll_freq;
0486     unsigned int fdi_pll_freq;
0487     unsigned int czclk_freq;
0488 
0489     struct {
0490         /* The current hardware cdclk configuration */
0491         struct intel_cdclk_config hw;
0492 
0493         /* cdclk, divider, and ratio table from bspec */
0494         const struct intel_cdclk_vals *table;
0495 
0496         struct intel_global_obj obj;
0497     } cdclk;
0498 
0499     struct {
0500         /* The current hardware dbuf configuration */
0501         u8 enabled_slices;
0502 
0503         struct intel_global_obj obj;
0504     } dbuf;
0505 
0506     /**
0507      * wq - Driver workqueue for GEM.
0508      *
0509      * NOTE: Work items scheduled here are not allowed to grab any modeset
0510      * locks, for otherwise the flushing done in the pageflip code will
0511      * result in deadlocks.
0512      */
0513     struct workqueue_struct *wq;
0514 
0515     /* ordered wq for modesets */
0516     struct workqueue_struct *modeset_wq;
0517     /* unbound hipri wq for page flips/plane updates */
0518     struct workqueue_struct *flip_wq;
0519 
0520     /* pm private clock gating functions */
0521     const struct drm_i915_clock_gating_funcs *clock_gating_funcs;
0522 
0523     /* pm display functions */
0524     const struct drm_i915_wm_disp_funcs *wm_disp;
0525 
0526     /* irq display functions */
0527     const struct intel_hotplug_funcs *hotplug_funcs;
0528 
0529     /* fdi display functions */
0530     const struct intel_fdi_funcs *fdi_funcs;
0531 
0532     /* display pll funcs */
0533     const struct intel_dpll_funcs *dpll_funcs;
0534 
0535     /* Display functions */
0536     const struct drm_i915_display_funcs *display;
0537 
0538     /* Display internal color functions */
0539     const struct intel_color_funcs *color_funcs;
0540 
0541     /* Display CDCLK functions */
0542     const struct intel_cdclk_funcs *cdclk_funcs;
0543 
0544     /* PCH chipset type */
0545     enum intel_pch pch_type;
0546     unsigned short pch_id;
0547 
0548     unsigned long quirks;
0549 
0550     struct drm_atomic_state *modeset_restore_state;
0551     struct drm_modeset_acquire_ctx reset_ctx;
0552 
0553     struct i915_gem_mm mm;
0554 
0555     /* Kernel Modesetting */
0556 
0557     /**
0558      * dpll and cdclk state is protected by connection_mutex
0559      * dpll.lock serializes intel_{prepare,enable,disable}_shared_dpll.
0560      * Must be global rather than per dpll, because on some platforms plls
0561      * share registers.
0562      */
0563     struct {
0564         struct mutex lock;
0565 
0566         int num_shared_dpll;
0567         struct intel_shared_dpll shared_dplls[I915_NUM_PLLS];
0568         const struct intel_dpll_mgr *mgr;
0569 
0570         struct {
0571             int nssc;
0572             int ssc;
0573         } ref_clks;
0574     } dpll;
0575 
0576     struct list_head global_obj_list;
0577 
0578     struct i915_frontbuffer_tracking fb_tracking;
0579 
0580     struct intel_atomic_helper {
0581         struct llist_head free_list;
0582         struct work_struct free_work;
0583     } atomic_helper;
0584 
0585     bool mchbar_need_disable;
0586 
0587     struct intel_l3_parity l3_parity;
0588 
0589     /*
0590      * HTI (aka HDPORT) state read during initial hw readout.  Most
0591      * platforms don't have HTI, so this will just stay 0.  Those that do
0592      * will use this later to figure out which PLLs and PHYs are unavailable
0593      * for driver usage.
0594      */
0595     u32 hti_state;
0596 
0597     /*
0598      * edram size in MB.
0599      * Cannot be determined by PCIID. You must always read a register.
0600      */
0601     u32 edram_size_mb;
0602 
0603     struct i915_power_domains power_domains;
0604 
0605     struct i915_gpu_error gpu_error;
0606 
0607     /* list of fbdev register on this device */
0608     struct intel_fbdev *fbdev;
0609     struct work_struct fbdev_suspend_work;
0610 
0611     struct drm_property *broadcast_rgb_property;
0612     struct drm_property *force_audio_property;
0613 
0614     u32 fdi_rx_config;
0615 
0616     /* Shadow for DISPLAY_PHY_CONTROL which can't be safely read */
0617     u32 chv_phy_control;
0618     /*
0619      * Shadows for CHV DPLL_MD regs to keep the state
0620      * checker somewhat working in the presence hardware
0621      * crappiness (can't read out DPLL_MD for pipes B & C).
0622      */
0623     u32 chv_dpll_md[I915_MAX_PIPES];
0624     u32 bxt_phy_grc;
0625 
0626     u32 suspend_count;
0627     struct i915_suspend_saved_registers regfile;
0628     struct vlv_s0ix_state *vlv_s0ix_state;
0629 
0630     enum {
0631         I915_SAGV_UNKNOWN = 0,
0632         I915_SAGV_DISABLED,
0633         I915_SAGV_ENABLED,
0634         I915_SAGV_NOT_CONTROLLED
0635     } sagv_status;
0636 
0637     u32 sagv_block_time_us;
0638 
0639     struct {
0640         /*
0641          * Raw watermark latency values:
0642          * in 0.1us units for WM0,
0643          * in 0.5us units for WM1+.
0644          */
0645         /* primary */
0646         u16 pri_latency[5];
0647         /* sprite */
0648         u16 spr_latency[5];
0649         /* cursor */
0650         u16 cur_latency[5];
0651         /*
0652          * Raw watermark memory latency values
0653          * for SKL for all 8 levels
0654          * in 1us units.
0655          */
0656         u16 skl_latency[8];
0657 
0658         /* current hardware state */
0659         union {
0660             struct ilk_wm_values hw;
0661             struct vlv_wm_values vlv;
0662             struct g4x_wm_values g4x;
0663         };
0664 
0665         u8 max_level;
0666 
0667         /*
0668          * Should be held around atomic WM register writing; also
0669          * protects * intel_crtc->wm.active and
0670          * crtc_state->wm.need_postvbl_update.
0671          */
0672         struct mutex wm_mutex;
0673     } wm;
0674 
0675     struct dram_info {
0676         bool wm_lv_0_adjust_needed;
0677         u8 num_channels;
0678         bool symmetric_memory;
0679         enum intel_dram_type {
0680             INTEL_DRAM_UNKNOWN,
0681             INTEL_DRAM_DDR3,
0682             INTEL_DRAM_DDR4,
0683             INTEL_DRAM_LPDDR3,
0684             INTEL_DRAM_LPDDR4,
0685             INTEL_DRAM_DDR5,
0686             INTEL_DRAM_LPDDR5,
0687         } type;
0688         u8 num_qgv_points;
0689         u8 num_psf_gv_points;
0690     } dram_info;
0691 
0692     struct intel_bw_info {
0693         /* for each QGV point */
0694         unsigned int deratedbw[I915_NUM_QGV_POINTS];
0695         /* for each PSF GV point */
0696         unsigned int psf_bw[I915_NUM_PSF_GV_POINTS];
0697         u8 num_qgv_points;
0698         u8 num_psf_gv_points;
0699         u8 num_planes;
0700     } max_bw[6];
0701 
0702     struct intel_global_obj bw_obj;
0703 
0704     struct intel_runtime_pm runtime_pm;
0705 
0706     struct i915_perf perf;
0707 
0708     /* Abstract the submission mechanism (legacy ringbuffer or execlists) away */
0709     struct intel_gt gt0;
0710 
0711     /*
0712      * i915->gt[0] == &i915->gt0
0713      */
0714 #define I915_MAX_GT 4
0715     struct intel_gt *gt[I915_MAX_GT];
0716 
0717     struct kobject *sysfs_gt;
0718 
0719     struct {
0720         struct i915_gem_contexts {
0721             spinlock_t lock; /* locks list */
0722             struct list_head list;
0723         } contexts;
0724 
0725         /*
0726          * We replace the local file with a global mappings as the
0727          * backing storage for the mmap is on the device and not
0728          * on the struct file, and we do not want to prolong the
0729          * lifetime of the local fd. To minimise the number of
0730          * anonymous inodes we create, we use a global singleton to
0731          * share the global mapping.
0732          */
0733         struct file *mmap_singleton;
0734     } gem;
0735 
0736     /* Window2 specifies time required to program DSB (Window2) in number of scan lines */
0737     u8 window2_delay;
0738 
0739     u8 pch_ssc_use;
0740 
0741     /* For i915gm/i945gm vblank irq workaround */
0742     u8 vblank_enabled;
0743 
0744     bool irq_enabled;
0745 
0746     union {
0747         /* perform PHY state sanity checks? */
0748         bool chv_phy_assert[2];
0749 
0750         /*
0751          * DG2: Mask of PHYs that were not calibrated by the firmware
0752          * and should not be used.
0753          */
0754         u8 snps_phy_failed_calibration;
0755     };
0756 
0757     bool ipc_enabled;
0758 
0759     struct intel_audio_private audio;
0760 
0761     struct i915_pmu pmu;
0762 
0763     struct i915_drm_clients clients;
0764 
0765     struct i915_hdcp_comp_master *hdcp_master;
0766     bool hdcp_comp_added;
0767 
0768     /* Mutex to protect the above hdcp component related values. */
0769     struct mutex hdcp_comp_mutex;
0770 
0771     /* The TTM device structure. */
0772     struct ttm_device bdev;
0773 
0774     I915_SELFTEST_DECLARE(struct i915_selftest_stash selftest;)
0775 
0776     /*
0777      * NOTE: This is the dri1/ums dungeon, don't add stuff here. Your patch
0778      * will be rejected. Instead look for a better place.
0779      */
0780 };
0781 
0782 static inline struct drm_i915_private *to_i915(const struct drm_device *dev)
0783 {
0784     return container_of(dev, struct drm_i915_private, drm);
0785 }
0786 
0787 static inline struct drm_i915_private *kdev_to_i915(struct device *kdev)
0788 {
0789     return dev_get_drvdata(kdev);
0790 }
0791 
0792 static inline struct drm_i915_private *pdev_to_i915(struct pci_dev *pdev)
0793 {
0794     return pci_get_drvdata(pdev);
0795 }
0796 
0797 static inline struct intel_gt *to_gt(struct drm_i915_private *i915)
0798 {
0799     return &i915->gt0;
0800 }
0801 
0802 /* Simple iterator over all initialised engines */
0803 #define for_each_engine(engine__, dev_priv__, id__) \
0804     for ((id__) = 0; \
0805          (id__) < I915_NUM_ENGINES; \
0806          (id__)++) \
0807         for_each_if ((engine__) = (dev_priv__)->engine[(id__)])
0808 
0809 /* Iterator over subset of engines selected by mask */
0810 #define for_each_engine_masked(engine__, gt__, mask__, tmp__) \
0811     for ((tmp__) = (mask__) & (gt__)->info.engine_mask; \
0812          (tmp__) ? \
0813          ((engine__) = (gt__)->engine[__mask_next_bit(tmp__)]), 1 : \
0814          0;)
0815 
0816 #define rb_to_uabi_engine(rb) \
0817     rb_entry_safe(rb, struct intel_engine_cs, uabi_node)
0818 
0819 #define for_each_uabi_engine(engine__, i915__) \
0820     for ((engine__) = rb_to_uabi_engine(rb_first(&(i915__)->uabi_engines));\
0821          (engine__); \
0822          (engine__) = rb_to_uabi_engine(rb_next(&(engine__)->uabi_node)))
0823 
0824 #define for_each_uabi_class_engine(engine__, class__, i915__) \
0825     for ((engine__) = intel_engine_lookup_user((i915__), (class__), 0); \
0826          (engine__) && (engine__)->uabi_class == (class__); \
0827          (engine__) = rb_to_uabi_engine(rb_next(&(engine__)->uabi_node)))
0828 
0829 #define I915_GTT_OFFSET_NONE ((u32)-1)
0830 
0831 /*
0832  * Frontbuffer tracking bits. Set in obj->frontbuffer_bits while a gem bo is
0833  * considered to be the frontbuffer for the given plane interface-wise. This
0834  * doesn't mean that the hw necessarily already scans it out, but that any
0835  * rendering (by the cpu or gpu) will land in the frontbuffer eventually.
0836  *
0837  * We have one bit per pipe and per scanout plane type.
0838  */
0839 #define INTEL_FRONTBUFFER_BITS_PER_PIPE 8
0840 #define INTEL_FRONTBUFFER(pipe, plane_id) ({ \
0841     BUILD_BUG_ON(INTEL_FRONTBUFFER_BITS_PER_PIPE * I915_MAX_PIPES > 32); \
0842     BUILD_BUG_ON(I915_MAX_PLANES > INTEL_FRONTBUFFER_BITS_PER_PIPE); \
0843     BIT((plane_id) + INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe)); \
0844 })
0845 #define INTEL_FRONTBUFFER_OVERLAY(pipe) \
0846     BIT(INTEL_FRONTBUFFER_BITS_PER_PIPE - 1 + INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))
0847 #define INTEL_FRONTBUFFER_ALL_MASK(pipe) \
0848     GENMASK(INTEL_FRONTBUFFER_BITS_PER_PIPE * ((pipe) + 1) - 1, \
0849         INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))
0850 
0851 #define INTEL_INFO(dev_priv)    (&(dev_priv)->__info)
0852 #define RUNTIME_INFO(dev_priv)  (&(dev_priv)->__runtime)
0853 #define DRIVER_CAPS(dev_priv)   (&(dev_priv)->caps)
0854 
0855 #define INTEL_DEVID(dev_priv)   (RUNTIME_INFO(dev_priv)->device_id)
0856 
0857 #define IP_VER(ver, rel)        ((ver) << 8 | (rel))
0858 
0859 #define GRAPHICS_VER(i915)      (INTEL_INFO(i915)->graphics.ver)
0860 #define GRAPHICS_VER_FULL(i915)     IP_VER(INTEL_INFO(i915)->graphics.ver, \
0861                            INTEL_INFO(i915)->graphics.rel)
0862 #define IS_GRAPHICS_VER(i915, from, until) \
0863     (GRAPHICS_VER(i915) >= (from) && GRAPHICS_VER(i915) <= (until))
0864 
0865 #define MEDIA_VER(i915)         (INTEL_INFO(i915)->media.ver)
0866 #define MEDIA_VER_FULL(i915)        IP_VER(INTEL_INFO(i915)->media.ver, \
0867                            INTEL_INFO(i915)->media.rel)
0868 #define IS_MEDIA_VER(i915, from, until) \
0869     (MEDIA_VER(i915) >= (from) && MEDIA_VER(i915) <= (until))
0870 
0871 #define DISPLAY_VER(i915)   (INTEL_INFO(i915)->display.ver)
0872 #define IS_DISPLAY_VER(i915, from, until) \
0873     (DISPLAY_VER(i915) >= (from) && DISPLAY_VER(i915) <= (until))
0874 
0875 #define INTEL_REVID(dev_priv)   (to_pci_dev((dev_priv)->drm.dev)->revision)
0876 
0877 #define HAS_DSB(dev_priv)   (INTEL_INFO(dev_priv)->display.has_dsb)
0878 
0879 #define INTEL_DISPLAY_STEP(__i915) (RUNTIME_INFO(__i915)->step.display_step)
0880 #define INTEL_GRAPHICS_STEP(__i915) (RUNTIME_INFO(__i915)->step.graphics_step)
0881 #define INTEL_MEDIA_STEP(__i915) (RUNTIME_INFO(__i915)->step.media_step)
0882 #define INTEL_BASEDIE_STEP(__i915) (RUNTIME_INFO(__i915)->step.basedie_step)
0883 
0884 #define IS_DISPLAY_STEP(__i915, since, until) \
0885     (drm_WARN_ON(&(__i915)->drm, INTEL_DISPLAY_STEP(__i915) == STEP_NONE), \
0886      INTEL_DISPLAY_STEP(__i915) >= (since) && INTEL_DISPLAY_STEP(__i915) < (until))
0887 
0888 #define IS_GRAPHICS_STEP(__i915, since, until) \
0889     (drm_WARN_ON(&(__i915)->drm, INTEL_GRAPHICS_STEP(__i915) == STEP_NONE), \
0890      INTEL_GRAPHICS_STEP(__i915) >= (since) && INTEL_GRAPHICS_STEP(__i915) < (until))
0891 
0892 #define IS_MEDIA_STEP(__i915, since, until) \
0893     (drm_WARN_ON(&(__i915)->drm, INTEL_MEDIA_STEP(__i915) == STEP_NONE), \
0894      INTEL_MEDIA_STEP(__i915) >= (since) && INTEL_MEDIA_STEP(__i915) < (until))
0895 
0896 #define IS_BASEDIE_STEP(__i915, since, until) \
0897     (drm_WARN_ON(&(__i915)->drm, INTEL_BASEDIE_STEP(__i915) == STEP_NONE), \
0898      INTEL_BASEDIE_STEP(__i915) >= (since) && INTEL_BASEDIE_STEP(__i915) < (until))
0899 
0900 static __always_inline unsigned int
0901 __platform_mask_index(const struct intel_runtime_info *info,
0902               enum intel_platform p)
0903 {
0904     const unsigned int pbits =
0905         BITS_PER_TYPE(info->platform_mask[0]) - INTEL_SUBPLATFORM_BITS;
0906 
0907     /* Expand the platform_mask array if this fails. */
0908     BUILD_BUG_ON(INTEL_MAX_PLATFORMS >
0909              pbits * ARRAY_SIZE(info->platform_mask));
0910 
0911     return p / pbits;
0912 }
0913 
0914 static __always_inline unsigned int
0915 __platform_mask_bit(const struct intel_runtime_info *info,
0916             enum intel_platform p)
0917 {
0918     const unsigned int pbits =
0919         BITS_PER_TYPE(info->platform_mask[0]) - INTEL_SUBPLATFORM_BITS;
0920 
0921     return p % pbits + INTEL_SUBPLATFORM_BITS;
0922 }
0923 
0924 static inline u32
0925 intel_subplatform(const struct intel_runtime_info *info, enum intel_platform p)
0926 {
0927     const unsigned int pi = __platform_mask_index(info, p);
0928 
0929     return info->platform_mask[pi] & INTEL_SUBPLATFORM_MASK;
0930 }
0931 
0932 static __always_inline bool
0933 IS_PLATFORM(const struct drm_i915_private *i915, enum intel_platform p)
0934 {
0935     const struct intel_runtime_info *info = RUNTIME_INFO(i915);
0936     const unsigned int pi = __platform_mask_index(info, p);
0937     const unsigned int pb = __platform_mask_bit(info, p);
0938 
0939     BUILD_BUG_ON(!__builtin_constant_p(p));
0940 
0941     return info->platform_mask[pi] & BIT(pb);
0942 }
0943 
0944 static __always_inline bool
0945 IS_SUBPLATFORM(const struct drm_i915_private *i915,
0946            enum intel_platform p, unsigned int s)
0947 {
0948     const struct intel_runtime_info *info = RUNTIME_INFO(i915);
0949     const unsigned int pi = __platform_mask_index(info, p);
0950     const unsigned int pb = __platform_mask_bit(info, p);
0951     const unsigned int msb = BITS_PER_TYPE(info->platform_mask[0]) - 1;
0952     const u32 mask = info->platform_mask[pi];
0953 
0954     BUILD_BUG_ON(!__builtin_constant_p(p));
0955     BUILD_BUG_ON(!__builtin_constant_p(s));
0956     BUILD_BUG_ON((s) >= INTEL_SUBPLATFORM_BITS);
0957 
0958     /* Shift and test on the MSB position so sign flag can be used. */
0959     return ((mask << (msb - pb)) & (mask << (msb - s))) & BIT(msb);
0960 }
0961 
0962 #define IS_MOBILE(dev_priv) (INTEL_INFO(dev_priv)->is_mobile)
0963 #define IS_DGFX(dev_priv)   (INTEL_INFO(dev_priv)->is_dgfx)
0964 
0965 #define IS_I830(dev_priv)   IS_PLATFORM(dev_priv, INTEL_I830)
0966 #define IS_I845G(dev_priv)  IS_PLATFORM(dev_priv, INTEL_I845G)
0967 #define IS_I85X(dev_priv)   IS_PLATFORM(dev_priv, INTEL_I85X)
0968 #define IS_I865G(dev_priv)  IS_PLATFORM(dev_priv, INTEL_I865G)
0969 #define IS_I915G(dev_priv)  IS_PLATFORM(dev_priv, INTEL_I915G)
0970 #define IS_I915GM(dev_priv) IS_PLATFORM(dev_priv, INTEL_I915GM)
0971 #define IS_I945G(dev_priv)  IS_PLATFORM(dev_priv, INTEL_I945G)
0972 #define IS_I945GM(dev_priv) IS_PLATFORM(dev_priv, INTEL_I945GM)
0973 #define IS_I965G(dev_priv)  IS_PLATFORM(dev_priv, INTEL_I965G)
0974 #define IS_I965GM(dev_priv) IS_PLATFORM(dev_priv, INTEL_I965GM)
0975 #define IS_G45(dev_priv)    IS_PLATFORM(dev_priv, INTEL_G45)
0976 #define IS_GM45(dev_priv)   IS_PLATFORM(dev_priv, INTEL_GM45)
0977 #define IS_G4X(dev_priv)    (IS_G45(dev_priv) || IS_GM45(dev_priv))
0978 #define IS_PINEVIEW(dev_priv)   IS_PLATFORM(dev_priv, INTEL_PINEVIEW)
0979 #define IS_G33(dev_priv)    IS_PLATFORM(dev_priv, INTEL_G33)
0980 #define IS_IRONLAKE(dev_priv)   IS_PLATFORM(dev_priv, INTEL_IRONLAKE)
0981 #define IS_IRONLAKE_M(dev_priv) \
0982     (IS_PLATFORM(dev_priv, INTEL_IRONLAKE) && IS_MOBILE(dev_priv))
0983 #define IS_SANDYBRIDGE(dev_priv) IS_PLATFORM(dev_priv, INTEL_SANDYBRIDGE)
0984 #define IS_IVYBRIDGE(dev_priv)  IS_PLATFORM(dev_priv, INTEL_IVYBRIDGE)
0985 #define IS_IVB_GT1(dev_priv)    (IS_IVYBRIDGE(dev_priv) && \
0986                  INTEL_INFO(dev_priv)->gt == 1)
0987 #define IS_VALLEYVIEW(dev_priv) IS_PLATFORM(dev_priv, INTEL_VALLEYVIEW)
0988 #define IS_CHERRYVIEW(dev_priv) IS_PLATFORM(dev_priv, INTEL_CHERRYVIEW)
0989 #define IS_HASWELL(dev_priv)    IS_PLATFORM(dev_priv, INTEL_HASWELL)
0990 #define IS_BROADWELL(dev_priv)  IS_PLATFORM(dev_priv, INTEL_BROADWELL)
0991 #define IS_SKYLAKE(dev_priv)    IS_PLATFORM(dev_priv, INTEL_SKYLAKE)
0992 #define IS_BROXTON(dev_priv)    IS_PLATFORM(dev_priv, INTEL_BROXTON)
0993 #define IS_KABYLAKE(dev_priv)   IS_PLATFORM(dev_priv, INTEL_KABYLAKE)
0994 #define IS_GEMINILAKE(dev_priv) IS_PLATFORM(dev_priv, INTEL_GEMINILAKE)
0995 #define IS_COFFEELAKE(dev_priv) IS_PLATFORM(dev_priv, INTEL_COFFEELAKE)
0996 #define IS_COMETLAKE(dev_priv)  IS_PLATFORM(dev_priv, INTEL_COMETLAKE)
0997 #define IS_ICELAKE(dev_priv)    IS_PLATFORM(dev_priv, INTEL_ICELAKE)
0998 #define IS_JSL_EHL(dev_priv)    (IS_PLATFORM(dev_priv, INTEL_JASPERLAKE) || \
0999                 IS_PLATFORM(dev_priv, INTEL_ELKHARTLAKE))
1000 #define IS_TIGERLAKE(dev_priv)  IS_PLATFORM(dev_priv, INTEL_TIGERLAKE)
1001 #define IS_ROCKETLAKE(dev_priv) IS_PLATFORM(dev_priv, INTEL_ROCKETLAKE)
1002 #define IS_DG1(dev_priv)        IS_PLATFORM(dev_priv, INTEL_DG1)
1003 #define IS_ALDERLAKE_S(dev_priv) IS_PLATFORM(dev_priv, INTEL_ALDERLAKE_S)
1004 #define IS_ALDERLAKE_P(dev_priv) IS_PLATFORM(dev_priv, INTEL_ALDERLAKE_P)
1005 #define IS_XEHPSDV(dev_priv) IS_PLATFORM(dev_priv, INTEL_XEHPSDV)
1006 #define IS_DG2(dev_priv)    IS_PLATFORM(dev_priv, INTEL_DG2)
1007 #define IS_PONTEVECCHIO(dev_priv) IS_PLATFORM(dev_priv, INTEL_PONTEVECCHIO)
1008 #define IS_METEORLAKE(dev_priv) IS_PLATFORM(dev_priv, INTEL_METEORLAKE)
1009 
1010 #define IS_METEORLAKE_M(dev_priv) \
1011     IS_SUBPLATFORM(dev_priv, INTEL_METEORLAKE, INTEL_SUBPLATFORM_M)
1012 #define IS_METEORLAKE_P(dev_priv) \
1013     IS_SUBPLATFORM(dev_priv, INTEL_METEORLAKE, INTEL_SUBPLATFORM_P)
1014 #define IS_DG2_G10(dev_priv) \
1015     IS_SUBPLATFORM(dev_priv, INTEL_DG2, INTEL_SUBPLATFORM_G10)
1016 #define IS_DG2_G11(dev_priv) \
1017     IS_SUBPLATFORM(dev_priv, INTEL_DG2, INTEL_SUBPLATFORM_G11)
1018 #define IS_DG2_G12(dev_priv) \
1019     IS_SUBPLATFORM(dev_priv, INTEL_DG2, INTEL_SUBPLATFORM_G12)
1020 #define IS_ADLS_RPLS(dev_priv) \
1021     IS_SUBPLATFORM(dev_priv, INTEL_ALDERLAKE_S, INTEL_SUBPLATFORM_RPL)
1022 #define IS_ADLP_N(dev_priv) \
1023     IS_SUBPLATFORM(dev_priv, INTEL_ALDERLAKE_P, INTEL_SUBPLATFORM_N)
1024 #define IS_ADLP_RPLP(dev_priv) \
1025     IS_SUBPLATFORM(dev_priv, INTEL_ALDERLAKE_P, INTEL_SUBPLATFORM_RPL)
1026 #define IS_HSW_EARLY_SDV(dev_priv) (IS_HASWELL(dev_priv) && \
1027                     (INTEL_DEVID(dev_priv) & 0xFF00) == 0x0C00)
1028 #define IS_BDW_ULT(dev_priv) \
1029     IS_SUBPLATFORM(dev_priv, INTEL_BROADWELL, INTEL_SUBPLATFORM_ULT)
1030 #define IS_BDW_ULX(dev_priv) \
1031     IS_SUBPLATFORM(dev_priv, INTEL_BROADWELL, INTEL_SUBPLATFORM_ULX)
1032 #define IS_BDW_GT3(dev_priv)    (IS_BROADWELL(dev_priv) && \
1033                  INTEL_INFO(dev_priv)->gt == 3)
1034 #define IS_HSW_ULT(dev_priv) \
1035     IS_SUBPLATFORM(dev_priv, INTEL_HASWELL, INTEL_SUBPLATFORM_ULT)
1036 #define IS_HSW_GT3(dev_priv)    (IS_HASWELL(dev_priv) && \
1037                  INTEL_INFO(dev_priv)->gt == 3)
1038 #define IS_HSW_GT1(dev_priv)    (IS_HASWELL(dev_priv) && \
1039                  INTEL_INFO(dev_priv)->gt == 1)
1040 /* ULX machines are also considered ULT. */
1041 #define IS_HSW_ULX(dev_priv) \
1042     IS_SUBPLATFORM(dev_priv, INTEL_HASWELL, INTEL_SUBPLATFORM_ULX)
1043 #define IS_SKL_ULT(dev_priv) \
1044     IS_SUBPLATFORM(dev_priv, INTEL_SKYLAKE, INTEL_SUBPLATFORM_ULT)
1045 #define IS_SKL_ULX(dev_priv) \
1046     IS_SUBPLATFORM(dev_priv, INTEL_SKYLAKE, INTEL_SUBPLATFORM_ULX)
1047 #define IS_KBL_ULT(dev_priv) \
1048     IS_SUBPLATFORM(dev_priv, INTEL_KABYLAKE, INTEL_SUBPLATFORM_ULT)
1049 #define IS_KBL_ULX(dev_priv) \
1050     IS_SUBPLATFORM(dev_priv, INTEL_KABYLAKE, INTEL_SUBPLATFORM_ULX)
1051 #define IS_SKL_GT2(dev_priv)    (IS_SKYLAKE(dev_priv) && \
1052                  INTEL_INFO(dev_priv)->gt == 2)
1053 #define IS_SKL_GT3(dev_priv)    (IS_SKYLAKE(dev_priv) && \
1054                  INTEL_INFO(dev_priv)->gt == 3)
1055 #define IS_SKL_GT4(dev_priv)    (IS_SKYLAKE(dev_priv) && \
1056                  INTEL_INFO(dev_priv)->gt == 4)
1057 #define IS_KBL_GT2(dev_priv)    (IS_KABYLAKE(dev_priv) && \
1058                  INTEL_INFO(dev_priv)->gt == 2)
1059 #define IS_KBL_GT3(dev_priv)    (IS_KABYLAKE(dev_priv) && \
1060                  INTEL_INFO(dev_priv)->gt == 3)
1061 #define IS_CFL_ULT(dev_priv) \
1062     IS_SUBPLATFORM(dev_priv, INTEL_COFFEELAKE, INTEL_SUBPLATFORM_ULT)
1063 #define IS_CFL_ULX(dev_priv) \
1064     IS_SUBPLATFORM(dev_priv, INTEL_COFFEELAKE, INTEL_SUBPLATFORM_ULX)
1065 #define IS_CFL_GT2(dev_priv)    (IS_COFFEELAKE(dev_priv) && \
1066                  INTEL_INFO(dev_priv)->gt == 2)
1067 #define IS_CFL_GT3(dev_priv)    (IS_COFFEELAKE(dev_priv) && \
1068                  INTEL_INFO(dev_priv)->gt == 3)
1069 
1070 #define IS_CML_ULT(dev_priv) \
1071     IS_SUBPLATFORM(dev_priv, INTEL_COMETLAKE, INTEL_SUBPLATFORM_ULT)
1072 #define IS_CML_ULX(dev_priv) \
1073     IS_SUBPLATFORM(dev_priv, INTEL_COMETLAKE, INTEL_SUBPLATFORM_ULX)
1074 #define IS_CML_GT2(dev_priv)    (IS_COMETLAKE(dev_priv) && \
1075                  INTEL_INFO(dev_priv)->gt == 2)
1076 
1077 #define IS_ICL_WITH_PORT_F(dev_priv) \
1078     IS_SUBPLATFORM(dev_priv, INTEL_ICELAKE, INTEL_SUBPLATFORM_PORTF)
1079 
1080 #define IS_TGL_UY(dev_priv) \
1081     IS_SUBPLATFORM(dev_priv, INTEL_TIGERLAKE, INTEL_SUBPLATFORM_UY)
1082 
1083 #define IS_SKL_GRAPHICS_STEP(p, since, until) (IS_SKYLAKE(p) && IS_GRAPHICS_STEP(p, since, until))
1084 
1085 #define IS_KBL_GRAPHICS_STEP(dev_priv, since, until) \
1086     (IS_KABYLAKE(dev_priv) && IS_GRAPHICS_STEP(dev_priv, since, until))
1087 #define IS_KBL_DISPLAY_STEP(dev_priv, since, until) \
1088     (IS_KABYLAKE(dev_priv) && IS_DISPLAY_STEP(dev_priv, since, until))
1089 
1090 #define IS_JSL_EHL_GRAPHICS_STEP(p, since, until) \
1091     (IS_JSL_EHL(p) && IS_GRAPHICS_STEP(p, since, until))
1092 #define IS_JSL_EHL_DISPLAY_STEP(p, since, until) \
1093     (IS_JSL_EHL(p) && IS_DISPLAY_STEP(p, since, until))
1094 
1095 #define IS_TGL_DISPLAY_STEP(__i915, since, until) \
1096     (IS_TIGERLAKE(__i915) && \
1097      IS_DISPLAY_STEP(__i915, since, until))
1098 
1099 #define IS_TGL_UY_GRAPHICS_STEP(__i915, since, until) \
1100     (IS_TGL_UY(__i915) && \
1101      IS_GRAPHICS_STEP(__i915, since, until))
1102 
1103 #define IS_TGL_GRAPHICS_STEP(__i915, since, until) \
1104     (IS_TIGERLAKE(__i915) && !IS_TGL_UY(__i915)) && \
1105      IS_GRAPHICS_STEP(__i915, since, until))
1106 
1107 #define IS_RKL_DISPLAY_STEP(p, since, until) \
1108     (IS_ROCKETLAKE(p) && IS_DISPLAY_STEP(p, since, until))
1109 
1110 #define IS_DG1_GRAPHICS_STEP(p, since, until) \
1111     (IS_DG1(p) && IS_GRAPHICS_STEP(p, since, until))
1112 #define IS_DG1_DISPLAY_STEP(p, since, until) \
1113     (IS_DG1(p) && IS_DISPLAY_STEP(p, since, until))
1114 
1115 #define IS_ADLS_DISPLAY_STEP(__i915, since, until) \
1116     (IS_ALDERLAKE_S(__i915) && \
1117      IS_DISPLAY_STEP(__i915, since, until))
1118 
1119 #define IS_ADLS_GRAPHICS_STEP(__i915, since, until) \
1120     (IS_ALDERLAKE_S(__i915) && \
1121      IS_GRAPHICS_STEP(__i915, since, until))
1122 
1123 #define IS_ADLP_DISPLAY_STEP(__i915, since, until) \
1124     (IS_ALDERLAKE_P(__i915) && \
1125      IS_DISPLAY_STEP(__i915, since, until))
1126 
1127 #define IS_ADLP_GRAPHICS_STEP(__i915, since, until) \
1128     (IS_ALDERLAKE_P(__i915) && \
1129      IS_GRAPHICS_STEP(__i915, since, until))
1130 
1131 #define IS_XEHPSDV_GRAPHICS_STEP(__i915, since, until) \
1132     (IS_XEHPSDV(__i915) && IS_GRAPHICS_STEP(__i915, since, until))
1133 
1134 /*
1135  * DG2 hardware steppings are a bit unusual.  The hardware design was forked to
1136  * create three variants (G10, G11, and G12) which each have distinct
1137  * workaround sets.  The G11 and G12 forks of the DG2 design reset the GT
1138  * stepping back to "A0" for their first iterations, even though they're more
1139  * similar to a G10 B0 stepping and G10 C0 stepping respectively in terms of
1140  * functionality and workarounds.  However the display stepping does not reset
1141  * in the same manner --- a specific stepping like "B0" has a consistent
1142  * meaning regardless of whether it belongs to a G10, G11, or G12 DG2.
1143  *
1144  * TLDR:  All GT workarounds and stepping-specific logic must be applied in
1145  * relation to a specific subplatform (G10/G11/G12), whereas display workarounds
1146  * and stepping-specific logic will be applied with a general DG2-wide stepping
1147  * number.
1148  */
1149 #define IS_DG2_GRAPHICS_STEP(__i915, variant, since, until) \
1150     (IS_SUBPLATFORM(__i915, INTEL_DG2, INTEL_SUBPLATFORM_##variant) && \
1151      IS_GRAPHICS_STEP(__i915, since, until))
1152 
1153 #define IS_DG2_DISPLAY_STEP(__i915, since, until) \
1154     (IS_DG2(__i915) && \
1155      IS_DISPLAY_STEP(__i915, since, until))
1156 
1157 #define IS_PVC_BD_STEP(__i915, since, until) \
1158     (IS_PONTEVECCHIO(__i915) && \
1159      IS_BASEDIE_STEP(__i915, since, until))
1160 
1161 #define IS_PVC_CT_STEP(__i915, since, until) \
1162     (IS_PONTEVECCHIO(__i915) && \
1163      IS_GRAPHICS_STEP(__i915, since, until))
1164 
1165 #define IS_LP(dev_priv)     (INTEL_INFO(dev_priv)->is_lp)
1166 #define IS_GEN9_LP(dev_priv)    (GRAPHICS_VER(dev_priv) == 9 && IS_LP(dev_priv))
1167 #define IS_GEN9_BC(dev_priv)    (GRAPHICS_VER(dev_priv) == 9 && !IS_LP(dev_priv))
1168 
1169 #define __HAS_ENGINE(engine_mask, id) ((engine_mask) & BIT(id))
1170 #define HAS_ENGINE(gt, id) __HAS_ENGINE((gt)->info.engine_mask, id)
1171 
1172 #define ENGINE_INSTANCES_MASK(gt, first, count) ({      \
1173     unsigned int first__ = (first);                 \
1174     unsigned int count__ = (count);                 \
1175     ((gt)->info.engine_mask &                       \
1176      GENMASK(first__ + count__ - 1, first__)) >> first__;       \
1177 })
1178 #define RCS_MASK(gt) \
1179     ENGINE_INSTANCES_MASK(gt, RCS0, I915_MAX_RCS)
1180 #define BCS_MASK(gt) \
1181     ENGINE_INSTANCES_MASK(gt, BCS0, I915_MAX_BCS)
1182 #define VDBOX_MASK(gt) \
1183     ENGINE_INSTANCES_MASK(gt, VCS0, I915_MAX_VCS)
1184 #define VEBOX_MASK(gt) \
1185     ENGINE_INSTANCES_MASK(gt, VECS0, I915_MAX_VECS)
1186 #define CCS_MASK(gt) \
1187     ENGINE_INSTANCES_MASK(gt, CCS0, I915_MAX_CCS)
1188 
1189 #define HAS_MEDIA_RATIO_MODE(dev_priv) (INTEL_INFO(dev_priv)->has_media_ratio_mode)
1190 
1191 /*
1192  * The Gen7 cmdparser copies the scanned buffer to the ggtt for execution
1193  * All later gens can run the final buffer from the ppgtt
1194  */
1195 #define CMDPARSER_USES_GGTT(dev_priv) (GRAPHICS_VER(dev_priv) == 7)
1196 
1197 #define HAS_LLC(dev_priv)   (INTEL_INFO(dev_priv)->has_llc)
1198 #define HAS_4TILE(dev_priv) (INTEL_INFO(dev_priv)->has_4tile)
1199 #define HAS_SNOOP(dev_priv) (INTEL_INFO(dev_priv)->has_snoop)
1200 #define HAS_EDRAM(dev_priv) ((dev_priv)->edram_size_mb)
1201 #define HAS_SECURE_BATCHES(dev_priv) (GRAPHICS_VER(dev_priv) < 6)
1202 #define HAS_WT(dev_priv)    HAS_EDRAM(dev_priv)
1203 
1204 #define HWS_NEEDS_PHYSICAL(dev_priv)    (INTEL_INFO(dev_priv)->hws_needs_physical)
1205 
1206 #define HAS_LOGICAL_RING_CONTEXTS(dev_priv) \
1207         (INTEL_INFO(dev_priv)->has_logical_ring_contexts)
1208 #define HAS_LOGICAL_RING_ELSQ(dev_priv) \
1209         (INTEL_INFO(dev_priv)->has_logical_ring_elsq)
1210 
1211 #define HAS_EXECLISTS(dev_priv) HAS_LOGICAL_RING_CONTEXTS(dev_priv)
1212 
1213 #define INTEL_PPGTT(dev_priv) (INTEL_INFO(dev_priv)->ppgtt_type)
1214 #define HAS_PPGTT(dev_priv) \
1215     (INTEL_PPGTT(dev_priv) != INTEL_PPGTT_NONE)
1216 #define HAS_FULL_PPGTT(dev_priv) \
1217     (INTEL_PPGTT(dev_priv) >= INTEL_PPGTT_FULL)
1218 
1219 #define HAS_PAGE_SIZES(dev_priv, sizes) ({ \
1220     GEM_BUG_ON((sizes) == 0); \
1221     ((sizes) & ~INTEL_INFO(dev_priv)->page_sizes) == 0; \
1222 })
1223 
1224 #define HAS_OVERLAY(dev_priv)        (INTEL_INFO(dev_priv)->display.has_overlay)
1225 #define OVERLAY_NEEDS_PHYSICAL(dev_priv) \
1226         (INTEL_INFO(dev_priv)->display.overlay_needs_physical)
1227 
1228 /* Early gen2 have a totally busted CS tlb and require pinned batches. */
1229 #define HAS_BROKEN_CS_TLB(dev_priv) (IS_I830(dev_priv) || IS_I845G(dev_priv))
1230 
1231 #define NEEDS_RC6_CTX_CORRUPTION_WA(dev_priv)   \
1232     (IS_BROADWELL(dev_priv) || GRAPHICS_VER(dev_priv) == 9)
1233 
1234 /* WaRsDisableCoarsePowerGating:skl,cnl */
1235 #define NEEDS_WaRsDisableCoarsePowerGating(dev_priv)            \
1236     (IS_SKL_GT3(dev_priv) || IS_SKL_GT4(dev_priv))
1237 
1238 #define HAS_GMBUS_IRQ(dev_priv) (DISPLAY_VER(dev_priv) >= 4)
1239 #define HAS_GMBUS_BURST_READ(dev_priv) (DISPLAY_VER(dev_priv) >= 11 || \
1240                     IS_GEMINILAKE(dev_priv) || \
1241                     IS_KABYLAKE(dev_priv))
1242 
1243 /* With the 945 and later, Y tiling got adjusted so that it was 32 128-byte
1244  * rows, which changed the alignment requirements and fence programming.
1245  */
1246 #define HAS_128_BYTE_Y_TILING(dev_priv) (GRAPHICS_VER(dev_priv) != 2 && \
1247                      !(IS_I915G(dev_priv) || IS_I915GM(dev_priv)))
1248 #define SUPPORTS_TV(dev_priv)       (INTEL_INFO(dev_priv)->display.supports_tv)
1249 #define I915_HAS_HOTPLUG(dev_priv)  (INTEL_INFO(dev_priv)->display.has_hotplug)
1250 
1251 #define HAS_FW_BLC(dev_priv)    (DISPLAY_VER(dev_priv) > 2)
1252 #define HAS_FBC(dev_priv)   (INTEL_INFO(dev_priv)->display.fbc_mask != 0)
1253 #define HAS_CUR_FBC(dev_priv)   (!HAS_GMCH(dev_priv) && DISPLAY_VER(dev_priv) >= 7)
1254 
1255 #define HAS_IPS(dev_priv)   (IS_HSW_ULT(dev_priv) || IS_BROADWELL(dev_priv))
1256 
1257 #define HAS_DP_MST(dev_priv)    (INTEL_INFO(dev_priv)->display.has_dp_mst)
1258 #define HAS_DP20(dev_priv)  (IS_DG2(dev_priv))
1259 
1260 #define HAS_CDCLK_CRAWL(dev_priv)    (INTEL_INFO(dev_priv)->display.has_cdclk_crawl)
1261 #define HAS_DDI(dev_priv)        (INTEL_INFO(dev_priv)->display.has_ddi)
1262 #define HAS_FPGA_DBG_UNCLAIMED(dev_priv) (INTEL_INFO(dev_priv)->display.has_fpga_dbg)
1263 #define HAS_PSR(dev_priv)        (INTEL_INFO(dev_priv)->display.has_psr)
1264 #define HAS_PSR_HW_TRACKING(dev_priv) \
1265     (INTEL_INFO(dev_priv)->display.has_psr_hw_tracking)
1266 #define HAS_PSR2_SEL_FETCH(dev_priv)     (DISPLAY_VER(dev_priv) >= 12)
1267 #define HAS_TRANSCODER(dev_priv, trans)  ((INTEL_INFO(dev_priv)->display.cpu_transcoder_mask & BIT(trans)) != 0)
1268 
1269 #define HAS_RC6(dev_priv)        (INTEL_INFO(dev_priv)->has_rc6)
1270 #define HAS_RC6p(dev_priv)       (INTEL_INFO(dev_priv)->has_rc6p)
1271 #define HAS_RC6pp(dev_priv)      (false) /* HW was never validated */
1272 
1273 #define HAS_RPS(dev_priv)   (INTEL_INFO(dev_priv)->has_rps)
1274 
1275 #define HAS_DMC(dev_priv)   (INTEL_INFO(dev_priv)->display.has_dmc)
1276 
1277 #define HAS_HECI_PXP(dev_priv) \
1278     (INTEL_INFO(dev_priv)->has_heci_pxp)
1279 
1280 #define HAS_HECI_GSCFI(dev_priv) \
1281     (INTEL_INFO(dev_priv)->has_heci_gscfi)
1282 
1283 #define HAS_HECI_GSC(dev_priv) (HAS_HECI_PXP(dev_priv) || HAS_HECI_GSCFI(dev_priv))
1284 
1285 #define HAS_MSO(i915)       (DISPLAY_VER(i915) >= 12)
1286 
1287 #define HAS_RUNTIME_PM(dev_priv) (INTEL_INFO(dev_priv)->has_runtime_pm)
1288 #define HAS_64BIT_RELOC(dev_priv) (INTEL_INFO(dev_priv)->has_64bit_reloc)
1289 
1290 /*
1291  * Set this flag, when platform requires 64K GTT page sizes or larger for
1292  * device local memory access.
1293  */
1294 #define HAS_64K_PAGES(dev_priv) (INTEL_INFO(dev_priv)->has_64k_pages)
1295 
1296 /*
1297  * Set this flag when platform doesn't allow both 64k pages and 4k pages in
1298  * the same PT. this flag means we need to support compact PT layout for the
1299  * ppGTT when using the 64K GTT pages.
1300  */
1301 #define NEEDS_COMPACT_PT(dev_priv) (INTEL_INFO(dev_priv)->needs_compact_pt)
1302 
1303 #define HAS_IPC(dev_priv)        (INTEL_INFO(dev_priv)->display.has_ipc)
1304 
1305 #define HAS_REGION(i915, i) (INTEL_INFO(i915)->memory_regions & (i))
1306 #define HAS_LMEM(i915) HAS_REGION(i915, REGION_LMEM)
1307 
1308 /*
1309  * Platform has the dedicated compression control state for each lmem surfaces
1310  * stored in lmem to support the 3D and media compression formats.
1311  */
1312 #define HAS_FLAT_CCS(dev_priv)   (INTEL_INFO(dev_priv)->has_flat_ccs)
1313 
1314 #define HAS_GT_UC(dev_priv) (INTEL_INFO(dev_priv)->has_gt_uc)
1315 
1316 #define HAS_POOLED_EU(dev_priv) (INTEL_INFO(dev_priv)->has_pooled_eu)
1317 
1318 #define HAS_GLOBAL_MOCS_REGISTERS(dev_priv) (INTEL_INFO(dev_priv)->has_global_mocs)
1319 
1320 #define HAS_PXP(dev_priv)  ((IS_ENABLED(CONFIG_DRM_I915_PXP) && \
1321                 INTEL_INFO(dev_priv)->has_pxp) && \
1322                 VDBOX_MASK(to_gt(dev_priv)))
1323 
1324 #define HAS_GMCH(dev_priv) (INTEL_INFO(dev_priv)->display.has_gmch)
1325 
1326 #define HAS_LSPCON(dev_priv) (IS_DISPLAY_VER(dev_priv, 9, 10))
1327 
1328 #define HAS_L3_CCS_READ(i915) (INTEL_INFO(i915)->has_l3_ccs_read)
1329 
1330 /* DPF == dynamic parity feature */
1331 #define HAS_L3_DPF(dev_priv) (INTEL_INFO(dev_priv)->has_l3_dpf)
1332 #define NUM_L3_SLICES(dev_priv) (IS_HSW_GT3(dev_priv) ? \
1333                  2 : HAS_L3_DPF(dev_priv))
1334 
1335 #define GT_FREQUENCY_MULTIPLIER 50
1336 #define GEN9_FREQ_SCALER 3
1337 
1338 #define INTEL_NUM_PIPES(dev_priv) (hweight8(INTEL_INFO(dev_priv)->display.pipe_mask))
1339 
1340 #define HAS_DISPLAY(dev_priv) (INTEL_INFO(dev_priv)->display.pipe_mask != 0)
1341 
1342 #define HAS_VRR(i915)   (DISPLAY_VER(i915) >= 11)
1343 
1344 #define HAS_ASYNC_FLIPS(i915)       (DISPLAY_VER(i915) >= 5)
1345 
1346 /* Only valid when HAS_DISPLAY() is true */
1347 #define INTEL_DISPLAY_ENABLED(dev_priv) \
1348     (drm_WARN_ON(&(dev_priv)->drm, !HAS_DISPLAY(dev_priv)),     \
1349      !(dev_priv)->params.disable_display &&             \
1350      !intel_opregion_headless_sku(dev_priv))
1351 
1352 #define HAS_GUC_DEPRIVILEGE(dev_priv) \
1353     (INTEL_INFO(dev_priv)->has_guc_deprivilege)
1354 
1355 #define HAS_PERCTX_PREEMPT_CTRL(i915) \
1356     ((GRAPHICS_VER(i915) >= 9) &&  GRAPHICS_VER_FULL(i915) < IP_VER(12, 55))
1357 
1358 #define HAS_D12_PLANE_MINIMIZATION(dev_priv) (IS_ROCKETLAKE(dev_priv) || \
1359                           IS_ALDERLAKE_S(dev_priv))
1360 
1361 #define HAS_MBUS_JOINING(i915) (IS_ALDERLAKE_P(i915))
1362 
1363 #define HAS_3D_PIPELINE(i915)   (INTEL_INFO(i915)->has_3d_pipeline)
1364 
1365 #define HAS_ONE_EU_PER_FUSE_BIT(i915)   (INTEL_INFO(i915)->has_one_eu_per_fuse_bit)
1366 
1367 /* i915_gem.c */
1368 void i915_gem_init_early(struct drm_i915_private *dev_priv);
1369 void i915_gem_cleanup_early(struct drm_i915_private *dev_priv);
1370 
1371 static inline void i915_gem_drain_freed_objects(struct drm_i915_private *i915)
1372 {
1373     /*
1374      * A single pass should suffice to release all the freed objects (along
1375      * most call paths) , but be a little more paranoid in that freeing
1376      * the objects does take a little amount of time, during which the rcu
1377      * callbacks could have added new objects into the freed list, and
1378      * armed the work again.
1379      */
1380     while (atomic_read(&i915->mm.free_count)) {
1381         flush_work(&i915->mm.free_work);
1382         flush_delayed_work(&i915->bdev.wq);
1383         rcu_barrier();
1384     }
1385 }
1386 
1387 static inline void i915_gem_drain_workqueue(struct drm_i915_private *i915)
1388 {
1389     /*
1390      * Similar to objects above (see i915_gem_drain_freed-objects), in
1391      * general we have workers that are armed by RCU and then rearm
1392      * themselves in their callbacks. To be paranoid, we need to
1393      * drain the workqueue a second time after waiting for the RCU
1394      * grace period so that we catch work queued via RCU from the first
1395      * pass. As neither drain_workqueue() nor flush_workqueue() report
1396      * a result, we make an assumption that we only don't require more
1397      * than 3 passes to catch all _recursive_ RCU delayed work.
1398      *
1399      */
1400     int pass = 3;
1401     do {
1402         flush_workqueue(i915->wq);
1403         rcu_barrier();
1404         i915_gem_drain_freed_objects(i915);
1405     } while (--pass);
1406     drain_workqueue(i915->wq);
1407 }
1408 
1409 struct i915_vma * __must_check
1410 i915_gem_object_ggtt_pin_ww(struct drm_i915_gem_object *obj,
1411                 struct i915_gem_ww_ctx *ww,
1412                 const struct i915_ggtt_view *view,
1413                 u64 size, u64 alignment, u64 flags);
1414 
1415 struct i915_vma * __must_check
1416 i915_gem_object_ggtt_pin(struct drm_i915_gem_object *obj,
1417              const struct i915_ggtt_view *view,
1418              u64 size, u64 alignment, u64 flags);
1419 
1420 int i915_gem_object_unbind(struct drm_i915_gem_object *obj,
1421                unsigned long flags);
1422 #define I915_GEM_OBJECT_UNBIND_ACTIVE BIT(0)
1423 #define I915_GEM_OBJECT_UNBIND_BARRIER BIT(1)
1424 #define I915_GEM_OBJECT_UNBIND_TEST BIT(2)
1425 #define I915_GEM_OBJECT_UNBIND_VM_TRYLOCK BIT(3)
1426 #define I915_GEM_OBJECT_UNBIND_ASYNC BIT(4)
1427 
1428 void i915_gem_runtime_suspend(struct drm_i915_private *dev_priv);
1429 
1430 int __must_check i915_gem_set_global_seqno(struct drm_device *dev, u32 seqno);
1431 
1432 int __must_check i915_gem_init(struct drm_i915_private *dev_priv);
1433 void i915_gem_driver_register(struct drm_i915_private *i915);
1434 void i915_gem_driver_unregister(struct drm_i915_private *i915);
1435 void i915_gem_driver_remove(struct drm_i915_private *dev_priv);
1436 void i915_gem_driver_release(struct drm_i915_private *dev_priv);
1437 
1438 int i915_gem_open(struct drm_i915_private *i915, struct drm_file *file);
1439 
1440 /* intel_device_info.c */
1441 static inline struct intel_device_info *
1442 mkwrite_device_info(struct drm_i915_private *dev_priv)
1443 {
1444     return (struct intel_device_info *)INTEL_INFO(dev_priv);
1445 }
1446 
1447 static inline enum i915_map_type
1448 i915_coherent_map_type(struct drm_i915_private *i915,
1449                struct drm_i915_gem_object *obj, bool always_coherent)
1450 {
1451     if (i915_gem_object_is_lmem(obj))
1452         return I915_MAP_WC;
1453     if (HAS_LLC(i915) || always_coherent)
1454         return I915_MAP_WB;
1455     else
1456         return I915_MAP_WC;
1457 }
1458 
1459 #endif