xref: /linux/drivers/gpu/drm/i915/i915_drv.h (revision 2ba9268dd603d23e17643437b2246acb6844953b)
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 
35 #include "i915_reg.h"
36 #include "intel_bios.h"
37 #include "intel_ringbuffer.h"
38 #include "intel_lrc.h"
39 #include "i915_gem_gtt.h"
40 #include "i915_gem_render_state.h"
41 #include <linux/io-mapping.h>
42 #include <linux/i2c.h>
43 #include <linux/i2c-algo-bit.h>
44 #include <drm/intel-gtt.h>
45 #include <drm/drm_legacy.h> /* for struct drm_dma_handle */
46 #include <drm/drm_gem.h>
47 #include <linux/backlight.h>
48 #include <linux/hashtable.h>
49 #include <linux/intel-iommu.h>
50 #include <linux/kref.h>
51 #include <linux/pm_qos.h>
52 
53 /* General customization:
54  */
55 
56 #define DRIVER_NAME		"i915"
57 #define DRIVER_DESC		"Intel Graphics"
58 #define DRIVER_DATE		"20150130"
59 
60 #undef WARN_ON
61 /* Many gcc seem to no see through this and fall over :( */
62 #if 0
63 #define WARN_ON(x) ({ \
64 	bool __i915_warn_cond = (x); \
65 	if (__builtin_constant_p(__i915_warn_cond)) \
66 		BUILD_BUG_ON(__i915_warn_cond); \
67 	WARN(__i915_warn_cond, "WARN_ON(" #x ")"); })
68 #else
69 #define WARN_ON(x) WARN((x), "WARN_ON(" #x ")")
70 #endif
71 
72 #define MISSING_CASE(x) WARN(1, "Missing switch case (%lu) in %s\n", \
73 			     (long) (x), __func__);
74 
75 /* Use I915_STATE_WARN(x) and I915_STATE_WARN_ON() (rather than WARN() and
76  * WARN_ON()) for hw state sanity checks to check for unexpected conditions
77  * which may not necessarily be a user visible problem.  This will either
78  * WARN() or DRM_ERROR() depending on the verbose_checks moduleparam, to
79  * enable distros and users to tailor their preferred amount of i915 abrt
80  * spam.
81  */
82 #define I915_STATE_WARN(condition, format...) ({			\
83 	int __ret_warn_on = !!(condition);				\
84 	if (unlikely(__ret_warn_on)) {					\
85 		if (i915.verbose_state_checks)				\
86 			WARN(1, format);				\
87 		else 							\
88 			DRM_ERROR(format);				\
89 	}								\
90 	unlikely(__ret_warn_on);					\
91 })
92 
93 #define I915_STATE_WARN_ON(condition) ({				\
94 	int __ret_warn_on = !!(condition);				\
95 	if (unlikely(__ret_warn_on)) {					\
96 		if (i915.verbose_state_checks)				\
97 			WARN(1, "WARN_ON(" #condition ")\n");		\
98 		else 							\
99 			DRM_ERROR("WARN_ON(" #condition ")\n");		\
100 	}								\
101 	unlikely(__ret_warn_on);					\
102 })
103 
104 enum pipe {
105 	INVALID_PIPE = -1,
106 	PIPE_A = 0,
107 	PIPE_B,
108 	PIPE_C,
109 	_PIPE_EDP,
110 	I915_MAX_PIPES = _PIPE_EDP
111 };
112 #define pipe_name(p) ((p) + 'A')
113 
114 enum transcoder {
115 	TRANSCODER_A = 0,
116 	TRANSCODER_B,
117 	TRANSCODER_C,
118 	TRANSCODER_EDP,
119 	I915_MAX_TRANSCODERS
120 };
121 #define transcoder_name(t) ((t) + 'A')
122 
123 /*
124  * This is the maximum (across all platforms) number of planes (primary +
125  * sprites) that can be active at the same time on one pipe.
126  *
127  * This value doesn't count the cursor plane.
128  */
129 #define I915_MAX_PLANES	3
130 
131 enum plane {
132 	PLANE_A = 0,
133 	PLANE_B,
134 	PLANE_C,
135 };
136 #define plane_name(p) ((p) + 'A')
137 
138 #define sprite_name(p, s) ((p) * INTEL_INFO(dev)->num_sprites[(p)] + (s) + 'A')
139 
140 enum port {
141 	PORT_A = 0,
142 	PORT_B,
143 	PORT_C,
144 	PORT_D,
145 	PORT_E,
146 	I915_MAX_PORTS
147 };
148 #define port_name(p) ((p) + 'A')
149 
150 #define I915_NUM_PHYS_VLV 2
151 
152 enum dpio_channel {
153 	DPIO_CH0,
154 	DPIO_CH1
155 };
156 
157 enum dpio_phy {
158 	DPIO_PHY0,
159 	DPIO_PHY1
160 };
161 
162 enum intel_display_power_domain {
163 	POWER_DOMAIN_PIPE_A,
164 	POWER_DOMAIN_PIPE_B,
165 	POWER_DOMAIN_PIPE_C,
166 	POWER_DOMAIN_PIPE_A_PANEL_FITTER,
167 	POWER_DOMAIN_PIPE_B_PANEL_FITTER,
168 	POWER_DOMAIN_PIPE_C_PANEL_FITTER,
169 	POWER_DOMAIN_TRANSCODER_A,
170 	POWER_DOMAIN_TRANSCODER_B,
171 	POWER_DOMAIN_TRANSCODER_C,
172 	POWER_DOMAIN_TRANSCODER_EDP,
173 	POWER_DOMAIN_PORT_DDI_A_2_LANES,
174 	POWER_DOMAIN_PORT_DDI_A_4_LANES,
175 	POWER_DOMAIN_PORT_DDI_B_2_LANES,
176 	POWER_DOMAIN_PORT_DDI_B_4_LANES,
177 	POWER_DOMAIN_PORT_DDI_C_2_LANES,
178 	POWER_DOMAIN_PORT_DDI_C_4_LANES,
179 	POWER_DOMAIN_PORT_DDI_D_2_LANES,
180 	POWER_DOMAIN_PORT_DDI_D_4_LANES,
181 	POWER_DOMAIN_PORT_DSI,
182 	POWER_DOMAIN_PORT_CRT,
183 	POWER_DOMAIN_PORT_OTHER,
184 	POWER_DOMAIN_VGA,
185 	POWER_DOMAIN_AUDIO,
186 	POWER_DOMAIN_PLLS,
187 	POWER_DOMAIN_AUX_A,
188 	POWER_DOMAIN_AUX_B,
189 	POWER_DOMAIN_AUX_C,
190 	POWER_DOMAIN_AUX_D,
191 	POWER_DOMAIN_INIT,
192 
193 	POWER_DOMAIN_NUM,
194 };
195 
196 #define POWER_DOMAIN_PIPE(pipe) ((pipe) + POWER_DOMAIN_PIPE_A)
197 #define POWER_DOMAIN_PIPE_PANEL_FITTER(pipe) \
198 		((pipe) + POWER_DOMAIN_PIPE_A_PANEL_FITTER)
199 #define POWER_DOMAIN_TRANSCODER(tran) \
200 	((tran) == TRANSCODER_EDP ? POWER_DOMAIN_TRANSCODER_EDP : \
201 	 (tran) + POWER_DOMAIN_TRANSCODER_A)
202 
203 enum hpd_pin {
204 	HPD_NONE = 0,
205 	HPD_PORT_A = HPD_NONE, /* PORT_A is internal */
206 	HPD_TV = HPD_NONE,     /* TV is known to be unreliable */
207 	HPD_CRT,
208 	HPD_SDVO_B,
209 	HPD_SDVO_C,
210 	HPD_PORT_B,
211 	HPD_PORT_C,
212 	HPD_PORT_D,
213 	HPD_NUM_PINS
214 };
215 
216 #define I915_GEM_GPU_DOMAINS \
217 	(I915_GEM_DOMAIN_RENDER | \
218 	 I915_GEM_DOMAIN_SAMPLER | \
219 	 I915_GEM_DOMAIN_COMMAND | \
220 	 I915_GEM_DOMAIN_INSTRUCTION | \
221 	 I915_GEM_DOMAIN_VERTEX)
222 
223 #define for_each_pipe(__dev_priv, __p) \
224 	for ((__p) = 0; (__p) < INTEL_INFO(__dev_priv)->num_pipes; (__p)++)
225 #define for_each_plane(pipe, p) \
226 	for ((p) = 0; (p) < INTEL_INFO(dev)->num_sprites[(pipe)] + 1; (p)++)
227 #define for_each_sprite(p, s) for ((s) = 0; (s) < INTEL_INFO(dev)->num_sprites[(p)]; (s)++)
228 
229 #define for_each_crtc(dev, crtc) \
230 	list_for_each_entry(crtc, &dev->mode_config.crtc_list, head)
231 
232 #define for_each_intel_crtc(dev, intel_crtc) \
233 	list_for_each_entry(intel_crtc, &dev->mode_config.crtc_list, base.head)
234 
235 #define for_each_intel_encoder(dev, intel_encoder)		\
236 	list_for_each_entry(intel_encoder,			\
237 			    &(dev)->mode_config.encoder_list,	\
238 			    base.head)
239 
240 #define for_each_encoder_on_crtc(dev, __crtc, intel_encoder) \
241 	list_for_each_entry((intel_encoder), &(dev)->mode_config.encoder_list, base.head) \
242 		if ((intel_encoder)->base.crtc == (__crtc))
243 
244 #define for_each_connector_on_encoder(dev, __encoder, intel_connector) \
245 	list_for_each_entry((intel_connector), &(dev)->mode_config.connector_list, base.head) \
246 		if ((intel_connector)->base.encoder == (__encoder))
247 
248 #define for_each_power_domain(domain, mask)				\
249 	for ((domain) = 0; (domain) < POWER_DOMAIN_NUM; (domain)++)	\
250 		if ((1 << (domain)) & (mask))
251 
252 struct drm_i915_private;
253 struct i915_mm_struct;
254 struct i915_mmu_object;
255 
256 enum intel_dpll_id {
257 	DPLL_ID_PRIVATE = -1, /* non-shared dpll in use */
258 	/* real shared dpll ids must be >= 0 */
259 	DPLL_ID_PCH_PLL_A = 0,
260 	DPLL_ID_PCH_PLL_B = 1,
261 	/* hsw/bdw */
262 	DPLL_ID_WRPLL1 = 0,
263 	DPLL_ID_WRPLL2 = 1,
264 	/* skl */
265 	DPLL_ID_SKL_DPLL1 = 0,
266 	DPLL_ID_SKL_DPLL2 = 1,
267 	DPLL_ID_SKL_DPLL3 = 2,
268 };
269 #define I915_NUM_PLLS 3
270 
271 struct intel_dpll_hw_state {
272 	/* i9xx, pch plls */
273 	uint32_t dpll;
274 	uint32_t dpll_md;
275 	uint32_t fp0;
276 	uint32_t fp1;
277 
278 	/* hsw, bdw */
279 	uint32_t wrpll;
280 
281 	/* skl */
282 	/*
283 	 * DPLL_CTRL1 has 6 bits for each each this DPLL. We store those in
284 	 * lower part of crtl1 and they get shifted into position when writing
285 	 * the register.  This allows us to easily compare the state to share
286 	 * the DPLL.
287 	 */
288 	uint32_t ctrl1;
289 	/* HDMI only, 0 when used for DP */
290 	uint32_t cfgcr1, cfgcr2;
291 };
292 
293 struct intel_shared_dpll_config {
294 	unsigned crtc_mask; /* mask of CRTCs sharing this PLL */
295 	struct intel_dpll_hw_state hw_state;
296 };
297 
298 struct intel_shared_dpll {
299 	struct intel_shared_dpll_config config;
300 	struct intel_shared_dpll_config *new_config;
301 
302 	int active; /* count of number of active CRTCs (i.e. DPMS on) */
303 	bool on; /* is the PLL actually active? Disabled during modeset */
304 	const char *name;
305 	/* should match the index in the dev_priv->shared_dplls array */
306 	enum intel_dpll_id id;
307 	/* The mode_set hook is optional and should be used together with the
308 	 * intel_prepare_shared_dpll function. */
309 	void (*mode_set)(struct drm_i915_private *dev_priv,
310 			 struct intel_shared_dpll *pll);
311 	void (*enable)(struct drm_i915_private *dev_priv,
312 		       struct intel_shared_dpll *pll);
313 	void (*disable)(struct drm_i915_private *dev_priv,
314 			struct intel_shared_dpll *pll);
315 	bool (*get_hw_state)(struct drm_i915_private *dev_priv,
316 			     struct intel_shared_dpll *pll,
317 			     struct intel_dpll_hw_state *hw_state);
318 };
319 
320 #define SKL_DPLL0 0
321 #define SKL_DPLL1 1
322 #define SKL_DPLL2 2
323 #define SKL_DPLL3 3
324 
325 /* Used by dp and fdi links */
326 struct intel_link_m_n {
327 	uint32_t	tu;
328 	uint32_t	gmch_m;
329 	uint32_t	gmch_n;
330 	uint32_t	link_m;
331 	uint32_t	link_n;
332 };
333 
334 void intel_link_compute_m_n(int bpp, int nlanes,
335 			    int pixel_clock, int link_clock,
336 			    struct intel_link_m_n *m_n);
337 
338 /* Interface history:
339  *
340  * 1.1: Original.
341  * 1.2: Add Power Management
342  * 1.3: Add vblank support
343  * 1.4: Fix cmdbuffer path, add heap destroy
344  * 1.5: Add vblank pipe configuration
345  * 1.6: - New ioctl for scheduling buffer swaps on vertical blank
346  *      - Support vertical blank on secondary display pipe
347  */
348 #define DRIVER_MAJOR		1
349 #define DRIVER_MINOR		6
350 #define DRIVER_PATCHLEVEL	0
351 
352 #define WATCH_LISTS	0
353 
354 struct opregion_header;
355 struct opregion_acpi;
356 struct opregion_swsci;
357 struct opregion_asle;
358 
359 struct intel_opregion {
360 	struct opregion_header __iomem *header;
361 	struct opregion_acpi __iomem *acpi;
362 	struct opregion_swsci __iomem *swsci;
363 	u32 swsci_gbda_sub_functions;
364 	u32 swsci_sbcb_sub_functions;
365 	struct opregion_asle __iomem *asle;
366 	void __iomem *vbt;
367 	u32 __iomem *lid_state;
368 	struct work_struct asle_work;
369 };
370 #define OPREGION_SIZE            (8*1024)
371 
372 struct intel_overlay;
373 struct intel_overlay_error_state;
374 
375 #define I915_FENCE_REG_NONE -1
376 #define I915_MAX_NUM_FENCES 32
377 /* 32 fences + sign bit for FENCE_REG_NONE */
378 #define I915_MAX_NUM_FENCE_BITS 6
379 
380 struct drm_i915_fence_reg {
381 	struct list_head lru_list;
382 	struct drm_i915_gem_object *obj;
383 	int pin_count;
384 };
385 
386 struct sdvo_device_mapping {
387 	u8 initialized;
388 	u8 dvo_port;
389 	u8 slave_addr;
390 	u8 dvo_wiring;
391 	u8 i2c_pin;
392 	u8 ddc_pin;
393 };
394 
395 struct intel_display_error_state;
396 
397 struct drm_i915_error_state {
398 	struct kref ref;
399 	struct timeval time;
400 
401 	char error_msg[128];
402 	u32 reset_count;
403 	u32 suspend_count;
404 
405 	/* Generic register state */
406 	u32 eir;
407 	u32 pgtbl_er;
408 	u32 ier;
409 	u32 gtier[4];
410 	u32 ccid;
411 	u32 derrmr;
412 	u32 forcewake;
413 	u32 error; /* gen6+ */
414 	u32 err_int; /* gen7 */
415 	u32 done_reg;
416 	u32 gac_eco;
417 	u32 gam_ecochk;
418 	u32 gab_ctl;
419 	u32 gfx_mode;
420 	u32 extra_instdone[I915_NUM_INSTDONE_REG];
421 	u64 fence[I915_MAX_NUM_FENCES];
422 	struct intel_overlay_error_state *overlay;
423 	struct intel_display_error_state *display;
424 	struct drm_i915_error_object *semaphore_obj;
425 
426 	struct drm_i915_error_ring {
427 		bool valid;
428 		/* Software tracked state */
429 		bool waiting;
430 		int hangcheck_score;
431 		enum intel_ring_hangcheck_action hangcheck_action;
432 		int num_requests;
433 
434 		/* our own tracking of ring head and tail */
435 		u32 cpu_ring_head;
436 		u32 cpu_ring_tail;
437 
438 		u32 semaphore_seqno[I915_NUM_RINGS - 1];
439 
440 		/* Register state */
441 		u32 tail;
442 		u32 head;
443 		u32 ctl;
444 		u32 hws;
445 		u32 ipeir;
446 		u32 ipehr;
447 		u32 instdone;
448 		u32 bbstate;
449 		u32 instpm;
450 		u32 instps;
451 		u32 seqno;
452 		u64 bbaddr;
453 		u64 acthd;
454 		u32 fault_reg;
455 		u64 faddr;
456 		u32 rc_psmi; /* sleep state */
457 		u32 semaphore_mboxes[I915_NUM_RINGS - 1];
458 
459 		struct drm_i915_error_object {
460 			int page_count;
461 			u32 gtt_offset;
462 			u32 *pages[0];
463 		} *ringbuffer, *batchbuffer, *wa_batchbuffer, *ctx, *hws_page;
464 
465 		struct drm_i915_error_request {
466 			long jiffies;
467 			u32 seqno;
468 			u32 tail;
469 		} *requests;
470 
471 		struct {
472 			u32 gfx_mode;
473 			union {
474 				u64 pdp[4];
475 				u32 pp_dir_base;
476 			};
477 		} vm_info;
478 
479 		pid_t pid;
480 		char comm[TASK_COMM_LEN];
481 	} ring[I915_NUM_RINGS];
482 
483 	struct drm_i915_error_buffer {
484 		u32 size;
485 		u32 name;
486 		u32 rseqno, wseqno;
487 		u32 gtt_offset;
488 		u32 read_domains;
489 		u32 write_domain;
490 		s32 fence_reg:I915_MAX_NUM_FENCE_BITS;
491 		s32 pinned:2;
492 		u32 tiling:2;
493 		u32 dirty:1;
494 		u32 purgeable:1;
495 		u32 userptr:1;
496 		s32 ring:4;
497 		u32 cache_level:3;
498 	} **active_bo, **pinned_bo;
499 
500 	u32 *active_bo_count, *pinned_bo_count;
501 	u32 vm_count;
502 };
503 
504 struct intel_connector;
505 struct intel_encoder;
506 struct intel_crtc_state;
507 struct intel_initial_plane_config;
508 struct intel_crtc;
509 struct intel_limit;
510 struct dpll;
511 
512 struct drm_i915_display_funcs {
513 	bool (*fbc_enabled)(struct drm_device *dev);
514 	void (*enable_fbc)(struct drm_crtc *crtc);
515 	void (*disable_fbc)(struct drm_device *dev);
516 	int (*get_display_clock_speed)(struct drm_device *dev);
517 	int (*get_fifo_size)(struct drm_device *dev, int plane);
518 	/**
519 	 * find_dpll() - Find the best values for the PLL
520 	 * @limit: limits for the PLL
521 	 * @crtc: current CRTC
522 	 * @target: target frequency in kHz
523 	 * @refclk: reference clock frequency in kHz
524 	 * @match_clock: if provided, @best_clock P divider must
525 	 *               match the P divider from @match_clock
526 	 *               used for LVDS downclocking
527 	 * @best_clock: best PLL values found
528 	 *
529 	 * Returns true on success, false on failure.
530 	 */
531 	bool (*find_dpll)(const struct intel_limit *limit,
532 			  struct intel_crtc *crtc,
533 			  int target, int refclk,
534 			  struct dpll *match_clock,
535 			  struct dpll *best_clock);
536 	void (*update_wm)(struct drm_crtc *crtc);
537 	void (*update_sprite_wm)(struct drm_plane *plane,
538 				 struct drm_crtc *crtc,
539 				 uint32_t sprite_width, uint32_t sprite_height,
540 				 int pixel_size, bool enable, bool scaled);
541 	void (*modeset_global_resources)(struct drm_device *dev);
542 	/* Returns the active state of the crtc, and if the crtc is active,
543 	 * fills out the pipe-config with the hw state. */
544 	bool (*get_pipe_config)(struct intel_crtc *,
545 				struct intel_crtc_state *);
546 	void (*get_initial_plane_config)(struct intel_crtc *,
547 					 struct intel_initial_plane_config *);
548 	int (*crtc_compute_clock)(struct intel_crtc *crtc,
549 				  struct intel_crtc_state *crtc_state);
550 	void (*crtc_enable)(struct drm_crtc *crtc);
551 	void (*crtc_disable)(struct drm_crtc *crtc);
552 	void (*off)(struct drm_crtc *crtc);
553 	void (*audio_codec_enable)(struct drm_connector *connector,
554 				   struct intel_encoder *encoder,
555 				   struct drm_display_mode *mode);
556 	void (*audio_codec_disable)(struct intel_encoder *encoder);
557 	void (*fdi_link_train)(struct drm_crtc *crtc);
558 	void (*init_clock_gating)(struct drm_device *dev);
559 	int (*queue_flip)(struct drm_device *dev, struct drm_crtc *crtc,
560 			  struct drm_framebuffer *fb,
561 			  struct drm_i915_gem_object *obj,
562 			  struct intel_engine_cs *ring,
563 			  uint32_t flags);
564 	void (*update_primary_plane)(struct drm_crtc *crtc,
565 				     struct drm_framebuffer *fb,
566 				     int x, int y);
567 	void (*hpd_irq_setup)(struct drm_device *dev);
568 	/* clock updates for mode set */
569 	/* cursor updates */
570 	/* render clock increase/decrease */
571 	/* display clock increase/decrease */
572 	/* pll clock increase/decrease */
573 
574 	int (*setup_backlight)(struct intel_connector *connector, enum pipe pipe);
575 	uint32_t (*get_backlight)(struct intel_connector *connector);
576 	void (*set_backlight)(struct intel_connector *connector,
577 			      uint32_t level);
578 	void (*disable_backlight)(struct intel_connector *connector);
579 	void (*enable_backlight)(struct intel_connector *connector);
580 };
581 
582 enum forcewake_domain_id {
583 	FW_DOMAIN_ID_RENDER = 0,
584 	FW_DOMAIN_ID_BLITTER,
585 	FW_DOMAIN_ID_MEDIA,
586 
587 	FW_DOMAIN_ID_COUNT
588 };
589 
590 enum forcewake_domains {
591 	FORCEWAKE_RENDER = (1 << FW_DOMAIN_ID_RENDER),
592 	FORCEWAKE_BLITTER = (1 << FW_DOMAIN_ID_BLITTER),
593 	FORCEWAKE_MEDIA	= (1 << FW_DOMAIN_ID_MEDIA),
594 	FORCEWAKE_ALL = (FORCEWAKE_RENDER |
595 			 FORCEWAKE_BLITTER |
596 			 FORCEWAKE_MEDIA)
597 };
598 
599 struct intel_uncore_funcs {
600 	void (*force_wake_get)(struct drm_i915_private *dev_priv,
601 							enum forcewake_domains domains);
602 	void (*force_wake_put)(struct drm_i915_private *dev_priv,
603 							enum forcewake_domains domains);
604 
605 	uint8_t  (*mmio_readb)(struct drm_i915_private *dev_priv, off_t offset, bool trace);
606 	uint16_t (*mmio_readw)(struct drm_i915_private *dev_priv, off_t offset, bool trace);
607 	uint32_t (*mmio_readl)(struct drm_i915_private *dev_priv, off_t offset, bool trace);
608 	uint64_t (*mmio_readq)(struct drm_i915_private *dev_priv, off_t offset, bool trace);
609 
610 	void (*mmio_writeb)(struct drm_i915_private *dev_priv, off_t offset,
611 				uint8_t val, bool trace);
612 	void (*mmio_writew)(struct drm_i915_private *dev_priv, off_t offset,
613 				uint16_t val, bool trace);
614 	void (*mmio_writel)(struct drm_i915_private *dev_priv, off_t offset,
615 				uint32_t val, bool trace);
616 	void (*mmio_writeq)(struct drm_i915_private *dev_priv, off_t offset,
617 				uint64_t val, bool trace);
618 };
619 
620 struct intel_uncore {
621 	spinlock_t lock; /** lock is also taken in irq contexts. */
622 
623 	struct intel_uncore_funcs funcs;
624 
625 	unsigned fifo_count;
626 	enum forcewake_domains fw_domains;
627 
628 	struct intel_uncore_forcewake_domain {
629 		struct drm_i915_private *i915;
630 		enum forcewake_domain_id id;
631 		unsigned wake_count;
632 		struct timer_list timer;
633 		u32 reg_set;
634 		u32 val_set;
635 		u32 val_clear;
636 		u32 reg_ack;
637 		u32 reg_post;
638 		u32 val_reset;
639 	} fw_domain[FW_DOMAIN_ID_COUNT];
640 };
641 
642 /* Iterate over initialised fw domains */
643 #define for_each_fw_domain_mask(domain__, mask__, dev_priv__, i__) \
644 	for ((i__) = 0, (domain__) = &(dev_priv__)->uncore.fw_domain[0]; \
645 	     (i__) < FW_DOMAIN_ID_COUNT; \
646 	     (i__)++, (domain__) = &(dev_priv__)->uncore.fw_domain[i__]) \
647 		if (((mask__) & (dev_priv__)->uncore.fw_domains) & (1 << (i__)))
648 
649 #define for_each_fw_domain(domain__, dev_priv__, i__) \
650 	for_each_fw_domain_mask(domain__, FORCEWAKE_ALL, dev_priv__, i__)
651 
652 #define DEV_INFO_FOR_EACH_FLAG(func, sep) \
653 	func(is_mobile) sep \
654 	func(is_i85x) sep \
655 	func(is_i915g) sep \
656 	func(is_i945gm) sep \
657 	func(is_g33) sep \
658 	func(need_gfx_hws) sep \
659 	func(is_g4x) sep \
660 	func(is_pineview) sep \
661 	func(is_broadwater) sep \
662 	func(is_crestline) sep \
663 	func(is_ivybridge) sep \
664 	func(is_valleyview) sep \
665 	func(is_haswell) sep \
666 	func(is_skylake) sep \
667 	func(is_preliminary) sep \
668 	func(has_fbc) sep \
669 	func(has_pipe_cxsr) sep \
670 	func(has_hotplug) sep \
671 	func(cursor_needs_physical) sep \
672 	func(has_overlay) sep \
673 	func(overlay_needs_physical) sep \
674 	func(supports_tv) sep \
675 	func(has_llc) sep \
676 	func(has_ddi) sep \
677 	func(has_fpga_dbg)
678 
679 #define DEFINE_FLAG(name) u8 name:1
680 #define SEP_SEMICOLON ;
681 
682 struct intel_device_info {
683 	u32 display_mmio_offset;
684 	u16 device_id;
685 	u8 num_pipes:3;
686 	u8 num_sprites[I915_MAX_PIPES];
687 	u8 gen;
688 	u8 ring_mask; /* Rings supported by the HW */
689 	DEV_INFO_FOR_EACH_FLAG(DEFINE_FLAG, SEP_SEMICOLON);
690 	/* Register offsets for the various display pipes and transcoders */
691 	int pipe_offsets[I915_MAX_TRANSCODERS];
692 	int trans_offsets[I915_MAX_TRANSCODERS];
693 	int palette_offsets[I915_MAX_PIPES];
694 	int cursor_offsets[I915_MAX_PIPES];
695 	unsigned int eu_total;
696 };
697 
698 #undef DEFINE_FLAG
699 #undef SEP_SEMICOLON
700 
701 enum i915_cache_level {
702 	I915_CACHE_NONE = 0,
703 	I915_CACHE_LLC, /* also used for snoopable memory on non-LLC */
704 	I915_CACHE_L3_LLC, /* gen7+, L3 sits between the domain specifc
705 			      caches, eg sampler/render caches, and the
706 			      large Last-Level-Cache. LLC is coherent with
707 			      the CPU, but L3 is only visible to the GPU. */
708 	I915_CACHE_WT, /* hsw:gt3e WriteThrough for scanouts */
709 };
710 
711 struct i915_ctx_hang_stats {
712 	/* This context had batch pending when hang was declared */
713 	unsigned batch_pending;
714 
715 	/* This context had batch active when hang was declared */
716 	unsigned batch_active;
717 
718 	/* Time when this context was last blamed for a GPU reset */
719 	unsigned long guilty_ts;
720 
721 	/* If the contexts causes a second GPU hang within this time,
722 	 * it is permanently banned from submitting any more work.
723 	 */
724 	unsigned long ban_period_seconds;
725 
726 	/* This context is banned to submit more work */
727 	bool banned;
728 };
729 
730 /* This must match up with the value previously used for execbuf2.rsvd1. */
731 #define DEFAULT_CONTEXT_HANDLE 0
732 /**
733  * struct intel_context - as the name implies, represents a context.
734  * @ref: reference count.
735  * @user_handle: userspace tracking identity for this context.
736  * @remap_slice: l3 row remapping information.
737  * @file_priv: filp associated with this context (NULL for global default
738  *	       context).
739  * @hang_stats: information about the role of this context in possible GPU
740  *		hangs.
741  * @vm: virtual memory space used by this context.
742  * @legacy_hw_ctx: render context backing object and whether it is correctly
743  *                initialized (legacy ring submission mechanism only).
744  * @link: link in the global list of contexts.
745  *
746  * Contexts are memory images used by the hardware to store copies of their
747  * internal state.
748  */
749 struct intel_context {
750 	struct kref ref;
751 	int user_handle;
752 	uint8_t remap_slice;
753 	struct drm_i915_file_private *file_priv;
754 	struct i915_ctx_hang_stats hang_stats;
755 	struct i915_hw_ppgtt *ppgtt;
756 
757 	/* Legacy ring buffer submission */
758 	struct {
759 		struct drm_i915_gem_object *rcs_state;
760 		bool initialized;
761 	} legacy_hw_ctx;
762 
763 	/* Execlists */
764 	bool rcs_initialized;
765 	struct {
766 		struct drm_i915_gem_object *state;
767 		struct intel_ringbuffer *ringbuf;
768 		int pin_count;
769 	} engine[I915_NUM_RINGS];
770 
771 	struct list_head link;
772 };
773 
774 struct i915_fbc {
775 	unsigned long size;
776 	unsigned threshold;
777 	unsigned int fb_id;
778 	enum plane plane;
779 	int y;
780 
781 	struct drm_mm_node compressed_fb;
782 	struct drm_mm_node *compressed_llb;
783 
784 	bool false_color;
785 
786 	/* Tracks whether the HW is actually enabled, not whether the feature is
787 	 * possible. */
788 	bool enabled;
789 
790 	/* On gen8 some rings cannont perform fbc clean operation so for now
791 	 * we are doing this on SW with mmio.
792 	 * This variable works in the opposite information direction
793 	 * of ring->fbc_dirty telling software on frontbuffer tracking
794 	 * to perform the cache clean on sw side.
795 	 */
796 	bool need_sw_cache_clean;
797 
798 	struct intel_fbc_work {
799 		struct delayed_work work;
800 		struct drm_crtc *crtc;
801 		struct drm_framebuffer *fb;
802 	} *fbc_work;
803 
804 	enum no_fbc_reason {
805 		FBC_OK, /* FBC is enabled */
806 		FBC_UNSUPPORTED, /* FBC is not supported by this chipset */
807 		FBC_NO_OUTPUT, /* no outputs enabled to compress */
808 		FBC_STOLEN_TOO_SMALL, /* not enough space for buffers */
809 		FBC_UNSUPPORTED_MODE, /* interlace or doublescanned mode */
810 		FBC_MODE_TOO_LARGE, /* mode too large for compression */
811 		FBC_BAD_PLANE, /* fbc not supported on plane */
812 		FBC_NOT_TILED, /* buffer not tiled */
813 		FBC_MULTIPLE_PIPES, /* more than one pipe active */
814 		FBC_MODULE_PARAM,
815 		FBC_CHIP_DEFAULT, /* disabled by default on this chip */
816 	} no_fbc_reason;
817 };
818 
819 /**
820  * HIGH_RR is the highest eDP panel refresh rate read from EDID
821  * LOW_RR is the lowest eDP panel refresh rate found from EDID
822  * parsing for same resolution.
823  */
824 enum drrs_refresh_rate_type {
825 	DRRS_HIGH_RR,
826 	DRRS_LOW_RR,
827 	DRRS_MAX_RR, /* RR count */
828 };
829 
830 enum drrs_support_type {
831 	DRRS_NOT_SUPPORTED = 0,
832 	STATIC_DRRS_SUPPORT = 1,
833 	SEAMLESS_DRRS_SUPPORT = 2
834 };
835 
836 struct intel_dp;
837 struct i915_drrs {
838 	struct mutex mutex;
839 	struct delayed_work work;
840 	struct intel_dp *dp;
841 	unsigned busy_frontbuffer_bits;
842 	enum drrs_refresh_rate_type refresh_rate_type;
843 	enum drrs_support_type type;
844 };
845 
846 struct i915_psr {
847 	struct mutex lock;
848 	bool sink_support;
849 	bool source_ok;
850 	struct intel_dp *enabled;
851 	bool active;
852 	struct delayed_work work;
853 	unsigned busy_frontbuffer_bits;
854 	bool link_standby;
855 };
856 
857 enum intel_pch {
858 	PCH_NONE = 0,	/* No PCH present */
859 	PCH_IBX,	/* Ibexpeak PCH */
860 	PCH_CPT,	/* Cougarpoint PCH */
861 	PCH_LPT,	/* Lynxpoint PCH */
862 	PCH_SPT,        /* Sunrisepoint PCH */
863 	PCH_NOP,
864 };
865 
866 enum intel_sbi_destination {
867 	SBI_ICLK,
868 	SBI_MPHY,
869 };
870 
871 #define QUIRK_PIPEA_FORCE (1<<0)
872 #define QUIRK_LVDS_SSC_DISABLE (1<<1)
873 #define QUIRK_INVERT_BRIGHTNESS (1<<2)
874 #define QUIRK_BACKLIGHT_PRESENT (1<<3)
875 #define QUIRK_PIPEB_FORCE (1<<4)
876 #define QUIRK_PIN_SWIZZLED_PAGES (1<<5)
877 
878 struct intel_fbdev;
879 struct intel_fbc_work;
880 
881 struct intel_gmbus {
882 	struct i2c_adapter adapter;
883 	u32 force_bit;
884 	u32 reg0;
885 	u32 gpio_reg;
886 	struct i2c_algo_bit_data bit_algo;
887 	struct drm_i915_private *dev_priv;
888 };
889 
890 struct i915_suspend_saved_registers {
891 	u8 saveLBB;
892 	u32 saveDSPACNTR;
893 	u32 saveDSPBCNTR;
894 	u32 saveDSPARB;
895 	u32 savePIPEACONF;
896 	u32 savePIPEBCONF;
897 	u32 savePIPEASRC;
898 	u32 savePIPEBSRC;
899 	u32 saveFPA0;
900 	u32 saveFPA1;
901 	u32 saveDPLL_A;
902 	u32 saveDPLL_A_MD;
903 	u32 saveHTOTAL_A;
904 	u32 saveHBLANK_A;
905 	u32 saveHSYNC_A;
906 	u32 saveVTOTAL_A;
907 	u32 saveVBLANK_A;
908 	u32 saveVSYNC_A;
909 	u32 saveBCLRPAT_A;
910 	u32 saveTRANSACONF;
911 	u32 saveTRANS_HTOTAL_A;
912 	u32 saveTRANS_HBLANK_A;
913 	u32 saveTRANS_HSYNC_A;
914 	u32 saveTRANS_VTOTAL_A;
915 	u32 saveTRANS_VBLANK_A;
916 	u32 saveTRANS_VSYNC_A;
917 	u32 savePIPEASTAT;
918 	u32 saveDSPASTRIDE;
919 	u32 saveDSPASIZE;
920 	u32 saveDSPAPOS;
921 	u32 saveDSPAADDR;
922 	u32 saveDSPASURF;
923 	u32 saveDSPATILEOFF;
924 	u32 savePFIT_PGM_RATIOS;
925 	u32 saveBLC_HIST_CTL;
926 	u32 saveBLC_PWM_CTL;
927 	u32 saveBLC_PWM_CTL2;
928 	u32 saveBLC_CPU_PWM_CTL;
929 	u32 saveBLC_CPU_PWM_CTL2;
930 	u32 saveFPB0;
931 	u32 saveFPB1;
932 	u32 saveDPLL_B;
933 	u32 saveDPLL_B_MD;
934 	u32 saveHTOTAL_B;
935 	u32 saveHBLANK_B;
936 	u32 saveHSYNC_B;
937 	u32 saveVTOTAL_B;
938 	u32 saveVBLANK_B;
939 	u32 saveVSYNC_B;
940 	u32 saveBCLRPAT_B;
941 	u32 saveTRANSBCONF;
942 	u32 saveTRANS_HTOTAL_B;
943 	u32 saveTRANS_HBLANK_B;
944 	u32 saveTRANS_HSYNC_B;
945 	u32 saveTRANS_VTOTAL_B;
946 	u32 saveTRANS_VBLANK_B;
947 	u32 saveTRANS_VSYNC_B;
948 	u32 savePIPEBSTAT;
949 	u32 saveDSPBSTRIDE;
950 	u32 saveDSPBSIZE;
951 	u32 saveDSPBPOS;
952 	u32 saveDSPBADDR;
953 	u32 saveDSPBSURF;
954 	u32 saveDSPBTILEOFF;
955 	u32 saveVGA0;
956 	u32 saveVGA1;
957 	u32 saveVGA_PD;
958 	u32 saveVGACNTRL;
959 	u32 saveADPA;
960 	u32 saveLVDS;
961 	u32 savePP_ON_DELAYS;
962 	u32 savePP_OFF_DELAYS;
963 	u32 saveDVOA;
964 	u32 saveDVOB;
965 	u32 saveDVOC;
966 	u32 savePP_ON;
967 	u32 savePP_OFF;
968 	u32 savePP_CONTROL;
969 	u32 savePP_DIVISOR;
970 	u32 savePFIT_CONTROL;
971 	u32 save_palette_a[256];
972 	u32 save_palette_b[256];
973 	u32 saveFBC_CONTROL;
974 	u32 saveIER;
975 	u32 saveIIR;
976 	u32 saveIMR;
977 	u32 saveDEIER;
978 	u32 saveDEIMR;
979 	u32 saveGTIER;
980 	u32 saveGTIMR;
981 	u32 saveFDI_RXA_IMR;
982 	u32 saveFDI_RXB_IMR;
983 	u32 saveCACHE_MODE_0;
984 	u32 saveMI_ARB_STATE;
985 	u32 saveSWF0[16];
986 	u32 saveSWF1[16];
987 	u32 saveSWF2[3];
988 	u8 saveMSR;
989 	u8 saveSR[8];
990 	u8 saveGR[25];
991 	u8 saveAR_INDEX;
992 	u8 saveAR[21];
993 	u8 saveDACMASK;
994 	u8 saveCR[37];
995 	uint64_t saveFENCE[I915_MAX_NUM_FENCES];
996 	u32 saveCURACNTR;
997 	u32 saveCURAPOS;
998 	u32 saveCURABASE;
999 	u32 saveCURBCNTR;
1000 	u32 saveCURBPOS;
1001 	u32 saveCURBBASE;
1002 	u32 saveCURSIZE;
1003 	u32 saveDP_B;
1004 	u32 saveDP_C;
1005 	u32 saveDP_D;
1006 	u32 savePIPEA_GMCH_DATA_M;
1007 	u32 savePIPEB_GMCH_DATA_M;
1008 	u32 savePIPEA_GMCH_DATA_N;
1009 	u32 savePIPEB_GMCH_DATA_N;
1010 	u32 savePIPEA_DP_LINK_M;
1011 	u32 savePIPEB_DP_LINK_M;
1012 	u32 savePIPEA_DP_LINK_N;
1013 	u32 savePIPEB_DP_LINK_N;
1014 	u32 saveFDI_RXA_CTL;
1015 	u32 saveFDI_TXA_CTL;
1016 	u32 saveFDI_RXB_CTL;
1017 	u32 saveFDI_TXB_CTL;
1018 	u32 savePFA_CTL_1;
1019 	u32 savePFB_CTL_1;
1020 	u32 savePFA_WIN_SZ;
1021 	u32 savePFB_WIN_SZ;
1022 	u32 savePFA_WIN_POS;
1023 	u32 savePFB_WIN_POS;
1024 	u32 savePCH_DREF_CONTROL;
1025 	u32 saveDISP_ARB_CTL;
1026 	u32 savePIPEA_DATA_M1;
1027 	u32 savePIPEA_DATA_N1;
1028 	u32 savePIPEA_LINK_M1;
1029 	u32 savePIPEA_LINK_N1;
1030 	u32 savePIPEB_DATA_M1;
1031 	u32 savePIPEB_DATA_N1;
1032 	u32 savePIPEB_LINK_M1;
1033 	u32 savePIPEB_LINK_N1;
1034 	u32 saveMCHBAR_RENDER_STANDBY;
1035 	u32 savePCH_PORT_HOTPLUG;
1036 	u16 saveGCDGMBUS;
1037 };
1038 
1039 struct vlv_s0ix_state {
1040 	/* GAM */
1041 	u32 wr_watermark;
1042 	u32 gfx_prio_ctrl;
1043 	u32 arb_mode;
1044 	u32 gfx_pend_tlb0;
1045 	u32 gfx_pend_tlb1;
1046 	u32 lra_limits[GEN7_LRA_LIMITS_REG_NUM];
1047 	u32 media_max_req_count;
1048 	u32 gfx_max_req_count;
1049 	u32 render_hwsp;
1050 	u32 ecochk;
1051 	u32 bsd_hwsp;
1052 	u32 blt_hwsp;
1053 	u32 tlb_rd_addr;
1054 
1055 	/* MBC */
1056 	u32 g3dctl;
1057 	u32 gsckgctl;
1058 	u32 mbctl;
1059 
1060 	/* GCP */
1061 	u32 ucgctl1;
1062 	u32 ucgctl3;
1063 	u32 rcgctl1;
1064 	u32 rcgctl2;
1065 	u32 rstctl;
1066 	u32 misccpctl;
1067 
1068 	/* GPM */
1069 	u32 gfxpause;
1070 	u32 rpdeuhwtc;
1071 	u32 rpdeuc;
1072 	u32 ecobus;
1073 	u32 pwrdwnupctl;
1074 	u32 rp_down_timeout;
1075 	u32 rp_deucsw;
1076 	u32 rcubmabdtmr;
1077 	u32 rcedata;
1078 	u32 spare2gh;
1079 
1080 	/* Display 1 CZ domain */
1081 	u32 gt_imr;
1082 	u32 gt_ier;
1083 	u32 pm_imr;
1084 	u32 pm_ier;
1085 	u32 gt_scratch[GEN7_GT_SCRATCH_REG_NUM];
1086 
1087 	/* GT SA CZ domain */
1088 	u32 tilectl;
1089 	u32 gt_fifoctl;
1090 	u32 gtlc_wake_ctrl;
1091 	u32 gtlc_survive;
1092 	u32 pmwgicz;
1093 
1094 	/* Display 2 CZ domain */
1095 	u32 gu_ctl0;
1096 	u32 gu_ctl1;
1097 	u32 pcbr;
1098 	u32 clock_gate_dis2;
1099 };
1100 
1101 struct intel_rps_ei {
1102 	u32 cz_clock;
1103 	u32 render_c0;
1104 	u32 media_c0;
1105 };
1106 
1107 struct intel_gen6_power_mgmt {
1108 	/*
1109 	 * work, interrupts_enabled and pm_iir are protected by
1110 	 * dev_priv->irq_lock
1111 	 */
1112 	struct work_struct work;
1113 	bool interrupts_enabled;
1114 	u32 pm_iir;
1115 
1116 	/* Frequencies are stored in potentially platform dependent multiples.
1117 	 * In other words, *_freq needs to be multiplied by X to be interesting.
1118 	 * Soft limits are those which are used for the dynamic reclocking done
1119 	 * by the driver (raise frequencies under heavy loads, and lower for
1120 	 * lighter loads). Hard limits are those imposed by the hardware.
1121 	 *
1122 	 * A distinction is made for overclocking, which is never enabled by
1123 	 * default, and is considered to be above the hard limit if it's
1124 	 * possible at all.
1125 	 */
1126 	u8 cur_freq;		/* Current frequency (cached, may not == HW) */
1127 	u8 min_freq_softlimit;	/* Minimum frequency permitted by the driver */
1128 	u8 max_freq_softlimit;	/* Max frequency permitted by the driver */
1129 	u8 max_freq;		/* Maximum frequency, RP0 if not overclocking */
1130 	u8 min_freq;		/* AKA RPn. Minimum frequency */
1131 	u8 efficient_freq;	/* AKA RPe. Pre-determined balanced frequency */
1132 	u8 rp1_freq;		/* "less than" RP0 power/freqency */
1133 	u8 rp0_freq;		/* Non-overclocked max frequency. */
1134 	u32 cz_freq;
1135 
1136 	u32 ei_interrupt_count;
1137 
1138 	int last_adj;
1139 	enum { LOW_POWER, BETWEEN, HIGH_POWER } power;
1140 
1141 	bool enabled;
1142 	struct delayed_work delayed_resume_work;
1143 
1144 	/* manual wa residency calculations */
1145 	struct intel_rps_ei up_ei, down_ei;
1146 
1147 	/*
1148 	 * Protects RPS/RC6 register access and PCU communication.
1149 	 * Must be taken after struct_mutex if nested.
1150 	 */
1151 	struct mutex hw_lock;
1152 };
1153 
1154 /* defined intel_pm.c */
1155 extern spinlock_t mchdev_lock;
1156 
1157 struct intel_ilk_power_mgmt {
1158 	u8 cur_delay;
1159 	u8 min_delay;
1160 	u8 max_delay;
1161 	u8 fmax;
1162 	u8 fstart;
1163 
1164 	u64 last_count1;
1165 	unsigned long last_time1;
1166 	unsigned long chipset_power;
1167 	u64 last_count2;
1168 	u64 last_time2;
1169 	unsigned long gfx_power;
1170 	u8 corr;
1171 
1172 	int c_m;
1173 	int r_t;
1174 
1175 	struct drm_i915_gem_object *pwrctx;
1176 	struct drm_i915_gem_object *renderctx;
1177 };
1178 
1179 struct drm_i915_private;
1180 struct i915_power_well;
1181 
1182 struct i915_power_well_ops {
1183 	/*
1184 	 * Synchronize the well's hw state to match the current sw state, for
1185 	 * example enable/disable it based on the current refcount. Called
1186 	 * during driver init and resume time, possibly after first calling
1187 	 * the enable/disable handlers.
1188 	 */
1189 	void (*sync_hw)(struct drm_i915_private *dev_priv,
1190 			struct i915_power_well *power_well);
1191 	/*
1192 	 * Enable the well and resources that depend on it (for example
1193 	 * interrupts located on the well). Called after the 0->1 refcount
1194 	 * transition.
1195 	 */
1196 	void (*enable)(struct drm_i915_private *dev_priv,
1197 		       struct i915_power_well *power_well);
1198 	/*
1199 	 * Disable the well and resources that depend on it. Called after
1200 	 * the 1->0 refcount transition.
1201 	 */
1202 	void (*disable)(struct drm_i915_private *dev_priv,
1203 			struct i915_power_well *power_well);
1204 	/* Returns the hw enabled state. */
1205 	bool (*is_enabled)(struct drm_i915_private *dev_priv,
1206 			   struct i915_power_well *power_well);
1207 };
1208 
1209 /* Power well structure for haswell */
1210 struct i915_power_well {
1211 	const char *name;
1212 	bool always_on;
1213 	/* power well enable/disable usage count */
1214 	int count;
1215 	/* cached hw enabled state */
1216 	bool hw_enabled;
1217 	unsigned long domains;
1218 	unsigned long data;
1219 	const struct i915_power_well_ops *ops;
1220 };
1221 
1222 struct i915_power_domains {
1223 	/*
1224 	 * Power wells needed for initialization at driver init and suspend
1225 	 * time are on. They are kept on until after the first modeset.
1226 	 */
1227 	bool init_power_on;
1228 	bool initializing;
1229 	int power_well_count;
1230 
1231 	struct mutex lock;
1232 	int domain_use_count[POWER_DOMAIN_NUM];
1233 	struct i915_power_well *power_wells;
1234 };
1235 
1236 #define MAX_L3_SLICES 2
1237 struct intel_l3_parity {
1238 	u32 *remap_info[MAX_L3_SLICES];
1239 	struct work_struct error_work;
1240 	int which_slice;
1241 };
1242 
1243 struct i915_gem_batch_pool {
1244 	struct drm_device *dev;
1245 	struct list_head cache_list;
1246 };
1247 
1248 struct i915_gem_mm {
1249 	/** Memory allocator for GTT stolen memory */
1250 	struct drm_mm stolen;
1251 	/** List of all objects in gtt_space. Used to restore gtt
1252 	 * mappings on resume */
1253 	struct list_head bound_list;
1254 	/**
1255 	 * List of objects which are not bound to the GTT (thus
1256 	 * are idle and not used by the GPU) but still have
1257 	 * (presumably uncached) pages still attached.
1258 	 */
1259 	struct list_head unbound_list;
1260 
1261 	/*
1262 	 * A pool of objects to use as shadow copies of client batch buffers
1263 	 * when the command parser is enabled. Prevents the client from
1264 	 * modifying the batch contents after software parsing.
1265 	 */
1266 	struct i915_gem_batch_pool batch_pool;
1267 
1268 	/** Usable portion of the GTT for GEM */
1269 	unsigned long stolen_base; /* limited to low memory (32-bit) */
1270 
1271 	/** PPGTT used for aliasing the PPGTT with the GTT */
1272 	struct i915_hw_ppgtt *aliasing_ppgtt;
1273 
1274 	struct notifier_block oom_notifier;
1275 	struct shrinker shrinker;
1276 	bool shrinker_no_lock_stealing;
1277 
1278 	/** LRU list of objects with fence regs on them. */
1279 	struct list_head fence_list;
1280 
1281 	/**
1282 	 * We leave the user IRQ off as much as possible,
1283 	 * but this means that requests will finish and never
1284 	 * be retired once the system goes idle. Set a timer to
1285 	 * fire periodically while the ring is running. When it
1286 	 * fires, go retire requests.
1287 	 */
1288 	struct delayed_work retire_work;
1289 
1290 	/**
1291 	 * When we detect an idle GPU, we want to turn on
1292 	 * powersaving features. So once we see that there
1293 	 * are no more requests outstanding and no more
1294 	 * arrive within a small period of time, we fire
1295 	 * off the idle_work.
1296 	 */
1297 	struct delayed_work idle_work;
1298 
1299 	/**
1300 	 * Are we in a non-interruptible section of code like
1301 	 * modesetting?
1302 	 */
1303 	bool interruptible;
1304 
1305 	/**
1306 	 * Is the GPU currently considered idle, or busy executing userspace
1307 	 * requests?  Whilst idle, we attempt to power down the hardware and
1308 	 * display clocks. In order to reduce the effect on performance, there
1309 	 * is a slight delay before we do so.
1310 	 */
1311 	bool busy;
1312 
1313 	/* the indicator for dispatch video commands on two BSD rings */
1314 	int bsd_ring_dispatch_index;
1315 
1316 	/** Bit 6 swizzling required for X tiling */
1317 	uint32_t bit_6_swizzle_x;
1318 	/** Bit 6 swizzling required for Y tiling */
1319 	uint32_t bit_6_swizzle_y;
1320 
1321 	/* accounting, useful for userland debugging */
1322 	spinlock_t object_stat_lock;
1323 	size_t object_memory;
1324 	u32 object_count;
1325 };
1326 
1327 struct drm_i915_error_state_buf {
1328 	struct drm_i915_private *i915;
1329 	unsigned bytes;
1330 	unsigned size;
1331 	int err;
1332 	u8 *buf;
1333 	loff_t start;
1334 	loff_t pos;
1335 };
1336 
1337 struct i915_error_state_file_priv {
1338 	struct drm_device *dev;
1339 	struct drm_i915_error_state *error;
1340 };
1341 
1342 struct i915_gpu_error {
1343 	/* For hangcheck timer */
1344 #define DRM_I915_HANGCHECK_PERIOD 1500 /* in ms */
1345 #define DRM_I915_HANGCHECK_JIFFIES msecs_to_jiffies(DRM_I915_HANGCHECK_PERIOD)
1346 	/* Hang gpu twice in this window and your context gets banned */
1347 #define DRM_I915_CTX_BAN_PERIOD DIV_ROUND_UP(8*DRM_I915_HANGCHECK_PERIOD, 1000)
1348 
1349 	struct workqueue_struct *hangcheck_wq;
1350 	struct delayed_work hangcheck_work;
1351 
1352 	/* For reset and error_state handling. */
1353 	spinlock_t lock;
1354 	/* Protected by the above dev->gpu_error.lock. */
1355 	struct drm_i915_error_state *first_error;
1356 
1357 	unsigned long missed_irq_rings;
1358 
1359 	/**
1360 	 * State variable controlling the reset flow and count
1361 	 *
1362 	 * This is a counter which gets incremented when reset is triggered,
1363 	 * and again when reset has been handled. So odd values (lowest bit set)
1364 	 * means that reset is in progress and even values that
1365 	 * (reset_counter >> 1):th reset was successfully completed.
1366 	 *
1367 	 * If reset is not completed succesfully, the I915_WEDGE bit is
1368 	 * set meaning that hardware is terminally sour and there is no
1369 	 * recovery. All waiters on the reset_queue will be woken when
1370 	 * that happens.
1371 	 *
1372 	 * This counter is used by the wait_seqno code to notice that reset
1373 	 * event happened and it needs to restart the entire ioctl (since most
1374 	 * likely the seqno it waited for won't ever signal anytime soon).
1375 	 *
1376 	 * This is important for lock-free wait paths, where no contended lock
1377 	 * naturally enforces the correct ordering between the bail-out of the
1378 	 * waiter and the gpu reset work code.
1379 	 */
1380 	atomic_t reset_counter;
1381 
1382 #define I915_RESET_IN_PROGRESS_FLAG	1
1383 #define I915_WEDGED			(1 << 31)
1384 
1385 	/**
1386 	 * Waitqueue to signal when the reset has completed. Used by clients
1387 	 * that wait for dev_priv->mm.wedged to settle.
1388 	 */
1389 	wait_queue_head_t reset_queue;
1390 
1391 	/* Userspace knobs for gpu hang simulation;
1392 	 * combines both a ring mask, and extra flags
1393 	 */
1394 	u32 stop_rings;
1395 #define I915_STOP_RING_ALLOW_BAN       (1 << 31)
1396 #define I915_STOP_RING_ALLOW_WARN      (1 << 30)
1397 
1398 	/* For missed irq/seqno simulation. */
1399 	unsigned int test_irq_rings;
1400 
1401 	/* Used to prevent gem_check_wedged returning -EAGAIN during gpu reset   */
1402 	bool reload_in_reset;
1403 };
1404 
1405 enum modeset_restore {
1406 	MODESET_ON_LID_OPEN,
1407 	MODESET_DONE,
1408 	MODESET_SUSPENDED,
1409 };
1410 
1411 struct ddi_vbt_port_info {
1412 	/*
1413 	 * This is an index in the HDMI/DVI DDI buffer translation table.
1414 	 * The special value HDMI_LEVEL_SHIFT_UNKNOWN means the VBT didn't
1415 	 * populate this field.
1416 	 */
1417 #define HDMI_LEVEL_SHIFT_UNKNOWN	0xff
1418 	uint8_t hdmi_level_shift;
1419 
1420 	uint8_t supports_dvi:1;
1421 	uint8_t supports_hdmi:1;
1422 	uint8_t supports_dp:1;
1423 };
1424 
1425 enum psr_lines_to_wait {
1426 	PSR_0_LINES_TO_WAIT = 0,
1427 	PSR_1_LINE_TO_WAIT,
1428 	PSR_4_LINES_TO_WAIT,
1429 	PSR_8_LINES_TO_WAIT
1430 };
1431 
1432 struct intel_vbt_data {
1433 	struct drm_display_mode *lfp_lvds_vbt_mode; /* if any */
1434 	struct drm_display_mode *sdvo_lvds_vbt_mode; /* if any */
1435 
1436 	/* Feature bits */
1437 	unsigned int int_tv_support:1;
1438 	unsigned int lvds_dither:1;
1439 	unsigned int lvds_vbt:1;
1440 	unsigned int int_crt_support:1;
1441 	unsigned int lvds_use_ssc:1;
1442 	unsigned int display_clock_mode:1;
1443 	unsigned int fdi_rx_polarity_inverted:1;
1444 	unsigned int has_mipi:1;
1445 	int lvds_ssc_freq;
1446 	unsigned int bios_lvds_val; /* initial [PCH_]LVDS reg val in VBIOS */
1447 
1448 	enum drrs_support_type drrs_type;
1449 
1450 	/* eDP */
1451 	int edp_rate;
1452 	int edp_lanes;
1453 	int edp_preemphasis;
1454 	int edp_vswing;
1455 	bool edp_initialized;
1456 	bool edp_support;
1457 	int edp_bpp;
1458 	struct edp_power_seq edp_pps;
1459 
1460 	struct {
1461 		bool full_link;
1462 		bool require_aux_wakeup;
1463 		int idle_frames;
1464 		enum psr_lines_to_wait lines_to_wait;
1465 		int tp1_wakeup_time;
1466 		int tp2_tp3_wakeup_time;
1467 	} psr;
1468 
1469 	struct {
1470 		u16 pwm_freq_hz;
1471 		bool present;
1472 		bool active_low_pwm;
1473 		u8 min_brightness;	/* min_brightness/255 of max */
1474 	} backlight;
1475 
1476 	/* MIPI DSI */
1477 	struct {
1478 		u16 port;
1479 		u16 panel_id;
1480 		struct mipi_config *config;
1481 		struct mipi_pps_data *pps;
1482 		u8 seq_version;
1483 		u32 size;
1484 		u8 *data;
1485 		u8 *sequence[MIPI_SEQ_MAX];
1486 	} dsi;
1487 
1488 	int crt_ddc_pin;
1489 
1490 	int child_dev_num;
1491 	union child_device_config *child_dev;
1492 
1493 	struct ddi_vbt_port_info ddi_port_info[I915_MAX_PORTS];
1494 };
1495 
1496 enum intel_ddb_partitioning {
1497 	INTEL_DDB_PART_1_2,
1498 	INTEL_DDB_PART_5_6, /* IVB+ */
1499 };
1500 
1501 struct intel_wm_level {
1502 	bool enable;
1503 	uint32_t pri_val;
1504 	uint32_t spr_val;
1505 	uint32_t cur_val;
1506 	uint32_t fbc_val;
1507 };
1508 
1509 struct ilk_wm_values {
1510 	uint32_t wm_pipe[3];
1511 	uint32_t wm_lp[3];
1512 	uint32_t wm_lp_spr[3];
1513 	uint32_t wm_linetime[3];
1514 	bool enable_fbc_wm;
1515 	enum intel_ddb_partitioning partitioning;
1516 };
1517 
1518 struct skl_ddb_entry {
1519 	uint16_t start, end;	/* in number of blocks, 'end' is exclusive */
1520 };
1521 
1522 static inline uint16_t skl_ddb_entry_size(const struct skl_ddb_entry *entry)
1523 {
1524 	return entry->end - entry->start;
1525 }
1526 
1527 static inline bool skl_ddb_entry_equal(const struct skl_ddb_entry *e1,
1528 				       const struct skl_ddb_entry *e2)
1529 {
1530 	if (e1->start == e2->start && e1->end == e2->end)
1531 		return true;
1532 
1533 	return false;
1534 }
1535 
1536 struct skl_ddb_allocation {
1537 	struct skl_ddb_entry pipe[I915_MAX_PIPES];
1538 	struct skl_ddb_entry plane[I915_MAX_PIPES][I915_MAX_PLANES];
1539 	struct skl_ddb_entry cursor[I915_MAX_PIPES];
1540 };
1541 
1542 struct skl_wm_values {
1543 	bool dirty[I915_MAX_PIPES];
1544 	struct skl_ddb_allocation ddb;
1545 	uint32_t wm_linetime[I915_MAX_PIPES];
1546 	uint32_t plane[I915_MAX_PIPES][I915_MAX_PLANES][8];
1547 	uint32_t cursor[I915_MAX_PIPES][8];
1548 	uint32_t plane_trans[I915_MAX_PIPES][I915_MAX_PLANES];
1549 	uint32_t cursor_trans[I915_MAX_PIPES];
1550 };
1551 
1552 struct skl_wm_level {
1553 	bool plane_en[I915_MAX_PLANES];
1554 	bool cursor_en;
1555 	uint16_t plane_res_b[I915_MAX_PLANES];
1556 	uint8_t plane_res_l[I915_MAX_PLANES];
1557 	uint16_t cursor_res_b;
1558 	uint8_t cursor_res_l;
1559 };
1560 
1561 /*
1562  * This struct helps tracking the state needed for runtime PM, which puts the
1563  * device in PCI D3 state. Notice that when this happens, nothing on the
1564  * graphics device works, even register access, so we don't get interrupts nor
1565  * anything else.
1566  *
1567  * Every piece of our code that needs to actually touch the hardware needs to
1568  * either call intel_runtime_pm_get or call intel_display_power_get with the
1569  * appropriate power domain.
1570  *
1571  * Our driver uses the autosuspend delay feature, which means we'll only really
1572  * suspend if we stay with zero refcount for a certain amount of time. The
1573  * default value is currently very conservative (see intel_runtime_pm_enable), but
1574  * it can be changed with the standard runtime PM files from sysfs.
1575  *
1576  * The irqs_disabled variable becomes true exactly after we disable the IRQs and
1577  * goes back to false exactly before we reenable the IRQs. We use this variable
1578  * to check if someone is trying to enable/disable IRQs while they're supposed
1579  * to be disabled. This shouldn't happen and we'll print some error messages in
1580  * case it happens.
1581  *
1582  * For more, read the Documentation/power/runtime_pm.txt.
1583  */
1584 struct i915_runtime_pm {
1585 	bool suspended;
1586 	bool irqs_enabled;
1587 };
1588 
1589 enum intel_pipe_crc_source {
1590 	INTEL_PIPE_CRC_SOURCE_NONE,
1591 	INTEL_PIPE_CRC_SOURCE_PLANE1,
1592 	INTEL_PIPE_CRC_SOURCE_PLANE2,
1593 	INTEL_PIPE_CRC_SOURCE_PF,
1594 	INTEL_PIPE_CRC_SOURCE_PIPE,
1595 	/* TV/DP on pre-gen5/vlv can't use the pipe source. */
1596 	INTEL_PIPE_CRC_SOURCE_TV,
1597 	INTEL_PIPE_CRC_SOURCE_DP_B,
1598 	INTEL_PIPE_CRC_SOURCE_DP_C,
1599 	INTEL_PIPE_CRC_SOURCE_DP_D,
1600 	INTEL_PIPE_CRC_SOURCE_AUTO,
1601 	INTEL_PIPE_CRC_SOURCE_MAX,
1602 };
1603 
1604 struct intel_pipe_crc_entry {
1605 	uint32_t frame;
1606 	uint32_t crc[5];
1607 };
1608 
1609 #define INTEL_PIPE_CRC_ENTRIES_NR	128
1610 struct intel_pipe_crc {
1611 	spinlock_t lock;
1612 	bool opened;		/* exclusive access to the result file */
1613 	struct intel_pipe_crc_entry *entries;
1614 	enum intel_pipe_crc_source source;
1615 	int head, tail;
1616 	wait_queue_head_t wq;
1617 };
1618 
1619 struct i915_frontbuffer_tracking {
1620 	struct mutex lock;
1621 
1622 	/*
1623 	 * Tracking bits for delayed frontbuffer flushing du to gpu activity or
1624 	 * scheduled flips.
1625 	 */
1626 	unsigned busy_bits;
1627 	unsigned flip_bits;
1628 };
1629 
1630 struct i915_wa_reg {
1631 	u32 addr;
1632 	u32 value;
1633 	/* bitmask representing WA bits */
1634 	u32 mask;
1635 };
1636 
1637 #define I915_MAX_WA_REGS 16
1638 
1639 struct i915_workarounds {
1640 	struct i915_wa_reg reg[I915_MAX_WA_REGS];
1641 	u32 count;
1642 };
1643 
1644 struct drm_i915_private {
1645 	struct drm_device *dev;
1646 	struct kmem_cache *slab;
1647 
1648 	const struct intel_device_info info;
1649 
1650 	int relative_constants_mode;
1651 
1652 	void __iomem *regs;
1653 
1654 	struct intel_uncore uncore;
1655 
1656 	struct intel_gmbus gmbus[GMBUS_NUM_PORTS];
1657 
1658 
1659 	/** gmbus_mutex protects against concurrent usage of the single hw gmbus
1660 	 * controller on different i2c buses. */
1661 	struct mutex gmbus_mutex;
1662 
1663 	/**
1664 	 * Base address of the gmbus and gpio block.
1665 	 */
1666 	uint32_t gpio_mmio_base;
1667 
1668 	/* MMIO base address for MIPI regs */
1669 	uint32_t mipi_mmio_base;
1670 
1671 	wait_queue_head_t gmbus_wait_queue;
1672 
1673 	struct pci_dev *bridge_dev;
1674 	struct intel_engine_cs ring[I915_NUM_RINGS];
1675 	struct drm_i915_gem_object *semaphore_obj;
1676 	uint32_t last_seqno, next_seqno;
1677 
1678 	struct drm_dma_handle *status_page_dmah;
1679 	struct resource mch_res;
1680 
1681 	/* protects the irq masks */
1682 	spinlock_t irq_lock;
1683 
1684 	/* protects the mmio flip data */
1685 	spinlock_t mmio_flip_lock;
1686 
1687 	bool display_irqs_enabled;
1688 
1689 	/* To control wakeup latency, e.g. for irq-driven dp aux transfers. */
1690 	struct pm_qos_request pm_qos;
1691 
1692 	/* DPIO indirect register protection */
1693 	struct mutex dpio_lock;
1694 
1695 	/** Cached value of IMR to avoid reads in updating the bitfield */
1696 	union {
1697 		u32 irq_mask;
1698 		u32 de_irq_mask[I915_MAX_PIPES];
1699 	};
1700 	u32 gt_irq_mask;
1701 	u32 pm_irq_mask;
1702 	u32 pm_rps_events;
1703 	u32 pipestat_irq_mask[I915_MAX_PIPES];
1704 
1705 	struct work_struct hotplug_work;
1706 	struct {
1707 		unsigned long hpd_last_jiffies;
1708 		int hpd_cnt;
1709 		enum {
1710 			HPD_ENABLED = 0,
1711 			HPD_DISABLED = 1,
1712 			HPD_MARK_DISABLED = 2
1713 		} hpd_mark;
1714 	} hpd_stats[HPD_NUM_PINS];
1715 	u32 hpd_event_bits;
1716 	struct delayed_work hotplug_reenable_work;
1717 
1718 	struct i915_fbc fbc;
1719 	struct i915_drrs drrs;
1720 	struct intel_opregion opregion;
1721 	struct intel_vbt_data vbt;
1722 
1723 	bool preserve_bios_swizzle;
1724 
1725 	/* overlay */
1726 	struct intel_overlay *overlay;
1727 
1728 	/* backlight registers and fields in struct intel_panel */
1729 	struct mutex backlight_lock;
1730 
1731 	/* LVDS info */
1732 	bool no_aux_handshake;
1733 
1734 	/* protects panel power sequencer state */
1735 	struct mutex pps_mutex;
1736 
1737 	struct drm_i915_fence_reg fence_regs[I915_MAX_NUM_FENCES]; /* assume 965 */
1738 	int fence_reg_start; /* 4 if userland hasn't ioctl'd us yet */
1739 	int num_fence_regs; /* 8 on pre-965, 16 otherwise */
1740 
1741 	unsigned int fsb_freq, mem_freq, is_ddr3;
1742 	unsigned int vlv_cdclk_freq;
1743 	unsigned int hpll_freq;
1744 
1745 	/**
1746 	 * wq - Driver workqueue for GEM.
1747 	 *
1748 	 * NOTE: Work items scheduled here are not allowed to grab any modeset
1749 	 * locks, for otherwise the flushing done in the pageflip code will
1750 	 * result in deadlocks.
1751 	 */
1752 	struct workqueue_struct *wq;
1753 
1754 	/* Display functions */
1755 	struct drm_i915_display_funcs display;
1756 
1757 	/* PCH chipset type */
1758 	enum intel_pch pch_type;
1759 	unsigned short pch_id;
1760 
1761 	unsigned long quirks;
1762 
1763 	enum modeset_restore modeset_restore;
1764 	struct mutex modeset_restore_lock;
1765 
1766 	struct list_head vm_list; /* Global list of all address spaces */
1767 	struct i915_gtt gtt; /* VM representing the global address space */
1768 
1769 	struct i915_gem_mm mm;
1770 	DECLARE_HASHTABLE(mm_structs, 7);
1771 	struct mutex mm_lock;
1772 
1773 	/* Kernel Modesetting */
1774 
1775 	struct sdvo_device_mapping sdvo_mappings[2];
1776 
1777 	struct drm_crtc *plane_to_crtc_mapping[I915_MAX_PIPES];
1778 	struct drm_crtc *pipe_to_crtc_mapping[I915_MAX_PIPES];
1779 	wait_queue_head_t pending_flip_queue;
1780 
1781 #ifdef CONFIG_DEBUG_FS
1782 	struct intel_pipe_crc pipe_crc[I915_MAX_PIPES];
1783 #endif
1784 
1785 	int num_shared_dpll;
1786 	struct intel_shared_dpll shared_dplls[I915_NUM_PLLS];
1787 	int dpio_phy_iosf_port[I915_NUM_PHYS_VLV];
1788 
1789 	struct i915_workarounds workarounds;
1790 
1791 	/* Reclocking support */
1792 	bool render_reclock_avail;
1793 	bool lvds_downclock_avail;
1794 	/* indicates the reduced downclock for LVDS*/
1795 	int lvds_downclock;
1796 
1797 	struct i915_frontbuffer_tracking fb_tracking;
1798 
1799 	u16 orig_clock;
1800 
1801 	bool mchbar_need_disable;
1802 
1803 	struct intel_l3_parity l3_parity;
1804 
1805 	/* Cannot be determined by PCIID. You must always read a register. */
1806 	size_t ellc_size;
1807 
1808 	/* gen6+ rps state */
1809 	struct intel_gen6_power_mgmt rps;
1810 
1811 	/* ilk-only ips/rps state. Everything in here is protected by the global
1812 	 * mchdev_lock in intel_pm.c */
1813 	struct intel_ilk_power_mgmt ips;
1814 
1815 	struct i915_power_domains power_domains;
1816 
1817 	struct i915_psr psr;
1818 
1819 	struct i915_gpu_error gpu_error;
1820 
1821 	struct drm_i915_gem_object *vlv_pctx;
1822 
1823 #ifdef CONFIG_DRM_I915_FBDEV
1824 	/* list of fbdev register on this device */
1825 	struct intel_fbdev *fbdev;
1826 	struct work_struct fbdev_suspend_work;
1827 #endif
1828 
1829 	struct drm_property *broadcast_rgb_property;
1830 	struct drm_property *force_audio_property;
1831 
1832 	/* hda/i915 audio component */
1833 	bool audio_component_registered;
1834 
1835 	uint32_t hw_context_size;
1836 	struct list_head context_list;
1837 
1838 	u32 fdi_rx_config;
1839 
1840 	u32 suspend_count;
1841 	struct i915_suspend_saved_registers regfile;
1842 	struct vlv_s0ix_state vlv_s0ix_state;
1843 
1844 	struct {
1845 		/*
1846 		 * Raw watermark latency values:
1847 		 * in 0.1us units for WM0,
1848 		 * in 0.5us units for WM1+.
1849 		 */
1850 		/* primary */
1851 		uint16_t pri_latency[5];
1852 		/* sprite */
1853 		uint16_t spr_latency[5];
1854 		/* cursor */
1855 		uint16_t cur_latency[5];
1856 		/*
1857 		 * Raw watermark memory latency values
1858 		 * for SKL for all 8 levels
1859 		 * in 1us units.
1860 		 */
1861 		uint16_t skl_latency[8];
1862 
1863 		/*
1864 		 * The skl_wm_values structure is a bit too big for stack
1865 		 * allocation, so we keep the staging struct where we store
1866 		 * intermediate results here instead.
1867 		 */
1868 		struct skl_wm_values skl_results;
1869 
1870 		/* current hardware state */
1871 		union {
1872 			struct ilk_wm_values hw;
1873 			struct skl_wm_values skl_hw;
1874 		};
1875 	} wm;
1876 
1877 	struct i915_runtime_pm pm;
1878 
1879 	struct intel_digital_port *hpd_irq_port[I915_MAX_PORTS];
1880 	u32 long_hpd_port_mask;
1881 	u32 short_hpd_port_mask;
1882 	struct work_struct dig_port_work;
1883 
1884 	/*
1885 	 * if we get a HPD irq from DP and a HPD irq from non-DP
1886 	 * the non-DP HPD could block the workqueue on a mode config
1887 	 * mutex getting, that userspace may have taken. However
1888 	 * userspace is waiting on the DP workqueue to run which is
1889 	 * blocked behind the non-DP one.
1890 	 */
1891 	struct workqueue_struct *dp_wq;
1892 
1893 	/* Abstract the submission mechanism (legacy ringbuffer or execlists) away */
1894 	struct {
1895 		int (*do_execbuf)(struct drm_device *dev, struct drm_file *file,
1896 				  struct intel_engine_cs *ring,
1897 				  struct intel_context *ctx,
1898 				  struct drm_i915_gem_execbuffer2 *args,
1899 				  struct list_head *vmas,
1900 				  struct drm_i915_gem_object *batch_obj,
1901 				  u64 exec_start, u32 flags);
1902 		int (*init_rings)(struct drm_device *dev);
1903 		void (*cleanup_ring)(struct intel_engine_cs *ring);
1904 		void (*stop_ring)(struct intel_engine_cs *ring);
1905 	} gt;
1906 
1907 	uint32_t request_uniq;
1908 
1909 	/*
1910 	 * NOTE: This is the dri1/ums dungeon, don't add stuff here. Your patch
1911 	 * will be rejected. Instead look for a better place.
1912 	 */
1913 };
1914 
1915 static inline struct drm_i915_private *to_i915(const struct drm_device *dev)
1916 {
1917 	return dev->dev_private;
1918 }
1919 
1920 static inline struct drm_i915_private *dev_to_i915(struct device *dev)
1921 {
1922 	return to_i915(dev_get_drvdata(dev));
1923 }
1924 
1925 /* Iterate over initialised rings */
1926 #define for_each_ring(ring__, dev_priv__, i__) \
1927 	for ((i__) = 0; (i__) < I915_NUM_RINGS; (i__)++) \
1928 		if (((ring__) = &(dev_priv__)->ring[(i__)]), intel_ring_initialized((ring__)))
1929 
1930 enum hdmi_force_audio {
1931 	HDMI_AUDIO_OFF_DVI = -2,	/* no aux data for HDMI-DVI converter */
1932 	HDMI_AUDIO_OFF,			/* force turn off HDMI audio */
1933 	HDMI_AUDIO_AUTO,		/* trust EDID */
1934 	HDMI_AUDIO_ON,			/* force turn on HDMI audio */
1935 };
1936 
1937 #define I915_GTT_OFFSET_NONE ((u32)-1)
1938 
1939 struct drm_i915_gem_object_ops {
1940 	/* Interface between the GEM object and its backing storage.
1941 	 * get_pages() is called once prior to the use of the associated set
1942 	 * of pages before to binding them into the GTT, and put_pages() is
1943 	 * called after we no longer need them. As we expect there to be
1944 	 * associated cost with migrating pages between the backing storage
1945 	 * and making them available for the GPU (e.g. clflush), we may hold
1946 	 * onto the pages after they are no longer referenced by the GPU
1947 	 * in case they may be used again shortly (for example migrating the
1948 	 * pages to a different memory domain within the GTT). put_pages()
1949 	 * will therefore most likely be called when the object itself is
1950 	 * being released or under memory pressure (where we attempt to
1951 	 * reap pages for the shrinker).
1952 	 */
1953 	int (*get_pages)(struct drm_i915_gem_object *);
1954 	void (*put_pages)(struct drm_i915_gem_object *);
1955 	int (*dmabuf_export)(struct drm_i915_gem_object *);
1956 	void (*release)(struct drm_i915_gem_object *);
1957 };
1958 
1959 /*
1960  * Frontbuffer tracking bits. Set in obj->frontbuffer_bits while a gem bo is
1961  * considered to be the frontbuffer for the given plane interface-vise. This
1962  * doesn't mean that the hw necessarily already scans it out, but that any
1963  * rendering (by the cpu or gpu) will land in the frontbuffer eventually.
1964  *
1965  * We have one bit per pipe and per scanout plane type.
1966  */
1967 #define INTEL_FRONTBUFFER_BITS_PER_PIPE 4
1968 #define INTEL_FRONTBUFFER_BITS \
1969 	(INTEL_FRONTBUFFER_BITS_PER_PIPE * I915_MAX_PIPES)
1970 #define INTEL_FRONTBUFFER_PRIMARY(pipe) \
1971 	(1 << (INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe)))
1972 #define INTEL_FRONTBUFFER_CURSOR(pipe) \
1973 	(1 << (1 +(INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))))
1974 #define INTEL_FRONTBUFFER_SPRITE(pipe) \
1975 	(1 << (2 +(INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))))
1976 #define INTEL_FRONTBUFFER_OVERLAY(pipe) \
1977 	(1 << (3 +(INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe))))
1978 #define INTEL_FRONTBUFFER_ALL_MASK(pipe) \
1979 	(0xf << (INTEL_FRONTBUFFER_BITS_PER_PIPE * (pipe)))
1980 
1981 struct drm_i915_gem_object {
1982 	struct drm_gem_object base;
1983 
1984 	const struct drm_i915_gem_object_ops *ops;
1985 
1986 	/** List of VMAs backed by this object */
1987 	struct list_head vma_list;
1988 
1989 	/** Stolen memory for this object, instead of being backed by shmem. */
1990 	struct drm_mm_node *stolen;
1991 	struct list_head global_list;
1992 
1993 	struct list_head ring_list;
1994 	/** Used in execbuf to temporarily hold a ref */
1995 	struct list_head obj_exec_link;
1996 
1997 	struct list_head batch_pool_list;
1998 
1999 	/**
2000 	 * This is set if the object is on the active lists (has pending
2001 	 * rendering and so a non-zero seqno), and is not set if it i s on
2002 	 * inactive (ready to be unbound) list.
2003 	 */
2004 	unsigned int active:1;
2005 
2006 	/**
2007 	 * This is set if the object has been written to since last bound
2008 	 * to the GTT
2009 	 */
2010 	unsigned int dirty:1;
2011 
2012 	/**
2013 	 * Fence register bits (if any) for this object.  Will be set
2014 	 * as needed when mapped into the GTT.
2015 	 * Protected by dev->struct_mutex.
2016 	 */
2017 	signed int fence_reg:I915_MAX_NUM_FENCE_BITS;
2018 
2019 	/**
2020 	 * Advice: are the backing pages purgeable?
2021 	 */
2022 	unsigned int madv:2;
2023 
2024 	/**
2025 	 * Current tiling mode for the object.
2026 	 */
2027 	unsigned int tiling_mode:2;
2028 	/**
2029 	 * Whether the tiling parameters for the currently associated fence
2030 	 * register have changed. Note that for the purposes of tracking
2031 	 * tiling changes we also treat the unfenced register, the register
2032 	 * slot that the object occupies whilst it executes a fenced
2033 	 * command (such as BLT on gen2/3), as a "fence".
2034 	 */
2035 	unsigned int fence_dirty:1;
2036 
2037 	/**
2038 	 * Is the object at the current location in the gtt mappable and
2039 	 * fenceable? Used to avoid costly recalculations.
2040 	 */
2041 	unsigned int map_and_fenceable:1;
2042 
2043 	/**
2044 	 * Whether the current gtt mapping needs to be mappable (and isn't just
2045 	 * mappable by accident). Track pin and fault separate for a more
2046 	 * accurate mappable working set.
2047 	 */
2048 	unsigned int fault_mappable:1;
2049 	unsigned int pin_mappable:1;
2050 	unsigned int pin_display:1;
2051 
2052 	/*
2053 	 * Is the object to be mapped as read-only to the GPU
2054 	 * Only honoured if hardware has relevant pte bit
2055 	 */
2056 	unsigned long gt_ro:1;
2057 	unsigned int cache_level:3;
2058 	unsigned int cache_dirty:1;
2059 
2060 	unsigned int has_dma_mapping:1;
2061 
2062 	unsigned int frontbuffer_bits:INTEL_FRONTBUFFER_BITS;
2063 
2064 	struct sg_table *pages;
2065 	int pages_pin_count;
2066 
2067 	/* prime dma-buf support */
2068 	void *dma_buf_vmapping;
2069 	int vmapping_count;
2070 
2071 	/** Breadcrumb of last rendering to the buffer. */
2072 	struct drm_i915_gem_request *last_read_req;
2073 	struct drm_i915_gem_request *last_write_req;
2074 	/** Breadcrumb of last fenced GPU access to the buffer. */
2075 	struct drm_i915_gem_request *last_fenced_req;
2076 
2077 	/** Current tiling stride for the object, if it's tiled. */
2078 	uint32_t stride;
2079 
2080 	/** References from framebuffers, locks out tiling changes. */
2081 	unsigned long framebuffer_references;
2082 
2083 	/** Record of address bit 17 of each page at last unbind. */
2084 	unsigned long *bit_17;
2085 
2086 	union {
2087 		/** for phy allocated objects */
2088 		struct drm_dma_handle *phys_handle;
2089 
2090 		struct i915_gem_userptr {
2091 			uintptr_t ptr;
2092 			unsigned read_only :1;
2093 			unsigned workers :4;
2094 #define I915_GEM_USERPTR_MAX_WORKERS 15
2095 
2096 			struct i915_mm_struct *mm;
2097 			struct i915_mmu_object *mmu_object;
2098 			struct work_struct *work;
2099 		} userptr;
2100 	};
2101 };
2102 #define to_intel_bo(x) container_of(x, struct drm_i915_gem_object, base)
2103 
2104 void i915_gem_track_fb(struct drm_i915_gem_object *old,
2105 		       struct drm_i915_gem_object *new,
2106 		       unsigned frontbuffer_bits);
2107 
2108 /**
2109  * Request queue structure.
2110  *
2111  * The request queue allows us to note sequence numbers that have been emitted
2112  * and may be associated with active buffers to be retired.
2113  *
2114  * By keeping this list, we can avoid having to do questionable sequence
2115  * number comparisons on buffer last_read|write_seqno. It also allows an
2116  * emission time to be associated with the request for tracking how far ahead
2117  * of the GPU the submission is.
2118  *
2119  * The requests are reference counted, so upon creation they should have an
2120  * initial reference taken using kref_init
2121  */
2122 struct drm_i915_gem_request {
2123 	struct kref ref;
2124 
2125 	/** On Which ring this request was generated */
2126 	struct intel_engine_cs *ring;
2127 
2128 	/** GEM sequence number associated with this request. */
2129 	uint32_t seqno;
2130 
2131 	/** Position in the ringbuffer of the start of the request */
2132 	u32 head;
2133 
2134 	/**
2135 	 * Position in the ringbuffer of the start of the postfix.
2136 	 * This is required to calculate the maximum available ringbuffer
2137 	 * space without overwriting the postfix.
2138 	 */
2139 	 u32 postfix;
2140 
2141 	/** Position in the ringbuffer of the end of the whole request */
2142 	u32 tail;
2143 
2144 	/**
2145 	 * Context related to this request
2146 	 * Contexts are refcounted, so when this request is associated with a
2147 	 * context, we must increment the context's refcount, to guarantee that
2148 	 * it persists while any request is linked to it. Requests themselves
2149 	 * are also refcounted, so the request will only be freed when the last
2150 	 * reference to it is dismissed, and the code in
2151 	 * i915_gem_request_free() will then decrement the refcount on the
2152 	 * context.
2153 	 */
2154 	struct intel_context *ctx;
2155 
2156 	/** Batch buffer related to this request if any */
2157 	struct drm_i915_gem_object *batch_obj;
2158 
2159 	/** Time at which this request was emitted, in jiffies. */
2160 	unsigned long emitted_jiffies;
2161 
2162 	/** global list entry for this request */
2163 	struct list_head list;
2164 
2165 	struct drm_i915_file_private *file_priv;
2166 	/** file_priv list entry for this request */
2167 	struct list_head client_list;
2168 
2169 	uint32_t uniq;
2170 
2171 	/**
2172 	 * The ELSP only accepts two elements at a time, so we queue
2173 	 * context/tail pairs on a given queue (ring->execlist_queue) until the
2174 	 * hardware is available. The queue serves a double purpose: we also use
2175 	 * it to keep track of the up to 2 contexts currently in the hardware
2176 	 * (usually one in execution and the other queued up by the GPU): We
2177 	 * only remove elements from the head of the queue when the hardware
2178 	 * informs us that an element has been completed.
2179 	 *
2180 	 * All accesses to the queue are mediated by a spinlock
2181 	 * (ring->execlist_lock).
2182 	 */
2183 
2184 	/** Execlist link in the submission queue.*/
2185 	struct list_head execlist_link;
2186 
2187 	/** Execlists no. of times this request has been sent to the ELSP */
2188 	int elsp_submitted;
2189 
2190 };
2191 
2192 void i915_gem_request_free(struct kref *req_ref);
2193 
2194 static inline uint32_t
2195 i915_gem_request_get_seqno(struct drm_i915_gem_request *req)
2196 {
2197 	return req ? req->seqno : 0;
2198 }
2199 
2200 static inline struct intel_engine_cs *
2201 i915_gem_request_get_ring(struct drm_i915_gem_request *req)
2202 {
2203 	return req ? req->ring : NULL;
2204 }
2205 
2206 static inline void
2207 i915_gem_request_reference(struct drm_i915_gem_request *req)
2208 {
2209 	kref_get(&req->ref);
2210 }
2211 
2212 static inline void
2213 i915_gem_request_unreference(struct drm_i915_gem_request *req)
2214 {
2215 	WARN_ON(!mutex_is_locked(&req->ring->dev->struct_mutex));
2216 	kref_put(&req->ref, i915_gem_request_free);
2217 }
2218 
2219 static inline void i915_gem_request_assign(struct drm_i915_gem_request **pdst,
2220 					   struct drm_i915_gem_request *src)
2221 {
2222 	if (src)
2223 		i915_gem_request_reference(src);
2224 
2225 	if (*pdst)
2226 		i915_gem_request_unreference(*pdst);
2227 
2228 	*pdst = src;
2229 }
2230 
2231 /*
2232  * XXX: i915_gem_request_completed should be here but currently needs the
2233  * definition of i915_seqno_passed() which is below. It will be moved in
2234  * a later patch when the call to i915_seqno_passed() is obsoleted...
2235  */
2236 
2237 struct drm_i915_file_private {
2238 	struct drm_i915_private *dev_priv;
2239 	struct drm_file *file;
2240 
2241 	struct {
2242 		spinlock_t lock;
2243 		struct list_head request_list;
2244 		struct delayed_work idle_work;
2245 	} mm;
2246 	struct idr context_idr;
2247 
2248 	atomic_t rps_wait_boost;
2249 	struct  intel_engine_cs *bsd_ring;
2250 };
2251 
2252 /*
2253  * A command that requires special handling by the command parser.
2254  */
2255 struct drm_i915_cmd_descriptor {
2256 	/*
2257 	 * Flags describing how the command parser processes the command.
2258 	 *
2259 	 * CMD_DESC_FIXED: The command has a fixed length if this is set,
2260 	 *                 a length mask if not set
2261 	 * CMD_DESC_SKIP: The command is allowed but does not follow the
2262 	 *                standard length encoding for the opcode range in
2263 	 *                which it falls
2264 	 * CMD_DESC_REJECT: The command is never allowed
2265 	 * CMD_DESC_REGISTER: The command should be checked against the
2266 	 *                    register whitelist for the appropriate ring
2267 	 * CMD_DESC_MASTER: The command is allowed if the submitting process
2268 	 *                  is the DRM master
2269 	 */
2270 	u32 flags;
2271 #define CMD_DESC_FIXED    (1<<0)
2272 #define CMD_DESC_SKIP     (1<<1)
2273 #define CMD_DESC_REJECT   (1<<2)
2274 #define CMD_DESC_REGISTER (1<<3)
2275 #define CMD_DESC_BITMASK  (1<<4)
2276 #define CMD_DESC_MASTER   (1<<5)
2277 
2278 	/*
2279 	 * The command's unique identification bits and the bitmask to get them.
2280 	 * This isn't strictly the opcode field as defined in the spec and may
2281 	 * also include type, subtype, and/or subop fields.
2282 	 */
2283 	struct {
2284 		u32 value;
2285 		u32 mask;
2286 	} cmd;
2287 
2288 	/*
2289 	 * The command's length. The command is either fixed length (i.e. does
2290 	 * not include a length field) or has a length field mask. The flag
2291 	 * CMD_DESC_FIXED indicates a fixed length. Otherwise, the command has
2292 	 * a length mask. All command entries in a command table must include
2293 	 * length information.
2294 	 */
2295 	union {
2296 		u32 fixed;
2297 		u32 mask;
2298 	} length;
2299 
2300 	/*
2301 	 * Describes where to find a register address in the command to check
2302 	 * against the ring's register whitelist. Only valid if flags has the
2303 	 * CMD_DESC_REGISTER bit set.
2304 	 */
2305 	struct {
2306 		u32 offset;
2307 		u32 mask;
2308 	} reg;
2309 
2310 #define MAX_CMD_DESC_BITMASKS 3
2311 	/*
2312 	 * Describes command checks where a particular dword is masked and
2313 	 * compared against an expected value. If the command does not match
2314 	 * the expected value, the parser rejects it. Only valid if flags has
2315 	 * the CMD_DESC_BITMASK bit set. Only entries where mask is non-zero
2316 	 * are valid.
2317 	 *
2318 	 * If the check specifies a non-zero condition_mask then the parser
2319 	 * only performs the check when the bits specified by condition_mask
2320 	 * are non-zero.
2321 	 */
2322 	struct {
2323 		u32 offset;
2324 		u32 mask;
2325 		u32 expected;
2326 		u32 condition_offset;
2327 		u32 condition_mask;
2328 	} bits[MAX_CMD_DESC_BITMASKS];
2329 };
2330 
2331 /*
2332  * A table of commands requiring special handling by the command parser.
2333  *
2334  * Each ring has an array of tables. Each table consists of an array of command
2335  * descriptors, which must be sorted with command opcodes in ascending order.
2336  */
2337 struct drm_i915_cmd_table {
2338 	const struct drm_i915_cmd_descriptor *table;
2339 	int count;
2340 };
2341 
2342 /* Note that the (struct drm_i915_private *) cast is just to shut up gcc. */
2343 #define __I915__(p) ({ \
2344 	struct drm_i915_private *__p; \
2345 	if (__builtin_types_compatible_p(typeof(*p), struct drm_i915_private)) \
2346 		__p = (struct drm_i915_private *)p; \
2347 	else if (__builtin_types_compatible_p(typeof(*p), struct drm_device)) \
2348 		__p = to_i915((struct drm_device *)p); \
2349 	else \
2350 		BUILD_BUG(); \
2351 	__p; \
2352 })
2353 #define INTEL_INFO(p) 	(&__I915__(p)->info)
2354 #define INTEL_DEVID(p)	(INTEL_INFO(p)->device_id)
2355 
2356 #define IS_I830(dev)		(INTEL_DEVID(dev) == 0x3577)
2357 #define IS_845G(dev)		(INTEL_DEVID(dev) == 0x2562)
2358 #define IS_I85X(dev)		(INTEL_INFO(dev)->is_i85x)
2359 #define IS_I865G(dev)		(INTEL_DEVID(dev) == 0x2572)
2360 #define IS_I915G(dev)		(INTEL_INFO(dev)->is_i915g)
2361 #define IS_I915GM(dev)		(INTEL_DEVID(dev) == 0x2592)
2362 #define IS_I945G(dev)		(INTEL_DEVID(dev) == 0x2772)
2363 #define IS_I945GM(dev)		(INTEL_INFO(dev)->is_i945gm)
2364 #define IS_BROADWATER(dev)	(INTEL_INFO(dev)->is_broadwater)
2365 #define IS_CRESTLINE(dev)	(INTEL_INFO(dev)->is_crestline)
2366 #define IS_GM45(dev)		(INTEL_DEVID(dev) == 0x2A42)
2367 #define IS_G4X(dev)		(INTEL_INFO(dev)->is_g4x)
2368 #define IS_PINEVIEW_G(dev)	(INTEL_DEVID(dev) == 0xa001)
2369 #define IS_PINEVIEW_M(dev)	(INTEL_DEVID(dev) == 0xa011)
2370 #define IS_PINEVIEW(dev)	(INTEL_INFO(dev)->is_pineview)
2371 #define IS_G33(dev)		(INTEL_INFO(dev)->is_g33)
2372 #define IS_IRONLAKE_M(dev)	(INTEL_DEVID(dev) == 0x0046)
2373 #define IS_IVYBRIDGE(dev)	(INTEL_INFO(dev)->is_ivybridge)
2374 #define IS_IVB_GT1(dev)		(INTEL_DEVID(dev) == 0x0156 || \
2375 				 INTEL_DEVID(dev) == 0x0152 || \
2376 				 INTEL_DEVID(dev) == 0x015a)
2377 #define IS_SNB_GT1(dev)		(INTEL_DEVID(dev) == 0x0102 || \
2378 				 INTEL_DEVID(dev) == 0x0106 || \
2379 				 INTEL_DEVID(dev) == 0x010A)
2380 #define IS_VALLEYVIEW(dev)	(INTEL_INFO(dev)->is_valleyview)
2381 #define IS_CHERRYVIEW(dev)	(INTEL_INFO(dev)->is_valleyview && IS_GEN8(dev))
2382 #define IS_HASWELL(dev)	(INTEL_INFO(dev)->is_haswell)
2383 #define IS_BROADWELL(dev)	(!INTEL_INFO(dev)->is_valleyview && IS_GEN8(dev))
2384 #define IS_SKYLAKE(dev)	(INTEL_INFO(dev)->is_skylake)
2385 #define IS_MOBILE(dev)		(INTEL_INFO(dev)->is_mobile)
2386 #define IS_HSW_EARLY_SDV(dev)	(IS_HASWELL(dev) && \
2387 				 (INTEL_DEVID(dev) & 0xFF00) == 0x0C00)
2388 #define IS_BDW_ULT(dev)		(IS_BROADWELL(dev) && \
2389 				 ((INTEL_DEVID(dev) & 0xf) == 0x6 ||	\
2390 				 (INTEL_DEVID(dev) & 0xf) == 0xb ||	\
2391 				 (INTEL_DEVID(dev) & 0xf) == 0xe))
2392 #define IS_BDW_GT3(dev)		(IS_BROADWELL(dev) && \
2393 				 (INTEL_DEVID(dev) & 0x00F0) == 0x0020)
2394 #define IS_HSW_ULT(dev)		(IS_HASWELL(dev) && \
2395 				 (INTEL_DEVID(dev) & 0xFF00) == 0x0A00)
2396 #define IS_HSW_GT3(dev)		(IS_HASWELL(dev) && \
2397 				 (INTEL_DEVID(dev) & 0x00F0) == 0x0020)
2398 /* ULX machines are also considered ULT. */
2399 #define IS_HSW_ULX(dev)		(INTEL_DEVID(dev) == 0x0A0E || \
2400 				 INTEL_DEVID(dev) == 0x0A1E)
2401 #define IS_PRELIMINARY_HW(intel_info) ((intel_info)->is_preliminary)
2402 
2403 /*
2404  * The genX designation typically refers to the render engine, so render
2405  * capability related checks should use IS_GEN, while display and other checks
2406  * have their own (e.g. HAS_PCH_SPLIT for ILK+ display, IS_foo for particular
2407  * chips, etc.).
2408  */
2409 #define IS_GEN2(dev)	(INTEL_INFO(dev)->gen == 2)
2410 #define IS_GEN3(dev)	(INTEL_INFO(dev)->gen == 3)
2411 #define IS_GEN4(dev)	(INTEL_INFO(dev)->gen == 4)
2412 #define IS_GEN5(dev)	(INTEL_INFO(dev)->gen == 5)
2413 #define IS_GEN6(dev)	(INTEL_INFO(dev)->gen == 6)
2414 #define IS_GEN7(dev)	(INTEL_INFO(dev)->gen == 7)
2415 #define IS_GEN8(dev)	(INTEL_INFO(dev)->gen == 8)
2416 #define IS_GEN9(dev)	(INTEL_INFO(dev)->gen == 9)
2417 
2418 #define RENDER_RING		(1<<RCS)
2419 #define BSD_RING		(1<<VCS)
2420 #define BLT_RING		(1<<BCS)
2421 #define VEBOX_RING		(1<<VECS)
2422 #define BSD2_RING		(1<<VCS2)
2423 #define HAS_BSD(dev)		(INTEL_INFO(dev)->ring_mask & BSD_RING)
2424 #define HAS_BSD2(dev)		(INTEL_INFO(dev)->ring_mask & BSD2_RING)
2425 #define HAS_BLT(dev)		(INTEL_INFO(dev)->ring_mask & BLT_RING)
2426 #define HAS_VEBOX(dev)		(INTEL_INFO(dev)->ring_mask & VEBOX_RING)
2427 #define HAS_LLC(dev)		(INTEL_INFO(dev)->has_llc)
2428 #define HAS_WT(dev)		((IS_HASWELL(dev) || IS_BROADWELL(dev)) && \
2429 				 __I915__(dev)->ellc_size)
2430 #define I915_NEED_GFX_HWS(dev)	(INTEL_INFO(dev)->need_gfx_hws)
2431 
2432 #define HAS_HW_CONTEXTS(dev)	(INTEL_INFO(dev)->gen >= 6)
2433 #define HAS_LOGICAL_RING_CONTEXTS(dev)	(INTEL_INFO(dev)->gen >= 8)
2434 #define USES_PPGTT(dev)		(i915.enable_ppgtt)
2435 #define USES_FULL_PPGTT(dev)	(i915.enable_ppgtt == 2)
2436 
2437 #define HAS_OVERLAY(dev)		(INTEL_INFO(dev)->has_overlay)
2438 #define OVERLAY_NEEDS_PHYSICAL(dev)	(INTEL_INFO(dev)->overlay_needs_physical)
2439 
2440 /* Early gen2 have a totally busted CS tlb and require pinned batches. */
2441 #define HAS_BROKEN_CS_TLB(dev)		(IS_I830(dev) || IS_845G(dev))
2442 /*
2443  * dp aux and gmbus irq on gen4 seems to be able to generate legacy interrupts
2444  * even when in MSI mode. This results in spurious interrupt warnings if the
2445  * legacy irq no. is shared with another device. The kernel then disables that
2446  * interrupt source and so prevents the other device from working properly.
2447  */
2448 #define HAS_AUX_IRQ(dev) (INTEL_INFO(dev)->gen >= 5)
2449 #define HAS_GMBUS_IRQ(dev) (INTEL_INFO(dev)->gen >= 5)
2450 
2451 /* With the 945 and later, Y tiling got adjusted so that it was 32 128-byte
2452  * rows, which changed the alignment requirements and fence programming.
2453  */
2454 #define HAS_128_BYTE_Y_TILING(dev) (!IS_GEN2(dev) && !(IS_I915G(dev) || \
2455 						      IS_I915GM(dev)))
2456 #define SUPPORTS_DIGITAL_OUTPUTS(dev)	(!IS_GEN2(dev) && !IS_PINEVIEW(dev))
2457 #define SUPPORTS_INTEGRATED_HDMI(dev)	(IS_G4X(dev) || IS_GEN5(dev))
2458 #define SUPPORTS_INTEGRATED_DP(dev)	(IS_G4X(dev) || IS_GEN5(dev))
2459 #define SUPPORTS_TV(dev)		(INTEL_INFO(dev)->supports_tv)
2460 #define I915_HAS_HOTPLUG(dev)		 (INTEL_INFO(dev)->has_hotplug)
2461 
2462 #define HAS_FW_BLC(dev) (INTEL_INFO(dev)->gen > 2)
2463 #define HAS_PIPE_CXSR(dev) (INTEL_INFO(dev)->has_pipe_cxsr)
2464 #define HAS_FBC(dev) (INTEL_INFO(dev)->has_fbc)
2465 
2466 #define HAS_IPS(dev)		(IS_HSW_ULT(dev) || IS_BROADWELL(dev))
2467 
2468 #define HAS_DDI(dev)		(INTEL_INFO(dev)->has_ddi)
2469 #define HAS_FPGA_DBG_UNCLAIMED(dev)	(INTEL_INFO(dev)->has_fpga_dbg)
2470 #define HAS_PSR(dev)		(IS_HASWELL(dev) || IS_BROADWELL(dev) || \
2471 				 IS_VALLEYVIEW(dev) || IS_CHERRYVIEW(dev) || \
2472 				 IS_SKYLAKE(dev))
2473 #define HAS_RUNTIME_PM(dev)	(IS_GEN6(dev) || IS_HASWELL(dev) || \
2474 				 IS_BROADWELL(dev) || IS_VALLEYVIEW(dev))
2475 #define HAS_RC6(dev)		(INTEL_INFO(dev)->gen >= 6)
2476 #define HAS_RC6p(dev)		(INTEL_INFO(dev)->gen == 6 || IS_IVYBRIDGE(dev))
2477 
2478 #define INTEL_PCH_DEVICE_ID_MASK		0xff00
2479 #define INTEL_PCH_IBX_DEVICE_ID_TYPE		0x3b00
2480 #define INTEL_PCH_CPT_DEVICE_ID_TYPE		0x1c00
2481 #define INTEL_PCH_PPT_DEVICE_ID_TYPE		0x1e00
2482 #define INTEL_PCH_LPT_DEVICE_ID_TYPE		0x8c00
2483 #define INTEL_PCH_LPT_LP_DEVICE_ID_TYPE		0x9c00
2484 #define INTEL_PCH_SPT_DEVICE_ID_TYPE		0xA100
2485 #define INTEL_PCH_SPT_LP_DEVICE_ID_TYPE		0x9D00
2486 
2487 #define INTEL_PCH_TYPE(dev) (__I915__(dev)->pch_type)
2488 #define HAS_PCH_SPT(dev) (INTEL_PCH_TYPE(dev) == PCH_SPT)
2489 #define HAS_PCH_LPT(dev) (INTEL_PCH_TYPE(dev) == PCH_LPT)
2490 #define HAS_PCH_CPT(dev) (INTEL_PCH_TYPE(dev) == PCH_CPT)
2491 #define HAS_PCH_IBX(dev) (INTEL_PCH_TYPE(dev) == PCH_IBX)
2492 #define HAS_PCH_NOP(dev) (INTEL_PCH_TYPE(dev) == PCH_NOP)
2493 #define HAS_PCH_SPLIT(dev) (INTEL_PCH_TYPE(dev) != PCH_NONE)
2494 
2495 #define HAS_GMCH_DISPLAY(dev) (INTEL_INFO(dev)->gen < 5 || IS_VALLEYVIEW(dev))
2496 
2497 /* DPF == dynamic parity feature */
2498 #define HAS_L3_DPF(dev) (IS_IVYBRIDGE(dev) || IS_HASWELL(dev))
2499 #define NUM_L3_SLICES(dev) (IS_HSW_GT3(dev) ? 2 : HAS_L3_DPF(dev))
2500 
2501 #define GT_FREQUENCY_MULTIPLIER 50
2502 
2503 #include "i915_trace.h"
2504 
2505 extern const struct drm_ioctl_desc i915_ioctls[];
2506 extern int i915_max_ioctl;
2507 
2508 extern int i915_suspend_legacy(struct drm_device *dev, pm_message_t state);
2509 extern int i915_resume_legacy(struct drm_device *dev);
2510 extern int i915_master_create(struct drm_device *dev, struct drm_master *master);
2511 extern void i915_master_destroy(struct drm_device *dev, struct drm_master *master);
2512 
2513 /* i915_params.c */
2514 struct i915_params {
2515 	int modeset;
2516 	int panel_ignore_lid;
2517 	unsigned int powersave;
2518 	int semaphores;
2519 	unsigned int lvds_downclock;
2520 	int lvds_channel_mode;
2521 	int panel_use_ssc;
2522 	int vbt_sdvo_panel_type;
2523 	int enable_rc6;
2524 	int enable_fbc;
2525 	int enable_ppgtt;
2526 	int enable_execlists;
2527 	int enable_psr;
2528 	unsigned int preliminary_hw_support;
2529 	int disable_power_well;
2530 	int enable_ips;
2531 	int invert_brightness;
2532 	int enable_cmd_parser;
2533 	/* leave bools at the end to not create holes */
2534 	bool enable_hangcheck;
2535 	bool fastboot;
2536 	bool prefault_disable;
2537 	bool reset;
2538 	bool disable_display;
2539 	bool disable_vtd_wa;
2540 	int use_mmio_flip;
2541 	bool mmio_debug;
2542 	bool verbose_state_checks;
2543 	bool nuclear_pageflip;
2544 };
2545 extern struct i915_params i915 __read_mostly;
2546 
2547 				/* i915_dma.c */
2548 extern int i915_driver_load(struct drm_device *, unsigned long flags);
2549 extern int i915_driver_unload(struct drm_device *);
2550 extern int i915_driver_open(struct drm_device *dev, struct drm_file *file);
2551 extern void i915_driver_lastclose(struct drm_device * dev);
2552 extern void i915_driver_preclose(struct drm_device *dev,
2553 				 struct drm_file *file);
2554 extern void i915_driver_postclose(struct drm_device *dev,
2555 				  struct drm_file *file);
2556 extern int i915_driver_device_is_agp(struct drm_device * dev);
2557 #ifdef CONFIG_COMPAT
2558 extern long i915_compat_ioctl(struct file *filp, unsigned int cmd,
2559 			      unsigned long arg);
2560 #endif
2561 extern int intel_gpu_reset(struct drm_device *dev);
2562 extern int i915_reset(struct drm_device *dev);
2563 extern unsigned long i915_chipset_val(struct drm_i915_private *dev_priv);
2564 extern unsigned long i915_mch_val(struct drm_i915_private *dev_priv);
2565 extern unsigned long i915_gfx_val(struct drm_i915_private *dev_priv);
2566 extern void i915_update_gfx_val(struct drm_i915_private *dev_priv);
2567 int vlv_force_gfx_clock(struct drm_i915_private *dev_priv, bool on);
2568 void intel_hpd_cancel_work(struct drm_i915_private *dev_priv);
2569 
2570 /* i915_irq.c */
2571 void i915_queue_hangcheck(struct drm_device *dev);
2572 __printf(3, 4)
2573 void i915_handle_error(struct drm_device *dev, bool wedged,
2574 		       const char *fmt, ...);
2575 
2576 extern void intel_irq_init(struct drm_i915_private *dev_priv);
2577 extern void intel_hpd_init(struct drm_i915_private *dev_priv);
2578 int intel_irq_install(struct drm_i915_private *dev_priv);
2579 void intel_irq_uninstall(struct drm_i915_private *dev_priv);
2580 
2581 extern void intel_uncore_sanitize(struct drm_device *dev);
2582 extern void intel_uncore_early_sanitize(struct drm_device *dev,
2583 					bool restore_forcewake);
2584 extern void intel_uncore_init(struct drm_device *dev);
2585 extern void intel_uncore_check_errors(struct drm_device *dev);
2586 extern void intel_uncore_fini(struct drm_device *dev);
2587 extern void intel_uncore_forcewake_reset(struct drm_device *dev, bool restore);
2588 const char *intel_uncore_forcewake_domain_to_str(const enum forcewake_domain_id id);
2589 void intel_uncore_forcewake_get(struct drm_i915_private *dev_priv,
2590 				enum forcewake_domains domains);
2591 void intel_uncore_forcewake_put(struct drm_i915_private *dev_priv,
2592 				enum forcewake_domains domains);
2593 void assert_forcewakes_inactive(struct drm_i915_private *dev_priv);
2594 
2595 void
2596 i915_enable_pipestat(struct drm_i915_private *dev_priv, enum pipe pipe,
2597 		     u32 status_mask);
2598 
2599 void
2600 i915_disable_pipestat(struct drm_i915_private *dev_priv, enum pipe pipe,
2601 		      u32 status_mask);
2602 
2603 void valleyview_enable_display_irqs(struct drm_i915_private *dev_priv);
2604 void valleyview_disable_display_irqs(struct drm_i915_private *dev_priv);
2605 void
2606 ironlake_enable_display_irq(struct drm_i915_private *dev_priv, u32 mask);
2607 void
2608 ironlake_disable_display_irq(struct drm_i915_private *dev_priv, u32 mask);
2609 void ibx_display_interrupt_update(struct drm_i915_private *dev_priv,
2610 				  uint32_t interrupt_mask,
2611 				  uint32_t enabled_irq_mask);
2612 #define ibx_enable_display_interrupt(dev_priv, bits) \
2613 	ibx_display_interrupt_update((dev_priv), (bits), (bits))
2614 #define ibx_disable_display_interrupt(dev_priv, bits) \
2615 	ibx_display_interrupt_update((dev_priv), (bits), 0)
2616 
2617 /* i915_gem.c */
2618 int i915_gem_create_ioctl(struct drm_device *dev, void *data,
2619 			  struct drm_file *file_priv);
2620 int i915_gem_pread_ioctl(struct drm_device *dev, void *data,
2621 			 struct drm_file *file_priv);
2622 int i915_gem_pwrite_ioctl(struct drm_device *dev, void *data,
2623 			  struct drm_file *file_priv);
2624 int i915_gem_mmap_ioctl(struct drm_device *dev, void *data,
2625 			struct drm_file *file_priv);
2626 int i915_gem_mmap_gtt_ioctl(struct drm_device *dev, void *data,
2627 			struct drm_file *file_priv);
2628 int i915_gem_set_domain_ioctl(struct drm_device *dev, void *data,
2629 			      struct drm_file *file_priv);
2630 int i915_gem_sw_finish_ioctl(struct drm_device *dev, void *data,
2631 			     struct drm_file *file_priv);
2632 void i915_gem_execbuffer_move_to_active(struct list_head *vmas,
2633 					struct intel_engine_cs *ring);
2634 void i915_gem_execbuffer_retire_commands(struct drm_device *dev,
2635 					 struct drm_file *file,
2636 					 struct intel_engine_cs *ring,
2637 					 struct drm_i915_gem_object *obj);
2638 int i915_gem_ringbuffer_submission(struct drm_device *dev,
2639 				   struct drm_file *file,
2640 				   struct intel_engine_cs *ring,
2641 				   struct intel_context *ctx,
2642 				   struct drm_i915_gem_execbuffer2 *args,
2643 				   struct list_head *vmas,
2644 				   struct drm_i915_gem_object *batch_obj,
2645 				   u64 exec_start, u32 flags);
2646 int i915_gem_execbuffer(struct drm_device *dev, void *data,
2647 			struct drm_file *file_priv);
2648 int i915_gem_execbuffer2(struct drm_device *dev, void *data,
2649 			 struct drm_file *file_priv);
2650 int i915_gem_busy_ioctl(struct drm_device *dev, void *data,
2651 			struct drm_file *file_priv);
2652 int i915_gem_get_caching_ioctl(struct drm_device *dev, void *data,
2653 			       struct drm_file *file);
2654 int i915_gem_set_caching_ioctl(struct drm_device *dev, void *data,
2655 			       struct drm_file *file);
2656 int i915_gem_throttle_ioctl(struct drm_device *dev, void *data,
2657 			    struct drm_file *file_priv);
2658 int i915_gem_madvise_ioctl(struct drm_device *dev, void *data,
2659 			   struct drm_file *file_priv);
2660 int i915_gem_set_tiling(struct drm_device *dev, void *data,
2661 			struct drm_file *file_priv);
2662 int i915_gem_get_tiling(struct drm_device *dev, void *data,
2663 			struct drm_file *file_priv);
2664 int i915_gem_init_userptr(struct drm_device *dev);
2665 int i915_gem_userptr_ioctl(struct drm_device *dev, void *data,
2666 			   struct drm_file *file);
2667 int i915_gem_get_aperture_ioctl(struct drm_device *dev, void *data,
2668 				struct drm_file *file_priv);
2669 int i915_gem_wait_ioctl(struct drm_device *dev, void *data,
2670 			struct drm_file *file_priv);
2671 void i915_gem_load(struct drm_device *dev);
2672 unsigned long i915_gem_shrink(struct drm_i915_private *dev_priv,
2673 			      long target,
2674 			      unsigned flags);
2675 #define I915_SHRINK_PURGEABLE 0x1
2676 #define I915_SHRINK_UNBOUND 0x2
2677 #define I915_SHRINK_BOUND 0x4
2678 void *i915_gem_object_alloc(struct drm_device *dev);
2679 void i915_gem_object_free(struct drm_i915_gem_object *obj);
2680 void i915_gem_object_init(struct drm_i915_gem_object *obj,
2681 			 const struct drm_i915_gem_object_ops *ops);
2682 struct drm_i915_gem_object *i915_gem_alloc_object(struct drm_device *dev,
2683 						  size_t size);
2684 void i915_init_vm(struct drm_i915_private *dev_priv,
2685 		  struct i915_address_space *vm);
2686 void i915_gem_free_object(struct drm_gem_object *obj);
2687 void i915_gem_vma_destroy(struct i915_vma *vma);
2688 
2689 #define PIN_MAPPABLE 0x1
2690 #define PIN_NONBLOCK 0x2
2691 #define PIN_GLOBAL 0x4
2692 #define PIN_OFFSET_BIAS 0x8
2693 #define PIN_OFFSET_MASK (~4095)
2694 int __must_check i915_gem_object_pin_view(struct drm_i915_gem_object *obj,
2695 					  struct i915_address_space *vm,
2696 					  uint32_t alignment,
2697 					  uint64_t flags,
2698 					  const struct i915_ggtt_view *view);
2699 static inline
2700 int __must_check i915_gem_object_pin(struct drm_i915_gem_object *obj,
2701 				     struct i915_address_space *vm,
2702 				     uint32_t alignment,
2703 				     uint64_t flags)
2704 {
2705 	return i915_gem_object_pin_view(obj, vm, alignment, flags,
2706 						&i915_ggtt_view_normal);
2707 }
2708 
2709 int i915_vma_bind(struct i915_vma *vma, enum i915_cache_level cache_level,
2710 		  u32 flags);
2711 int __must_check i915_vma_unbind(struct i915_vma *vma);
2712 int i915_gem_object_put_pages(struct drm_i915_gem_object *obj);
2713 void i915_gem_release_all_mmaps(struct drm_i915_private *dev_priv);
2714 void i915_gem_release_mmap(struct drm_i915_gem_object *obj);
2715 
2716 int i915_gem_obj_prepare_shmem_read(struct drm_i915_gem_object *obj,
2717 				    int *needs_clflush);
2718 
2719 int __must_check i915_gem_object_get_pages(struct drm_i915_gem_object *obj);
2720 static inline struct page *i915_gem_object_get_page(struct drm_i915_gem_object *obj, int n)
2721 {
2722 	struct sg_page_iter sg_iter;
2723 
2724 	for_each_sg_page(obj->pages->sgl, &sg_iter, obj->pages->nents, n)
2725 		return sg_page_iter_page(&sg_iter);
2726 
2727 	return NULL;
2728 }
2729 static inline void i915_gem_object_pin_pages(struct drm_i915_gem_object *obj)
2730 {
2731 	BUG_ON(obj->pages == NULL);
2732 	obj->pages_pin_count++;
2733 }
2734 static inline void i915_gem_object_unpin_pages(struct drm_i915_gem_object *obj)
2735 {
2736 	BUG_ON(obj->pages_pin_count == 0);
2737 	obj->pages_pin_count--;
2738 }
2739 
2740 int __must_check i915_mutex_lock_interruptible(struct drm_device *dev);
2741 int i915_gem_object_sync(struct drm_i915_gem_object *obj,
2742 			 struct intel_engine_cs *to);
2743 void i915_vma_move_to_active(struct i915_vma *vma,
2744 			     struct intel_engine_cs *ring);
2745 int i915_gem_dumb_create(struct drm_file *file_priv,
2746 			 struct drm_device *dev,
2747 			 struct drm_mode_create_dumb *args);
2748 int i915_gem_mmap_gtt(struct drm_file *file_priv, struct drm_device *dev,
2749 		      uint32_t handle, uint64_t *offset);
2750 /**
2751  * Returns true if seq1 is later than seq2.
2752  */
2753 static inline bool
2754 i915_seqno_passed(uint32_t seq1, uint32_t seq2)
2755 {
2756 	return (int32_t)(seq1 - seq2) >= 0;
2757 }
2758 
2759 static inline bool i915_gem_request_completed(struct drm_i915_gem_request *req,
2760 					      bool lazy_coherency)
2761 {
2762 	u32 seqno;
2763 
2764 	BUG_ON(req == NULL);
2765 
2766 	seqno = req->ring->get_seqno(req->ring, lazy_coherency);
2767 
2768 	return i915_seqno_passed(seqno, req->seqno);
2769 }
2770 
2771 int __must_check i915_gem_get_seqno(struct drm_device *dev, u32 *seqno);
2772 int __must_check i915_gem_set_seqno(struct drm_device *dev, u32 seqno);
2773 int __must_check i915_gem_object_get_fence(struct drm_i915_gem_object *obj);
2774 int __must_check i915_gem_object_put_fence(struct drm_i915_gem_object *obj);
2775 
2776 bool i915_gem_object_pin_fence(struct drm_i915_gem_object *obj);
2777 void i915_gem_object_unpin_fence(struct drm_i915_gem_object *obj);
2778 
2779 struct drm_i915_gem_request *
2780 i915_gem_find_active_request(struct intel_engine_cs *ring);
2781 
2782 bool i915_gem_retire_requests(struct drm_device *dev);
2783 void i915_gem_retire_requests_ring(struct intel_engine_cs *ring);
2784 int __must_check i915_gem_check_wedge(struct i915_gpu_error *error,
2785 				      bool interruptible);
2786 int __must_check i915_gem_check_olr(struct drm_i915_gem_request *req);
2787 
2788 static inline bool i915_reset_in_progress(struct i915_gpu_error *error)
2789 {
2790 	return unlikely(atomic_read(&error->reset_counter)
2791 			& (I915_RESET_IN_PROGRESS_FLAG | I915_WEDGED));
2792 }
2793 
2794 static inline bool i915_terminally_wedged(struct i915_gpu_error *error)
2795 {
2796 	return atomic_read(&error->reset_counter) & I915_WEDGED;
2797 }
2798 
2799 static inline u32 i915_reset_count(struct i915_gpu_error *error)
2800 {
2801 	return ((atomic_read(&error->reset_counter) & ~I915_WEDGED) + 1) / 2;
2802 }
2803 
2804 static inline bool i915_stop_ring_allow_ban(struct drm_i915_private *dev_priv)
2805 {
2806 	return dev_priv->gpu_error.stop_rings == 0 ||
2807 		dev_priv->gpu_error.stop_rings & I915_STOP_RING_ALLOW_BAN;
2808 }
2809 
2810 static inline bool i915_stop_ring_allow_warn(struct drm_i915_private *dev_priv)
2811 {
2812 	return dev_priv->gpu_error.stop_rings == 0 ||
2813 		dev_priv->gpu_error.stop_rings & I915_STOP_RING_ALLOW_WARN;
2814 }
2815 
2816 void i915_gem_reset(struct drm_device *dev);
2817 bool i915_gem_clflush_object(struct drm_i915_gem_object *obj, bool force);
2818 int __must_check i915_gem_object_finish_gpu(struct drm_i915_gem_object *obj);
2819 int __must_check i915_gem_init(struct drm_device *dev);
2820 int i915_gem_init_rings(struct drm_device *dev);
2821 int __must_check i915_gem_init_hw(struct drm_device *dev);
2822 int i915_gem_l3_remap(struct intel_engine_cs *ring, int slice);
2823 void i915_gem_init_swizzling(struct drm_device *dev);
2824 void i915_gem_cleanup_ringbuffer(struct drm_device *dev);
2825 int __must_check i915_gpu_idle(struct drm_device *dev);
2826 int __must_check i915_gem_suspend(struct drm_device *dev);
2827 int __i915_add_request(struct intel_engine_cs *ring,
2828 		       struct drm_file *file,
2829 		       struct drm_i915_gem_object *batch_obj);
2830 #define i915_add_request(ring) \
2831 	__i915_add_request(ring, NULL, NULL)
2832 int __i915_wait_request(struct drm_i915_gem_request *req,
2833 			unsigned reset_counter,
2834 			bool interruptible,
2835 			s64 *timeout,
2836 			struct drm_i915_file_private *file_priv);
2837 int __must_check i915_wait_request(struct drm_i915_gem_request *req);
2838 int i915_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);
2839 int __must_check
2840 i915_gem_object_set_to_gtt_domain(struct drm_i915_gem_object *obj,
2841 				  bool write);
2842 int __must_check
2843 i915_gem_object_set_to_cpu_domain(struct drm_i915_gem_object *obj, bool write);
2844 int __must_check
2845 i915_gem_object_pin_to_display_plane(struct drm_i915_gem_object *obj,
2846 				     u32 alignment,
2847 				     struct intel_engine_cs *pipelined);
2848 void i915_gem_object_unpin_from_display_plane(struct drm_i915_gem_object *obj);
2849 int i915_gem_object_attach_phys(struct drm_i915_gem_object *obj,
2850 				int align);
2851 int i915_gem_open(struct drm_device *dev, struct drm_file *file);
2852 void i915_gem_release(struct drm_device *dev, struct drm_file *file);
2853 
2854 uint32_t
2855 i915_gem_get_gtt_size(struct drm_device *dev, uint32_t size, int tiling_mode);
2856 uint32_t
2857 i915_gem_get_gtt_alignment(struct drm_device *dev, uint32_t size,
2858 			    int tiling_mode, bool fenced);
2859 
2860 int i915_gem_object_set_cache_level(struct drm_i915_gem_object *obj,
2861 				    enum i915_cache_level cache_level);
2862 
2863 struct drm_gem_object *i915_gem_prime_import(struct drm_device *dev,
2864 				struct dma_buf *dma_buf);
2865 
2866 struct dma_buf *i915_gem_prime_export(struct drm_device *dev,
2867 				struct drm_gem_object *gem_obj, int flags);
2868 
2869 void i915_gem_restore_fences(struct drm_device *dev);
2870 
2871 unsigned long i915_gem_obj_offset_view(struct drm_i915_gem_object *o,
2872 				       struct i915_address_space *vm,
2873 				       enum i915_ggtt_view_type view);
2874 static inline
2875 unsigned long i915_gem_obj_offset(struct drm_i915_gem_object *o,
2876 				  struct i915_address_space *vm)
2877 {
2878 	return i915_gem_obj_offset_view(o, vm, I915_GGTT_VIEW_NORMAL);
2879 }
2880 bool i915_gem_obj_bound_any(struct drm_i915_gem_object *o);
2881 bool i915_gem_obj_bound_view(struct drm_i915_gem_object *o,
2882 			     struct i915_address_space *vm,
2883 			     enum i915_ggtt_view_type view);
2884 static inline
2885 bool i915_gem_obj_bound(struct drm_i915_gem_object *o,
2886 			struct i915_address_space *vm)
2887 {
2888 	return i915_gem_obj_bound_view(o, vm, I915_GGTT_VIEW_NORMAL);
2889 }
2890 
2891 unsigned long i915_gem_obj_size(struct drm_i915_gem_object *o,
2892 				struct i915_address_space *vm);
2893 struct i915_vma *i915_gem_obj_to_vma_view(struct drm_i915_gem_object *obj,
2894 					  struct i915_address_space *vm,
2895 					  const struct i915_ggtt_view *view);
2896 static inline
2897 struct i915_vma *i915_gem_obj_to_vma(struct drm_i915_gem_object *obj,
2898 				     struct i915_address_space *vm)
2899 {
2900 	return i915_gem_obj_to_vma_view(obj, vm, &i915_ggtt_view_normal);
2901 }
2902 
2903 struct i915_vma *
2904 i915_gem_obj_lookup_or_create_vma_view(struct drm_i915_gem_object *obj,
2905 				       struct i915_address_space *vm,
2906 				       const struct i915_ggtt_view *view);
2907 
2908 static inline
2909 struct i915_vma *
2910 i915_gem_obj_lookup_or_create_vma(struct drm_i915_gem_object *obj,
2911 				  struct i915_address_space *vm)
2912 {
2913 	return i915_gem_obj_lookup_or_create_vma_view(obj, vm,
2914 						&i915_ggtt_view_normal);
2915 }
2916 
2917 struct i915_vma *i915_gem_obj_to_ggtt(struct drm_i915_gem_object *obj);
2918 static inline bool i915_gem_obj_is_pinned(struct drm_i915_gem_object *obj) {
2919 	struct i915_vma *vma;
2920 	list_for_each_entry(vma, &obj->vma_list, vma_link)
2921 		if (vma->pin_count > 0)
2922 			return true;
2923 	return false;
2924 }
2925 
2926 /* Some GGTT VM helpers */
2927 #define i915_obj_to_ggtt(obj) \
2928 	(&((struct drm_i915_private *)(obj)->base.dev->dev_private)->gtt.base)
2929 static inline bool i915_is_ggtt(struct i915_address_space *vm)
2930 {
2931 	struct i915_address_space *ggtt =
2932 		&((struct drm_i915_private *)(vm)->dev->dev_private)->gtt.base;
2933 	return vm == ggtt;
2934 }
2935 
2936 static inline struct i915_hw_ppgtt *
2937 i915_vm_to_ppgtt(struct i915_address_space *vm)
2938 {
2939 	WARN_ON(i915_is_ggtt(vm));
2940 
2941 	return container_of(vm, struct i915_hw_ppgtt, base);
2942 }
2943 
2944 
2945 static inline bool i915_gem_obj_ggtt_bound(struct drm_i915_gem_object *obj)
2946 {
2947 	return i915_gem_obj_bound(obj, i915_obj_to_ggtt(obj));
2948 }
2949 
2950 static inline unsigned long
2951 i915_gem_obj_ggtt_offset(struct drm_i915_gem_object *obj)
2952 {
2953 	return i915_gem_obj_offset(obj, i915_obj_to_ggtt(obj));
2954 }
2955 
2956 static inline unsigned long
2957 i915_gem_obj_ggtt_size(struct drm_i915_gem_object *obj)
2958 {
2959 	return i915_gem_obj_size(obj, i915_obj_to_ggtt(obj));
2960 }
2961 
2962 static inline int __must_check
2963 i915_gem_obj_ggtt_pin(struct drm_i915_gem_object *obj,
2964 		      uint32_t alignment,
2965 		      unsigned flags)
2966 {
2967 	return i915_gem_object_pin(obj, i915_obj_to_ggtt(obj),
2968 				   alignment, flags | PIN_GLOBAL);
2969 }
2970 
2971 static inline int
2972 i915_gem_object_ggtt_unbind(struct drm_i915_gem_object *obj)
2973 {
2974 	return i915_vma_unbind(i915_gem_obj_to_ggtt(obj));
2975 }
2976 
2977 void i915_gem_object_ggtt_unpin(struct drm_i915_gem_object *obj);
2978 
2979 /* i915_gem_context.c */
2980 int __must_check i915_gem_context_init(struct drm_device *dev);
2981 void i915_gem_context_fini(struct drm_device *dev);
2982 void i915_gem_context_reset(struct drm_device *dev);
2983 int i915_gem_context_open(struct drm_device *dev, struct drm_file *file);
2984 int i915_gem_context_enable(struct drm_i915_private *dev_priv);
2985 void i915_gem_context_close(struct drm_device *dev, struct drm_file *file);
2986 int i915_switch_context(struct intel_engine_cs *ring,
2987 			struct intel_context *to);
2988 struct intel_context *
2989 i915_gem_context_get(struct drm_i915_file_private *file_priv, u32 id);
2990 void i915_gem_context_free(struct kref *ctx_ref);
2991 struct drm_i915_gem_object *
2992 i915_gem_alloc_context_obj(struct drm_device *dev, size_t size);
2993 static inline void i915_gem_context_reference(struct intel_context *ctx)
2994 {
2995 	kref_get(&ctx->ref);
2996 }
2997 
2998 static inline void i915_gem_context_unreference(struct intel_context *ctx)
2999 {
3000 	kref_put(&ctx->ref, i915_gem_context_free);
3001 }
3002 
3003 static inline bool i915_gem_context_is_default(const struct intel_context *c)
3004 {
3005 	return c->user_handle == DEFAULT_CONTEXT_HANDLE;
3006 }
3007 
3008 int i915_gem_context_create_ioctl(struct drm_device *dev, void *data,
3009 				  struct drm_file *file);
3010 int i915_gem_context_destroy_ioctl(struct drm_device *dev, void *data,
3011 				   struct drm_file *file);
3012 int i915_gem_context_getparam_ioctl(struct drm_device *dev, void *data,
3013 				    struct drm_file *file_priv);
3014 int i915_gem_context_setparam_ioctl(struct drm_device *dev, void *data,
3015 				    struct drm_file *file_priv);
3016 
3017 /* i915_gem_evict.c */
3018 int __must_check i915_gem_evict_something(struct drm_device *dev,
3019 					  struct i915_address_space *vm,
3020 					  int min_size,
3021 					  unsigned alignment,
3022 					  unsigned cache_level,
3023 					  unsigned long start,
3024 					  unsigned long end,
3025 					  unsigned flags);
3026 int i915_gem_evict_vm(struct i915_address_space *vm, bool do_idle);
3027 int i915_gem_evict_everything(struct drm_device *dev);
3028 
3029 /* belongs in i915_gem_gtt.h */
3030 static inline void i915_gem_chipset_flush(struct drm_device *dev)
3031 {
3032 	if (INTEL_INFO(dev)->gen < 6)
3033 		intel_gtt_chipset_flush();
3034 }
3035 
3036 /* i915_gem_stolen.c */
3037 int i915_gem_init_stolen(struct drm_device *dev);
3038 int i915_gem_stolen_setup_compression(struct drm_device *dev, int size, int fb_cpp);
3039 void i915_gem_stolen_cleanup_compression(struct drm_device *dev);
3040 void i915_gem_cleanup_stolen(struct drm_device *dev);
3041 struct drm_i915_gem_object *
3042 i915_gem_object_create_stolen(struct drm_device *dev, u32 size);
3043 struct drm_i915_gem_object *
3044 i915_gem_object_create_stolen_for_preallocated(struct drm_device *dev,
3045 					       u32 stolen_offset,
3046 					       u32 gtt_offset,
3047 					       u32 size);
3048 
3049 /* i915_gem_tiling.c */
3050 static inline bool i915_gem_object_needs_bit17_swizzle(struct drm_i915_gem_object *obj)
3051 {
3052 	struct drm_i915_private *dev_priv = obj->base.dev->dev_private;
3053 
3054 	return dev_priv->mm.bit_6_swizzle_x == I915_BIT_6_SWIZZLE_9_10_17 &&
3055 		obj->tiling_mode != I915_TILING_NONE;
3056 }
3057 
3058 void i915_gem_detect_bit_6_swizzle(struct drm_device *dev);
3059 void i915_gem_object_do_bit_17_swizzle(struct drm_i915_gem_object *obj);
3060 void i915_gem_object_save_bit_17_swizzle(struct drm_i915_gem_object *obj);
3061 
3062 /* i915_gem_debug.c */
3063 #if WATCH_LISTS
3064 int i915_verify_lists(struct drm_device *dev);
3065 #else
3066 #define i915_verify_lists(dev) 0
3067 #endif
3068 
3069 /* i915_debugfs.c */
3070 int i915_debugfs_init(struct drm_minor *minor);
3071 void i915_debugfs_cleanup(struct drm_minor *minor);
3072 #ifdef CONFIG_DEBUG_FS
3073 void intel_display_crc_init(struct drm_device *dev);
3074 #else
3075 static inline void intel_display_crc_init(struct drm_device *dev) {}
3076 #endif
3077 
3078 /* i915_gpu_error.c */
3079 __printf(2, 3)
3080 void i915_error_printf(struct drm_i915_error_state_buf *e, const char *f, ...);
3081 int i915_error_state_to_str(struct drm_i915_error_state_buf *estr,
3082 			    const struct i915_error_state_file_priv *error);
3083 int i915_error_state_buf_init(struct drm_i915_error_state_buf *eb,
3084 			      struct drm_i915_private *i915,
3085 			      size_t count, loff_t pos);
3086 static inline void i915_error_state_buf_release(
3087 	struct drm_i915_error_state_buf *eb)
3088 {
3089 	kfree(eb->buf);
3090 }
3091 void i915_capture_error_state(struct drm_device *dev, bool wedge,
3092 			      const char *error_msg);
3093 void i915_error_state_get(struct drm_device *dev,
3094 			  struct i915_error_state_file_priv *error_priv);
3095 void i915_error_state_put(struct i915_error_state_file_priv *error_priv);
3096 void i915_destroy_error_state(struct drm_device *dev);
3097 
3098 void i915_get_extra_instdone(struct drm_device *dev, uint32_t *instdone);
3099 const char *i915_cache_level_str(struct drm_i915_private *i915, int type);
3100 
3101 /* i915_gem_batch_pool.c */
3102 void i915_gem_batch_pool_init(struct drm_device *dev,
3103 			      struct i915_gem_batch_pool *pool);
3104 void i915_gem_batch_pool_fini(struct i915_gem_batch_pool *pool);
3105 struct drm_i915_gem_object*
3106 i915_gem_batch_pool_get(struct i915_gem_batch_pool *pool, size_t size);
3107 
3108 /* i915_cmd_parser.c */
3109 int i915_cmd_parser_get_version(void);
3110 int i915_cmd_parser_init_ring(struct intel_engine_cs *ring);
3111 void i915_cmd_parser_fini_ring(struct intel_engine_cs *ring);
3112 bool i915_needs_cmd_parser(struct intel_engine_cs *ring);
3113 int i915_parse_cmds(struct intel_engine_cs *ring,
3114 		    struct drm_i915_gem_object *batch_obj,
3115 		    struct drm_i915_gem_object *shadow_batch_obj,
3116 		    u32 batch_start_offset,
3117 		    u32 batch_len,
3118 		    bool is_master);
3119 
3120 /* i915_suspend.c */
3121 extern int i915_save_state(struct drm_device *dev);
3122 extern int i915_restore_state(struct drm_device *dev);
3123 
3124 /* i915_ums.c */
3125 void i915_save_display_reg(struct drm_device *dev);
3126 void i915_restore_display_reg(struct drm_device *dev);
3127 
3128 /* i915_sysfs.c */
3129 void i915_setup_sysfs(struct drm_device *dev_priv);
3130 void i915_teardown_sysfs(struct drm_device *dev_priv);
3131 
3132 /* intel_i2c.c */
3133 extern int intel_setup_gmbus(struct drm_device *dev);
3134 extern void intel_teardown_gmbus(struct drm_device *dev);
3135 static inline bool intel_gmbus_is_port_valid(unsigned port)
3136 {
3137 	return (port >= GMBUS_PORT_SSC && port <= GMBUS_PORT_DPD);
3138 }
3139 
3140 extern struct i2c_adapter *intel_gmbus_get_adapter(
3141 		struct drm_i915_private *dev_priv, unsigned port);
3142 extern void intel_gmbus_set_speed(struct i2c_adapter *adapter, int speed);
3143 extern void intel_gmbus_force_bit(struct i2c_adapter *adapter, bool force_bit);
3144 static inline bool intel_gmbus_is_forced_bit(struct i2c_adapter *adapter)
3145 {
3146 	return container_of(adapter, struct intel_gmbus, adapter)->force_bit;
3147 }
3148 extern void intel_i2c_reset(struct drm_device *dev);
3149 
3150 /* intel_opregion.c */
3151 #ifdef CONFIG_ACPI
3152 extern int intel_opregion_setup(struct drm_device *dev);
3153 extern void intel_opregion_init(struct drm_device *dev);
3154 extern void intel_opregion_fini(struct drm_device *dev);
3155 extern void intel_opregion_asle_intr(struct drm_device *dev);
3156 extern int intel_opregion_notify_encoder(struct intel_encoder *intel_encoder,
3157 					 bool enable);
3158 extern int intel_opregion_notify_adapter(struct drm_device *dev,
3159 					 pci_power_t state);
3160 #else
3161 static inline int intel_opregion_setup(struct drm_device *dev) { return 0; }
3162 static inline void intel_opregion_init(struct drm_device *dev) { return; }
3163 static inline void intel_opregion_fini(struct drm_device *dev) { return; }
3164 static inline void intel_opregion_asle_intr(struct drm_device *dev) { return; }
3165 static inline int
3166 intel_opregion_notify_encoder(struct intel_encoder *intel_encoder, bool enable)
3167 {
3168 	return 0;
3169 }
3170 static inline int
3171 intel_opregion_notify_adapter(struct drm_device *dev, pci_power_t state)
3172 {
3173 	return 0;
3174 }
3175 #endif
3176 
3177 /* intel_acpi.c */
3178 #ifdef CONFIG_ACPI
3179 extern void intel_register_dsm_handler(void);
3180 extern void intel_unregister_dsm_handler(void);
3181 #else
3182 static inline void intel_register_dsm_handler(void) { return; }
3183 static inline void intel_unregister_dsm_handler(void) { return; }
3184 #endif /* CONFIG_ACPI */
3185 
3186 /* modesetting */
3187 extern void intel_modeset_init_hw(struct drm_device *dev);
3188 extern void intel_modeset_init(struct drm_device *dev);
3189 extern void intel_modeset_gem_init(struct drm_device *dev);
3190 extern void intel_modeset_cleanup(struct drm_device *dev);
3191 extern void intel_connector_unregister(struct intel_connector *);
3192 extern int intel_modeset_vga_set_state(struct drm_device *dev, bool state);
3193 extern void intel_modeset_setup_hw_state(struct drm_device *dev,
3194 					 bool force_restore);
3195 extern void i915_redisable_vga(struct drm_device *dev);
3196 extern void i915_redisable_vga_power_on(struct drm_device *dev);
3197 extern bool ironlake_set_drps(struct drm_device *dev, u8 val);
3198 extern void intel_init_pch_refclk(struct drm_device *dev);
3199 extern void gen6_set_rps(struct drm_device *dev, u8 val);
3200 extern void valleyview_set_rps(struct drm_device *dev, u8 val);
3201 extern void intel_set_memory_cxsr(struct drm_i915_private *dev_priv,
3202 				  bool enable);
3203 extern void intel_detect_pch(struct drm_device *dev);
3204 extern int intel_trans_dp_port_sel(struct drm_crtc *crtc);
3205 extern int intel_enable_rc6(const struct drm_device *dev);
3206 
3207 extern bool i915_semaphore_is_enabled(struct drm_device *dev);
3208 int i915_reg_read_ioctl(struct drm_device *dev, void *data,
3209 			struct drm_file *file);
3210 int i915_get_reset_stats_ioctl(struct drm_device *dev, void *data,
3211 			       struct drm_file *file);
3212 
3213 void intel_notify_mmio_flip(struct intel_engine_cs *ring);
3214 
3215 /* overlay */
3216 extern struct intel_overlay_error_state *intel_overlay_capture_error_state(struct drm_device *dev);
3217 extern void intel_overlay_print_error_state(struct drm_i915_error_state_buf *e,
3218 					    struct intel_overlay_error_state *error);
3219 
3220 extern struct intel_display_error_state *intel_display_capture_error_state(struct drm_device *dev);
3221 extern void intel_display_print_error_state(struct drm_i915_error_state_buf *e,
3222 					    struct drm_device *dev,
3223 					    struct intel_display_error_state *error);
3224 
3225 int sandybridge_pcode_read(struct drm_i915_private *dev_priv, u32 mbox, u32 *val);
3226 int sandybridge_pcode_write(struct drm_i915_private *dev_priv, u32 mbox, u32 val);
3227 
3228 /* intel_sideband.c */
3229 u32 vlv_punit_read(struct drm_i915_private *dev_priv, u32 addr);
3230 void vlv_punit_write(struct drm_i915_private *dev_priv, u32 addr, u32 val);
3231 u32 vlv_nc_read(struct drm_i915_private *dev_priv, u8 addr);
3232 u32 vlv_gpio_nc_read(struct drm_i915_private *dev_priv, u32 reg);
3233 void vlv_gpio_nc_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
3234 u32 vlv_cck_read(struct drm_i915_private *dev_priv, u32 reg);
3235 void vlv_cck_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
3236 u32 vlv_ccu_read(struct drm_i915_private *dev_priv, u32 reg);
3237 void vlv_ccu_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
3238 u32 vlv_bunit_read(struct drm_i915_private *dev_priv, u32 reg);
3239 void vlv_bunit_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
3240 u32 vlv_gps_core_read(struct drm_i915_private *dev_priv, u32 reg);
3241 void vlv_gps_core_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
3242 u32 vlv_dpio_read(struct drm_i915_private *dev_priv, enum pipe pipe, int reg);
3243 void vlv_dpio_write(struct drm_i915_private *dev_priv, enum pipe pipe, int reg, u32 val);
3244 u32 intel_sbi_read(struct drm_i915_private *dev_priv, u16 reg,
3245 		   enum intel_sbi_destination destination);
3246 void intel_sbi_write(struct drm_i915_private *dev_priv, u16 reg, u32 value,
3247 		     enum intel_sbi_destination destination);
3248 u32 vlv_flisdsi_read(struct drm_i915_private *dev_priv, u32 reg);
3249 void vlv_flisdsi_write(struct drm_i915_private *dev_priv, u32 reg, u32 val);
3250 
3251 int intel_gpu_freq(struct drm_i915_private *dev_priv, int val);
3252 int intel_freq_opcode(struct drm_i915_private *dev_priv, int val);
3253 
3254 #define I915_READ8(reg)		dev_priv->uncore.funcs.mmio_readb(dev_priv, (reg), true)
3255 #define I915_WRITE8(reg, val)	dev_priv->uncore.funcs.mmio_writeb(dev_priv, (reg), (val), true)
3256 
3257 #define I915_READ16(reg)	dev_priv->uncore.funcs.mmio_readw(dev_priv, (reg), true)
3258 #define I915_WRITE16(reg, val)	dev_priv->uncore.funcs.mmio_writew(dev_priv, (reg), (val), true)
3259 #define I915_READ16_NOTRACE(reg)	dev_priv->uncore.funcs.mmio_readw(dev_priv, (reg), false)
3260 #define I915_WRITE16_NOTRACE(reg, val)	dev_priv->uncore.funcs.mmio_writew(dev_priv, (reg), (val), false)
3261 
3262 #define I915_READ(reg)		dev_priv->uncore.funcs.mmio_readl(dev_priv, (reg), true)
3263 #define I915_WRITE(reg, val)	dev_priv->uncore.funcs.mmio_writel(dev_priv, (reg), (val), true)
3264 #define I915_READ_NOTRACE(reg)		dev_priv->uncore.funcs.mmio_readl(dev_priv, (reg), false)
3265 #define I915_WRITE_NOTRACE(reg, val)	dev_priv->uncore.funcs.mmio_writel(dev_priv, (reg), (val), false)
3266 
3267 /* Be very careful with read/write 64-bit values. On 32-bit machines, they
3268  * will be implemented using 2 32-bit writes in an arbitrary order with
3269  * an arbitrary delay between them. This can cause the hardware to
3270  * act upon the intermediate value, possibly leading to corruption and
3271  * machine death. You have been warned.
3272  */
3273 #define I915_WRITE64(reg, val)	dev_priv->uncore.funcs.mmio_writeq(dev_priv, (reg), (val), true)
3274 #define I915_READ64(reg)	dev_priv->uncore.funcs.mmio_readq(dev_priv, (reg), true)
3275 
3276 #define I915_READ64_2x32(lower_reg, upper_reg) ({			\
3277 		u32 upper = I915_READ(upper_reg);			\
3278 		u32 lower = I915_READ(lower_reg);			\
3279 		u32 tmp = I915_READ(upper_reg);				\
3280 		if (upper != tmp) {					\
3281 			upper = tmp;					\
3282 			lower = I915_READ(lower_reg);			\
3283 			WARN_ON(I915_READ(upper_reg) != upper);		\
3284 		}							\
3285 		(u64)upper << 32 | lower; })
3286 
3287 #define POSTING_READ(reg)	(void)I915_READ_NOTRACE(reg)
3288 #define POSTING_READ16(reg)	(void)I915_READ16_NOTRACE(reg)
3289 
3290 /* "Broadcast RGB" property */
3291 #define INTEL_BROADCAST_RGB_AUTO 0
3292 #define INTEL_BROADCAST_RGB_FULL 1
3293 #define INTEL_BROADCAST_RGB_LIMITED 2
3294 
3295 static inline uint32_t i915_vgacntrl_reg(struct drm_device *dev)
3296 {
3297 	if (IS_VALLEYVIEW(dev))
3298 		return VLV_VGACNTRL;
3299 	else if (INTEL_INFO(dev)->gen >= 5)
3300 		return CPU_VGACNTRL;
3301 	else
3302 		return VGACNTRL;
3303 }
3304 
3305 static inline void __user *to_user_ptr(u64 address)
3306 {
3307 	return (void __user *)(uintptr_t)address;
3308 }
3309 
3310 static inline unsigned long msecs_to_jiffies_timeout(const unsigned int m)
3311 {
3312 	unsigned long j = msecs_to_jiffies(m);
3313 
3314 	return min_t(unsigned long, MAX_JIFFY_OFFSET, j + 1);
3315 }
3316 
3317 static inline unsigned long nsecs_to_jiffies_timeout(const u64 n)
3318 {
3319         return min_t(u64, MAX_JIFFY_OFFSET, nsecs_to_jiffies64(n) + 1);
3320 }
3321 
3322 static inline unsigned long
3323 timespec_to_jiffies_timeout(const struct timespec *value)
3324 {
3325 	unsigned long j = timespec_to_jiffies(value);
3326 
3327 	return min_t(unsigned long, MAX_JIFFY_OFFSET, j + 1);
3328 }
3329 
3330 /*
3331  * If you need to wait X milliseconds between events A and B, but event B
3332  * doesn't happen exactly after event A, you record the timestamp (jiffies) of
3333  * when event A happened, then just before event B you call this function and
3334  * pass the timestamp as the first argument, and X as the second argument.
3335  */
3336 static inline void
3337 wait_remaining_ms_from_jiffies(unsigned long timestamp_jiffies, int to_wait_ms)
3338 {
3339 	unsigned long target_jiffies, tmp_jiffies, remaining_jiffies;
3340 
3341 	/*
3342 	 * Don't re-read the value of "jiffies" every time since it may change
3343 	 * behind our back and break the math.
3344 	 */
3345 	tmp_jiffies = jiffies;
3346 	target_jiffies = timestamp_jiffies +
3347 			 msecs_to_jiffies_timeout(to_wait_ms);
3348 
3349 	if (time_after(target_jiffies, tmp_jiffies)) {
3350 		remaining_jiffies = target_jiffies - tmp_jiffies;
3351 		while (remaining_jiffies)
3352 			remaining_jiffies =
3353 			    schedule_timeout_uninterruptible(remaining_jiffies);
3354 	}
3355 }
3356 
3357 static inline void i915_trace_irq_get(struct intel_engine_cs *ring,
3358 				      struct drm_i915_gem_request *req)
3359 {
3360 	if (ring->trace_irq_req == NULL && ring->irq_get(ring))
3361 		i915_gem_request_assign(&ring->trace_irq_req, req);
3362 }
3363 
3364 #endif
3365