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